mirror of
https://github.com/storytold/pdfcraft.git
synced 2026-11-11 08:51:27 +00:00
Merge remote-tracking branch 'upstream/main' into HEAD
# Conflicts: # crates/engine/src/tests.rs # crates/forms/src/values.rs
This commit is contained in:
mtlcl410 committed
commit
eaf20fe6d2
147 files changed
+9359
-96320
No files matched your search
@@ -3,6 +3,9 @@
|
||||
# signatures) and assets whose SHA-256 ATTRIBUTION.toml records (cargo xtask assets).
|
||||
* -text
|
||||
|
||||
# The craft-i18n pin: CI and the build read it as one SHA, so it stays LF everywhere (readers trim it too).
|
||||
craft-i18n.rev text eol=lf
|
||||
|
||||
# Not text at all: no textual diffs or merges either.
|
||||
*.pdf binary
|
||||
*.p12 binary
|
||||
|
||||
@@ -52,14 +52,14 @@ Anything else is forbidden, including assets whose licence you cannot prove from
|
||||
- path or URL, title, author;
|
||||
- source (URL, with version or commit);
|
||||
- SPDX licence, and the licence file in the repo;
|
||||
- SHA-256, except for translation catalogs (see below);
|
||||
- SHA-256;
|
||||
- how it is used.
|
||||
- **Translation catalogs** (`crates/ui-egui/src/i18n/*.tsv`, `kind = "translation"`) are project files under the project licence. Their entries carry no `sha256`: git history records every change and who made it. Every other kind (fonts, images, data) is hashed.
|
||||
- **Translations** live in craft-i18n (`locales/<code>/common.tsv` and `pdfcraft.tsv`), embedded at build time from the checkout pinned in `craft-i18n.rev`; PdfCraft keeps no catalogs. `ATTRIBUTION.toml` records them as one `[[build_input]]` (`kind = "translation"`); craft-i18n's own `ATTRIBUTION.md` credits the translators. Every `[[asset]]` (fonts, images, data) is hashed.
|
||||
- **`ATTRIBUTION.md`** is generated from it (`cargo xtask assets --write`). Never edit it by hand.
|
||||
- **`NOTICE`** keeps the licence notices that the licences require.
|
||||
- **`cargo xtask assets`** runs in `cargo xtask ci`. It fails if:
|
||||
- an asset file in the repository has no entry;
|
||||
- an entry's hash is missing or does not match (translation catalogs carry none);
|
||||
- an entry's hash is missing or does not match;
|
||||
- a licence is not on the allowlist;
|
||||
- a licence file is missing;
|
||||
- an image, icon or font names Adobe as author or source, except a font licensed under OFL-1.1 alone.
|
||||
|
||||
+4
-37
@@ -2,40 +2,12 @@
|
||||
|
||||
<!-- Generated from ATTRIBUTION.toml by `cargo xtask assets --write`. Do not edit by hand. -->
|
||||
|
||||
Every asset PdfCraft includes, bundles or uses to build its published material, with its author, source and licence. The policy is in [AGENTS.md](AGENTS.md) §1. The machine-readable list, with the SHA-256 of every asset but the translation catalogs, is [ATTRIBUTION.toml](ATTRIBUTION.toml). Licence texts are kept beside the assets and summarised in [NOTICE](NOTICE).
|
||||
Every asset PdfCraft includes, bundles or uses to build its published material, with its author, source and licence. The policy is in [AGENTS.md](AGENTS.md) §1. The machine-readable list, with the SHA-256 of every asset, is [ATTRIBUTION.toml](ATTRIBUTION.toml). Licence texts are kept beside the assets and summarised in [NOTICE](NOTICE).
|
||||
|
||||
## In this repository (289)
|
||||
## In this repository (255)
|
||||
|
||||
| Asset | Title | Author | Licence | Source | Used for |
|
||||
|---|---|---|---|---|---|
|
||||
| `crates/ui-egui/src/i18n/el.tsv` | Greek interface translation catalog | Camthalion77 and contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft English UI labels; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Greek UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/zh-hans.tsv` | Simplified Chinese interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Simplified Chinese UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/zh-hant.tsv` | Traditional Chinese (Taiwan) interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Traditional Chinese UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/cs.tsv` | Czech interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check and standard-identification wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Czech UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/pt-br.tsv` | Brazilian Portuguese interface translation catalog | André Cardoso (andrecards), PdfCraft contributors | MIT OR Apache-2.0 | Clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources: the ~1,826-entry gist posted in issue #288 (https://gist.github.com/andrecards/ac388c25fba17312ce83207f8b7b467e), completed and reviewed by PdfCraft contributors; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table limit messages are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Brazilian Portuguese UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/es.tsv` | Spanish interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; the 2026-10-20 coverage additions are AI-assisted and not separately native-reviewed; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Spanish UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/fr.tsv` | French interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | French UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/de.tsv` | German interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | German UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/lo.tsv` | Lao interface translation catalog | @bounkirdni-2025 | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Lao UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/te.tsv` | Telugu interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Telugu UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/it.tsv` | Italian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Italian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/pl.tsv` | Polish interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Polish UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/ru.tsv` | Russian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Russian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/hu.tsv` | Hungarian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Hungarian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/bg.tsv` | Bulgarian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Bulgarian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/kk.tsv` | Kazakh interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of the English UI labels into Kazakh, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Kazakh UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/ja.tsv` | Japanese interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Japanese UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/uk.tsv` | Ukrainian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Ukrainian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/ar.tsv` | Arabic interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Arabic UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/ckb.tsv` | Central Kurdish (Sorani) interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Central Kurdish UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/fa.tsv` | Persian (Farsi) interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-25 initial catalog covering the current 2,776-entry key union, AI-assisted translations from English, not separately native-reviewed | Persian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/tr.tsv` | Turkish interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Turkish UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/lt.tsv` | Lithuanian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels and user-facing messages; original catalog reviewed by a native Lithuanian-speaking contributor; 2026-10-15 coverage additions are AI-assisted and not separately native-reviewed; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Lithuanian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/hi.tsv` | Hindi interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Hindi UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/id.tsv` | Indonesian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Indonesian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/ko.tsv` | Korean interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Korean UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/ro.tsv` | Romanian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels and user-facing messages; AI-assisted and not yet reviewed line by line by a native Romanian speaker; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Romanian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/fi.tsv` | Finnish interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: AI-assisted (Claude Code) clean-room translations of PdfCraft's English UI labels and user-facing messages; not yet proofread by a native Finnish speaker; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 calculation-order, text-format, print, thumbnail, layer, comment-reshape and signature labels (previously English placeholders) are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Finnish UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `assets/icons/accessibility.svg` | Lucide icon "accessibility" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/accessibility.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
| `assets/icons/align-left.svg` | Lucide icon "align-left" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/align-left.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
| `assets/icons/align-center.svg` | Lucide icon "align-center" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/align-center.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
@@ -286,17 +258,11 @@ Every asset PdfCraft includes, bundles or uses to build its published material,
|
||||
| `packaging/macos/dmg/background.tiff` | PdfCraft macOS DMG window background (rendered) | @XusBadia | MIT OR Apache-2.0 | Rendered from packaging/macos/dmg/background.svg by packaging/macos/dmg/generate.py | 1x + 2x HiDPI 16-colour palette TIFF copied into the macOS DMG by packaging/macos/package.sh; includes the app icon and the free LittleCMS built-in sRGB profile |
|
||||
| `crates/sign/tests/data/x509-rsa-sha1.pdf` | One-page PDF with a legacy adbe.x509.rsa_sha1 signature by the RSA test key | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: hand-written PDF objects; signature made with `openssl dgst -sha1 -sign` over its byte ranges (see crates/sign/tests/data/README.md) | Signature validation tests (crates/sign/tests/it/pdf.rs): the legacy adbe.x509.rsa_sha1 format |
|
||||
| `assets/icons/monitor.svg` | Lucide icon "monitor" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/monitor.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
| `crates/ui-egui/src/i18n/vi.tsv` | Vietnamese interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels; PhotoCraft and VectorCraft Vietnamese catalogs used only as translation memory when English source and semantic context matched; original catalog reviewed by a native Vietnamese-speaking contributor; 2026-10-15 coverage additions are AI-assisted and not separately native-reviewed; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Vietnamese UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/sl.tsv` | Slovene interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Slovene UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `vendor/vello_common/assets/probe.png` | vello_common probe reference image (rendered from probe.rgba) | Linebender vello contributors | MIT OR Apache-2.0 | vello_common 0.0.8 (crates.io), vendored in vendor/vello_common; regenerated by its vello_sparse_tests regenerate_probe_reference binary | Reference picture of the vendored vello_common probe module, for people only; the build reads probe.rgba, not this file |
|
||||
| `crates/ui-egui/src/i18n/nb.tsv` | Norwegian Bokmål interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Norwegian Bokmål UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `assets/icons/superscript.svg` | Lucide icon "superscript" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/superscript.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
| `assets/icons/subscript.svg` | Lucide icon "subscript" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/subscript.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
| `assets/icons/pilcrow.svg` | Lucide icon "pilcrow" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/pilcrow.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
| `assets/icons/move-horizontal.svg` | Lucide icon "move-horizontal" | Lucide Contributors (portions Cole Bemis, Feather) | ISC AND MIT | https://github.com/lucide-icons/lucide (npm lucide-static 1.49.0, icons/move-horizontal.svg) | UI icon, embedded via crates/ui-egui/src/icon_data.rs |
|
||||
| `crates/ui-egui/src/i18n/sq.tsv` | Albanian interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-appearance labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Albanian UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/th.tsv` | Thai interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Thai UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
| `crates/ui-egui/src/i18n/ca.tsv` | Catalan interface translation catalog | PdfCraft contributors | MIT OR Apache-2.0 | Contributor-original: clean-room translations of PdfCraft's English UI labels, written from their meaning; no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed | Catalan UI strings, compiled in by crates/ui-egui/src/i18n.rs |
|
||||
|
||||
## Compiled in through dependencies (6)
|
||||
|
||||
@@ -338,10 +304,11 @@ Fonts are fetched by `cargo xtask demo-pdf` into `target/demo-fonts/`, OCR model
|
||||
| `text-detection.onnx` | Ocrs text detection model | Robert Knight (ocrs-models; trained on HierText, CC-BY-SA-4.0) | CC-BY-SA-4.0 | https://github.com/robertknight/ocrs/blob/0c826441362a701c55560fefc17bf356b6d1037e/ocrs/examples/download-models.sh (author-published ONNX models; model card: https://huggingface.co/robertknight/ocrs/blob/df0edd170279ab971b53e094c627255a87e1a503/README.md, cc-by-sa-4.0) | Scan & OCR: finds words on page images (cargo xtask models) |
|
||||
| `text-recognition.onnx` | Ocrs text recognition model | Robert Knight (ocrs-models; trained on HierText, CC-BY-SA-4.0) | CC-BY-SA-4.0 | https://github.com/robertknight/ocrs/blob/0c826441362a701c55560fefc17bf356b6d1037e/ocrs/examples/download-models.sh (author-published ONNX models; model card: https://huggingface.co/robertknight/ocrs/blob/df0edd170279ab971b53e094c627255a87e1a503/README.md, cc-by-sa-4.0) | Scan & OCR: reads the words it finds (cargo xtask models) |
|
||||
|
||||
## Optional build inputs (1)
|
||||
## Optional build inputs (2)
|
||||
|
||||
Not in this repository and never downloaded by it: compiled in only when the build sets the option (official releases do). Each input attributes its own files.
|
||||
|
||||
| Input | Option | Title | Author | Licence | Source | Attribution | Used for |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `craft-i18n` | `CRAFT_I18N_DIR` | Interface translations: the craft-i18n catalogs (locales/<code>/common.tsv and pdfcraft.tsv) of the 34 languages PdfCraft offers besides English | The craft-i18n translators, including every translator of PdfCraft's former in-repo catalogs (crates/ui-egui/src/i18n/*.tsv, migrated at pdfcraft@ecdd1e6) | MIT OR Apache-2.0 | https://github.com/storytold/craft-i18n (pinned by commit in craft-i18n.rev, which CI, releases and the flatpak manifests read) | https://github.com/storytold/craft-i18n/blob/main/ATTRIBUTION.md | Interface text in languages other than English, embedded by crates/ui-egui/build.rs and looked up through craft-libs' craft-i18n crate; a build without CRAFT_I18N_DIR is English only. Clean-room translations from PdfCraft's English interface labels |
|
||||
| `craft-fonts` | `CRAFT_FONTS_DIR` | Japanese fonts: BIZ UDPGothic (Regular, Bold), Shippori Mincho, BIZ UDMincho; native Simplified Chinese font: LXGW WenKai Lite; Arabic font: Noto Sans Arabic | The BIZ UDGothic and BIZ UDMincho Project Authors (Morisawa Inc.), The Shippori Mincho Project Authors (FONTDASU), LXGW and the original Klee Project Authors / Fontworks (LXGW WenKai Lite), The Noto Project Authors (Noto Sans Arabic) | OFL-1.1 | https://github.com/storytold/craft-fonts (pinned by commit in .github/workflows/release.yml and .github/workflows/ci.yml); LXGW WenKai Lite from https://github.com/lxgw/LxgwWenKai-Lite/releases/tag/v1.530 (commit b712c83d98acf977bacfb7fb010207802808bda9) | https://github.com/storytold/craft-fonts/blob/main/ATTRIBUTION.md | Japanese fallback in the interface (BIZ UDPGothic first) and Japanese glyphs in edited PDF text (Shippori Mincho); Simplified Chinese interface fallback on native builds only (LXGW WenKai Lite Regular, font SHA-256 f799a538a3355877e597a0ae04050e897932c9ae7689eb9227c2953c5dd549ea, OFL SHA-256 0333a85fe077b6849f8e417acc44e8bd879442ceb681e271acf93e2d57fd4e2e, read from fonts/simplified-chinese-manifest.txt and never embedded on wasm); Arabic interface text, file names and document titles (Noto Sans Arabic); the web build embeds BIZ UDPGothic Regular and the pinned small Arabic, Hebrew, Thai and Devanagari faces; the selected craft-fonts revision contains no Telugu face. Other non-Japanese CJK faces retain the general 4 MiB cap; the reviewed native-only LXGW fallback has a separate 16 MiB cap. Open-source OFL releases are permitted under current AGENTS.md §1.1 |
|
||||
+12
-341
@@ -1,296 +1,15 @@
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/el.tsv"
|
||||
title = "Greek interface translation catalog"
|
||||
author = "Camthalion77 and contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft English UI labels; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Greek UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
# ATTRIBUTION.toml: one entry per asset (AGENTS.md §1). The source of truth for provenance and licences.
|
||||
# ATTRIBUTION.md is generated from this file: `cargo xtask assets --write`. Checked by `cargo xtask assets` (part of `xtask ci`).
|
||||
#
|
||||
# [[asset]] a file in this repository (committed or vendored); `sha256` must match the file.
|
||||
# Translation catalogs (kind = "translation", crates/ui-egui/src/i18n/*.tsv) are project files
|
||||
# under the project licence and carry no `sha256`: git history records their provenance.
|
||||
# [[bundled]] a file compiled into PdfCraft by a Cargo dependency (its crate version must match Cargo.lock).
|
||||
# [[fetched]] downloaded at build time by xtask (never committed), pinned by `sha256`.
|
||||
# [[build_input]] an optional build input outside this repository (e.g. craft-fonts via CRAFT_FONTS_DIR);
|
||||
# [[build_input]] an optional build input outside this repository (craft-fonts via CRAFT_FONTS_DIR, craft-i18n via CRAFT_I18N_DIR);
|
||||
# never committed or downloaded here, its own repository attributes each file.
|
||||
#
|
||||
# licence: SPDX expression from the allowlist in AGENTS.md §1.2. adobe_data = true marks the closed list of
|
||||
# Adobe-authored non-visual technical data allowed by AGENTS.md §1.1.
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/zh-hans.tsv"
|
||||
title = "Simplified Chinese interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Simplified Chinese UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/zh-hant.tsv"
|
||||
title = "Traditional Chinese (Taiwan) interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Traditional Chinese UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/cs.tsv"
|
||||
title = "Czech interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check and standard-identification wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Czech UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/pt-br.tsv"
|
||||
title = "Brazilian Portuguese interface translation catalog"
|
||||
author = "André Cardoso (andrecards), PdfCraft contributors"
|
||||
source = "Clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources: the ~1,826-entry gist posted in issue #288 (https://gist.github.com/andrecards/ac388c25fba17312ce83207f8b7b467e), completed and reviewed by PdfCraft contributors; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table limit messages are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Brazilian Portuguese UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/es.tsv"
|
||||
title = "Spanish interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; the 2026-10-20 coverage additions are AI-assisted and not separately native-reviewed; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Spanish UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/fr.tsv"
|
||||
title = "French interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "French UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/de.tsv"
|
||||
title = "German interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "German UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/lo.tsv"
|
||||
title = "Lao interface translation catalog"
|
||||
author = "@bounkirdni-2025"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Lao UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/te.tsv"
|
||||
title = "Telugu interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Telugu UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/it.tsv"
|
||||
title = "Italian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Italian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/pl.tsv"
|
||||
title = "Polish interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Polish UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/ru.tsv"
|
||||
title = "Russian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Russian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/hu.tsv"
|
||||
title = "Hungarian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Hungarian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/bg.tsv"
|
||||
title = "Bulgarian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Bulgarian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/kk.tsv"
|
||||
title = "Kazakh interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of the English UI labels into Kazakh, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Kazakh UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/ja.tsv"
|
||||
title = "Japanese interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Japanese UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/uk.tsv"
|
||||
title = "Ukrainian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Ukrainian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/ar.tsv"
|
||||
title = "Arabic interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Arabic UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/ckb.tsv"
|
||||
title = "Central Kurdish (Sorani) interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Central Kurdish UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/fa.tsv"
|
||||
title = "Persian (Farsi) interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-25 initial catalog covering the current 2,776-entry key union, AI-assisted translations from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Persian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/tr.tsv"
|
||||
title = "Turkish interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Turkish UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/lt.tsv"
|
||||
title = "Lithuanian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels and user-facing messages; original catalog reviewed by a native Lithuanian-speaking contributor; 2026-10-15 coverage additions are AI-assisted and not separately native-reviewed; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Lithuanian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/hi.tsv"
|
||||
title = "Hindi interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Hindi UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/id.tsv"
|
||||
title = "Indonesian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Indonesian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/ko.tsv"
|
||||
title = "Korean interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Korean UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/ro.tsv"
|
||||
title = "Romanian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels and user-facing messages; AI-assisted and not yet reviewed line by line by a native Romanian speaker; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Romanian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/fi.tsv"
|
||||
title = "Finnish interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: AI-assisted (Claude Code) clean-room translations of PdfCraft's English UI labels and user-facing messages; not yet proofread by a native Finnish speaker; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 calculation-order, text-format, print, thumbnail, layer, comment-reshape and signature labels (previously English placeholders) are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Finnish UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "assets/icons/accessibility.svg"
|
||||
title = "Lucide icon \"accessibility\""
|
||||
@@ -3381,6 +3100,17 @@ kind = "model"
|
||||
usage = "Scan & OCR: reads the words it finds (cargo xtask models)"
|
||||
sha256 = "86c145c2edb96c8caed5b1ebb8f44d706408922211451c309c625157dd6061c5"
|
||||
|
||||
[[build_input]]
|
||||
name = "craft-i18n"
|
||||
option = "CRAFT_I18N_DIR"
|
||||
title = "Interface translations: the craft-i18n catalogs (locales/<code>/common.tsv and pdfcraft.tsv) of the 34 languages PdfCraft offers besides English"
|
||||
author = "The craft-i18n translators, including every translator of PdfCraft's former in-repo catalogs (crates/ui-egui/src/i18n/*.tsv, migrated at pdfcraft@ecdd1e6)"
|
||||
source = "https://github.com/storytold/craft-i18n (pinned by commit in craft-i18n.rev, which CI, releases and the flatpak manifests read)"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
attribution = "https://github.com/storytold/craft-i18n/blob/main/ATTRIBUTION.md"
|
||||
kind = "translation"
|
||||
usage = "Interface text in languages other than English, embedded by crates/ui-egui/build.rs and looked up through craft-libs' craft-i18n crate; a build without CRAFT_I18N_DIR is English only. Clean-room translations from PdfCraft's English interface labels"
|
||||
|
||||
[[build_input]]
|
||||
name = "craft-fonts"
|
||||
option = "CRAFT_FONTS_DIR"
|
||||
@@ -3414,26 +3144,6 @@ kind = "icon"
|
||||
usage = "UI icon, embedded via crates/ui-egui/src/icon_data.rs"
|
||||
sha256 = "d1a443233345724859de8e4fb48968ba91e885e12ddbd710701548bd91b39428"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/vi.tsv"
|
||||
title = "Vietnamese interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels; PhotoCraft and VectorCraft Vietnamese catalogs used only as translation memory when English source and semantic context matched; original catalog reviewed by a native Vietnamese-speaking contributor; 2026-10-15 coverage additions are AI-assisted and not separately native-reviewed; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-check wordings are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Vietnamese UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/sl.tsv"
|
||||
title = "Slovene interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-18 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Slovene UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
|
||||
path = "vendor/vello_common/assets/probe.png"
|
||||
@@ -3446,16 +3156,6 @@ kind = "image"
|
||||
usage = "Reference picture of the vendored vello_common probe module, for people only; the build reads probe.rgba, not this file"
|
||||
sha256 = "78c59a0cfd2c829909d77006f94e34dac1ae5d1f90e7f10f72e84de541fef697"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/nb.tsv"
|
||||
title = "Norwegian Bokmål interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Norwegian Bokmål UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "assets/icons/superscript.svg"
|
||||
title = "Lucide icon \"superscript\""
|
||||
@@ -3500,32 +3200,3 @@ kind = "icon"
|
||||
usage = "UI icon, embedded via crates/ui-egui/src/icon_data.rs"
|
||||
sha256 = "864ab2f19254e6ac7240bc6a98323197332e8f714d4d3f94831f41309e5ef2f7"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/sq.tsv"
|
||||
title = "Albanian interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 signature-appearance labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Albanian UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/th.tsv"
|
||||
title = "Thai interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Thai UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
|
||||
[[asset]]
|
||||
path = "crates/ui-egui/src/i18n/ca.tsv"
|
||||
title = "Catalan interface translation catalog"
|
||||
author = "PdfCraft contributors"
|
||||
source = "Contributor-original: clean-room translations of PdfCraft's English UI labels, written from their meaning; no proprietary localisation resources; 2026-10-22 page-gap labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 text-field-table labels are contributor-original AI-assisted translations from English, not separately native-reviewed; 2026-10-22 secured-document notice labels are contributor-original AI-assisted translations from English, not separately native-reviewed; the 2026-10-22 reply-count label is an AI-assisted translation from English, not separately native-reviewed"
|
||||
licence = "MIT OR Apache-2.0"
|
||||
licence_file = "LICENSE-MIT"
|
||||
kind = "translation"
|
||||
usage = "Catalan UI strings, compiled in by crates/ui-egui/src/i18n.rs"
|
||||
@@ -23,7 +23,7 @@ PdfCraft is a clean-room, open-source, Rust-native PDF application targeting Ado
|
||||
- **Layering.** Nothing below L7 depends on egui/winit/eframe/rfd (`plan/architecture.md` §3). `cos`/`filters`/`crypt`/`arlington` stay standalone.
|
||||
- **Page input.** Page modules read `PagePointer` (`crates/ui-egui/src/page_pointer.rs`), never egui's raw pointer state (`hover_pos`, `interact_pos`, `latest_pos`, `press_origin`, button reads); `page_pointer::tests::page_modules_read_the_pointer_only_through_page_pointer` enforces it.
|
||||
- **Page cursor.** Page modules claim the cursor for what is under the pointer (`view.cursor.claim(Layer::…, icon)`, `crates/ui-egui/src/canvas/page_cursor.rs`), never set it (`set_cursor_icon`, `cursor_icon =`, `on_hover_cursor`); `document_area` sets it once, from the claim on the highest layer the active tool reaches. `page_pointer::tests::page_modules_claim_the_cursor_and_never_set_it` enforces it.
|
||||
- **Page presses.** A page module decides what of its own is under a point in one hit test, which returns a `Hit` (owner, layer, cursor, tip; `crates/ui-egui/src/canvas/page_router.rs`) and gives its cursor, its tip and its press. It acts on a press only when the router says the press is its own (`view.router.owner(page)`), never by testing the press point again or by asking another module whether it wants it. Escape cancels any press the pages hold (`cancel_on_escape`), and that press is ignored until the button is up. `page_modules_take_presses_from_the_router_without_repeating_hit_tests` guards the centralized hit calls and captured-owner handlers; runtime routing tests cover gesture behavior.
|
||||
- **Page presses.** A page module decides what of its own is under a point in one hit test, which returns a `Hit` (owner, layer, cursor, tip; `crates/ui-egui/src/canvas/page_router.rs`) and gives its cursor, its tip and its press. It acts on a press only when the press is its own or, for the active tool, nobody's: the page view tells it which (`PagePress`: its own, nobody's, or another page's), and it never tests the press point again or asks another module whether it wants it. Escape cancels any press the pages hold (`cancel_on_escape`), and that press is ignored until the button is up. `page_pointer::tests::page_modules_act_on_a_press_only_through_the_router` enforces it.
|
||||
- **Fidelity.** The PDF object graph is the model. Preserve unknown data. Saves are incremental unless a full rewrite is required. Never silently drop or repair data without recording it.
|
||||
- **Never panic.** Every PDF, script, MCP call, settings file and keystroke is untrusted input, and none of it may crash the app or lose the user's work. This outranks feature work. Return `Result` (the crate's error enum) and propagate with `?`, or fall back leniently and record it. In non-test code:
|
||||
- No `unwrap`/`expect`/`panic!`/`unreachable!`/`todo!` unless it is provably infallible, with a comment saying why.
|
||||
|
||||
Generated
+37
-36
@@ -4208,7 +4208,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"craft-update",
|
||||
@@ -4232,7 +4232,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-a11y"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"pdfcraft-content",
|
||||
"pdfcraft-cos",
|
||||
@@ -4244,7 +4244,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-annot"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"hayro-syntax",
|
||||
"pdfcraft-cos",
|
||||
@@ -4255,7 +4255,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-audit"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"pdfcraft-content",
|
||||
"pdfcraft-cos",
|
||||
@@ -4266,7 +4266,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-automation"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"base64 0.23.1",
|
||||
"flate2",
|
||||
@@ -4288,7 +4288,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-cli"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"base64 0.23.1",
|
||||
"pdfcraft-audit",
|
||||
@@ -4306,11 +4306,11 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-compare"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-content"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"hayro-syntax",
|
||||
"pdfcraft-cos",
|
||||
@@ -4318,7 +4318,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-cos"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"hayro-syntax",
|
||||
@@ -4333,7 +4333,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-create"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"encoding_rs",
|
||||
"hayro-ccitt",
|
||||
@@ -4352,7 +4352,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-crypt"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"aes",
|
||||
"md-5",
|
||||
@@ -4364,7 +4364,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-edit"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"hayro-syntax",
|
||||
"kurbo 0.13.1",
|
||||
@@ -4382,7 +4382,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-engine"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"craft-docpath",
|
||||
@@ -4426,14 +4426,14 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-export"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"flate2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-filters"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"fax",
|
||||
"flate2",
|
||||
@@ -4446,7 +4446,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-fonts"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"harfrust",
|
||||
"pdfcraft-cos",
|
||||
@@ -4456,7 +4456,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-forms"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"hayro-syntax",
|
||||
"pdfcraft-content",
|
||||
@@ -4469,11 +4469,11 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-geom"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-js"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"boa_engine",
|
||||
"chrono",
|
||||
@@ -4481,7 +4481,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-measure"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"pdfcraft-annot",
|
||||
"pdfcraft-content",
|
||||
@@ -4494,14 +4494,14 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-model"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"pdfcraft-cos",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-ocr"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"ocrs",
|
||||
"pdfcraft-fonts",
|
||||
@@ -4512,7 +4512,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-optimize"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"image",
|
||||
"pdfcraft-annot",
|
||||
@@ -4528,11 +4528,11 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-oracle"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-organize"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"hayro-syntax",
|
||||
"pdfcraft-content",
|
||||
@@ -4543,7 +4543,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-platform"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"async-channel",
|
||||
"futures-lite",
|
||||
@@ -4553,7 +4553,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-preflight"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"flate2",
|
||||
"pdfcraft-content",
|
||||
@@ -4564,7 +4564,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-print"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"craft-print",
|
||||
"pdfcraft-content",
|
||||
@@ -4576,7 +4576,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-redact"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"pdfcraft-annot",
|
||||
"pdfcraft-content",
|
||||
@@ -4593,7 +4593,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-render"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"bytemuck",
|
||||
"flate2",
|
||||
@@ -4612,7 +4612,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-sign"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"aes",
|
||||
"aws-lc-rs",
|
||||
@@ -4648,17 +4648,18 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-testkit"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-ui-egui"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"arboard",
|
||||
"base64 0.23.1",
|
||||
"block2 0.6.2",
|
||||
"bytemuck",
|
||||
"chrono",
|
||||
"craft-i18n",
|
||||
"craft-keymap",
|
||||
"craft-menu",
|
||||
"craft-quit",
|
||||
@@ -4706,7 +4707,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-web"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"eframe",
|
||||
"egui",
|
||||
@@ -4718,7 +4719,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-xfa"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"base64 0.23.1",
|
||||
"image",
|
||||
@@ -4732,7 +4733,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pdfcraft-xfdf"
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
dependencies = [
|
||||
"pdfcraft-annot",
|
||||
"pdfcraft-cos",
|
||||
|
||||
+38
-34
@@ -5,7 +5,7 @@ exclude = ["vendor"]
|
||||
default-members = ["crates/*", "apps/pdfcraft", "apps/pdfcraft-cli", "xtask"]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.18.0"
|
||||
version = "0.18.1"
|
||||
edition = "2024"
|
||||
license = "MIT OR Apache-2.0"
|
||||
rust-version = "1.95"
|
||||
@@ -19,6 +19,10 @@ craft-quit = { git = "https://github.com/storytold/craft-libs", version = "0.1.0
|
||||
# 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 = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff" }
|
||||
craft-keymap = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff", default-features = false }
|
||||
# Interface translations: lookup, fallback, CLDR plurals and language names over the craft-i18n
|
||||
# catalogs that `crates/ui-egui/build.rs` embeds from `CRAFT_I18N_DIR` (storytold/craft-i18n, at
|
||||
# the commit in `craft-i18n.rev`). Already in the tree through craft-ui.
|
||||
craft-i18n = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff" }
|
||||
# Shared system spooler; document composition remains in pdfcraft-print.
|
||||
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).
|
||||
@@ -26,39 +30,39 @@ craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-l
|
||||
# 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 = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff", features = ["egui"] }
|
||||
# internal
|
||||
pdfcraft-geom = { path = "crates/geom", version = "0.18.0" }
|
||||
pdfcraft-filters = { path = "crates/filters", version = "0.18.0" }
|
||||
pdfcraft-cos = { path = "crates/cos", version = "0.18.0" }
|
||||
pdfcraft-crypt = { path = "crates/crypt", version = "0.18.0" }
|
||||
pdfcraft-organize = { path = "crates/organize", version = "0.18.0" }
|
||||
pdfcraft-measure = { path = "crates/measure", version = "0.18.0" }
|
||||
pdfcraft-annot = { path = "crates/annot", version = "0.18.0" }
|
||||
pdfcraft-audit = { path = "crates/audit", version = "0.18.0" }
|
||||
pdfcraft-fonts = { path = "crates/fonts", version = "0.18.0" }
|
||||
pdfcraft-model = { path = "crates/model", version = "0.18.0" }
|
||||
pdfcraft-content = { path = "crates/content", version = "0.18.0" }
|
||||
pdfcraft-redact = { path = "crates/redact", version = "0.18.0" }
|
||||
pdfcraft-print = { path = "crates/print", version = "0.18.0" }
|
||||
pdfcraft-xfdf = { path = "crates/xfdf", version = "0.18.0" }
|
||||
pdfcraft-sign = { path = "crates/sign", version = "0.18.0" }
|
||||
pdfcraft-optimize = { path = "crates/optimize", version = "0.18.0" }
|
||||
pdfcraft-a11y = { path = "crates/a11y", version = "0.18.0" }
|
||||
pdfcraft-oracle = { path = "crates/oracle", version = "0.18.0" }
|
||||
pdfcraft-testkit = { path = "crates/testkit", version = "0.18.0" }
|
||||
pdfcraft-ocr = { path = "crates/ocr", version = "0.18.0" }
|
||||
pdfcraft-js = { path = "crates/js", version = "0.18.0" }
|
||||
pdfcraft-compare = { path = "crates/compare", version = "0.18.0" }
|
||||
pdfcraft-preflight = { path = "crates/preflight", version = "0.18.0" }
|
||||
pdfcraft-export = { path = "crates/export", version = "0.18.0" }
|
||||
pdfcraft-edit = { path = "crates/edit", version = "0.18.0" }
|
||||
pdfcraft-create = { path = "crates/create", version = "0.18.0" }
|
||||
pdfcraft-forms = { path = "crates/forms", version = "0.18.0" }
|
||||
pdfcraft-xfa = { path = "crates/xfa", version = "0.18.0" }
|
||||
pdfcraft-render = { path = "crates/render", version = "0.18.0" }
|
||||
pdfcraft-engine = { path = "crates/engine", version = "0.18.0" }
|
||||
pdfcraft-platform = { path = "crates/platform", version = "0.18.0" }
|
||||
pdfcraft-ui-egui = { path = "crates/ui-egui", version = "0.18.0" }
|
||||
pdfcraft-automation = { path = "crates/automation", version = "0.18.0", default-features = false }
|
||||
pdfcraft-geom = { path = "crates/geom", version = "0.18.1" }
|
||||
pdfcraft-filters = { path = "crates/filters", version = "0.18.1" }
|
||||
pdfcraft-cos = { path = "crates/cos", version = "0.18.1" }
|
||||
pdfcraft-crypt = { path = "crates/crypt", version = "0.18.1" }
|
||||
pdfcraft-organize = { path = "crates/organize", version = "0.18.1" }
|
||||
pdfcraft-measure = { path = "crates/measure", version = "0.18.1" }
|
||||
pdfcraft-annot = { path = "crates/annot", version = "0.18.1" }
|
||||
pdfcraft-audit = { path = "crates/audit", version = "0.18.1" }
|
||||
pdfcraft-fonts = { path = "crates/fonts", version = "0.18.1" }
|
||||
pdfcraft-model = { path = "crates/model", version = "0.18.1" }
|
||||
pdfcraft-content = { path = "crates/content", version = "0.18.1" }
|
||||
pdfcraft-redact = { path = "crates/redact", version = "0.18.1" }
|
||||
pdfcraft-print = { path = "crates/print", version = "0.18.1" }
|
||||
pdfcraft-xfdf = { path = "crates/xfdf", version = "0.18.1" }
|
||||
pdfcraft-sign = { path = "crates/sign", version = "0.18.1" }
|
||||
pdfcraft-optimize = { path = "crates/optimize", version = "0.18.1" }
|
||||
pdfcraft-a11y = { path = "crates/a11y", version = "0.18.1" }
|
||||
pdfcraft-oracle = { path = "crates/oracle", version = "0.18.1" }
|
||||
pdfcraft-testkit = { path = "crates/testkit", version = "0.18.1" }
|
||||
pdfcraft-ocr = { path = "crates/ocr", version = "0.18.1" }
|
||||
pdfcraft-js = { path = "crates/js", version = "0.18.1" }
|
||||
pdfcraft-compare = { path = "crates/compare", version = "0.18.1" }
|
||||
pdfcraft-preflight = { path = "crates/preflight", version = "0.18.1" }
|
||||
pdfcraft-export = { path = "crates/export", version = "0.18.1" }
|
||||
pdfcraft-edit = { path = "crates/edit", version = "0.18.1" }
|
||||
pdfcraft-create = { path = "crates/create", version = "0.18.1" }
|
||||
pdfcraft-forms = { path = "crates/forms", version = "0.18.1" }
|
||||
pdfcraft-xfa = { path = "crates/xfa", version = "0.18.1" }
|
||||
pdfcraft-render = { path = "crates/render", version = "0.18.1" }
|
||||
pdfcraft-engine = { path = "crates/engine", version = "0.18.1" }
|
||||
pdfcraft-platform = { path = "crates/platform", version = "0.18.1" }
|
||||
pdfcraft-ui-egui = { path = "crates/ui-egui", version = "0.18.1" }
|
||||
pdfcraft-automation = { path = "crates/automation", version = "0.18.1", default-features = false }
|
||||
|
||||
# pdf
|
||||
hayro = "0.7.1"
|
||||
|
||||
@@ -223,6 +223,8 @@ Ranked; detail and the full milestone table in [docs/roadmap.md](docs/roadmap.md
|
||||
|
||||
## Progress log
|
||||
|
||||
- **2026-11-03 (M11, shared JBIG2 dictionary):** With Monochrome Images set to JBIG2, Optimize has up to 16 JBIG2 images share one symbol dictionary (`/JBIG2Globals`), the letters found on more than one page stored once, when that is smaller (`pdfcraft_filters::encode_jbig2_shared`). Eight pages of 10 pt text rendered at 300 dpi take 41% less in Helvetica and 42% in Times than coded alone, 10% in Courier; groups of 16 save 45%, of 32 only 47%. Only images redaction can store again without the dictionary share one (image masks and DeviceGray named directly, at most 64 Mi pixels), and redacting one stores the rest of its group so, which the group bounds to 15.
|
||||
|
||||
- **2026-11-03 (M5, #5850 review):** Resolve indirect IT when recognizing typewriter contents and Fill & Sign marks. Comment listing and property lookup retain their existing direct-Subtype behavior. A real double-click Edit composer preserves the typewriter’s text as written; ordinary comment edits keep trimming. Regressions cover direct Subtype with indirect intent, save/reopen, raw posted contents and same-index comments on different pages. The existing live-movement test now commits its setup with an outside click rather than Enter. Estimates unchanged.
|
||||
|
||||
- **2026-11-03 (M5, #5850):** Fill & Sign Enter inserts a line break in a growing editor; clicking outside commits and Escape cancels. Nonempty text keeps leading, internal and trailing line breaks. The headless fill_sign_add path sizes its typewriter box for the same wrapped lines so saved appearances show every row. Production-order keyboard and engine save/reopen/render regressions exercise the UI and headless callers. Estimates unchanged.
|
||||
|
||||
@@ -663,6 +663,29 @@ fn the_desktop_entry_names_the_window_class() {
|
||||
assert_eq!(class, Some(super::APP_ID));
|
||||
}
|
||||
|
||||
/// Both flatpak manifests build with the craft-i18n commit `craft-i18n.rev` pins: CI and
|
||||
/// releases read the file, and the manifests have to name the commit themselves. The pin may
|
||||
/// have a trailing newline or CRLF (a Windows checkout), so it is trimmed, as every reader does.
|
||||
#[test]
|
||||
fn the_flatpak_manifests_pin_the_craft_i18n_rev() {
|
||||
let root = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../..");
|
||||
let rev = std::fs::read_to_string(root.join("craft-i18n.rev")).unwrap();
|
||||
let rev = rev.trim();
|
||||
assert!(rev.len() == 40 && rev.bytes().all(|b| b.is_ascii_hexdigit()), "craft-i18n.rev holds one full SHA: {rev:?}");
|
||||
for manifest in ["ai.storyteller.pdfcraft.yml", "ai.storyteller.pdfcraft.bundle.yml"] {
|
||||
let text = std::fs::read_to_string(root.join("packaging/linux/flatpak").join(manifest)).unwrap();
|
||||
let source =
|
||||
text.split("url: https://github.com/storytold/craft-i18n").nth(1).unwrap_or_else(|| panic!("{manifest}: a craft-i18n git source"));
|
||||
let source = source.split("- type:").next().unwrap_or(source);
|
||||
let commit = source
|
||||
.lines()
|
||||
.find_map(|l| l.trim().strip_prefix("commit:"))
|
||||
.unwrap_or_else(|| panic!("{manifest}: the craft-i18n source pins a commit"));
|
||||
assert_eq!(commit.trim().trim_matches(['\'', '"']), rev, "{manifest}");
|
||||
assert!(text.contains("CRAFT_I18N_DIR: /run/build/pdfcraft/craft-i18n"), "{manifest}: the build names the catalogs");
|
||||
}
|
||||
}
|
||||
|
||||
// Regression test for #246: `eprintln!` panics when standard error is a broken pipe (a GUI
|
||||
// launch on Windows), and a panic inside the panic hook aborts the process. The start-up
|
||||
// path and the hook must write to standard error without it.
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
575cfdef63227b14daf173b8cc87928bfdfa325e
|
||||
@@ -1459,7 +1459,7 @@ pub fn tools() -> Vec<ToolDef> {
|
||||
.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, 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 past what one run may decode stay as they are, counted in images_refused; streams it only stores with Flate past that stay LZW, uncounted. 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, up to 16 JBIG2 images sharing one symbol dictionary (/JBIG2Globals) where that is smaller still (image masks and DeviceGray images named directly, of at most 64 Mi pixels, which redaction can store again without it), 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 past what one run may decode stay as they are, counted in images_refused; streams it only stores with Flate past that stay LZW, uncounted. 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!({
|
||||
|
||||
@@ -25,6 +25,12 @@ pub const MAX_PAGE_DECODED: usize = 256 << 20;
|
||||
/// Form XObjects one page's content walk may enter, each entry counted again.
|
||||
pub const MAX_PAGE_FORMS: usize = 50_000;
|
||||
|
||||
/// The most pixels an image redaction decodes, to clear the ones under a mark or to store again
|
||||
/// without the `/JBIG2Globals` it shares with a redacted image (`pdfcraft_redact`). Optimize has
|
||||
/// JBIG2 images share a dictionary only within it (`pdfcraft_optimize`), so that redaction can
|
||||
/// store each of them again: one it couldn't would refuse the redaction.
|
||||
pub const MAX_REDACTED_IMAGE_PIXELS: u64 = 64 << 20;
|
||||
|
||||
/// The steps a sample of a JPEG costs: a few bytes can hold a page of one grey, and decoding,
|
||||
/// resampling and storing it took about 20 to 45 ns a sample.
|
||||
const JPEG_WORK: u64 = 2;
|
||||
|
||||
@@ -19,6 +19,7 @@ mod reader;
|
||||
mod state;
|
||||
mod xref;
|
||||
|
||||
pub(crate) use objects::Held;
|
||||
#[cfg(test)]
|
||||
pub(crate) use reader::find;
|
||||
#[cfg(test)]
|
||||
@@ -62,6 +63,10 @@ pub struct Document {
|
||||
security: Option<Arc<pdfcraft_crypt::SecurityHandler>>,
|
||||
/// Object number of the `/Encrypt` dictionary (never encrypted itself).
|
||||
encrypt_num: Option<u32>,
|
||||
/// What that dictionary and `/ID` refer to, which the key comes from, and so is as stored.
|
||||
encrypt_members: Arc<HashSet<u32>>,
|
||||
/// Object numbers a scan of the file didn't find: the file doesn't change, so it never will.
|
||||
unfound: Arc<Mutex<HashSet<u32>>>,
|
||||
/// Encryption was added, changed or removed since opening: only a full save can apply it.
|
||||
encryption_changed: bool,
|
||||
/// Set by edits that must not leave earlier revisions in the file (redaction).
|
||||
|
||||
@@ -156,12 +156,16 @@ impl Document {
|
||||
self.try_get(r.num).unwrap_or_else(|_| Arc::new(Object::Null))
|
||||
}
|
||||
|
||||
/// Follow a reference if `o` is one; otherwise return `o` itself.
|
||||
/// Follow a reference if `o` is one; otherwise return `o` itself. An object can be nothing but
|
||||
/// a reference to another, which is followed too, up to [`MAX_REFERENCE_HOPS`] of them.
|
||||
pub fn resolve(&self, o: &Object) -> Arc<Object> {
|
||||
match o {
|
||||
Object::Ref(r) => self.get(*r),
|
||||
other => Arc::new(other.clone()),
|
||||
let Object::Ref(r) = o else { return Arc::new(o.clone()) };
|
||||
let mut held = self.get(*r);
|
||||
for _ in 0..MAX_REFERENCE_HOPS {
|
||||
let Object::Ref(r) = &*held else { break };
|
||||
held = self.get(*r);
|
||||
}
|
||||
held
|
||||
}
|
||||
|
||||
/// `s` with the `/DecodeParms` its filters use made direct, so [`Stream::decoded`] reads them:
|
||||
@@ -218,7 +222,7 @@ impl Document {
|
||||
}
|
||||
|
||||
/// `o`, or the object it refers to, without copying either.
|
||||
fn held<'o>(&self, o: &'o Object) -> Held<'o> {
|
||||
pub(crate) fn held<'o>(&self, o: &'o Object) -> Held<'o> {
|
||||
match o {
|
||||
Object::Ref(_) => Held::Resolved(self.resolve(o)),
|
||||
o => Held::Direct(o),
|
||||
@@ -395,6 +399,7 @@ impl Document {
|
||||
// cycles such as `6 0 obj << /Length 6 0 R >>`. Bound the nesting on every path.
|
||||
let _guard =
|
||||
LoadGuard::enter(num).ok_or_else(|| CosError::Syntax { offset: 0, detail: format!("reference cycle while loading object {num}") })?;
|
||||
let _scope = crate::security::FollowScope::enter();
|
||||
let obj = self.load(num, 0)?;
|
||||
let obj = Arc::new(obj);
|
||||
// The editing cache is bounded like the scan reader's: re-parsing a file-backed view
|
||||
@@ -562,7 +567,11 @@ impl Document {
|
||||
let Object::Stream(s) = &*loaded else { return Err(CosError::MissingObject(num)) };
|
||||
let n = s.dict.int(b"N").unwrap_or(0).clamp(0, 1_000_000) as usize;
|
||||
let first = usize::try_from(s.dict.int(b"First").unwrap_or(0).max(0)).ok();
|
||||
let data = s.decoded_within(self.stream_limit)?;
|
||||
// Its parameters can be given by reference, and can sit in another object stream. A scan of
|
||||
// the file's object streams comes here without a read around it.
|
||||
let _scope = crate::security::FollowScope::enter();
|
||||
let readable = crate::security::following(Cow::Borrowed(s), || self.with_direct_parms(s));
|
||||
let data = readable.decoded_within(self.stream_limit)?;
|
||||
let mut lx = Lexer::new(&data, 0);
|
||||
let mut index = Vec::with_capacity(n);
|
||||
for _ in 0..n {
|
||||
@@ -577,8 +586,14 @@ impl Document {
|
||||
Ok(stm)
|
||||
}
|
||||
|
||||
/// Last-resort lookup: scan the file for `num G obj`.
|
||||
/// Last-resort lookup: scan the file for `num G obj`. What isn't there is remembered: each miss
|
||||
/// reads the whole file, and a file can refer to such an object from everywhere.
|
||||
fn scan_for(&self, num: u32) -> Option<(ObjRef, Object)> {
|
||||
if self.unfound.lock().is_ok_and(|unfound| unfound.contains(&num)) {
|
||||
return None;
|
||||
}
|
||||
#[cfg(test)]
|
||||
super::tests::FILE_SCANS.with(|scans| scans.set(scans.get() + 1));
|
||||
let needle = format!("{num} ");
|
||||
let data = &self.data;
|
||||
let mut found = None;
|
||||
@@ -594,6 +609,11 @@ impl Document {
|
||||
found = Some((id, o)); // keep the last (newest) definition
|
||||
}
|
||||
}
|
||||
if found.is_none()
|
||||
&& let Ok(mut unfound) = self.unfound.lock()
|
||||
{
|
||||
unfound.insert(num);
|
||||
}
|
||||
found
|
||||
}
|
||||
|
||||
@@ -786,9 +806,13 @@ const DECODE_PARMS_KEYS: [&[u8]; 13] = [
|
||||
b"ColorTransform",
|
||||
];
|
||||
|
||||
/// How many references in a row [`Document::resolve`] follows: enough for any file, and it ends a
|
||||
/// cycle of them.
|
||||
const MAX_REFERENCE_HOPS: usize = 32;
|
||||
|
||||
/// An object read in place, or the object a reference names as the document holds it: either way
|
||||
/// nothing is copied ([`Document::held`]).
|
||||
enum Held<'o> {
|
||||
pub(crate) enum Held<'o> {
|
||||
Direct(&'o Object),
|
||||
Resolved(Arc<Object>),
|
||||
}
|
||||
|
||||
@@ -1,7 +1,11 @@
|
||||
use super::reader::find;
|
||||
use super::state::Credentials;
|
||||
use super::xref::XrefIndex;
|
||||
use super::{Arc, BTreeMap, CosError, Dict, Document, ObjRef, Object};
|
||||
use super::{Arc, BTreeMap, CosError, Dict, Document, HashSet, ObjRef, Object};
|
||||
|
||||
/// More objects than `/Encrypt` and `/ID` refer to in any file, so that one which refers to the page
|
||||
/// tree, say, doesn't have a whole document read to open it.
|
||||
const MAX_ENCRYPT_MEMBERS: usize = 64;
|
||||
|
||||
impl Document {
|
||||
/// A new document with an empty page tree (for split / extract / combine). It has no
|
||||
@@ -27,6 +31,8 @@ impl Document {
|
||||
version: "1.7".into(),
|
||||
security: None,
|
||||
encrypt_num: None,
|
||||
encrypt_members: Arc::default(),
|
||||
unfound: Arc::default(),
|
||||
encryption_changed: false,
|
||||
full_save: false,
|
||||
out_security: None,
|
||||
@@ -111,6 +117,8 @@ impl Document {
|
||||
version,
|
||||
security: None,
|
||||
encrypt_num: None,
|
||||
encrypt_members: Arc::default(),
|
||||
unfound: Arc::default(),
|
||||
encryption_changed: false,
|
||||
full_save: false,
|
||||
out_security: None,
|
||||
@@ -185,6 +193,8 @@ impl Document {
|
||||
};
|
||||
let params = crate::security::encrypt_dict(self, &dict);
|
||||
let id0 = self.first_id();
|
||||
// Read here, while nothing is decrypted yet.
|
||||
let members = self.encryption_members(enc);
|
||||
let handler = match credentials {
|
||||
Credentials::Password(password) => Arc::new(pdfcraft_crypt::SecurityHandler::open(params, &id0, *password).map_err(|e| match e {
|
||||
pdfcraft_crypt::CryptError::WrongPassword if password.is_none() => CosError::NeedsPassword,
|
||||
@@ -197,6 +207,7 @@ impl Document {
|
||||
};
|
||||
self.security = Some(handler);
|
||||
self.encrypt_num = num;
|
||||
self.encrypt_members = Arc::new(members);
|
||||
// Objects read while locating the catalog were read before decryption was possible.
|
||||
self.cache = Arc::default();
|
||||
self.objstms = Arc::default();
|
||||
@@ -205,10 +216,42 @@ impl Document {
|
||||
|
||||
/// The first file identifier, part of the encryption key (empty when there is none).
|
||||
fn first_id(&self) -> Vec<u8> {
|
||||
match self.trailer.get(b"ID") {
|
||||
Some(Object::Array(a)) => a.first().and_then(|s| s.as_string()).map(|s| s.bytes.clone()).unwrap_or_default(),
|
||||
_ => Vec::new(),
|
||||
let id = self.trailer.get(b"ID").map(|id| self.resolve(id));
|
||||
let first = id.as_deref().and_then(Object::as_array).and_then(|a| a.first()).map(|s| self.resolve(s));
|
||||
first.as_deref().and_then(Object::as_string).map(|s| s.bytes.clone()).unwrap_or_default()
|
||||
}
|
||||
|
||||
/// The objects `/Encrypt`, given as `enc`, and `/ID` refer to, the ones they refer to, and so
|
||||
/// on, up to [`MAX_ENCRYPT_MEMBERS`]. Their strings aren't encrypted (ISO 32000-2 §7.6.2): the
|
||||
/// key is made from them, so they have to read as stored, and stay so. A number with no object
|
||||
/// behind it, and a stream, which those dictionaries never hold, isn't one: an object added
|
||||
/// under that number later, or a page's content a hostile `/Encrypt` names, is encrypted.
|
||||
fn encryption_members(&self, enc: &Object) -> HashSet<u32> {
|
||||
let mut pending = Vec::new();
|
||||
crate::writer::collect_refs(enc, &mut |r| pending.push(r));
|
||||
if let Some(id) = self.trailer.get(b"ID") {
|
||||
crate::writer::collect_refs(id, &mut |r| pending.push(r));
|
||||
}
|
||||
let mut members = HashSet::new();
|
||||
while let Some(r) = pending.pop() {
|
||||
if members.len() >= MAX_ENCRYPT_MEMBERS || members.contains(&r.num) {
|
||||
continue;
|
||||
}
|
||||
let held = self.get(r);
|
||||
if matches!(&*held, Object::Null | Object::Stream(_)) {
|
||||
continue;
|
||||
}
|
||||
members.insert(r.num);
|
||||
crate::writer::collect_refs(&held, &mut |x| pending.push(x));
|
||||
}
|
||||
members
|
||||
}
|
||||
|
||||
/// Whether object `num` is written as it is held, being one of [`Document::encryption_members`],
|
||||
/// unedited, and the save writing the same `/Encrypt`. What was edited or added is encrypted
|
||||
/// whatever its number.
|
||||
pub(crate) fn stored_as_is(&self, num: u32) -> bool {
|
||||
!self.encryption_changed && !self.is_edited(num) && self.encrypt_members.contains(&num)
|
||||
}
|
||||
|
||||
/// Lift the restrictions of a document opened with its user password by entering the
|
||||
@@ -270,8 +313,9 @@ impl Document {
|
||||
/// always a full rewrite. Returns the handler (authenticated as owner).
|
||||
pub fn set_encryption(&mut self, params: &pdfcraft_crypt::NewEncryption) -> Result<(), CosError> {
|
||||
// The file identifier is part of the key; make sure it exists and keep it.
|
||||
let id0 = match self.trailer.get(b"ID") {
|
||||
Some(Object::Array(a)) if a.len() == 2 => a[0].as_string().map(|s| s.bytes.clone()).unwrap_or_default(),
|
||||
let id = self.trailer.get(b"ID").map(|id| self.resolve(id));
|
||||
let id0 = match id.as_deref() {
|
||||
Some(Object::Array(a)) if a.len() == 2 => self.first_id(),
|
||||
_ => {
|
||||
let id = pdfcraft_crypt::file_id(¶ms.seed);
|
||||
let s = Object::String(crate::PdfString { bytes: id.clone(), hex: true });
|
||||
@@ -338,7 +382,9 @@ impl Document {
|
||||
/// Decrypt a freshly parsed indirect object if the document is encrypted.
|
||||
pub(super) fn decrypted(&self, id: ObjRef, o: Object) -> Object {
|
||||
match &self.security {
|
||||
Some(h) if Some(id.num) != self.encrypt_num => crate::security::transform(h, &o, id.num, id.generation, crate::security::Pass::Decrypt),
|
||||
Some(h) if Some(id.num) != self.encrypt_num && !self.encrypt_members.contains(&id.num) => {
|
||||
crate::security::transform(self, h, &o, id.num, id.generation, crate::security::Pass::Decrypt)
|
||||
}
|
||||
_ => o,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,147 @@
|
||||
use super::*;
|
||||
|
||||
std::thread_local! {
|
||||
/// How many times `Document::scan_for` read the file on this thread.
|
||||
pub(super) static FILE_SCANS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
|
||||
}
|
||||
|
||||
/// A scan that doesn't find an object isn't made again: each reads the whole file, and a file can
|
||||
/// refer to such an object from every object it has.
|
||||
#[test]
|
||||
fn what_a_scan_of_the_file_did_not_find_is_remembered() {
|
||||
let body = b"%PDF-1.7\n1 0 obj << /Type /Catalog /Pages 2 0 R >> endobj\n2 0 obj << /Type /Pages /Kids [] /Count 0 >> endobj\n";
|
||||
let mut out = body.to_vec();
|
||||
let xref = out.len();
|
||||
out.extend_from_slice(b"xref\n0 4\n0000000000 65535 f \n");
|
||||
out.extend_from_slice(format!("{:010} 00000 n \n", 9).as_bytes());
|
||||
out.extend_from_slice(format!("{:010} 00000 n \n", body.iter().position(|b| *b == b'\n').unwrap() + 49).as_bytes());
|
||||
out.extend_from_slice(b"0000000001 00000 n \n");
|
||||
out.extend_from_slice(format!("trailer << /Size 4 /Root 1 0 R >>\nstartxref\n{xref}\n%%EOF\n").as_bytes());
|
||||
let doc = Document::open(Arc::new(out)).unwrap();
|
||||
FILE_SCANS.with(|scans| scans.set(0));
|
||||
for _ in 0..5 {
|
||||
assert!(doc.try_get(3).is_err());
|
||||
}
|
||||
assert_eq!(FILE_SCANS.with(std::cell::Cell::get), 1);
|
||||
let clone = doc.clone();
|
||||
assert!(clone.try_get(3).is_err());
|
||||
assert_eq!(FILE_SCANS.with(std::cell::Cell::get), 1, "a clone has the same file");
|
||||
}
|
||||
|
||||
/// An object can be nothing but a reference to another. A chain of them is followed, and one that
|
||||
/// goes round ends in what isn't a dictionary or a name, without hanging.
|
||||
#[test]
|
||||
fn references_to_references_are_followed() {
|
||||
let mut doc = Document::new_empty();
|
||||
let name = doc.add(Object::name("Target"));
|
||||
let one = doc.add(Object::Ref(name));
|
||||
let two = doc.add(Object::Ref(one));
|
||||
assert_eq!(doc.resolve(&Object::Ref(two)).as_name(), Some(b"Target".as_slice()));
|
||||
let a = doc.add(Object::Null);
|
||||
let b = doc.add(Object::Ref(a));
|
||||
doc.set(a, Object::Ref(b));
|
||||
assert_eq!(doc.resolve(&Object::Ref(a)).as_name(), None);
|
||||
}
|
||||
|
||||
/// An object stream's `/DecodeParms` can be given by reference: without them a predictor isn't
|
||||
/// undone, so its members were lost.
|
||||
#[test]
|
||||
fn an_object_stream_with_parameters_by_reference_is_read() {
|
||||
let members = b"3 0 << /Hidden (yes) >>";
|
||||
// PNG Sub, one row.
|
||||
let mut rows = vec![1u8];
|
||||
let mut before = 0u8;
|
||||
for b in members {
|
||||
rows.push(b.wrapping_sub(before));
|
||||
before = *b;
|
||||
}
|
||||
let coded = pdfcraft_filters::encode_flate(&rows);
|
||||
let mut out = b"%PDF-1.5\n".to_vec();
|
||||
let mut offs = [0usize; 7];
|
||||
let mut obj = |out: &mut Vec<u8>, n: usize, body: &[u8]| {
|
||||
offs[n] = out.len();
|
||||
out.extend_from_slice(format!("{n} 0 obj\n").as_bytes());
|
||||
out.extend_from_slice(body);
|
||||
out.extend_from_slice(b"\nendobj\n");
|
||||
};
|
||||
obj(&mut out, 1, b"<< /Type /Catalog /Pages 2 0 R >>");
|
||||
obj(&mut out, 2, b"<< /Type /Pages /Kids [] /Count 0 /Extra 3 0 R >>");
|
||||
let mut stm = format!("<< /Type /ObjStm /N 1 /First 4 /Filter /FlateDecode /DecodeParms 6 0 R /Length {} >>\nstream\n", coded.len()).into_bytes();
|
||||
stm.extend_from_slice(&coded);
|
||||
stm.extend_from_slice(b"\nendstream");
|
||||
obj(&mut out, 4, &stm);
|
||||
let data = [2u8, 0, 4, 0];
|
||||
let mut xs = format!("<< /Type /XRef /Size 7 /W [1 2 1] /Index [3 1] /Length {} >>\nstream\n", data.len()).into_bytes();
|
||||
xs.extend_from_slice(&data);
|
||||
xs.extend_from_slice(b"\nendstream");
|
||||
obj(&mut out, 5, &xs);
|
||||
obj(&mut out, 6, format!("<< /Predictor 11 /Columns {} >>", members.len()).as_bytes());
|
||||
let table = out.len();
|
||||
out.extend_from_slice(b"xref\n0 7\n0000000000 65535 f \n");
|
||||
for (n, off) in offs.iter().enumerate().skip(1) {
|
||||
let line = if n == 3 { "0000000000 65535 f \n".to_string() } else { format!("{off:010} 00000 n \n") };
|
||||
out.extend_from_slice(line.as_bytes());
|
||||
}
|
||||
out.extend_from_slice(format!("trailer << /Size 7 /Root 1 0 R /XRefStm {} >>\nstartxref\n{table}\n%%EOF\n", offs[5]).as_bytes());
|
||||
let doc = Document::open(Arc::new(out)).unwrap();
|
||||
let hidden = doc.get(ObjRef::new(3, 0));
|
||||
assert_eq!(hidden.as_dict().and_then(|d| d.get(b"Hidden")).and_then(Object::as_string).map(|s| s.bytes.clone()), Some(b"yes".to_vec()));
|
||||
}
|
||||
|
||||
/// Each entry of an `/Encrypt` dictionary, and of a crypt filter in it, reads the same by reference.
|
||||
/// Read as absent, `/StmF` or `/CFM` was `/Identity`, so a whole file's streams stayed ciphertext.
|
||||
#[test]
|
||||
fn encrypt_dictionary_entries_read_the_same_by_reference() {
|
||||
let string = |s: &str| Object::String(crate::PdfString::text(s));
|
||||
let mut filter = Dict::new();
|
||||
filter.set(b"CFM".to_vec(), Object::name("AESV2"));
|
||||
filter.set(b"Length".to_vec(), Object::Int(5));
|
||||
let cf = |filter: Dict| {
|
||||
let mut cf = Dict::new();
|
||||
cf.set(b"StdCF".to_vec(), Object::Dict(filter));
|
||||
cf.set(b"Other".to_vec(), Object::Dict(Dict::new()));
|
||||
Object::Dict(cf)
|
||||
};
|
||||
let mut d = Dict::new();
|
||||
let entries = [
|
||||
("Filter", Object::name("Standard")),
|
||||
("V", Object::Int(4)),
|
||||
("R", Object::Int(4)),
|
||||
("Length", Object::Int(128)),
|
||||
("P", Object::Int(-44)),
|
||||
("O", string("owner")),
|
||||
("U", string("user")),
|
||||
("EncryptMetadata", Object::Bool(false)),
|
||||
("CF", cf(filter.clone())),
|
||||
("StmF", Object::name("StdCF")),
|
||||
("StrF", Object::name("Other")),
|
||||
("EFF", Object::name("StdCF")),
|
||||
];
|
||||
for (key, value) in &entries {
|
||||
d.set(key.as_bytes().to_vec(), value.clone());
|
||||
}
|
||||
let mut doc = Document::new_empty();
|
||||
let direct = crate::security::encrypt_dict(&doc, &d);
|
||||
assert_eq!((direct.stm_f.as_slice(), direct.str_f.as_slice(), direct.ef_f.as_slice()), (&b"StdCF"[..], &b"Other"[..], &b"StdCF"[..]));
|
||||
assert_eq!(direct.length_bits, 40, "the filter's own length, in bytes");
|
||||
assert!(!direct.encrypt_metadata);
|
||||
assert_eq!(direct.crypt_filters.iter().filter(|(_, m)| *m == pdfcraft_crypt::Method::Aes128).count(), 1);
|
||||
for (key, value) in &entries {
|
||||
let mut one = d.clone();
|
||||
let r = doc.add(value.clone());
|
||||
one.set(key.as_bytes().to_vec(), Object::Ref(r));
|
||||
assert_eq!(crate::security::encrypt_dict(&doc, &one), direct, "/{key}");
|
||||
}
|
||||
for key in ["CFM", "Length"] {
|
||||
let mut by_reference = filter.clone();
|
||||
let r = doc.add(filter.get(key.as_bytes()).unwrap().clone());
|
||||
by_reference.set(key.as_bytes().to_vec(), Object::Ref(r));
|
||||
let mut one = d.clone();
|
||||
one.set(b"CF".to_vec(), cf(by_reference));
|
||||
assert_eq!(crate::security::encrypt_dict(&doc, &one), direct, "/{key} in the filter");
|
||||
}
|
||||
}
|
||||
|
||||
/// /DecodeParms given by reference, whole, as array entries or as the numbers inside, are read
|
||||
/// once made direct: here a Flate predictor, which the stream alone doesn't see. Only the entries the filters use are
|
||||
/// resolved, and nothing is for a chain longer than a decoder takes.
|
||||
|
||||
@@ -22,7 +22,7 @@ mod parser;
|
||||
mod security;
|
||||
mod writer;
|
||||
|
||||
pub use budget::{DecodeBudget, ImageBudget, MAX_PAGE_DECODED, MAX_PAGE_FORMS};
|
||||
pub use budget::{DecodeBudget, ImageBudget, MAX_PAGE_DECODED, MAX_PAGE_FORMS, MAX_REDACTED_IMAGE_PIXELS};
|
||||
pub use bytes::Bytes;
|
||||
pub use document::{Document, ReadState, Revision, SourceIdentity, XrefEntry};
|
||||
pub use object::{Dict, MAX_DECODED, MAX_JBIG2_GLOBALS, Name, ObjRef, Object, PdfString, Stream};
|
||||
|
||||
+214
-80
@@ -7,10 +7,69 @@
|
||||
//! false. Streams naming a crypt filter (`/Crypt` in `/Filter`) use that filter; embedded files
|
||||
//! use `/EFF`.
|
||||
|
||||
use pdfcraft_crypt::{EncryptDict, Method, SecurityHandler, StreamKind};
|
||||
use std::cell::Cell;
|
||||
|
||||
use pdfcraft_crypt::{EncryptDict, Method, SecurityHandler, StreamKind};
|
||||
use pdfcraft_filters::MAX_CHAIN;
|
||||
|
||||
use crate::document::Held;
|
||||
use crate::{Dict, Document, Object, PdfString, Stream};
|
||||
|
||||
/// How many references one read or write of an object may follow, with all that it loads on the
|
||||
/// way. How an object is treated can be given by reference, and what that loads can do the same: a
|
||||
/// file could make one read a tree of them, each object read again once the cache has let it go.
|
||||
/// An object takes a few of these, and two dozen if every part of it is given by reference; past
|
||||
/// this they read as absent. The parameters of an object stream, read together, count as one.
|
||||
const MAX_FOLLOWED: u32 = 32;
|
||||
|
||||
std::thread_local! {
|
||||
/// How many [`FollowScope`]s this thread is inside.
|
||||
static SCOPES: Cell<u32> = const { Cell::new(0) };
|
||||
/// The references followed in the outermost of them.
|
||||
static FOLLOWED: Cell<u32> = const { Cell::new(0) };
|
||||
/// The references refused in the outermost of them, past [`MAX_FOLLOWED`].
|
||||
static REFUSED: Cell<u32> = const { Cell::new(0) };
|
||||
}
|
||||
|
||||
/// One read or write of an object, with everything it loads on the way: what [`MAX_FOLLOWED`] counts.
|
||||
pub(crate) struct FollowScope;
|
||||
|
||||
impl FollowScope {
|
||||
pub(crate) fn enter() -> Self {
|
||||
if SCOPES.replace(SCOPES.get().saturating_add(1)) == 0 {
|
||||
FOLLOWED.set(0);
|
||||
REFUSED.set(0);
|
||||
}
|
||||
FollowScope
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for FollowScope {
|
||||
fn drop(&mut self) {
|
||||
SCOPES.set(SCOPES.get().saturating_sub(1));
|
||||
}
|
||||
}
|
||||
|
||||
/// What `f` gives, counted against [`MAX_FOLLOWED`], or `spent` past it. Called inside a
|
||||
/// [`FollowScope`], which is what starts the count again.
|
||||
pub(crate) fn following<T>(spent: T, f: impl FnOnce() -> T) -> T {
|
||||
if FOLLOWED.get() >= MAX_FOLLOWED {
|
||||
REFUSED.set(REFUSED.get().saturating_add(1));
|
||||
return spent;
|
||||
}
|
||||
FOLLOWED.set(FOLLOWED.get() + 1);
|
||||
f()
|
||||
}
|
||||
|
||||
/// `o`, or the object it refers to, for what decides how a stream or dictionary is treated. Past
|
||||
/// [`MAX_FOLLOWED`] a reference reads as absent.
|
||||
fn followed<'o>(doc: &Document, o: &'o Object) -> Held<'o> {
|
||||
match o {
|
||||
Object::Ref(_) => following(Held::Direct(&Object::Null), || doc.held(o)),
|
||||
o => Held::Direct(o),
|
||||
}
|
||||
}
|
||||
|
||||
fn bytes_of(doc: &Document, d: &Dict, key: &[u8]) -> Vec<u8> {
|
||||
d.get(key).map(|v| doc.resolve(v)).and_then(|v| v.as_string().map(|s| s.bytes.clone())).unwrap_or_default()
|
||||
}
|
||||
@@ -18,12 +77,12 @@ fn bytes_of(doc: &Document, d: &Dict, key: &[u8]) -> Vec<u8> {
|
||||
/// Read the handler parameters from an `/Encrypt` dictionary.
|
||||
pub(crate) fn encrypt_dict(doc: &Document, d: &Dict) -> EncryptDict {
|
||||
let int = |k: &[u8], default: i64| d.get(k).map(|v| doc.resolve(v)).and_then(|v| v.as_int()).unwrap_or(default);
|
||||
let name = |k: &[u8]| d.get(k).and_then(|v| v.as_name()).map(|n| n.to_vec()).unwrap_or_else(|| b"Identity".to_vec());
|
||||
let name = |d: &Dict, k: &[u8]| d.get(k).and_then(|v| doc.resolve(v).as_name().map(<[u8]>::to_vec));
|
||||
let mut crypt_filters = Vec::new();
|
||||
if let Some(cf) = d.get(b"CF").map(|c| doc.resolve(c)).and_then(|c| c.as_dict().cloned()) {
|
||||
for (k, v) in cf.iter() {
|
||||
let Some(f) = doc.resolve(v).as_dict().cloned() else { continue };
|
||||
let method = match f.name(b"CFM") {
|
||||
let method = match name(&f, b"CFM").as_deref() {
|
||||
Some(b"V2") => Method::Rc4,
|
||||
Some(b"AESV2") => Method::Aes128,
|
||||
Some(b"AESV3") => Method::Aes256,
|
||||
@@ -40,7 +99,8 @@ pub(crate) fn encrypt_dict(doc: &Document, d: &Dict) -> EncryptDict {
|
||||
.get(b"CF")
|
||||
.map(|c| doc.resolve(c))
|
||||
.and_then(|c| c.as_dict().and_then(|c| c.get(b"StdCF").map(|f| doc.resolve(f))))
|
||||
.and_then(|f| f.as_dict().and_then(|f| f.int(b"Length")))
|
||||
.and_then(|f| f.as_dict().and_then(|f| f.get(b"Length").map(|n| doc.resolve(n))))
|
||||
.and_then(|n| n.as_int())
|
||||
.filter(|n| *n > 0);
|
||||
let length_bits = match (v, cf_len) {
|
||||
(5.., _) => 256,
|
||||
@@ -50,7 +110,7 @@ pub(crate) fn encrypt_dict(doc: &Document, d: &Dict) -> EncryptDict {
|
||||
_ => int(b"Length", 40),
|
||||
};
|
||||
EncryptDict {
|
||||
filter: d.name(b"Filter").map(|n| n.to_vec()).unwrap_or_default(),
|
||||
filter: name(d, b"Filter").unwrap_or_default(),
|
||||
v,
|
||||
r: int(b"R", 0),
|
||||
length_bits,
|
||||
@@ -60,28 +120,46 @@ pub(crate) fn encrypt_dict(doc: &Document, d: &Dict) -> EncryptDict {
|
||||
ue: bytes_of(doc, d, b"UE"),
|
||||
perms: bytes_of(doc, d, b"Perms"),
|
||||
p: int(b"P", -1) as i32,
|
||||
encrypt_metadata: !matches!(d.get(b"EncryptMetadata"), Some(Object::Bool(false))),
|
||||
encrypt_metadata: !matches!(d.get(b"EncryptMetadata").map(|v| doc.resolve(v)).as_deref(), Some(Object::Bool(false))),
|
||||
crypt_filters,
|
||||
stm_f: name(b"StmF"),
|
||||
str_f: name(b"StrF"),
|
||||
ef_f: d.get(b"EFF").and_then(|v| v.as_name()).map(|n| n.to_vec()).unwrap_or_default(),
|
||||
stm_f: name(d, b"StmF").unwrap_or_else(|| b"Identity".to_vec()),
|
||||
str_f: name(d, b"StrF").unwrap_or_else(|| b"Identity".to_vec()),
|
||||
ef_f: name(d, b"EFF").unwrap_or_default(),
|
||||
}
|
||||
}
|
||||
|
||||
/// The crypt filter a stream names in its `/Filter` chain (`/Crypt` + `/DecodeParms /Name`).
|
||||
fn named_crypt_filter(dict: &Dict) -> Option<Vec<u8>> {
|
||||
let names: Vec<&[u8]> = match dict.get(b"Filter") {
|
||||
Some(Object::Name(n)) => vec![n],
|
||||
Some(Object::Array(a)) => a.iter().filter_map(Object::as_name).collect(),
|
||||
/// Whether `f`, an entry of a `/Filter` chain or its only filter, is `/Crypt`.
|
||||
fn is_crypt(doc: &Document, f: &Object) -> bool {
|
||||
followed(doc, f).as_name() == Some(b"Crypt")
|
||||
}
|
||||
|
||||
/// The crypt filter a stream names in its `/Filter` chain (`/Crypt` + `/DecodeParms /Name`), each
|
||||
/// given directly or by reference, in an array or not. A chain longer than any decoder takes names
|
||||
/// none: nothing can read that stream anyway, and every stream of a file can share one long array.
|
||||
/// A `/Name` that reads as absent means `/Identity`, unless a reference on the way to it was refused
|
||||
/// (see [`MAX_FOLLOWED`]): that says nothing about the stream, so it names none, and the document's
|
||||
/// own filter is used.
|
||||
fn named_crypt_filter(doc: &Document, dict: &Dict) -> Option<Vec<u8>> {
|
||||
let refused = REFUSED.get();
|
||||
let filter = followed(doc, dict.get(b"Filter")?);
|
||||
let i = match &*filter {
|
||||
Object::Array(a) if a.len() <= MAX_CHAIN + 1 => a.iter().position(|f| is_crypt(doc, f))?,
|
||||
f if is_crypt(doc, f) => 0,
|
||||
_ => return None,
|
||||
};
|
||||
let i = names.iter().position(|n| *n == b"Crypt")?;
|
||||
let parms = match dict.get(b"DecodeParms") {
|
||||
Some(Object::Dict(d)) if i == 0 => Some(d.clone()),
|
||||
Some(Object::Array(a)) => a.get(i).and_then(|p| p.as_dict().cloned()),
|
||||
let parms = dict.get(b"DecodeParms").map(|p| followed(doc, p));
|
||||
let entry = match parms.as_deref() {
|
||||
Some(Object::Array(a)) => a.get(i).map(|p| followed(doc, p)),
|
||||
Some(p) if i == 0 => Some(Held::Direct(p)),
|
||||
_ => None,
|
||||
};
|
||||
Some(parms.and_then(|p| p.name(b"Name").map(|n| n.to_vec())).unwrap_or_else(|| b"Identity".to_vec()))
|
||||
let name = entry.as_deref().and_then(Object::as_dict).and_then(|p| p.get(b"Name")).map(|n| followed(doc, n));
|
||||
match name.as_deref().and_then(Object::as_name) {
|
||||
Some(name) => Some(name.to_vec()),
|
||||
// /Identity here would read ciphertext as data, and write the stream in the clear.
|
||||
None if REFUSED.get() > refused => None,
|
||||
None => Some(b"Identity".to_vec()),
|
||||
}
|
||||
}
|
||||
|
||||
/// A signature dictionary (field signature, document timestamp or usage-rights signature),
|
||||
@@ -91,42 +169,67 @@ fn named_crypt_filter(dict: &Dict) -> Option<Vec<u8>> {
|
||||
/// `/Contents` alongside an array `/ByteRange` (`/Type` is optional). A signature dictionary
|
||||
/// has no `/Subtype`; a dictionary with one (an annotation, whose `/Contents` is the comment
|
||||
/// text) or with another `/Type` is never exempt, whatever else it carries.
|
||||
fn is_signature_dict(d: &Dict) -> bool {
|
||||
if d.get(b"Subtype").is_some() {
|
||||
/// With `doc` its entries are read through references; a dictionary nested in another object
|
||||
/// has none (see [`transform`]).
|
||||
fn is_signature_dict(doc: Option<&Document>, d: &Dict) -> bool {
|
||||
// All this decides is what happens to such a /Contents.
|
||||
if !matches!(d.get(b"Contents"), Some(Object::String(_))) {
|
||||
return false;
|
||||
}
|
||||
match d.get(b"Type") {
|
||||
Some(_) => matches!(d.name(b"Type"), Some(b"Sig" | b"DocTimeStamp")),
|
||||
None => matches!(d.get(b"Contents"), Some(Object::String(_))) && matches!(d.get(b"ByteRange"), Some(Object::Array(_))),
|
||||
// A null entry, or one that refers to nothing, is an absent one (ISO 32000-2 §7.3.7, §7.3.10).
|
||||
let entry = |key: &[u8]| {
|
||||
let value = d.get(key)?;
|
||||
let held = doc.map_or(Held::Direct(value), |doc| followed(doc, value));
|
||||
(!matches!(*held, Object::Null)).then_some(held)
|
||||
};
|
||||
if entry(b"Subtype").is_some() {
|
||||
return false;
|
||||
}
|
||||
match entry(b"Type") {
|
||||
Some(t) => matches!(t.as_name(), Some(b"Sig" | b"DocTimeStamp")),
|
||||
None => matches!(entry(b"ByteRange").as_deref(), Some(Object::Array(_))),
|
||||
}
|
||||
}
|
||||
|
||||
/// Remove the `/Crypt` entry from a stream's filter chain, with its decode parameters.
|
||||
fn drop_crypt_filter(dict: &mut Dict) {
|
||||
let i = match dict.get(b"Filter") {
|
||||
Some(Object::Array(a)) => a.iter().position(|n| n.as_name() == Some(b"Crypt")),
|
||||
Some(Object::Name(n)) if n.as_slice() == b"Crypt" => Some(0),
|
||||
_ => None,
|
||||
/// Longer than any filter's name. A name can be of any length, and a chain every stream shares can
|
||||
/// hold a long one.
|
||||
const MAX_FILTER_NAME: usize = 127;
|
||||
|
||||
/// The dictionary of `source` without the `/Crypt` entries of its filter chain and their decode
|
||||
/// parameters. The two come out direct when given by reference, which every stream of a file can
|
||||
/// share, so of what was shared only small values are copied: filter names, and the parameters
|
||||
/// decoders read ([`Document::with_direct_parms`]). The chain is short, as [`named_crypt_filter`]
|
||||
/// found a filter in it.
|
||||
fn drop_crypt_filter(doc: &Document, source: &Stream) -> Dict {
|
||||
let entry = |f: &Object| match f {
|
||||
f if is_crypt(doc, f) => Object::name("Crypt"),
|
||||
Object::Name(n) if n.len() <= MAX_FILTER_NAME => f.clone(),
|
||||
Object::Ref(_) => f.clone(),
|
||||
_ => Object::Null,
|
||||
};
|
||||
let Some(i) = i else { return };
|
||||
let mut filters = match dict.get(b"Filter") {
|
||||
Some(Object::Array(a)) => a.clone(),
|
||||
_ => Vec::new(),
|
||||
let filter = source.dict.get(b"Filter").map(|f| followed(doc, f));
|
||||
let chain: Vec<Object> = match filter.as_deref() {
|
||||
Some(Object::Array(a)) => a.iter().map(entry).collect(),
|
||||
Some(f) => vec![entry(f)],
|
||||
None => Vec::new(),
|
||||
};
|
||||
if i < filters.len() {
|
||||
filters.remove(i);
|
||||
}
|
||||
let crypt: Vec<bool> = chain.iter().map(|f| f.as_name() == Some(b"Crypt")).collect();
|
||||
let mut chained = Stream::from_raw(source.dict.clone(), Vec::new());
|
||||
chained.dict.set(b"Filter".to_vec(), Object::Array(chain.clone()));
|
||||
// A lone parameter dictionary belongs to the first filter (as `named_crypt_filter` reads it).
|
||||
match dict.get(b"DecodeParms").cloned() {
|
||||
Some(Object::Array(mut parms)) if i < parms.len() => {
|
||||
parms.remove(i);
|
||||
dict.set(b"DecodeParms".to_vec(), Object::Array(parms));
|
||||
}
|
||||
Some(Object::Dict(_)) if i == 0 => {
|
||||
let parms = match doc.with_direct_parms(&chained).dict.get(b"DecodeParms") {
|
||||
Some(Object::Array(p)) => Some(Object::Array(p.iter().zip(&crypt).filter(|(_, c)| !**c).map(|(p, _)| p.clone()).collect())),
|
||||
Some(Object::Dict(_)) if crypt.first() == Some(&true) => None,
|
||||
_ => source.dict.get(b"DecodeParms").cloned(),
|
||||
};
|
||||
let mut dict = source.dict.clone();
|
||||
match parms {
|
||||
Some(p) => dict.set(b"DecodeParms".to_vec(), p),
|
||||
None => {
|
||||
dict.remove(b"DecodeParms");
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
let filters: Vec<Object> = chain.into_iter().zip(&crypt).filter(|(_, c)| !**c).map(|(f, _)| f).collect();
|
||||
if filters.is_empty() {
|
||||
dict.remove(b"Filter");
|
||||
if matches!(dict.get(b"DecodeParms"), Some(Object::Array(p)) if p.is_empty()) {
|
||||
@@ -135,6 +238,7 @@ fn drop_crypt_filter(dict: &mut Dict) {
|
||||
} else {
|
||||
dict.set(b"Filter".to_vec(), Object::Array(filters));
|
||||
}
|
||||
dict
|
||||
}
|
||||
|
||||
/// What [`transform`] does to an object.
|
||||
@@ -152,51 +256,81 @@ pub(crate) enum Pass {
|
||||
|
||||
/// Decrypt or encrypt every string and stream in an indirect object, except a signature
|
||||
/// dictionary's `/Contents` (see [`is_signature_dict`]).
|
||||
pub(crate) fn transform(h: &SecurityHandler, o: &Object, num: u32, generation: u16, pass: Pass) -> Object {
|
||||
///
|
||||
/// `o` is as `doc` holds it: what a stream's dictionary gives by reference is read from `doc`, so
|
||||
/// its references have to be the document's, not a save's renumbered ones.
|
||||
pub(crate) fn transform(doc: &Document, h: &SecurityHandler, o: &Object, num: u32, generation: u16, pass: Pass) -> Object {
|
||||
let _scope = FollowScope::enter();
|
||||
let decrypt = pass == Pass::Decrypt;
|
||||
let strings = |s: &PdfString| {
|
||||
let bytes = if decrypt { h.decrypt_string(num, generation, &s.bytes) } else { h.encrypt_string(num, generation, &s.bytes) };
|
||||
PdfString { bytes, hex: s.hex || !decrypt }
|
||||
};
|
||||
walk(o, &strings, h, num, generation, pass)
|
||||
// References are followed here only, for the object itself, never for what is nested in it.
|
||||
// `walk` goes deep, and a load from down there adds that depth again for each object loaded,
|
||||
// which overflowed the stack on a 10 KB file. A stream can't be nested, and a dictionary that
|
||||
// is reads as it says directly.
|
||||
match o {
|
||||
Object::Stream(s) => stream(doc, s, &strings, h, num, generation, pass),
|
||||
Object::Dict(d) if is_signature_dict(Some(doc), d) => signature_dict(d, &strings),
|
||||
o => walk(o, &strings),
|
||||
}
|
||||
}
|
||||
|
||||
fn walk(o: &Object, strings: &dyn Fn(&PdfString) -> PdfString, h: &SecurityHandler, num: u32, generation: u16, pass: Pass) -> Object {
|
||||
let decrypt = pass == Pass::Decrypt;
|
||||
/// `d`, a signature dictionary, with the strings of everything but its `/Contents` transformed.
|
||||
fn signature_dict(d: &Dict, strings: &dyn Fn(&PdfString) -> PdfString) -> Object {
|
||||
Object::Dict(
|
||||
d.iter()
|
||||
.map(|(k, v)| match (k.as_slice(), v) {
|
||||
(b"Contents", Object::String(_)) => (k.clone(), v.clone()),
|
||||
_ => (k.clone(), walk(v, strings)),
|
||||
})
|
||||
.collect(),
|
||||
)
|
||||
}
|
||||
|
||||
fn walk(o: &Object, strings: &dyn Fn(&PdfString) -> PdfString) -> Object {
|
||||
match o {
|
||||
Object::String(s) => Object::String(strings(s)),
|
||||
Object::Array(a) => Object::Array(a.iter().map(|x| walk(x, strings, h, num, generation, pass)).collect()),
|
||||
Object::Dict(d) if is_signature_dict(d) => Object::Dict(
|
||||
d.iter()
|
||||
.map(|(k, v)| match (k.as_slice(), v) {
|
||||
(b"Contents", Object::String(_)) => (k.clone(), v.clone()),
|
||||
_ => (k.clone(), walk(v, strings, h, num, generation, pass)),
|
||||
})
|
||||
.collect(),
|
||||
),
|
||||
Object::Dict(d) => Object::Dict(d.iter().map(|(k, v)| (k.clone(), walk(v, strings, h, num, generation, pass))).collect()),
|
||||
Object::Stream(s) => {
|
||||
let mut dict: Dict = s.dict.iter().map(|(k, v)| (k.clone(), walk(v, strings, h, num, generation, pass))).collect();
|
||||
let ty = s.dict.name(b"Type");
|
||||
// Cross-reference streams are never encrypted (§7.5.8), but only reading may trust the
|
||||
// label: a stream a producer calls /XRef stays plaintext if writing believes it, and the
|
||||
// writer builds its own cross-reference streams outside this transform.
|
||||
if (decrypt && ty == Some(b"XRef")) || (ty == Some(b"Metadata") && !h.encrypts_metadata()) {
|
||||
return Object::Stream(Stream { dict, raw: s.raw.clone() });
|
||||
}
|
||||
let mut named = named_crypt_filter(&s.dict);
|
||||
if pass == Pass::EncryptReplacing && named.as_deref().is_some_and(|n| !h.dict().crypt_filters.iter().any(|(f, _)| f == n)) {
|
||||
drop_crypt_filter(&mut dict);
|
||||
named = None;
|
||||
}
|
||||
let kind = match (&named, ty) {
|
||||
(Some(n), _) => StreamKind::Named(n),
|
||||
(None, Some(b"EmbeddedFile")) => StreamKind::EmbeddedFile,
|
||||
_ => StreamKind::Normal,
|
||||
};
|
||||
let raw = if decrypt { h.decrypt_stream(num, generation, &s.raw, kind) } else { h.encrypt_stream(num, generation, &s.raw, kind) };
|
||||
Object::Stream(Stream { dict, raw: raw.into() })
|
||||
}
|
||||
Object::Array(a) => Object::Array(a.iter().map(|x| walk(x, strings)).collect()),
|
||||
Object::Dict(d) if is_signature_dict(None, d) => signature_dict(d, strings),
|
||||
Object::Dict(d) => Object::Dict(d.iter().map(|(k, v)| (k.clone(), walk(v, strings))).collect()),
|
||||
other => other.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
fn stream(
|
||||
doc: &Document,
|
||||
s: &Stream,
|
||||
strings: &dyn Fn(&PdfString) -> PdfString,
|
||||
h: &SecurityHandler,
|
||||
num: u32,
|
||||
generation: u16,
|
||||
pass: Pass,
|
||||
) -> Object {
|
||||
let decrypt = pass == Pass::Decrypt;
|
||||
let walked = |d: &Dict| -> Dict { d.iter().map(|(k, v)| (k.clone(), walk(v, strings))).collect() };
|
||||
let ty = s.dict.get(b"Type").map(|t| followed(doc, t));
|
||||
let ty = ty.as_deref().and_then(Object::as_name);
|
||||
// Cross-reference streams are never encrypted (§7.5.8), but only reading may trust the
|
||||
// label: a stream a producer calls /XRef stays plaintext if writing believes it, and the
|
||||
// writer builds its own cross-reference streams outside this transform.
|
||||
if (decrypt && ty == Some(b"XRef")) || (ty == Some(b"Metadata") && !h.encrypts_metadata()) {
|
||||
return Object::Stream(Stream { dict: walked(&s.dict), raw: s.raw.clone() });
|
||||
}
|
||||
let mut named = named_crypt_filter(doc, &s.dict);
|
||||
// Before the walk, which then encrypts what is in the dictionary this leaves.
|
||||
let foreign = pass == Pass::EncryptReplacing && named.as_deref().is_some_and(|n| !h.dict().crypt_filters.iter().any(|(f, _)| f == n));
|
||||
let dropped = foreign.then(|| drop_crypt_filter(doc, s));
|
||||
if dropped.is_some() {
|
||||
named = None;
|
||||
}
|
||||
let dict = walked(dropped.as_ref().unwrap_or(&s.dict));
|
||||
let kind = match (&named, ty) {
|
||||
(Some(n), _) => StreamKind::Named(n),
|
||||
(None, Some(b"EmbeddedFile")) => StreamKind::EmbeddedFile,
|
||||
_ => StreamKind::Normal,
|
||||
};
|
||||
let raw = if decrypt { h.decrypt_stream(num, generation, &s.raw, kind) } else { h.encrypt_stream(num, generation, &s.raw, kind) };
|
||||
Object::Stream(Stream { dict, raw: raw.into() })
|
||||
}
|
||||
@@ -133,11 +133,12 @@ fn write_stream(s: &Stream, out: &mut Vec<u8>) {
|
||||
|
||||
/// The object as written: encrypted with its (output) number when the document is encrypted,
|
||||
/// except the `/Encrypt` dictionary itself (`source_num` is its number in the source document).
|
||||
/// `o` has the document's numbers in its references ([`crate::security::transform`]).
|
||||
fn prepared<'a>(doc: &Document, source_num: u32, num: u32, generation: u16, o: &'a Object) -> Cow<'a, Object> {
|
||||
match doc.output_security() {
|
||||
(Some(h), encrypt_num) if Some(source_num) != encrypt_num => {
|
||||
(Some(h), encrypt_num) if Some(source_num) != encrypt_num && !doc.stored_as_is(source_num) => {
|
||||
let pass = if doc.encryption_changed() { crate::security::Pass::EncryptReplacing } else { crate::security::Pass::Encrypt };
|
||||
Cow::Owned(crate::security::transform(h, o, num, generation, pass))
|
||||
Cow::Owned(crate::security::transform(doc, h, o, num, generation, pass))
|
||||
}
|
||||
_ => Cow::Borrowed(o),
|
||||
}
|
||||
@@ -287,6 +288,10 @@ pub fn write_full(doc: &Document, opts: &SaveOptions) -> Result<Vec<u8>, CosErro
|
||||
queue.push_back(r);
|
||||
}
|
||||
}
|
||||
// A direct /Encrypt can refer to objects, /CF or /StmF, say.
|
||||
if let Some(encrypt @ Object::Dict(_)) = trailer_in.get(b"Encrypt") {
|
||||
visit_refs(encrypt, &mut queue);
|
||||
}
|
||||
// Unknown trailer entries are document data. Objects they alone reference must be written
|
||||
// too, or a full rewrite would keep the key and drop its value.
|
||||
for (key, value) in trailer_in.iter() {
|
||||
@@ -315,7 +320,10 @@ pub fn write_full(doc: &Document, opts: &SaveOptions) -> Result<Vec<u8>, CosErro
|
||||
// The /Encrypt dictionary and everything it references (e.g. indirect /CF crypt-filter
|
||||
// dictionaries) are needed before anything can be decrypted: never inside object streams.
|
||||
let mut encryption_objects: std::collections::HashSet<ObjRef> = std::collections::HashSet::new();
|
||||
let mut pending: Vec<ObjRef> = trailer_in.reference(b"Encrypt").into_iter().collect();
|
||||
let mut pending: Vec<ObjRef> = Vec::new();
|
||||
if let Some(encrypt) = trailer_in.get(b"Encrypt") {
|
||||
collect_refs(encrypt, &mut |r| pending.push(r));
|
||||
}
|
||||
while let Some(r) = pending.pop() {
|
||||
if encryption_objects.insert(r) {
|
||||
collect_refs(&reader.get(r), &mut |x| pending.push(x));
|
||||
@@ -336,9 +344,10 @@ pub fn write_full(doc: &Document, opts: &SaveOptions) -> Result<Vec<u8>, CosErro
|
||||
if in_stream {
|
||||
packed.push((num, *r));
|
||||
} else {
|
||||
let o = renumber(&*reread(&mut reader, *r, *is_stream)?, &map);
|
||||
let o = reread(&mut reader, *r, *is_stream)?;
|
||||
let o = renumber(&prepared(&reader.document, r.num, num, 0, &o), &map);
|
||||
rows.insert(num, Row::InFile(out.len() as u64, 0));
|
||||
write_indirect(num, 0, &prepared(&reader.document, r.num, num, 0, &o), &mut out);
|
||||
write_indirect(num, 0, &o, &mut out);
|
||||
}
|
||||
}
|
||||
// Object streams take the numbers after the last object. Their contents are not encrypted
|
||||
@@ -368,11 +377,11 @@ pub fn write_full(doc: &Document, opts: &SaveOptions) -> Result<Vec<u8>, CosErro
|
||||
trailer.set(key.to_vec(), Object::Ref(ObjRef::new(*r, 0)));
|
||||
}
|
||||
}
|
||||
if let Some(Object::Dict(d)) = trailer_in.get(b"Encrypt") {
|
||||
trailer.set(b"Encrypt".to_vec(), Object::Dict(d.clone()));
|
||||
if let Some(encrypt @ Object::Dict(_)) = trailer_in.get(b"Encrypt") {
|
||||
trailer.set(b"Encrypt".to_vec(), renumber(encrypt, &map));
|
||||
}
|
||||
if let Some(id) = trailer_in.get(b"ID") {
|
||||
trailer.set(b"ID".to_vec(), id.clone());
|
||||
trailer.set(b"ID".to_vec(), direct_id(&reader.document, id));
|
||||
}
|
||||
for (key, value) in trailer_in.iter() {
|
||||
if !trailer_key_rewritten(key) {
|
||||
@@ -442,6 +451,22 @@ impl ObjectStreamBatch {
|
||||
}
|
||||
}
|
||||
|
||||
/// `/ID` for the trailer, direct, as it has to be with `/Encrypt`: nothing else in the file holds
|
||||
/// what it refers to now. Given by reference it is two entries at most, however many references a
|
||||
/// file gave, so that one large string isn't copied for each. An entry that isn't a string stays in
|
||||
/// its place as an empty one, which is how the key read it.
|
||||
fn direct_id(doc: &Document, id: &Object) -> Object {
|
||||
if matches!(id, Object::Array(a) if !a.iter().any(|s| matches!(s, Object::Ref(_)))) {
|
||||
return id.clone();
|
||||
}
|
||||
let entry = |s: &Object| match &*doc.resolve(s) {
|
||||
s @ Object::String(_) => s.clone(),
|
||||
_ => Object::String(crate::PdfString { bytes: Vec::new(), hex: true }),
|
||||
};
|
||||
let held = doc.resolve(id);
|
||||
Object::Array(held.as_array().into_iter().flatten().take(2).map(entry).collect())
|
||||
}
|
||||
|
||||
/// Trailer keys a full rewrite generates itself. Everything else is copied, with references
|
||||
/// renumbered, so a save does not drop metadata the reader accepted.
|
||||
fn trailer_key_rewritten(key: &[u8]) -> bool {
|
||||
@@ -486,7 +511,7 @@ pub(crate) fn unlinked_additions(doc: &Document) -> HashSet<u32> {
|
||||
pending.into_keys().collect()
|
||||
}
|
||||
|
||||
fn collect_refs(o: &Object, f: &mut impl FnMut(ObjRef)) {
|
||||
pub(crate) fn collect_refs(o: &Object, f: &mut impl FnMut(ObjRef)) {
|
||||
match o {
|
||||
Object::Ref(r) => f(*r),
|
||||
Object::Array(a) => a.iter().for_each(|x| collect_refs(x, f)),
|
||||
@@ -663,6 +688,15 @@ fn civil_from_days(days: i64) -> (i64, u32, u32) {
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
/// `/ID` by reference comes out direct, each entry where it was: the key is made from the first.
|
||||
#[test]
|
||||
fn a_file_identifier_keeps_its_entries_in_their_places() {
|
||||
let doc = Document::new_empty();
|
||||
let string = |bytes: &[u8]| Object::String(crate::PdfString { bytes: bytes.to_vec(), hex: true });
|
||||
let nowhere = Object::Ref(ObjRef::new(9_999, 0));
|
||||
assert_eq!(super::direct_id(&doc, &Object::Array(vec![nowhere, string(b"ab")])), Object::Array(vec![string(b""), string(b"ab")]));
|
||||
}
|
||||
|
||||
use proptest::prelude::*;
|
||||
|
||||
use super::*;
|
||||
|
||||
@@ -494,3 +494,826 @@ fn a_stream_labelled_xref_is_encrypted_when_saved() {
|
||||
let bytes = write_full(&doc, &SaveOptions { object_streams: false, ..SaveOptions::default() }).unwrap();
|
||||
assert!(!bytes.windows(SECRET.len()).any(|w| w == SECRET.as_bytes()), "the labelled stream was written in the clear");
|
||||
}
|
||||
|
||||
/// The content stream's reference.
|
||||
fn contents_of(doc: &Document) -> ObjRef {
|
||||
let catalog = doc.get(doc.root().unwrap()).as_dict().cloned().unwrap();
|
||||
let pages = doc.get(catalog.reference(b"Pages").unwrap()).as_dict().cloned().unwrap();
|
||||
let page = doc.resolve(&pages.get(b"Kids").unwrap().as_array().unwrap()[0]).as_dict().cloned().unwrap();
|
||||
page.reference(b"Contents").unwrap()
|
||||
}
|
||||
|
||||
/// The content stream's data as loaded, whatever its filters say.
|
||||
fn raw_content(doc: &Document) -> String {
|
||||
match &*doc.get(contents_of(doc)) {
|
||||
Object::Stream(s) => String::from_utf8_lossy(&s.raw).trim().to_string(),
|
||||
_ => panic!("no content stream"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Gives the content stream the `/Filter` and `/DecodeParms` of `selector`.
|
||||
fn select(doc: &mut Document, (filter, parms): (Object, Object)) {
|
||||
let contents = contents_of(doc);
|
||||
let Object::Stream(mut s) = doc.get(contents).as_ref().clone() else { panic!("no content stream") };
|
||||
s.dict.set(b"Filter".to_vec(), filter);
|
||||
s.dict.set(b"DecodeParms".to_vec(), parms);
|
||||
doc.set(contents, Object::Stream(s));
|
||||
}
|
||||
|
||||
/// `/Crypt` naming `name`, in the `form`th spelling: all direct, then each part by reference.
|
||||
/// `None` past the last.
|
||||
fn selector(doc: &mut Document, form: usize, name: &str) -> Option<(Object, Object)> {
|
||||
let crypt = Object::name("Crypt");
|
||||
let parms = |n: Object| {
|
||||
let mut d = pdfcraft_cos::Dict::new();
|
||||
d.set(b"Name".to_vec(), n);
|
||||
Object::Dict(d)
|
||||
};
|
||||
let named = parms(Object::name(name));
|
||||
Some(match form {
|
||||
0 => (crypt, named),
|
||||
1 => (crypt, Object::Ref(doc.add(named))),
|
||||
2 => (Object::Array(vec![crypt]), Object::Array(vec![Object::Ref(doc.add(named))])),
|
||||
3 => (Object::Array(vec![crypt]), Object::Ref(doc.add(Object::Array(vec![named])))),
|
||||
4 => (crypt, parms(Object::Ref(doc.add(Object::name(name))))),
|
||||
5 => (Object::Ref(doc.add(crypt)), named),
|
||||
6 => (Object::Ref(doc.add(Object::Array(vec![crypt]))), Object::Array(vec![named])),
|
||||
7 => (Object::Array(vec![Object::Ref(doc.add(crypt))]), Object::Array(vec![named])),
|
||||
// Behind a filter given by reference: places in the two arrays pair up all the same.
|
||||
8 => (Object::Array(vec![Object::Ref(doc.add(Object::name("ASCIIHexDecode"))), crypt]), Object::Array(vec![Object::Null, named])),
|
||||
// The two entries in different forms, which is how a lone filter is usually spelled.
|
||||
9 => (Object::Array(vec![crypt]), named),
|
||||
10 => (crypt, Object::Array(vec![named])),
|
||||
// The filter twice, which names the first's.
|
||||
11 => (Object::Array(vec![crypt.clone(), crypt]), Object::Array(vec![named.clone(), named])),
|
||||
// A reference to a reference.
|
||||
12 => {
|
||||
let name = doc.add(Object::name(name));
|
||||
let hop = doc.add(Object::Ref(name));
|
||||
(crypt, parms(Object::Ref(hop)))
|
||||
}
|
||||
_ => return None,
|
||||
})
|
||||
}
|
||||
|
||||
fn holds(bytes: &[u8], text: &str) -> bool {
|
||||
String::from_utf8_lossy(bytes).contains(text)
|
||||
}
|
||||
|
||||
/// An object `/Encrypt` names is written as stored only while it is as stored. A file whose
|
||||
/// `/Encrypt` names its `/Info` reads that dictionary as stored; once the title is edited, both
|
||||
/// saves encrypt it rather than writing the new title in the clear.
|
||||
#[test]
|
||||
fn an_edited_object_that_encrypt_names_is_encrypted() {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes128,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [9; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let info = doc.trailer().reference(b"Info").unwrap();
|
||||
let mut dict = doc.get(doc.trailer().reference(b"Encrypt").unwrap()).as_dict().cloned().unwrap();
|
||||
dict.set(b"Junk".to_vec(), Object::Ref(info));
|
||||
doc.trailer_mut().set(b"Encrypt".to_vec(), Object::Dict(dict));
|
||||
let bytes = write_full(&doc, &SaveOptions::default()).unwrap();
|
||||
let mut doc = Document::open(Arc::new(bytes)).unwrap();
|
||||
let info = doc.trailer().reference(b"Info").unwrap();
|
||||
doc.update_dict(info, |d| d.set(b"Title".to_vec(), PdfString::text("Merger plan"))).unwrap();
|
||||
for (save, saved) in [("incremental", write_incremental(&doc, &SaveOptions::default())), ("full", write_full(&doc, &SaveOptions::default()))] {
|
||||
assert!(!holds(&saved.unwrap(), "Merger plan"), "{save}: the edited title was written in the clear");
|
||||
}
|
||||
}
|
||||
|
||||
/// A stream can select its crypt filter by reference at every step: the chain, an entry of it, the
|
||||
/// parameters, an entry of those, the name (ISO 32000-2 §7.3.10, §7.4.10). Read as absent, the
|
||||
/// filter was `/Identity`, so such a stream was saved in the clear and, in a file from elsewhere,
|
||||
/// its ciphertext read as data. A full save renumbers: what it follows has the document's numbers.
|
||||
#[test]
|
||||
fn a_crypt_filter_selected_by_reference_is_used() {
|
||||
for alg in [Algorithm::Aes128, Algorithm::Aes256] {
|
||||
for form in 0.. {
|
||||
let mut doc = Document::open(Arc::new(protect(alg, "", "owner", -1))).unwrap();
|
||||
let Some(selected) = selector(&mut doc, form, "StdCF") else { break };
|
||||
select(&mut doc, selected);
|
||||
let saved = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
assert!(!holds(&saved, "Secret page"), "{alg:?} form {form}: saved encrypted");
|
||||
let back = Document::open(Arc::new(saved)).unwrap();
|
||||
assert_eq!(raw_content(&back), SECRET, "{alg:?} form {form}: read back");
|
||||
let full = write_full(&back, &SaveOptions::default()).unwrap();
|
||||
assert!(!holds(&full, "Secret page"), "{alg:?} form {form}: renumbered, encrypted");
|
||||
assert_eq!(raw_content(&Document::open(Arc::new(full)).unwrap()), SECRET, "{alg:?} form {form}: renumbered");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A reference to a stream that takes `follows` references to read cold, this one included: its
|
||||
/// nine filters are all read, the last leading to the next stream.
|
||||
fn spends(doc: &mut Document, follows: usize) -> Object {
|
||||
let left = follows - 1;
|
||||
let mut filters: Vec<Object> = (0..left.min(8)).map(|i| Object::Ref(doc.add(Object::Int(i as i64)))).collect();
|
||||
if left > 8 {
|
||||
filters.push(spends(doc, left - 8));
|
||||
}
|
||||
let mut dict = pdfcraft_cos::Dict::new();
|
||||
dict.set(b"Filter".to_vec(), Object::Array(filters));
|
||||
Object::Ref(doc.add(Object::Stream(pdfcraft_cos::Stream::from_raw(dict, Vec::new()))))
|
||||
}
|
||||
|
||||
/// Gives the content stream a `/Type` that takes `follows` references to read, ahead of its filter.
|
||||
fn spend_first(doc: &mut Document, follows: usize) {
|
||||
let spent = spends(doc, follows);
|
||||
let contents = contents_of(doc);
|
||||
let Object::Stream(mut s) = doc.get(contents).as_ref().clone() else { panic!("no content stream") };
|
||||
s.dict.set(b"Type".to_vec(), spent);
|
||||
doc.set(contents, Object::Stream(s));
|
||||
}
|
||||
|
||||
/// Past what one read may follow a reference reads as absent, and a crypt filter with no `/Name` is
|
||||
/// `/Identity`. Together those would read this stream's ciphertext as data, so what can't be told
|
||||
/// is the document's own filter, as a `/Filter` that can't be read is.
|
||||
#[test]
|
||||
fn a_crypt_filter_past_what_a_read_may_follow_is_the_documents_own() {
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
let selected = selector(&mut doc, 1, "StdCF").unwrap();
|
||||
select(&mut doc, selected);
|
||||
spend_first(&mut doc, 40);
|
||||
let saved = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
assert!(!holds(&saved, "Secret page"), "saved encrypted");
|
||||
let back = Document::open(Arc::new(saved)).unwrap();
|
||||
assert_eq!(raw_content(&back), SECRET);
|
||||
let full = write_full(&back, &SaveOptions::default()).unwrap();
|
||||
assert!(!holds(&full, "Secret page"), "renumbered, encrypted");
|
||||
assert_eq!(raw_content(&Document::open(Arc::new(full)).unwrap()), SECRET, "renumbered");
|
||||
}
|
||||
|
||||
/// A read that takes all it may follow has refused nothing: a crypt filter with no `/Name` after it
|
||||
/// is still `/Identity`, and the stream is in the clear.
|
||||
#[test]
|
||||
fn a_crypt_filter_with_no_name_after_all_a_read_may_follow_is_identity() {
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
select(&mut doc, (Object::name("Crypt"), Object::Dict(pdfcraft_cos::Dict::new())));
|
||||
spend_first(&mut doc, 32);
|
||||
let saved = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
assert!(holds(&saved, "Secret page"), "written as the stream asks");
|
||||
assert_eq!(raw_content(&Document::open(Arc::new(saved)).unwrap()), SECRET);
|
||||
}
|
||||
|
||||
/// `/Identity` selected by reference keeps a stream in the clear in a document that encrypts the
|
||||
/// rest, in every spelling, on both saves.
|
||||
#[test]
|
||||
fn an_identity_crypt_filter_selected_by_reference_leaves_a_stream_alone() {
|
||||
for form in 0.. {
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
let Some(selected) = selector(&mut doc, form, "Identity") else { break };
|
||||
select(&mut doc, selected);
|
||||
let saved = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
assert!(holds(&saved, "Secret page"), "form {form}: written as the stream asks");
|
||||
let back = Document::open(Arc::new(saved)).unwrap();
|
||||
assert_eq!(raw_content(&back), SECRET, "form {form}");
|
||||
let full = write_full(&back, &SaveOptions::default()).unwrap();
|
||||
assert!(holds(&full, "Secret page"), "form {form}: renumbered");
|
||||
assert_eq!(raw_content(&Document::open(Arc::new(full)).unwrap()), SECRET, "form {form}: renumbered");
|
||||
}
|
||||
}
|
||||
|
||||
/// New protection drops a crypt filter it doesn't define, whichever way the stream selected it. The
|
||||
/// chain comes out direct. Parameters in the stream's own dictionary stay, encrypted with it; of an
|
||||
/// array in an object of its own, which every stream can share, only what decoders read is copied.
|
||||
#[test]
|
||||
fn protecting_drops_a_crypt_filter_selected_by_reference() {
|
||||
let protected = |doc: &mut Document| {
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes256,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [7; 32],
|
||||
})
|
||||
.unwrap();
|
||||
write_full(doc, &SaveOptions::default()).unwrap()
|
||||
};
|
||||
for form in 0.. {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
let Some(selected) = selector(&mut doc, form, "MyCF") else { break };
|
||||
select(&mut doc, selected);
|
||||
let bytes = protected(&mut doc);
|
||||
assert!(!holds(&bytes, "Secret page"), "form {form}: encrypted");
|
||||
assert!(!holds(&bytes, "MyCF"), "form {form}: no selector left in the stream");
|
||||
let back = Document::open(Arc::new(bytes.clone())).unwrap();
|
||||
assert_eq!(raw_content(&back), SECRET, "form {form}");
|
||||
let contents = back.get(contents_of(&back));
|
||||
let filter = contents.as_dict().unwrap().get(b"Filter");
|
||||
match form {
|
||||
8 => assert!(
|
||||
matches!(filter, Some(Object::Array(a)) if matches!(a.as_slice(), [Object::Ref(_)])),
|
||||
"form 8: the other filter stays: {filter:?}"
|
||||
),
|
||||
_ => assert_eq!(filter, None, "form {form}"),
|
||||
}
|
||||
assert!(hayro_syntax::Pdf::new(bytes).is_ok(), "form {form}");
|
||||
}
|
||||
for shared in [false, true] {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
let mut named = pdfcraft_cos::Dict::new();
|
||||
named.set(b"Name".to_vec(), Object::name("MyCF"));
|
||||
let mut other = pdfcraft_cos::Dict::new();
|
||||
other.set(b"Note".to_vec(), Object::String(PdfString::text("Private note")));
|
||||
other.set(b"Predictor".to_vec(), Object::Int(1));
|
||||
let parms = Object::Array(vec![Object::Dict(named), Object::Dict(other)]);
|
||||
let parms = if shared { Object::Ref(doc.add(parms)) } else { parms };
|
||||
select(&mut doc, (Object::Array(vec![Object::name("Crypt"), Object::name("ASCIIHexDecode")]), parms));
|
||||
let bytes = protected(&mut doc);
|
||||
assert!(!holds(&bytes, "Private note"), "shared: {shared}");
|
||||
let back = Document::open(Arc::new(bytes)).unwrap();
|
||||
let contents = back.get(contents_of(&back));
|
||||
let kept = contents.as_dict().unwrap().get(b"DecodeParms").unwrap().as_array().unwrap();
|
||||
assert_eq!(kept.len(), 1, "one filter left, one entry");
|
||||
let kept = kept[0].as_dict().unwrap();
|
||||
assert_eq!(kept.get(b"Predictor"), Some(&Object::Int(1)), "shared: {shared}");
|
||||
assert_eq!(kept.get(b"Note").is_some(), !shared, "shared: {shared}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Every stream of a file can share one large object as its `/DecodeParms` or `/Filter`, which
|
||||
/// costs nothing until new protection drops a crypt filter from each. Copied whole, a 1 MB file
|
||||
/// came out at 1 GB.
|
||||
#[test]
|
||||
fn protecting_copies_no_large_object_into_every_stream() {
|
||||
let pad = Object::Array(vec![Object::Int(1); 100_000]);
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
let mut large = pdfcraft_cos::Dict::new();
|
||||
large.set(b"Pad".to_vec(), pad.clone());
|
||||
let parms = doc.add(Object::Array(vec![Object::Null, Object::Dict(large)]));
|
||||
let filter = doc.add(Object::Array(vec![Object::name("Crypt"), Object::Name(vec![b'A'; 100_000]), pad]));
|
||||
let mut streams = Vec::new();
|
||||
for _ in 0..200 {
|
||||
let mut by_parms = pdfcraft_cos::Dict::new();
|
||||
by_parms.set(b"Filter".to_vec(), Object::Array(vec![Object::name("Crypt"), Object::name("ASCIIHexDecode")]));
|
||||
by_parms.set(b"DecodeParms".to_vec(), Object::Ref(parms));
|
||||
streams.push(Object::Ref(doc.add(Object::Stream(pdfcraft_cos::Stream::from_raw(by_parms, b"41>".to_vec())))));
|
||||
let mut by_filter = pdfcraft_cos::Dict::new();
|
||||
by_filter.set(b"Filter".to_vec(), Object::Ref(filter));
|
||||
streams.push(Object::Ref(doc.add(Object::Stream(pdfcraft_cos::Stream::from_raw(by_filter, b"41>".to_vec())))));
|
||||
}
|
||||
doc.update_dict(doc.root().unwrap(), |c| c.set(b"Test".to_vec(), Object::Array(streams))).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes256,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [7; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let bytes = write_full(&doc, &SaveOptions { object_streams: false, ..SaveOptions::default() }).unwrap();
|
||||
assert!(bytes.len() < 1 << 20, "{} bytes", bytes.len());
|
||||
}
|
||||
|
||||
/// A file can name one large string thousands of times in `/ID`, which holds two. An encrypted file
|
||||
/// keeps its `/ID`, so each copy would be in the file a save writes.
|
||||
#[test]
|
||||
fn a_file_identifier_of_many_references_is_two_strings() {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes128,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [9; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let large = doc.add(Object::String(PdfString { bytes: vec![0xAB; 100_000], hex: true }));
|
||||
doc.trailer_mut().set(b"ID".to_vec(), Object::Array(vec![Object::Ref(large); 500]));
|
||||
let bytes = write_full(&doc, &SaveOptions { object_streams: false, ..SaveOptions::default() }).unwrap();
|
||||
assert!(bytes.len() < 1 << 20, "{} bytes", bytes.len());
|
||||
}
|
||||
|
||||
/// What a file can do with those references: point a stream's selector at the stream itself, or at
|
||||
/// nothing. They read as absent, so a stream with `/Crypt` is `/Identity` (ISO 32000-2 §7.4.10),
|
||||
/// and one that names no filter follows the document's. Loading ends either way.
|
||||
#[test]
|
||||
fn a_crypt_filter_reference_to_itself_or_nothing_reads_as_absent() {
|
||||
let named = |n: Object| {
|
||||
let mut d = pdfcraft_cos::Dict::new();
|
||||
d.set(b"Name".to_vec(), n);
|
||||
Object::Dict(d)
|
||||
};
|
||||
for (what, encrypted) in [
|
||||
("/Filter to itself", true),
|
||||
("/Filter nowhere", true),
|
||||
("/DecodeParms to itself", false),
|
||||
("/DecodeParms nowhere", false),
|
||||
("/Name to itself", false),
|
||||
("/Name nowhere", false),
|
||||
] {
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
let me = Object::Ref(contents_of(&doc));
|
||||
let nowhere = Object::Ref(ObjRef::new(9_999, 0));
|
||||
let crypt = Object::name("Crypt");
|
||||
select(
|
||||
&mut doc,
|
||||
match what {
|
||||
"/Filter to itself" => (me, Object::Null),
|
||||
"/Filter nowhere" => (nowhere, Object::Null),
|
||||
"/DecodeParms to itself" => (crypt, me),
|
||||
"/DecodeParms nowhere" => (crypt, nowhere),
|
||||
"/Name to itself" => (crypt, named(me)),
|
||||
_ => (crypt, named(nowhere)),
|
||||
},
|
||||
);
|
||||
let saved = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
assert_eq!(!holds(&saved, "Secret page"), encrypted, "{what}");
|
||||
assert_eq!(raw_content(&Document::open(Arc::new(saved)).unwrap()), SECRET, "{what}");
|
||||
}
|
||||
}
|
||||
|
||||
/// A lone parameter dictionary belongs to the first filter, so `/Crypt` behind another filter has
|
||||
/// none of its own and is `/Identity` (ISO 32000-2 §7.4.1), whatever that dictionary says.
|
||||
#[test]
|
||||
fn a_lone_parameter_dictionary_is_the_first_filters() {
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
let mut parms = pdfcraft_cos::Dict::new();
|
||||
parms.set(b"Name".to_vec(), Object::name("StdCF"));
|
||||
let first = Object::Array(vec![Object::name("Crypt"), Object::name("ASCIIHexDecode")]);
|
||||
let second = Object::Array(vec![Object::name("ASCIIHexDecode"), Object::name("Crypt")]);
|
||||
select(&mut doc, (first, Object::Dict(parms.clone())));
|
||||
assert!(!holds(&write_incremental(&doc, &SaveOptions::default()).unwrap(), "Secret page"), "first: it names StdCF");
|
||||
select(&mut doc, (second, Object::Dict(parms)));
|
||||
assert!(holds(&write_incremental(&doc, &SaveOptions::default()).unwrap(), "Secret page"), "second: it names nothing");
|
||||
}
|
||||
|
||||
/// A lone parameter dictionary is the first filter's, so dropping a `/Crypt` behind that filter
|
||||
/// leaves it, and dropping one in front of it takes it away.
|
||||
#[test]
|
||||
fn protecting_keeps_the_parameters_of_the_filter_before_a_crypt_filter() {
|
||||
let protected = |filters: Vec<Object>| {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
let mut parms = pdfcraft_cos::Dict::new();
|
||||
parms.set(b"Name".to_vec(), Object::name("MyCF"));
|
||||
select(&mut doc, (Object::Array(filters), Object::Dict(parms)));
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes256,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [7; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let back = Document::open(Arc::new(write_full(&doc, &SaveOptions::default()).unwrap())).unwrap();
|
||||
back.get(contents_of(&back)).as_dict().unwrap().contains(b"DecodeParms")
|
||||
};
|
||||
let (hex, crypt) = (Object::name("ASCIIHexDecode"), Object::name("Crypt"));
|
||||
assert!(protected(vec![hex.clone(), crypt.clone()]), "the first filter's, which stays");
|
||||
assert!(!protected(vec![crypt, hex]), "/Crypt's, which goes");
|
||||
}
|
||||
|
||||
/// Dropping `/Crypt` takes its entry out of `/DecodeParms`, and an array too short to have one is
|
||||
/// left as it is, given directly or by reference.
|
||||
#[test]
|
||||
fn protecting_leaves_a_parameter_array_too_short_for_the_crypt_filter() {
|
||||
for by_reference in [false, true] {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
let short = Object::Array(vec![Object::Null]);
|
||||
let parms = if by_reference { Object::Ref(doc.add(short)) } else { short };
|
||||
select(&mut doc, (Object::Array(vec![Object::name("ASCIIHexDecode"), Object::name("Crypt")]), parms));
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes256,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [7; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let bytes = write_full(&doc, &SaveOptions::default()).unwrap();
|
||||
assert!(!holds(&bytes, "Secret page"), "by reference: {by_reference}");
|
||||
let back = Document::open(Arc::new(bytes)).unwrap();
|
||||
assert_eq!(raw_content(&back), SECRET, "by reference: {by_reference}");
|
||||
let contents = back.get(contents_of(&back));
|
||||
let filter = contents.as_dict().unwrap().get(b"Filter").unwrap().as_array().unwrap();
|
||||
assert_eq!(filter.len(), 1, "only /Crypt goes");
|
||||
assert_eq!(filter[0].as_name(), Some(b"ASCIIHexDecode".as_slice()), "the other filter stays as it was");
|
||||
}
|
||||
}
|
||||
|
||||
/// A chain of up to [`pdfcraft_filters::MAX_CHAIN`] filters and `/Crypt` is read; a longer one
|
||||
/// names no crypt filter, so its entries aren't followed for every stream sharing it.
|
||||
#[test]
|
||||
fn a_chain_longer_than_any_decoder_takes_names_no_crypt_filter() {
|
||||
let chain = |others: usize| {
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
let mut filters = vec![Object::name("ASCIIHexDecode"); others];
|
||||
filters.push(Object::name("Crypt"));
|
||||
let array = doc.add(Object::Array(filters));
|
||||
select(&mut doc, (Object::Ref(array), Object::Null));
|
||||
holds(&write_incremental(&doc, &SaveOptions::default()).unwrap(), "Secret page")
|
||||
};
|
||||
assert!(chain(pdfcraft_filters::MAX_CHAIN), "the longest chain read: /Identity, in the clear");
|
||||
assert!(!chain(pdfcraft_filters::MAX_CHAIN + 1), "one more: the document's filter");
|
||||
}
|
||||
|
||||
/// A stream's `/Type` by reference picks its handling like one given directly: metadata left
|
||||
/// readable under `/EncryptMetadata false`, an embedded file under `/EFF`.
|
||||
#[test]
|
||||
fn a_stream_type_given_by_reference_picks_its_crypt_filter() {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
let catalog = doc.get(doc.root().unwrap()).as_dict().cloned().unwrap();
|
||||
let meta = catalog.reference(b"Metadata").unwrap();
|
||||
let ty = doc.add(Object::name("Metadata"));
|
||||
let Object::Stream(mut s) = doc.get(meta).as_ref().clone() else { panic!("no metadata stream") };
|
||||
s.dict.set(b"Type".to_vec(), Object::Ref(ty));
|
||||
doc.set(meta, Object::Stream(s));
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes256,
|
||||
user_password: "",
|
||||
owner_password: "o",
|
||||
permissions: -1,
|
||||
encrypt_metadata: false,
|
||||
seed: [5; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let bytes = write_full(&doc, &SaveOptions::default()).unwrap();
|
||||
assert!(holds(&bytes, "<x:xmpmeta>meta</x:xmpmeta>"), "search engines can read XMP");
|
||||
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
let encrypt = doc.trailer().reference(b"Encrypt").unwrap();
|
||||
doc.update_dict(encrypt, |e| e.set(b"EFF".to_vec(), Object::name("Identity"))).unwrap();
|
||||
let mut doc = Document::open(Arc::new(write_incremental(&doc, &SaveOptions::default()).unwrap())).unwrap();
|
||||
let contents = contents_of(&doc);
|
||||
let ty = doc.add(Object::name("EmbeddedFile"));
|
||||
let Object::Stream(mut s) = doc.get(contents).as_ref().clone() else { panic!("no content stream") };
|
||||
s.dict.set(b"Type".to_vec(), Object::Ref(ty));
|
||||
doc.set(contents, Object::Stream(s));
|
||||
assert!(holds(&write_incremental(&doc, &SaveOptions::default()).unwrap(), "Secret page"), "/EFF /Identity leaves it alone");
|
||||
}
|
||||
|
||||
/// What makes a dictionary a signature's can be given by reference, and what is null or refers to
|
||||
/// nothing is absent: `/Contents` stays as written in each of these.
|
||||
#[test]
|
||||
fn a_signature_dictionary_is_known_in_every_form() {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
let ty = doc.add(Object::name("Sig"));
|
||||
let range = Object::Array([0, 10, 20, 30].into_iter().map(Object::Int).collect());
|
||||
let by_reference = doc.add(range.clone());
|
||||
let nowhere = Object::Ref(ObjRef::new(9_999, 0));
|
||||
let forms: [(Vec<(&str, Object)>, &str); 5] = [
|
||||
(vec![("Type", Object::Ref(ty))], "DEAD"),
|
||||
(vec![("ByteRange", Object::Ref(by_reference))], "BEEF"),
|
||||
(vec![("Type", Object::Null), ("ByteRange", range.clone())], "CAFE"),
|
||||
(vec![("Type", nowhere.clone()), ("ByteRange", range.clone())], "F00D"),
|
||||
(vec![("Subtype", nowhere), ("ByteRange", range)], "D00D"),
|
||||
];
|
||||
let mut signatures = Vec::new();
|
||||
for (entries, contents) in forms {
|
||||
let mut sig = pdfcraft_cos::Dict::new();
|
||||
for (key, value) in entries {
|
||||
sig.set(key.as_bytes().to_vec(), value);
|
||||
}
|
||||
let bytes = (0..contents.len()).step_by(2).map(|i| u8::from_str_radix(&contents[i..i + 2], 16).unwrap()).collect();
|
||||
sig.set(b"Contents".to_vec(), Object::String(PdfString { bytes, hex: true }));
|
||||
signatures.push(Object::Ref(doc.add(Object::Dict(sig))));
|
||||
}
|
||||
// Nested in another object, it follows nothing, but known directly it is one all the same.
|
||||
let mut nested = pdfcraft_cos::Dict::new();
|
||||
nested.set(b"Type".to_vec(), Object::name("Sig"));
|
||||
nested.set(b"Contents".to_vec(), Object::String(PdfString { bytes: vec![0xAB, 0xBA], hex: true }));
|
||||
let mut field = pdfcraft_cos::Dict::new();
|
||||
field.set(b"V".to_vec(), Object::Dict(nested));
|
||||
signatures.push(Object::Ref(doc.add(Object::Dict(field))));
|
||||
// Neither of what makes one: a string /Contents alone is anybody's, so it's encrypted.
|
||||
let mut other = pdfcraft_cos::Dict::new();
|
||||
other.set(b"Contents".to_vec(), Object::String(PdfString { bytes: vec![0xAB, 0xCD], hex: true }));
|
||||
signatures.push(Object::Ref(doc.add(Object::Dict(other))));
|
||||
doc.update_dict(doc.root().unwrap(), |c| c.set(b"Test".to_vec(), Object::Array(signatures))).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes256,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [3; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let bytes = write_full(&doc, &SaveOptions { object_streams: false, ..SaveOptions::default() }).unwrap();
|
||||
for contents in ["DEAD", "BEEF", "CAFE", "F00D", "D00D", "ABBA"] {
|
||||
assert!(holds(&bytes, &format!("<{contents}>")), "{contents}: written as is");
|
||||
}
|
||||
assert!(!holds(&bytes, "<ABCD>"), "without a /ByteRange it is no signature");
|
||||
}
|
||||
|
||||
/// What a test needs to write an update of a classic file protected with AES-128.
|
||||
struct Classic {
|
||||
bytes: Vec<u8>,
|
||||
root: ObjRef,
|
||||
pages: ObjRef,
|
||||
info: ObjRef,
|
||||
encrypt: ObjRef,
|
||||
id: Vec<u8>,
|
||||
dict: pdfcraft_cos::Dict,
|
||||
}
|
||||
|
||||
fn classic_file() -> Classic {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes128,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [9; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let bytes = write_full(&doc, &SaveOptions { object_streams: false, ..SaveOptions::default() }).unwrap();
|
||||
let doc = Document::open(Arc::new(bytes.clone())).unwrap();
|
||||
let encrypt = doc.trailer().reference(b"Encrypt").unwrap();
|
||||
let id = doc.trailer().get(b"ID").unwrap().as_array().unwrap()[0].as_string().unwrap().bytes.clone();
|
||||
let dict = doc.get(encrypt).as_dict().cloned().unwrap();
|
||||
let pages = doc.get(doc.root().unwrap()).as_dict().unwrap().reference(b"Pages").unwrap();
|
||||
Classic { root: doc.root().unwrap(), pages, info: doc.trailer().reference(b"Info").unwrap(), bytes, encrypt, id, dict }
|
||||
}
|
||||
|
||||
fn hex(bytes: &[u8]) -> String {
|
||||
bytes.iter().map(|b| format!("{b:02X}")).collect()
|
||||
}
|
||||
|
||||
/// `bytes` with an update appended: `objects`, and a trailer of `trailer` entries, in which `@n`
|
||||
/// stands for the offset of object `n`. An object with nothing in it gets an entry of the
|
||||
/// cross-reference table that points at nothing.
|
||||
fn updated(bytes: &[u8], objects: &[(u32, Vec<u8>)], trailer: &str) -> Vec<u8> {
|
||||
let at = bytes.windows(9).rposition(|w| w == b"startxref").unwrap();
|
||||
let prev: usize = String::from_utf8_lossy(&bytes[at + 9..]).split_whitespace().next().unwrap().parse().unwrap();
|
||||
let mut out = bytes.to_vec();
|
||||
let mut table = String::from("xref\n");
|
||||
let mut trailer = trailer.to_string();
|
||||
for (num, body) in objects {
|
||||
if body.is_empty() {
|
||||
table.push_str(&format!("{num} 1\n0000000010 00000 n \n"));
|
||||
continue;
|
||||
}
|
||||
trailer = trailer.replace(&format!("@{num}"), &out.len().to_string());
|
||||
table.push_str(&format!("{num} 1\n{:010} 00000 n \n", out.len()));
|
||||
out.extend_from_slice(format!("{num} 0 obj\n").as_bytes());
|
||||
out.extend_from_slice(body);
|
||||
out.extend_from_slice(b"\nendobj\n");
|
||||
}
|
||||
let xref = out.len();
|
||||
out.extend_from_slice(table.as_bytes());
|
||||
out.extend_from_slice(format!("trailer\n<< {trailer} /Size 2000 /Prev {prev} >>\nstartxref\n{xref}\n%%EOF\n").as_bytes());
|
||||
out
|
||||
}
|
||||
|
||||
/// The `/Encrypt` dictionary of `file`, with `/O`, `/StmF` and `/StrF` as given.
|
||||
fn encrypt_with(file: &Classic, o: &str, filter: &str) -> Vec<u8> {
|
||||
let string = |key: &[u8]| hex(&file.dict.get(key).unwrap().as_string().unwrap().bytes);
|
||||
format!(
|
||||
"<< /Filter /Standard /V 4 /R 4 /Length 128 /P {} /O {o} /U <{}> /CF << /StdCF << /CFM /AESV2 /Length 16 /AuthEvent /DocOpen >> >> /StmF /{filter} /StrF /{filter} >>",
|
||||
file.dict.int(b"P").unwrap(),
|
||||
string(b"U")
|
||||
)
|
||||
.into_bytes()
|
||||
}
|
||||
|
||||
/// An object stream can have its parameters by reference, and a stream's crypt filter can be
|
||||
/// selected by a member of it: legal together, though each is rare. What reads the stream first
|
||||
/// goes through the object stream, and members must come out of it as they do read directly. They
|
||||
/// didn't, while a read made for a selector wasn't allowed to follow its own: the object stream was
|
||||
/// kept undecoded, its members lost for good, and a full save wrote nulls without saying so.
|
||||
#[test]
|
||||
fn an_object_stream_reached_from_a_selector_keeps_its_members() {
|
||||
let file = classic_file();
|
||||
let parms = "[<< /Name /Identity >> null]";
|
||||
let header = format!("902 0 903 {} ", parms.len() + 1);
|
||||
let members = format!("{header}{parms} << /Keep (yes) >>");
|
||||
let (mut rows, mut before) = (vec![1u8], 0u8);
|
||||
for b in members.bytes() {
|
||||
rows.push(b.wrapping_sub(before));
|
||||
before = b;
|
||||
}
|
||||
let coded = pdfcraft_cos::Stream::flate(pdfcraft_cos::Dict::new(), &rows).raw;
|
||||
let mut object_stream =
|
||||
format!("<< /Type /ObjStm /N 2 /First {} /Filter /FlateDecode /DecodeParms 911 0 R /Length {} >>\nstream\n", header.len(), coded.len())
|
||||
.into_bytes();
|
||||
object_stream.extend_from_slice(&coded);
|
||||
object_stream.extend_from_slice(b"\nendstream");
|
||||
let data = [2u8, 0x03, 0x8E, 0, 2, 0x03, 0x8E, 1];
|
||||
let mut xref = format!("<< /Type /XRef /Size 2000 /W [1 2 1] /Index [902 2] /Length {} >>\nstream\n", data.len()).into_bytes();
|
||||
xref.extend_from_slice(&data);
|
||||
xref.extend_from_slice(b"\nendstream");
|
||||
let string = |key: &[u8]| format!("<{}>", hex(&file.dict.get(key).unwrap().as_string().unwrap().bytes));
|
||||
let objects = [
|
||||
(file.root.num, format!("<< /Type /Catalog /Pages {} 0 R /A 900 0 R /B 903 0 R >>", file.pages.num).into_bytes()),
|
||||
(file.encrypt.num, encrypt_with(&file, &string(b"O"), "Identity")),
|
||||
(900, b"<< /Filter [/Crypt /ASCIIHexDecode] /DecodeParms 902 0 R /Length 1 >>\nstream\n>\nendstream".to_vec()),
|
||||
(910, object_stream),
|
||||
(911, format!("<< /Predictor 11 /Columns {} >>", members.len()).into_bytes()),
|
||||
(912, xref),
|
||||
];
|
||||
let trailer = format!("/Root {} 0 R /Encrypt {} 0 R /ID [<{id}> <{id}>] /XRefStm @912", file.root.num, file.encrypt.num, id = hex(&file.id));
|
||||
let bytes = updated(&file.bytes, &objects, &trailer);
|
||||
let keep =
|
||||
|doc: &Document, r: &Object| doc.resolve(r).as_dict().and_then(|d| d.get(b"Keep")).and_then(Object::as_string).map(|s| s.bytes.clone());
|
||||
let member = Object::Ref(ObjRef::new(903, 0));
|
||||
let doc = Document::open(Arc::new(bytes.clone())).unwrap();
|
||||
assert_eq!(keep(&doc, &member).as_deref(), Some(b"yes".as_slice()), "read first");
|
||||
let doc = Document::open(Arc::new(bytes.clone())).unwrap();
|
||||
let _ = doc.get(ObjRef::new(900, 0));
|
||||
assert_eq!(keep(&doc, &member).as_deref(), Some(b"yes".as_slice()), "read after the stream selecting from it");
|
||||
let saved = write_full(&Document::open(Arc::new(bytes)).unwrap(), &SaveOptions::default()).unwrap();
|
||||
let back = Document::open(Arc::new(saved)).unwrap();
|
||||
let catalog = back.get(back.root().unwrap());
|
||||
assert_eq!(keep(&back, catalog.as_dict().unwrap().get(b"B").unwrap()).as_deref(), Some(b"yes".as_slice()), "after a full save");
|
||||
}
|
||||
|
||||
/// `walk` goes as deep as an object nests, so following a reference from down there adds that depth
|
||||
/// again for each object it loads: this file, under 10 KB, overflowed a 2 MiB stack and took the
|
||||
/// process with it. Only the object itself follows references, and it does so in very little stack.
|
||||
#[test]
|
||||
fn nested_dictionaries_load_nothing_on_a_small_stack() {
|
||||
let file = classic_file();
|
||||
let first = 960u32;
|
||||
let objects: Vec<(u32, Vec<u8>)> = (first..first + 40)
|
||||
.map(|num| {
|
||||
let open = "[".repeat(120);
|
||||
let close = "]".repeat(120);
|
||||
(num, format!("{open}<< /Contents () /Type {} 0 R >>{close}", num + 1).into_bytes())
|
||||
})
|
||||
.collect();
|
||||
let trailer = format!("/Root {} 0 R /Encrypt {} 0 R /ID [<{id}> <{id}>]", file.root.num, file.encrypt.num, id = hex(&file.id));
|
||||
let bytes = updated(&file.bytes, &objects, &trailer);
|
||||
let reading = std::thread::Builder::new().stack_size(1 << 20).spawn(move || {
|
||||
let doc = Document::open(Arc::new(bytes)).unwrap();
|
||||
doc.get(ObjRef::new(first, 0)).as_array().is_some()
|
||||
});
|
||||
assert_eq!(reading.unwrap().join().ok(), Some(true));
|
||||
}
|
||||
|
||||
/// The object itself can follow references, a ladder of them as long as loading may nest, and that
|
||||
/// fits a small stack too.
|
||||
#[test]
|
||||
fn a_ladder_of_signature_checks_fits_a_small_stack() {
|
||||
let file = classic_file();
|
||||
let first = 960u32;
|
||||
let objects: Vec<(u32, Vec<u8>)> =
|
||||
(first..first + 40).map(|num| (num, format!("<< /Contents () /Type {} 0 R >>", num + 1).into_bytes())).collect();
|
||||
let trailer = format!("/Root {} 0 R /Encrypt {} 0 R /ID [<{id}> <{id}>]", file.root.num, file.encrypt.num, id = hex(&file.id));
|
||||
let bytes = updated(&file.bytes, &objects, &trailer);
|
||||
let reading = std::thread::Builder::new().stack_size(1 << 20).spawn(move || {
|
||||
let doc = Document::open(Arc::new(bytes)).unwrap();
|
||||
doc.get(ObjRef::new(first, 0)).as_dict().is_some()
|
||||
});
|
||||
assert_eq!(reading.unwrap().join().ok(), Some(true));
|
||||
}
|
||||
|
||||
/// The strings of `/Encrypt` are never encrypted (ISO 32000-2 §7.6.2), and can be objects of their
|
||||
/// own. Read as ordinary strings they were decrypted, and a full save encrypted them again under
|
||||
/// another number, so the file it wrote no longer opened with its own password.
|
||||
#[test]
|
||||
fn encrypt_strings_given_by_reference_stay_as_stored() {
|
||||
let file = classic_file();
|
||||
let string = |key: &[u8]| hex(&file.dict.get(key).unwrap().as_string().unwrap().bytes);
|
||||
let replaced = format!(
|
||||
"<< /Filter /Standard /V 4 /R 4 /Length 128 /P {} /O 900 0 R /U 901 0 R /CF << /StdCF << /CFM /AESV2 /Length 16 /AuthEvent /DocOpen >> >> /StmF /StdCF /StrF /StdCF >>",
|
||||
file.dict.int(b"P").unwrap()
|
||||
);
|
||||
let objects = [
|
||||
(file.encrypt.num, replaced.into_bytes()),
|
||||
(900, format!("<{}>", string(b"O")).into_bytes()),
|
||||
(901, format!("<{}>", string(b"U")).into_bytes()),
|
||||
];
|
||||
let trailer =
|
||||
format!("/Root {} 0 R /Info {} 0 R /Encrypt {} 0 R /ID [<{id}> <{id}>]", file.root.num, file.info.num, file.encrypt.num, id = hex(&file.id));
|
||||
let source = Document::open(Arc::new(updated(&file.bytes, &objects, &trailer))).unwrap();
|
||||
assert_eq!(content(&source), SECRET, "the file reads");
|
||||
assert_eq!(title(&source).as_deref(), Some("Quarterly numbers"));
|
||||
for object_streams in [false, true] {
|
||||
let saved = write_full(&source, &SaveOptions { object_streams, ..SaveOptions::default() }).unwrap();
|
||||
let back = Document::open(Arc::new(saved)).unwrap();
|
||||
assert_eq!(content(&back), SECRET, "object streams: {object_streams}");
|
||||
assert_eq!(title(&back).as_deref(), Some("Quarterly numbers"), "object streams: {object_streams}");
|
||||
}
|
||||
}
|
||||
|
||||
/// A save keeps what a file is protected with: its `/Encrypt`, which holds the handler and the
|
||||
/// permissions, its `/ID`, and so its file key, under every algorithm and by either kind of save.
|
||||
#[test]
|
||||
fn a_save_keeps_the_handler_the_key_and_the_permissions() {
|
||||
for alg in ALL {
|
||||
let doc = Document::open_with_password(Arc::new(protect(alg, "user", "owner", -1 ^ 0b1_0000)), Some("user")).unwrap();
|
||||
let held = |d: &Document| {
|
||||
let encrypt = d.resolve(d.trailer().get(b"Encrypt").unwrap()).as_dict().unwrap().clone();
|
||||
(encrypt, d.trailer().get(b"ID").cloned(), d.security().unwrap().file_key().to_vec(), format!("{:?}", d.permissions()))
|
||||
};
|
||||
let before = held(&doc);
|
||||
let mut edited = doc.clone();
|
||||
let _ = edited.add(Object::Int(1));
|
||||
for (save, saved) in [
|
||||
("incremental", write_incremental(&edited, &SaveOptions::default()).unwrap()),
|
||||
("full", write_full(&doc, &SaveOptions::default()).unwrap()),
|
||||
] {
|
||||
let back = Document::open_with_password(Arc::new(saved), Some("user")).unwrap();
|
||||
assert!(held(&back) == before, "{alg:?}: a {save} save");
|
||||
assert_eq!(content(&back), SECRET, "{alg:?}: a {save} save");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// `/ID` has to be direct in an encrypted file, but one that isn't has its key made from the same
|
||||
/// bytes. A full save writes it direct, and an incremental one leaves it as it was.
|
||||
#[test]
|
||||
fn a_file_identifier_given_by_reference_is_read() {
|
||||
let file = classic_file();
|
||||
let id = hex(&file.id);
|
||||
let reference = |entries: &str, objects: &[(u32, Vec<u8>)]| {
|
||||
let trailer = format!("/Root {} 0 R /Encrypt {} 0 R /ID {entries}", file.root.num, file.encrypt.num);
|
||||
updated(&file.bytes, objects, &trailer)
|
||||
};
|
||||
let whole = reference("900 0 R", &[(900, format!("[<{id}> <{id}>]").into_bytes())]);
|
||||
let entries = reference("[900 0 R 901 0 R]", &[(900, format!("<{id}>").into_bytes()), (901, format!("<{id}>").into_bytes())]);
|
||||
for file in [whole, entries] {
|
||||
let source = Document::open(Arc::new(file)).unwrap();
|
||||
assert_eq!(content(&source), SECRET);
|
||||
let back = Document::open(Arc::new(write_full(&source, &SaveOptions::default()).unwrap())).unwrap();
|
||||
assert_eq!(content(&back), SECRET);
|
||||
assert!(matches!(back.trailer().get(b"ID"), Some(Object::Array(_))), "written direct");
|
||||
let mut edited = source.clone();
|
||||
let _ = edited.add(Object::Int(1));
|
||||
let back = Document::open(Arc::new(write_incremental(&edited, &SaveOptions::default()).unwrap())).unwrap();
|
||||
assert_eq!(content(&back), SECRET, "an incremental save");
|
||||
assert_eq!(back.trailer().get(b"ID"), edited.trailer().get(b"ID"), "and leaves it as it was");
|
||||
}
|
||||
}
|
||||
|
||||
/// A direct `/Encrypt` can refer to objects. A full save dropped those it found only there, and kept
|
||||
/// its references as they were under the old numbers, so nothing in the file read afterwards.
|
||||
#[test]
|
||||
fn a_direct_encrypt_dictionary_keeps_what_it_refers_to() {
|
||||
for object_streams in [false, true] {
|
||||
let mut doc = Document::open(Arc::new(fixture())).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes128,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [9; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let mut dict = doc.get(doc.trailer().reference(b"Encrypt").unwrap()).as_dict().cloned().unwrap();
|
||||
let filter = doc.add(Object::name("StdCF"));
|
||||
let filters = doc.add(dict.get(b"CF").unwrap().clone());
|
||||
dict.set(b"StmF".to_vec(), Object::Ref(filter));
|
||||
dict.set(b"CF".to_vec(), Object::Ref(filters));
|
||||
doc.trailer_mut().set(b"Encrypt".to_vec(), Object::Dict(dict));
|
||||
let options = SaveOptions { object_streams, ..SaveOptions::default() };
|
||||
let saved = write_full(&doc, &options).unwrap();
|
||||
let back = Document::open(Arc::new(saved)).unwrap();
|
||||
assert_eq!(content(&back), SECRET, "object streams: {object_streams}");
|
||||
let again = write_full(&back, &options).unwrap();
|
||||
assert_eq!(content(&Document::open(Arc::new(again)).unwrap()), SECRET, "object streams: {object_streams}, saved again");
|
||||
}
|
||||
}
|
||||
|
||||
/// How a stream is treated can be given by reference, and what that loads can be a stream too. A
|
||||
/// file can make a ladder of those, where each rung reads the rung below, then two trees wider than
|
||||
/// the object cache, which push that rung out of it, then the rung below again. Each rung would
|
||||
/// take twice what the one below does, if one read could follow any number of references.
|
||||
#[test]
|
||||
fn selectors_that_lead_to_selectors_load_at_once() {
|
||||
let mut doc = Document::open(Arc::new(protect(Algorithm::Aes128, "", "owner", -1))).unwrap();
|
||||
let stream_of = |doc: &mut Document, filters: Vec<Object>| {
|
||||
let mut dict = pdfcraft_cos::Dict::new();
|
||||
dict.set(b"Filter".to_vec(), Object::Array(filters));
|
||||
doc.add(Object::Stream(pdfcraft_cos::Stream::from_raw(dict, Vec::new())))
|
||||
};
|
||||
let tree = |doc: &mut Document| {
|
||||
let mut level: Vec<ObjRef> = (0..6_561).map(|i| doc.add(Object::Int(i))).collect();
|
||||
while level.len() > 1 {
|
||||
let chunks: Vec<Vec<Object>> = level.chunks(9).map(|c| c.iter().map(|r| Object::Ref(*r)).collect()).collect();
|
||||
level = chunks.into_iter().map(|c| stream_of(doc, c)).collect();
|
||||
}
|
||||
Object::Ref(level[0])
|
||||
};
|
||||
let (first, second) = (tree(&mut doc), tree(&mut doc));
|
||||
let mut top = doc.add(Object::Int(0));
|
||||
// Twelve rungs of two, and the trees' five levels, stay inside the 32 that loading may nest.
|
||||
for _ in 0..12 {
|
||||
let (a, b) = (stream_of(&mut doc, vec![Object::Ref(top)]), stream_of(&mut doc, vec![Object::Ref(top)]));
|
||||
top = stream_of(&mut doc, vec![Object::Ref(a), first.clone(), second.clone(), Object::Ref(b)]);
|
||||
}
|
||||
let saved = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
let (done, finished) = std::sync::mpsc::channel();
|
||||
std::thread::spawn(move || {
|
||||
let doc = Document::open(Arc::new(saved)).unwrap();
|
||||
let _ = done.send(doc.get(top).as_dict().is_some());
|
||||
});
|
||||
// With the budget it takes milliseconds, and without it longer than anyone would wait, so a
|
||||
// margin this wide can't fail on a busy machine.
|
||||
assert_eq!(finished.recv_timeout(std::time::Duration::from_secs(120)), Ok(true), "loading must not fan out");
|
||||
}
|
||||
@@ -10538,6 +10538,107 @@ fn xfa_deferred_choice_resets_preserve_the_reset_value_through_reopen() {
|
||||
assert!(failures.is_empty(), "{}", failures.join("\n"));
|
||||
}
|
||||
|
||||
/// Optimize has JBIG2 images share a symbol dictionary only where redaction can store each again
|
||||
/// without it. Of four pages of the same scan, the two in DeviceGray and the image mask share one;
|
||||
/// the one in a DeviceN of one colourant, which redaction doesn't store again, is coded alone.
|
||||
/// Redacting the first page then stores the second and the mask again without the dictionary,
|
||||
/// which leaves the file.
|
||||
#[test]
|
||||
fn redacting_an_optimized_jbig2_page_stores_the_rest_of_its_group_again() {
|
||||
use pdfcraft_cos::{Dict, Document, ObjRef, Object, SaveOptions, Stream, write_full};
|
||||
let (w, h) = (600usize, 480usize);
|
||||
// Lines of 26 letters, each 32 rows of a run from a stem down its left side, of 2 to 24 pixels,
|
||||
// the same to the pixel wherever it is, picked and spaced at random.
|
||||
let mut seed = 0x2545_F491_4F6C_DD1Du64;
|
||||
let mut next = move || {
|
||||
seed ^= seed << 13;
|
||||
seed ^= seed >> 7;
|
||||
seed ^= seed << 17;
|
||||
seed as usize
|
||||
};
|
||||
let letters: Vec<Vec<usize>> = (0..26).map(|_| (0..16).map(|_| 1 + next() % 12).collect()).collect();
|
||||
let stride = w.div_ceil(8);
|
||||
let mut bits = vec![0xFFu8; stride * h];
|
||||
for top in (8..h - 40).step_by(44) {
|
||||
let mut x = 8 + next() % 8;
|
||||
while x + 32 < w {
|
||||
let letter = &letters[next() % 26];
|
||||
for (row, run) in letter.iter().enumerate() {
|
||||
for (px, py) in (x..x + 2 * run).flat_map(|px| [(px, top + 2 * row), (px, top + 2 * row + 1)]) {
|
||||
bits[py * stride + px / 8] &= !(0x80 >> (px % 8));
|
||||
}
|
||||
}
|
||||
x += 2 * letter.iter().max().unwrap_or(&1) + 4 + next() % 5;
|
||||
}
|
||||
}
|
||||
let mut doc = Document::new_empty();
|
||||
let pages = doc.root().and_then(|r| doc.get(r).as_dict().and_then(|d| d.reference(b"Pages"))).unwrap();
|
||||
let device_n = Object::Array(vec![Object::name("DeviceN"), Object::Array(vec![Object::name("Black")]), Object::name("DeviceGray"), {
|
||||
let mut tint = Dict::new();
|
||||
tint.set(b"FunctionType".to_vec(), Object::Int(2));
|
||||
tint.set(b"Domain".to_vec(), Object::Array(vec![Object::Int(0), Object::Int(1)]));
|
||||
tint.set(b"N".to_vec(), Object::Int(1));
|
||||
Object::Dict(tint)
|
||||
}]);
|
||||
let mut images: Vec<ObjRef> = Vec::new();
|
||||
let grey = || ("ColorSpace", Object::name("DeviceGray"));
|
||||
for (k, (key, value)) in [grey(), grey(), ("ColorSpace", device_n), ("ImageMask", Object::Bool(true))].into_iter().enumerate() {
|
||||
let mut d = Dict::new();
|
||||
d.set(b"Type".to_vec(), Object::name("XObject"));
|
||||
d.set(b"Subtype".to_vec(), Object::name("Image"));
|
||||
d.set(b"Width".to_vec(), Object::Int(w as i64));
|
||||
d.set(b"Height".to_vec(), Object::Int(h as i64));
|
||||
d.set(b"BitsPerComponent".to_vec(), Object::Int(1));
|
||||
d.set(key.as_bytes().to_vec(), value);
|
||||
let image = doc.add(Object::Stream(Stream::flate(d, &bits)));
|
||||
images.push(image);
|
||||
let content = doc.add(Object::Stream(Stream::from_raw(Dict::new(), b"q 144 0 0 115.2 36 600 cm /Im Do Q".to_vec())));
|
||||
let mut xobjects = Dict::new();
|
||||
xobjects.set(b"Im".to_vec(), Object::Ref(image));
|
||||
let mut resources = Dict::new();
|
||||
resources.set(b"XObject".to_vec(), Object::Dict(xobjects));
|
||||
let mut page = Dict::new();
|
||||
page.set(b"Type".to_vec(), Object::name("Page"));
|
||||
page.set(b"Parent".to_vec(), Object::Ref(pages));
|
||||
page.set(b"MediaBox".to_vec(), Object::Array(vec![0.into(), 0.into(), 612.into(), 792.into()]));
|
||||
page.set(b"Resources".to_vec(), Object::Dict(resources));
|
||||
page.set(b"Contents".to_vec(), Object::Ref(content));
|
||||
if k == 0 {
|
||||
let mut mark = Dict::new();
|
||||
mark.set(b"Type".to_vec(), Object::name("Annot"));
|
||||
mark.set(b"Subtype".to_vec(), Object::name("Redact"));
|
||||
mark.set(b"Rect".to_vec(), Object::Array(vec![40.into(), 610.into(), 100.into(), 650.into()]));
|
||||
let mark = doc.add(Object::Dict(mark));
|
||||
page.set(b"Annots".to_vec(), Object::Array(vec![Object::Ref(mark)]));
|
||||
}
|
||||
let page = doc.add(Object::Dict(page));
|
||||
doc.update_dict(pages, |d| {
|
||||
let mut kids = d.get(b"Kids").and_then(|k| k.as_array().cloned()).unwrap_or_default();
|
||||
kids.push(Object::Ref(page));
|
||||
d.set(b"Count".to_vec(), Object::Int(kids.len() as i64));
|
||||
d.set(b"Kids".to_vec(), Object::Array(kids));
|
||||
})
|
||||
.unwrap();
|
||||
}
|
||||
let mono = pdfcraft_optimize::MonoSettings {
|
||||
compression: pdfcraft_optimize::MonoCompression::Jbig2,
|
||||
downsample: false,
|
||||
..pdfcraft_optimize::MonoSettings::REDUCE
|
||||
};
|
||||
pdfcraft_optimize::optimize(&mut doc, &pdfcraft_optimize::Settings { mono, ..Default::default() }).unwrap();
|
||||
let globals = |doc: &Document, image: ObjRef| match &*doc.get(image) {
|
||||
Object::Stream(s) => s.dict.get(b"DecodeParms").and_then(Object::as_dict).and_then(|d| d.reference(b"JBIG2Globals")),
|
||||
_ => None,
|
||||
};
|
||||
let shared = globals(&doc, images[0]);
|
||||
assert!(shared.is_some() && globals(&doc, images[1]) == shared && globals(&doc, images[3]) == shared, "DeviceGray and the mask share");
|
||||
assert_eq!(globals(&doc, images[2]), None, "the DeviceN page is coded alone");
|
||||
pdfcraft_redact::apply(&mut doc, None).unwrap();
|
||||
let saved = Document::open(Arc::new(write_full(&doc, &SaveOptions::default()).unwrap())).unwrap();
|
||||
let named = saved.scan_objects().filter(|(_, o)| matches!(&**o, Object::Stream(s) if saved.jbig2_globals_ref(s).is_some())).count();
|
||||
assert_eq!(named, 0, "no image names the dictionary, which left with them");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fill_sign_multiline_text_survives_engine_save_reopen_and_render() {
|
||||
let (mut session, id) = rotated_blank(0);
|
||||
|
||||
@@ -27,10 +27,11 @@ encode(filter, params, data) -> Result<Vec<u8>, FilterError>
|
||||
encode_flate(data) -> Vec<u8> // zlib, level 6
|
||||
encode_g4(data, columns, rows) -> Result<Vec<u8>, FilterError> // 1-bit rows as CCITT Group 4; columns <= MAX_G4_COLUMNS
|
||||
pub struct CcittParams { k, columns, rows, end_of_line, encoded_byte_align, end_of_block, black_is_1 } // Table 11; Default = its defaults
|
||||
decode_ccitt(data, ¶ms, max_rows) -> Result<Vec<u8>, FilterError> // CCITT fax as CCITTFaxDecode gives it; columns <= MAX_CCITT_COLUMNS
|
||||
decode_jbig2(data, globals, columns, rows, max) -> Result<Vec<u8>, FilterError> // JBIG2 as JBIG2Decode gives it; a page of columns × rows, within max and MAX_JBIG2_PIXELS
|
||||
encode_jbig2_generic(data, columns, rows) -> Result<Vec<u8>, FilterError> // 1-bit rows as lossless JBIG2 for JBIG2Decode; columns <= MAX_JBIG2_COLUMNS
|
||||
encode_jbig2(data, columns, rows) -> Result<Vec<u8>, FilterError> // 1-bit rows as lossless JBIG2 for JBIG2Decode, symbol coded when that is smaller; columns <= MAX_JBIG2_COLUMNS
|
||||
decode_ccitt_within(data, ¶ms, max_rows, work: &mut u64) -> Result<Vec<u8>, FilterError> // CCITT fax as CCITTFaxDecode gives it; columns <= MAX_CCITT_COLUMNS; its rows paid for from work before they are decoded
|
||||
decode_jbig2_within(data, globals, columns, rows, max, work: &mut u64) -> Result<Vec<u8>, FilterError> // JBIG2 as JBIG2Decode gives it; a page of columns × rows, within max and MAX_JBIG2_PIXELS; reading and decoding it spend from work, in the decoder's steps
|
||||
encode_jbig2_generic(data, columns, rows) -> Result<Vec<u8>, FilterError> // 1-bit rows as lossless JBIG2 for JBIG2Decode; columns and rows <= MAX_JBIG2_COLUMNS (65,535) and MAX_JBIG2_PIXELS (2^28) samples, what the decoder takes
|
||||
encode_jbig2(data, columns, rows) -> Result<Vec<u8>, FilterError> // 1-bit rows as lossless JBIG2 for JBIG2Decode, symbol coded when that is smaller; the same limits
|
||||
encode_jbig2_shared(&[(data, columns, rows)]) -> Result<Option<SharedJbig2>, FilterError> // images symbol coded sharing one dictionary: the /JBIG2Globals data, and each image's stream or None; the same limits
|
||||
```
|
||||
|
||||
- `chain` is applied first to last, as in a `/Filter` array.
|
||||
@@ -50,8 +51,8 @@ encode_jbig2(data, columns, rows) -> Result<Vec<u8>, FilterError> // 1-bit row
|
||||
| ASCIIHexDecode | white space ignored, odd digit padded with 0, `>` EOD (optional), other characters → Corrupt | upper case, newline every 64 digits, `>` |
|
||||
| ASCII85Decode | `<~` prefix, `z`, white space, `~>` (or bare `~`, or none) EOD, final partial group; `z` inside a group, a 1-char final group, overflow or bad characters → Corrupt | `z` for zero groups, newline every 75 characters, `~>` |
|
||||
| RunLengthDecode | 0–127 literal, 129–255 repeat, 128 EOD (optional); truncated run → Corrupt | runs of ≥2 repeat, literals up to 128, 128 |
|
||||
| CCITTFaxDecode | not in a chain (`Unsupported`); `decode_ccitt` decodes Group 3 and Group 4 on its own, as rows of 1-bit samples each on a new byte, black 0 unless `black_is_1`, at most `max_rows` rows (fewer with `/Rows`), the rows before any damage, up to 1,048,576 samples a row; Group 3 rows on bytes are read by their end-of-line codes when the data starts with one and on bytes otherwise, whatever `end_of_line` says, so data with codes but none before the first row (not as T.4 sends them) is read on bytes, as the renderer draws it, and at `k` 0 may come out as other rows (`pdfcraft_cos::Document::decoded_image` calls it for a fax image, after the filters before it) | `encode_g4`: Group 4 (`/K -1`) with an end-of-block mark, 0 bits coded black so `/BlackIs1 false` decodes the same bits; rows packed MSB first, each on a new byte, padding bits and trailing bytes ignored; up to 32,767 samples a row (the encoder counts positions in 16 bits); no rows or columns, or too wide → Unsupported, too few bytes → Corrupt |
|
||||
| JBIG2Decode | not in a chain (`Unsupported`); `decode_jbig2` decodes it on its own with `hayro-jbig2`, given what its `/JBIG2Globals` decode to, as rows of 1-bit samples each on a new byte, black 0; the page has to be `columns` × `rows` (PdfCraft's renderer draws the whole page into the image), within `max` bytes as such rows and 2^28 pixels (`MAX_JBIG2_PIXELS`, about the most the decoder takes), checked before it is decoded; regions inside it are bounded by the decoder alone (a region may claim more pixels than its page); damaged data, or globals that don't decode, are `Corrupt` (`pdfcraft_cos::Document::decoded_image` calls it for a JBIG2 image, after the filters before it) | `encode_jbig2_generic`: the embedded organisation (D.3) with a page information segment and an immediate lossless generic region (7.4.6), no `/JBIG2Globals`; template 0 with its nominal AT pixels and typical prediction (6.2.5), coded with the MQ arithmetic coder (Annex E, Table E.1) and ended by its 0xFF 0xAC marker. A 0 sample is coded as a JBIG2 1 (black), since `JBIG2Decode` gives black as 0, so the stream decodes to the same bits; rows packed MSB first, each on a new byte, padding bits and trailing bytes ignored; up to 1,048,576 samples a row; no rows or columns, or too wide → Unsupported, too few bytes → Corrupt. `encode_jbig2`: the smaller of that and symbol coding (`jbig2/symbols.rs`): each distinct mark (8-connected black pixels, at most 256 a side) stored once in a symbol dictionary (7.4.2; arithmetic coded, each bitmap a template 0 generic region without typical prediction, the bitmaps sharing their contexts) and placed by immediate lossless text regions referring to it (7.4.3; bottom-left reference corner, strips of 1, 2, 4 or 8 rows, whichever is smallest), each of at most 10,000 instances over a band of rows, as the decoder PdfCraft renders with (`hayro-jbig2`) takes no more in one region, with larger marks, and in a second plan marks that occur once, in a generic region over their box. Only exact copies share a symbol (no refinement), so the stream decodes to the same bits; fewer than two symbols, more than 2^20 black runs, 65,536 distinct marks or 16 MiB of their pixels, or more than 2^24 rows, and the generic coding is used; a plan of more than 32,767 symbols (that decoder refuses more) isn't made |
|
||||
| CCITTFaxDecode | not in a chain (`Unsupported`); `decode_ccitt_within` decodes Group 3 and Group 4 on its own, as rows of 1-bit samples each on a new byte, black 0 unless `black_is_1`, at most `max_rows` rows (fewer with `/Rows`), the rows before any damage, up to 1,048,576 samples a row; Group 3 rows on bytes are read by their end-of-line codes when the data starts with one and on bytes otherwise, whatever `end_of_line` says, so data with codes but none before the first row (not as T.4 sends them) is read on bytes, as the renderer draws it, and at `k` 0 may come out as other rows (`pdfcraft_cos::ImageBudget::decode` calls it for a fax image, after the filters before it) | `encode_g4`: Group 4 (`/K -1`) with an end-of-block mark, 0 bits coded black so `/BlackIs1 false` decodes the same bits; rows packed MSB first, each on a new byte, padding bits and trailing bytes ignored; up to 32,767 samples a row (the encoder counts positions in 16 bits); no rows or columns, or too wide → Unsupported, too few bytes → Corrupt |
|
||||
| JBIG2Decode | not in a chain (`Unsupported`); `decode_jbig2_within` decodes it on its own with `hayro-jbig2`, given what its `/JBIG2Globals` decode to, as rows of 1-bit samples each on a new byte, black 0; the page has to be `columns` × `rows` (PdfCraft's renderer draws the whole page into the image), within `max` bytes as such rows and 2^28 pixels (`MAX_JBIG2_PIXELS`, the most the decoder takes), checked before it is decoded; regions inside it are bounded by the decoder alone (a region may claim more pixels than its page); damaged data, or globals that don't decode, are `Corrupt` (`pdfcraft_cos::ImageBudget::decode` calls it for a JBIG2 image, after the filters before it) | `encode_jbig2_generic`: the embedded organisation (D.3) with a page information segment and an immediate lossless generic region (7.4.6), no `/JBIG2Globals`; template 0 with its nominal AT pixels and typical prediction (6.2.5), coded with the MQ arithmetic coder (Annex E, Table E.1) and ended by its 0xFF 0xAC marker. A 0 sample is coded as a JBIG2 1 (black), since `JBIG2Decode` gives black as 0, so the stream decodes to the same bits; rows packed MSB first, each on a new byte, padding bits and trailing bytes ignored; up to 65,535 samples on a side and 2^28 in all, where `hayro-jbig2` stops; no rows or columns, or too large → Unsupported, too few bytes → Corrupt. `encode_jbig2`: the smaller of that and symbol coding (`jbig2/symbols.rs`): each distinct mark (8-connected black pixels, at most 256 a side) stored once in a symbol dictionary (7.4.2; arithmetic coded, each bitmap a template 0 generic region without typical prediction, the bitmaps sharing their contexts) and placed by immediate lossless text regions referring to it (7.4.3; bottom-left reference corner, strips of 1, 2, 4 or 8 rows, whichever is smallest), each of at most 10,000 instances over a band of rows, as the decoder PdfCraft renders with (`hayro-jbig2`) takes no more in one region, with larger marks, and in a second plan marks that occur once, in a generic region over their box. Only exact copies share a symbol (no refinement), so the stream decodes to the same bits; fewer than two symbols, more than 2^20 black runs, 65,536 distinct marks or 16 MiB of their pixels, and the generic coding is used; a plan of more than 32,767 symbols (that decoder refuses more) isn't made. `encode_jbig2_shared`: the marks found in more than one image of a group (at most 16,383, those in the most images first, within the same limits on distinct marks and their pixels as one image's) go once in a symbol dictionary segment associated with no page, number 0, which is the `/JBIG2Globals` data (7.2.6, D.3); each image's stream numbers its segments from 1 (a segment refers only to lower numbers, 7.2.5) and its text regions refer to that dictionary first, then to one of its own for the marks only it repeats, so the shared symbols' IDs come first (Table 31's SBSYMS); the rest is coded as `encode_jbig2`'s symbol coding codes it, the smaller of its two plans. An image that places none of the shared marks gets no stream, to be stored alone; whether the rest save more than the globals take is the caller's to weigh |
|
||||
|
||||
## Tests
|
||||
|
||||
@@ -61,8 +62,8 @@ encode_jbig2(data, columns, rows) -> Result<Vec<u8>, FilterError> // 1-bit row
|
||||
- `ccitt.rs`: `decode_ccitt` gives back the rows `encode_g4` was given (with `/BlackIs1`, `/Rows` and a row limit), refuses bad widths, and bounds its output for any input; byte-aligned Group 3 in each layout, over 32 seeded pictures, decodes to its picture, and a byte short to fewer rows. Group 4 output decoded by `hayro-ccitt` (an independent decoder) matches the input bits: a text-like page, padding bits, the widest row, and property tests over bitmaps of noise and of runs; any input returns rather than panics.
|
||||
- `mq.rs`: the arithmetic coder reproduces Annex H.2's 30 bytes from its 256 decisions.
|
||||
- `jbig2.rs`: output decoded by `hayro-jbig2` (dev-dependency, an independent decoder) matches the input bits: a text-like page (smaller than Group 4), edges, padding, all-white and all-black regions (typical rows), and property tests over bitmaps of noise and of runs; any input returns rather than panics.
|
||||
- `jbig2/decode.rs`: `decode_jbig2` gives back the rows of both codings, padding bits 0; refuses a page of another width or height, past `max` or past `MAX_JBIG2_PIXELS` before decoding it (2^28 pixels take about 34 MB, a bit each), globals that aren't JBIG2 and damaged data, and returns rather than panics on every prefix of a stream.
|
||||
- `jbig2/symbols.rs`: the integer coders against Annex A's example and Table A.1; symbol-coded output decoded by `hayro-jbig2` matches the input bits for every plan and strip size: text whose letters repeat (under half the generic coding's size, the dictionary retained and referred to), large and lone marks left to a generic region, marks on the edges, touching at corners and inside each other's boxes, and property tests over glyphs scattered over each other and the edges with stray pixels (never larger than the generic coding); one shape, a blank page and noise are coded generically; marks joined at a corner, either way, are one mark, and 256 pixels a side is a symbol while 257 wide or tall is left out; black padding bits are ignored; coordinates past 4,435 use Annex A's 32-bit range and PREV stays below 512; past 2^20 runs, 2^24 rows, 65,536 distinct marks or 2^24 symbol pixels the image is coded generically, and at each cap it is still looked at; a plan codes at most 32,767 symbols, which decode, and past that the second plan still codes the repeated ones; more than 10,000 marks are placed by several text regions, numbered in turn, the dictionary retained for each but the last; any input returns rather than panics.
|
||||
- `jbig2/decode.rs`: `decode_jbig2_within` gives back the rows of both codings, padding bits 0; refuses a page of another width or height, past `max` or past `MAX_JBIG2_PIXELS` before decoding it (2^28 pixels take about 34 MB, a bit each), globals that aren't JBIG2 and damaged data, and returns rather than panics on every prefix of a stream.
|
||||
- `jbig2/symbols.rs`: the integer coders against Annex A's example and Table A.1; symbol-coded output decoded by `hayro-jbig2` matches the input bits for every plan and strip size: text whose letters repeat (under half the generic coding's size, the dictionary retained and referred to), large and lone marks left to a generic region, marks on the edges, touching at corners and inside each other's boxes, and property tests over glyphs scattered over each other and the edges with stray pixels (never larger than the generic coding); one shape, a blank page and noise are coded generically; marks joined at a corner, either way, are one mark, and 256 pixels a side is a symbol while 257 wide or tall is left out; black padding bits are ignored; coordinates past 4,435 use Annex A's 32-bit range and PREV stays below 512; past 2^20 runs, 65,536 distinct marks or 2^24 symbol pixels the image is coded generically, and at each cap it is still looked at; a plan codes at most 32,767 symbols, which decode, and past that the second plan still codes the repeated ones; more than 10,000 marks are placed by several text regions, numbered in turn, the dictionary retained for each but the last; pages in one font share one dictionary, segment 0 of no page, retained, which each page's text regions refer to first, taking less together than alone, a page's own repeated marks in a dictionary referred to after it, a page sharing nothing left alone, images with fewer than two marks in common sharing nothing, and past 16,383 shared marks those in the most images kept, with a property test over groups of scattered pages; any input returns rather than panics.
|
||||
- `fuzz/`: a detached cargo-fuzz crate (`cargo +nightly fuzz run decode`, run from `crates/filters/`).
|
||||
|
||||
## Status
|
||||
|
||||
+121
-25
@@ -1,8 +1,9 @@
|
||||
//! JBIG2 encoding (ITU-T T.88 | ISO/IEC 14492), for `JBIG2Decode` (ISO 32000-2 §7.4.7), lossless:
|
||||
//! a generic region, template 0 with its nominal adaptive pixels, typical prediction on, MQ
|
||||
//! arithmetic coding ([`crate::mq`]); or the image's marks as symbols ([`symbols`]). Written from
|
||||
//! the standard's 6.2.5 (coding a generic region), 7.2 (segment headers), 7.4.1, 7.4.6 and 7.4.8
|
||||
//! (the segments) and D.3 (the embedded organisation PDF uses). Decoding is in [`decode`].
|
||||
//! arithmetic coding ([`crate::mq`]); or the image's marks as symbols ([`symbols`]), which a group
|
||||
//! of images may share through `/JBIG2Globals`. Written from the standard's 6.2.5 (coding a generic
|
||||
//! region), 7.2 (segment headers), 7.4.1, 7.4.6 and 7.4.8 (the segments) and D.3 (the embedded
|
||||
//! organisation PDF uses). Decoding is in [`decode`].
|
||||
|
||||
mod decode;
|
||||
mod symbols;
|
||||
@@ -12,9 +13,11 @@ pub use decode::{MAX_JBIG2_PIXELS, decode_jbig2_within};
|
||||
use crate::FilterError;
|
||||
use crate::mq::{Context, MqEncoder};
|
||||
|
||||
/// The widest row [`encode_jbig2_generic`] encodes. JBIG2 allows 32-bit widths; this keeps a
|
||||
/// row's buffers small and its positions in range.
|
||||
pub const MAX_JBIG2_COLUMNS: u32 = 1 << 20;
|
||||
/// The widest row, and the most rows, [`encode_jbig2_generic`] encodes: what `hayro-jbig2`, the
|
||||
/// decoder behind `JBIG2Decode` here, takes on a side. JBIG2 allows 32-bit sizes, but past this
|
||||
/// nothing here could read the stream, and the optimizer, which doesn't read back what it stores,
|
||||
/// replaced such an image with one that draws nothing.
|
||||
pub const MAX_JBIG2_COLUMNS: u32 = 65_535;
|
||||
|
||||
/// Template 0's pixels (Figure 3), as (x, y) offsets from the pixel being coded, each a bit of the
|
||||
/// context in this order: the four on the current row, the five fixed ones on the row above, the
|
||||
@@ -54,9 +57,7 @@ const PAD: usize = 4;
|
||||
/// Errors: as [`encode_jbig2_generic`].
|
||||
pub fn encode_jbig2(data: &[u8], columns: u32, rows: u32) -> Result<Vec<u8>, FilterError> {
|
||||
let generic = encode_jbig2_generic(data, columns, rows)?;
|
||||
// `encode_jbig2_generic` checked that the rows are there.
|
||||
let stride = (columns as usize).div_ceil(8);
|
||||
let samples = usize::try_from(rows).ok().and_then(|r| r.checked_mul(stride)).and_then(|n| data.get(..n));
|
||||
let samples = rows_to_encode(data, columns, rows).ok();
|
||||
Ok(match samples.and_then(|s| symbols::encode(s, columns, rows)) {
|
||||
Some(coded) if coded.len() < generic.len() => coded,
|
||||
_ => generic,
|
||||
@@ -72,18 +73,13 @@ pub fn encode_jbig2(data: &[u8], columns: u32, rows: u32) -> Result<Vec<u8>, Fil
|
||||
/// samples have it. Bytes after the last row are ignored, as are the bits that pad a row to a whole
|
||||
/// byte.
|
||||
///
|
||||
/// Errors: no rows or columns, or rows wider than [`MAX_JBIG2_COLUMNS`]
|
||||
/// ([`FilterError::Unsupported`]); fewer bytes than the rows need ([`FilterError::Corrupt`]).
|
||||
/// Errors: no rows or columns, more of either than [`MAX_JBIG2_COLUMNS`], or more samples than
|
||||
/// [`MAX_JBIG2_PIXELS`], what the decoder takes ([`FilterError::Unsupported`]); fewer bytes than the
|
||||
/// rows need ([`FilterError::Corrupt`]).
|
||||
pub fn encode_jbig2_generic(data: &[u8], columns: u32, rows: u32) -> Result<Vec<u8>, FilterError> {
|
||||
if columns == 0 || rows == 0 || columns > MAX_JBIG2_COLUMNS {
|
||||
return Err(FilterError::Unsupported(format!("JBIG2 encoding of {columns} × {rows} samples")));
|
||||
}
|
||||
let samples = rows_to_encode(data, columns, rows)?;
|
||||
let width = columns as usize;
|
||||
let stride = width.div_ceil(8);
|
||||
let samples = usize::try_from(rows).ok().and_then(|r| r.checked_mul(stride)).and_then(|n| data.get(..n)).ok_or_else(|| FilterError::Corrupt {
|
||||
filter: "JBIG2Decode",
|
||||
detail: format!("{} bytes for {rows} rows of {columns} samples", data.len()),
|
||||
})?;
|
||||
let mut contexts: Vec<Context> = vec![0; 1 << 16];
|
||||
let mut mq = MqEncoder::new();
|
||||
let height = samples.len() / stride;
|
||||
@@ -101,6 +97,48 @@ pub fn encode_jbig2_generic(data: &[u8], columns: u32, rows: u32) -> Result<Vec<
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
/// The samples of `rows` rows of `columns` 1-bit samples in `data`, when the encoders here take
|
||||
/// that size; the errors are [`encode_jbig2_generic`]'s.
|
||||
fn rows_to_encode(data: &[u8], columns: u32, rows: u32) -> Result<&[u8], FilterError> {
|
||||
let too_large = columns > MAX_JBIG2_COLUMNS || rows > MAX_JBIG2_COLUMNS || u64::from(columns) * u64::from(rows) > MAX_JBIG2_PIXELS;
|
||||
if columns == 0 || rows == 0 || too_large {
|
||||
return Err(FilterError::Unsupported(format!("JBIG2 encoding of {columns} × {rows} samples")));
|
||||
}
|
||||
let stride = (columns as usize).div_ceil(8);
|
||||
usize::try_from(rows)
|
||||
.ok()
|
||||
.and_then(|r| r.checked_mul(stride))
|
||||
.and_then(|n| data.get(..n))
|
||||
.ok_or_else(|| FilterError::Corrupt { filter: "JBIG2Decode", detail: format!("{} bytes for {rows} rows of {columns} samples", data.len()) })
|
||||
}
|
||||
|
||||
/// A group of images coded by [`encode_jbig2_shared`]: the data of the `/JBIG2Globals` stream
|
||||
/// they share, and each image's own stream, in the order given, or `None` for one that shares
|
||||
/// nothing with the others.
|
||||
#[derive(Debug)]
|
||||
pub struct SharedJbig2 {
|
||||
pub globals: Vec<u8>,
|
||||
pub images: Vec<Option<Vec<u8>>>,
|
||||
}
|
||||
|
||||
/// Images, each `rows` rows of `columns` 1-bit PDF samples, as lossless JBIG2 sharing one symbol
|
||||
/// dictionary: the marks found in more than one of them are stored once, in a symbol dictionary
|
||||
/// segment not associated with a page, which is the `/JBIG2Globals` stream's data, and each image's
|
||||
/// stream, in the embedded organisation, places them from there, with its other marks coded as
|
||||
/// [`encode_jbig2`]'s symbol coding codes them (see [`symbols`]). With the globals, each decodes to
|
||||
/// its own bits. An image that holds none of those marks, or that symbol coding doesn't take, has
|
||||
/// no stream here; it is stored alone. `None` when the images share fewer than two marks.
|
||||
///
|
||||
/// What each image's stream saves is left for the caller to weigh against what the globals take,
|
||||
/// which the images that use them share.
|
||||
///
|
||||
/// Errors: as [`encode_jbig2_generic`], for the first image it would refuse.
|
||||
pub fn encode_jbig2_shared(images: &[(&[u8], u32, u32)]) -> Result<Option<SharedJbig2>, FilterError> {
|
||||
let images =
|
||||
images.iter().map(|(data, columns, rows)| Ok((rows_to_encode(data, *columns, *rows)?, *columns, *rows))).collect::<Result<Vec<_>, _>>()?;
|
||||
Ok(symbols::encode_shared(&images).map(|(globals, images)| SharedJbig2 { globals, images }))
|
||||
}
|
||||
|
||||
/// A page information segment's data (7.4.8): the page's size, resolution unknown, eventually
|
||||
/// lossless, default pixel 0 (white), OR combination, not striped.
|
||||
fn page_information(columns: u32, rows: u32) -> Vec<u8> {
|
||||
@@ -141,12 +179,18 @@ fn at_pixels(out: &mut Vec<u8>) {
|
||||
}
|
||||
}
|
||||
|
||||
/// A segment (7.2): its header (number, type, the segments it refers to, page 1, data length),
|
||||
/// then its data. `retained`: a later segment refers to this one. `refers_to` holds each
|
||||
/// A segment (7.2) of page 1: its header (number, type, the segments it refers to, the page, data
|
||||
/// length), then its data. `retained`: a later segment refers to this one. `refers_to` holds each
|
||||
/// referred-to segment's number and whether a segment after this one refers to it too (its
|
||||
/// retain bit, 7.2.4). Segment numbers here stay below 256, so each referred-to one takes a byte
|
||||
/// (7.2.5); a segment refers to at most four, so their count and retain bits take one byte too.
|
||||
fn segment(out: &mut Vec<u8>, number: u32, kind: u8, refers_to: &[(u8, bool)], retained: bool, data: &[u8]) {
|
||||
segment_of(out, 1, number, kind, refers_to, retained, data);
|
||||
}
|
||||
|
||||
/// [`segment`], of page `page`: 0 for a segment associated with no page (7.2.6), such as the
|
||||
/// global ones `/JBIG2Globals` holds, which a page's segments may refer to.
|
||||
fn segment_of(out: &mut Vec<u8>, page: u8, number: u32, kind: u8, refers_to: &[(u8, bool)], retained: bool, data: &[u8]) {
|
||||
out.extend_from_slice(&number.to_be_bytes());
|
||||
out.push(kind);
|
||||
// At most four, so the count fits its three bits.
|
||||
@@ -154,8 +198,8 @@ fn segment(out: &mut Vec<u8>, number: u32, kind: u8, refers_to: &[(u8, bool)], r
|
||||
let kept = refers_to.iter().enumerate().fold(0u8, |bits, (k, (_, kept))| bits | u8::from(*kept) << (k + 1));
|
||||
out.push((refers_to.len() as u8) << 5 | kept | u8::from(retained));
|
||||
out.extend(refers_to.iter().map(|(n, _)| *n));
|
||||
out.push(1);
|
||||
// A segment's data never comes near 4 GiB here: a row is at most 1 MiB wide.
|
||||
out.push(page);
|
||||
// A segment's data never comes near 4 GiB here: an image is at most 2^28 samples.
|
||||
out.extend_from_slice(&u32::try_from(data.len()).unwrap_or(u32::MAX).to_be_bytes());
|
||||
out.extend_from_slice(data);
|
||||
}
|
||||
@@ -212,6 +256,11 @@ mod tests {
|
||||
/// The rows an independent decoder (`hayro-jbig2`) reads from `data`, as PDF samples: true
|
||||
/// for white (a JBIG2 0).
|
||||
pub(super) fn decode(data: &[u8]) -> Vec<Vec<bool>> {
|
||||
decode_with(data, None)
|
||||
}
|
||||
|
||||
/// [`decode`], with `/JBIG2Globals`.
|
||||
pub(super) fn decode_with(data: &[u8], globals: Option<&[u8]>) -> Vec<Vec<bool>> {
|
||||
struct Rows(Vec<Vec<bool>>, Vec<bool>, usize);
|
||||
impl hayro_jbig2::Decoder for Rows {
|
||||
fn push_pixel(&mut self, black: bool) {
|
||||
@@ -226,7 +275,7 @@ mod tests {
|
||||
self.0.push(row);
|
||||
}
|
||||
}
|
||||
let image = hayro_jbig2::Image::new_embedded(data, None).unwrap();
|
||||
let image = hayro_jbig2::Image::new_embedded(data, globals).unwrap();
|
||||
let mut rows = Rows(Vec::new(), Vec::new(), image.width() as usize);
|
||||
image.decode(&mut rows).unwrap();
|
||||
rows.0
|
||||
@@ -343,9 +392,56 @@ mod tests {
|
||||
fn what_it_cannot_encode_is_an_error() {
|
||||
assert!(matches!(encode_jbig2_generic(&[0; 8], 0, 1), Err(FilterError::Unsupported(_))));
|
||||
assert!(matches!(encode_jbig2_generic(&[0; 8], 8, 0), Err(FilterError::Unsupported(_))));
|
||||
assert!(matches!(encode_jbig2_generic(&[0; 8], MAX_JBIG2_COLUMNS + 1, 1), Err(FilterError::Unsupported(_))));
|
||||
assert!(matches!(encode_jbig2_generic(&[0; 3], 16, 2), Err(FilterError::Corrupt { .. })), "two rows of 16 need 4 bytes");
|
||||
assert!(matches!(encode_jbig2_generic(&[], 1, u32::MAX), Err(FilterError::Corrupt { .. })));
|
||||
assert!(matches!(encode_jbig2_generic(&[], 1, 2), Err(FilterError::Corrupt { .. })));
|
||||
}
|
||||
|
||||
/// The encoder stops where the decoder does, on each side and in total: past that it would
|
||||
/// write a stream nothing here can read. 16,384 squared is exactly the bound on samples.
|
||||
/// `encode_jbig2_shared` refuses what `encode_jbig2_generic` refuses: an image taller than
|
||||
/// the decoder takes is `Unsupported`, one at the bound isn't refused. (Its one tall mark is
|
||||
/// too large to be a symbol, so nothing is shared: `Ok(None)`.)
|
||||
#[test]
|
||||
fn shared_coding_takes_only_what_the_decoder_takes() {
|
||||
let past = vec![0x7F; MAX_JBIG2_COLUMNS as usize + 1];
|
||||
let tall = (&past[..], 1, MAX_JBIG2_COLUMNS + 1);
|
||||
assert!(matches!(encode_jbig2_shared(&[tall, tall]), Err(FilterError::Unsupported(_))), "too tall");
|
||||
let at = (&past[..MAX_JBIG2_COLUMNS as usize], 1, MAX_JBIG2_COLUMNS);
|
||||
assert!(matches!(encode_jbig2_shared(&[at, at]), Ok(None)), "at the bound");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn it_encodes_only_what_the_decoder_takes() {
|
||||
let unsupported = |columns, rows| matches!(encode_jbig2_generic(&[], columns, rows), Err(FilterError::Unsupported(_)));
|
||||
assert!(unsupported(MAX_JBIG2_COLUMNS + 1, 1), "too wide");
|
||||
assert!(unsupported(1, MAX_JBIG2_COLUMNS + 1), "too tall");
|
||||
assert!(unsupported(16_385, 16_384), "too many samples, each side within the bound");
|
||||
assert!(unsupported(u32::MAX, u32::MAX), "the product doesn't overflow");
|
||||
// At the bounds what it writes reads back, through the decoder that has to read it.
|
||||
let wide = vec![0x0F; (MAX_JBIG2_COLUMNS as usize).div_ceil(8) * 4];
|
||||
assert_eq!(decode(&encode_jbig2_generic(&wide, MAX_JBIG2_COLUMNS, 4).unwrap()), unpack(&wide, MAX_JBIG2_COLUMNS, 4));
|
||||
let tall = vec![0x7F; MAX_JBIG2_COLUMNS as usize];
|
||||
assert_eq!(decode(&encode_jbig2_generic(&tall, 1, MAX_JBIG2_COLUMNS).unwrap()), unpack(&tall, 1, MAX_JBIG2_COLUMNS));
|
||||
struct Rows(u32, u64);
|
||||
impl hayro_jbig2::Decoder for Rows {
|
||||
fn push_pixel(&mut self, black: bool) {
|
||||
self.1 += u64::from(black);
|
||||
}
|
||||
fn push_pixel_chunk(&mut self, black: bool, chunks: u32) {
|
||||
self.1 += u64::from(black) * u64::from(chunks) * 8;
|
||||
}
|
||||
fn next_line(&mut self) {
|
||||
self.0 += 1;
|
||||
}
|
||||
}
|
||||
// One black pixel, so a page that came back blank wouldn't pass.
|
||||
let mut largest = vec![0xFF; 2_048 * 16_384];
|
||||
largest[0] = 0x7F;
|
||||
let largest = encode_jbig2_generic(&largest, 16_384, 16_384).unwrap();
|
||||
let mut rows = Rows(0, 0);
|
||||
hayro_jbig2::Image::new_embedded(&largest, None).unwrap().decode(&mut rows).unwrap();
|
||||
assert_eq!(rows.0, 16_384);
|
||||
assert_eq!(rows.1, 1);
|
||||
}
|
||||
|
||||
proptest::proptest! {
|
||||
|
||||
@@ -4,7 +4,8 @@ use crate::FilterError;
|
||||
use crate::ccitt::Rows;
|
||||
|
||||
/// The largest JBIG2 page [`decode_jbig2_within`] decodes, in pixels. The decoder decodes a page whole,
|
||||
/// and takes pages of up to about this many (20,000 × 10,000 decodes).
|
||||
/// and takes pages of up to this many (20,000 × 10,000 decodes). It is also the most
|
||||
/// [`encode_jbig2_generic`](crate::encode_jbig2_generic) encodes, so what it stores reads back.
|
||||
pub const MAX_JBIG2_PIXELS: u64 = 1 << 28;
|
||||
|
||||
/// A `JBIG2Decode` stream's `data`, with what its `/JBIG2Globals` stream decodes to, decoded as the
|
||||
@@ -143,6 +144,143 @@ mod tests {
|
||||
assert_eq!(decode_jbig2(&symbols, None, w, h, usize::MAX).unwrap(), marks);
|
||||
}
|
||||
|
||||
/// A region's location is unsigned (ISO/IEC 14492 5.4.4), so one past `i32::MAX` is off the
|
||||
/// page. The decoder took it for a signed one: a region at 0xFFFFFFFC came back onto the page
|
||||
/// four pixels left of it, and a refinement anywhere past `i32::MAX` was refused, and the page
|
||||
/// with it. Each stream is a page of 16 × 12 covered by a generic region, then a region of 8 × 6
|
||||
/// of one kind past `i32::MAX`, coded by the standard's procedures, and decodes to that page
|
||||
/// alone; moved onto the page, the region draws. Vendored hayro-jbig2 patch 14.
|
||||
#[test]
|
||||
fn a_region_located_past_i32_max_is_off_the_page() {
|
||||
const PAGE: &str = "0000000030000100000013000000100000000c00000000000000004200000000000126000100000035000000100000000c0000000000000000040003fffdff02fefefed906aa2cb6ee4ccb4bc975d02669ca7a9c14c20c638f5a5e1bffac";
|
||||
let cases = [
|
||||
// At 0xFFFFFFFC, 1.
|
||||
("generic", "00000002260001000000220000000800000006fffffffc00000001000003fffdff02fefefe17c876ae6f77ffac"),
|
||||
// At 1, 0xFFFFFFFE, with its symbol dictionary.
|
||||
(
|
||||
"text",
|
||||
"000000020000010000001e000003fffdff02fefefe00000001000000014fdda14149cec477ed5fffac00000003062002010000001b000000080000000600000001fffffffe00001000000001a943ffac",
|
||||
),
|
||||
// At 0xFFFFFFFC, 1, with its pattern dictionary.
|
||||
(
|
||||
"halftone",
|
||||
"000000021000010000000a000101000000011fffac00000003162002010000002e0000000800000006fffffffc0000000100000000000800000006000000000000000001000000d09301774485ffac",
|
||||
),
|
||||
// At 0xFFFFFFFC, 1, reading the page there (7.4.7.4): 0s.
|
||||
("refinement of the page", "000000022a00010000001e0000000800000006fffffffc000000010400ffffffff0bd98f188428ffac"),
|
||||
// Of an intermediate region at the same place (7.4.7.5), 1, 0xFFFFFFFE.
|
||||
(
|
||||
"refinement of a region",
|
||||
"0000000224000100000023000000080000000600000001fffffffe000003fffdff02fefefe3d81322da16b7fffac000000032a2002010000001e000000080000000600000001fffffffe0000ffffffffe29946b82229ffac",
|
||||
),
|
||||
// Of an intermediate refinement of an intermediate region, all at 0xFFFFFFFC, 1.
|
||||
(
|
||||
"refinement of a refinement",
|
||||
"00000002240001000000230000000800000006fffffffc00000001000003fffdff02fefefecdfd921ec8c47fffac00000003282002010000001e0000000800000006fffffffc000000010000ffffffff903cdb447a47ffac000000042a2003010000001e0000000800000006fffffffc000000010000ffffffffdcd6078cab86ffac",
|
||||
),
|
||||
];
|
||||
let hex = |text: &str| (0..text.len() / 2).map(|i| u8::from_str_radix(&text[i * 2..i * 2 + 2], 16).unwrap()).collect::<Vec<u8>>();
|
||||
let decode = |segments: &str| decode_jbig2(&[hex(PAGE), hex(segments)].concat(), None, 16, 12, usize::MAX).unwrap();
|
||||
let page = decode("");
|
||||
assert!(page.iter().any(|&byte| byte != 0xFF), "the page has ink");
|
||||
for (kind, segments) in cases {
|
||||
assert_eq!(decode(segments), page, "{kind}");
|
||||
// Moved onto the page, to 4, 1 or 1, 2, the same regions draw: they decode, and are
|
||||
// left out for where they are.
|
||||
let (off, on) = [("fffffffc00000001", "0000000400000001"), ("00000001fffffffe", "0000000100000002")]
|
||||
.into_iter()
|
||||
.find(|(off, _)| segments.contains(off))
|
||||
.unwrap();
|
||||
assert_ne!(decode(&segments.replace(off, on)), page, "{kind} on the page");
|
||||
}
|
||||
|
||||
// A refinement at 2, 0 of an intermediate region at 0x80000000, 0. A refinement of a
|
||||
// region refines it where it is, "GRREFERENCEDX 0, GRREFERENCEDY 0" (Table 35), and the two
|
||||
// should be at one place (7.4.7.5). Where they aren't, it decodes as it does where they are.
|
||||
const ELSEWHERE: &str = "000000022400010000002300000008000000068000000000000000000003fffdff02fefefe1bca3149568cdfffac000000032a2002010000001e000000080000000600000002000000000000ffffffff784a909cc761ffac";
|
||||
let refined = decode(ELSEWHERE);
|
||||
assert_eq!(refined, decode(&ELSEWHERE.replace("8000000000000000", "0000000200000000")), "the region at 2, 0 too");
|
||||
assert_ne!(refined, page, "drawn");
|
||||
}
|
||||
|
||||
/// A refinement of the page refines "the current contents of the page buffer, restricted to the
|
||||
/// area of the page buffer specified by this segment's region segment information field"
|
||||
/// (ISO/IEC 14492 7.4.7.4), at an offset of 0 (Table 35), and reads 0 outside that area
|
||||
/// (6.3.5.2). The decoder read the page around the area too, and refused a refinement wider or
|
||||
/// taller than the page. A refinement of another region refines that region, not the page. And
|
||||
/// a reference 32 or more left of a refinement (GRREFERENCEDX below −31, as a symbol refined
|
||||
/// with an RDX below −31 has, Table 18) is read from where each row starts in it: each row's
|
||||
/// first context read 0 for the reference column it starts at, and from 33 left for the one
|
||||
/// before it too. Each stream is coded by the standard's procedures and decodes to its
|
||||
/// picture, `#` for black. Vendored hayro-jbig2 patch 16.
|
||||
#[test]
|
||||
fn a_refinement_refines_the_page_in_its_area_and_any_reference_where_it_is() {
|
||||
let cases: [(&str, &str, &[&str]); 5] = [
|
||||
(
|
||||
"a 48 × 6 page a generic region has inked, refined at 33: ink on both sides of the area, template 0",
|
||||
"000000003000010000001300000030000000060000000000000000420000000000012600010000004100000030000000060000000000000000040003fffdff02fefefe331433558a5c5056cf412003ec9a38164df39bd4463b9331502c4fb1c267ab77b665aa5962ffac000000022a0001000000210000000c0000000600000021000000000400ffffffff9a6c35bbeee221f687ffac",
|
||||
&[
|
||||
".#..##.######..#.#..#####.##..#........##.##..##",
|
||||
".#..####.####.#...###.##.##.#.#.....#.#.####.###",
|
||||
"##.#......#..#....#..#.###.#..#.#####.###.######",
|
||||
"......#....###.#.##..#.##........#.#.#...#####..",
|
||||
"#.##..###.#.#.##.....#...#.#..#.##.#..#...#...#.",
|
||||
".###...#..#..#..##..#.#..#####.#.##.......###.##",
|
||||
],
|
||||
),
|
||||
(
|
||||
"a 24 × 8 inked page refined at 5, 1, template 1",
|
||||
"000000003000010000001300000018000000080000000000000000420000000000012600010000003500000018000000080000000000000000040003fffdff02fefefeb1e133cb8bcbb8510e81d219bb880dfb40a311dc5c298819efffac000000022a00010000001b0000000a0000000500000005000000010401e55c0078dcd30fffac",
|
||||
&[
|
||||
"#.##.##...##....##.##..#",
|
||||
"#.##.##...#.####..##..#.",
|
||||
"##..##.##...#...###..#.#",
|
||||
".....#.#.##.#...###....#",
|
||||
"..#.#...#.#...#.#...##.#",
|
||||
"....######...#.####....#",
|
||||
"..######..##.#.#..##.#..",
|
||||
"...#..##.####.#..##...#.",
|
||||
],
|
||||
),
|
||||
(
|
||||
"a 16 × 5 inked page refined by a region 4 wider than it, template 0",
|
||||
"000000003000010000001300000010000000050000000000000000420000000000012600010000002600000010000000050000000000000000040003fffdff02fefefe22e5e253a429cbf2c701ffac000000022a000100000023000000140000000500000000000000000400ffffffff3afa516532bbe3d481926fffac",
|
||||
&[".#.#.#.#..#.#.#.", "##.####..###...#", "..####.#..####.#", ".###.#.....#..#.", "#.###..#########"],
|
||||
),
|
||||
(
|
||||
"an intermediate region at 4, 1 on an inked 20 × 8 page, refined there (OR): the region, not the page, template 0",
|
||||
"000000003000010000001300000014000000080000000000000000420000000000012600010000003000000014000000080000000000000000040003fffdff02fefefeb91e434e1726ca89ed06c2bffb0fe5fa7fccc80fffac00000002240001000000230000000a000000050000000400000001000003fffdff02fefefece7a9826ba81bfffac000000032a2002010000001e0000000a0000000500000004000000010000ffffffffd046ee6f6190ffac",
|
||||
&[
|
||||
"#.#.#....#.#...#....",
|
||||
"##..#.#.#.##.....##.",
|
||||
"##.#.#.#.#.###.##...",
|
||||
"###.##.####..###.#.#",
|
||||
"...#.###..###.#.#..#",
|
||||
"#...#######.#...####",
|
||||
"..##.##...#..##..#.#",
|
||||
"#...##...#.##....#..",
|
||||
],
|
||||
),
|
||||
(
|
||||
"a symbol refined in a symbol dictionary from a 40 × 6 one, RDX −33: 33 left, template 1",
|
||||
"0000000030000100000013000000070000000600000000000000004200000000000100000100000036000003fffdff02fefefe00000001000000014f913296209e2187f37bddb8589c8beb7d70109de7124ebe47d04914ef7e655c3c4cffac00000002002001010000001f100203fffdff02fefefe00000001000000014fe451a27bddf49f7ef7e7ffac00000003062002010000001b0000000700000006000000000000000004001000000001a943ffac",
|
||||
&[".####.#", ".##..##", "......#", "...#..#", "#.#.###", "....##."],
|
||||
),
|
||||
];
|
||||
let hex = |text: &str| (0..text.len() / 2).map(|i| u8::from_str_radix(&text[i * 2..i * 2 + 2], 16).unwrap()).collect::<Vec<u8>>();
|
||||
for (form, stream, picture) in cases {
|
||||
let (w, h) = (picture[0].len(), picture.len());
|
||||
// As the filter gives it: black as 0, each row padded to a byte with 0s.
|
||||
let mut rows = vec![0u8; w.div_ceil(8) * h];
|
||||
for (y, row) in picture.iter().enumerate() {
|
||||
for (x, _) in row.bytes().enumerate().filter(|(_, c)| *c == b'.') {
|
||||
rows[y * w.div_ceil(8) + x / 8] |= 0x80 >> (x % 8);
|
||||
}
|
||||
}
|
||||
assert_eq!(decode_jbig2(&hex(stream), None, w as u32, h as u32, usize::MAX).unwrap(), rows, "{form}");
|
||||
}
|
||||
}
|
||||
|
||||
/// What a page costs is the same however much a run has left. Given exactly that it decodes,
|
||||
/// and less stops it: spending all that's left, and what comes after isn't read. A page that
|
||||
/// fails still spends what it took.
|
||||
@@ -182,6 +320,57 @@ mod tests {
|
||||
assert_eq!(u64::MAX - work, 4 * 14);
|
||||
}
|
||||
|
||||
/// A refinement whose reference is offset right of it (GRREFERENCEDX above 0, as a refined text
|
||||
/// instance has from a wider bitmap, ISO/IEC 14492 Table 12, and a refined symbol from an RDX
|
||||
/// above 0, Table 18) reads the reference from its first column. Left of the reference the
|
||||
/// decoder emptied what it had read of it, and at its first column didn't read it again, so its
|
||||
/// first 32 columns read as 0: such a refinement decoded to other pixels than were coded, or
|
||||
/// failed. Each stream is a refinement coded by the standard's procedures on a page of its own
|
||||
/// size, and decodes to its picture, `#` for black. Vendored hayro-jbig2 patch 15.
|
||||
#[test]
|
||||
fn a_refinement_reads_a_reference_right_of_it_from_its_first_column() {
|
||||
let cases: [(&str, &str, &[&str]); 4] = [
|
||||
(
|
||||
"a text instance of an 8 × 6 symbol refined 6 wider: 3 right, template 0",
|
||||
"00000000300001000000130000000e000000060000000000000000420000000000010000010000001d000003fffdff02fefefe00000001000000014fdd3dba48bdddde35ffac00000002062001010000002c0000000e000000060000000000000000040012ffffffff00000001a96b4a6b78b7fc094fadde1b3e881fffac",
|
||||
&[".#.#.#....#...", "##.###....##.#", ".###...###..#.", "#.......#...#.", "#.####.#...#..", "#.##...###.#.."],
|
||||
),
|
||||
(
|
||||
"refined 2 wider and 2 taller, RDX and RDY 1: 2 right, 2 down, template 1",
|
||||
"00000000300001000000130000000a000000080000000000000000420000000000010000010000001d000003fffdff02fefefe00000001000000014fdd9c52d3ea827a43ffac0000000206200101000000280000000a00000008000000000000000004801200000001a96c00cdac6dd5f6f848ce872411cfffac",
|
||||
&["####.##...", "####..####", "####..##..", "...##...#.", "#......#..", "..#.....#.", "##....####", ".#........"],
|
||||
),
|
||||
(
|
||||
"a symbol refined in a symbol dictionary, RDX 5, RDY −1, template 0 with its AT pixels moved",
|
||||
"00000000300001000000130000000c000000060000000000000000420000000000010000010000001e000003fffdff02fefefe00000001000000014fdda13efc4029efc95fffac000000020020010100000027000203fffdff02fefefefeff010100000001000000014fc98c352dd84a906f120ffb49793fffac00000003062002010000001b0000000c00000006000000000000000004001000000001a943ffac",
|
||||
&["#.#.##.#.###", "..#.#.....##", "##..#...#...", "..##....##..", "##.#.##.####", ".#..#####..#"],
|
||||
),
|
||||
(
|
||||
"a text instance of a 40 × 5 symbol refined 2 wider, RDX 1: 2 right, across a word, template 0",
|
||||
"00000000300001000000130000002a0000000500000000000000004200000000000100000100000031000003fffdff02fefefe00000001000000015240f590d953ae3f4069dede672090d4d61b377906d3f41aafa4f77107ffac00000002062001010000003c0000002a000000050000000000000000040012ffffffff00000001a96c0b9386d4b140486bdc3673dbd031490e468c7f7813d19068ab04a79cbfffac",
|
||||
&[
|
||||
"##.#.#..##.##.#####.#....#.#.#..#..######.",
|
||||
".#.#..###....#..##.#..#.####.#..#.###...##",
|
||||
".#.#......#....#####....#...###...#####...",
|
||||
"#...##.##.......#...###.###...##..##.###.#",
|
||||
"..#..###..###..#...#.......##.#........##.",
|
||||
],
|
||||
),
|
||||
];
|
||||
let hex = |text: &str| (0..text.len() / 2).map(|i| u8::from_str_radix(&text[i * 2..i * 2 + 2], 16).unwrap()).collect::<Vec<u8>>();
|
||||
for (form, stream, picture) in cases {
|
||||
let (w, h) = (picture[0].len(), picture.len());
|
||||
// As the filter gives it: black as 0, each row padded to a byte with 0s.
|
||||
let mut rows = vec![0u8; w.div_ceil(8) * h];
|
||||
for (y, row) in picture.iter().enumerate() {
|
||||
for (x, _) in row.bytes().enumerate().filter(|(_, c)| *c == b'.') {
|
||||
rows[y * w.div_ceil(8) + x / 8] |= 0x80 >> (x % 8);
|
||||
}
|
||||
}
|
||||
assert_eq!(decode_jbig2(&hex(stream), None, w as u32, h as u32, usize::MAX).unwrap(), rows, "{form}");
|
||||
}
|
||||
}
|
||||
|
||||
/// The page has to be the image's size, and is bounded before it is decoded, being decoded
|
||||
/// whole: within `max` as rows of one bit, and within [`MAX_JBIG2_PIXELS`]. Globals are given
|
||||
/// to the decoder: ones it skips decode, ones that aren't JBIG2 are an error, as is damaged
|
||||
@@ -213,4 +402,87 @@ mod tests {
|
||||
let _ = decode_jbig2(&data[..end], None, w, h, usize::MAX);
|
||||
}
|
||||
}
|
||||
|
||||
/// Pixels past a bitmap's edge are 0 (ISO/IEC 14492 6.3.5.2). A page whose default pixel is 1,
|
||||
/// and an intermediate text or halftone region whose default pixel is 1, kept 1s past their
|
||||
/// width in their last word of each row, and a refinement, which reads its reference a word at
|
||||
/// a time, read them as pixels: of rows not a multiple of 32 wide, it decoded to other pixels
|
||||
/// than were coded. Each stream is a refinement coded by the standard's procedures from a
|
||||
/// reference read as 0 past its edge, and decodes to the picture given, `#` for black.
|
||||
/// Vendored hayro-jbig2 patch 13.
|
||||
#[test]
|
||||
fn a_refinement_reads_nothing_past_its_references_width() {
|
||||
// A page of 7 × 6, then of 33 × 6, whose default pixel is 1, refined whole.
|
||||
const PAGE_7: &str = "000000003000010000001300000007000000060000000000000000460000000000012a00010000001e000000070000000600000000000000000400ffffffffe42d7e889ebcffac";
|
||||
const PAGE_33: &str = "000000003000010000001300000021000000060000000000000000460000000000012a000100000034000000210000000600000000000000000400ffffffff314a8d598037eb3f915ab3d526ccae915ad6a6a7b814111b124ae60fffac";
|
||||
// An intermediate text region of 31 × 6 whose default pixel is 1, then one of 7 × 6 on a
|
||||
// page of 40, each refined into the page.
|
||||
const TEXT_31: &str = "00000000300001000000130000001f0000000600000000000000004200000000000100000100000030000003fffdff02fefefe00000001000000014f96dceb76c7f1ff585971969cd9f88e538261a6f713be68d77e8e1fffac00000002042001010000001b0000001f00000006000000000000000000029000000001a943ffac000000032a2002010000002f0000001f0000000600000000000000000400ffffffff9ac311688adbc8f570a2f96aef93d332e3b1f4b27b704bffac";
|
||||
const TEXT_7: &str = "000000003000010000001300000028000000060000000000000000420000000000010000010000001d000003fffdff02fefefe00000001000000014fe1f79f4a95c5b77fffac00000002042001010000001b0000000700000006000000000000000000029000000001a943ffac000000032a2002010000001e000000070000000600000000000000000400ffffffffa71dae12bd7fffac";
|
||||
// An intermediate halftone region of 33 × 6 whose default pixel is 1, refined into the page.
|
||||
const HALFTONE_33: &str = "000000003000010000001300000021000000060000000000000000420000000000011000010000000a000101000000011fffac00000002142001010000004100000021000000060000000000000000009000000021000000060000000000000000010000004ea6618f551d48ff24c2c5c98124d449f2adea6fca76e4297fffac000000032a20020100000032000000210000000600000000000000000400ffffffffe87db809393a3251e565e7a749e6470ab37f7aef186ceaf5167bffac";
|
||||
let cases: [(&str, &str, [&str; 6]); 5] = [
|
||||
("page 7", PAGE_7, ["###.#.#", ".......", "#.####.", "######.", "#.#...#", ".#...##"]),
|
||||
(
|
||||
"page 33",
|
||||
PAGE_33,
|
||||
[
|
||||
".#..##........###..####....#.##.#",
|
||||
".#.###.###.##.##..#..#...#.....##",
|
||||
".....##..#....#.##.######.###..#.",
|
||||
"##...#..##.###..###.##..#.#.#.#.#",
|
||||
".##.#........##.#.#.....###......",
|
||||
"...#.#####.#..#.###......###..###",
|
||||
],
|
||||
),
|
||||
(
|
||||
"text 31",
|
||||
TEXT_31,
|
||||
[
|
||||
"....##....###......#.##.#.#....",
|
||||
".#.....##.......##..###.#...#..",
|
||||
".#.#.#.####...#####.####...#.#.",
|
||||
"......#...#...#.##...##...#..#.",
|
||||
".#..##.###.#.###..####...#...#.",
|
||||
"#...#...#..#.#....#.##.#.....#.",
|
||||
],
|
||||
),
|
||||
(
|
||||
"text 7 on a page of 40",
|
||||
TEXT_7,
|
||||
[
|
||||
"......#.................................",
|
||||
".....##.................................",
|
||||
"##...##.................................",
|
||||
"..#.....................................",
|
||||
"##......................................",
|
||||
"..#.....................................",
|
||||
],
|
||||
),
|
||||
(
|
||||
"halftone 33",
|
||||
HALFTONE_33,
|
||||
[
|
||||
"##...#.###.#.###.....#.####..####",
|
||||
"##.##.#...#.##.##.##.#...#.#.###.",
|
||||
"###..#.#....##.###...#..##.##..##",
|
||||
"##..#...###...##..#.####.###.#...",
|
||||
"####.###.###.#..#..#.#.####...###",
|
||||
"#.#..#........#....#.#.##.##..#.#",
|
||||
],
|
||||
),
|
||||
];
|
||||
let hex = |text: &str| (0..text.len() / 2).map(|i| u8::from_str_radix(&text[i * 2..i * 2 + 2], 16).unwrap()).collect::<Vec<u8>>();
|
||||
for (form, stream, picture) in cases {
|
||||
let w = picture[0].len();
|
||||
// As the filter gives it: black as 0, each row padded to a byte with 0s.
|
||||
let mut rows = vec![0u8; w.div_ceil(8) * picture.len()];
|
||||
for (y, row) in picture.iter().enumerate() {
|
||||
for (x, _) in row.bytes().enumerate().filter(|(_, c)| *c == b'.') {
|
||||
rows[y * w.div_ceil(8) + x / 8] |= 0x80 >> (x % 8);
|
||||
}
|
||||
}
|
||||
assert_eq!(decode_jbig2(&hex(stream), None, w as u32, 6, usize::MAX).unwrap(), rows, "{form}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -11,7 +11,7 @@ use std::collections::HashMap;
|
||||
use std::hash::{DefaultHasher, Hash, Hasher};
|
||||
use std::ops::Range;
|
||||
|
||||
use super::{at_pixels, code_generic, generic_region, page_information, region_information, segment};
|
||||
use super::{at_pixels, code_generic, generic_region, page_information, region_information, segment, segment_of};
|
||||
use crate::mq::{Context, MqEncoder};
|
||||
|
||||
/// The longest side of a mark stored as a symbol. A larger one is left to the generic region.
|
||||
@@ -27,7 +27,9 @@ const MAX_SYMBOLS: usize = 1 << 16;
|
||||
const MAX_SYMBOL_PIXELS: usize = 1 << 24;
|
||||
|
||||
/// The most symbols one plan codes. The decoder PdfCraft renders JBIG2 with (`hayro-jbig2`)
|
||||
/// refuses 32,768 symbols or more, and others may too, so a plan with more isn't made.
|
||||
/// refuses a dictionary whose new and exported symbols pass 65,535 together, and a plan exports
|
||||
/// every symbol it codes, so it refuses 32,768 or more; others may too, so a plan with more isn't
|
||||
/// made.
|
||||
const MAX_CODED_SYMBOLS: usize = (1 << 15) - 1;
|
||||
|
||||
/// The most symbol instances one text region places. The decoder PdfCraft renders JBIG2 with
|
||||
@@ -35,14 +37,14 @@ const MAX_CODED_SYMBOLS: usize = (1 << 15) - 1;
|
||||
/// placed by several regions, each over a band of rows, all referring to the one dictionary.
|
||||
const MAX_REGION_INSTANCES: usize = 10_000;
|
||||
|
||||
// Segment numbers stay at most 256, so a referred-to one takes a byte (7.2.5): the page, the
|
||||
// dictionary, a text region for each MAX_REGION_INSTANCES of at most MAX_RUNS marks, and the
|
||||
// generic region.
|
||||
const _: () = assert!(MAX_RUNS.div_ceil(MAX_REGION_INSTANCES) + 3 <= 256);
|
||||
/// The most symbols a group's shared dictionary holds ([`encode_shared`]): half of what a page may
|
||||
/// place, so each page keeps room for its own.
|
||||
const MAX_SHARED_SYMBOLS: usize = MAX_CODED_SYMBOLS / 2;
|
||||
|
||||
/// The most rows symbol coded. With rows at most 2^20 samples wide, every coordinate and
|
||||
/// difference coded then fits the 32-bit integers Annex A codes.
|
||||
const MAX_ROWS: u32 = 1 << 24;
|
||||
// Segment numbers stay at most 256, so a referred-to one takes a byte (7.2.5): the shared
|
||||
// dictionary, the page, its own dictionary, a text region for each MAX_REGION_INSTANCES of at most
|
||||
// MAX_RUNS marks, and the generic region.
|
||||
const _: () = assert!(MAX_RUNS.div_ceil(MAX_REGION_INSTANCES) + 4 <= 256);
|
||||
|
||||
/// The integer coders' ranges (Table A.1): how many 1 bits pick the range, how many bits give the
|
||||
/// offset into it, and its first value. The last range has no 0 after its prefix.
|
||||
@@ -99,20 +101,111 @@ struct Instance {
|
||||
height: u32,
|
||||
}
|
||||
|
||||
/// A group of images coded by [`encode_shared`]: the globals' data, and each image's stream.
|
||||
type SharedCoding = (Vec<u8>, Vec<Option<Vec<u8>>>);
|
||||
|
||||
/// The symbols of a group's shared dictionary, as one image's [`plan`] places them: the ID each of
|
||||
/// the image's symbols has there, if it is there, and how many symbols that dictionary exports.
|
||||
struct Shared {
|
||||
ids: Vec<Option<u32>>,
|
||||
count: u32,
|
||||
}
|
||||
|
||||
/// `rows` rows of `columns` 1-bit PDF samples (black 0), symbol coded: the smaller of two plans,
|
||||
/// every mark of at most [`MAX_SYMBOL_SIDE`] a side as a symbol, or only those with a copy.
|
||||
/// `None` when neither plan has from two to [`MAX_CODED_SYMBOLS`] symbols, or the image is too
|
||||
/// large or too busy to look at.
|
||||
pub(super) fn encode(samples: &[u8], columns: u32, rows: u32) -> Option<Vec<u8>> {
|
||||
let page = page(samples, columns, rows)?;
|
||||
[1, 2].into_iter().filter_map(|copies| plan(&page, columns, rows, copies, None)).min_by_key(Vec::len)
|
||||
let page = page(samples, columns)?;
|
||||
[1, 2].into_iter().filter_map(|copies| plan(&page, columns, rows, copies, None, None)).min_by_key(Vec::len)
|
||||
}
|
||||
|
||||
/// Images, each as [`encode`] takes one, symbol coded sharing one dictionary: the globals' data, a
|
||||
/// symbol dictionary segment associated with no page (number 0) holding the distinct marks found
|
||||
/// in more than one image, and each image's stream placing them from there, the smaller of
|
||||
/// [`encode`]'s two plans for its other marks. The group's marks are held within the limits one
|
||||
/// image's are ([`MAX_SYMBOLS`], [`MAX_SYMBOL_PIXELS`]): past them, later marks aren't shared. Past
|
||||
/// [`MAX_SHARED_SYMBOLS`] shared marks, those in the most images are kept.
|
||||
///
|
||||
/// An image too large or too busy to look at, or that places none of the shared marks, gets `None`;
|
||||
/// `None` overall when fewer than two marks are shared.
|
||||
pub(super) fn encode_shared(images: &[(&[u8], u32, u32)]) -> Option<SharedCoding> {
|
||||
// The group's distinct marks, each with how many images hold it (as its uses), looked at an
|
||||
// image at a time.
|
||||
let mut table: Vec<Symbol> = Vec::new();
|
||||
let mut by_hash: HashMap<u64, Vec<u32>> = HashMap::new();
|
||||
let mut held = 0usize;
|
||||
for (samples, columns, _) in images {
|
||||
let Some(page) = page(samples, *columns) else { continue };
|
||||
// An image's symbols are distinct, so each counts an image once.
|
||||
for symbol in page.symbols {
|
||||
match find(&table, &by_hash, &symbol) {
|
||||
Some(t) => {
|
||||
if let Some(s) = table.get_mut(t as usize) {
|
||||
s.uses = s.uses.saturating_add(1);
|
||||
}
|
||||
}
|
||||
None => {
|
||||
let Some(more) = held.checked_add(symbol.pixels.len()).filter(|h| *h <= MAX_SYMBOL_PIXELS && table.len() < MAX_SYMBOLS) else {
|
||||
continue;
|
||||
};
|
||||
held = more;
|
||||
let t = u32::try_from(table.len()).ok()?;
|
||||
by_hash.entry(fingerprint(&symbol)).or_default().push(t);
|
||||
table.push(Symbol { uses: 1, ..symbol });
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
let uses = |t: &u32| table.get(*t as usize).map_or(0, |s| s.uses);
|
||||
let mut shared: Vec<u32> = (0..u32::try_from(table.len()).ok()?).filter(|t| uses(t) >= 2).collect();
|
||||
if shared.len() < 2 {
|
||||
return None;
|
||||
}
|
||||
shared.sort_by_key(|t| std::cmp::Reverse(uses(t)));
|
||||
shared.truncate(MAX_SHARED_SYMBOLS);
|
||||
// The dictionary's order, as `plan` keeps it.
|
||||
shared.sort_by_key(|t| table.get(*t as usize).map(|s| (s.height, s.width)));
|
||||
let mut global = vec![None; table.len()];
|
||||
for (k, t) in shared.iter().enumerate() {
|
||||
if let Some(slot) = global.get_mut(*t as usize) {
|
||||
*slot = u32::try_from(k).ok();
|
||||
}
|
||||
}
|
||||
let symbols: Vec<&Symbol> = shared.iter().filter_map(|t| table.get(*t as usize)).collect();
|
||||
let mut globals = Vec::new();
|
||||
segment_of(&mut globals, 0, 0, 0, &[], true, &symbol_dictionary(&symbols)?);
|
||||
let count = u32::try_from(symbols.len()).ok()?;
|
||||
let streams = images
|
||||
.iter()
|
||||
.map(|(samples, columns, rows)| {
|
||||
let page = page(samples, *columns)?;
|
||||
let ids = page.symbols.iter().map(|s| find(&table, &by_hash, s).and_then(|t| global.get(t as usize).copied().flatten())).collect();
|
||||
let shared = Shared { ids, count };
|
||||
[1, 2].into_iter().filter_map(|copies| plan(&page, *columns, *rows, copies, None, Some(&shared))).min_by_key(Vec::len)
|
||||
})
|
||||
.collect();
|
||||
Some((globals, streams))
|
||||
}
|
||||
|
||||
/// What sorts a symbol's bitmap ([`symbols`] and [`encode_shared`] look exact copies up by it).
|
||||
fn fingerprint(s: &Symbol) -> u64 {
|
||||
let mut hasher = DefaultHasher::new();
|
||||
(s.width, s.height, &s.pixels).hash(&mut hasher);
|
||||
hasher.finish()
|
||||
}
|
||||
|
||||
/// The index in `table` of the symbol with `s`'s bitmap, looked up by its [`fingerprint`].
|
||||
fn find(table: &[Symbol], by_hash: &HashMap<u64, Vec<u32>>, s: &Symbol) -> Option<u32> {
|
||||
by_hash
|
||||
.get(&fingerprint(s))?
|
||||
.iter()
|
||||
.copied()
|
||||
.find(|t| table.get(*t as usize).is_some_and(|t| (t.width, t.height) == (s.width, s.height) && t.pixels == s.pixels))
|
||||
}
|
||||
|
||||
/// The image's marks and symbols; `None` past the limits above.
|
||||
fn page(samples: &[u8], columns: u32, rows: u32) -> Option<Page> {
|
||||
if rows > MAX_ROWS {
|
||||
return None;
|
||||
}
|
||||
fn page(samples: &[u8], columns: u32) -> Option<Page> {
|
||||
let width = usize::try_from(columns).ok()?;
|
||||
let stride = width.div_ceil(8);
|
||||
if stride == 0 {
|
||||
@@ -272,23 +365,18 @@ fn symbols(page: &mut Page) -> Option<()> {
|
||||
page.large.push(m);
|
||||
continue;
|
||||
}
|
||||
let pixels = pixels(mark, &page.runs, &page.order);
|
||||
let mut hasher = DefaultHasher::new();
|
||||
(width, height, &pixels).hash(&mut hasher);
|
||||
let same = by_hash.entry(hasher.finish()).or_default();
|
||||
let symbol = Symbol { width, height, pixels: pixels(mark, &page.runs, &page.order), uses: 0 };
|
||||
let symbols = &mut page.symbols;
|
||||
let known =
|
||||
same.iter().copied().find(|s| symbols.get(*s as usize).is_some_and(|s| (s.width, s.height) == (width, height) && s.pixels == pixels));
|
||||
let id = match known {
|
||||
let id = match find(symbols, &by_hash, &symbol) {
|
||||
Some(id) => id,
|
||||
None => {
|
||||
kept = kept.checked_add(pixels.len())?;
|
||||
kept = kept.checked_add(symbol.pixels.len())?;
|
||||
if kept > MAX_SYMBOL_PIXELS || symbols.len() == MAX_SYMBOLS {
|
||||
return None;
|
||||
}
|
||||
let id = u32::try_from(symbols.len()).ok()?;
|
||||
symbols.push(Symbol { width, height, pixels, uses: 0 });
|
||||
same.push(id);
|
||||
by_hash.entry(fingerprint(&symbol)).or_default().push(id);
|
||||
symbols.push(symbol);
|
||||
id
|
||||
}
|
||||
};
|
||||
@@ -305,18 +393,28 @@ fn symbols(page: &mut Page) -> Option<()> {
|
||||
/// the other marks in a generic region. `None` with fewer than two such symbols (their IDs would
|
||||
/// take no bits at all, SBSYMCODELEN 0, a corner of the standard left alone here) or more than
|
||||
/// [`MAX_CODED_SYMBOLS`].
|
||||
fn plan(page: &Page, columns: u32, rows: u32, copies: u32, log_strips: Option<u32>) -> Option<Vec<u8>> {
|
||||
///
|
||||
/// With `shared`, the symbols a group's dictionary holds are placed from there, whatever their uses
|
||||
/// here, and the page's own dictionary holds only the others (none, when it has none), as
|
||||
/// [`encode_shared`] writes them; `None` too for a page that places none of the shared ones.
|
||||
fn plan(page: &Page, columns: u32, rows: u32, copies: u32, log_strips: Option<u32>, shared: Option<&Shared>) -> Option<Vec<u8>> {
|
||||
let symbol = |s: u32| page.symbols.get(s as usize);
|
||||
let global = |s: u32| shared.and_then(|g| g.ids.get(s as usize).copied().flatten());
|
||||
let globals = shared.map_or(0, |g| g.count);
|
||||
// The dictionary's order (6.5.5): height classes from the shortest, each narrowest first.
|
||||
let mut kept: Vec<u32> = (0..page.symbols.len() as u32).filter(|s| symbol(*s).is_some_and(|s| s.uses >= copies)).collect();
|
||||
if kept.len() < 2 || kept.len() > MAX_CODED_SYMBOLS {
|
||||
let mut kept: Vec<u32> =
|
||||
(0..page.symbols.len() as u32).filter(|s| global(*s).is_none() && symbol(*s).is_some_and(|s| s.uses >= copies)).collect();
|
||||
let count = usize::try_from(globals).ok()?.checked_add(kept.len())?;
|
||||
if !(2..=MAX_CODED_SYMBOLS).contains(&count) {
|
||||
return None;
|
||||
}
|
||||
kept.sort_by_key(|s| symbol(*s).map(|s| (s.height, s.width)));
|
||||
let mut id = vec![None; page.symbols.len()];
|
||||
// The shared symbols' IDs come first, as their dictionary is referred to first (Table 31's
|
||||
// SBSYMS).
|
||||
let mut id: Vec<Option<u32>> = (0..page.symbols.len() as u32).map(global).collect();
|
||||
for (k, s) in kept.iter().enumerate() {
|
||||
if let Some(slot) = id.get_mut(*s as usize) {
|
||||
*slot = u32::try_from(k).ok();
|
||||
*slot = u32::try_from(k).ok().and_then(|k| k.checked_add(globals));
|
||||
}
|
||||
}
|
||||
let mut instances = Vec::new();
|
||||
@@ -329,9 +427,12 @@ fn plan(page: &Page, columns: u32, rows: u32, copies: u32, log_strips: Option<u3
|
||||
_ => left.push(*m),
|
||||
}
|
||||
}
|
||||
if shared.is_some() && !instances.iter().any(|i| i.id < globals) {
|
||||
return None;
|
||||
}
|
||||
let kept: Vec<&Symbol> = kept.iter().filter_map(|s| symbol(*s)).collect();
|
||||
let dictionary = symbol_dictionary(&kept)?;
|
||||
let count = u32::try_from(kept.len()).ok()?;
|
||||
let dictionary = if kept.is_empty() { None } else { Some(symbol_dictionary(&kept)?) };
|
||||
let count = u32::try_from(count).ok()?;
|
||||
// Bands of at most MAX_REGION_INSTANCES, from the top.
|
||||
instances.sort_by_key(|i| (i.t, i.s));
|
||||
let mut regions = Vec::new();
|
||||
@@ -344,12 +445,21 @@ fn plan(page: &Page, columns: u32, rows: u32, copies: u32, log_strips: Option<u3
|
||||
});
|
||||
}
|
||||
let mut out = Vec::new();
|
||||
segment(&mut out, 0, 48, &[], false, &page_information(columns, rows));
|
||||
segment(&mut out, 1, 0, &[], true, &dictionary);
|
||||
let mut number = 2;
|
||||
// The shared dictionary is segment 0, in the globals, and a segment refers only to lower
|
||||
// numbers (7.2.5): the page's own follow it.
|
||||
let mut number = u32::from(shared.is_some());
|
||||
segment(&mut out, number, 48, &[], false, &page_information(columns, rows));
|
||||
number += 1;
|
||||
let mut dictionaries: Vec<u8> = shared.map(|_| 0).into_iter().collect();
|
||||
if let Some(dictionary) = &dictionary {
|
||||
segment(&mut out, number, 0, &[], true, dictionary);
|
||||
dictionaries.push(u8::try_from(number).ok()?);
|
||||
number += 1;
|
||||
}
|
||||
for (k, text) in regions.iter().enumerate() {
|
||||
// The dictionary stays retained for the next region, until the last (7.2.4).
|
||||
segment(&mut out, number, 7, &[(1, k + 1 < regions.len())], false, text);
|
||||
// The dictionaries stay retained for the next region, until the last (7.2.4).
|
||||
let refers_to: Vec<(u8, bool)> = dictionaries.iter().map(|n| (*n, k + 1 < regions.len())).collect();
|
||||
segment(&mut out, number, 7, &refers_to, false, text);
|
||||
number += 1;
|
||||
}
|
||||
if !left.is_empty() {
|
||||
@@ -543,8 +653,9 @@ fn encode_id(mq: &mut MqEncoder, contexts: &mut [Context], length: u32, id: u32)
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::jbig2::tests::{decode, samples, unpack};
|
||||
use crate::jbig2::{encode_jbig2, encode_jbig2_generic};
|
||||
use crate::FilterError;
|
||||
use crate::jbig2::tests::{decode, decode_with, samples, unpack};
|
||||
use crate::jbig2::{encode_jbig2, encode_jbig2_generic, encode_jbig2_shared};
|
||||
|
||||
type Bitmap = Vec<Vec<u8>>;
|
||||
|
||||
@@ -665,11 +776,11 @@ mod tests {
|
||||
fn every_plan_round_trips(picture: &Bitmap) -> usize {
|
||||
let (columns, rows) = (picture[0].len() as u32, picture.len() as u32);
|
||||
let data = samples(picture);
|
||||
let page = page(&data, columns, rows).unwrap();
|
||||
let page = page(&data, columns).unwrap();
|
||||
let mut plans = 0;
|
||||
for copies in [1, 2] {
|
||||
for log_strips in 0..4 {
|
||||
if let Some(coded) = plan(&page, columns, rows, copies, Some(log_strips)) {
|
||||
if let Some(coded) = plan(&page, columns, rows, copies, Some(log_strips), None) {
|
||||
assert_eq!(decode(&coded), unpack(&data, columns, rows), "{copies} copies, strips of {}", 1 << log_strips);
|
||||
plans += 1;
|
||||
}
|
||||
@@ -735,10 +846,10 @@ mod tests {
|
||||
row[stride - 1] &= 0xFF << (8 * stride - columns);
|
||||
}
|
||||
let (c, r) = (columns as u32, 120);
|
||||
let page = page(&data, c, r).unwrap();
|
||||
let page = page(&data, c).unwrap();
|
||||
assert!(page.marks.iter().all(|m| m.x1 as usize <= columns), "{columns} columns");
|
||||
for copies in [1, 2] {
|
||||
if let Some(coded) = plan(&page, c, r, copies, None) {
|
||||
if let Some(coded) = plan(&page, c, r, copies, None, None) {
|
||||
assert_eq!(decode(&coded), unpack(&data, c, r), "{columns} columns");
|
||||
}
|
||||
}
|
||||
@@ -771,7 +882,7 @@ mod tests {
|
||||
row[290] = 1;
|
||||
}
|
||||
let data = samples(&picture);
|
||||
let page = page(&data, 300, 300).unwrap();
|
||||
let page = page(&data, 300).unwrap();
|
||||
let boxes: Vec<(u32, u32, u32, u32)> = page.marks.iter().map(|m| (m.x0, m.y0, m.x1 - m.x0, m.y1 - m.y0)).collect();
|
||||
assert_eq!(
|
||||
boxes,
|
||||
@@ -792,18 +903,14 @@ mod tests {
|
||||
assert_eq!(every_plan_round_trips(&picture), 8);
|
||||
}
|
||||
|
||||
/// Past 2^20 black runs or 2^24 rows the image is left to generic coding; at either cap it is
|
||||
/// still looked at.
|
||||
/// Past 2^20 black runs the image is left to generic coding; at the cap it is still looked at.
|
||||
#[test]
|
||||
fn busy_or_tall_images_are_left_to_generic_coding() {
|
||||
fn busy_images_are_left_to_generic_coding() {
|
||||
// 0x55: four black pixels a byte, each its own run, under the same ones on the next row.
|
||||
let columns = 1 << 20;
|
||||
let row = vec![0x55u8; columns / 8];
|
||||
assert!(page(&row.repeat(2), columns as u32, 2).is_some(), "2^20 runs");
|
||||
assert!(page(&row.repeat(3), columns as u32, 3).is_none(), "1.5 × 2^20 runs");
|
||||
let tall = vec![0xFFu8; MAX_ROWS as usize + 1];
|
||||
assert!(page(&tall, 1, MAX_ROWS + 1).is_none());
|
||||
assert!(page(&tall, 1, MAX_ROWS).is_some());
|
||||
assert!(page(&row.repeat(2), columns as u32).is_some(), "2^20 runs");
|
||||
assert!(page(&row.repeat(3), columns as u32).is_none(), "1.5 × 2^20 runs");
|
||||
}
|
||||
|
||||
/// A plan codes at most 32,767 symbols, which an independent decoder reads back; with more,
|
||||
@@ -828,18 +935,18 @@ mod tests {
|
||||
(samples(&picture), columns as u32, rows as u32)
|
||||
};
|
||||
let (data, columns, rows) = codes(MAX_CODED_SYMBOLS, 0);
|
||||
let at_cap = page(&data, columns, rows).unwrap();
|
||||
assert_eq!(decode(&plan(&at_cap, columns, rows, 1, None).unwrap()), unpack(&data, columns, rows));
|
||||
let at_cap = page(&data, columns).unwrap();
|
||||
assert_eq!(decode(&plan(&at_cap, columns, rows, 1, None, None).unwrap()), unpack(&data, columns, rows));
|
||||
// One more distinct mark, each once: neither plan is made.
|
||||
let (data, columns, rows) = codes(MAX_CODED_SYMBOLS + 1, 0);
|
||||
let past = page(&data, columns, rows).unwrap();
|
||||
assert!(plan(&past, columns, rows, 1, None).is_none() && plan(&past, columns, rows, 2, None).is_none());
|
||||
let past = page(&data, columns).unwrap();
|
||||
assert!(plan(&past, columns, rows, 1, None, None).is_none() && plan(&past, columns, rows, 2, None, None).is_none());
|
||||
assert_eq!(encode_jbig2(&data, columns, rows).unwrap(), encode_jbig2_generic(&data, columns, rows).unwrap());
|
||||
// With two of them repeated, the second plan codes those two.
|
||||
let (data, columns, rows) = codes(MAX_CODED_SYMBOLS + 1, 200);
|
||||
let past = page(&data, columns, rows).unwrap();
|
||||
assert!(plan(&past, columns, rows, 1, None).is_none());
|
||||
assert_eq!(decode(&plan(&past, columns, rows, 2, None).unwrap()), unpack(&data, columns, rows));
|
||||
let past = page(&data, columns).unwrap();
|
||||
assert!(plan(&past, columns, rows, 1, None, None).is_none());
|
||||
assert_eq!(decode(&plan(&past, columns, rows, 2, None, None).unwrap()), unpack(&data, columns, rows));
|
||||
// Above a page of text whose letters repeat, that second plan is the one `encode_jbig2`
|
||||
// keeps: the first, of every mark, would code too many symbols.
|
||||
let mut picture: Bitmap = vec![vec![0u8; 256 * 18]; 512];
|
||||
@@ -857,10 +964,10 @@ mod tests {
|
||||
let coded = encode_jbig2(&data, columns, rows).unwrap();
|
||||
assert_eq!(segment_types(&coded)[1], 0, "symbol coded");
|
||||
assert_eq!(decode(&coded), unpack(&data, columns, rows));
|
||||
let (data, columns, rows) = codes(MAX_SYMBOLS, 0);
|
||||
assert_eq!(page(&data, columns, rows).map(|p| p.symbols.len()), Some(MAX_SYMBOLS));
|
||||
let (data, columns, rows) = codes(MAX_SYMBOLS + 1, 0);
|
||||
assert!(page(&data, columns, rows).is_none());
|
||||
let (data, columns, _) = codes(MAX_SYMBOLS, 0);
|
||||
assert_eq!(page(&data, columns).map(|p| p.symbols.len()), Some(MAX_SYMBOLS));
|
||||
let (data, columns, _) = codes(MAX_SYMBOLS + 1, 0);
|
||||
assert!(page(&data, columns).is_none());
|
||||
// `n` black squares of 256 × 256, each with a white pixel in a different place: 2^16
|
||||
// pixels a symbol, so 256 of them are exactly the cap.
|
||||
let squares = |n: usize| {
|
||||
@@ -876,11 +983,11 @@ mod tests {
|
||||
(samples(&picture), columns as u32, rows as u32)
|
||||
};
|
||||
let (data, columns, rows) = squares(256);
|
||||
let at_cap = page(&data, columns, rows).unwrap();
|
||||
let at_cap = page(&data, columns).unwrap();
|
||||
assert_eq!(at_cap.symbols.len(), 256);
|
||||
assert_eq!(decode(&plan(&at_cap, columns, rows, 1, None).unwrap()), unpack(&data, columns, rows));
|
||||
let (data, columns, rows) = squares(257);
|
||||
assert!(page(&data, columns, rows).is_none());
|
||||
assert_eq!(decode(&plan(&at_cap, columns, rows, 1, None, None).unwrap()), unpack(&data, columns, rows));
|
||||
let (data, columns, _) = squares(257);
|
||||
assert!(page(&data, columns).is_none());
|
||||
}
|
||||
|
||||
/// More than 10,000 marks are placed by several text regions, each of at most 10,000 (more
|
||||
@@ -993,7 +1100,199 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
/// Each segment's page association (7.2.6): the byte after the numbers it refers to.
|
||||
fn associations(data: &[u8]) -> Vec<u8> {
|
||||
let (mut pages, mut at) = (Vec::new(), 0);
|
||||
while at < data.len() {
|
||||
let refers = usize::from(data[at + 5] >> 5);
|
||||
pages.push(data[at + 6 + refers]);
|
||||
let length_at = at + 6 + refers + 1;
|
||||
at = length_at + 4 + u32::from_be_bytes(data[length_at..length_at + 4].try_into().unwrap()) as usize;
|
||||
}
|
||||
pages
|
||||
}
|
||||
|
||||
/// `pictures`, `columns` × `rows` each, coded sharing a dictionary; each image's stream, which
|
||||
/// has to be there, decodes with the globals to its picture.
|
||||
fn shared_round_trip(pictures: &[Bitmap]) -> (Vec<u8>, Vec<Vec<u8>>) {
|
||||
let (columns, rows) = (pictures[0][0].len() as u32, pictures[0].len() as u32);
|
||||
let data: Vec<Vec<u8>> = pictures.iter().map(|p| samples(p)).collect();
|
||||
let images: Vec<(&[u8], u32, u32)> = data.iter().map(|d| (&d[..], columns, rows)).collect();
|
||||
let shared = encode_jbig2_shared(&images).unwrap().unwrap();
|
||||
let (globals, coded) = (shared.globals, shared.images);
|
||||
let coded: Vec<Vec<u8>> = coded.into_iter().map(Option::unwrap).collect();
|
||||
for (d, c) in data.iter().zip(&coded) {
|
||||
assert_eq!(decode_with(c, Some(&globals)), unpack(d, columns, rows));
|
||||
}
|
||||
(globals, coded)
|
||||
}
|
||||
|
||||
/// `font` with a stem 20 pixels tall down each glyph's left side: a font sharing no glyph with
|
||||
/// any [`glyphs`] gives, whose glyphs are at most 18 pixels tall.
|
||||
fn stemmed(font: &[Bitmap]) -> Vec<Bitmap> {
|
||||
font.iter()
|
||||
.map(|g| {
|
||||
(0..g.len().max(20)).map(|y| std::iter::once(1).chain(g.get(y).cloned().unwrap_or_else(|| vec![0; g[0].len()])).collect()).collect()
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Mark `k` of a set of distinct ones: a stroke 33 pixels long with a pixel above every other
|
||||
/// column for each 1 bit of `k`, below 2^17.
|
||||
fn comb(k: usize) -> Bitmap {
|
||||
let mut g = vec![vec![0u8; 33]; 2];
|
||||
g[1].fill(1);
|
||||
for bit in 0..17 {
|
||||
g[0][2 * bit] = u8::from(k >> bit & 1 == 1);
|
||||
}
|
||||
g
|
||||
}
|
||||
|
||||
/// The combs `ks`, 120 a row, the rows four pixels apart.
|
||||
fn combs(ks: impl ExactSizeIterator<Item = usize>) -> Bitmap {
|
||||
let mut page = vec![vec![0u8; 120 * 36]; ks.len().div_ceil(120) * 4];
|
||||
for (i, k) in ks.enumerate() {
|
||||
draw(&mut page, &comb(k), (i % 120 * 36) as i64, (i / 120 * 4) as i64);
|
||||
}
|
||||
page
|
||||
}
|
||||
|
||||
/// The symbols a symbol dictionary segment exports (SDNUMEXSYMS, 7.4.2.1.4), in a stream
|
||||
/// that is that segment alone: after its header, flags and adaptive pixels.
|
||||
fn exported(globals: &[u8]) -> usize {
|
||||
u32::from_be_bytes(globals[21..25].try_into().unwrap()) as usize
|
||||
}
|
||||
|
||||
/// Pages in one font share its letters: one symbol dictionary, segment 0, associated with no
|
||||
/// page and retained (7.2.4, 7.2.6), which each page's text region refers to first, its own
|
||||
/// segments numbered after it (7.2.5). Together they take less than they take alone.
|
||||
#[test]
|
||||
fn pages_in_one_font_share_one_dictionary() {
|
||||
let font = glyphs(40, 7);
|
||||
let pictures: Vec<Bitmap> = (0..4).map(|seed| text(1200, 300, &font, 20 + seed)).collect();
|
||||
let (globals, coded) = shared_round_trip(&pictures);
|
||||
assert_eq!(segments(&globals), [(0, 0, true, vec![])]);
|
||||
assert_eq!(associations(&globals), [0]);
|
||||
let (mut shared, mut alone) = (globals.len(), 0);
|
||||
for (picture, c) in pictures.iter().zip(&coded) {
|
||||
let segments = segments(c);
|
||||
assert_eq!(segments.first().map(|s| s.0), Some(1), "the page's own segments follow");
|
||||
assert!(segments.iter().filter(|s| s.1 == 7).all(|s| s.3.first() == Some(&(0, false))), "{segments:?}");
|
||||
assert!(associations(c).iter().all(|page| *page == 1));
|
||||
shared += c.len();
|
||||
alone += encode_jbig2(&samples(picture), 1200, 300).unwrap().len();
|
||||
}
|
||||
assert!(shared < alone, "shared {shared} bytes, alone {alone}");
|
||||
}
|
||||
|
||||
/// Two pages alike place every mark from the shared dictionary and have none of their own; a
|
||||
/// page with letters of its own as well keeps them in its own dictionary, referred to after the
|
||||
/// shared one (its symbols' IDs follow), and the page with nothing shared has no stream.
|
||||
#[test]
|
||||
fn what_a_page_has_alone_stays_its_own() {
|
||||
let (font, other) = (glyphs(30, 7), stemmed(&glyphs(20, 99)));
|
||||
let same = text(900, 240, &font, 3);
|
||||
let mut more = text(900, 240, &font, 4);
|
||||
more.extend(text(900, 120, &other, 5));
|
||||
let (globals, coded) = shared_round_trip(&[same.clone(), same.clone()]);
|
||||
assert!(!globals.is_empty());
|
||||
assert!(coded.iter().all(|c| segment_types(c) == [48, 7]), "{:?}", coded.iter().map(|c| segment_types(c)).collect::<Vec<_>>());
|
||||
let with_more = |p: &Bitmap| p.iter().cloned().chain(std::iter::repeat_n(vec![0u8; 900], 120)).collect::<Bitmap>();
|
||||
let (_, coded) = shared_round_trip(&[with_more(&same), more]);
|
||||
assert_eq!(segment_types(&coded[1])[..3], [48, 0, 7]);
|
||||
assert_eq!(segments(&coded[1])[2].3, [(0, false), (2, false)]);
|
||||
let alone = text(900, 360, &other, 6);
|
||||
let data: Vec<Vec<u8>> = [&same, &same, &alone].iter().map(|p| samples(p)).collect();
|
||||
let images: Vec<(&[u8], u32, u32)> = vec![(&data[0], 900, 240), (&data[1], 900, 240), (&data[2], 900, 360)];
|
||||
let (_, coded) = encode_shared(&images).unwrap();
|
||||
assert!(coded[0].is_some() && coded[1].is_some() && coded[2].is_none());
|
||||
}
|
||||
|
||||
/// Images that share fewer than two marks share nothing; two are enough.
|
||||
#[test]
|
||||
fn images_with_nothing_in_common_share_nothing() {
|
||||
let font = glyphs(30, 7);
|
||||
let (a, b) = (samples(&text(600, 200, &font, 1)), samples(&text(600, 200, &stemmed(&font), 1)));
|
||||
assert!(encode_shared(&[(&a, 600, 200), (&b, 600, 200)]).is_none());
|
||||
assert!(encode_shared(&[(&a, 600, 200)]).is_none(), "one image");
|
||||
assert!(encode_shared(&[]).is_none());
|
||||
// The two commonest letters of the first page, below the last line of the second.
|
||||
let mut two = text(600, 200, &stemmed(&font), 1);
|
||||
draw(&mut two, &font[0], 10, 180);
|
||||
draw(&mut two, &font[1], 100, 180);
|
||||
let two = samples(&two);
|
||||
let (globals, coded) = encode_shared(&[(&a, 600, 200), (&two, 600, 200)]).unwrap();
|
||||
assert_eq!(exported(&globals), 2);
|
||||
assert_eq!(decode_with(coded[1].as_ref().unwrap(), Some(&globals)), unpack(&two, 600, 200));
|
||||
}
|
||||
|
||||
/// The images of a group are checked as `encode_jbig2_generic` checks one, and an image it
|
||||
/// would refuse refuses the group.
|
||||
#[test]
|
||||
fn a_group_with_an_image_the_encoder_refuses_is_refused() {
|
||||
let page = samples(&text(600, 200, &glyphs(30, 7), 1));
|
||||
assert!(matches!(encode_jbig2_shared(&[(&page, 600, 200), (&page[..10], 600, 200)]), Err(FilterError::Corrupt { .. })));
|
||||
assert!(matches!(encode_jbig2_shared(&[(&page, 600, 200), (&page, 0, 200)]), Err(FilterError::Unsupported(_))));
|
||||
assert!(encode_jbig2_shared(&[(&page, 600, 200), (&page, 600, 200)]).unwrap().is_some());
|
||||
}
|
||||
|
||||
/// A group holds its distinct marks within what one image's are held to: past 65,536 a mark
|
||||
/// first seen later isn't held, so isn't shared, while those held count every image they're
|
||||
/// in. Ten marks of the first image are in two images after it, with 464 first seen there.
|
||||
#[test]
|
||||
fn past_the_marks_a_group_holds_later_ones_arent_shared() {
|
||||
let (a, b) = (samples(&combs(0..40_000)), samples(&combs(40_000..65_536)));
|
||||
let late = combs((0..10).chain(65_536..66_000).collect::<Vec<_>>().into_iter());
|
||||
let (rows, late) = (late.len() as u32, samples(&late));
|
||||
let (columns, a_rows, b_rows) = (120 * 36, 40_000u32.div_ceil(120) * 4, 25_536u32.div_ceil(120) * 4);
|
||||
let images = [(&a[..], columns, a_rows), (&b[..], columns, b_rows), (&late[..], columns, rows), (&late[..], columns, rows)];
|
||||
let (globals, coded) = encode_shared(&images).unwrap();
|
||||
assert_eq!(exported(&globals), 10);
|
||||
for c in &coded[2..] {
|
||||
assert_eq!(decode_with(c.as_ref().unwrap(), Some(&globals)), unpack(&late, columns, rows));
|
||||
}
|
||||
}
|
||||
|
||||
/// Past what one dictionary shares, it keeps the marks the most images hold: 20,000 shared,
|
||||
/// the first 10,000 in all three images and the rest in two. The third image then places all
|
||||
/// its marks from it, and the other two code the rest themselves (in a dictionary of their own
|
||||
/// or a generic region, whichever is smaller).
|
||||
#[test]
|
||||
fn past_the_shared_limit_the_most_widely_held_marks_are_shared() {
|
||||
let (both, first) = (combs(0..20_000), combs(0..10_000));
|
||||
let rows = both.len();
|
||||
let first: Bitmap = first.iter().cloned().chain(std::iter::repeat_n(vec![0u8; 120 * 36], rows - first.len())).collect();
|
||||
let (globals, coded) = shared_round_trip(&[both.clone(), both, first]);
|
||||
assert_eq!(exported(&globals), MAX_SHARED_SYMBOLS);
|
||||
assert_eq!(segment_types(&coded[2]), [48, 7]);
|
||||
assert!(segment_types(&coded[0]).iter().any(|t| *t == 0 || *t == 39), "{:?}", segment_types(&coded[0]));
|
||||
}
|
||||
|
||||
proptest::proptest! {
|
||||
/// Glyphs scattered over pages of one font: whatever is shared, every page with a stream
|
||||
/// decodes with the globals to its picture.
|
||||
#[test]
|
||||
fn shared_groups_round_trip(
|
||||
columns in 1usize..200,
|
||||
rows in 1usize..100,
|
||||
shapes in 2usize..8,
|
||||
n in 0usize..60,
|
||||
pages in 2usize..5,
|
||||
seed in proptest::num::u64::ANY,
|
||||
) {
|
||||
let font = glyphs(shapes, seed);
|
||||
let data: Vec<Vec<u8>> = (0..pages).map(|p| samples(&scatter(columns, rows, &font, seed ^ p as u64, n))).collect();
|
||||
let (c, r) = (columns as u32, rows as u32);
|
||||
let images: Vec<(&[u8], u32, u32)> = data.iter().map(|d| (&d[..], c, r)).collect();
|
||||
if let Some((globals, coded)) = encode_shared(&images) {
|
||||
for (d, coded) in data.iter().zip(coded) {
|
||||
if let Some(coded) = coded {
|
||||
proptest::prop_assert_eq!(decode_with(&coded, Some(&globals)), unpack(d, c, r));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Glyphs anywhere, over the edges and each other, with stray pixels: every plan decodes to
|
||||
/// the picture, and `encode_jbig2` is never larger than the generic coding.
|
||||
#[test]
|
||||
@@ -1024,6 +1323,7 @@ mod tests {
|
||||
fn any_input_returns(data in proptest::collection::vec(0u8..=255, 0..600), columns in 0u32..5000, rows in 0u32..80) {
|
||||
let _ = encode_jbig2(&data, columns, rows);
|
||||
let _ = encode(&data, columns, rows);
|
||||
let _ = encode_shared(&[(&data, columns, rows), (&data, columns, rows.saturating_sub(1))]);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -27,7 +27,8 @@
|
||||
//! ```
|
||||
//!
|
||||
//! 1-bit samples can be encoded as CCITT Group 4 ([`encode_g4`]) or lossless JBIG2
|
||||
//! ([`encode_jbig2`]).
|
||||
//! ([`encode_jbig2`]), a group of images sharing their marks through `/JBIG2Globals`
|
||||
//! ([`encode_jbig2_shared`]).
|
||||
//!
|
||||
//! Every decoder is bounded by a caller-supplied `max_output` (decompression-bomb
|
||||
//! defence) and never panics on malformed input.
|
||||
@@ -47,7 +48,7 @@ mod runlength;
|
||||
use std::borrow::Cow;
|
||||
|
||||
pub use ccitt::{CcittParams, MAX_CCITT_COLUMNS, MAX_G4_COLUMNS, decode_ccitt_within, encode_g4};
|
||||
pub use jbig2::{MAX_JBIG2_COLUMNS, MAX_JBIG2_PIXELS, decode_jbig2_within, encode_jbig2, encode_jbig2_generic};
|
||||
pub use jbig2::{MAX_JBIG2_COLUMNS, MAX_JBIG2_PIXELS, SharedJbig2, decode_jbig2_within, encode_jbig2, encode_jbig2_generic, encode_jbig2_shared};
|
||||
|
||||
/// A PDF stream filter, identified by its `/Filter` name.
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
|
||||
|
||||
@@ -50,7 +50,10 @@ let cells: Vec<table::Cell> = grid.cells_for(names)?; // "Table1_1", "Table
|
||||
keeps it: `/V` is stored as typed, the appearance draws `?` for those characters, the widget is
|
||||
marked with the first one (`pdfcraft_fonts::UNDRAWN_MARK`, cleared once all of it can be drawn)
|
||||
and the form sets `/NeedAppearances`, so other viewers draw the field from its value with fonts
|
||||
that have them. Not in a document that declares PDF/A, which forbids that flag (`declares_pdfa`).
|
||||
that have them. Not in a document that declares PDF/A, which forbids that flag (`declares_pdfa`:
|
||||
the bytes `pdfaid:part` in XMP metadata each filter stage of which decodes within 8 MiB, the cap
|
||||
preflight's Standards panel reads it with; preflight reads the identifier by its namespace, so a
|
||||
packet that gives that namespace another prefix declares PDF/A there and not here).
|
||||
`undrawn_fields` lists the marked fields; the engine reports each edit that draws one, and
|
||||
flattening refuses to make that `?` permanent.
|
||||
- Displaying a form that leaves its appearances to the viewer (`/NeedAppearances`, or a text or
|
||||
|
||||
@@ -212,13 +212,24 @@ impl FieldAppearanceCache {
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether the document's XMP metadata declares PDF/A conformance (`pdfaid:part`).
|
||||
/// The most each filter stage of the XMP metadata stream may decode for its PDF/A declaration to
|
||||
/// be read, the cap preflight's Standards panel reads it with: past it, metadata declares nothing
|
||||
/// there either.
|
||||
pub(crate) const MAX_XMP_BYTES: usize = 8 << 20;
|
||||
|
||||
/// Whether the document's XMP metadata declares PDF/A conformance (the bytes `pdfaid:part`).
|
||||
/// Metadata a filter stage of which decodes past [`MAX_XMP_BYTES`] doesn't.
|
||||
pub fn declares_pdfa(doc: &Document) -> bool {
|
||||
let Some(root) = doc.root() else { return false };
|
||||
let Some(m) = doc.get(root).as_dict().and_then(|c| c.get(b"Metadata").cloned()) else { return false };
|
||||
let m = doc.resolve(&m);
|
||||
match &*m {
|
||||
Object::Stream(s) => s.decoded().is_ok_and(|b| b.windows(11).any(|w| w == b"pdfaid:part")),
|
||||
// Not a `DecodeBudget`, which counts every stage against one allowance: preflight bounds
|
||||
// each stage, and the two must agree on metadata stored through a chain of filters.
|
||||
// `/DecodeParms` is read only when direct, as preflight and organize read metadata too:
|
||||
// PDF/A asks for it unfiltered, so only a file that breaks that reaches parameters here,
|
||||
// and the readers go to `with_direct_parms` together or they disagree.
|
||||
Object::Stream(s) => s.decoded_within(MAX_XMP_BYTES).is_ok_and(|b| b.windows(11).any(|w| w == b"pdfaid:part")),
|
||||
_ => false,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -583,10 +583,15 @@ fn apply_late_widget_props(
|
||||
}
|
||||
|
||||
/// Name field `old` `new` in each field's Calculate script that reads it
|
||||
/// ([`crate::af::rename_in_calculation`]).
|
||||
/// ([`crate::af::rename_in_calculation`]). Script streams share one budget, as a reading of the
|
||||
/// form's scripts does, however many fields name the same stream; past it, a script is left as
|
||||
/// it is, like one that won't decode. A Calculate action several fields share by reference is
|
||||
/// read and rewritten once, in place, so they all read the new name.
|
||||
fn rename_in_calculations(doc: &mut Document, all: &[Field], old: &str, new: &str) -> Result<(), FormError> {
|
||||
let aa_of =
|
||||
|doc: &Document, r: ObjRef| doc.get(r).as_dict().and_then(|d| d.get(b"AA").map(|a| doc.resolve(a))).and_then(|a| a.as_dict().cloned());
|
||||
let mut scripts = crate::script_budget();
|
||||
let mut shared = std::collections::HashSet::new();
|
||||
for f in all {
|
||||
// The script is the field's, or its only widget's when the field has none, as
|
||||
// `actions_of` reads it.
|
||||
@@ -595,12 +600,16 @@ fn rename_in_calculations(doc: &mut Document, all: &[Field], old: &str, new: &st
|
||||
_ => None,
|
||||
};
|
||||
let Some((owner, mut aa)) = aa_of(doc, f.obj).map(|aa| (f.obj, aa)).or_else(only_widget) else { continue };
|
||||
let by_ref = aa.get(b"C").and_then(Object::as_ref);
|
||||
if by_ref.is_some_and(|r| !shared.insert(r)) {
|
||||
continue;
|
||||
}
|
||||
let Some(mut action) = aa.get(b"C").and_then(|a| doc.resolve(a).as_dict().cloned()) else { continue };
|
||||
let js = match action.get(b"JS").map(|js| doc.resolve(js)).as_deref() {
|
||||
Some(Object::String(s)) => s.to_text(),
|
||||
// A stream that isn't UTF-8 reads with replacement characters, which must not be
|
||||
// written back in place of what it holds.
|
||||
Some(Object::Stream(s)) => match s.decoded().ok().and_then(|b| String::from_utf8(b).ok()) {
|
||||
Some(Object::Stream(s)) => match scripts.decode(s).ok().and_then(|b| String::from_utf8(b).ok()) {
|
||||
Some(js) => js,
|
||||
None => continue,
|
||||
},
|
||||
@@ -608,6 +617,10 @@ fn rename_in_calculations(doc: &mut Document, all: &[Field], old: &str, new: &st
|
||||
};
|
||||
let Some(js) = crate::af::rename_in_calculation(&js, old, new) else { continue };
|
||||
action.set(b"JS".to_vec(), PdfString::text(&js));
|
||||
if let Some(r) = by_ref {
|
||||
doc.update_dict(r, |d| *d = action)?;
|
||||
continue;
|
||||
}
|
||||
aa.set(b"C".to_vec(), Object::Dict(action));
|
||||
doc.update_dict(owner, |d| d.set(b"AA".to_vec(), Object::Dict(aa)))?;
|
||||
}
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
//! the shapes from a page's content, [`raster::shapes`] from a picture of the page (a scan).
|
||||
|
||||
use pdfcraft_content::{Matrix, Pieces};
|
||||
use pdfcraft_cos::{Document, Object};
|
||||
use pdfcraft_cos::{DecodeBudget, Document, Object};
|
||||
|
||||
pub mod raster;
|
||||
|
||||
@@ -49,6 +49,60 @@ pub struct Candidate {
|
||||
/// points along its sides (#2942: a cell drawn with a midpoint on each vertical side).
|
||||
const MAX_RECT_POINTS: usize = 16;
|
||||
|
||||
/// Graphics states saved (`q`) and kept at once while detecting; deeper saves are counted, not kept.
|
||||
const MAX_SAVES: usize = 256;
|
||||
|
||||
/// The graphics states a page saves (`q`) as detection follows its matrix: at most [`MAX_SAVES`]
|
||||
/// kept, deeper ones counted so each `Q` still closes its own. Of those not kept: the matrix when
|
||||
/// the first was made, which closing the last restores; the shallowest a `cm` changed the matrix
|
||||
/// in; and whether a `Q` has closed that one, so the matrix isn't known until the last closes.
|
||||
struct Saves {
|
||||
kept: Vec<Matrix>,
|
||||
lost: usize,
|
||||
lost_base: Matrix,
|
||||
moved_at: usize,
|
||||
unknown: bool,
|
||||
}
|
||||
|
||||
impl Default for Saves {
|
||||
fn default() -> Self {
|
||||
Saves { kept: Vec::new(), lost: 0, lost_base: Matrix::IDENTITY, moved_at: usize::MAX, unknown: false }
|
||||
}
|
||||
}
|
||||
|
||||
impl Saves {
|
||||
fn save(&mut self, ctm: Matrix) {
|
||||
if self.kept.len() < MAX_SAVES && self.lost == 0 {
|
||||
self.kept.push(ctm);
|
||||
} else {
|
||||
if self.lost == 0 {
|
||||
self.lost_base = ctm;
|
||||
}
|
||||
self.lost = self.lost.saturating_add(1);
|
||||
}
|
||||
}
|
||||
|
||||
fn restore(&mut self, ctm: &mut Matrix) {
|
||||
if self.lost == 0 {
|
||||
*ctm = self.kept.pop().unwrap_or(*ctm);
|
||||
return;
|
||||
}
|
||||
self.lost -= 1;
|
||||
if self.lost == 0 {
|
||||
(*ctm, self.moved_at, self.unknown) = (self.lost_base, usize::MAX, false);
|
||||
} else if self.lost < self.moved_at {
|
||||
self.unknown = true;
|
||||
}
|
||||
}
|
||||
|
||||
/// A `cm` changed the matrix at the current depth.
|
||||
fn moved(&mut self) {
|
||||
if self.lost > 0 {
|
||||
self.moved_at = self.moved_at.min(self.lost);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The rectangles and horizontal segments a page draws (stroked or filled), in user space.
|
||||
#[derive(Default)]
|
||||
struct DetectionPath {
|
||||
@@ -125,7 +179,15 @@ impl DetectionPath {
|
||||
}
|
||||
}
|
||||
|
||||
/// The shapes page `page`'s content draws, its streams decoded within one page's allowance
|
||||
/// ([`DecodeBudget::page`]), however often `/Contents` lists the same stream.
|
||||
pub fn page_shapes(doc: &Document, page: usize) -> Shapes {
|
||||
shapes_within(doc, page, &mut DecodeBudget::page())
|
||||
}
|
||||
|
||||
/// [`page_shapes`], decoding against `budget`: a stream `/Contents` lists again is charged again,
|
||||
/// and one past what is left reads as empty.
|
||||
pub(crate) fn shapes_within(doc: &Document, page: usize, budget: &mut DecodeBudget) -> Shapes {
|
||||
let mut out = Shapes::default();
|
||||
let Some(p) = pdfcraft_model::pages(doc).into_iter().nth(page) else { return out };
|
||||
let list: Vec<Object> = match p.dict.get(b"Contents").map(|c| doc.resolve(c)) {
|
||||
@@ -139,24 +201,36 @@ pub fn page_shapes(doc: &Document, page: usize) -> Shapes {
|
||||
let mut pieces = Vec::new();
|
||||
for o in list {
|
||||
if let Object::Stream(s) = &*doc.resolve(&o) {
|
||||
pieces.push(s.decoded().unwrap_or_default());
|
||||
pieces.push(budget.decode(s).unwrap_or_default());
|
||||
}
|
||||
}
|
||||
let mut ctm = Matrix::IDENTITY;
|
||||
let mut stack = Vec::new();
|
||||
let mut saves = Saves::default();
|
||||
let mut path_boxes: Vec<[f64; 4]> = Vec::new();
|
||||
let mut subpaths: Vec<DetectionPath> = Vec::new();
|
||||
let mut path = DetectionPath::default();
|
||||
let mut cur: Option<[f64; 2]> = None;
|
||||
for op in Pieces::join(&pieces).parse().ops {
|
||||
let joined = Pieces::join(&pieces);
|
||||
drop(pieces);
|
||||
// An operator at a time: dense content (`n n n …`) parsed whole holds about 80 bytes for each
|
||||
// byte it decoded.
|
||||
for op in pdfcraft_content::ops(joined.data()) {
|
||||
match op.op.as_slice() {
|
||||
b"q" => stack.push(ctm),
|
||||
b"Q" => ctm = stack.pop().unwrap_or(ctm),
|
||||
b"q" => saves.save(ctm),
|
||||
b"Q" => saves.restore(&mut ctm),
|
||||
b"cm" => {
|
||||
if let Some(m) = op.nums::<6>() {
|
||||
ctm = Matrix(m).then(&ctm);
|
||||
saves.moved();
|
||||
}
|
||||
}
|
||||
// Painted where the matrix isn't known: dropped, as `n` drops a path.
|
||||
b"S" | b"s" | b"f" | b"F" | b"f*" | b"B" | b"B*" | b"b" | b"b*" if saves.unknown => {
|
||||
path_boxes.clear();
|
||||
subpaths.clear();
|
||||
path = DetectionPath::default();
|
||||
cur = None;
|
||||
}
|
||||
b"re" => {
|
||||
path.finish(&mut subpaths);
|
||||
if let Some([x, y, w, h]) = op.nums::<4>() {
|
||||
|
||||
@@ -192,11 +192,17 @@ fn actions_of(doc: &Document, d: &Dict, widgets: &[ObjRef], scripts: &mut Decode
|
||||
out
|
||||
}
|
||||
|
||||
fn values_of(doc: &Document, o: Option<&Object>) -> Vec<String> {
|
||||
/// Text streams of field values (`/V`, `/DV`) one reading of the form may decode in all, however
|
||||
/// many fields name the same stream.
|
||||
pub(crate) const MAX_VALUE_BYTES: usize = 64 << 20;
|
||||
|
||||
/// A field's value or default value (`/V`, `/DV`). A text stream is decoded against `budget`, and
|
||||
/// reads as no value once it is spent, as one that won't decode does.
|
||||
fn values_of(doc: &Document, o: Option<&Object>, budget: &mut DecodeBudget) -> Vec<String> {
|
||||
let Some(o) = o else { return Vec::new() };
|
||||
match &*doc.resolve(o) {
|
||||
Object::Array(a) => a.iter().filter_map(|x| text_of(&doc.resolve(x))).collect(),
|
||||
Object::Stream(s) => s.decoded().ok().map(|b| PdfString::literal(b).to_text()).into_iter().collect(),
|
||||
Object::Stream(s) => budget.decode(s).ok().map(|b| PdfString::literal(b).to_text()).into_iter().collect(),
|
||||
other => text_of(other).filter(|s| s != "Off" && !s.is_empty()).into_iter().collect(),
|
||||
}
|
||||
}
|
||||
@@ -345,7 +351,12 @@ pub(crate) fn enumerate(doc: &Document) -> (Vec<Field>, usize) {
|
||||
None => Inherited::default(),
|
||||
};
|
||||
let mut out = Vec::new();
|
||||
let mut seen = Seen { fields: std::collections::HashSet::new(), widgets: std::collections::HashSet::new(), scripts: script_budget() };
|
||||
let mut seen = Seen {
|
||||
fields: std::collections::HashSet::new(),
|
||||
widgets: std::collections::HashSet::new(),
|
||||
scripts: script_budget(),
|
||||
values: DecodeBudget::new(MAX_VALUE_BYTES, 0),
|
||||
};
|
||||
if let Some(af) = &af {
|
||||
for f in af.get(b"Fields").map(|o| doc.resolve(o)).and_then(|o| o.as_array().cloned()).unwrap_or_default() {
|
||||
if let Some(r) = f.as_ref() {
|
||||
@@ -416,13 +427,14 @@ fn unlisted_root(doc: &Document, r: ObjRef, seen: &std::collections::HashSet<Obj
|
||||
}
|
||||
}
|
||||
|
||||
/// What one reading of the form's fields has used: the field and widget dictionaries read, and
|
||||
/// the script budget their actions share.
|
||||
/// What one reading of the form's fields has used: the field and widget dictionaries read, the
|
||||
/// script budget their actions share, and the budget their value streams share.
|
||||
struct Seen {
|
||||
fields: std::collections::HashSet<ObjRef>,
|
||||
/// A widget belongs to the first field that lists it, however often it is listed.
|
||||
widgets: std::collections::HashSet<ObjRef>,
|
||||
scripts: DecodeBudget,
|
||||
values: DecodeBudget,
|
||||
}
|
||||
|
||||
/// Read the field at `r` and the fields under it into `out`, with what they inherit from
|
||||
@@ -549,8 +561,8 @@ fn walk(
|
||||
name: inh.name.clone(),
|
||||
obj: r,
|
||||
kind,
|
||||
value: values_of(doc, inh.v.as_ref()),
|
||||
default: values_of(doc, inh.dv.as_ref()),
|
||||
value: values_of(doc, inh.v.as_ref(), &mut seen.values),
|
||||
default: values_of(doc, inh.dv.as_ref(), &mut seen.values),
|
||||
flags: ff,
|
||||
max_len: inh.max_len,
|
||||
options,
|
||||
|
||||
@@ -3575,6 +3575,149 @@ fn repeated_script_references_share_one_decode_budget() {
|
||||
assert!(calculate > 0 && calculate <= limit, "{calculate} bytes of field scripts");
|
||||
}
|
||||
|
||||
/// An unfiltered stream of `body`, as an object of [`document`].
|
||||
fn raw_stream(body: &str) -> String {
|
||||
format!("<< /Length {} >>\nstream\n{body}\nendstream", body.len())
|
||||
}
|
||||
|
||||
/// 300 fields whose value is one 1 MiB text stream: a reading of the form decodes their values
|
||||
/// within one budget, not 300 MiB.
|
||||
#[test]
|
||||
fn repeated_value_streams_share_one_decode_budget() {
|
||||
let fields_list: String = (0..300).map(|i| format!("{} 0 R ", i + 3)).collect();
|
||||
let mut objs = vec![format!("<< /Type /Catalog /AcroForm << /Fields [{fields_list}] >> >>"), raw_stream(&"x".repeat(1 << 20))];
|
||||
objs.extend((0..300).map(|i| format!("<< /FT /Tx /T (f{i}) /V 2 0 R /DV 2 0 R >>")));
|
||||
let all = fields(&document(&objs));
|
||||
assert_eq!(all.len(), 300);
|
||||
let read: usize = all.iter().flat_map(|f| f.value.iter().chain(&f.default)).map(String::len).sum();
|
||||
assert!(read > 0 && read <= crate::read::MAX_VALUE_BYTES, "{read} bytes of values");
|
||||
assert_eq!(all[0].value, ["x".repeat(1 << 20)], "the first field still reads its value");
|
||||
}
|
||||
|
||||
/// Clear form leaves a field as it is when its default is a stream the value budget didn't reach:
|
||||
/// 70 fields typed in, whose default is one 1 MiB text stream, keep a value, the first ones
|
||||
/// their default and the rest what was typed, none of them emptied.
|
||||
#[test]
|
||||
fn clear_form_keeps_a_field_whose_default_was_not_read() {
|
||||
let n = 70;
|
||||
let fields_list: String = (0..n).map(|i| format!("{} 0 R ", i + 3)).collect();
|
||||
let mut objs = vec![format!("<< /Type /Catalog /AcroForm << /Fields [{fields_list}] >> >>"), raw_stream(&"d".repeat(1 << 20))];
|
||||
objs.extend((0..n).map(|i| format!("<< /FT /Tx /T (f{i}) /V (typed) /DV 2 0 R >>")));
|
||||
let mut doc = document(&objs);
|
||||
reset(&mut doc, None).unwrap();
|
||||
let values: Vec<String> = (0..n)
|
||||
.map(|i| {
|
||||
let field = doc.get(ObjRef::new(i as u32 + 3, 0));
|
||||
field.as_dict().and_then(|d| d.get(b"V")).and_then(|v| v.as_string().map(PdfString::to_text)).unwrap_or_default()
|
||||
})
|
||||
.collect();
|
||||
assert!(values.iter().all(|v| !v.is_empty()), "no field is emptied");
|
||||
assert_eq!(values[0], "d".repeat(1 << 20), "the first field goes back to its default");
|
||||
assert_eq!(values[n - 1], "typed", "the last field, whose default wasn't read, keeps its value");
|
||||
// A value the reading didn't decode, with no default, is cleared: it isn't known to be empty.
|
||||
let mut objs = vec![format!("<< /Type /Catalog /AcroForm << /Fields [{fields_list}] >> >>"), raw_stream(&"v".repeat(1 << 20))];
|
||||
objs.extend((0..n).map(|i| format!("<< /FT /Tx /T (f{i}) /V 2 0 R >>")));
|
||||
let mut doc = document(&objs);
|
||||
reset(&mut doc, None).unwrap();
|
||||
let last = doc.get(ObjRef::new(n as u32 + 2, 0));
|
||||
assert!(last.as_dict().and_then(|d| d.get(b"V")).is_none_or(|v| !matches!(v, Object::Ref(_))), "the last field's unread value is cleared");
|
||||
}
|
||||
|
||||
/// Renaming a field that 300 calculations read through one shared Calculate action, whose script
|
||||
/// is a 256 KiB stream, decodes and rewrites that action once, in place: every calculation reads
|
||||
/// the new name, and nothing is decoded or written 300 times.
|
||||
#[test]
|
||||
fn a_rename_rewrites_a_shared_calculation_once() {
|
||||
let n = 300;
|
||||
let refs = |from: usize| -> String { (from..from + n).map(|i| format!("{i} 0 R ")).collect() };
|
||||
let js = format!("AFSimple_Calculate(\"SUM\", new Array (\"a\"));{}", " ".repeat(256 << 10));
|
||||
let mut objs = vec![
|
||||
"<< /Type /Catalog /Pages 2 0 R /AcroForm 4 0 R >>".into(),
|
||||
"<< /Type /Pages /Kids [3 0 R] /Count 1 /MediaBox [0 0 600 800] >>".into(),
|
||||
format!("<< /Type /Page /Parent 2 0 R /Annots [5 0 R {}] >>", refs(8)),
|
||||
format!("<< /Fields [5 0 R {}] /DA (/Helv 0 Tf 0 g) >>", refs(8)),
|
||||
"<< /Type /Annot /Subtype /Widget /FT /Tx /T (a) /Rect [50 700 250 720] /P 3 0 R >>".into(),
|
||||
"<< /S /JavaScript /JS 7 0 R >>".into(),
|
||||
raw_stream(&js),
|
||||
];
|
||||
objs.extend((0..n).map(|i| format!("<< /Type /Annot /Subtype /Widget /FT /Tx /T (c{i}) /Rect [50 10 250 30] /P 3 0 R /AA << /C 6 0 R >> >>")));
|
||||
let mut doc = document(&objs);
|
||||
set_props(&mut doc, "a", &FieldProps { name: Some("qty".into()), ..FieldProps::default() }).unwrap();
|
||||
let action = ObjRef::new(6, 0);
|
||||
let renamed = (8..8 + n).all(|i| {
|
||||
let field = doc.get(ObjRef::new(i as u32, 0));
|
||||
field.as_dict().and_then(|d| d.get(b"AA")).and_then(|aa| aa.as_dict()?.get(b"C")?.as_ref()) == Some(action)
|
||||
});
|
||||
assert!(renamed, "every calculation still names the one shared action");
|
||||
let js = doc.get(action).as_dict().and_then(|d| d.get(b"JS")?.as_string().map(PdfString::to_text)).unwrap_or_default();
|
||||
assert!(js.contains("\"qty\"") && !js.contains("\"a\""), "the shared action reads the new name");
|
||||
assert!(js.len() <= MAX_SCRIPT_BYTES, "{} bytes written once", js.len());
|
||||
}
|
||||
|
||||
/// A page whose `/Contents` lists one 1 MiB stream ten times is read within the budget given:
|
||||
/// pieces past it read as empty, so their rectangles aren't found.
|
||||
#[test]
|
||||
fn page_shapes_decode_a_repeated_content_stream_within_the_budget() {
|
||||
let piece = format!("%{}\n10 10 20 20 re S\n", "x".repeat(1 << 20));
|
||||
let doc = document(&[
|
||||
"<< /Type /Catalog /Pages 2 0 R >>".into(),
|
||||
"<< /Type /Pages /Kids [3 0 R] /Count 1 /MediaBox [0 0 600 800] >>".into(),
|
||||
format!("<< /Type /Page /Parent 2 0 R /Contents [{}] >>", "4 0 R ".repeat(10)),
|
||||
raw_stream(&piece),
|
||||
]);
|
||||
assert_eq!(crate::detect::page_shapes(&doc, 0).boxes.len(), 10, "one page's allowance reads them all");
|
||||
let mut budget = DecodeBudget::new(4 << 20, 0);
|
||||
let boxes = crate::detect::shapes_within(&doc, 0, &mut budget).boxes.len();
|
||||
assert!((1..=4).contains(&boxes), "{boxes} rectangles read within 4 MiB");
|
||||
assert_eq!(budget.remaining(), 0, "the budget is spent");
|
||||
}
|
||||
|
||||
/// Field detection keeps at most 256 saved graphics states, and each `Q` still restores its own
|
||||
/// `q` past that: a scale set 300 saves deep is gone once they are all restored.
|
||||
#[test]
|
||||
fn page_shapes_restore_saves_past_the_cap() {
|
||||
let content = format!("{} 2 0 0 2 0 0 cm {} 10 10 20 20 re S", "q ".repeat(300), "Q ".repeat(300));
|
||||
let doc = document(&[
|
||||
"<< /Type /Catalog /Pages 2 0 R >>".into(),
|
||||
"<< /Type /Pages /Kids [3 0 R] /Count 1 /MediaBox [0 0 600 800] >>".into(),
|
||||
"<< /Type /Page /Parent 2 0 R /Contents 4 0 R >>".into(),
|
||||
raw_stream(&content),
|
||||
]);
|
||||
assert_eq!(crate::detect::page_shapes(&doc, 0).boxes, [[10.0, 10.0, 30.0, 30.0]]);
|
||||
// A scale set past the cap and closed by its own `Q` leaves a matrix that can't be known until
|
||||
// the last lost save closes: what is drawn in between isn't reported at the scaled place.
|
||||
let content = format!("{} q 2 0 0 2 0 0 cm Q 10 10 20 20 re S {} 40 40 10 10 re S", "q ".repeat(257), "Q ".repeat(257));
|
||||
let doc = document(&[
|
||||
"<< /Type /Catalog /Pages 2 0 R >>".into(),
|
||||
"<< /Type /Pages /Kids [3 0 R] /Count 1 /MediaBox [0 0 600 800] >>".into(),
|
||||
"<< /Type /Page /Parent 2 0 R /Contents 4 0 R >>".into(),
|
||||
raw_stream(&content),
|
||||
]);
|
||||
assert_eq!(crate::detect::page_shapes(&doc, 0).boxes, [[40.0, 40.0, 50.0, 50.0]]);
|
||||
}
|
||||
|
||||
/// The PDF/A declaration is read from metadata each filter stage of which decodes within
|
||||
/// [`crate::appearances::MAX_XMP_BYTES`], as preflight decodes it: a field drawn with characters its
|
||||
/// font lacks decodes no more than that a stage.
|
||||
#[test]
|
||||
fn a_pdfa_declaration_is_read_from_metadata_within_its_cap() {
|
||||
let declared = |xmp: String| declares_pdfa(&document(&["<< /Type /Catalog /Metadata 2 0 R >>".into(), raw_stream(&xmp)]));
|
||||
let pdfa = |padding: usize| format!("<x:xmpmeta><pdfaid:part>2</pdfaid:part>{}</x:xmpmeta>", " ".repeat(padding));
|
||||
assert!(declared(pdfa(1 << 20)));
|
||||
assert!(!declared(pdfa(crate::appearances::MAX_XMP_BYTES)), "metadata past the cap declares nothing");
|
||||
assert!(!declared("<x:xmpmeta><dc:title>pdfaid</dc:title></x:xmpmeta>".into()), "metadata without pdfaid:part declares nothing");
|
||||
// 3.5 MiB stored as hex, then Flate: its stages decode 7 and 3.5 MiB, each within the cap.
|
||||
let xmp = pdfa(7 << 19);
|
||||
let hex: Vec<u8> = xmp.bytes().flat_map(|b| [b"0123456789ABCDEF"[usize::from(b >> 4)], b"0123456789ABCDEF"[usize::from(b & 15)]]).collect();
|
||||
let mut stream = pdfcraft_cos::Stream::flate(pdfcraft_cos::Dict::new(), &hex);
|
||||
stream.dict.set(b"Filter".to_vec(), Object::Array(vec![Object::name("FlateDecode"), Object::name("ASCIIHexDecode")]));
|
||||
let mut doc = Document::new_empty();
|
||||
let metadata = doc.add(Object::Stream(stream));
|
||||
let catalog = doc.add(Object::Dict([(b"Metadata".to_vec(), Object::Ref(metadata))].into_iter().collect()));
|
||||
doc.trailer_mut().set(b"Root".to_vec(), Object::Ref(catalog));
|
||||
assert!(declares_pdfa(&doc), "metadata through a chain of filters declares PDF/A, as preflight decodes it");
|
||||
}
|
||||
|
||||
/// A widget listed many times, by one field's `/Kids` or by a `/Kids` array several fields share,
|
||||
/// is read once: the first field to list it owns it.
|
||||
#[test]
|
||||
|
||||
@@ -470,7 +470,9 @@ fn redraw(doc: &mut Document, f: &Field, values: &[String], scripts: &mut dyn Sc
|
||||
/// document that declares PDF/A, which forbids it: there the widget's mark
|
||||
/// (`pdfcraft_fonts::UNDRAWN_MARK`) is all, and the edit's report says the `?` shows everywhere.
|
||||
pub(crate) fn ask_viewers_to_redraw(doc: &mut Document) -> Result<(), FormError> {
|
||||
if declares_pdfa(doc) || need_appearances(doc) {
|
||||
// The form's own flag first: once it is set, the metadata needn't be decoded again for each
|
||||
// field drawn after.
|
||||
if need_appearances(doc) || declares_pdfa(doc) {
|
||||
return Ok(());
|
||||
}
|
||||
let Some(root) = doc.root() else { return Ok(()) };
|
||||
@@ -625,6 +627,22 @@ pub fn clear_password_values(doc: &mut Document) -> Result<usize, FormError> {
|
||||
Ok(targets.len())
|
||||
}
|
||||
|
||||
/// Whether `field`'s `key` (`/V` or `/DV`, its own or inherited) is a stream with data, which
|
||||
/// [`fields`] reads as empty once its value budget is spent.
|
||||
fn unread_stream(doc: &Document, field: ObjRef, key: &[u8]) -> bool {
|
||||
let mut node = Some(field);
|
||||
for _ in 0..64 {
|
||||
let Some(r) = node else { break };
|
||||
let obj = doc.get(r);
|
||||
let Some(d) = obj.as_dict() else { break };
|
||||
if let Some(value) = d.get(key) {
|
||||
return matches!(&*doc.resolve(value), Object::Stream(s) if !s.raw.is_empty());
|
||||
}
|
||||
node = d.reference(b"Parent");
|
||||
}
|
||||
false
|
||||
}
|
||||
|
||||
/// Acrobat's Clear form: every field (or the named ones) back to its default value.
|
||||
pub fn reset(doc: &mut Document, names: Option<&[String]>) -> Result<usize, FormError> {
|
||||
let all = fields(doc);
|
||||
@@ -641,7 +659,11 @@ pub fn reset(doc: &mut Document, names: Option<&[String]>) -> Result<usize, Form
|
||||
let named: Option<std::collections::HashSet<&str>> = names.map(|n| n.iter().map(String::as_str).collect());
|
||||
let mut changed = 0;
|
||||
for f in all.iter().filter(|f| named.as_ref().is_none_or(|n| n.contains(f.name.as_str()))) {
|
||||
if f.value == f.default {
|
||||
// A default the reading didn't decode (its budget spent) is unknown, not empty: clearing
|
||||
// the field to nothing would lose the value it should go back to. A value it didn't decode
|
||||
// isn't known to be the default, so it is reset.
|
||||
let unread = |key: &[u8], read: &[String]| read.is_empty() && unread_stream(doc, f.obj, key);
|
||||
if unread(b"DV", &f.default) || (f.value == f.default && !unread(b"V", &f.value)) {
|
||||
continue;
|
||||
}
|
||||
let v = match f.kind {
|
||||
|
||||
@@ -30,7 +30,9 @@ let report = optimize_with_progress(&mut doc, &settings, &mut |stage| keep_going
|
||||
threshold are resampled with a bicubic (Catmull-Rom) filter to a target resolution and
|
||||
stored as JPEG (Acrobat's quality steps) or ZIP; soft masks are resampled with their image. A
|
||||
stencil `/Mask` has its own resolution, so the picture changes under it and it stays as it is.
|
||||
An image is replaced only if the result is smaller. Left alone by these colour and grey
|
||||
An image is replaced only if the result is smaller. Images over 80 million pixels are left
|
||||
alone by the image steps, here and below, whatever their settings (memory); Clean Up may still
|
||||
Flate an unfiltered or LZW one. Left alone by these colour and grey
|
||||
settings: CMYK and other colour spaces, image masks, colour-key masks, decode arrays, more than 8 bits, JPEG 2000,
|
||||
JBIG2 and CCITT (black-and-white images, CCITT and JBIG2 among them, are below). A JPEG is read with
|
||||
its colour transform (an Adobe marker's, else `/ColorTransform`, ISO 32000-2 §7.4.8), so one
|
||||
@@ -87,7 +89,15 @@ let report = optimize_with_progress(&mut doc, &settings, &mut |stage| keep_going
|
||||
alone when JBIG2 is asked for, is stored again as the compression asks when that is smaller (as JBIG2 symbols where
|
||||
its own coding is a generic region, say); a symbol-coded scan, averaged, loses its exact
|
||||
repeats and often comes out larger, and then stays as it is. A JBIG2 image stored again refers to no
|
||||
`/JBIG2Globals`, and one whose page isn't its size (PdfCraft's
|
||||
`/JBIG2Globals` of its own. With JBIG2 asked for, the images stored as JBIG2, up to 16 at a
|
||||
time, then share one symbol dictionary in a new `/JBIG2Globals` stream, holding the marks found
|
||||
in more than one of them: those that come out smaller that way, when together they save more
|
||||
than it takes. Only images that redaction can store again without it share one: image masks
|
||||
and DeviceGray images named directly, of at most 64 Mi pixels (redaction's limit,
|
||||
`pdfcraft_cos::MAX_REDACTED_IMAGE_PIXELS`); others are coded alone.
|
||||
Redacting one of them stores the others of its group again without it, so the group keeps that
|
||||
to 15 images, and each image's decode reads the dictionary of 16 at most. A
|
||||
JBIG2 image whose page isn't its size (PdfCraft's
|
||||
renderer draws the whole page into the image) is left alone. With Retain, a resampled image
|
||||
keeps its kind of compression (CCITT, JBIG2, or Flate) and nothing else changes; an image of
|
||||
more bits is then left to the grey or colour settings. Every change is kept only when it is
|
||||
@@ -96,11 +106,12 @@ let report = optimize_with_progress(&mut doc, &settings, &mut |stage| keep_going
|
||||
space, decode array and `/Mask` stay, but for packed RGB, which becomes grey with one decode
|
||||
pair. Group 4 wins on scans, whose ragged edges defeat Flate; on clean computer-drawn 1-bit
|
||||
art Flate can be smaller. Not yet: inline images, an image's own `/SMask` or `/Mask`
|
||||
image (only images drawn on a page are visited), and Group 4 for rows wider than 32,767
|
||||
samples.
|
||||
image (only images drawn on a page are visited), Group 4 for rows wider than 32,767
|
||||
samples, and JBIG2 past 65,535 samples on a side, where the decoder stops (its 2^28 in all
|
||||
is past the 80 million pixels above).
|
||||
|
||||
- Lossless JBIG2 uses bounded generic-region encoding or exact-copy symbol dictionaries when
|
||||
smaller. No lossy symbol substitution is used. Export, redaction and this step read JBIG2
|
||||
smaller, a dictionary shared by up to 16 images when that is smaller still. No lossy symbol substitution is used. Export, redaction and this step read JBIG2
|
||||
images, with bounded shared globals. All of a run's images share one allowance of decoding
|
||||
(`pdfcraft_cos::ImageBudget`), filters, decoders and pixels alike, JPEG samples and merged
|
||||
pictures too: about
|
||||
|
||||
@@ -1117,12 +1117,23 @@ fn downsample_bits_checked(data: &[u8], w: u32, h: u32, nw: u32, nh: u32, dark_i
|
||||
/// to be resampled, and so is JBIG2 alone when Group 4 is asked for; Group 3, Group 4 inside
|
||||
/// another filter, and JBIG2 otherwise are stored again like any other. With `Retain`, a resampled image keeps its kind of compression (CCITT, JBIG2, or
|
||||
/// Flate), and nothing else changes: an image of more bits stays as it is, for the grey or
|
||||
/// colour settings. A JBIG2 image stored again refers to no `/JBIG2Globals`.
|
||||
/// colour settings. A JBIG2 image stored again refers to no `/JBIG2Globals`; with `Jbig2`, [`share`]
|
||||
/// may then have a group of them share one.
|
||||
///
|
||||
/// The samples keep their meaning, so the colour space, decode array and `/Mask` stay, but for
|
||||
/// black-and-white RGB, which becomes grey with one decode pair, and an indexed image's default
|
||||
/// decode array, which goes as the default at one bit.
|
||||
fn mono(doc: &Document, s: &Stream, ppi: f64, defaults: bool, settings: &MonoSettings, budget: &mut ImageBudget) -> Option<(Stream, bool)> {
|
||||
///
|
||||
/// Stored as JBIG2 with `Jbig2`, it comes with the 1-bit samples it was coded from, for [`share`]
|
||||
/// to code again with the run's other JBIG2 images.
|
||||
fn mono(
|
||||
doc: &Document,
|
||||
s: &Stream,
|
||||
ppi: f64,
|
||||
defaults: bool,
|
||||
settings: &MonoSettings,
|
||||
budget: &mut ImageBudget,
|
||||
) -> Option<(Stream, bool, Option<Vec<u8>>)> {
|
||||
let d = &s.dict;
|
||||
let downsample = settings.downsample && ppi.is_finite() && ppi > settings.above_ppi && settings.target_ppi > 0.0 && !d.contains(b"SMask");
|
||||
let retain = settings.compression == MonoCompression::Retain;
|
||||
@@ -1206,7 +1217,106 @@ fn mono(doc: &Document, s: &Stream, ppi: f64, defaults: bool, settings: &MonoSet
|
||||
let flate = ((resampled || packed_from_more) && !(retain && (ccitt || jbig2))).then(|| Stream::flate(dict, &data));
|
||||
// Smaller as stored, counting the dictionary: a tiny image can lose by Group 4's parameters.
|
||||
let best = [g4, jbig, flate].into_iter().flatten().filter_map(|c| Some((crate::stored_len(&c)?, c))).min_by_key(|(len, _)| *len)?;
|
||||
(best.0 < crate::stored_len(s)?).then_some((best.1, resampled))
|
||||
let shareable = settings.compression == MonoCompression::Jbig2 && best.1.dict.name(b"Filter") == Some(b"JBIG2Decode");
|
||||
(best.0 < crate::stored_len(s)?).then(|| (best.1, resampled, shareable.then_some(data)))
|
||||
}
|
||||
|
||||
/// The most images that share one symbol dictionary ([`share`]). Redaction stores again every
|
||||
/// image that shares a redacted one's dictionary, and each image's decode reads all of it, so a
|
||||
/// group keeps both to that many; most of what sharing saves comes with the first few images.
|
||||
const SHARED_IMAGES: usize = 16;
|
||||
|
||||
/// The most bytes of 1-bit samples a group holds: a group is coded before it would pass them
|
||||
/// ([`hold_in`]). An image that shares has at most [`SHARED_PIXELS`], and as its rows are whole
|
||||
/// bytes, at most that many bytes, which is this: one always fits a group with nothing in it.
|
||||
const SHARED_BYTES: usize = 64 << 20;
|
||||
|
||||
/// What the globals cost as an object of their own besides their dictionary and data: `N 0 obj`,
|
||||
/// `stream`, `endstream` and `endobj`, a cross-reference entry, and an encrypted file's IV and
|
||||
/// padding. A group is shared only when it saves more than that as well.
|
||||
const NEW_OBJECT: usize = 96;
|
||||
|
||||
/// Adds `image` to `group`, coding the group (`share`, which empties it) first when the image's
|
||||
/// samples would take it past `cap` bytes, and after when it has [`SHARED_IMAGES`].
|
||||
fn hold_in(group: &mut Vec<Held>, image: Held, cap: usize, mut share: impl FnMut(&mut Vec<Held>)) {
|
||||
if group.iter().map(|h| h.bits.len()).fold(image.bits.len(), usize::saturating_add) > cap {
|
||||
share(group);
|
||||
}
|
||||
group.push(image);
|
||||
if group.len() == SHARED_IMAGES {
|
||||
share(group);
|
||||
}
|
||||
}
|
||||
|
||||
/// The most pixels an image sharing a dictionary has: redaction's own limit on the images it
|
||||
/// stores again (see [`shares`]).
|
||||
const SHARED_PIXELS: u64 = pdfcraft_cos::MAX_REDACTED_IMAGE_PIXELS;
|
||||
|
||||
/// Whether an image stored as JBIG2 (its dictionary `d`) may share a dictionary: only one that
|
||||
/// redaction can store again without it, an image mask or a DeviceGray image, named directly, of
|
||||
/// at most [`SHARED_PIXELS`]. Redacting one image of a group stores the others so, as the
|
||||
/// dictionary can hold the shapes of marks under the area, and refuses the redaction for one it
|
||||
/// can't; an image of another colour space, though redaction may take it, is coded alone.
|
||||
fn shares(d: &Dict) -> bool {
|
||||
let side = |key: &[u8]| d.int(key).and_then(|v| u64::try_from(v).ok());
|
||||
let within = side(b"Width").zip(side(b"Height")).is_some_and(|(w, h)| w.saturating_mul(h) <= SHARED_PIXELS);
|
||||
within && (matches!(d.get(b"ImageMask"), Some(Object::Bool(true))) || d.name(b"ColorSpace") == Some(b"DeviceGray"))
|
||||
}
|
||||
|
||||
/// An image the run stored as JBIG2, held to be stored again sharing a dictionary ([`share`]): its
|
||||
/// 1-bit samples, `width` × `height`.
|
||||
struct Held {
|
||||
image: ObjRef,
|
||||
bits: Vec<u8>,
|
||||
width: u32,
|
||||
height: u32,
|
||||
}
|
||||
|
||||
/// Stores the images of `group`, each JBIG2 already, again sharing one symbol dictionary in a
|
||||
/// `/JBIG2Globals` stream ([`pdfcraft_filters::encode_jbig2_shared`]): those that come out smaller
|
||||
/// that way, if together they save more than the globals take. The others stay as they are, and
|
||||
/// so do all of them when that saves nothing. `report` counts the bytes as they end up, the globals
|
||||
/// included.
|
||||
fn share(doc: &mut Document, group: &mut Vec<Held>, report: &mut Report) {
|
||||
let held = std::mem::take(group);
|
||||
if held.len() < 2 {
|
||||
return;
|
||||
}
|
||||
let images: Vec<(&[u8], u32, u32)> = held.iter().map(|h| (&h.bits[..], h.width, h.height)).collect();
|
||||
let Ok(Some(shared)) = pdfcraft_filters::encode_jbig2_shared(&images) else { return };
|
||||
let with_globals = |s: &Stream, coded: Vec<u8>, globals: ObjRef| {
|
||||
let mut dict = s.dict.clone();
|
||||
let mut parms = Dict::new();
|
||||
parms.set(b"JBIG2Globals".to_vec(), Object::Ref(globals));
|
||||
dict.set(b"DecodeParms".to_vec(), Object::Dict(parms));
|
||||
Stream::from_raw(dict, coded)
|
||||
};
|
||||
// Weighed naming the globals with the longest reference there is: the real one is no longer.
|
||||
let longest = ObjRef { num: u32::MAX, generation: u16::MAX };
|
||||
let (mut chosen, mut saved) = (Vec::new(), 0usize);
|
||||
for (h, coded) in held.iter().zip(shared.images) {
|
||||
let Some(coded) = coded else { continue };
|
||||
let object = doc.get(h.image);
|
||||
let Object::Stream(alone) = &*object else { continue };
|
||||
let shorter = crate::stored_len(alone).zip(crate::stored_len(&with_globals(alone, coded.clone(), longest))).filter(|(a, b)| b < a);
|
||||
if let Some((before, after)) = shorter {
|
||||
saved = saved.saturating_add(before - after);
|
||||
chosen.push((h.image, coded));
|
||||
}
|
||||
}
|
||||
let globals = Stream::from_raw(Dict::new(), shared.globals);
|
||||
if chosen.is_empty() || crate::stored_len(&globals).is_none_or(|takes| saved <= takes.saturating_add(NEW_OBJECT)) {
|
||||
return;
|
||||
}
|
||||
report.image_bytes_after = report.image_bytes_after.saturating_add(globals.raw.len());
|
||||
let globals = doc.add(Object::Stream(globals));
|
||||
for (image, coded) in chosen {
|
||||
let object = doc.get(image);
|
||||
let Object::Stream(alone) = &*object else { continue };
|
||||
report.image_bytes_after = report.image_bytes_after.saturating_sub(alone.raw.len()).saturating_add(coded.len());
|
||||
let new = with_globals(alone, coded, globals);
|
||||
doc.set(image, Object::Stream(new));
|
||||
}
|
||||
}
|
||||
|
||||
/// One pass over the document's images, within `budget`. An image past it stays as it is, and is
|
||||
@@ -1239,6 +1349,13 @@ pub(crate) fn run(
|
||||
refs.sort_by_key(|(r, _)| r.num);
|
||||
let total = refs.len();
|
||||
let mut jbig2 = false;
|
||||
let mut group: Vec<Held> = Vec::new();
|
||||
// Holds a JBIG2 image for `share`, which codes the group once it is full.
|
||||
let mut hold = |doc: &mut Document, image: ObjRef, size: (Option<i64>, Option<i64>), bits: Option<Vec<u8>>, report: &mut Report| {
|
||||
let side = |v: Option<i64>| v.and_then(|v| u32::try_from(v).ok());
|
||||
let (Some(bits), Some(width), Some(height)) = (bits, side(size.0), side(size.1)) else { return };
|
||||
hold_in(&mut group, Held { image, bits, width, height }, SHARED_BYTES, |group| share(doc, group, report));
|
||||
};
|
||||
for (done, (r, ppi)) in refs.into_iter().enumerate() {
|
||||
if !progress(Stage::Images { done, total }) {
|
||||
return Err(OptimizeError::Cancelled);
|
||||
@@ -1254,7 +1371,7 @@ pub(crate) fn run(
|
||||
Some(m) if packed_from_more => (Some(m), None),
|
||||
m => (None, m),
|
||||
};
|
||||
if let Some((new, resampled)) = mono {
|
||||
if let Some((new, resampled, bits)) = mono {
|
||||
report.image_bytes_before += s.raw.len();
|
||||
report.image_bytes_after += new.raw.len();
|
||||
if resampled {
|
||||
@@ -1263,7 +1380,10 @@ pub(crate) fn run(
|
||||
report.images_recompressed += 1;
|
||||
}
|
||||
jbig2 |= new.dict.name(b"Filter") == Some(b"JBIG2Decode");
|
||||
let size = (new.dict.int(b"Width"), new.dict.int(b"Height"));
|
||||
let bits = bits.filter(|_| shares(&new.dict));
|
||||
doc.set(r, Object::Stream(new));
|
||||
hold(doc, r, size, bits, report);
|
||||
continue;
|
||||
}
|
||||
let n = s.dict.get(b"ColorSpace").and_then(|cs| components(doc, cs));
|
||||
@@ -1278,10 +1398,10 @@ pub(crate) fn run(
|
||||
}),
|
||||
};
|
||||
let total = |new: &Stream, smask: Option<&(ObjRef, Stream)>| Some(crate::stored_len(new)?.saturating_add(smask_len(smask).unwrap_or(0)));
|
||||
let packed_wins = packed.as_ref().is_some_and(|(p, _)| {
|
||||
let packed_wins = packed.as_ref().is_some_and(|(p, _, _)| {
|
||||
processed.as_ref().is_none_or(|(new, smask)| total(p, None).zip(total(new, smask.as_ref())).is_some_and(|(a, b)| a <= b))
|
||||
});
|
||||
if let Some((new, resampled)) = packed.filter(|_| packed_wins) {
|
||||
if let Some((new, resampled, bits)) = packed.filter(|_| packed_wins) {
|
||||
jbig2 |= new.dict.name(b"Filter") == Some(b"JBIG2Decode");
|
||||
report.image_bytes_before += s.raw.len();
|
||||
report.image_bytes_after += new.raw.len();
|
||||
@@ -1290,7 +1410,10 @@ pub(crate) fn run(
|
||||
} else {
|
||||
report.images_recompressed += 1;
|
||||
}
|
||||
let size = (new.dict.int(b"Width"), new.dict.int(b"Height"));
|
||||
let bits = bits.filter(|_| shares(&new.dict));
|
||||
doc.set(r, Object::Stream(new));
|
||||
hold(doc, r, size, bits, report);
|
||||
continue;
|
||||
}
|
||||
let Some((new, smask)) = processed else {
|
||||
@@ -1311,6 +1434,7 @@ pub(crate) fn run(
|
||||
doc.set(mr, Object::Stream(m));
|
||||
}
|
||||
}
|
||||
share(doc, &mut group, report);
|
||||
if !progress(Stage::Images { done: total, total }) {
|
||||
return Err(OptimizeError::Cancelled);
|
||||
}
|
||||
@@ -1338,6 +1462,58 @@ fn at_least_pdf_1_4(doc: &mut Document) -> Result<(), OptimizeError> {
|
||||
mod dimension_tests {
|
||||
use super::*;
|
||||
|
||||
/// A group is coded before an image's samples would take it past its limit, and once it has
|
||||
/// [`SHARED_IMAGES`]: with room for 10 bytes, images of 4 go two to a group, never three, and
|
||||
/// with room for 8, two of 4 fill one exactly; one of exactly the limit joins a group with
|
||||
/// nothing in it.
|
||||
#[test]
|
||||
fn a_group_is_coded_before_its_samples_would_pass_the_limit() {
|
||||
let held = |bytes: usize| Held { image: ObjRef { num: 1, generation: 0 }, bits: vec![0; bytes], width: 8, height: 8 };
|
||||
let mut coded: Vec<Vec<usize>> = Vec::new();
|
||||
let mut group = Vec::new();
|
||||
let mut code = |g: &mut Vec<Held>| coded.push(std::mem::take(g).iter().map(|h| h.bits.len()).collect());
|
||||
for _ in 0..5 {
|
||||
hold_in(&mut group, held(4), 10, &mut code);
|
||||
}
|
||||
hold_in(&mut group, held(10), 10, &mut code);
|
||||
assert_eq!(coded, [vec![4, 4], vec![4, 4], vec![4]]);
|
||||
assert_eq!(group.iter().map(|h| h.bits.len()).collect::<Vec<_>>(), [10]);
|
||||
// Exactly the limit is within it: with room for 8, two images of 4 stay together.
|
||||
let (mut count, mut group) = (0, Vec::new());
|
||||
let mut code = |g: &mut Vec<Held>| count += std::mem::take(g).len();
|
||||
hold_in(&mut group, held(4), 8, &mut code);
|
||||
hold_in(&mut group, held(4), 8, &mut code);
|
||||
assert_eq!((count, group.len()), (0, 2));
|
||||
let (mut count, mut group) = (0, Vec::new());
|
||||
for _ in 0..SHARED_IMAGES {
|
||||
hold_in(&mut group, held(1), usize::MAX, |g| count += std::mem::take(g).len());
|
||||
}
|
||||
assert_eq!((count, group.len()), (SHARED_IMAGES, 0), "coded on the 16th");
|
||||
}
|
||||
|
||||
/// Only what redaction can store again without the dictionary shares one: an image mask, or
|
||||
/// DeviceGray named directly, of at most 2^26 pixels.
|
||||
#[test]
|
||||
fn only_what_redaction_can_store_again_shares_a_dictionary() {
|
||||
let dict = |entries: Vec<(&str, Object)>| {
|
||||
let mut d = Dict::new();
|
||||
for (k, v) in entries {
|
||||
d.set(k.as_bytes().to_vec(), v);
|
||||
}
|
||||
d
|
||||
};
|
||||
let sized = |w: i64, h: i64, cs: Object| dict(vec![("Width", Object::Int(w)), ("Height", Object::Int(h)), ("ColorSpace", cs)]);
|
||||
assert!(shares(&sized(8192, 8192, Object::name("DeviceGray"))));
|
||||
assert!(!shares(&sized(8192, 8193, Object::name("DeviceGray"))), "a row past 2^26 pixels");
|
||||
assert!(shares(&dict(vec![("Width", Object::Int(8)), ("Height", Object::Int(8)), ("ImageMask", Object::Bool(true))])));
|
||||
let device_n =
|
||||
Object::Array(vec![Object::name("DeviceN"), Object::Array(vec![Object::name("Black")]), Object::name("DeviceGray"), Object::Null]);
|
||||
assert!(!shares(&sized(8, 8, device_n)));
|
||||
assert!(!shares(&sized(8, 8, Object::name("CalGray"))));
|
||||
assert!(!shares(&sized(8, 8, Object::Ref(ObjRef { num: 3, generation: 0 }))), "a colour space by reference");
|
||||
assert!(!shares(&dict(vec![("ColorSpace", Object::name("DeviceGray"))])), "no size");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pixel_reader_rejects_hostile_dimensions_before_decoding() {
|
||||
for (width, height, channels) in [(-1, 1, 1), (0, 1, 1), (i64::from(u32::MAX) + 101, 1, 1), (80_000_001, 1, 1), (2, 2, usize::MAX)] {
|
||||
|
||||
@@ -1951,8 +1951,17 @@ fn black_and_white_images_become_jbig2() {
|
||||
assert!(r.image_bytes_after < as_g4.image_bytes_after, "JBIG2 {} bytes, Group 4 {}", r.image_bytes_after, as_g4.image_bytes_after);
|
||||
let images: Vec<Stream> = image_refs(&jbig2).into_iter().map(|i| stream(&jbig2, i)).collect();
|
||||
assert_eq!(images.len(), 3);
|
||||
// The same text three times: the grey image and the mask share one symbol dictionary, and the
|
||||
// indexed image, which only those share, is coded alone.
|
||||
let globals_of = |s: &Stream| s.dict.get(b"DecodeParms").and_then(Object::as_dict).map(|d| (d.len(), d.reference(b"JBIG2Globals")));
|
||||
let is_indexed = |s: &Stream| s.dict.get(b"ColorSpace").and_then(Object::as_array).is_some();
|
||||
let shared: Vec<_> = images.iter().filter(|s| !is_indexed(s)).map(globals_of).collect();
|
||||
assert!(shared.len() == 2 && shared[0].is_some_and(|(n, g)| n == 1 && g.is_some()) && shared[0] == shared[1], "{shared:?}");
|
||||
for s in &images {
|
||||
assert_eq!((s.dict.name(b"Filter"), s.dict.contains(b"DecodeParms")), (Some(&b"JBIG2Decode"[..]), false));
|
||||
assert_eq!(s.dict.name(b"Filter"), Some(&b"JBIG2Decode"[..]));
|
||||
if is_indexed(s) {
|
||||
assert!(!s.dict.contains(b"DecodeParms"));
|
||||
}
|
||||
}
|
||||
assert!(images.iter().any(|s| s.dict.get(b"Decode") == Some(&decode)), "the decode array stays");
|
||||
let indexed_kept =
|
||||
@@ -1999,6 +2008,11 @@ fn a_catalog_version_given_by_reference_is_read() {
|
||||
/// `#` a 3 × 3 block, three columns apart with a wider gap between words, every copy of a letter
|
||||
/// the same to the pixel.
|
||||
fn rendered_text(w: u32, h: u32) -> Vec<u8> {
|
||||
rendered_text_from(w, h, 0x2545_F491_4F6C_DD1D)
|
||||
}
|
||||
|
||||
/// [`rendered_text`], its letters picked from `seed`, which isn't 0.
|
||||
fn rendered_text_from(w: u32, h: u32, mut seed: u64) -> Vec<u8> {
|
||||
const LETTERS: [&[&str]; 5] = [
|
||||
&["##", "##", "##", "##", "##", "##", "##", "##", "##", "##"],
|
||||
&["......", ".####.", "##..##", "##..##", "##..##", "##..##", ".####."],
|
||||
@@ -2008,7 +2022,6 @@ fn rendered_text(w: u32, h: u32) -> Vec<u8> {
|
||||
];
|
||||
let stride = (w as usize).div_ceil(8);
|
||||
let mut data = vec![0xFF; stride * h as usize];
|
||||
let mut seed = 0x2545_F491_4F6C_DD1Du64;
|
||||
let mut next = move || {
|
||||
seed ^= seed << 13;
|
||||
seed ^= seed >> 7;
|
||||
@@ -2053,9 +2066,194 @@ fn rendered_text_becomes_jbig2_symbols() {
|
||||
assert_eq!(s.dict.name(b"Filter"), Some(&b"JBIG2Decode"[..]));
|
||||
let generic = pdfcraft_filters::encode_jbig2_generic(&text, w, h).unwrap();
|
||||
assert!(s.raw.len() * 2 < generic.len(), "symbols {} bytes, generic {}", s.raw.len(), generic.len());
|
||||
assert!(!s.dict.contains(b"DecodeParms"), "alone, it shares no dictionary");
|
||||
assert!(render(&doc) == before, "the page looks the same");
|
||||
}
|
||||
|
||||
/// Page `index` of `doc`, saved and opened again, rendered at scale 1.
|
||||
fn render_page(doc: &Document, index: usize) -> Vec<u8> {
|
||||
let bytes = write_full(doc, &SaveOptions::default()).unwrap();
|
||||
let mut r = pdfcraft_render::PageRenderer::new(Arc::new(bytes), pdfcraft_render::RenderConfig::default());
|
||||
let out = r.render(pdfcraft_render::RenderRequest { page: index, scale: 1.0, ..Default::default() });
|
||||
assert!(out.error.is_none(), "{:?}", out.error);
|
||||
out.rgba.to_vec()
|
||||
}
|
||||
|
||||
/// Text in a font of 26 letters, about 10 pt at 300 dpi: each letter 32 rows of a run from a stem
|
||||
/// down its left side, of 2 to 24 pixels, every copy the same to the pixel; lines 44 rows apart,
|
||||
/// the letters picked from `seed`, which isn't 0.
|
||||
fn font_text(w: u32, h: u32, mut seed: u64) -> Vec<u8> {
|
||||
let mut font_seed = 0x2545_F491_4F6C_DD1Du64;
|
||||
let next = |seed: &mut u64| {
|
||||
*seed ^= *seed << 13;
|
||||
*seed ^= *seed >> 7;
|
||||
*seed ^= *seed << 17;
|
||||
*seed
|
||||
};
|
||||
let letters: Vec<Vec<usize>> = (0..26).map(|_| (0..16).map(|_| 1 + (next(&mut font_seed) % 12) as usize).collect()).collect();
|
||||
let stride = (w as usize).div_ceil(8);
|
||||
let mut data = vec![0xFF; stride * h as usize];
|
||||
for top in (8..(h as usize).saturating_sub(40)).step_by(44) {
|
||||
let mut x = 8;
|
||||
while x + 32 < w as usize {
|
||||
let letter = &letters[(next(&mut seed) % 26) as usize];
|
||||
for (row, run) in letter.iter().enumerate() {
|
||||
for y in [top + 2 * row, top + 2 * row + 1] {
|
||||
for px in x..x + 2 * run {
|
||||
data[y * stride + px / 8] &= !(0x80 >> (px % 8));
|
||||
}
|
||||
}
|
||||
}
|
||||
x += 2 * letter.iter().max().unwrap() + 4 + if next(&mut seed) % 6 == 0 { 14 } else { 0 };
|
||||
}
|
||||
}
|
||||
data
|
||||
}
|
||||
|
||||
/// The `/JBIG2Globals` an image names in its `/DecodeParms`.
|
||||
fn globals_of(doc: &Document, image: ObjRef) -> Option<ObjRef> {
|
||||
stream(doc, image).dict.get(b"DecodeParms")?.as_dict()?.reference(b"JBIG2Globals")
|
||||
}
|
||||
|
||||
/// Pages of text in one font, each letter the same to the pixel on every page, stored as JBIG2
|
||||
/// share one symbol dictionary (`/JBIG2Globals`): together they take less than each page coded
|
||||
/// alone, and every page looks the same, the last one, whose crosses no other page has, placing
|
||||
/// them from a dictionary of its own beside the shared one. The report counts the bytes they
|
||||
/// take, the globals once.
|
||||
#[test]
|
||||
fn jbig2_pages_share_one_symbol_dictionary() {
|
||||
let mut doc = Document::new_empty();
|
||||
let (w, h) = (600u32, 480u32);
|
||||
let stride = (w as usize).div_ceil(8);
|
||||
let pages: Vec<Vec<u8>> = (1..=4u64)
|
||||
.map(|k| {
|
||||
let mut text = font_text(w, h, k.wrapping_mul(0x9E37_79B9_7F4A_7C15));
|
||||
if k == 4 {
|
||||
// Crosses down the right margin, three pixels a stroke.
|
||||
for top in (40..440).step_by(40) {
|
||||
for (dx, dy) in (0..9).map(|i| (i, 4)).chain((0..9).map(|i| (4, i))) {
|
||||
let (x, y) = (580 + dx, top + dy);
|
||||
text[y * stride + x / 8] &= !(0x80 >> (x % 8));
|
||||
}
|
||||
}
|
||||
}
|
||||
text
|
||||
})
|
||||
.collect();
|
||||
let images: Vec<ObjRef> = pages
|
||||
.iter()
|
||||
.map(|text| {
|
||||
let im = mono_image(&mut doc, w, h, text, None, &[("BitsPerComponent", 1.into()), ("ColorSpace", Object::name("DeviceGray"))]);
|
||||
page(&mut doc, &[("Im", im)], "q 600 0 0 480 6 300 cm /Im Do Q");
|
||||
im
|
||||
})
|
||||
.collect();
|
||||
let before: Vec<Vec<u8>> = (0..pages.len()).map(|p| render_page(&doc, p)).collect();
|
||||
let alone: usize = pages.iter().map(|text| pdfcraft_filters::encode_jbig2(text, w, h).unwrap().len()).sum();
|
||||
let settings = Settings { mono: MonoSettings { compression: MonoCompression::Jbig2, ..MonoSettings::REDUCE }, ..Settings::default() };
|
||||
let report = optimize(&mut doc, &settings).unwrap();
|
||||
let globals = globals_of(&doc, images[0]).expect("the first page names the globals");
|
||||
assert!(images.iter().all(|im| globals_of(&doc, *im) == Some(globals)), "every page names the same globals");
|
||||
let shared = stream(&doc, globals).raw.len() + images.iter().map(|im| stream(&doc, *im).raw.len()).sum::<usize>();
|
||||
assert!(shared * 4 < alone * 3, "shared {shared} bytes, alone {alone}");
|
||||
assert_eq!(report.image_bytes_after, shared);
|
||||
for (p, before) in before.iter().enumerate() {
|
||||
assert!(render_page(&doc, p) == *before, "page {p} looks the same");
|
||||
let s = stream(&doc, images[p]);
|
||||
assert_eq!(decoded_image(&doc, &s).unwrap(), pages[p], "page {p} decodes to its samples");
|
||||
}
|
||||
// Optimized again, each page would come out larger alone than it is beside the globals: the
|
||||
// sharing stays.
|
||||
let streams: Vec<Stream> = images.iter().map(|im| stream(&doc, *im)).collect();
|
||||
let again = optimize(&mut doc, &settings).unwrap();
|
||||
assert_eq!((again.images_recompressed, again.images_resampled), (0, 0));
|
||||
assert!(images.iter().zip(&streams).all(|(im, s)| stream(&doc, *im) == *s));
|
||||
}
|
||||
|
||||
/// Images share a dictionary only where that saves more than it takes: two pages of five small
|
||||
/// letters save less than their globals would take, and stay as they are coded alone.
|
||||
#[test]
|
||||
fn a_dictionary_that_saves_less_than_it_takes_isnt_shared() {
|
||||
let mut doc = Document::new_empty();
|
||||
let (w, h) = (600u32, 480u32);
|
||||
let images: Vec<ObjRef> = (1..=2u64)
|
||||
.map(|k| {
|
||||
let text = rendered_text_from(w, h, k.wrapping_mul(0x9E37_79B9_7F4A_7C15));
|
||||
let im = mono_image(&mut doc, w, h, &text, None, &[("BitsPerComponent", 1.into()), ("ColorSpace", Object::name("DeviceGray"))]);
|
||||
page(&mut doc, &[("Im", im)], "q 600 0 0 480 6 300 cm /Im Do Q");
|
||||
im
|
||||
})
|
||||
.collect();
|
||||
let settings = Settings { mono: MonoSettings { compression: MonoCompression::Jbig2, ..MonoSettings::REDUCE }, ..Settings::default() };
|
||||
let report = optimize(&mut doc, &settings).unwrap();
|
||||
assert_eq!(report.images_recompressed, 2);
|
||||
for im in &images {
|
||||
let s = stream(&doc, *im);
|
||||
assert_eq!((s.dict.name(b"Filter"), s.dict.contains(b"DecodeParms")), (Some(&b"JBIG2Decode"[..]), false));
|
||||
}
|
||||
// Optimized again, they code to what they are, no smaller: they stay.
|
||||
let streams: Vec<Stream> = images.iter().map(|im| stream(&doc, *im)).collect();
|
||||
assert_eq!(optimize(&mut doc, &settings).unwrap().images_recompressed, 0);
|
||||
assert!(images.iter().zip(&streams).all(|(im, s)| stream(&doc, *im) == *s));
|
||||
}
|
||||
|
||||
/// Only JBIG2 asked for shares: under Retain, JBIG2 pages drawn at 600 ppi are averaged and stored
|
||||
/// as JBIG2 again, each alone, as Retain changes nothing but their resolution.
|
||||
#[test]
|
||||
fn retained_jbig2_shares_nothing() {
|
||||
let mut doc = Document::new_empty();
|
||||
let (w, h) = (1200u32, 960u32);
|
||||
let images: Vec<ObjRef> = (1..=4u64)
|
||||
.map(|k| {
|
||||
let text = font_text(w, h, k.wrapping_mul(0x9E37_79B9_7F4A_7C15));
|
||||
let mut d = Dict::new();
|
||||
for (key, value) in [("Type", Object::name("XObject")), ("Subtype", Object::name("Image")), ("ColorSpace", Object::name("DeviceGray"))] {
|
||||
d.set(key.as_bytes().to_vec(), value);
|
||||
}
|
||||
for (key, value) in [("Width", i64::from(w)), ("Height", i64::from(h)), ("BitsPerComponent", 1)] {
|
||||
d.set(key.as_bytes().to_vec(), Object::Int(value));
|
||||
}
|
||||
d.set(b"Filter".to_vec(), Object::name("JBIG2Decode"));
|
||||
let im = doc.add(Object::Stream(Stream::from_raw(d, pdfcraft_filters::encode_jbig2(&text, w, h).unwrap())));
|
||||
// 1200 samples over 144 pt: 600 ppi.
|
||||
page(&mut doc, &[("Im", im)], "q 144 0 0 115.2 6 300 cm /Im Do Q");
|
||||
im
|
||||
})
|
||||
.collect();
|
||||
let settings = Settings { mono: MonoSettings { compression: MonoCompression::Retain, ..MonoSettings::REDUCE }, ..Settings::default() };
|
||||
assert_eq!(optimize(&mut doc, &settings).unwrap().images_resampled, 4);
|
||||
for im in images {
|
||||
let s = stream(&doc, im);
|
||||
assert_eq!((s.dict.name(b"Filter"), s.dict.contains(b"DecodeParms")), (Some(&b"JBIG2Decode"[..]), false));
|
||||
}
|
||||
}
|
||||
|
||||
/// Sixteen images at most share one dictionary, and two are enough: of eighteen, the first
|
||||
/// sixteen share one and the other two another.
|
||||
#[test]
|
||||
fn sixteen_images_at_most_share_a_dictionary() {
|
||||
let mut doc = Document::new_empty();
|
||||
let (w, h) = (600u32, 480u32);
|
||||
let texts: Vec<Vec<u8>> = (1..=18u64).map(|k| font_text(w, h, k.wrapping_mul(0x9E37_79B9_7F4A_7C15))).collect();
|
||||
let images: Vec<ObjRef> = texts
|
||||
.iter()
|
||||
.map(|text| {
|
||||
let im = mono_image(&mut doc, w, h, text, None, &[("BitsPerComponent", 1.into()), ("ColorSpace", Object::name("DeviceGray"))]);
|
||||
page(&mut doc, &[("Im", im)], "q 600 0 0 480 6 300 cm /Im Do Q");
|
||||
im
|
||||
})
|
||||
.collect();
|
||||
let settings = Settings { mono: MonoSettings { compression: MonoCompression::Jbig2, ..MonoSettings::REDUCE }, ..Settings::default() };
|
||||
optimize(&mut doc, &settings).unwrap();
|
||||
let globals: Vec<Option<ObjRef>> = images.iter().map(|im| globals_of(&doc, *im)).collect();
|
||||
assert!(globals.iter().all(Option::is_some), "{globals:?}");
|
||||
assert!(globals[..16].iter().all(|g| *g == globals[0]) && globals[16..].iter().all(|g| *g == globals[16]), "{globals:?}");
|
||||
assert_ne!(globals[0], globals[16]);
|
||||
for (k, (im, text)) in images.iter().zip(&texts).enumerate() {
|
||||
assert!(decoded_image(&doc, &stream(&doc, *im)).unwrap() == *text, "image {k} decodes to its samples");
|
||||
}
|
||||
}
|
||||
|
||||
/// A JBIG2 scan goes through Monochrome Images like any black-and-white image. Above 450 ppi it
|
||||
/// is averaged as its Flate copy is, to the same samples, and stored as each compression asks:
|
||||
/// Group 4 or JBIG2, or Flate when that is smaller, or under Retain JBIG2 again; alone or behind another
|
||||
@@ -3621,6 +3819,129 @@ fn indexed_thin_rules_survive_averaging_for_both_palette_orders_and_decodes() {
|
||||
}
|
||||
}
|
||||
|
||||
/// An image past what the JBIG2 decoder takes on a side stays as it is: JBIG2 can state the size,
|
||||
/// but PdfCraft's decoder refuses such a stream, so stored as JBIG2 it drew nothing here. At 65,535
|
||||
/// on a side, the same bars do become JBIG2, so the fixture does reach that choice, and the coding
|
||||
/// stored (symbols, here) reads back through that decoder.
|
||||
#[test]
|
||||
fn an_image_too_large_for_the_jbig2_decoder_stays_as_it_is() {
|
||||
for (w, h, stored) in
|
||||
[(65_535u32, 16u32, &b"JBIG2Decode"[..]), (16, 65_535, b"JBIG2Decode"), (65_536, 16, b"FlateDecode"), (16, 65_536, b"FlateDecode")]
|
||||
{
|
||||
let mut doc = Document::new_empty();
|
||||
let image = mono_image(&mut doc, w, h, &bars(w, h), None, &[("BitsPerComponent", 1.into()), ("ColorSpace", Object::name("DeviceGray"))]);
|
||||
page(&mut doc, &[("Im", image)], &format!("q {w} 0 0 {h} 0 0 cm /Im Do Q"));
|
||||
let before = stream(&doc, image).raw.clone();
|
||||
let settings =
|
||||
Settings { mono: MonoSettings { compression: MonoCompression::Jbig2, downsample: false, ..MonoSettings::REDUCE }, ..Settings::default() };
|
||||
optimize(&mut doc, &settings).unwrap();
|
||||
let s = stream(&doc, image);
|
||||
assert_eq!(s.dict.name(b"Filter"), Some(stored), "{w} × {h}");
|
||||
if stored == b"FlateDecode" {
|
||||
assert_eq!(s.raw, before, "{w} × {h}");
|
||||
} else {
|
||||
// The decoder gives padding bits as 0; the bars have them 1.
|
||||
let mut bits = bars(w, h);
|
||||
if w % 8 != 0 {
|
||||
for row in bits.chunks_mut((w as usize).div_ceil(8)) {
|
||||
if let Some(last) = row.last_mut() {
|
||||
*last &= 0xFFu8 << (8 - w % 8);
|
||||
}
|
||||
}
|
||||
}
|
||||
assert!(decoded_image(&doc, &s).unwrap() == bits, "{w} × {h} reads back");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The colour and grey steps leave an image over 80 million pixels as it is, whatever their settings
|
||||
/// (memory): 10,000 × 8,000 grey, the limit itself, drawn at 600 ppi, is resampled, and a row more
|
||||
/// stays as it is.
|
||||
#[test]
|
||||
fn grey_images_are_resampled_up_to_the_pixel_limit() {
|
||||
for (h, resampled) in [(8_000u32, true), (8_001, false)] {
|
||||
let mut doc = Document::new_empty();
|
||||
let grey = image(&mut doc, 10_000, h, 1, false, None);
|
||||
let before = stream(&doc, grey).raw.clone();
|
||||
let (pw, ph) = (10_000.0 * 72.0 / 600.0, f64::from(h) * 72.0 / 600.0);
|
||||
page(&mut doc, &[("G", grey)], &format!("q {pw} 0 0 {ph} 0 0 cm /G Do Q"));
|
||||
let report = optimize(&mut doc, &Settings::default()).unwrap();
|
||||
assert_eq!(report.images_resampled, usize::from(resampled), "10,000 × {h}: {report:?}");
|
||||
let s = stream(&doc, grey);
|
||||
if resampled {
|
||||
assert_eq!(s.dict.int(b"Width"), Some(2_500), "10,000 × {h}");
|
||||
} else {
|
||||
assert!(s.dict.int(b"Width") == Some(10_000) && s.raw == before, "10,000 × {h} stays as it is");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Dark bars of irregular lengths across the long side of a `w` × `h` 1-bit image, which Flate
|
||||
/// shrinks less than JBIG2.
|
||||
fn bars(w: u32, h: u32) -> Vec<u8> {
|
||||
let stride = (w as usize).div_ceil(8);
|
||||
let mut data = vec![0xFF; stride * h as usize];
|
||||
let mut state = 0x1234_5678u32;
|
||||
let mut next = move || {
|
||||
state ^= state << 13;
|
||||
state ^= state >> 17;
|
||||
state ^= state << 5;
|
||||
state as usize
|
||||
};
|
||||
let long = w.max(h) as usize;
|
||||
let mut at = 10;
|
||||
while at + 60 < long {
|
||||
let len = 5 + next() % 50;
|
||||
for along in at..at + len {
|
||||
for across in 0..12 {
|
||||
let (x, y) = if w > h { (along, across) } else { (across, along) };
|
||||
data[y * stride + x / 8] &= !(0x80 >> (x % 8));
|
||||
}
|
||||
}
|
||||
at += len + 5 + next() % 50;
|
||||
}
|
||||
data
|
||||
}
|
||||
|
||||
/// Past what the JBIG2 decoder takes on either side, an image packed from more bits, or one
|
||||
/// averaged to a size still past it, isn't stored as JBIG2 either: it becomes 1-bit Flate. Within
|
||||
/// the bound the same pictures do become JBIG2, so the fixtures reach that choice.
|
||||
#[test]
|
||||
fn what_is_too_large_for_jbig2_is_stored_another_way() {
|
||||
let settings = |downsample| Settings {
|
||||
mono: MonoSettings { compression: MonoCompression::Jbig2, downsample, ..MonoSettings::REDUCE },
|
||||
..Settings::default()
|
||||
};
|
||||
let (jbig2, flate) = (&b"JBIG2Decode"[..], &b"FlateDecode"[..]);
|
||||
// Eight-bit grey of only black and white, packed to one bit first, wide and tall.
|
||||
for (w, h, stored) in [(65_535u32, 16u32, jbig2), (65_536, 16, flate), (16, 65_535, jbig2), (16, 65_536, flate)] {
|
||||
let (bits, stride) = (bars(w, h), (w as usize).div_ceil(8));
|
||||
let grey: Vec<u8> = (0..h as usize)
|
||||
.flat_map(|y| (0..w as usize).map(move |x| (y, x)))
|
||||
.map(|(y, x)| if bits[y * stride + x / 8] & (0x80 >> (x % 8)) == 0 { 0 } else { 255 })
|
||||
.collect();
|
||||
let mut doc = Document::new_empty();
|
||||
let image = mono_image(&mut doc, w, h, &grey, None, &[("BitsPerComponent", 8.into()), ("ColorSpace", Object::name("DeviceGray"))]);
|
||||
page(&mut doc, &[("Im", image)], &format!("q {w} 0 0 {h} 0 0 cm /Im Do Q"));
|
||||
optimize(&mut doc, &settings(false)).unwrap();
|
||||
let s = stream(&doc, image);
|
||||
assert_eq!(s.dict.name(b"Filter"), Some(stored), "{w} × {h}, packed");
|
||||
assert_eq!(s.dict.int(b"BitsPerComponent"), Some(1), "{w} × {h}, packed");
|
||||
}
|
||||
// One bit, drawn at 600 ppi and averaged to 300: half the size, so 140,000 is still past it.
|
||||
for (w, h, stored) in [(70_000u32, 16u32, jbig2), (140_000, 16, flate), (16, 70_000, jbig2), (16, 140_000, flate)] {
|
||||
let mut doc = Document::new_empty();
|
||||
let image = mono_image(&mut doc, w, h, &bars(w, h), None, &[("BitsPerComponent", 1.into()), ("ColorSpace", Object::name("DeviceGray"))]);
|
||||
let (pw, ph) = (f64::from(w) * 72.0 / 600.0, f64::from(h) * 72.0 / 600.0);
|
||||
page(&mut doc, &[("Im", image)], &format!("q {pw} 0 0 {ph} 0 0 cm /Im Do Q"));
|
||||
optimize(&mut doc, &settings(true)).unwrap();
|
||||
let s = stream(&doc, image);
|
||||
assert_eq!(s.dict.name(b"Filter"), Some(stored), "{w} × {h}, averaged");
|
||||
assert_eq!(s.dict.int(b"BitsPerComponent"), Some(1), "{w} × {h}, averaged");
|
||||
assert_eq!((s.dict.int(b"Width"), s.dict.int(b"Height")), (Some(i64::from(w / 2)), Some(i64::from(h / 2))), "{w} × {h}, averaged");
|
||||
}
|
||||
}
|
||||
|
||||
/// An indexed image also drawn where the optimizer doesn't read (an annotation's appearance, where
|
||||
/// other default colour spaces may be in force and change which palette entry is darker) keeps its
|
||||
/// resolution, as black-and-white RGB keeps its colour space; drawn only on the page, it is
|
||||
|
||||
@@ -10,8 +10,9 @@
|
||||
use pdfcraft_content::{Matrix, overlaps};
|
||||
use pdfcraft_cos::{Dict, Document, ImageBudget, Object, Stream};
|
||||
|
||||
/// Most pixels an image may have to be cleared in place (larger ones are removed).
|
||||
const MAX_PIXELS: u64 = 64 << 20;
|
||||
/// Most pixels an image may have to be cleared in place (larger ones are removed), or to be stored
|
||||
/// again without shared `/JBIG2Globals` (see [`without_globals`]).
|
||||
const MAX_PIXELS: u64 = pdfcraft_cos::MAX_REDACTED_IMAGE_PIXELS;
|
||||
|
||||
fn components(doc: &Document, s: &Stream) -> Option<usize> {
|
||||
let cs = doc.resolve(s.dict.get(b"ColorSpace")?);
|
||||
|
||||
@@ -9127,3 +9127,271 @@ fn content_after_an_inline_image_holding_ei_is_still_read() {
|
||||
// `EI` inside the data was not taken for the end.
|
||||
assert!(page.contains("AFTER"), "the content after the image was lost: {page:?}");
|
||||
}
|
||||
|
||||
/// `/Crypt` has nothing to undo, so a chain naming it thousands of times costs no copy of the data
|
||||
/// for each. A chain of filters that does work has its own cost, which this isn't about.
|
||||
#[test]
|
||||
fn a_long_chain_of_crypt_filters_takes_no_time() {
|
||||
use super::*;
|
||||
let content = format!("1 0 0 rg 0 0 200 200 re f\n{}", " ".repeat(16 << 20));
|
||||
let chain = "/Crypt ".repeat(100_000);
|
||||
let pdf = format!(
|
||||
"%PDF-1.7\n1 0 obj << /Type /Catalog /Pages 2 0 R >> endobj\n\
|
||||
2 0 obj << /Type /Pages /Kids [3 0 R] /Count 1 >> endobj\n\
|
||||
3 0 obj << /Type /Page /Parent 2 0 R /MediaBox [0 0 200 200] /Contents 4 0 R >> endobj\n\
|
||||
4 0 obj << /Filter [{chain}] /Length {} >> stream\n{content}\nendstream endobj\n\
|
||||
trailer << /Root 1 0 R >>\n%%EOF",
|
||||
content.len()
|
||||
);
|
||||
let (done, finished) = std::sync::mpsc::channel();
|
||||
std::thread::spawn(move || {
|
||||
let page = PageRenderer::new(Arc::new(pdf.into_bytes()), RenderConfig::default()).render(RenderRequest {
|
||||
page: 0,
|
||||
kind: RequestKind::Pixels,
|
||||
tile: None,
|
||||
scale: 1.0,
|
||||
tag: 0,
|
||||
preview: false,
|
||||
});
|
||||
let start = (100 * page.width as usize + 100) * 4;
|
||||
let _ = done.send(page.rgba.get(start..start + 4).map(<[u8]>::to_vec));
|
||||
});
|
||||
// Skipped, this takes a moment; copied, 1.6 TB, which a margin this wide tells apart however
|
||||
// busy the machine.
|
||||
let pixel = finished.recv_timeout(std::time::Duration::from_secs(120)).expect("the chain costs no copy for each entry");
|
||||
assert_eq!(pixel, Some(vec![255, 0, 0, 255]));
|
||||
}
|
||||
|
||||
/// A lone filter takes its parameters as a dictionary or as an array of one, and given as an array
|
||||
/// of one itself it takes either too. The form of `/Filter` decided which was read, so a predictor
|
||||
/// in the other form was lost and the content came out as noise. `/StmF` and `/StrF` are optional,
|
||||
/// meaning `/Identity`: such a file didn't open at all, though a stream can still name a filter.
|
||||
#[test]
|
||||
fn a_filters_parameters_are_read_in_either_form() {
|
||||
use super::*;
|
||||
use pdfcraft_cos::{Algorithm, Dict, Document, NewEncryption, Object, SaveOptions, Stream, write_full, write_incremental};
|
||||
let content = b"1 0 0 rg 0 0 200 200 re f";
|
||||
let centre = |bytes: Vec<u8>| -> [u8; 4] {
|
||||
let page = PageRenderer::new(Arc::new(bytes), RenderConfig::default()).render(RenderRequest {
|
||||
page: 0,
|
||||
kind: RequestKind::Pixels,
|
||||
tile: None,
|
||||
scale: 1.0,
|
||||
tag: 0,
|
||||
preview: false,
|
||||
});
|
||||
let start = (100 * page.width as usize + 100) * 4;
|
||||
let mut pixel = [0; 4];
|
||||
pixel.copy_from_slice(page.rgba.get(start..start + 4).expect("centre pixel"));
|
||||
pixel
|
||||
};
|
||||
let page = |stream: &[u8]| {
|
||||
let mut pdf = b"%PDF-1.7\n1 0 obj << /Type /Catalog /Pages 2 0 R >> endobj\n2 0 obj << /Type /Pages /Kids [3 0 R] /Count 1 >> endobj\n3 0 obj << /Type /Page /Parent 2 0 R /MediaBox [0 0 200 200] /Contents 4 0 R >> endobj\n".to_vec();
|
||||
pdf.extend_from_slice(stream);
|
||||
pdf.extend_from_slice(b"\ntrailer << /Root 1 0 R >>\n%%EOF\n");
|
||||
pdf
|
||||
};
|
||||
// PNG Sub over one row, which reads as noise if it isn't undone.
|
||||
let mut rows = vec![1u8];
|
||||
let mut before = 0u8;
|
||||
for b in content {
|
||||
rows.push(b.wrapping_sub(before));
|
||||
before = *b;
|
||||
}
|
||||
let coded = Stream::flate(Dict::new(), &rows).raw;
|
||||
let parms = format!("<< /Predictor 11 /Columns {} >>", content.len());
|
||||
for (filter, decode_parms) in [
|
||||
("/FlateDecode", parms.clone()),
|
||||
("/FlateDecode", format!("[{parms}]")),
|
||||
("[/FlateDecode]", parms.clone()),
|
||||
("[/FlateDecode]", format!("[{parms}]")),
|
||||
] {
|
||||
let mut stream = format!("4 0 obj << /Filter {filter} /DecodeParms {decode_parms} /Length {} >> stream\n", coded.len()).into_bytes();
|
||||
stream.extend_from_slice(&coded);
|
||||
stream.extend_from_slice(b"\nendstream endobj");
|
||||
assert_eq!(centre(page(&stream)), [255, 0, 0, 255], "{filter} with {decode_parms}");
|
||||
}
|
||||
|
||||
let plain = format!("4 0 obj << /Length {} >> stream\n{}\nendstream endobj", content.len(), String::from_utf8_lossy(content));
|
||||
let mut doc = Document::open(Arc::new(page(plain.as_bytes()))).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm: Algorithm::Aes128,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [9; 32],
|
||||
})
|
||||
.unwrap();
|
||||
// No object streams: they would be encrypted under the /StmF about to go.
|
||||
let saved = write_full(&doc, &SaveOptions { object_streams: false, ..SaveOptions::default() }).unwrap();
|
||||
let mut doc = Document::open(Arc::new(saved)).unwrap();
|
||||
let encrypt = doc.trailer().reference(b"Encrypt").unwrap();
|
||||
doc.update_dict(encrypt, |e| {
|
||||
e.remove(b"StmF");
|
||||
e.remove(b"StrF");
|
||||
})
|
||||
.unwrap();
|
||||
let mut doc = Document::open(Arc::new(write_incremental(&doc, &SaveOptions::default()).unwrap())).unwrap();
|
||||
let catalog = doc.get(doc.root().unwrap());
|
||||
let pages = doc.get(catalog.as_dict().unwrap().reference(b"Pages").unwrap());
|
||||
let first = doc.resolve(&pages.as_dict().unwrap().get(b"Kids").unwrap().as_array().unwrap()[0]);
|
||||
let contents = first.as_dict().unwrap().reference(b"Contents").unwrap();
|
||||
let mut named = Dict::new();
|
||||
named.set(b"Name".to_vec(), Object::name("StdCF"));
|
||||
let mut dict = Dict::new();
|
||||
dict.set(b"Filter".to_vec(), Object::name("Crypt"));
|
||||
dict.set(b"DecodeParms".to_vec(), Object::Dict(named));
|
||||
doc.set(contents, Object::Stream(Stream::from_raw(dict, content.to_vec())));
|
||||
assert_eq!(centre(write_incremental(&doc, &SaveOptions::default()).unwrap()), [255, 0, 0, 255], "no /StmF, and a stream naming StdCF");
|
||||
}
|
||||
|
||||
/// A stream can pick its own crypt filter: `/Crypt` in `/Filter`, with the filter's name in
|
||||
/// `/DecodeParms`, or `/Identity` without one (ISO 32000-2 §7.4.10). The renderer used the
|
||||
/// document's filter for every stream, and then couldn't decode `/Crypt`, so the page stayed blank.
|
||||
#[test]
|
||||
fn a_stream_with_a_crypt_filter_of_its_own_is_drawn() {
|
||||
use super::*;
|
||||
use pdfcraft_cos::{Algorithm, Dict, Document, NewEncryption, Object, SaveOptions, Stream, write_full, write_incremental};
|
||||
let content = "1 0 0 rg 0 0 200 200 re f";
|
||||
let page = format!(
|
||||
"%PDF-1.7\n1 0 obj << /Type /Catalog /Pages 2 0 R >> endobj\n\
|
||||
2 0 obj << /Type /Pages /Kids [3 0 R] /Count 1 >> endobj\n\
|
||||
3 0 obj << /Type /Page /Parent 2 0 R /MediaBox [0 0 200 200] /Contents 4 0 R >> endobj\n\
|
||||
4 0 obj << /Length {} >> stream\n{content}\nendstream endobj\n\
|
||||
trailer << /Root 1 0 R >>\n%%EOF",
|
||||
content.len()
|
||||
);
|
||||
let centre = |bytes: Vec<u8>| -> [u8; 4] {
|
||||
let page = PageRenderer::new(Arc::new(bytes), RenderConfig::default()).render(RenderRequest {
|
||||
page: 0,
|
||||
kind: RequestKind::Pixels,
|
||||
tile: None,
|
||||
scale: 1.0,
|
||||
tag: 0,
|
||||
preview: false,
|
||||
});
|
||||
let start = (100 * page.width as usize + 100) * 4;
|
||||
let mut pixel = [0; 4];
|
||||
pixel.copy_from_slice(page.rgba.get(start..start + 4).expect("centre pixel"));
|
||||
pixel
|
||||
};
|
||||
let name = |n: &str| {
|
||||
let mut parms = Dict::new();
|
||||
parms.set(b"Name".to_vec(), Object::name(n));
|
||||
Object::Dict(parms)
|
||||
};
|
||||
let hex: String = content.bytes().map(|b| format!("{b:02X}")).chain([">".to_string()]).collect();
|
||||
let crypt = || Object::name("Crypt");
|
||||
let contents_of = |doc: &Document| {
|
||||
let catalog = doc.get(doc.root().unwrap());
|
||||
let pages = doc.get(catalog.as_dict().unwrap().reference(b"Pages").unwrap());
|
||||
let page = doc.resolve(&pages.as_dict().unwrap().get(b"Kids").unwrap().as_array().unwrap()[0]);
|
||||
page.as_dict().unwrap().reference(b"Contents").unwrap()
|
||||
};
|
||||
for (algorithm, filters) in [(Algorithm::Rc4_128, false), (Algorithm::Aes128, true), (Algorithm::Aes256, true)] {
|
||||
let mut doc = Document::open(Arc::new(page.clone().into_bytes())).unwrap();
|
||||
doc.set_encryption(&NewEncryption {
|
||||
algorithm,
|
||||
user_password: "",
|
||||
owner_password: "owner",
|
||||
permissions: -1,
|
||||
encrypt_metadata: true,
|
||||
seed: [9; 32],
|
||||
})
|
||||
.unwrap();
|
||||
let protected = write_full(&doc, &SaveOptions::default()).unwrap();
|
||||
assert_eq!(centre(protected.clone()), [255, 0, 0, 255], "{algorithm:?}: the document's own filter");
|
||||
// A filter of its own name that stores streams as they are, beside the document's.
|
||||
let mut doc = Document::open(Arc::new(protected)).unwrap();
|
||||
if filters {
|
||||
let encrypt = doc.trailer().reference(b"Encrypt").unwrap();
|
||||
doc.update_dict(encrypt, |e| {
|
||||
let Some(Object::Dict(cf)) = e.get(b"CF") else { panic!("no /CF") };
|
||||
let mut cf = cf.clone();
|
||||
let mut stored = Dict::new();
|
||||
stored.set(b"CFM".to_vec(), Object::name("None"));
|
||||
cf.set(b"Stored".to_vec(), Object::Dict(stored));
|
||||
// `/Identity` is never one of these, whatever a file says.
|
||||
let mut named = Dict::new();
|
||||
named.set(b"CFM".to_vec(), Object::name("AESV2"));
|
||||
cf.set(b"Identity".to_vec(), Object::Dict(named));
|
||||
e.set(b"CF".to_vec(), Object::Dict(cf));
|
||||
})
|
||||
.unwrap();
|
||||
}
|
||||
let protected = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
let spellings = [
|
||||
"no name",
|
||||
"/Identity",
|
||||
"StdCF",
|
||||
"Stored",
|
||||
"/DecodeParms by reference",
|
||||
"/Filter by reference",
|
||||
"an entry of /Filter by reference",
|
||||
"an entry of /DecodeParms by reference",
|
||||
"/Name by reference",
|
||||
"before another filter",
|
||||
"a lone dictionary for an array of one",
|
||||
"an array of one for a name",
|
||||
"a dictionary by reference for an array of one",
|
||||
"an array of one by reference for a dictionary",
|
||||
"a name by reference for an array",
|
||||
"a lone dictionary before another filter",
|
||||
"past the longest chain",
|
||||
];
|
||||
for what in spellings {
|
||||
let mut doc = Document::open(Arc::new(protected.clone())).unwrap();
|
||||
let (filter, parms) = match what {
|
||||
"no name" => (crypt(), None),
|
||||
"/Identity" => (crypt(), Some(name("Identity"))),
|
||||
"StdCF" => (crypt(), Some(name("StdCF"))),
|
||||
"Stored" => (crypt(), Some(name("Stored"))),
|
||||
"/DecodeParms by reference" => (crypt(), Some(Object::Ref(doc.add(name("StdCF"))))),
|
||||
"/Filter by reference" => (Object::Ref(doc.add(crypt())), Some(name("StdCF"))),
|
||||
"an entry of /Filter by reference" => (Object::Array(vec![Object::Ref(doc.add(crypt()))]), Some(Object::Array(vec![name("StdCF")]))),
|
||||
"an entry of /DecodeParms by reference" => {
|
||||
(Object::Array(vec![crypt()]), Some(Object::Array(vec![Object::Ref(doc.add(name("StdCF")))])))
|
||||
}
|
||||
"/Name by reference" => {
|
||||
let mut parms = Dict::new();
|
||||
parms.set(b"Name".to_vec(), Object::Ref(doc.add(Object::name("StdCF"))));
|
||||
(crypt(), Some(Object::Dict(parms)))
|
||||
}
|
||||
"a lone dictionary for an array of one" => (Object::Array(vec![crypt()]), Some(name("StdCF"))),
|
||||
"an array of one for a name" => (crypt(), Some(Object::Array(vec![name("StdCF")]))),
|
||||
"a dictionary by reference for an array of one" => (Object::Array(vec![crypt()]), Some(Object::Ref(doc.add(name("StdCF"))))),
|
||||
"an array of one by reference for a dictionary" => (Object::Ref(doc.add(Object::Array(vec![crypt()]))), Some(name("StdCF"))),
|
||||
"a name by reference for an array" => (Object::Ref(doc.add(crypt())), Some(Object::Array(vec![name("StdCF")]))),
|
||||
"a lone dictionary before another filter" => (Object::Array(vec![crypt(), Object::name("ASCIIHexDecode")]), Some(name("StdCF"))),
|
||||
// One filter more than cos decodes: it names none there, so here neither, and the
|
||||
// stream is read with the document's filter, not the `Stored` it says.
|
||||
"past the longest chain" => {
|
||||
let mut chain = vec![crypt()];
|
||||
chain.extend(std::iter::repeat_n(Object::name("ASCIIHexDecode"), 9));
|
||||
(Object::Array(chain), Some(Object::Array(vec![name("Stored")])))
|
||||
}
|
||||
_ => (Object::Array(vec![crypt(), Object::name("ASCIIHexDecode")]), Some(Object::Array(vec![name("StdCF"), Object::Null]))),
|
||||
};
|
||||
let contents = contents_of(&doc);
|
||||
let Object::Stream(s) = doc.get(contents).as_ref().clone() else { panic!("no content stream") };
|
||||
let mut dict = s.dict.clone();
|
||||
dict.set(b"Filter".to_vec(), filter);
|
||||
if let Some(parms) = parms {
|
||||
dict.set(b"DecodeParms".to_vec(), parms);
|
||||
}
|
||||
let raw = match what {
|
||||
"before another filter" | "a lone dictionary before another filter" => hex.clone().into_bytes(),
|
||||
"past the longest chain" => (0..9).fold(content.as_bytes().to_vec(), |data, _| {
|
||||
let mut coded: Vec<u8> = data.iter().flat_map(|b| format!("{b:02X}").into_bytes()).collect();
|
||||
coded.push(b'>');
|
||||
coded
|
||||
}),
|
||||
_ => content.as_bytes().to_vec(),
|
||||
};
|
||||
doc.set(contents, Object::Stream(Stream::from_raw(dict, raw)));
|
||||
let saved = write_incremental(&doc, &SaveOptions::default()).unwrap();
|
||||
assert_eq!(centre(saved), [255, 0, 0, 255], "{algorithm:?}: {what}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -14,6 +14,8 @@ craft-ui = { workspace = true }
|
||||
# The menus: native on macOS, an egui bar elsewhere, from one definition (menus.rs).
|
||||
craft-menu = { workspace = true }
|
||||
craft-keymap = { workspace = true }
|
||||
# Interface translations over the embedded craft-i18n catalogs (`build.rs`, `src/i18n.rs`).
|
||||
craft-i18n = { workspace = true }
|
||||
# Quit from the menus asks the window to close, so the unsaved-changes check runs; on macOS a window
|
||||
# close also quits through `terminate:` (the Touch Bar crash, #1136).
|
||||
craft-quit = { workspace = true, features = ["egui"] }
|
||||
|
||||
+84
-1
@@ -1,4 +1,5 @@
|
||||
//! Bake the contributor credits into the binary as static Rust tables. Nothing is read at run time.
|
||||
//! Bake the contributor credits into the binary as static Rust tables, and embed the craft-i18n
|
||||
//! interface catalogs. Nothing is read at run time.
|
||||
//!
|
||||
//! - contributors/contributors.json: commit stats per GitHub username, with a mark for whose people.toml
|
||||
//! entry is verified.
|
||||
@@ -6,6 +7,12 @@
|
||||
//! JSON says the entry was verified (`people_entry`).
|
||||
//!
|
||||
//! A missing or malformed file gives empty tables (or no names) and a warning.
|
||||
//!
|
||||
//! - `CRAFT_I18N_DIR`, a craft-i18n checkout (storytold/craft-i18n, at the SHA in
|
||||
//! `craft-i18n.rev`): `craft_i18n.rs` holds `CRAFT_I18N`, one (locale, shared catalog, PdfCraft
|
||||
//! catalog) entry per locale that has a `pdfcraft.tsv`. Unset, or not a checkout (a warning),
|
||||
//! it is empty and the interface is English only; with `CRAFT_I18N_REQUIRED=1` (CI and releases)
|
||||
//! that is an error instead. Recipe: craft-i18n's `docs/integration.md`.
|
||||
|
||||
use std::fmt::Write as _;
|
||||
|
||||
@@ -23,6 +30,82 @@ fn main() {
|
||||
if let Err(e) = std::fs::write(&out, generate(&json, &people)) {
|
||||
println!("cargo::warning=writing {}: {e}", out.display());
|
||||
}
|
||||
let out = out.with_file_name("craft_i18n.rs");
|
||||
if let Err(e) = std::fs::write(&out, craft_i18n()) {
|
||||
println!("cargo::error=writing {}: {e}", out.display());
|
||||
}
|
||||
}
|
||||
|
||||
/// The catalog this app reads in each locale: `locales/<locale>/pdfcraft.tsv`.
|
||||
const APP_CATALOG: &str = "pdfcraft.tsv";
|
||||
|
||||
/// `CRAFT_I18N` from `CRAFT_I18N_DIR`: the `Embedded` list the craft-i18n crate reads.
|
||||
fn craft_i18n() -> String {
|
||||
println!("cargo::rerun-if-env-changed=CRAFT_I18N_DIR");
|
||||
println!("cargo::rerun-if-env-changed=CRAFT_I18N_REQUIRED");
|
||||
let required = std::env::var("CRAFT_I18N_REQUIRED").is_ok_and(|v| v.trim() == "1");
|
||||
let entries = match std::env::var_os("CRAFT_I18N_DIR").filter(|d| !d.is_empty()) {
|
||||
// Not canonicalized: on Windows that gives `\\?\C:\…`, which `include_str!` can't read.
|
||||
Some(dir) => match locales(&std::path::PathBuf::from(dir).join("locales")) {
|
||||
Ok(entries) => entries,
|
||||
Err(e) => {
|
||||
let level = if required { "error" } else { "warning" };
|
||||
println!("cargo::{level}=CRAFT_I18N_DIR: {e}; the interface is English only");
|
||||
Vec::new()
|
||||
}
|
||||
},
|
||||
None => {
|
||||
if required {
|
||||
println!("cargo::error=CRAFT_I18N_REQUIRED=1 but CRAFT_I18N_DIR is unset: a release must embed the translations");
|
||||
}
|
||||
Vec::new()
|
||||
}
|
||||
};
|
||||
let mut o = String::from("/// (locale, shared catalog, PdfCraft's catalog), one entry per locale; `\"\"` for a missing file.\n");
|
||||
o.push_str("pub static CRAFT_I18N: &craft_i18n::Embedded = &[\n");
|
||||
for (code, shared, app) in entries {
|
||||
// `{:?}` escapes the path (Windows backslashes) as a Rust string literal.
|
||||
let shared = shared.map_or_else(|| "\"\"".to_string(), |p| format!("include_str!({p:?})"));
|
||||
let _ = writeln!(o, " ({code:?}, {shared}, include_str!({app:?})),");
|
||||
}
|
||||
o.push_str("];\n");
|
||||
o
|
||||
}
|
||||
|
||||
/// One embedded locale: its code, its `common.tsv` if it has one, and its PdfCraft catalog.
|
||||
type Locale = (String, Option<std::path::PathBuf>, std::path::PathBuf);
|
||||
|
||||
/// Every locale under `dir` with PdfCraft's catalog, by code. An error when `dir` isn't a
|
||||
/// craft-i18n `locales/` directory.
|
||||
fn locales(dir: &std::path::Path) -> Result<Vec<Locale>, String> {
|
||||
// Build scripts run in the crate's directory and `include_str!` resolves against the
|
||||
// generated file, so a relative path would mean two different places.
|
||||
if !dir.is_absolute() {
|
||||
return Err(format!("{} is not an absolute path", dir.display()));
|
||||
}
|
||||
// Before read_dir, so a checkout that appears later reruns the script.
|
||||
println!("cargo::rerun-if-changed={}", dir.display());
|
||||
let list = std::fs::read_dir(dir).map_err(|e| format!("{} is not a craft-i18n checkout ({e})", dir.display()))?;
|
||||
let mut out = Vec::new();
|
||||
for entry in list.flatten() {
|
||||
let path = entry.path();
|
||||
let Some(code) = path.file_name().and_then(|n| n.to_str()).map(str::to_string) else { continue };
|
||||
let app = path.join(APP_CATALOG);
|
||||
if !app.is_file() {
|
||||
continue;
|
||||
}
|
||||
println!("cargo::rerun-if-changed={}", app.display());
|
||||
let shared = Some(path.join("common.tsv")).filter(|p| p.is_file());
|
||||
if let Some(p) = &shared {
|
||||
println!("cargo::rerun-if-changed={}", p.display());
|
||||
}
|
||||
out.push((code, shared, app));
|
||||
}
|
||||
if out.is_empty() {
|
||||
return Err(format!("{} has no locale with a {APP_CATALOG}", dir.display()));
|
||||
}
|
||||
out.sort();
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
fn read<T>(path: &std::path::Path, fallback: &str, parse: impl Fn(&str) -> Result<T, String>) -> Option<T> {
|
||||
|
||||
+233
-912
File diff suppressed because it is too large.
Load diff
@@ -24,14 +24,6 @@ pub(crate) fn signature_badges(signatures: &[pdfcraft_engine::SignatureInfo], pa
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Suppression window for egui's eased copy of point input.
|
||||
///
|
||||
/// egui 0.36.2 drains `WheelState::after_events` tail deltas by 90% per 0.1 s.
|
||||
pub(super) const SUPPRESS_SECS: f64 = 0.25;
|
||||
|
||||
/// Short rolling extension while egui still has an unprocessed wheel tail.
|
||||
pub(super) const SUPPRESS_TAIL_SECS: f64 = 0.05;
|
||||
|
||||
// Keep the viewer's scroll identity tied to the document instead of its parent UI. Without
|
||||
// `fades` (Show Page Edge Shadows off) the viewport-edge gradients are off for this area only.
|
||||
pub(super) fn page_scroll<R>(
|
||||
|
||||
@@ -39,8 +39,21 @@ pub(super) const THUMB_H: f32 = 320.0;
|
||||
|
||||
pub(super) const THUMB_BYTES: usize = 24 * 1024 * 1024;
|
||||
|
||||
/// The smallest whole-page allowance ([`page_budget`]).
|
||||
pub(super) const PAGE_BYTES: usize = 128 * 1024 * 1024;
|
||||
|
||||
/// The largest whole-page allowance ([`page_budget`]).
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
const MAX_PAGE_BYTES: usize = 384 * 1024 * 1024;
|
||||
|
||||
/// The web build's largest whole-page allowance ([`page_budget`]).
|
||||
#[cfg(target_arch = "wasm32")]
|
||||
const MAX_PAGE_BYTES: usize = 256 * 1024 * 1024;
|
||||
|
||||
/// Rasters the size of the largest whole page on screen that the allowance holds between its
|
||||
/// limits: the pages on screen and the pages just behind and ahead of them.
|
||||
const BUDGET_PAGES: usize = 8;
|
||||
|
||||
pub(super) const TILE_BYTES: usize = 128 * 1024 * 1024;
|
||||
|
||||
const UPLOAD_BYTES_PER_FRAME: usize = 16 * 1024 * 1024;
|
||||
@@ -105,6 +118,14 @@ pub(super) fn thumbnail_scale(width: f32, height: f32, density: f32) -> f32 {
|
||||
(THUMB_W / width.max(1.0)).min(THUMB_H / height.max(1.0)) * density
|
||||
}
|
||||
|
||||
/// The whole-page byte allowance when the largest whole-page raster on screen takes `largest`
|
||||
/// bytes: [`BUDGET_PAGES`] such rasters, kept between [`PAGE_BYTES`] and [`MAX_PAGE_BYTES`].
|
||||
/// The raster's size follows the zoom, the display density and the page; a tiled page is on
|
||||
/// screen as a small backdrop, so it does not raise the allowance.
|
||||
pub(super) fn page_budget(largest: usize) -> usize {
|
||||
largest.saturating_mul(BUDGET_PAGES).clamp(PAGE_BYTES, MAX_PAGE_BYTES)
|
||||
}
|
||||
|
||||
impl DocView {
|
||||
pub fn raster_memory(&self) -> RasterMemory {
|
||||
RasterMemory {
|
||||
@@ -137,6 +158,13 @@ impl DocView {
|
||||
k
|
||||
}
|
||||
|
||||
/// The pages with a cached whole-page raster, in page order (diagnostics and tests).
|
||||
pub fn cached_pages_debug(&self) -> Vec<usize> {
|
||||
let mut pages: Vec<usize> = self.pages.keys().copied().collect();
|
||||
pages.sort_unstable();
|
||||
pages
|
||||
}
|
||||
|
||||
/// Re-render every page and text layer (the document's appearance changed, e.g. a layer
|
||||
/// was toggled). Out-of-date rasters stay on screen until their replacements arrive, so the
|
||||
/// view never flashes blank.
|
||||
@@ -341,6 +369,17 @@ impl DocView {
|
||||
let mut tile_tags = HashSet::new();
|
||||
let mut grid = Vec::new();
|
||||
let (mut page_bytes, mut tile_bytes) = (0usize, 0usize);
|
||||
let demand = requests
|
||||
.iter()
|
||||
.filter(|r| {
|
||||
r.kind == RequestKind::Pixels && r.tile.is_none() && r.tag & (GRID_TAG | PRINT_TAG) == 0 && self.frame_visible.contains(&r.page)
|
||||
})
|
||||
.filter_map(|r| {
|
||||
let p = info.pages.get(r.page)?;
|
||||
Some(rgba_bytes(device_pixels(p.width, r.scale) as usize, device_pixels(p.height, r.scale) as usize))
|
||||
})
|
||||
.fold(0, usize::max);
|
||||
let page_limit = self.on_screen_page_budget(demand, None);
|
||||
for req in requests.iter().filter(|r| r.kind == RequestKind::Pixels) {
|
||||
let Some(p) = info.pages.get(req.page) else { continue };
|
||||
// Organize-grid renders: only the cells in view that need one (organize_grid).
|
||||
@@ -373,7 +412,7 @@ impl DocView {
|
||||
}
|
||||
} else {
|
||||
let bytes = rgba_bytes(device_pixels(p.width, req.scale) as usize, device_pixels(p.height, req.scale) as usize);
|
||||
if (!visible && (page_bytes.saturating_add(bytes) > PAGE_BYTES || pages.len() >= MAX_CACHED_PAGES)) || !pages.insert(req.page) {
|
||||
if (!visible && (page_bytes.saturating_add(bytes) > page_limit || pages.len() >= MAX_CACHED_PAGES)) || !pages.insert(req.page) {
|
||||
continue;
|
||||
}
|
||||
page_bytes = page_bytes.saturating_add(bytes);
|
||||
@@ -386,10 +425,11 @@ impl DocView {
|
||||
// current page first, so turning back a page shows it at once instead of rendering.
|
||||
let mut undemanded: Vec<usize> = self.pages.keys().copied().filter(|p| !pages.contains(p)).collect();
|
||||
undemanded.sort_by_key(|p| p.abs_diff(self.current));
|
||||
self.frame_demanded = pages.clone();
|
||||
let mut kept = pages.len();
|
||||
for page in undemanded {
|
||||
let bytes = self.pages.get(&page).map_or(0, |p| texture_bytes(&p.tex));
|
||||
if kept < MAX_CACHED_PAGES && page_bytes.saturating_add(bytes) <= PAGE_BYTES {
|
||||
if kept < MAX_CACHED_PAGES && page_bytes.saturating_add(bytes) <= page_limit {
|
||||
page_bytes = page_bytes.saturating_add(bytes);
|
||||
kept += 1;
|
||||
pages.insert(page);
|
||||
@@ -631,14 +671,21 @@ impl DocView {
|
||||
visible || bytes <= TILE_BYTES.saturating_sub(retained)
|
||||
} else {
|
||||
let thumb = req.tag & THUMB_TAG != 0;
|
||||
let (cache, limit) = if thumb { (&mut self.thumbs, THUMB_BYTES) } else { (&mut self.pages, PAGE_BYTES) };
|
||||
let page_limit = self.on_screen_page_budget(if visible { bytes } else { 0 }, Some(req.page));
|
||||
let (cache, limit) = if thumb { (&mut self.thumbs, THUMB_BYTES) } else { (&mut self.pages, page_limit) };
|
||||
cache.remove(&req.page);
|
||||
let mut retained = cache.values().fold(0usize, |n, p| n.saturating_add(texture_bytes(&p.tex)));
|
||||
// A zoom/DPI change can temporarily retain larger stale images than the new
|
||||
// demand estimates. Evict those first, then let the current demand refill them.
|
||||
let on_screen = |p: &usize| !thumb && self.frame_visible.contains(p);
|
||||
while retained.saturating_add(bytes) > limit {
|
||||
let Some(page) = cache.keys().copied().filter(|p| !on_screen(p)).max_by_key(|p| p.abs_diff(self.current)) else { break };
|
||||
// Pages this frame does not ask for go first, then those behind the scroll, the
|
||||
// farthest from the current page first.
|
||||
let evict_order = |p: &usize| {
|
||||
let demanded = !thumb && self.frame_demanded.contains(p);
|
||||
(!demanded, !thumb && super::behind_scroll(self.continuous, self.scroll_dir, self.current, *p), p.abs_diff(self.current))
|
||||
};
|
||||
let Some(page) = cache.keys().copied().filter(|p| !on_screen(p)).max_by_key(evict_order) else { break };
|
||||
if let Some(old) = cache.remove(&page) {
|
||||
retained = retained.saturating_sub(texture_bytes(&old.tex));
|
||||
}
|
||||
@@ -653,6 +700,19 @@ impl DocView {
|
||||
self.zoom * PT * ppp
|
||||
}
|
||||
|
||||
/// The whole-page allowance ([`page_budget`]) for the larger of `demand` and the rasters held
|
||||
/// for the pages on screen other than `except`. A held raster counts while a zoom hold keeps
|
||||
/// it on screen without a request.
|
||||
fn on_screen_page_budget(&self, demand: usize, except: Option<usize>) -> usize {
|
||||
page_budget(
|
||||
self.pages
|
||||
.iter()
|
||||
.filter(|(p, _)| Some(**p) != except && self.frame_visible.contains(p))
|
||||
.map(|(_, p)| texture_bytes(&p.tex))
|
||||
.fold(demand, usize::max),
|
||||
)
|
||||
}
|
||||
|
||||
/// Set whether the print preview rasters become luminance before upload. Toggling it drops
|
||||
/// the colour previews: new requests carry the grayscale tag, so stale ones are replaced.
|
||||
pub(crate) fn set_print_grayscale(&mut self, grayscale: bool) {
|
||||
|
||||
@@ -27,10 +27,12 @@ pub(crate) struct CropPageInput<'a> {
|
||||
pub(crate) info: &'a DocInfo,
|
||||
pub(crate) view: &'a mut DocView,
|
||||
pub(crate) allowed: bool,
|
||||
/// Nobody holds the press, and it began on this page: the tool's.
|
||||
pub(crate) free: bool,
|
||||
}
|
||||
|
||||
pub(crate) fn page_input(ui: &egui::Ui, input: CropPageInput<'_>) -> bool {
|
||||
let CropPageInput { resp, xf, ptr, page, info, view, allowed } = input;
|
||||
let CropPageInput { resp, xf, ptr, page, info, view, allowed, free } = input;
|
||||
let (pointer, origin) = (ptr.pos, ptr.origin);
|
||||
if pointer.is_some_and(|p| xf.rect.contains(p)) {
|
||||
view.cursor.claim(Layer::ToolArea, if allowed { egui::CursorIcon::Crosshair } else { egui::CursorIcon::NotAllowed });
|
||||
@@ -38,9 +40,9 @@ pub(crate) fn page_input(ui: &egui::Ui, input: CropPageInput<'_>) -> bool {
|
||||
if !allowed {
|
||||
return false;
|
||||
}
|
||||
// The tool's own press, of the primary button: nothing drawn over the page here holds it.
|
||||
// The tool's own press, of the primary button: one nobody holds.
|
||||
if resp.drag_started_by(egui::PointerButton::Primary)
|
||||
&& view.router.owner(page).is_none()
|
||||
&& free
|
||||
&& let Some(o) = origin.filter(|o| xf.rect.contains(*o))
|
||||
{
|
||||
view.crop_drag = Some((page, o));
|
||||
|
||||
@@ -0,0 +1,900 @@
|
||||
//! Page input: what the tools do with the pointer on one page, what lies under it for the page
|
||||
//! router, the text layer, and what is drawn over the page after its text.
|
||||
|
||||
use egui::{Color32, CornerRadius, Pos2, Rect, Stroke, vec2};
|
||||
use pdfcraft_render::{DocInfo, PageText};
|
||||
|
||||
use super::{DocView, PageEnv, PageFrame, PageSlot, PageXform, Selection, Span, cached_edit_images, click_unit, signature_badges};
|
||||
use crate::page_cursor::{Layer, Subject};
|
||||
use crate::page_pointer::PagePointer;
|
||||
use crate::page_router::{Owner, PagePress, top};
|
||||
use crate::{QuickTool, comments, icons};
|
||||
|
||||
/// What the page's tools did with the pointer this frame.
|
||||
pub(super) struct PageInput {
|
||||
/// A tool, a field or a comment took the pointer: text selection must leave it alone.
|
||||
pub(super) consumed: bool,
|
||||
/// Redact or Highlight draws boxes off text.
|
||||
pub(super) area_tool: bool,
|
||||
/// What a press under the pointer would take (the top hit there), for hover painting.
|
||||
pub(super) hover: Option<crate::page_router::Hit>,
|
||||
/// The press's click came up over what the press began on: a link's or a field's click counts
|
||||
/// only then, as a button's does.
|
||||
pub(super) released_over: bool,
|
||||
}
|
||||
|
||||
/// Common geometry and pointer state for a tool acting on one page.
|
||||
#[derive(Clone, Copy)]
|
||||
pub(crate) struct PageToolContext<'a> {
|
||||
pub ui: &'a egui::Ui,
|
||||
pub resp: &'a egui::Response,
|
||||
pub xf: &'a PageXform,
|
||||
pub ptr: &'a PagePointer,
|
||||
pub page: usize,
|
||||
pub doc: &'a pdfcraft_engine::Document,
|
||||
pub info: &'a DocInfo,
|
||||
}
|
||||
|
||||
/// The tools' input on one page. The hits at the press point decide who holds the press, and the
|
||||
/// modules are told what the press is to this page (`PagePress`): their own, nobody's (the active
|
||||
/// tool's: `tool_input`, and the tools still called here), or another page's. The Edit text group
|
||||
/// still asks the router, until it is told too. Text selection runs after, on what nobody took.
|
||||
pub(super) fn page_tool_input(ui: &mut egui::Ui, view: &mut DocView, frame: &mut PageFrame<'_>, slot: &PageSlot) -> PageInput {
|
||||
let PageEnv {
|
||||
added,
|
||||
allowed,
|
||||
can_fill,
|
||||
can_modify,
|
||||
comments_hidden,
|
||||
doc,
|
||||
doc_links,
|
||||
editing_content,
|
||||
form,
|
||||
info,
|
||||
prefs,
|
||||
preparing,
|
||||
redact_mark,
|
||||
table_preview,
|
||||
text_style,
|
||||
tool,
|
||||
..
|
||||
} = frame.env;
|
||||
let PageSlot { i, xf, .. } = *slot;
|
||||
let PageFrame { resp, ptr, pointer, .. } = *frame;
|
||||
let cx = PageToolContext { ui, resp, xf: &xf, ptr, page: i, doc, info };
|
||||
let pcx = comments::PageCx { page: i, xf: &xf, ptr, info, tool, prefs, allowed, hidden: comments_hidden, redact_mark };
|
||||
let (lines, images) =
|
||||
if matches!(tool, QuickTool::AddText | QuickTool::EditText) && can_modify { edit_inventory(view, doc, i) } else { Default::default() };
|
||||
let field_tool = match tool {
|
||||
QuickTool::Field(f) => Some(f),
|
||||
_ => None,
|
||||
};
|
||||
// While a table is being set up, nothing else is drawn or moved.
|
||||
let prepare_allowed = can_modify && table_preview.is_none() && frame.out.open_table.is_none();
|
||||
let hits = PageHits {
|
||||
page: i,
|
||||
xf: &xf,
|
||||
info,
|
||||
tool,
|
||||
pcx: &pcx,
|
||||
form,
|
||||
can_fill,
|
||||
can_modify,
|
||||
editing_content,
|
||||
preparing,
|
||||
field_tool,
|
||||
prepare_allowed,
|
||||
added,
|
||||
doc_links,
|
||||
lines: &lines,
|
||||
images: &images,
|
||||
clip: ui.clip_rect(),
|
||||
};
|
||||
if let Some(o) = ptr.pressed().filter(|o| xf.rect.contains(*o)) {
|
||||
let at = hits.at(view, o);
|
||||
view.router.press(i, at, tool);
|
||||
}
|
||||
// What this page has to do with the press: its owner's, the active tool's, or another page's.
|
||||
let press = view.router.press_for(i);
|
||||
// What lies under the pointer before the tools act, on the frames that need it: for a click's
|
||||
// release, a right-click's tool checks, and Fill & Sign's preview.
|
||||
let wants_under = resp.clicked() || resp.secondary_clicked() || matches!(tool, QuickTool::Fill(_)) && !ptr.any_down;
|
||||
let under = pointer.filter(|p| wants_under && xf.rect.contains(*p)).map(|p| hits.at(view, p)).unwrap_or_default();
|
||||
let released_over = match press {
|
||||
PagePress::Mine(owner) if resp.clicked() => under.iter().any(|h| h.owner == owner),
|
||||
_ => false,
|
||||
};
|
||||
// A right-click while the primary button is held (a comment moved, a box drawn) leaves the
|
||||
// selections that press acts on alone. egui ends the press's own interaction when any button is
|
||||
// released, the right-click's own frame included, so the button is what tells. A touch's long
|
||||
// press, which egui reports as a right-click with the finger still down, opens its menu.
|
||||
let press_held = ptr.primary_down && !resp.long_touched();
|
||||
let context = frame.right_click_on(xf.rect).and_then(|p| right_click(&hits, &under, view, p, press_held));
|
||||
// A mark already placed takes its own press (comments, below), as does one being moved on this
|
||||
// page until its move ends; with no button down the Fill & Sign tool's preview hides where a
|
||||
// press would be taken (a mark, its handles, a Prepare field).
|
||||
let over_mark = matches!(tool, QuickTool::Fill(_))
|
||||
&& (matches!(press, PagePress::Mine(_)) || comments::moving_on(view, i) || !ptr.any_down && top(under.iter().cloned(), tool).is_some());
|
||||
tool_input(ui, view, frame, slot, &pcx, press, over_mark);
|
||||
let on_field = if preparing {
|
||||
let o = crate::prepare::page_input(cx, form, field_tool, prepare_allowed, press, view);
|
||||
frame.out.field_props |= o.properties;
|
||||
frame.out.field_placed |= o.placed;
|
||||
frame.out.open_table = frame.out.open_table.or(o.table);
|
||||
o.consumed || field_tool.is_some()
|
||||
} else {
|
||||
tool == QuickTool::Select && crate::forms_ui::page_input(cx, form, can_fill, press, released_over, view)
|
||||
};
|
||||
// Redact draws boxes off text; so does Highlight (an area highlight, as in Acrobat).
|
||||
let area_tool = tool == QuickTool::Redact && can_modify || tool == QuickTool::Comment(comments::CommentTool::Highlight) && allowed;
|
||||
let boxing = area_tool && {
|
||||
let text = view.page_text(i);
|
||||
let over_text = |p: Pos2| {
|
||||
let (vx, vy) = xf.screen_to_view(p);
|
||||
text.as_ref().is_some_and(|t| t.glyphs.iter().any(|g| vx >= g.rect[0] && vx <= g.rect[2] && vy >= g.rect[1] && vy <= g.rect[3]))
|
||||
};
|
||||
crate::redact_ui::page_input(cx, over_text, press == PagePress::Free, view)
|
||||
};
|
||||
let on_objects = tool == QuickTool::EditText && can_modify && crate::object_ui::page_input(cx, view);
|
||||
// Add text acts on the page's own paragraphs over them, and on the one its press was on until
|
||||
// the button is up: a drag that leaves the box still ends, and no new box takes it over.
|
||||
let over_source = tool == QuickTool::AddText
|
||||
&& (matches!(view.router.owner(i), Some(crate::page_router::Owner::Paragraph { .. }))
|
||||
|| pointer.is_some_and(|p| {
|
||||
!crate::content_ui::hits_added(&xf, info, i, added, p) && crate::edit_text_ui::over_paragraph(&xf, info, i, &lines, p)
|
||||
}));
|
||||
let source_blocked = over_source && view.content.hold_blocked();
|
||||
if over_source && resp.clicked() && !source_blocked {
|
||||
if let Some(edit) = view.content.finish_draft(added) {
|
||||
view.pending_edit = Some(edit);
|
||||
}
|
||||
view.content.selected = None;
|
||||
}
|
||||
let on_content = !on_objects && editing_content && can_modify && {
|
||||
source_blocked
|
||||
|| crate::content_ui::page_input(
|
||||
cx,
|
||||
added,
|
||||
tool == QuickTool::AddText && !over_source,
|
||||
matches!(tool, QuickTool::AddText | QuickTool::EditText),
|
||||
text_style,
|
||||
view,
|
||||
)
|
||||
|| tool == QuickTool::AddText && !over_source
|
||||
};
|
||||
// Added content owns its gesture; its source text must not queue a second edit.
|
||||
// Edit text & images boxes every paragraph and image whenever the tool is on. Only the
|
||||
// input waits while selected objects or added content own the pointer, or while page
|
||||
// input is blocked (another tab, a dialog, the window unfocused): the boxes stay drawn
|
||||
// instead of vanishing until the pointer comes back.
|
||||
let others_own_pointer = on_objects || on_content;
|
||||
let on_edit_text = (tool == QuickTool::EditText || over_source) && can_modify && {
|
||||
// Editable text takes precedence over background/overlapping artwork. Both
|
||||
// inventories are painted every frame, even when text owns the pointer.
|
||||
let text_used = crate::edit_text_ui::page_input(cx, &lines, view, !others_own_pointer);
|
||||
let image_cx = crate::edit_text_ui::ImageCx {
|
||||
ui,
|
||||
resp,
|
||||
xf: &xf,
|
||||
ptr,
|
||||
page: i,
|
||||
info,
|
||||
allow_interaction: !others_own_pointer && (matches!(view.router.owner(i), Some(crate::page_router::Owner::Picture { .. })) || !text_used),
|
||||
};
|
||||
let image_used = crate::edit_text_ui::image_input(&image_cx, &images, view);
|
||||
!others_own_pointer && (text_used || image_used)
|
||||
};
|
||||
if tool == QuickTool::EditText {
|
||||
if others_own_pointer {
|
||||
if ptr.pressed().is_some() || resp.clicked() || resp.secondary_clicked() {
|
||||
view.image_selection = None;
|
||||
}
|
||||
} else {
|
||||
crate::content_ui::sync_image_selection(view, i, &images, added);
|
||||
}
|
||||
}
|
||||
let (link_owner, link_context) = (link_of(press.owner()), link_of(context));
|
||||
let on_link = tool == QuickTool::Link && can_modify && crate::link_ui::page_input(cx, press == PagePress::Free, link_owner, link_context, view);
|
||||
if tool == QuickTool::Select
|
||||
&& can_modify
|
||||
&& let Some(index) = link_context
|
||||
{
|
||||
view.links.context = Some((i, index));
|
||||
}
|
||||
// Comments, every frame: their own presses, a commenting tool's, and a click elsewhere that
|
||||
// leaves them unselected. A press nobody holds that another tool took this frame (Prepare's
|
||||
// selection rectangle, added content, which still decide for themselves) is not also a
|
||||
// commenting tool's, as before.
|
||||
let taken = on_objects || on_edit_text || on_link || on_content || boxing || on_field;
|
||||
let on_comment = comments::page_input(ui, resp, &pcx, press, taken, view);
|
||||
let consumed = taken || on_comment;
|
||||
let hover = pointer.and_then(|p| claim_under(&hits, view, p, frame.env.unobstructed));
|
||||
PageInput { consumed, area_tool, hover, released_over }
|
||||
}
|
||||
|
||||
/// What lies under the pointer at `p`, after the tools act: its top, what a press there would take,
|
||||
/// for hover painting. With `claim` (nothing drawn over the pages, such as the palette), its cursor
|
||||
/// and tip too, after the tools claimed theirs (the last claim on a layer stands).
|
||||
fn claim_under(hits: &PageHits<'_>, view: &mut DocView, p: Pos2, claim: bool) -> Option<crate::page_router::Hit> {
|
||||
let under = hits.at(view, p);
|
||||
if claim {
|
||||
for h in &under {
|
||||
view.cursor.claim_with_tip(h.layer, h.icon, h.tip.clone());
|
||||
}
|
||||
}
|
||||
top(under, hits.tool)
|
||||
}
|
||||
|
||||
/// The link `owner` is, by its `/Annots` index.
|
||||
fn link_of(owner: Option<Owner>) -> Option<usize> {
|
||||
match owner {
|
||||
Some(Owner::Link { index }) => Some(index),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
/// The active tool's own input on page `i`: the one gate for presses nobody holds. Measure, the
|
||||
/// stamps, Fill & Sign, Sign area, zoom and snapshot, the camera's quadrilateral and crop act only
|
||||
/// on a press that began on this page and that no hit won (`press` is Free), and keep their cursor
|
||||
/// and gestures. The camera also drags a corner whose press it holds, and crop's double-click
|
||||
/// opens Set Page Boxes wherever it is. `over_mark`: with Fill & Sign, a hit holds the press (a
|
||||
/// mark's, or a Prepare field's), a mark is being moved on this page, or with no button down a press
|
||||
/// under the pointer would be taken (a mark, its handles, a Prepare field).
|
||||
fn tool_input(
|
||||
ui: &egui::Ui,
|
||||
view: &mut DocView,
|
||||
frame: &mut PageFrame<'_>,
|
||||
slot: &PageSlot,
|
||||
pcx: &comments::PageCx<'_>,
|
||||
press: PagePress,
|
||||
over_mark: bool,
|
||||
) {
|
||||
let PageEnv {
|
||||
allowed,
|
||||
author,
|
||||
by_line,
|
||||
can_crop,
|
||||
can_modify,
|
||||
custom_stamp,
|
||||
date_text,
|
||||
doc,
|
||||
info,
|
||||
initials,
|
||||
signature,
|
||||
tool,
|
||||
units,
|
||||
fill_text_size,
|
||||
fill_text_color,
|
||||
..
|
||||
} = frame.env;
|
||||
let PageSlot { i, xf, .. } = *slot;
|
||||
let PageFrame { resp, ptr, .. } = *frame;
|
||||
let cx = PageToolContext { ui, resp, xf: &xf, ptr, page: i, doc, info };
|
||||
let free = press == PagePress::Free;
|
||||
if let QuickTool::Measure(measure_tool) = tool {
|
||||
crate::measure_ui::page_input(ui, crate::measure_ui::Clicks::of(resp, free), doc, view, pcx, measure_tool, units);
|
||||
}
|
||||
if let QuickTool::Stamp(kind) = tool
|
||||
&& allowed
|
||||
&& crate::stamps_ui::place(cx, kind, by_line, author, free, view)
|
||||
{
|
||||
frame.out.stamp_placed = true;
|
||||
}
|
||||
if let Some(cs) = custom_stamp.as_ref()
|
||||
&& allowed
|
||||
&& crate::stamps_ui::place_custom(cx, cs, author, free, view)
|
||||
{
|
||||
frame.out.stamp_placed = true;
|
||||
}
|
||||
if let QuickTool::Fill(ft) = tool
|
||||
&& allowed
|
||||
&& !over_mark
|
||||
{
|
||||
let input = crate::fill_sign::PageInput {
|
||||
tool: ft,
|
||||
text_size: fill_text_size,
|
||||
text_color: fill_text_color,
|
||||
signature: signature.as_ref(),
|
||||
initials: initials.as_ref(),
|
||||
preview: frame.signature_preview,
|
||||
author,
|
||||
date_text,
|
||||
};
|
||||
match crate::fill_sign::page_input(cx, input, free, view) {
|
||||
Some(crate::fill_sign::FillAction::Edit(e)) => view.pending_edit = Some(*e),
|
||||
Some(crate::fill_sign::FillAction::Signature(e)) => {
|
||||
view.pending_edit = Some(*e);
|
||||
view.fill_signature_page = Some(i);
|
||||
}
|
||||
Some(crate::fill_sign::FillAction::CreateSignature) => frame.out.open_signature = true,
|
||||
Some(crate::fill_sign::FillAction::CreateInitials) => frame.out.open_initials = true,
|
||||
Some(crate::fill_sign::FillAction::Refused(why)) => frame.out.refused = Some(why),
|
||||
None => {}
|
||||
}
|
||||
}
|
||||
if matches!(tool, QuickTool::SignArea { .. }) {
|
||||
crate::sign_ui::page_input(cx, free, view);
|
||||
}
|
||||
if matches!(tool, QuickTool::MarqueeZoom | QuickTool::Snapshot) {
|
||||
crate::zoom_snap::page_input(ui, resp, &xf, ptr, i, free, view);
|
||||
}
|
||||
if tool == QuickTool::EnhanceCamera {
|
||||
crate::camera_ui::page_input(resp, &xf, ptr, i, view, can_modify, press);
|
||||
}
|
||||
if tool == QuickTool::Crop
|
||||
&& crate::crop::page_input(ui, crate::crop::CropPageInput { resp, xf: &xf, ptr, page: i, info, view, allowed: can_crop, free })
|
||||
{
|
||||
view.current = i;
|
||||
frame.out.open_boxes = true;
|
||||
}
|
||||
}
|
||||
|
||||
/// A right-click at `p`: the page's menu opens there, and it goes to what lies on top there
|
||||
/// ([`PageHits::context_at`]), which the menu then acts on. A comment there is selected, and none
|
||||
/// elsewhere; a Prepare field is selected; links take theirs from what this returns.
|
||||
/// `under`: the hits at `p` before the tools act. `press_held`: the primary button is held, and the
|
||||
/// comment and Prepare selections its press acts on are left alone until its release; links still
|
||||
/// take theirs, as before.
|
||||
fn right_click(hits: &PageHits<'_>, under: &[crate::page_router::Hit], view: &mut DocView, p: Pos2, press_held: bool) -> Option<Owner> {
|
||||
let context = hits.context_at(view, p, under);
|
||||
// Delete page, Paste and Copy Image act where the menu opened, whoever takes the right-click.
|
||||
comments::anchor(hits.pcx, p, view);
|
||||
if press_held {
|
||||
return context;
|
||||
}
|
||||
// Add text takes every right-click on a page it can change, Edit text those on its own
|
||||
// paragraphs and pictures (the objects selected together, and crop mode's picture, among them),
|
||||
// the Link tool those on a link, and a Prepare field tool the whole page, as before: comments
|
||||
// see none of them.
|
||||
let tool_takes_it = match hits.tool {
|
||||
QuickTool::AddText => hits.can_modify,
|
||||
QuickTool::EditText => under.iter().any(|h| matches!(h.owner, Owner::Paragraph { .. } | Owner::Picture { .. } | Owner::Objects { .. })),
|
||||
QuickTool::Link => hits.can_modify && matches!(context, Some(Owner::Link { .. })),
|
||||
_ => hits.field_tool.is_some(),
|
||||
};
|
||||
if !tool_takes_it {
|
||||
let comment = match context {
|
||||
Some(Owner::Comment { index, .. }) => Some(index),
|
||||
_ => None,
|
||||
};
|
||||
comments::context(hits.pcx, comment, view);
|
||||
}
|
||||
if let Some(Owner::PrepareField { field, widget }) = context {
|
||||
crate::prepare::context(hits.form, field, widget, view);
|
||||
}
|
||||
context
|
||||
}
|
||||
|
||||
/// Edit text's paragraphs and pictures on page `i`, kept while the document is unchanged.
|
||||
fn edit_inventory(
|
||||
view: &mut DocView,
|
||||
doc: &pdfcraft_engine::Document,
|
||||
i: usize,
|
||||
) -> (Vec<pdfcraft_engine::TextBlock>, Vec<pdfcraft_engine::PageImage>) {
|
||||
let generation = doc.edit_generation();
|
||||
let lines = match view.edit_lines.get(&i) {
|
||||
Some((g, l)) if *g == generation => l.clone(),
|
||||
_ => {
|
||||
let l = doc.text_blocks(i);
|
||||
view.edit_lines.insert(i, (generation, l.clone()));
|
||||
l
|
||||
}
|
||||
};
|
||||
let images = cached_edit_images(view, doc, i).to_vec();
|
||||
(lines, images)
|
||||
}
|
||||
|
||||
/// What the page modules have under a point on one page, for the page router.
|
||||
struct PageHits<'a> {
|
||||
page: usize,
|
||||
xf: &'a PageXform,
|
||||
info: &'a DocInfo,
|
||||
tool: QuickTool,
|
||||
pcx: &'a comments::PageCx<'a>,
|
||||
form: &'a [pdfcraft_engine::FormField],
|
||||
can_fill: bool,
|
||||
can_modify: bool,
|
||||
/// Edit a PDF is open: added text and pictures can be picked up.
|
||||
editing_content: bool,
|
||||
preparing: bool,
|
||||
field_tool: Option<crate::prepare::FieldTool>,
|
||||
/// Prepare may draw and move fields (not while a table is being set up).
|
||||
prepare_allowed: bool,
|
||||
added: &'a [pdfcraft_engine::Added],
|
||||
/// The document's links, as the engine lists them (the Link tool edits every one).
|
||||
doc_links: &'a [pdfcraft_engine::LinkItem],
|
||||
lines: &'a [pdfcraft_engine::TextBlock],
|
||||
images: &'a [pdfcraft_engine::PageImage],
|
||||
/// The pages' visible area (the picture's rotate knob stays inside it).
|
||||
clip: Rect,
|
||||
}
|
||||
|
||||
impl PageHits<'_> {
|
||||
/// The hits at `p`, bottom up ([`Self::hits`]).
|
||||
fn at(&self, view: &DocView, p: Pos2) -> Vec<crate::page_router::Hit> {
|
||||
self.hits(view, p, false)
|
||||
}
|
||||
|
||||
/// What a right-click at `p` is on: what lies on top there, as for a press, but with every
|
||||
/// tool reaching comments and links, as a comment's menu shows whatever the tool. A highlight
|
||||
/// over a link is the highlight's ([`comments::context_hit`]).
|
||||
/// The Link tool edits links and reaches no comment: on a document it can change, its
|
||||
/// right-click is what its press there would take (`under`, the hits at `p`), when that is
|
||||
/// anything.
|
||||
fn context_at(&self, view: &DocView, p: Pos2, under: &[crate::page_router::Hit]) -> Option<Owner> {
|
||||
if self.tool == QuickTool::Link
|
||||
&& self.can_modify
|
||||
&& let Some(press) = top(under.iter().cloned(), QuickTool::Link)
|
||||
{
|
||||
return Some(press.owner);
|
||||
}
|
||||
top(self.hits(view, p, true), QuickTool::Select).map(|h| h.owner)
|
||||
}
|
||||
|
||||
/// The hits at `p`, bottom up: links, comments; Edit text's pictures under its paragraphs (text
|
||||
/// on top of artwork takes the press), added content, the objects selected together and the
|
||||
/// open paragraph's frame, the selected picture's grips over them all; the camera tool's corners;
|
||||
/// then form fields (Prepare's, being moved, over the comments; filled ones under added content
|
||||
/// and the comments that move). In crop mode, only the picture being cropped.
|
||||
/// For a right-click (`context`), comments by [`comments::context_hit`], and no camera corner (it
|
||||
/// has no menu).
|
||||
fn hits(&self, view: &DocView, p: Pos2, context: bool) -> Vec<crate::page_router::Hit> {
|
||||
let PageHits {
|
||||
page,
|
||||
xf,
|
||||
info,
|
||||
tool,
|
||||
pcx,
|
||||
form,
|
||||
can_fill,
|
||||
can_modify,
|
||||
editing_content,
|
||||
preparing,
|
||||
field_tool,
|
||||
prepare_allowed,
|
||||
added,
|
||||
doc_links,
|
||||
lines,
|
||||
images,
|
||||
clip,
|
||||
} = *self;
|
||||
// Crop mode owns every press on its page (`edit_text_ui::crop_hit`).
|
||||
if tool == QuickTool::EditText
|
||||
&& can_modify
|
||||
&& let Some(crop) = crate::edit_text_ui::crop_hit(view, page)
|
||||
{
|
||||
return vec![crop];
|
||||
}
|
||||
let fields = if preparing {
|
||||
crate::prepare::hit(xf, info, page, form, field_tool, prepare_allowed, &view.prepare, p)
|
||||
} else if tool == QuickTool::Select {
|
||||
crate::forms_ui::hit(xf, info, page, form, can_fill, p)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
// With Add text, only the paragraphs and pictures not under added content.
|
||||
let editing =
|
||||
can_modify && (tool == QuickTool::EditText || tool == QuickTool::AddText && !crate::content_ui::hits_added(xf, info, page, added, p));
|
||||
let (pictures, paragraphs, objects, grips) = if editing {
|
||||
let open = view.line_editor.as_ref().filter(|e| e.page == page);
|
||||
let frame = open
|
||||
.filter(|e| !e.has_changes())
|
||||
.and_then(|e| lines.get(e.block))
|
||||
.map(|l| xf.user_rect(info, page, l.rect.map(|v| v as f32)).expand(2.0));
|
||||
// Add text acts on the page's paragraphs only in their boxes, edges included (it
|
||||
// finishes the box being typed there, `over_source`): not on pictures, nor beside a
|
||||
// paragraph, where a click starts a new box.
|
||||
let edit_text = tool == QuickTool::EditText;
|
||||
let on_paragraphs = edit_text || crate::edit_text_ui::over_paragraph(xf, info, page, lines, p);
|
||||
(
|
||||
edit_text.then(|| crate::edit_text_ui::picture_hit(xf, page, info, images, view, p)).flatten(),
|
||||
on_paragraphs.then(|| crate::edit_text_ui::hit(xf, info, page, lines, open.map(|e| e.block), p)).flatten(),
|
||||
edit_text.then(|| crate::object_ui::hit(view, xf, info, page, frame, p)).flatten(),
|
||||
edit_text.then(|| crate::edit_text_ui::picture_handle_hit(clip, xf, page, info, images, view, p)).flatten(),
|
||||
)
|
||||
} else {
|
||||
(None, None, None, None)
|
||||
};
|
||||
// Added text and pictures, over the page's own paragraphs and under the objects selected
|
||||
// together.
|
||||
let picks_up = matches!(tool, QuickTool::Select | QuickTool::AddText | QuickTool::EditText);
|
||||
let added = (editing_content && can_modify && picks_up).then(|| crate::content_ui::hit(xf, info, page, added, view, p)).flatten();
|
||||
let corner = (!context && tool == QuickTool::EnhanceCamera && can_modify).then(|| crate::camera_ui::hit(xf, page, view, p)).flatten();
|
||||
let link = crate::link_ui::hit(xf, info, page, doc_links, tool, p);
|
||||
let comment = if context { comments::context_hit(pcx, p) } else { comments::hit(pcx, view, p, link.is_some()) };
|
||||
[link, comment, pictures, paragraphs, added, objects, grips, corner, fields].into_iter().flatten().collect()
|
||||
}
|
||||
}
|
||||
|
||||
/// Text layer: find matches, selection, I-beam and drag-to-select.
|
||||
pub(super) fn text_layer(ui: &mut egui::Ui, view: &mut DocView, frame: &mut PageFrame<'_>, slot: &PageSlot, input: &PageInput) {
|
||||
let PageEnv { info, selects_text, tool, .. } = frame.env;
|
||||
let PageSlot { i, r, xf } = *slot;
|
||||
let PageFrame { resp, ptr, pointer, .. } = *frame;
|
||||
if let Some(text) = view.texts.get(&i).cloned() {
|
||||
paint_text_marks(ui, view, &text, i, xf, resp.dragged());
|
||||
if selects_text
|
||||
&& !input.consumed
|
||||
&& let Some(p) = pointer.filter(|p| r.contains(*p))
|
||||
{
|
||||
text_pointer_input(ui, view, &text, TextPointer { page: i, xf, rect: r, info, tool, resp, ptr: ptr.clone(), pointer: p });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn paint_text_marks(ui: &egui::Ui, view: &DocView, text: &PageText, page: usize, xf: PageXform, dragging: bool) {
|
||||
let painter = ui.painter();
|
||||
let to_screen = |g: [f32; 4]| xf.view_rect(g);
|
||||
if let Some(find) = &view.find {
|
||||
for (index, (match_page, range)) in find.matches.iter().enumerate() {
|
||||
if *match_page != page {
|
||||
continue;
|
||||
}
|
||||
let fill = if find.current == Some(index) {
|
||||
Color32::from_rgba_unmultiplied(255, 140, 0, 110)
|
||||
} else {
|
||||
Color32::from_rgba_unmultiplied(255, 214, 0, 90)
|
||||
};
|
||||
for line_rect in text.line_rects(range.clone()) {
|
||||
painter.rect_filled(to_screen(line_rect).expand(1.0), CornerRadius::same(2), fill);
|
||||
}
|
||||
}
|
||||
}
|
||||
if view.all_text {
|
||||
for line_rect in text.line_rects(0..text.glyphs.len()) {
|
||||
painter.rect_filled(to_screen(line_rect), CornerRadius::same(1), Color32::from_rgba_unmultiplied(0x3A, 0x7B, 0xF0, 70));
|
||||
}
|
||||
}
|
||||
if let Some(selection) = view.selection.filter(|selection| selection.page == page) {
|
||||
for line_rect in selection.rects(text) {
|
||||
painter.rect_filled(to_screen(line_rect), CornerRadius::same(1), Color32::from_rgba_unmultiplied(0x3A, 0x7B, 0xF0, 70));
|
||||
}
|
||||
if let Span::Column { rect } = selection.span
|
||||
&& dragging
|
||||
{
|
||||
let outline = Stroke::new(1.0, Color32::from_rgb(0x3A, 0x7B, 0xF0));
|
||||
painter.rect_stroke(to_screen(rect), CornerRadius::ZERO, outline, egui::StrokeKind::Middle);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
struct TextPointer<'a> {
|
||||
page: usize,
|
||||
xf: PageXform,
|
||||
rect: Rect,
|
||||
info: &'a DocInfo,
|
||||
tool: QuickTool,
|
||||
resp: &'a egui::Response,
|
||||
ptr: PagePointer,
|
||||
pointer: Pos2,
|
||||
}
|
||||
|
||||
struct TextGesture<'a> {
|
||||
page: usize,
|
||||
xf: PageXform,
|
||||
rect: Rect,
|
||||
tool: QuickTool,
|
||||
ptr: PagePointer,
|
||||
resp: &'a egui::Response,
|
||||
pointer: Pos2,
|
||||
vx: f32,
|
||||
vy: f32,
|
||||
over_text: bool,
|
||||
over_link: bool,
|
||||
column: bool,
|
||||
}
|
||||
|
||||
fn text_pointer_input(ui: &mut egui::Ui, view: &mut DocView, text: &PageText, pointer: TextPointer<'_>) {
|
||||
let TextPointer { page, xf, rect, info, tool, resp, ptr, pointer: screen_pointer } = pointer;
|
||||
let (vx, vy) = xf.screen_to_view(screen_pointer);
|
||||
let over_text = text.glyphs.iter().any(|glyph| vx >= glyph.rect[0] && vx <= glyph.rect[2] && vy >= glyph.rect[1] && vy <= glyph.rect[3]);
|
||||
let over_link = info.links.iter().any(|link| link.page == page && xf.user_rect(info, page, link.rect).contains(screen_pointer));
|
||||
let column = tool == QuickTool::ColumnSelect || ui.input(|input| input.modifiers.alt);
|
||||
let gesture = TextGesture { page, xf, rect, tool, ptr, resp, pointer: screen_pointer, vx, vy, over_text, over_link, column };
|
||||
update_text_cursor(view, &gesture);
|
||||
update_selection_on_press(ui, view, text, &gesture);
|
||||
update_dragged_selection(view, text, &gesture);
|
||||
finish_text_pointer_gesture(ui, view, text, &gesture);
|
||||
}
|
||||
|
||||
fn update_text_cursor(view: &mut DocView, gesture: &TextGesture<'_>) {
|
||||
// A press on a link selects nothing (it is the link's), so no cursor here says it would.
|
||||
if gesture.column && !gesture.over_link {
|
||||
view.cursor.claim(Layer::Text, egui::CursorIcon::Crosshair);
|
||||
} else if gesture.over_text && !gesture.over_link {
|
||||
view.cursor.claim(Layer::Text, egui::CursorIcon::Text);
|
||||
}
|
||||
}
|
||||
|
||||
fn update_selection_on_press(ui: &egui::Ui, view: &mut DocView, text: &PageText, gesture: &TextGesture<'_>) {
|
||||
// A press held by what keeps its drag (a link, a comment that moves) selects no text; one on
|
||||
// text markup lets its drag select the text underneath.
|
||||
let press_here = gesture.ptr.origin.is_some_and(|origin| gesture.rect.contains(origin));
|
||||
if gesture.ptr.pressed().is_some() && press_here && !view.router.keeps_drag() {
|
||||
let now = ui.input(|input| input.time);
|
||||
let (max_delay, max_dist) = ui.ctx().options(|options| (options.input_options.max_double_click_delay, options.input_options.max_click_dist));
|
||||
let consecutive = now - view.last_press_time <= max_delay && view.last_press_pos.is_some_and(|pos| pos.distance(gesture.pointer) <= max_dist);
|
||||
view.clicks = if consecutive { view.clicks.saturating_add(1) } else { 1 };
|
||||
view.last_press_time = now;
|
||||
view.last_press_pos = Some(gesture.pointer);
|
||||
let clicks = selection_click_count(view.clicks, gesture.tool);
|
||||
if clicks >= 2
|
||||
&& gesture.over_text
|
||||
&& let Some((first, last)) = text.nearest(gesture.vx, gesture.vy).and_then(|anchor| click_unit(text, clicks, anchor))
|
||||
{
|
||||
view.selection = Some(Selection::run(gesture.page, first, last));
|
||||
}
|
||||
}
|
||||
if gesture.resp.drag_started() && press_here && !view.router.keeps_drag() {
|
||||
view.actions_dismissed = None;
|
||||
view.selection_drag = true;
|
||||
let origin = gesture.ptr.origin.unwrap_or(gesture.pointer);
|
||||
let (ox, oy) = gesture.xf.screen_to_view(origin);
|
||||
if view.clicks < 2 {
|
||||
view.selection = if gesture.column {
|
||||
Some(Selection { page: gesture.page, span: Span::Column { rect: [ox, oy, gesture.vx, gesture.vy] } })
|
||||
} else {
|
||||
text.nearest(ox, oy).map(|anchor| Selection::run(gesture.page, anchor, anchor))
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn selection_click_count(clicks: u32, tool: QuickTool) -> u32 {
|
||||
if clicks > 2 && tool != QuickTool::Select { 1 } else { clicks }
|
||||
}
|
||||
|
||||
fn update_dragged_selection(view: &mut DocView, text: &PageText, gesture: &TextGesture<'_>) {
|
||||
let clicks = selection_click_count(view.clicks, gesture.tool);
|
||||
if gesture.resp.dragged()
|
||||
&& let Some(selection) = view.selection.as_mut().filter(|selection| selection.page == gesture.page)
|
||||
{
|
||||
match &mut selection.span {
|
||||
Span::Run { anchor, head } if clicks >= 2 => {
|
||||
if let Some(hit) = text.nearest(gesture.vx, gesture.vy)
|
||||
&& let Some((first, last)) = click_unit(text, clicks, *anchor)
|
||||
{
|
||||
let (to_first, to_last) = click_unit(text, clicks, hit).unwrap_or((hit, hit));
|
||||
(*anchor, *head) = if to_first < first { (last, to_first) } else { (first, to_last.max(last)) };
|
||||
}
|
||||
}
|
||||
Span::Run { head, .. } => {
|
||||
if let Some(hit) = text.nearest(gesture.vx, gesture.vy) {
|
||||
*head = hit;
|
||||
}
|
||||
}
|
||||
Span::Column { rect } => {
|
||||
rect[2] = gesture.vx;
|
||||
rect[3] = gesture.vy;
|
||||
}
|
||||
}
|
||||
}
|
||||
if gesture.resp.drag_stopped()
|
||||
&& view.selection.is_some_and(|selection| {
|
||||
selection.page == gesture.page && matches!(selection.span, Span::Column { .. }) && selection.text(text).is_empty()
|
||||
})
|
||||
{
|
||||
view.selection = None;
|
||||
}
|
||||
}
|
||||
|
||||
fn finish_text_pointer_gesture(ui: &egui::Ui, view: &mut DocView, text: &PageText, gesture: &TextGesture<'_>) {
|
||||
let release_clicks = if gesture.resp.triple_clicked() {
|
||||
view.clicks.max(2).saturating_add(1)
|
||||
} else if gesture.resp.double_clicked() {
|
||||
view.clicks.max(2)
|
||||
} else {
|
||||
0
|
||||
};
|
||||
if release_clicks > 0 {
|
||||
view.clicks = release_clicks;
|
||||
}
|
||||
let clicks = selection_click_count(view.clicks, gesture.tool);
|
||||
if release_clicks > 0
|
||||
&& clicks >= 2
|
||||
&& gesture.over_text
|
||||
&& view.selection.is_none()
|
||||
&& let Some((first, last)) = text.nearest(gesture.vx, gesture.vy).and_then(|anchor| click_unit(text, clicks, anchor))
|
||||
{
|
||||
view.selection = Some(Selection::run(gesture.page, first, last));
|
||||
} else if gesture.resp.clicked() && view.clicks < 2 && !view.router.keeps_drag() {
|
||||
let shift = ui.input(|input| input.modifiers.shift);
|
||||
match (
|
||||
view.selection.as_mut().filter(|selection| shift && selection.page == gesture.page).map(|selection| &mut selection.span),
|
||||
text.nearest(gesture.vx, gesture.vy),
|
||||
) {
|
||||
(Some(Span::Run { head, .. }), Some(hit)) => *head = hit,
|
||||
_ => view.selection = None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Everything drawn over the page after its text: pictures, comments, content, links, fields, marks
|
||||
/// and badges.
|
||||
pub(super) fn page_overlays(ui: &mut egui::Ui, view: &mut DocView, frame: &mut PageFrame<'_>, slot: &PageSlot, input: &PageInput) {
|
||||
let PageEnv {
|
||||
added,
|
||||
allowed,
|
||||
calc_order,
|
||||
can_modify,
|
||||
comments_hidden,
|
||||
doc,
|
||||
doc_links,
|
||||
editing_content,
|
||||
form,
|
||||
generation,
|
||||
info,
|
||||
prefs,
|
||||
preparing,
|
||||
redact_mark,
|
||||
table_preview,
|
||||
tool,
|
||||
unobstructed,
|
||||
..
|
||||
} = frame.env;
|
||||
let PageSlot { i, xf, .. } = *slot;
|
||||
let PageFrame { resp, ptr, pointer, .. } = *frame;
|
||||
let painter = ui.painter();
|
||||
let tool_cx = PageToolContext { ui, resp, xf: &xf, ptr, page: i, doc, info };
|
||||
let pcx = comments::PageCx { page: i, xf: &xf, ptr, info, tool, prefs, allowed, hidden: comments_hidden, redact_mark };
|
||||
if tool == QuickTool::Select && !input.consumed {
|
||||
crate::image_pick::page_input(resp, &xf, i, info, doc, pointer, view);
|
||||
}
|
||||
crate::image_pick::drop_stale(doc, view);
|
||||
crate::image_pick::paint(painter, &xf, i, info, view);
|
||||
// A cancelled press ends no selection: no markup or redaction is made from it.
|
||||
if !view.press_cancelled {
|
||||
comments::page_after_text(resp, &pcx, view);
|
||||
if tool == QuickTool::Redact && can_modify {
|
||||
crate::redact_ui::after_text(resp, i, info, view);
|
||||
}
|
||||
}
|
||||
if input.area_tool {
|
||||
crate::redact_ui::paint(painter, i, view, pointer);
|
||||
}
|
||||
comments::paint_page(ui, painter, &pcx, view, input.hover.as_ref());
|
||||
if editing_content {
|
||||
crate::content_ui::paint_page(painter, &xf, i, info, added, view, pointer);
|
||||
}
|
||||
if tool == QuickTool::EditText {
|
||||
crate::object_ui::paint(painter, &xf, i, info, &view.objects);
|
||||
}
|
||||
if tool == QuickTool::EnhanceCamera {
|
||||
crate::camera_ui::paint(painter, &xf, i, view);
|
||||
}
|
||||
if tool == QuickTool::Link {
|
||||
crate::link_ui::paint(painter, &xf, i, info, doc_links, view, pointer);
|
||||
}
|
||||
if preparing {
|
||||
crate::prepare::paint_page(tool_cx, form, view);
|
||||
if let Some(preview) = &table_preview {
|
||||
crate::field_table_ui::paint_preview(painter, &xf, i, preview);
|
||||
}
|
||||
if calc_order {
|
||||
let selected = view.prepare.selected.as_ref().map(|(name, _)| name.as_str());
|
||||
if let Some(field) = crate::calc_order_ui::paint_page(tool_cx, form, &view.calc_order, generation, selected) {
|
||||
frame.calc_hover = Some(field);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
crate::forms_ui::paint_page(painter, &xf, i, info, form, view, input.hover.as_ref());
|
||||
crate::forms_ui::tooltip(resp, form, input.hover.as_ref());
|
||||
}
|
||||
|
||||
// Form-field highlight (Acrobat's "Highlight existing fields"); required fields get a
|
||||
// red border. Radio buttons and round XFA check boxes are round, and so is theirs (as
|
||||
// in Acrobat). Only what can be filled is marked: a read-only widget (its field's, or a
|
||||
// radio button's own) is left as it is drawn.
|
||||
paint_field_highlights(painter, &xf, info, form.as_slice(), i, view.highlight_fields);
|
||||
// Links: the hand and the link's target, which count only for the tools that follow or
|
||||
// edit links (`Layer::reached_by`). Tips draw above the palette, so none shows while it is
|
||||
// open, even beside it. A click follows the link its press was on, released over it: one that
|
||||
// slips off the link first follows nothing, as a button's does.
|
||||
if unobstructed
|
||||
&& resp.clicked()
|
||||
&& tool == QuickTool::Select
|
||||
&& !input.consumed
|
||||
&& let Some(Owner::Link { index }) = view.router.owner(i)
|
||||
&& input.released_over
|
||||
&& let Some(l) = info.links.iter().find(|l| l.page == i && l.index == index)
|
||||
{
|
||||
frame.out.clicked_link = Some(l.target.clone());
|
||||
}
|
||||
// Comments say what they are with any tool, beside its cursor, as Acrobat's do.
|
||||
comments::describe(&pcx, view);
|
||||
for (mp, mr, mc) in &view.compare_marks {
|
||||
if *mp == i {
|
||||
let sr = xf.user_rect(info, i, *mr).expand(1.5);
|
||||
painter.rect_filled(sr, CornerRadius::same(2), mc.gamma_multiply(0.28));
|
||||
}
|
||||
}
|
||||
if let Some((fp, fr, t0)) = view.flash
|
||||
&& fp == i
|
||||
{
|
||||
let now = ui.input(|inp| inp.time);
|
||||
let t0 = if t0 == 0.0 { now } else { t0 };
|
||||
view.flash = Some((fp, fr, t0));
|
||||
let age = (now - t0) as f32;
|
||||
if age < 1.6 {
|
||||
let a = ((1.6 - age) / 1.6 * 255.0) as u8;
|
||||
let sr = xf.user_rect(info, i, fr).expand(4.0);
|
||||
painter.rect_stroke(
|
||||
sr,
|
||||
CornerRadius::same(3),
|
||||
Stroke::new(2.5, Color32::from_rgba_unmultiplied(0x1B, 0x63, 0xE0, a)),
|
||||
egui::StrokeKind::Outside,
|
||||
);
|
||||
ui.ctx().request_repaint();
|
||||
} else {
|
||||
view.flash = None;
|
||||
}
|
||||
}
|
||||
// Validation is viewer chrome over the signer's original artwork, which
|
||||
// may still say "Signature Not Verified". These badges never enter document
|
||||
// streams, image/text exports, vector printing or Print as Image.
|
||||
for badge in signature_badges(&doc.signatures, i) {
|
||||
let [x0, y0, x1, y1] = badge.rect;
|
||||
let sr = xf.user_rect(info, i, [x0 as f32, y0 as f32, x1 as f32, y1 as f32]);
|
||||
let (icon, color) = crate::sign_ui::signature_status_style(badge.status);
|
||||
painter.rect_stroke(sr, CornerRadius::same(2), Stroke::new(1.5, color), egui::StrokeKind::Outside);
|
||||
// A widget too small for the mark keeps its outline: the verdict still shows.
|
||||
if sr.width() < 4.0 || sr.height() < 4.0 {
|
||||
continue;
|
||||
}
|
||||
// Big enough to read at a glance, small enough to leave the signer's own
|
||||
// text visible around it.
|
||||
let side = (sr.width().min(sr.height()) * 0.8).clamp(24.0, 192.0);
|
||||
let mark = Rect::from_center_size(sr.center(), vec2(side, side));
|
||||
icons::paint(ui, mark, icon, side * 0.64, color);
|
||||
// Overlapping widgets paint in order, so the topmost badge's verdict is the tip, with
|
||||
// any tool; a link's or a comment's tip wins over any badge.
|
||||
if pointer.is_some_and(|p| mark.expand(2.0).contains(p)) {
|
||||
view.cursor.describe(Subject::SignatureBadge, badge.summary.to_string());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn paint_field_highlights(painter: &egui::Painter, xf: &PageXform, info: &DocInfo, form: &[pdfcraft_engine::FormField], page: usize, enabled: bool) {
|
||||
if !enabled {
|
||||
return;
|
||||
}
|
||||
for field in form.iter() {
|
||||
let required = field.has(pdfcraft_engine::field_flags::REQUIRED);
|
||||
for widget in field.widgets.iter().filter(|widget| widget.page == Some(page) && !widget.hidden && !widget.read_only) {
|
||||
let rect = widget.rect;
|
||||
let screen_rect = xf.user_rect(info, page, [rect[0] as f32, rect[1] as f32, rect[2] as f32, rect[3] as f32]);
|
||||
let tint = Color32::from_rgba_unmultiplied(0x6E, 0x8E, 0xF5, 48);
|
||||
let (width, color) = if required { (2.0, Color32::from_rgb(0xE3, 0x22, 0x22)) } else { (1.0, Color32::from_rgb(0x6E, 0x8E, 0xF5)) };
|
||||
if widget.round {
|
||||
let radius = screen_rect.width().min(screen_rect.height()) / 2.0;
|
||||
painter.circle_filled(screen_rect.center(), radius, tint);
|
||||
painter.circle_stroke(screen_rect.center(), radius - width / 2.0, Stroke::new(width, color));
|
||||
} else {
|
||||
painter.rect_filled(screen_rect, CornerRadius::same(1), tint);
|
||||
painter.rect_stroke(screen_rect, CornerRadius::same(1), Stroke::new(width, color), egui::StrokeKind::Inside);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Escape while the pages hold a press abandons the gesture it drives, whichever tool's: nothing is
|
||||
/// placed, drawn, moved, resized or opened, and the press is ignored until the button is up. The
|
||||
/// frame of the release still belongs to the cancelled press.
|
||||
pub(super) fn cancel_on_escape(ctx: &egui::Context, view: &mut DocView, ptr: &PagePointer) {
|
||||
// Over once the button is up and its release seen, or when a new press comes (its release and
|
||||
// the next press can share a frame).
|
||||
let new_press = matches!(ptr.edges.last(), Some(crate::page_pointer::Edge::Press(_)));
|
||||
if view.press_cancelled && (new_press || !ptr.any_down && ptr.edges.is_empty()) {
|
||||
view.press_cancelled = false;
|
||||
}
|
||||
if !view.press_cancelled && ptr.origin.is_some() && ptr.primary_down && ctx.input_mut(|i| i.consume_key(egui::Modifiers::NONE, egui::Key::Escape))
|
||||
{
|
||||
// A text selection being dragged goes with its drag: the markup, redaction or Replace
|
||||
// Text that its end would make is not made.
|
||||
if view.selection_drag {
|
||||
view.clear_selection();
|
||||
}
|
||||
view.cancel_pointer_gestures();
|
||||
view.press_cancelled = true;
|
||||
}
|
||||
}
|
||||
@@ -39,6 +39,9 @@ pub(crate) struct PagePointer {
|
||||
pub origin: Option<Pos2>,
|
||||
/// This frame's primary presses and releases of a press the pages hold, in order.
|
||||
pub edges: Vec<Edge>,
|
||||
/// Where this frame's last primary release of a press the pages hold was: where a click came
|
||||
/// up, which the pointer may have left by the frame's end. Kept past the cap on `edges`.
|
||||
pub released: Option<Pos2>,
|
||||
/// The primary button is down, wherever it was pressed: a gesture ends once it is up.
|
||||
pub primary_down: bool,
|
||||
/// Some button is down, wherever it was pressed.
|
||||
@@ -49,8 +52,16 @@ impl PagePointer {
|
||||
/// The pointer for `resp`, the content widget that holds every page, allocated in `ui`, while
|
||||
/// a dialog is open over the window or not (`modal`).
|
||||
pub(crate) fn read(ui: &egui::Ui, resp: &egui::Response, modal: bool) -> Self {
|
||||
let (at, origin, edges, primary_down, any_down) =
|
||||
ui.input(|i| (i.pointer.interact_pos(), i.pointer.press_origin(), edges(&i.events), i.pointer.primary_down(), i.pointer.any_down()));
|
||||
let (at, origin, edges, released, primary_down, any_down) = ui.input(|i| {
|
||||
(
|
||||
i.pointer.interact_pos(),
|
||||
i.pointer.press_origin(),
|
||||
edges(&i.events),
|
||||
last_release(&i.events),
|
||||
i.pointer.primary_down(),
|
||||
i.pointer.any_down(),
|
||||
)
|
||||
});
|
||||
// egui's own answer to "do the pages hold a press?": from the press on until the frame
|
||||
// of its click, release or drag stop. A drag can outlive egui's press while the
|
||||
// pointer is outside the window. With a dialog open only a drag counts, up to the frame
|
||||
@@ -64,9 +75,9 @@ impl PagePointer {
|
||||
resp.dragged() || resp.drag_stopped() || (!modal && (resp.interact_pointer_pos().is_some() || press_origin.is_some_and(|p| on_top(&p))));
|
||||
let pos = at.filter(|p| held || on_top(p));
|
||||
if !held {
|
||||
return Self { pos, origin: None, edges: Vec::new(), primary_down, any_down };
|
||||
return Self { pos, origin: None, edges: Vec::new(), released: None, primary_down, any_down };
|
||||
}
|
||||
Self { pos, origin: press_origin, edges, primary_down, any_down }
|
||||
Self { pos, origin: press_origin, edges, released, primary_down, any_down }
|
||||
}
|
||||
|
||||
/// Where the pointer is, when it is inside `r`.
|
||||
@@ -97,6 +108,14 @@ fn first_press(edges: &[Edge]) -> Option<Pos2> {
|
||||
})
|
||||
}
|
||||
|
||||
/// Where the last primary release among `events` was, however many came before it.
|
||||
fn last_release(events: &[Event]) -> Option<Pos2> {
|
||||
events.iter().rev().find_map(|e| match e {
|
||||
Event::PointerButton { pos, button: PointerButton::Primary, pressed: false, .. } if pos.is_finite() => Some(*pos),
|
||||
_ => None,
|
||||
})
|
||||
}
|
||||
|
||||
/// The first [`MAX_EDGES`] primary presses and releases among `events`, in order.
|
||||
fn edges(events: &[Event]) -> Vec<Edge> {
|
||||
events
|
||||
|
||||
@@ -53,6 +53,20 @@ fn a_touch_tap_keeps_its_position_on_the_frame_it_lifts() {
|
||||
assert_eq!(frame(&ctx, vec![], false), PagePointer::default(), "and forget it the frame after");
|
||||
}
|
||||
|
||||
/// A click is located where it came up even after a stall's many presses and releases, past the
|
||||
/// cap on a frame's edges. Read from the edges kept, it was an earlier release's.
|
||||
#[test]
|
||||
fn a_frames_last_release_is_kept_past_the_cap_on_its_edges() {
|
||||
let ctx = Context::default();
|
||||
let (p, q) = (pos2(50.0, 60.0), pos2(80.0, 90.0));
|
||||
frame(&ctx, vec![Event::PointerMoved(p)], false);
|
||||
let mut events: Vec<Event> = (0..2 * MAX_EDGES).map(|i| button(p, PointerButton::Primary, i % 2 == 0)).collect();
|
||||
events.extend([button(q, PointerButton::Primary, true), button(q, PointerButton::Primary, false)]);
|
||||
let stall = frame(&ctx, events, false);
|
||||
assert_eq!(stall.edges.len(), MAX_EDGES);
|
||||
assert_eq!(stall.released, Some(q));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_press_and_release_in_one_frame_keep_the_press() {
|
||||
let ctx = Context::default();
|
||||
@@ -150,8 +164,9 @@ fn edges_are_primary_finite_in_order_and_capped() {
|
||||
}
|
||||
|
||||
/// The page modules: the per-page chain in `canvas::document_area` and what it calls.
|
||||
const PAGE_MODULES: [&str; 35] = [
|
||||
const PAGE_MODULES: [&str; 37] = [
|
||||
"canvas.rs",
|
||||
"canvas/page_input.rs",
|
||||
"canvas/area.rs",
|
||||
"canvas/bars.rs",
|
||||
"canvas/cache.rs",
|
||||
@@ -186,8 +201,18 @@ const PAGE_MODULES: [&str; 35] = [
|
||||
"canvas/image_pick.rs",
|
||||
"canvas/signature_drag.rs",
|
||||
"tools/calc_order_ui.rs",
|
||||
"tools/stamps_ui.rs",
|
||||
];
|
||||
|
||||
/// What a file that acts on the pages uses: the pointer, a tool's or the comments' page context,
|
||||
/// what a press is to a page, the router's hits and owners, or the router itself. Such a file is a
|
||||
/// page module. One that acts on the pages through the page view's response and a bare point alone
|
||||
/// uses none of them (`canvas/image_pick.rs`): PAGE_MODULES lists it by hand.
|
||||
const PAGE_MODULE_MARKS: [&str; 6] = ["PagePointer", "PageToolContext", "PageCx", "PagePress", "page_router::", ".router."];
|
||||
|
||||
/// The router's own files, which define what page modules use.
|
||||
const ROUTER_FILES: [&str; 3] = ["canvas/page_pointer.rs", "canvas/page_router.rs", "canvas/page_cursor.rs"];
|
||||
|
||||
/// egui's raw pointer state: where the pointer is, and which buttons are down or went down.
|
||||
const RAW_READS: [&str; 21] = [
|
||||
"hover_pos()",
|
||||
@@ -216,14 +241,13 @@ const RAW_READS: [&str; 21] = [
|
||||
|
||||
/// Functions in the page modules that are not page input and read egui's pointer state
|
||||
/// themselves: (file, function, why).
|
||||
const NOT_PAGE_INPUT: [(&str, &str, &str); 11] = [
|
||||
const NOT_PAGE_INPUT: [(&str, &str, &str); 10] = [
|
||||
("canvas/area.rs", "zoom_anchor", "a pinch zooms the whole view, and is read before the pages' widget exists"),
|
||||
("canvas/area.rs", "drawing_edge_pointer", "scrolls the view at its edges, read before the pages' widget exists"),
|
||||
("canvas/area.rs", "glide_interrupted", "a press anywhere stops the touchpad's glide"),
|
||||
("canvas/area.rs", "presentation_click", "full screen's click to turn the page, read before the pages' widget exists"),
|
||||
("canvas/bars.rs", "page_size_hint", "the page size hint sits in the view's corner, not on a page"),
|
||||
("canvas/organize.rs", "organize_grid", "Organize Pages shows thumbnails, not pages"),
|
||||
("tools/comments/input.rs", "keys", "keyboard handling after the pages: a drag cancelled with Escape ends once no button is down"),
|
||||
("tools/forms_ui.rs", "overlay", "the field editor is an Area of its own over the page"),
|
||||
("tools/content_ui.rs", "editor", "the added-text editor is an Area of its own over the page"),
|
||||
("tools/edit_text_ui.rs", "overlay", "the paragraph editor is an Area of its own over the page"),
|
||||
@@ -263,36 +287,131 @@ fn uses(line: &str, name: &str) -> bool {
|
||||
line.match_indices(name).any(|(at, _)| name.starts_with('.') || !line[..at].ends_with(|c: char| c.is_alphanumeric() || c == '_'))
|
||||
}
|
||||
|
||||
/// The lines of `source` outside its test modules, numbered from 1. Tests drive egui's input and
|
||||
/// read its output themselves. A test module (`#[cfg(test)]` then `mod name {`) ends at the first
|
||||
/// line that is a lone `}`, as rustfmt lays a top-level item out, so the code after a test module
|
||||
/// in the middle of a file is still read; `#[cfg(test)]` then `mod name;` is one line.
|
||||
fn outside_test_modules(source: &str) -> Vec<(usize, &str)> {
|
||||
let mut kept = Vec::new();
|
||||
let mut lines = source.lines().enumerate().map(|(n, line)| (n + 1, line)).peekable();
|
||||
while let Some((n, line)) = lines.next() {
|
||||
if line == "#[cfg(test)]" && lines.peek().is_some_and(|(_, next)| next.starts_with("mod ")) {
|
||||
if lines.next().is_some_and(|(_, module)| module.ends_with('{')) {
|
||||
lines.by_ref().find(|(_, line)| *line == "}");
|
||||
}
|
||||
continue;
|
||||
}
|
||||
kept.push((n, line));
|
||||
}
|
||||
kept
|
||||
}
|
||||
|
||||
/// The lines of code in `source` outside its test modules, numbered from 1, each with the
|
||||
/// top-level function or `impl` method it is in; comment lines are left out. A line rustfmt
|
||||
/// continued (a method chain split as `view` / `.router` / `.owner(i)`) is read with the one it
|
||||
/// continues, under that one's number.
|
||||
fn code_lines(source: &str) -> Vec<(usize, Option<&str>, String)> {
|
||||
let (mut function, mut in_impl) = (None, false);
|
||||
let mut lines: Vec<(usize, Option<&str>, String)> = Vec::new();
|
||||
for (n, line) in outside_test_modules(source) {
|
||||
if line.starts_with("impl") {
|
||||
(function, in_impl) = (None, true);
|
||||
} else if line == "}" {
|
||||
(function, in_impl) = (None, false);
|
||||
} else if let Some(name) = declares(line).or_else(|| line.strip_prefix(" ").filter(|_| in_impl).and_then(declares)) {
|
||||
function = Some(name);
|
||||
}
|
||||
if line.trim_start().starts_with("//") {
|
||||
continue;
|
||||
}
|
||||
match lines.last_mut() {
|
||||
Some((_, _, text)) if line.trim_start().starts_with('.') => text.push_str(line.trim_start()),
|
||||
_ => lines.push((n, function, line.to_owned())),
|
||||
}
|
||||
}
|
||||
lines
|
||||
}
|
||||
|
||||
/// Each name `find` finds in a line of the page modules' code (their tests left out), as (file,
|
||||
/// the top-level function or `impl` method it is in, line, name) ([`code_lines`]).
|
||||
fn page_module_matches(find: impl Fn(&str) -> Vec<String>) -> Vec<(&'static str, Option<String>, usize, String)> {
|
||||
let src = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("src");
|
||||
let mut found = Vec::new();
|
||||
for file in PAGE_MODULES {
|
||||
let source = std::fs::read_to_string(src.join(file)).expect("page module").replace("\r\n", "\n");
|
||||
for (n, function, text) in code_lines(&source) {
|
||||
for name in find(&text) {
|
||||
found.push((file, function.map(str::to_owned), n, name));
|
||||
}
|
||||
}
|
||||
}
|
||||
found
|
||||
}
|
||||
|
||||
/// Each hit test `source` imports under a name that is not a hit test's (`use …::hit as under;`),
|
||||
/// as (name, alias), from each `use` statement, from its first line to its `;`, wherever it is.
|
||||
fn aliased_hit_tests(source: &str) -> Vec<(String, String)> {
|
||||
let mut found = Vec::new();
|
||||
let mut statement: Option<String> = None;
|
||||
for line in source.lines().map(str::trim) {
|
||||
if statement.is_none() && ["use ", "pub use ", "pub(crate) use ", "pub(super) use "].iter().any(|start| line.starts_with(start)) {
|
||||
statement = Some(String::new());
|
||||
}
|
||||
let Some(text) = statement.as_mut() else { continue };
|
||||
text.push_str(line);
|
||||
text.push(' ');
|
||||
if !line.ends_with(';') {
|
||||
continue;
|
||||
}
|
||||
for part in text.split([',', '{', '}', ';']) {
|
||||
let Some((path, alias)) = part.split_once(" as ") else { continue };
|
||||
let (name, alias) = (path.trim().rsplit("::").next().unwrap_or_default(), alias.trim());
|
||||
if is_hit_test(name) && !is_hit_test(alias) {
|
||||
found.push((name.to_owned(), alias.to_owned()));
|
||||
}
|
||||
}
|
||||
statement = None;
|
||||
}
|
||||
found
|
||||
}
|
||||
|
||||
/// Each hit test a page module imports under a name that is not a hit test's, which the checks by
|
||||
/// name would not see ([`aliased_hit_tests`]).
|
||||
fn hit_test_aliases() -> Vec<String> {
|
||||
let src = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("src");
|
||||
let mut found = Vec::new();
|
||||
for file in PAGE_MODULES {
|
||||
let source = std::fs::read_to_string(src.join(file)).expect("page module");
|
||||
for (name, alias) in aliased_hit_tests(&source) {
|
||||
found.push(format!(
|
||||
"src/{file}: `{name} as {alias}` imports a hit test under another name, which the checks by name miss: name \
|
||||
it `hit` or `…_hit`."
|
||||
));
|
||||
}
|
||||
}
|
||||
found
|
||||
}
|
||||
|
||||
/// Each use of one of `names` in the page modules' code (their tests left out).
|
||||
fn page_module_uses(names: &[&str]) -> Vec<(&'static str, Option<String>, usize, String)> {
|
||||
page_module_matches(|line| names.iter().filter(|name| uses(line, name)).map(|name| (*name).to_owned()).collect())
|
||||
}
|
||||
|
||||
/// Each use of one of `names` in the page modules' code (their tests left out) outside the
|
||||
/// functions `allowed` to, as "src/file:line: `name` why"; then each allowed function that uses
|
||||
/// none of them any more, as "src/file: fn function unused".
|
||||
fn misuses(names: &[&str], allowed: &[(&str, &str, &str)], why: &str, unused: &str) -> Vec<String> {
|
||||
let src = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("src");
|
||||
misuses_in(page_module_uses(names), allowed, why, unused)
|
||||
}
|
||||
|
||||
/// [`misuses`], of what was `found`.
|
||||
fn misuses_in(found: Vec<(&str, Option<String>, usize, String)>, allowed: &[(&str, &str, &str)], why: &str, unused: &str) -> Vec<String> {
|
||||
let mut problems = Vec::new();
|
||||
let mut needed = vec![false; allowed.len()];
|
||||
for file in PAGE_MODULES {
|
||||
let source = std::fs::read_to_string(src.join(file)).expect("page module").replace("\r\n", "\n");
|
||||
// Tests drive egui's input and read its output themselves.
|
||||
let code = source.split("#[cfg(test)]\nmod ").next().unwrap_or_default();
|
||||
// The top-level function, or method of an `impl`, that each line is in.
|
||||
let (mut function, mut in_impl) = (None, false);
|
||||
for (n, line) in code.lines().enumerate() {
|
||||
if line.starts_with("impl") {
|
||||
(function, in_impl) = (None, true);
|
||||
} else if line == "}" {
|
||||
(function, in_impl) = (None, false);
|
||||
} else if let Some(name) = declares(line).or_else(|| line.strip_prefix(" ").filter(|_| in_impl).and_then(declares)) {
|
||||
function = Some(name);
|
||||
}
|
||||
if line.trim_start().starts_with("//") {
|
||||
continue;
|
||||
}
|
||||
for name in names.iter().filter(|name| uses(line, name)) {
|
||||
match allowed.iter().position(|(f, function_name, _)| *f == file && function == Some(*function_name)) {
|
||||
Some(k) => needed[k] = true,
|
||||
None => problems.push(format!("src/{file}:{}: `{name}` {why}", n + 1)),
|
||||
}
|
||||
}
|
||||
for (file, function, n, name) in found {
|
||||
match allowed.iter().position(|(f, function_name, _)| *f == file && function.as_deref() == Some(*function_name)) {
|
||||
Some(k) => needed[k] = true,
|
||||
None => problems.push(format!("src/{file}:{n}: `{name}` {why}")),
|
||||
}
|
||||
}
|
||||
for ((file, name, _), needed) in allowed.iter().zip(needed) {
|
||||
@@ -317,7 +436,7 @@ fn page_modules_read_the_pointer_only_through_page_pointer() {
|
||||
NOT_PAGE_INPUT there, with why.",
|
||||
"reads no pointer state any more: remove it from NOT_PAGE_INPUT.",
|
||||
);
|
||||
// A module that takes the page pointer is a page module, so it is checked too.
|
||||
// A module that acts on the pages is a page module, so it is checked too.
|
||||
let mut dirs = vec![src.clone()];
|
||||
while let Some(dir) = dirs.pop() {
|
||||
for entry in std::fs::read_dir(dir).expect("source directory") {
|
||||
@@ -337,8 +456,9 @@ fn page_modules_read_the_pointer_only_through_page_pointer() {
|
||||
let file =
|
||||
path.strip_prefix(&src).expect("under src").components().map(|c| c.as_os_str().to_string_lossy()).collect::<Vec<_>>().join("/");
|
||||
let source = std::fs::read_to_string(&path).expect("source file");
|
||||
if file != "canvas/page_pointer.rs" && source.contains("PagePointer") && !PAGE_MODULES.contains(&file.as_str()) {
|
||||
problems.push(format!("src/{file} takes the page pointer: add it to PAGE_MODULES."));
|
||||
let marks = PAGE_MODULE_MARKS.iter().filter(|mark| source.contains(**mark)).collect::<Vec<_>>();
|
||||
if !ROUTER_FILES.contains(&file.as_str()) && !marks.is_empty() && !PAGE_MODULES.contains(&file.as_str()) {
|
||||
problems.push(format!("src/{file} uses {marks:?}, so it acts on the pages: add it to PAGE_MODULES."));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -362,18 +482,138 @@ fn page_modules_claim_the_cursor_and_never_set_it() {
|
||||
assert!(problems.is_empty(), "{}", problems.join("\n"));
|
||||
}
|
||||
|
||||
/// Hit producers are called only by the central routing table, not again by an input handler.
|
||||
const PAGE_HIT_CALLS: [&str; 8] = [
|
||||
/// What decides, keeps or drops the press the pages hold.
|
||||
const ROUTER_WRITES: [&str; 8] = [
|
||||
"router.begin(",
|
||||
"router.press(",
|
||||
"router.settle(",
|
||||
"router.cancel(",
|
||||
"PageRouter::begin(",
|
||||
"PageRouter::press(",
|
||||
"PageRouter::settle(",
|
||||
"PageRouter::cancel(",
|
||||
];
|
||||
|
||||
/// The functions that decide, keep or drop the press the pages hold: (file, function, why).
|
||||
const ROUTER_WRITERS: [(&str, &str, &str); 3] = [
|
||||
("canvas/page_input.rs", "page_tool_input", "the hits at the press point decide its owner, once per press"),
|
||||
("canvas.rs", "draw_pages", "the press is over once the button is up and its release seen, and a new one drops the last owner"),
|
||||
("canvas.rs", "cancel_pointer_gestures", "every pointer gesture's cancel: Escape, automation's cancel"),
|
||||
];
|
||||
|
||||
/// Ways to make a `Hit`.
|
||||
const HIT_BUILDS: [&str; 2] = ["Hit::new(", "Hit {"];
|
||||
|
||||
/// Whether `name` is a hit test's: `hit`, or `…_hit`.
|
||||
fn is_hit_test(name: &str) -> bool {
|
||||
name == "hit" || name.ends_with("_hit")
|
||||
}
|
||||
|
||||
/// The hit tests `line` calls: by path, bare or as a method.
|
||||
fn hit_test_calls(line: &str) -> Vec<String> {
|
||||
line.match_indices("hit(")
|
||||
.filter_map(|(at, _)| {
|
||||
let end = at + "hit".len();
|
||||
let start = line[..end].char_indices().rev().find(|(_, c)| !(c.is_alphanumeric() || *c == '_')).map_or(0, |(i, c)| i + c.len_utf8());
|
||||
let (before, name) = (&line[..start], &line[start..end]);
|
||||
(is_hit_test(name) && !before.ends_with("fn ")).then(|| name.to_owned())
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// The functions that call a hit test: (file, function, why). Hit tests are found by name (a
|
||||
/// function named `hit` or `…_hit`, called by path, bare or as a method). The comments' point test
|
||||
/// has a list of its own (`COMMENT_POINT_TESTERS`); the others by other names (added content's,
|
||||
/// Edit text's paragraphs', Redact's text test, the text layer's links) are not listed yet, and
|
||||
/// most are PR 4b's. `PageHits::hits` is the one: the hits
|
||||
/// at the press point decide its owner, and those under the pointer give its cursor, its tip, hover
|
||||
/// painting and a right-click.
|
||||
const HIT_TESTERS: [(&str, &str, &str); 1] = [(
|
||||
"canvas/page_input.rs",
|
||||
"hits",
|
||||
"`PageHits::hits`: every module's hits at a point, for the pointer's cursor and tip, a right-click and, once, the press's owner",
|
||||
)];
|
||||
|
||||
/// The page view's asks for every module's hits at a point (`PageHits::hits`, and `at` and
|
||||
/// `context_at`, which wrap it).
|
||||
const PAGE_HITS_ASKS: [&str; 6] = [".hits(", ".at(", ".context_at(", "PageHits::hits(", "PageHits::at(", "PageHits::context_at("];
|
||||
|
||||
/// The functions that ask the page view's hits at a point: (file, function, why). `PageHits` is
|
||||
/// private to `page_input.rs`, so this keeps a new function there from asking; a second ask inside
|
||||
/// a listed function is for review to catch. The method names are matched in every page module,
|
||||
/// so an `at` of another type there would need them narrowed.
|
||||
const PAGE_HITS_ASKERS: [(&str, &str, &str); 5] = [
|
||||
("canvas/page_input.rs", "at", "`PageHits::at`: the hits at a point, as a press there would take them"),
|
||||
("canvas/page_input.rs", "context_at", "`PageHits::context_at`: what a right-click at a point is on"),
|
||||
(
|
||||
"canvas/page_input.rs",
|
||||
"page_tool_input",
|
||||
"the hits at the press point decide its owner, once per press; those under the pointer before the tools act, once a \
|
||||
frame, serve a click's release, a right-click and Fill & Sign's preview",
|
||||
),
|
||||
("canvas/page_input.rs", "claim_under", "what lies under the pointer after the tools act: its cursor, its tip and hover painting"),
|
||||
("canvas/page_input.rs", "right_click", "what a right-click is on"),
|
||||
];
|
||||
|
||||
/// The comments' point test, which their hit tests are built on: which comment lies under a point.
|
||||
const COMMENT_POINT_TESTS: [&str; 2] = [".comment_at(", "PageCx::comment_at("];
|
||||
|
||||
/// The functions that ask which comment lies under a point: (file, function, why).
|
||||
const COMMENT_POINT_TESTERS: [(&str, &str, &str); 3] = [
|
||||
("tools/comments/input.rs", "hit", "the comments' hit test"),
|
||||
("tools/comments/input.rs", "context_hit", "the comments' hit test for a right-click"),
|
||||
("tools/comments/paint.rs", "paint_page", "a redaction mark shows its fill under the pointer with every tool, as comments' tips show"),
|
||||
];
|
||||
|
||||
/// What reads who holds the press the pages hold.
|
||||
const ROUTER_READS: [&str; 6] =
|
||||
["router.press_for(", "router.owner(", "router.keeps_drag(", "PageRouter::press_for(", "PageRouter::owner(", "PageRouter::keeps_drag("];
|
||||
|
||||
/// The functions that read who holds the press: (file, function, why). The page view asks once per
|
||||
/// page and tells each module what the press is to its page (`PagePress`); the Edit text group, the
|
||||
/// text layer and link following still ask, until they are told too (PR 4b), and an unused entry
|
||||
/// fails the test.
|
||||
const ROUTER_READERS: [(&str, &str, &str); 8] = [
|
||||
(
|
||||
"canvas/page_input.rs",
|
||||
"page_tool_input",
|
||||
"the page view: what the press is to each page (`press_for`); Add text's paragraph and the pictures until 4b",
|
||||
),
|
||||
("canvas/page_input.rs", "update_selection_on_press", "the text layer selects no text under a press held by what keeps its drag (4b)"),
|
||||
("canvas/page_input.rs", "finish_text_pointer_gesture", "a click held by what keeps its drag leaves the text selection alone (4b)"),
|
||||
("canvas/page_input.rs", "page_overlays", "a click follows the link that holds its press (4b)"),
|
||||
("tools/content_ui.rs", "page_input", "added text and pictures, until they are told (4b)"),
|
||||
("tools/edit_text_ui.rs", "page_input", "Edit text's paragraphs, until they are told (4b)"),
|
||||
("tools/edit_text_ui/image.rs", "image_input", "Edit text's pictures, until they are told (4b)"),
|
||||
("tools/object_ui.rs", "input", "the objects selected together, until they are told (4b)"),
|
||||
];
|
||||
|
||||
/// What ignores the press the pages hold until the button is up.
|
||||
const PRESS_IGNORES: [&str; 1] = ["press_cancelled = true"];
|
||||
|
||||
/// The one function that ignores a press until the button is up: (file, function, why).
|
||||
const PRESS_IGNORERS: [(&str, &str, &str); 1] =
|
||||
[("canvas/page_input.rs", "cancel_on_escape", "Escape abandons the gesture the press drives, whichever tool's")];
|
||||
|
||||
/// The module hit tests, called by path: a press handler calls none of them (HIT_TESTERS says who
|
||||
/// may).
|
||||
const PAGE_HIT_CALLS: [&str; 12] = [
|
||||
"link_ui::hit(",
|
||||
"prepare::hit(",
|
||||
"forms_ui::hit(",
|
||||
"comments::hit(",
|
||||
"comments::context_hit(",
|
||||
"camera_ui::hit(",
|
||||
"edit_text_ui::hit(",
|
||||
"edit_text_ui::picture_hit(",
|
||||
"edit_text_ui::picture_handle_hit(",
|
||||
"edit_text_ui::crop_hit(",
|
||||
"object_ui::hit(",
|
||||
"content_ui::hit(",
|
||||
];
|
||||
|
||||
/// Whether a press handler's `code` acts on the owner the router captured, and calls no hit test
|
||||
/// of its own to choose one.
|
||||
fn routed_press_handler(code: &str) -> bool {
|
||||
let code = code.lines().filter(|line| !line.trim_start().starts_with("//")).collect::<Vec<_>>().join("\n");
|
||||
code.contains("router.owner(")
|
||||
@@ -383,51 +623,161 @@ fn routed_press_handler(code: &str) -> bool {
|
||||
&& !uses(&code, "handle_hit(")
|
||||
}
|
||||
|
||||
/// Source-level guard for the Page presses rule, alongside the raw-pointer and cursor guards.
|
||||
/// Runtime routing, capture lifetime and Escape behavior have separate behavioral tests.
|
||||
/// Page modules act on a press only when the router says it is theirs. The hits at the press
|
||||
/// point decide its owner once, in one place, and a `Hit` comes only from a module's hit test,
|
||||
/// so what the cursor promised is what the press does. Where each module tested the press
|
||||
/// point again, or asked another whether it wanted the press, the answers disagreed: a press on
|
||||
/// one check box released over the next ticked the second, and a drag could be taken over
|
||||
/// halfway. Only `PageHits::hits` asks the hit tests. Escape is the one way to
|
||||
/// drop a press and ignore it until the button is up.
|
||||
#[test]
|
||||
fn page_modules_take_presses_from_the_router_without_repeating_hit_tests() {
|
||||
fn page_modules_act_on_a_press_only_through_the_router() {
|
||||
let mut problems = misuses(
|
||||
&PAGE_HIT_CALLS,
|
||||
&[("canvas.rs", "at", "the central PageHits table")],
|
||||
"repeats a module hit test outside PageHits::at; use the captured router owner",
|
||||
"no longer collects module hits",
|
||||
&ROUTER_WRITES,
|
||||
&ROUTER_WRITERS,
|
||||
"decides, keeps or drops the press the pages hold. Only the hits at the press point decide its owner, once \
|
||||
(src/canvas/page_router.rs), and the page view tells each module what the press is to its page (`PagePress`). Drop a press with \
|
||||
`DocView::cancel_pointer_gestures`. A new place that must? Add the function to ROUTER_WRITERS in \
|
||||
src/canvas/page_pointer/tests.rs, with why.",
|
||||
"no longer decides, keeps or drops the press: remove it from ROUTER_WRITERS.",
|
||||
);
|
||||
problems.extend(misuses(
|
||||
&["router.press("],
|
||||
&[("canvas.rs", "page_tool_input", "the central press capture")],
|
||||
"captures a page press outside the central routing path",
|
||||
"no longer captures page presses",
|
||||
&ROUTER_READS,
|
||||
&ROUTER_READERS,
|
||||
"reads who holds the press the pages hold. The page view asks the router once per page and tells each module \
|
||||
what the press is to its page: take a `PagePress` (src/canvas/page_router.rs) instead. A new place that must? \
|
||||
Add the function to ROUTER_READERS in src/canvas/page_pointer/tests.rs, with why.",
|
||||
"no longer reads who holds the press: remove it from ROUTER_READERS.",
|
||||
));
|
||||
// A router method the lists above don't name yet is the router's all the same: only their
|
||||
// functions use it.
|
||||
let known: Vec<&str> = ROUTER_WRITES.iter().chain(ROUTER_READS.iter()).copied().collect();
|
||||
let unlisted = page_module_matches(|line| {
|
||||
let router = uses(line, ".router.") || uses(line, "PageRouter::");
|
||||
if router && !known.iter().any(|name| uses(line, name)) { vec!["router".to_owned()] } else { Vec::new() }
|
||||
});
|
||||
problems.extend(
|
||||
unlisted
|
||||
.into_iter()
|
||||
.filter(|(file, function, _, _)| {
|
||||
!ROUTER_WRITERS.iter().chain(ROUTER_READERS.iter()).any(|(f, name, _)| f == file && function.as_deref() == Some(*name))
|
||||
})
|
||||
.map(|(file, _, n, _)| {
|
||||
format!(
|
||||
"src/{file}:{n}: uses the router by a method ROUTER_WRITES and ROUTER_READS don't name. The page view \
|
||||
decides the press and tells each module what it is to its page (`PagePress`): add the method to \
|
||||
ROUTER_WRITES or ROUTER_READS in src/canvas/page_pointer/tests.rs, and the function to their lists \
|
||||
only if it must."
|
||||
)
|
||||
}),
|
||||
);
|
||||
problems.extend(misuses(
|
||||
&COMMENT_POINT_TESTS,
|
||||
&COMMENT_POINT_TESTERS,
|
||||
"asks which comment lies under a point. The comments' hit tests answer that for a press and a right-click: \
|
||||
act on what the page view tells you, rather than testing the point again. A new place that must? Add the \
|
||||
function to COMMENT_POINT_TESTERS in src/canvas/page_pointer/tests.rs, with why.",
|
||||
"no longer asks which comment lies under a point: remove it from COMMENT_POINT_TESTERS.",
|
||||
));
|
||||
problems.extend(misuses(
|
||||
&PAGE_HITS_ASKS,
|
||||
&PAGE_HITS_ASKERS,
|
||||
"asks the page view's hits at a point. The hits at the press point decide its owner once, and those under the \
|
||||
pointer are taken once before the tools act and once after: use those (`under`, `PageInput.hover`). A new \
|
||||
place that must ask? Add the function to PAGE_HITS_ASKERS in src/canvas/page_pointer/tests.rs, with why.",
|
||||
"no longer asks the page view's hits: remove it from PAGE_HITS_ASKERS.",
|
||||
));
|
||||
problems.extend(misuses(
|
||||
&PRESS_IGNORES,
|
||||
&PRESS_IGNORERS,
|
||||
"ignores the press the pages hold. Escape cancels a press, in `cancel_on_escape`: drop a gesture with \
|
||||
`DocView::cancel_pointer_gestures` instead.",
|
||||
"no longer ignores a press: remove it from PRESS_IGNORERS.",
|
||||
));
|
||||
let src = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("src");
|
||||
for (file, function) in [
|
||||
("tools/forms_ui.rs", "page_input"),
|
||||
("tools/prepare.rs", "page_input"),
|
||||
("tools/content_ui.rs", "page_input"),
|
||||
("tools/edit_text_ui.rs", "page_input"),
|
||||
("tools/edit_text_ui/image.rs", "image_input"),
|
||||
("tools/object_ui.rs", "input"),
|
||||
("tools/comments/input.rs", "select_input"),
|
||||
] {
|
||||
let source = std::fs::read_to_string(src.join(file)).expect("page input module");
|
||||
let body = source.lines().skip_while(|line| declares(line) != Some(function)).take_while(|line| *line != "}").collect::<Vec<_>>().join("\n");
|
||||
// Forms reuse their hit test for hover text and to require release over the captured
|
||||
// widget. Neither chooses the press owner. Pin both calls to the current pointer `p`,
|
||||
// not the press origin, and reject an additional call or a changed argument.
|
||||
let body = if file == "tools/forms_ui.rs" {
|
||||
let call = "hit(xf, info, page, form, allowed, p)";
|
||||
assert_eq!(body.matches(call).count(), 2, "only the existing hover and release checks are exempt");
|
||||
body.replace(call, "hover_or_release_check")
|
||||
} else {
|
||||
body
|
||||
};
|
||||
if !routed_press_handler(&body) {
|
||||
problems.push(format!("src/{file}: {function} must consume the captured router owner without repeating a hit test"));
|
||||
}
|
||||
}
|
||||
// A hit test is a function named `hit` or `…_hit`: one answer to "what of mine is here?",
|
||||
// which gives the module's cursor, its tip and its press.
|
||||
problems.extend(misuses_in(
|
||||
page_module_matches(hit_test_calls),
|
||||
&HIT_TESTERS,
|
||||
"calls a hit test. The hits at the press point decide its owner once, in `PageHits::hits`: act on the press when \
|
||||
the page view tells you it is yours (`PagePress::Mine`), rather than testing its point again. What lies under \
|
||||
the pointer comes from the page view's own hits: hover painting and tips (`PageInput.hover`), a click released \
|
||||
over what it was pressed on (`released_over`). A new place that must ask? Add the function to HIT_TESTERS in \
|
||||
src/canvas/page_pointer/tests.rs, with why.",
|
||||
"calls no hit test any more: remove it from HIT_TESTERS.",
|
||||
));
|
||||
problems.extend(hit_test_aliases());
|
||||
// An entry no page module calls any more no longer guards anything.
|
||||
let called = page_module_uses(&PAGE_HIT_CALLS);
|
||||
problems.extend(
|
||||
PAGE_HIT_CALLS
|
||||
.iter()
|
||||
.filter(|call| !called.iter().any(|(_, _, _, name)| name == *call))
|
||||
.map(|call| format!("no page module calls `{call}` any more: remove it from PAGE_HIT_CALLS.")),
|
||||
);
|
||||
let builds = page_module_uses(&HIT_BUILDS);
|
||||
assert!(!builds.is_empty(), "no page module makes a `Hit` any more: update HIT_BUILDS");
|
||||
problems.extend(builds.into_iter().filter(|(_, function, _, _)| !function.as_deref().is_some_and(is_hit_test)).map(|(file, _, n, name)| {
|
||||
format!(
|
||||
"src/{file}:{n}: `{name}` makes a hit outside a hit test. A page module answers \"what of mine is \
|
||||
here?\" in one function, named `hit` or `…_hit`, so its cursor, its tip and its press agree."
|
||||
)
|
||||
}));
|
||||
assert!(problems.is_empty(), "{}", problems.join("\n"));
|
||||
}
|
||||
|
||||
/// A test module in the middle of a file hides only itself from the page guards: the code after
|
||||
/// it is read too. The guards used to stop at the first test module.
|
||||
#[test]
|
||||
fn the_page_guards_read_past_a_test_module_in_the_middle_of_a_file() {
|
||||
let source = "fn before() {}\n#[cfg(test)]\nmod tests {\n fn inside() {}\n}\n\nfn after() {}\n#[cfg(test)]\nmod more;\nfn last() {}\n";
|
||||
let kept: Vec<(usize, &str)> = outside_test_modules(source);
|
||||
assert_eq!(kept, [(1, "fn before() {}"), (6, ""), (7, "fn after() {}"), (10, "fn last() {}")]);
|
||||
}
|
||||
|
||||
/// The guard's readers: hit tests by name, the function a line declares, a call rustfmt split,
|
||||
/// and a hit test imported as another name.
|
||||
#[test]
|
||||
fn the_page_guards_read_hit_tests_split_calls_and_aliases() {
|
||||
assert_eq!(hit_test_calls("let h = crate::forms_ui::hit(xf, p);"), ["hit"]);
|
||||
assert_eq!(hit_test_calls("cx.comment_hit(p) && picture_hit(p)"), ["comment_hit", "picture_hit"]);
|
||||
assert!(hit_test_calls("pub(crate) fn hit(xf: &PageXform) -> Option<Hit> {").is_empty());
|
||||
assert!(hit_test_calls("let all = self.hits(view, p, false);").is_empty());
|
||||
assert_eq!(declares("pub(crate) const fn crop_hit<'a>(view: &DocView) {"), Some("crop_hit"));
|
||||
assert_eq!(declares("let hit = 1;"), None);
|
||||
let source = "impl PageHits<'_> {\n fn at(&self) {\n self\n .hits(view, p, false)\n }\n}\nfn after() {\n // view.router.owner(0)\n let _ = view\n .router\n .owner(0);\n}\n";
|
||||
assert_eq!(
|
||||
code_lines(source),
|
||||
[
|
||||
(1, None, "impl PageHits<'_> {".to_owned()),
|
||||
(2, Some("at"), " fn at(&self) {".to_owned()),
|
||||
(3, Some("at"), " self.hits(view, p, false)".to_owned()),
|
||||
(5, Some("at"), " }".to_owned()),
|
||||
(6, None, "}".to_owned()),
|
||||
(7, Some("after"), "fn after() {".to_owned()),
|
||||
(9, Some("after"), " let _ = view.router.owner(0);".to_owned()),
|
||||
(12, None, "}".to_owned()),
|
||||
]
|
||||
);
|
||||
let source =
|
||||
"fn a() {}\n\n#[cfg(any())]\nuse crate::camera_ui::hit as corner_under;\nuse crate::x::{\n hit as x_hit,\n picture_hit as under,\n};\n";
|
||||
let aliases: Vec<(String, String)> = [("hit", "corner_under"), ("picture_hit", "under")].map(|(a, b)| (a.to_owned(), b.to_owned())).to_vec();
|
||||
assert_eq!(aliased_hit_tests(source), aliases);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_page_press_guard_rejects_missing_owners_and_second_hit_tests() {
|
||||
assert!(routed_press_handler("let owner = view.router.owner(page);"));
|
||||
|
||||
@@ -6,7 +6,8 @@
|
||||
//! press point decide who captures it ([`PageRouter::press`]), by the same table: the highest layer
|
||||
//! the active tool reaches. Until the button is up only the owner acts on the press, its drag and
|
||||
//! its release, so what the cursor promised is what the press does, and nothing takes a gesture
|
||||
//! back halfway.
|
||||
//! back halfway. Each page is told what it has to do with the press ([`PagePress`]): its owner's,
|
||||
//! the active tool's, or none of its business.
|
||||
|
||||
use egui::CursorIcon;
|
||||
|
||||
@@ -18,7 +19,7 @@ use crate::page_cursor::Layer;
|
||||
pub(crate) enum Owner {
|
||||
/// A comment (or a Fill & Sign mark), by its `/Annots` index, and the part of it.
|
||||
Comment { index: usize, part: CommentPart },
|
||||
/// A link, by its index in the document's links.
|
||||
/// A link, by its index in its page's `/Annots`.
|
||||
Link { index: usize },
|
||||
/// A form field's widget, by the field's index in the form and the widget's in the field.
|
||||
Field { field: usize, widget: usize },
|
||||
@@ -35,6 +36,8 @@ pub(crate) enum Owner {
|
||||
/// Added text or a picture placed on the page, by its index among the page's, and a corner of
|
||||
/// the selected one (left, top) or the item itself.
|
||||
Added { index: usize, corner: Option<(bool, bool)> },
|
||||
/// Enhance ▸ Camera image: a corner of the quadrilateral (0 left top, then clockwise).
|
||||
CameraCorner { corner: usize },
|
||||
}
|
||||
|
||||
/// The part of a picture a hit is on.
|
||||
@@ -87,7 +90,7 @@ pub(crate) struct Hit {
|
||||
/// Beside the pointer where this hit wins (a link's target).
|
||||
pub tip: Option<String>,
|
||||
/// A drag from here is not this owner's: a click on a highlight selects it, a drag across it
|
||||
/// selects the text underneath.
|
||||
/// selects the text underneath; with the Link tool, a drag from a link draws a new one.
|
||||
pub declines_drag: bool,
|
||||
}
|
||||
|
||||
@@ -106,10 +109,35 @@ pub(crate) fn top(hits: impl IntoIterator<Item = Hit>, tool: QuickTool) -> Optio
|
||||
})
|
||||
}
|
||||
|
||||
/// What one page has to do with the press the pages hold.
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub(crate) enum PagePress {
|
||||
/// The press began on this page, and the owner's hit won it: its module acts on it. Others
|
||||
/// only let go of their own state (a click on anything but the selected comment unselects it).
|
||||
Mine(Owner),
|
||||
/// No button is down, or the press began on this page and nobody's hit won it: the active
|
||||
/// tool's. Also every page's while a press the page view does not hold is down (one that began
|
||||
/// over a panel), and after the press was dropped ([`PageRouter::cancel`]) until the button is
|
||||
/// up (`Elsewhere` instead when Escape came in the press's own frame; page input skips a
|
||||
/// cancelled press either way).
|
||||
Free,
|
||||
/// The press began on another page, or off the pages (between them, or beside one).
|
||||
Elsewhere,
|
||||
}
|
||||
|
||||
impl PagePress {
|
||||
/// Who holds the press on this page, if anyone.
|
||||
pub(crate) fn owner(self) -> Option<Owner> {
|
||||
match self {
|
||||
PagePress::Mine(owner) => Some(owner),
|
||||
PagePress::Free | PagePress::Elsewhere => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A press the pages hold, and who it belongs to.
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub(crate) struct Capture {
|
||||
pub page: usize,
|
||||
pub owner: Owner,
|
||||
pub declines_drag: bool,
|
||||
}
|
||||
@@ -118,18 +146,43 @@ pub(crate) struct Capture {
|
||||
#[derive(Debug, Default)]
|
||||
pub(crate) struct PageRouter {
|
||||
capture: Option<Capture>,
|
||||
/// A press is held, and the page it began on (`None`: off the pages, between them or beside one).
|
||||
began: Option<Option<usize>>,
|
||||
}
|
||||
|
||||
impl PageRouter {
|
||||
/// A new press on the pages: the last one's owner goes, and until a page claims it the press is
|
||||
/// between the pages.
|
||||
pub(crate) fn begin(&mut self) {
|
||||
self.capture = None;
|
||||
self.began = Some(None);
|
||||
}
|
||||
|
||||
/// A press on `page`: `hits` at the press point decide who it belongs to. A press nobody's
|
||||
/// hit claims is held by nobody (the page's text, or a tool that acts anywhere on the page).
|
||||
/// Only a press just begun ([`Self::begin`]) is claimed, by the first page that does: pages
|
||||
/// that touch (the gaps hidden) can share a row of pixels, and a press there is one page's.
|
||||
pub(crate) fn press(&mut self, page: usize, hits: impl IntoIterator<Item = Hit>, tool: QuickTool) {
|
||||
self.capture = top(hits, tool).map(|h| Capture { page, owner: h.owner, declines_drag: h.declines_drag });
|
||||
if self.began != Some(None) {
|
||||
return;
|
||||
}
|
||||
self.capture = top(hits, tool).map(|h| Capture { owner: h.owner, declines_drag: h.declines_drag });
|
||||
self.began = Some(Some(page));
|
||||
}
|
||||
|
||||
/// What `page` has to do with the press the pages hold.
|
||||
pub(crate) fn press_for(&self, page: usize) -> PagePress {
|
||||
match (self.began, &self.capture) {
|
||||
(None, _) => PagePress::Free,
|
||||
(Some(Some(p)), Some(capture)) if p == page => PagePress::Mine(capture.owner),
|
||||
(Some(Some(p)), None) if p == page => PagePress::Free,
|
||||
_ => PagePress::Elsewhere,
|
||||
}
|
||||
}
|
||||
|
||||
/// Who holds the press on `page`.
|
||||
pub(crate) fn owner(&self, page: usize) -> Option<Owner> {
|
||||
self.capture.as_ref().filter(|c| c.page == page).map(|c| c.owner)
|
||||
self.press_for(page).owner()
|
||||
}
|
||||
|
||||
/// Whether the press is held by someone who keeps its drag: then the page's text is not
|
||||
@@ -142,12 +195,15 @@ impl PageRouter {
|
||||
pub(crate) fn settle(&mut self, any_down: bool, edges: bool) {
|
||||
if !any_down && !edges {
|
||||
self.capture = None;
|
||||
self.began = None;
|
||||
}
|
||||
}
|
||||
|
||||
/// Drops the press (Escape, a dialog, automation's cancel).
|
||||
/// Drops the press (Escape, automation's cancel): every page is the active tool's again
|
||||
/// ([`PagePress::Free`]). Page input skips a press Escape cancelled until the button is up.
|
||||
pub(crate) fn cancel(&mut self) {
|
||||
self.capture = None;
|
||||
self.began = None;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -172,6 +228,7 @@ mod tests {
|
||||
#[test]
|
||||
fn a_press_is_held_until_the_button_is_up_and_its_release_seen() {
|
||||
let mut r = PageRouter::default();
|
||||
r.begin();
|
||||
r.press(2, [hit(Layer::Comment, 7)], QuickTool::Select);
|
||||
assert_eq!(r.owner(2), Some(hit(Layer::Comment, 7).owner));
|
||||
assert_eq!(r.owner(1), None, "only on its page");
|
||||
@@ -180,14 +237,49 @@ mod tests {
|
||||
assert!(r.owner(2).is_some(), "the release frame still belongs to the press");
|
||||
r.settle(false, false);
|
||||
assert_eq!(r.owner(2), None);
|
||||
r.begin();
|
||||
r.press(0, [], QuickTool::Select);
|
||||
assert_eq!(r.owner(0), None, "a press nobody claims is held by nobody");
|
||||
assert!(!r.keeps_drag());
|
||||
}
|
||||
|
||||
/// A page is told whether the press is its owner's, the active tool's, or another page's.
|
||||
#[test]
|
||||
fn each_page_is_told_whether_the_press_is_its_own() {
|
||||
let mut r = PageRouter::default();
|
||||
assert_eq!(r.press_for(3), PagePress::Free, "no button down: every page is the tool's");
|
||||
r.begin();
|
||||
assert_eq!(r.press_for(0), PagePress::Elsewhere, "a press between the pages is no page's");
|
||||
r.press(2, [], QuickTool::Select);
|
||||
assert_eq!((r.press_for(2), r.press_for(1)), (PagePress::Free, PagePress::Elsewhere), "nobody's, on page 2");
|
||||
r.begin();
|
||||
r.press(1, [hit(Layer::Comment, 4)], QuickTool::Select);
|
||||
assert_eq!((r.press_for(1), r.press_for(2)), (PagePress::Mine(hit(Layer::Comment, 4).owner), PagePress::Elsewhere));
|
||||
r.settle(false, true);
|
||||
assert_eq!(r.press_for(2), PagePress::Elsewhere, "until its release has been seen");
|
||||
r.settle(false, false);
|
||||
assert_eq!((r.press_for(1), r.press_for(2)), (PagePress::Free, PagePress::Free));
|
||||
r.begin();
|
||||
r.cancel();
|
||||
// Page input skips a press Escape cancelled until the button is up (`press_cancelled`).
|
||||
assert_eq!(r.press_for(0), PagePress::Free, "a cancelled press leaves every page to the tool");
|
||||
}
|
||||
|
||||
/// Pages that touch (the gaps hidden) can share a row of pixels: a press there is the first
|
||||
/// page's to claim it, and the next page's claim is ignored.
|
||||
#[test]
|
||||
fn a_press_where_two_pages_touch_is_the_first_pages() {
|
||||
let mut r = PageRouter::default();
|
||||
r.begin();
|
||||
r.press(0, [hit(Layer::Comment, 1)], QuickTool::Select);
|
||||
r.press(1, [hit(Layer::Comment, 2)], QuickTool::Select);
|
||||
assert_eq!((r.press_for(0), r.press_for(1)), (PagePress::Mine(hit(Layer::Comment, 1).owner), PagePress::Elsewhere));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_highlight_lets_its_drag_go_to_the_text() {
|
||||
let mut r = PageRouter::default();
|
||||
r.begin();
|
||||
r.press(0, [Hit { declines_drag: true, ..hit(Layer::Comment, 0) }], QuickTool::Select);
|
||||
assert!(r.owner(0).is_some() && !r.keeps_drag());
|
||||
r.cancel();
|
||||
|
||||
@@ -402,8 +402,7 @@ mod tests {
|
||||
let doc = session.get(id).expect("open");
|
||||
let index = doc.info.annotations.iter().find(|a| a.subtype == "Sound").expect("listed").index;
|
||||
let ctx = egui::Context::default();
|
||||
let mut cv = CommentView::default();
|
||||
cv.gesture = Some(Gesture::Move { page: 0, index, from: pos2(0.0, 0.0) });
|
||||
let mut cv = CommentView { gesture: Some(Gesture::Move { page: 0, index, from: pos2(0.0, 0.0) }), ..CommentView::default() };
|
||||
let mut drag = SignatureDrag::default();
|
||||
let key = Some((doc.edit_generation(), 0, index));
|
||||
drag.prepare_move(&ctx, doc, &cv, None, false, 1.0);
|
||||
|
||||
@@ -234,6 +234,100 @@ fn view(pages: usize, layout: PageLayout, continuous: bool) -> DocView {
|
||||
DocView::new(DocId(1), &info, ViewDefaults { layout, continuous, ..Default::default() })
|
||||
}
|
||||
|
||||
/// Delivers a raw move event to the same viewport path used by native input.
|
||||
fn viewport_wheel_event(unit: egui::MouseWheelUnit, delta: Vec2) -> egui::Event {
|
||||
egui::Event::MouseWheel { unit, delta, phase: egui::TouchPhase::Move, modifiers: egui::Modifiers::NONE, source: egui::MouseWheelSource::Unknown }
|
||||
}
|
||||
|
||||
/// Runs actual UI passes while explicitly discarding the unused texture output.
|
||||
fn viewport_wheel_frame(ctx: &egui::Context, view: &mut DocView, time: f64, events: Vec<egui::Event>, passes: usize, animate: bool) -> Vec<Vec2> {
|
||||
let screen = Rect::from_min_size(Pos2::ZERO, vec2(600.0, 800.0));
|
||||
let mut events = events;
|
||||
events.insert(0, egui::Event::PointerMoved(screen.center()));
|
||||
let input = egui::RawInput { screen_rect: Some(screen), time: Some(time), predicted_dt: 1.0 / 60.0, events, ..Default::default() };
|
||||
let mut deltas = Vec::new();
|
||||
ctx.run_ui(input, |ui| {
|
||||
let avail = ui.max_rect();
|
||||
assert!(ui.rect_contains_pointer(avail), "the synthetic pointer owns the viewport");
|
||||
let wheel = read_wheel(ui, view, avail, false, false, true, animate);
|
||||
deltas.push(wheel.precise_scroll + wheel.coarse_scroll);
|
||||
assert_eq!(ui.input(|i| i.smooth_scroll_delta), Vec2::ZERO, "egui's wheel copy is drained on every owned pass");
|
||||
if deltas.len() < passes {
|
||||
ui.ctx().request_discard("exercise viewport wheel ownership across passes");
|
||||
}
|
||||
})
|
||||
.drop_without_applying_deltas();
|
||||
assert_eq!(deltas.len(), passes);
|
||||
deltas
|
||||
}
|
||||
|
||||
/// Fixes line distance and discard allowance independently of host preferences.
|
||||
fn viewport_wheel_context() -> egui::Context {
|
||||
let ctx = egui::Context::default();
|
||||
ctx.options_mut(|options| {
|
||||
options.max_passes = std::num::NonZeroUsize::new(3).unwrap();
|
||||
options.input_options.line_scroll_speed = 100.0;
|
||||
});
|
||||
ctx
|
||||
}
|
||||
|
||||
/// A frame's admitted distance is unchanged by additional layout passes.
|
||||
#[test]
|
||||
fn viewport_wheel_discard_passes_neither_repeat_nor_advance_motion() {
|
||||
for animate in [false, true] {
|
||||
let (one, three) = (viewport_wheel_context(), viewport_wheel_context());
|
||||
let (mut single_view, mut multi_view) = (view(2, PageLayout::Single, true), view(2, PageLayout::Single, true));
|
||||
let mut total = Vec2::ZERO;
|
||||
for frame in 0..90 {
|
||||
let events = if frame == 0 {
|
||||
vec![
|
||||
viewport_wheel_event(egui::MouseWheelUnit::Line, vec2(0.0, -1.0)),
|
||||
viewport_wheel_event(egui::MouseWheelUnit::Point, vec2(0.0, -7.0)),
|
||||
]
|
||||
} else {
|
||||
Vec::new()
|
||||
};
|
||||
let time = 1.0 + f64::from(frame) / 60.0;
|
||||
let expected = viewport_wheel_frame(&one, &mut single_view, time, events.clone(), 1, animate);
|
||||
let actual = viewport_wheel_frame(&three, &mut multi_view, time, events, 3, animate);
|
||||
assert!((actual[0] - expected[0]).length() < 0.001, "frame {frame}, animations {animate}: {actual:?} versus {expected:?}");
|
||||
assert_eq!(&actual[1..], &[Vec2::ZERO, Vec2::ZERO], "discarded passes do not spend the retained queue");
|
||||
if frame == 0 {
|
||||
if animate {
|
||||
assert!(actual[0].y < -7.0 && actual[0].y > -107.0, "fine input is direct and the whole coarse amount is eased");
|
||||
} else {
|
||||
assert_eq!(actual[0], vec2(0.0, -107.0));
|
||||
}
|
||||
}
|
||||
total += actual[0];
|
||||
}
|
||||
assert!((total.y + 107.0).abs() < 0.002, "one admitted mixed bucket preserves distance: {total:?}");
|
||||
assert!(!multi_view.wheel_motion.has_pending());
|
||||
}
|
||||
}
|
||||
|
||||
/// Mixed current input survives an older same-axis queue being interrupted.
|
||||
#[test]
|
||||
fn viewport_precise_input_cancels_only_older_motion_on_its_axis() {
|
||||
let (actual_ctx, reference_ctx) = (viewport_wheel_context(), viewport_wheel_context());
|
||||
let (mut actual, mut reference) = (view(2, PageLayout::Single, true), view(2, PageLayout::Single, true));
|
||||
viewport_wheel_frame(&actual_ctx, &mut actual, 1.0, vec![viewport_wheel_event(egui::MouseWheelUnit::Line, vec2(1.0, -1.0))], 1, true);
|
||||
viewport_wheel_frame(&reference_ctx, &mut reference, 1.0, vec![viewport_wheel_event(egui::MouseWheelUnit::Line, vec2(1.0, 0.0))], 1, true);
|
||||
let mixed =
|
||||
vec![viewport_wheel_event(egui::MouseWheelUnit::Line, vec2(0.0, -1.0)), viewport_wheel_event(egui::MouseWheelUnit::Point, vec2(0.0, 2.0))];
|
||||
let mut total = Vec2::ZERO;
|
||||
for frame in 1..90 {
|
||||
let events = if frame == 1 { mixed.clone() } else { Vec::new() };
|
||||
let time = 1.0 + f64::from(frame) / 60.0;
|
||||
let output = viewport_wheel_frame(&actual_ctx, &mut actual, time, events.clone(), 3, true)[0];
|
||||
let expected = viewport_wheel_frame(&reference_ctx, &mut reference, time, events, 1, true)[0];
|
||||
assert!((output - expected).length() < 0.001, "older y motion is canceled, x motion and new coarse input survive");
|
||||
total += output;
|
||||
}
|
||||
assert!(total.x > 0.0, "the untouched x tail continues");
|
||||
assert!((total.y + 98.0).abs() < 0.002, "only the new y bucket is admitted: {total:?}");
|
||||
}
|
||||
|
||||
fn history_search_view() -> DocView {
|
||||
let mut v = view(5, PageLayout::Single, true);
|
||||
v.texts.insert(
|
||||
@@ -1273,6 +1367,141 @@ fn page_and_tile_admission_accounts_for_bytes_before_count_limits() {
|
||||
assert!(!v.admit_texture(RenderRequest::default(), PAGE_BYTES + 1));
|
||||
}
|
||||
|
||||
/// The frame demand of a continuous view showing `shown`, with its prefetch, in queue order.
|
||||
fn scroll_demand(v: &DocView, shown: &[usize]) -> Vec<RenderRequest> {
|
||||
let mut wanted: Vec<(usize, f32, u64, Option<Tile>)> = shown.iter().map(|&p| (p, 1.0, 1000, None)).collect();
|
||||
wanted.extend(scroll_prefetch(v, shown).into_iter().map(|p| (p, 1.0, 1000, None)));
|
||||
order_demand(v, &mut wanted, shown);
|
||||
wanted.into_iter().map(|(page, scale, tag, tile)| RenderRequest { page, scale, tag, tile, ..Default::default() }).collect()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn continuous_view_prefetches_the_rows_ahead_of_the_way_it_moved() {
|
||||
let mut v = view(20, PageLayout::Single, true);
|
||||
v.current = 10;
|
||||
assert!(scroll_prefetch(&v, &[9, 10]).is_empty(), "nothing before the view moves");
|
||||
v.scroll_dir = 1;
|
||||
assert_eq!(scroll_prefetch(&v, &[9, 10]), [11, 12]);
|
||||
v.scroll_dir = -1;
|
||||
assert_eq!(scroll_prefetch(&v, &[9, 10]), [8, 7]);
|
||||
assert_eq!(scroll_prefetch(&v, &[0, 1]), Vec::<usize>::new(), "nothing above the first page");
|
||||
let mut two = view(20, PageLayout::TwoUp, true);
|
||||
two.scroll_dir = 1;
|
||||
assert_eq!(scroll_prefetch(&two, &[8, 9]), [10, 11, 12, 13], "two rows of two pages");
|
||||
let mut single = view(20, PageLayout::Single, false);
|
||||
single.scroll_dir = 1;
|
||||
assert!(scroll_prefetch(&single, &[9]).is_empty(), "single-page view keeps its own prefetch");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn scrolling_the_other_way_drops_the_prefetch_from_the_queue() {
|
||||
let info = DocInfo {
|
||||
pages: (0..20)
|
||||
.map(|_| pdfcraft_render::PageInfo { width: 300.0, height: 400.0, label: String::new(), crop: [0.0, 0.0, 300.0, 400.0], rotation: 0 })
|
||||
.collect(),
|
||||
..Default::default()
|
||||
};
|
||||
let mut v = DocView::new(DocId(1), &info, ViewDefaults { continuous: true, ..Default::default() });
|
||||
v.current = 10;
|
||||
v.scroll_dir = 1;
|
||||
v.frame_visible = [9, 10].into();
|
||||
v.frame_queue = scroll_demand(&v, &[9, 10]);
|
||||
let down: Vec<usize> = v.prepare_render_queue(&info, 1.0).iter().map(|r| r.page).collect();
|
||||
assert_eq!(down, [10, 9, 11, 12], "on-screen pages first, then the pages below");
|
||||
v.scroll_dir = -1;
|
||||
v.frame_queue = scroll_demand(&v, &[9, 10]);
|
||||
let up: Vec<usize> = v.prepare_render_queue(&info, 1.0).iter().map(|r| r.page).collect();
|
||||
assert_eq!(up, [10, 9, 8, 7], "the pages below leave the queue, which cancels their renders");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_way_the_view_moved_does_not_reorder_the_pages_on_screen() {
|
||||
let mut v = view(20, PageLayout::Single, true);
|
||||
v.current = 10;
|
||||
let shown = [8, 9, 10, 11, 12];
|
||||
let still: Vec<usize> = scroll_demand(&v, &shown).iter().map(|r| r.page).collect();
|
||||
v.scroll_dir = 1;
|
||||
let down: Vec<usize> = scroll_demand(&v, &shown).iter().map(|r| r.page).collect();
|
||||
assert_eq!(down[..5], still[..5], "on-screen pages keep their order");
|
||||
assert_eq!(down[5..], [13, 14]);
|
||||
// Off-screen pages ahead of the move come before nearer ones behind it.
|
||||
let mut wanted = vec![(9, 1.0, 1000, None), (13, 1.0, 1000, None), (10, 1.0, 1000, None)];
|
||||
order_demand(&v, &mut wanted, &[10]);
|
||||
assert_eq!(wanted.iter().map(|w| w.0).collect::<Vec<_>>(), [10, 13, 9]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_prefetch_ahead_stays_within_the_page_allowance() {
|
||||
let mut info = thumbnail_info(20);
|
||||
for p in &mut info.pages {
|
||||
p.width = 2000.0;
|
||||
p.height = 2000.0;
|
||||
}
|
||||
let mut v = DocView::new(DocId(1), &info, ViewDefaults { continuous: true, ..Default::default() });
|
||||
v.current = 3;
|
||||
v.scroll_dir = 1;
|
||||
// Eight 16 MB pages on screen leave no room in the 128 MiB allowance for another.
|
||||
let shown: Vec<usize> = (0..8).collect();
|
||||
v.frame_visible = shown.iter().copied().collect();
|
||||
v.frame_queue = scroll_demand(&v, &shown);
|
||||
assert!(v.frame_queue.iter().any(|r| r.page == 8), "the prefetch asks for the next page");
|
||||
let pages: Vec<usize> = v.prepare_render_queue(&info, 1.0).iter().map(|r| r.page).collect();
|
||||
assert_eq!(pages.iter().copied().max(), Some(7), "no prefetch past the allowance: {pages:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_arriving_raster_evicts_pages_nobody_asks_for_and_then_pages_behind_the_scroll() {
|
||||
let ctx = egui::Context::default();
|
||||
ctx.input_mut(|i| i.max_texture_side = 4096);
|
||||
let mut v = view(20, PageLayout::Single, true);
|
||||
let texture = |name| ctx.load_texture(name, egui::ColorImage::filled([4000, 4000], Color32::WHITE), TextureOptions::LINEAR);
|
||||
v.current = 10;
|
||||
v.scroll_dir = 1;
|
||||
v.frame_visible = [10].into();
|
||||
// A prefetch off screen: a raster arriving on screen would widen the allowance to hold it.
|
||||
let page = RenderRequest { page: 11, scale: 1.0, tag: 1000, ..Default::default() };
|
||||
let bytes = rgba_bytes(4000, 4000);
|
||||
// Page 7 is behind the scroll and no longer asked for; page 14 is the prefetch ahead.
|
||||
v.frame_demanded = [10, 11, 14].into();
|
||||
v.pages.insert(7, PageTex { tag: 1000, tex: texture("behind") });
|
||||
v.pages.insert(14, PageTex { tag: 1000, tex: texture("ahead") });
|
||||
assert!(v.admit_texture(page, bytes));
|
||||
assert!(v.pages.contains_key(&14) && !v.pages.contains_key(&7), "the page nobody asks for goes first");
|
||||
// Both asked for: the page behind the scroll goes, though it is nearer.
|
||||
v.frame_demanded = [7, 10, 11, 14].into();
|
||||
v.pages.insert(7, PageTex { tag: 1000, tex: texture("behind") });
|
||||
assert!(v.admit_texture(page, bytes));
|
||||
assert!(v.pages.contains_key(&14) && !v.pages.contains_key(&7), "the page behind the scroll goes first");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_tiled_page_ahead_keeps_its_sharper_raster() {
|
||||
let ctx = egui::Context::default();
|
||||
let mut v = view(20, PageLayout::Single, true);
|
||||
let p = pdfcraft_render::PageInfo { width: 300.0, height: 400.0, label: String::new(), crop: [0.0, 0.0, 300.0, 400.0], rotation: 0 };
|
||||
let (scale, max_side) = (12.0, 16384.0);
|
||||
let backdrop = BASE_SIDE / 400.0;
|
||||
// At 12× the page is 4800 pixels tall: tiled, with a 2048-pixel backdrop.
|
||||
assert_eq!(prefetch_demand(&v, &p, 3, scale, scale_tag(scale), max_side), (3, backdrop, scale_tag(backdrop), None));
|
||||
assert_eq!(prefetch_demand(&v, &p, 3, 2.0, scale_tag(2.0), max_side), (3, 2.0, scale_tag(2.0), None), "not tiled: the page as drawn");
|
||||
let texture = |name| ctx.load_texture(name, egui::ColorImage::filled([1, 1], Color32::WHITE), TextureOptions::LINEAR);
|
||||
v.pages.insert(3, PageTex { tag: scale_tag(8.0), tex: texture("sharper") });
|
||||
assert_eq!(prefetch_demand(&v, &p, 3, scale, scale_tag(scale), max_side), (3, 8.0, scale_tag(8.0), None), "the sharper raster is kept");
|
||||
v.pages.insert(3, PageTex { tag: scale_tag(2.0), tex: texture("softer") });
|
||||
assert_eq!(prefetch_demand(&v, &p, 3, scale, scale_tag(scale), max_side), (3, backdrop, scale_tag(backdrop), None));
|
||||
v.pages.insert(3, PageTex { tag: STALE_TAG, tex: texture("stale") });
|
||||
assert_eq!(prefetch_demand(&v, &p, 3, scale, scale_tag(scale), max_side), (3, backdrop, scale_tag(backdrop), None));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_zoom_or_layout_change_clears_the_scroll_direction() {
|
||||
assert_eq!(scroll_direction(0, 40.0, false), 1);
|
||||
assert_eq!(scroll_direction(1, -40.0, false), -1);
|
||||
assert_eq!(scroll_direction(-1, 0.2, false), -1, "a still view keeps its direction");
|
||||
assert_eq!(scroll_direction(1, -300.0, true), 0, "a zoom out moves the offset up without a scroll");
|
||||
assert_eq!(scroll_direction(-1, 300.0, true), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn on_screen_pages_and_tiles_are_admitted_beyond_the_prefetch_allowance() {
|
||||
let ctx = egui::Context::default();
|
||||
@@ -1300,6 +1529,99 @@ fn on_screen_pages_and_tiles_are_admitted_beyond_the_prefetch_allowance() {
|
||||
assert_eq!(v.prepare_render_queue(&info, 1.0).len(), 40);
|
||||
}
|
||||
|
||||
/// `count` pages that each make a 2,980 x 3,850 raster (about 43.8 MiB, a Letter page at fit
|
||||
/// width in a 3440 x 1440 window) at scale `1 / size`.
|
||||
fn fit_width_pages(count: usize, size: f32) -> DocInfo {
|
||||
let mut info = thumbnail_info(count);
|
||||
for p in &mut info.pages {
|
||||
p.width = 2980.0 * size;
|
||||
p.height = 3850.0 * size;
|
||||
}
|
||||
info
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn large_pages_on_screen_widen_the_allowance_for_the_pages_around_them() {
|
||||
// A wide window at fit width, or smaller pages zoomed in: the raster's size is what counts.
|
||||
for (size, scale) in [(1.0, 1.0), (0.5, 2.0)] {
|
||||
let info = fit_width_pages(5, size);
|
||||
let mut v = DocView::new(DocId(1), &info, ViewDefaults::default());
|
||||
v.frame_visible = HashSet::from([3, 4]);
|
||||
v.frame_queue = (0..5).map(|page| RenderRequest { page, scale, tag: 1000, ..Default::default() }).collect();
|
||||
let pages: Vec<usize> = v.prepare_render_queue(&info, 1.0).iter().map(|r| r.page).collect();
|
||||
assert_eq!(pages, (0..5).collect::<Vec<_>>(), "two pages on screen and three off screen at scale {scale}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tiled_pages_on_screen_keep_the_128_mib_page_allowance() {
|
||||
let info = fit_width_pages(8, 1.0);
|
||||
let mut v = DocView::new(DocId(1), &info, ViewDefaults::default());
|
||||
v.frame_visible = HashSet::from([3, 4]);
|
||||
// Pages 3 and 4 are on screen as a backdrop and tiles, beside whole pages off screen.
|
||||
let mut queue: Vec<RenderRequest> = [3, 4]
|
||||
.into_iter()
|
||||
.flat_map(|page| {
|
||||
[
|
||||
RenderRequest { page, scale: 0.25, tag: 2000, ..Default::default() },
|
||||
RenderRequest { page, scale: 1.0, tag: 1000, tile: Some(Tile { x: 0, y: 0, w: 1024, h: 1024 }), ..Default::default() },
|
||||
]
|
||||
})
|
||||
.collect();
|
||||
queue.extend([2, 5, 1, 6, 0, 7].map(|page| RenderRequest { page, scale: 1.0, tag: 1000, ..Default::default() }));
|
||||
v.frame_queue = queue;
|
||||
let pages: Vec<usize> = v.prepare_render_queue(&info, 1.0).iter().filter(|r| r.tile.is_none()).map(|r| r.page).collect();
|
||||
assert_eq!(pages, vec![3, 4, 2, 5], "two backdrops and two whole pages fit in 128 MiB");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rasters_on_screen_size_the_allowance_for_arriving_pages() {
|
||||
let ctx = egui::Context::default();
|
||||
ctx.begin_pass(egui::RawInput { max_texture_side: Some(4096), ..Default::default() });
|
||||
let info = fit_width_pages(8, 1.0);
|
||||
let mut v = DocView::new(DocId(1), &info, ViewDefaults::default());
|
||||
let off_screen = RenderRequest { page: 0, scale: 1.0, tag: 1000, ..Default::default() };
|
||||
let mib = 1024 * 1024;
|
||||
assert!(!v.admit_texture(off_screen, 150 * mib), "with nothing on screen the allowance is 128 MiB");
|
||||
v.frame_visible = HashSet::from([3, 4]);
|
||||
v.last_queue = [3, 4].map(|page| RenderRequest { page, scale: 1.0, tag: 1000, ..Default::default() }).to_vec();
|
||||
for req in v.last_queue.clone() {
|
||||
assert!(v.receive_result(&ctx, solid_result(req, 2980, 3850)) > 0, "on-screen page {} uploaded", req.page);
|
||||
}
|
||||
assert!(v.admit_texture(off_screen, 150 * mib), "two 43.8 MiB pages on screen allow 350 MiB, or 256 MiB on the web");
|
||||
assert!(!v.admit_texture(off_screen, 400 * mib), "past the largest allowance");
|
||||
ctx.end_pass().textures_delta.clear();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_raster_held_on_screen_without_a_request_sizes_the_allowance() {
|
||||
let ctx = egui::Context::default();
|
||||
ctx.begin_pass(egui::RawInput { max_texture_side: Some(4096), ..Default::default() });
|
||||
let info = fit_width_pages(8, 1.0);
|
||||
let mut v = DocView::new(DocId(1), &info, ViewDefaults::default());
|
||||
v.frame_visible = HashSet::from([3]);
|
||||
let req = RenderRequest { page: 3, scale: 1.0, tag: 1000, ..Default::default() };
|
||||
v.last_queue = vec![req];
|
||||
assert!(v.receive_result(&ctx, solid_result(req, 2980, 3850)) > 0);
|
||||
// A zoom hold leaves page 3's request out while its raster stays on screen.
|
||||
v.frame_queue = [2, 4, 1].map(|page| RenderRequest { page, scale: 1.0, tag: 1000, ..Default::default() }).to_vec();
|
||||
let pages: Vec<usize> = v.prepare_render_queue(&info, 1.0).iter().map(|r| r.page).collect();
|
||||
assert_eq!(pages, vec![2, 4, 1]);
|
||||
assert!(v.pages.contains_key(&3), "the held raster is kept beside the prefetch");
|
||||
ctx.end_pass().textures_delta.clear();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_page_allowance_is_eight_on_screen_rasters_within_its_limits() {
|
||||
let mib = 1024 * 1024;
|
||||
assert_eq!(cache::page_budget(0), PAGE_BYTES);
|
||||
assert_eq!(cache::page_budget(10 * mib), PAGE_BYTES);
|
||||
assert_eq!(cache::page_budget(20 * mib), 160 * mib);
|
||||
let ceiling = cache::page_budget(usize::MAX);
|
||||
assert_eq!(cache::page_budget(64 * mib), ceiling);
|
||||
assert_eq!(ceiling, if cfg!(target_arch = "wasm32") { 256 * mib } else { 384 * mib });
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_page_turned_back_to_is_still_cached() {
|
||||
let ctx = egui::Context::default();
|
||||
@@ -2037,3 +2359,24 @@ fn image_handles_account_for_document_and_view_rotation() {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Cancelling the pages' pointer gestures (Escape, automation's cancel) lets go of a
|
||||
/// camera corner being dragged: the quadrilateral stays, and no corner follows the pointer.
|
||||
#[test]
|
||||
fn cancelling_pointer_gestures_lets_go_of_a_camera_corner() {
|
||||
let mut v = view(1, PageLayout::Single, true);
|
||||
v.camera = Some(crate::camera_ui::CameraQuad { grab: Some(2), ..crate::camera_ui::CameraQuad::inset(0, 300.0, 400.0) });
|
||||
v.cancel_pointer_gestures();
|
||||
assert_eq!(v.camera.map(|q| q.grab), Some(None));
|
||||
}
|
||||
|
||||
/// A camera corner at the page's edge is hit on the page only: a press off the page is no page's,
|
||||
/// so its grab cursor does not show there.
|
||||
#[test]
|
||||
fn a_camera_corner_at_the_page_edge_is_hit_on_the_page_only() {
|
||||
let mut v = view(1, PageLayout::Single, true);
|
||||
v.camera = Some(crate::camera_ui::CameraQuad { page: 0, corners: [[0.0, 0.0], [300.0, 0.0], [300.0, 400.0], [0.0, 400.0]], grab: None });
|
||||
let xf = PageXform { rect: Rect::from_min_size(pos2(10.0, 20.0), egui::vec2(300.0, 400.0)), rot: 0, pw: 300.0, ph: 400.0 };
|
||||
assert!(crate::camera_ui::hit(&xf, 0, &v, pos2(14.0, 24.0)).is_some(), "on the page");
|
||||
assert!(crate::camera_ui::hit(&xf, 0, &v, pos2(6.0, 16.0)).is_none(), "just off it");
|
||||
}
|
||||
@@ -1,9 +1,10 @@
|
||||
//! Bounded acceleration for coarse wheel input in the document viewport.
|
||||
//!
|
||||
//! Line-unit events describe notches, not motion over time. A fixed distance per
|
||||
//! notch makes a fast spin feel slow, so this module derives a bounded multiplier
|
||||
//! from arrival time and direction. The state is constant-size and leaves isolated
|
||||
//! notches unchanged.
|
||||
//! Coarse line events use a bounded arrival-rate multiplier and one motion curve
|
||||
//! for their whole distance. Isolated notches retain their distance. Fractional line
|
||||
//! components stay direct on their own axes; explicitly continuous sources stay direct
|
||||
//! on both axes. Fractional values alone do not identify the physical device.
|
||||
//! Retained motion uses constant-size state.
|
||||
|
||||
use egui::Vec2;
|
||||
|
||||
@@ -20,9 +21,12 @@ const MAX_TICKS: u32 = 13;
|
||||
/// Extra ticks retained beyond the ceiling. They absorb a few slow events
|
||||
/// before the visible multiplier starts to fall.
|
||||
const HYSTERESIS_TICKS: u32 = 4;
|
||||
/// Maximum scroll applied from one frame of coarse input, in points per axis.
|
||||
/// Each event is clamped first; this caps the sum.
|
||||
/// Per-axis bound for a normalized bucket, accelerated surplus or emitted motion step.
|
||||
pub(crate) const MAX_FRAME_POINTS: f32 = 8192.0;
|
||||
/// Per-axis motion input limit after combining base, surplus and Page distance.
|
||||
const MAX_MOTION_INPUT_POINTS: f32 = 2.0 * MAX_FRAME_POINTS;
|
||||
/// Retained motion permits a transient burst beyond one output frame.
|
||||
const MAX_PENDING_POINTS: f32 = 2.0 * MAX_FRAME_POINTS;
|
||||
/// Per-event clamp, in native units (lines or pages). Keeps one hostile event
|
||||
/// bounded before points conversion.
|
||||
pub(crate) const MAX_EVENT_UNITS: f32 = 10.0;
|
||||
@@ -74,15 +78,95 @@ impl WheelBoost {
|
||||
}
|
||||
}
|
||||
|
||||
/// Caps one frame of accumulated coarse scroll, per axis. A non-finite axis
|
||||
/// Caps a normalized bucket or output step, per axis. A non-finite axis
|
||||
/// maps to zero; the other axis is preserved.
|
||||
pub(crate) fn cap_frame(delta: Vec2) -> Vec2 {
|
||||
cap_points(delta, MAX_FRAME_POINTS)
|
||||
}
|
||||
|
||||
/// Caps finite point distances independently; invalid axes contribute no distance.
|
||||
fn cap_points(delta: Vec2, limit: f32) -> Vec2 {
|
||||
Vec2::new(
|
||||
if delta.x.is_finite() { delta.x.clamp(-MAX_FRAME_POINTS, MAX_FRAME_POINTS) } else { 0.0 },
|
||||
if delta.y.is_finite() { delta.y.clamp(-MAX_FRAME_POINTS, MAX_FRAME_POINTS) } else { 0.0 },
|
||||
if delta.x.is_finite() { delta.x.clamp(-limit, limit) } else { 0.0 },
|
||||
if delta.y.is_finite() { delta.y.clamp(-limit, limit) } else { 0.0 },
|
||||
)
|
||||
}
|
||||
|
||||
/// Eases the whole coarse-wheel distance, including its unaccelerated part.
|
||||
///
|
||||
/// The caller owns input once per egui frame, cancels old motion on direct-input
|
||||
/// axes before stepping, and requests another frame while motion is pending.
|
||||
/// Each axis admits up to 16384 input points and retains up to 16384 pending
|
||||
/// points, emitting at most 8192 per frame. Input beyond those finite capacities
|
||||
/// is dropped; isolated base-plus-surplus bursts are preserved when there is room.
|
||||
#[derive(Debug, Default)]
|
||||
pub(crate) struct Motion {
|
||||
pending: Vec2,
|
||||
last: Option<f64>,
|
||||
}
|
||||
|
||||
impl Motion {
|
||||
/// Forgets owed distance and its clock when input ownership or navigation changes.
|
||||
pub(crate) fn reset(&mut self) {
|
||||
*self = Self::default();
|
||||
}
|
||||
|
||||
/// Drops older coarse motion on axes carrying direct input. This must happen
|
||||
/// before adding this frame's coarse input, so mixed input is retained.
|
||||
pub(crate) fn cancel_axes(&mut self, direct: Vec2) {
|
||||
if direct.x != 0.0 {
|
||||
self.pending.x = 0.0;
|
||||
}
|
||||
if direct.y != 0.0 {
|
||||
self.pending.y = 0.0;
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether another frame is needed to deliver admitted coarse movement.
|
||||
pub(crate) fn has_pending(&self) -> bool {
|
||||
self.pending != Vec2::ZERO
|
||||
}
|
||||
|
||||
/// Consumes a bounded frame bucket. Reversal cancels the older direction on
|
||||
/// that axis. Disabling animation drains existing and new input immediately,
|
||||
/// except for overflow beyond the frame cap. A stale clock cancels the old
|
||||
/// tail; an invalid clock also limits fresh input to one output frame without
|
||||
/// retaining it. Pending plus fresh input cannot exceed queue and output capacity.
|
||||
pub(crate) fn step(&mut self, input: Vec2, now: f64, dt: f32, animate: bool) -> Vec2 {
|
||||
let input = cap_points(input, MAX_MOTION_INPUT_POINTS);
|
||||
let stale = !now.is_finite() || self.last.is_some_and(|last| now < last || now - last > RESET_GAP_SECS);
|
||||
if stale {
|
||||
self.pending = Vec2::ZERO;
|
||||
}
|
||||
self.last = now.is_finite().then_some(now);
|
||||
if !now.is_finite() {
|
||||
self.pending = Vec2::ZERO;
|
||||
return cap_frame(input);
|
||||
}
|
||||
// Use a valid elapsed frame interval rather than letting invalid or very
|
||||
// large intervals erase the distinction between animated and direct input.
|
||||
let dt = if dt.is_finite() && dt > 0.0 { dt.min(0.1) } else { 1.0 / 60.0 };
|
||||
let fraction = if animate { 1.0 - 0.1_f32.powf(dt / 0.1) } else { 1.0 };
|
||||
Vec2::new(Self::step_axis(&mut self.pending.x, input.x, fraction), Self::step_axis(&mut self.pending.y, input.y, fraction))
|
||||
}
|
||||
|
||||
/// Delivers one axis while bounding both the returned step and remaining distance.
|
||||
fn step_axis(pending: &mut f32, input: f32, fraction: f32) -> f32 {
|
||||
if input != 0.0 && input.signum() != pending.signum() {
|
||||
*pending = 0.0;
|
||||
}
|
||||
let capacity = MAX_PENDING_POINTS + MAX_FRAME_POINTS;
|
||||
let total = (*pending + input).clamp(-capacity, capacity);
|
||||
// Emit enough overflow to keep both output and pending bounded, without
|
||||
// discarding distance after the finite queue's admission boundary.
|
||||
let magnitude = total.abs();
|
||||
let emitted = if magnitude <= 0.01 { magnitude } else { (magnitude * fraction).max(magnitude - MAX_PENDING_POINTS).min(MAX_FRAME_POINTS) };
|
||||
let output = total.signum() * emitted;
|
||||
*pending = total - output;
|
||||
output
|
||||
}
|
||||
}
|
||||
|
||||
/// One frame of wheel input, normalized in a single pass. Line motion is in
|
||||
/// points; page motion remains in native units until the viewport is known.
|
||||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||||
@@ -98,38 +182,39 @@ pub(crate) fn accumulate(events: &[egui::Event], line_points: f32, single_paging
|
||||
let line_points = sanitize_scale(line_points);
|
||||
let mut out = FrameInput::default();
|
||||
for event in events {
|
||||
let egui::Event::MouseWheel { unit, delta, modifiers, .. } = event else { continue };
|
||||
let egui::Event::MouseWheel { unit, delta, modifiers, source, .. } = event else { continue };
|
||||
if modifiers.command || modifiers.ctrl {
|
||||
continue; // Zooming, not scrolling.
|
||||
}
|
||||
if !delta.is_finite() {
|
||||
continue;
|
||||
}
|
||||
// Fractional native line components use a distance-preserving routing policy for
|
||||
// high-resolution input, not evidence of a particular physical device.
|
||||
// Inspect before clamping or axis folding, which can hide fractions.
|
||||
let continuous = matches!(source, egui::MouseWheelSource::Trackpad | egui::MouseWheelSource::Momentum);
|
||||
let direct_x = continuous || delta.x.fract() != 0.0 || (modifiers.shift && delta.y.fract() != 0.0);
|
||||
let direct_y = continuous || delta.y.fract() != 0.0;
|
||||
let delta = if modifiers.shift { Vec2::new(delta.x + delta.y, 0.0) } else { *delta };
|
||||
if !delta.is_finite() {
|
||||
continue;
|
||||
}
|
||||
match unit {
|
||||
egui::MouseWheelUnit::Point if modifiers.shift => {
|
||||
// Shift scrolls sideways, matching egui's own wheel handling.
|
||||
let sum = delta.x + delta.y;
|
||||
if sum.is_finite() {
|
||||
out.precise.x += sum;
|
||||
}
|
||||
}
|
||||
egui::MouseWheelUnit::Point => out.precise += *delta,
|
||||
egui::MouseWheelUnit::Line if modifiers.shift => {
|
||||
let sum = delta.x + delta.y;
|
||||
if sum.is_finite() {
|
||||
out.line.x += sum.clamp(-MAX_EVENT_UNITS, MAX_EVENT_UNITS) * line_points;
|
||||
}
|
||||
}
|
||||
egui::MouseWheelUnit::Point => out.precise += delta,
|
||||
egui::MouseWheelUnit::Line => {
|
||||
out.line.x += delta.x.clamp(-MAX_EVENT_UNITS, MAX_EVENT_UNITS) * line_points;
|
||||
if !single_paging {
|
||||
out.line.y += delta.y.clamp(-MAX_EVENT_UNITS, MAX_EVENT_UNITS) * line_points;
|
||||
let mut points = delta.clamp(Vec2::splat(-MAX_EVENT_UNITS), Vec2::splat(MAX_EVENT_UNITS)) * line_points;
|
||||
if single_paging {
|
||||
points.y = 0.0;
|
||||
}
|
||||
}
|
||||
egui::MouseWheelUnit::Page if modifiers.shift => {
|
||||
let sum = delta.x + delta.y;
|
||||
if sum.is_finite() {
|
||||
out.page.x += sum.clamp(-MAX_EVENT_UNITS, MAX_EVENT_UNITS);
|
||||
if direct_x {
|
||||
out.precise.x += points.x;
|
||||
} else {
|
||||
out.line.x += points.x;
|
||||
}
|
||||
if direct_y {
|
||||
out.precise.y += points.y;
|
||||
} else {
|
||||
out.line.y += points.y;
|
||||
}
|
||||
}
|
||||
egui::MouseWheelUnit::Page => {
|
||||
@@ -145,10 +230,10 @@ pub(crate) fn accumulate(events: &[egui::Event], line_points: f32, single_paging
|
||||
out
|
||||
}
|
||||
|
||||
/// Converts the frame total to the extra scroll delta beyond egui's share.
|
||||
/// Converts the frame total to the accelerated surplus.
|
||||
///
|
||||
/// egui applies the base distance through its own smoothing. This function
|
||||
/// returns only the accelerated surplus, so an isolated notch adds nothing.
|
||||
/// The caller adds this to the base distance before passing the whole coarse
|
||||
/// bucket to `Motion`, so an isolated notch adds no surplus.
|
||||
/// Each axis advances once per frame; events batched into one frame cannot
|
||||
/// accelerate one another. Output is frame-capped.
|
||||
pub(crate) fn boost_extra(input: FrameInput, boost_x: &mut WheelBoost, boost_y: &mut WheelBoost, now: f64) -> Vec2 {
|
||||
@@ -171,6 +256,283 @@ fn sanitize_scale(points: f32) -> f32 {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
/// Easing preserves distance and terminates at each tested refresh rate.
|
||||
#[test]
|
||||
fn whole_distance_eases_and_settles_at_each_frame_rate() {
|
||||
for hz in [30, 60, 144] {
|
||||
let dt = 1.0 / hz as f32;
|
||||
let mut motion = Motion::default();
|
||||
let first = motion.step(egui::vec2(0.0, -600.0), 1.0, dt, true);
|
||||
assert!(first.y < 0.0 && first.y > -600.0);
|
||||
let mut total = first.y;
|
||||
for frame in 1..=hz * 2 {
|
||||
let delta = motion.step(Vec2::ZERO, 1.0 + f64::from(frame) / f64::from(hz), dt, true);
|
||||
assert!(delta.y <= 0.0);
|
||||
total += delta.y;
|
||||
}
|
||||
assert!((total + 600.0).abs() < 0.002, "{hz} Hz: {total}");
|
||||
assert!(!motion.has_pending());
|
||||
}
|
||||
}
|
||||
|
||||
/// Timing follows elapsed seconds rather than a fixed number of frames.
|
||||
#[test]
|
||||
fn equal_elapsed_time_consumes_the_same_share_at_different_cadences() {
|
||||
let expected = 600.0 * (1.0 - 0.1_f32.powf(5.0 / 3.0));
|
||||
for hz in [30, 60, 144] {
|
||||
let mut motion = Motion::default();
|
||||
let mut total = 0.0;
|
||||
for frame in 0..hz / 6 {
|
||||
let input = if frame == 0 { egui::vec2(600.0, 0.0) } else { Vec2::ZERO };
|
||||
total += motion.step(input, 1.0 + f64::from(frame) / f64::from(hz), 1.0 / hz as f32, true).x;
|
||||
}
|
||||
assert!((total - expected).abs() < 0.01, "{hz} Hz: {total} versus {expected}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Reversing one axis preserves the other axis's admitted distance.
|
||||
#[test]
|
||||
fn motion_reversal_cancels_only_the_reversed_axis() {
|
||||
let mut motion = Motion::default();
|
||||
motion.step(egui::vec2(120.0, -600.0), 1.0, 0.01, true);
|
||||
let retained_x = motion.pending.x;
|
||||
let delta = motion.step(egui::vec2(0.0, 100.0), 1.01, 0.01, true);
|
||||
assert!(delta.x > 0.0 && delta.y > 0.0);
|
||||
assert!((delta.x + motion.pending.x - retained_x).abs() < 0.001);
|
||||
assert!((delta.y + motion.pending.y - 100.0).abs() < 0.001);
|
||||
}
|
||||
|
||||
/// An isolated base-plus-surplus burst can settle without losing its requested distance.
|
||||
#[test]
|
||||
fn transient_burst_above_one_output_frame_preserves_distance() {
|
||||
for distance in [9600.0, 2.0 * MAX_FRAME_POINTS] {
|
||||
let mut motion = Motion::default();
|
||||
let mut total = 0.0;
|
||||
for frame in 0..120 {
|
||||
let input = if frame == 0 { egui::vec2(0.0, -distance) } else { Vec2::ZERO };
|
||||
let output = motion.step(input, 1.0 + f64::from(frame) / 60.0, 1.0 / 60.0, true);
|
||||
assert!(output.is_finite() && output.y.abs() <= MAX_FRAME_POINTS);
|
||||
total += output.y;
|
||||
}
|
||||
assert!((total + distance).abs() < 0.02, "requested {distance}, delivered {total}");
|
||||
assert!(!motion.has_pending());
|
||||
}
|
||||
}
|
||||
|
||||
/// Direct input interrupts older motion, while a current mixed event still contributes.
|
||||
#[test]
|
||||
fn precise_axes_cancel_old_tail_without_dropping_current_coarse_input() {
|
||||
let mut motion = Motion::default();
|
||||
motion.step(egui::vec2(200.0, -500.0), 1.0, 0.01, true);
|
||||
let retained_x = motion.pending.x;
|
||||
motion.cancel_axes(egui::vec2(0.0, 0.25));
|
||||
let delta = motion.step(egui::vec2(0.0, -80.0), 1.01, 0.01, true);
|
||||
assert!((delta.x + motion.pending.x - retained_x).abs() < 0.001);
|
||||
assert!((delta.y + motion.pending.y + 80.0).abs() < 0.001);
|
||||
}
|
||||
|
||||
/// Saturation limits per-frame work without silently losing admitted movement.
|
||||
#[test]
|
||||
fn saturated_motion_bounds_output_and_queue_without_losing_distance() {
|
||||
let mut motion = Motion::default();
|
||||
let mut admitted = 0.0;
|
||||
let mut emitted = 0.0;
|
||||
for frame in 0..80 {
|
||||
let input = if frame < 20 { MAX_FRAME_POINTS } else { 0.0 };
|
||||
admitted += input;
|
||||
let delta = motion.step(egui::vec2(input, 0.0), 1.0 + f64::from(frame) * 0.01, 0.01, true);
|
||||
assert!((0.0..=MAX_FRAME_POINTS).contains(&delta.x));
|
||||
assert!((0.0..=MAX_PENDING_POINTS).contains(&motion.pending.x));
|
||||
emitted += delta.x;
|
||||
assert!((admitted - emitted - motion.pending.x).abs() < 0.1);
|
||||
}
|
||||
}
|
||||
|
||||
/// Sustained arrival above service capacity drops excess only at the finite admission boundary.
|
||||
#[test]
|
||||
fn sustained_double_frame_input_keeps_a_finite_queue_and_output() {
|
||||
let mut motion = Motion::default();
|
||||
let mut requested = 0.0;
|
||||
let mut admitted = 0.0;
|
||||
let mut emitted = 0.0;
|
||||
for frame in 0..160 {
|
||||
let input = if frame < 20 { MAX_MOTION_INPUT_POINTS } else { 0.0 };
|
||||
let previous = motion.pending.x;
|
||||
let total = (previous + input).min(MAX_PENDING_POINTS + MAX_FRAME_POINTS);
|
||||
requested += input;
|
||||
admitted += total - previous;
|
||||
let output = motion.step(egui::vec2(input, -input), 1.0 + f64::from(frame) * 0.01, 0.01, true);
|
||||
emitted += output.x;
|
||||
assert!((0.0..=MAX_FRAME_POINTS).contains(&output.x));
|
||||
assert!((0.0..=MAX_PENDING_POINTS).contains(&motion.pending.x));
|
||||
assert_eq!(output.y, -output.x);
|
||||
assert_eq!(motion.pending.y, -motion.pending.x);
|
||||
assert!((output.x + motion.pending.x - total).abs() < 0.003);
|
||||
assert!((admitted - emitted - motion.pending.x).abs() < 0.15);
|
||||
}
|
||||
assert!(requested > admitted, "a sustained overload must not create an unlimited queue");
|
||||
assert!((emitted - admitted).abs() < 0.15);
|
||||
assert!(!motion.has_pending());
|
||||
}
|
||||
|
||||
/// Input admission permits two output frames, while each emitted step stays independently bounded.
|
||||
#[test]
|
||||
fn oversized_motion_input_is_limited_before_entering_the_queue() {
|
||||
for animate in [false, true] {
|
||||
let mut motion = Motion::default();
|
||||
let mut delivered = 0.0;
|
||||
for frame in 0..120 {
|
||||
let input = if frame == 0 { egui::vec2(4.0 * MAX_FRAME_POINTS, 0.0) } else { Vec2::ZERO };
|
||||
let output = motion.step(input, 1.0 + f64::from(frame) / 60.0, 1.0 / 60.0, animate);
|
||||
assert!(output.x <= MAX_FRAME_POINTS);
|
||||
assert!(motion.pending.x <= MAX_PENDING_POINTS);
|
||||
delivered += output.x;
|
||||
}
|
||||
assert!((delivered - MAX_MOTION_INPUT_POINTS).abs() < 0.02, "animations {animate}: {delivered}");
|
||||
assert!(!motion.has_pending());
|
||||
}
|
||||
}
|
||||
|
||||
/// A non-finite clock neither resumes old movement nor emits an oversized fresh step.
|
||||
#[test]
|
||||
fn invalid_clock_limits_a_fresh_burst_without_retaining_it() {
|
||||
for now in [f64::NAN, f64::INFINITY, f64::NEG_INFINITY] {
|
||||
let mut motion = Motion::default();
|
||||
motion.step(egui::vec2(100.0, 100.0), 1.0, 0.01, true);
|
||||
let output = motion.step(egui::vec2(MAX_MOTION_INPUT_POINTS, -MAX_MOTION_INPUT_POINTS), now, 0.01, true);
|
||||
assert_eq!(output, egui::vec2(MAX_FRAME_POINTS, -MAX_FRAME_POINTS));
|
||||
assert!(!motion.has_pending());
|
||||
assert_eq!(motion.step(Vec2::ZERO, 2.0, 0.01, true), Vec2::ZERO);
|
||||
}
|
||||
}
|
||||
|
||||
/// Turning animation off drains owed movement under the same output cap.
|
||||
#[test]
|
||||
fn disabling_animation_preserves_owed_distance_with_a_bounded_flush() {
|
||||
let mut motion = Motion::default();
|
||||
let first = motion.step(egui::vec2(MAX_FRAME_POINTS, 0.0), 1.0, 0.01, true);
|
||||
let second = motion.step(egui::vec2(MAX_FRAME_POINTS, 0.0), 1.01, 0.01, false);
|
||||
assert_eq!(second.x, MAX_FRAME_POINTS);
|
||||
let last = motion.step(Vec2::ZERO, 1.02, 0.01, false);
|
||||
assert!((first.x + second.x + last.x - 2.0 * MAX_FRAME_POINTS).abs() < 0.002);
|
||||
assert!(!motion.has_pending());
|
||||
assert_eq!(motion.step(egui::vec2(0.0, -100.0), 1.03, 0.01, false), egui::vec2(0.0, -100.0));
|
||||
assert!(!motion.has_pending());
|
||||
}
|
||||
|
||||
/// Invalid input or a discontinuous clock cannot retain an unbounded or stale tail.
|
||||
#[test]
|
||||
fn reset_clock_gaps_and_invalid_values_cannot_reanimate_old_motion() {
|
||||
for next in [0.5, 2.0, f64::NAN, f64::INFINITY] {
|
||||
let mut motion = Motion::default();
|
||||
motion.step(egui::vec2(100.0, -200.0), 1.0, 0.01, true);
|
||||
assert_eq!(motion.step(Vec2::ZERO, next, 0.01, true), Vec2::ZERO);
|
||||
assert!(!motion.has_pending());
|
||||
}
|
||||
for dt in [f32::NAN, f32::INFINITY, -1.0, 0.0, 1e9] {
|
||||
let mut motion = Motion::default();
|
||||
let delta = motion.step(egui::vec2(100.0, f32::NAN), 1.0, dt, true);
|
||||
assert!(delta.x.is_finite() && delta.x > 0.0 && delta.x < 100.0);
|
||||
assert_eq!(delta.y, 0.0);
|
||||
motion.reset();
|
||||
assert!(!motion.has_pending());
|
||||
}
|
||||
}
|
||||
|
||||
/// Normalization cannot hide fractional motion by clamping or combining its axes.
|
||||
#[test]
|
||||
fn fractional_lines_are_direct_before_clamping_or_axis_folding() {
|
||||
use egui::MouseWheelUnit::Line;
|
||||
let input = accumulate(&[wheel(Line, 0.0, -10.5), shifted(Line, 0.5, 0.5)], 100.0, false);
|
||||
assert_eq!(input.precise, egui::vec2(100.0, -1000.0));
|
||||
assert_eq!(input.line, Vec2::ZERO);
|
||||
let events: [egui::Event; 4] = core::array::from_fn(|_| wheel(Line, 0.0, -0.25));
|
||||
let input = accumulate(&events, 100.0, false);
|
||||
assert_eq!(input.precise.y, -100.0);
|
||||
}
|
||||
|
||||
/// Source hints and partial-notch distances each independently select direct movement.
|
||||
#[test]
|
||||
fn known_continuous_sources_are_direct_even_for_integral_lines() {
|
||||
for source in [egui::MouseWheelSource::Trackpad, egui::MouseWheelSource::Momentum] {
|
||||
let mut event = wheel(egui::MouseWheelUnit::Line, 0.0, -1.0);
|
||||
if let egui::Event::MouseWheel { source: slot, .. } = &mut event {
|
||||
*slot = source;
|
||||
}
|
||||
let input = accumulate(&[event], 100.0, false);
|
||||
assert_eq!(input.precise, egui::vec2(0.0, -100.0));
|
||||
assert_eq!(input.line, Vec2::ZERO);
|
||||
let diagonal = egui::Event::MouseWheel {
|
||||
unit: egui::MouseWheelUnit::Line,
|
||||
delta: egui::vec2(0.25, -1.0),
|
||||
phase: egui::TouchPhase::Move,
|
||||
modifiers: egui::Modifiers::NONE,
|
||||
source,
|
||||
};
|
||||
let input = accumulate(&[diagonal], 100.0, false);
|
||||
assert_eq!(input.precise, egui::vec2(25.0, -100.0));
|
||||
assert_eq!(input.line, Vec2::ZERO);
|
||||
}
|
||||
let mut event = wheel(egui::MouseWheelUnit::Line, 0.0, -0.25);
|
||||
if let egui::Event::MouseWheel { source, .. } = &mut event {
|
||||
*source = egui::MouseWheelSource::Wheel;
|
||||
}
|
||||
assert_eq!(accumulate(&[event], 100.0, false).precise, egui::vec2(0.0, -25.0));
|
||||
}
|
||||
|
||||
/// A fractional horizontal component does not change a vertical notch's distance policy.
|
||||
#[test]
|
||||
fn diagonal_fraction_keeps_the_other_axis_coarse() {
|
||||
use egui::MouseWheelUnit::Line;
|
||||
for source in [egui::MouseWheelSource::Unknown, egui::MouseWheelSource::Wheel] {
|
||||
let mut diagonal = wheel(Line, 0.25, -1.0);
|
||||
if let egui::Event::MouseWheel { source: slot, .. } = &mut diagonal {
|
||||
*slot = source;
|
||||
}
|
||||
let mut bx = WheelBoost::default();
|
||||
let mut by = WheelBoost::default();
|
||||
let mut reference_bx = WheelBoost::default();
|
||||
let mut reference_by = WheelBoost::default();
|
||||
let mut motion = Motion::default();
|
||||
let mut reference_motion = Motion::default();
|
||||
for frame in 0..90 {
|
||||
let (input, reference) = if frame < 12 {
|
||||
let input = accumulate(std::slice::from_ref(&diagonal), 100.0, false);
|
||||
assert_eq!(input.precise, egui::vec2(25.0, 0.0), "{source:?}: only the fractional axis is direct");
|
||||
assert_eq!(input.line, egui::vec2(0.0, -100.0));
|
||||
(input, accumulate(&[wheel(Line, 0.0, -1.0)], 100.0, false))
|
||||
} else {
|
||||
(FrameInput::default(), FrameInput::default())
|
||||
};
|
||||
let now = 1.0 + f64::from(frame) / 60.0;
|
||||
let coarse = input.line + boost_extra(input, &mut bx, &mut by, now);
|
||||
let reference_coarse = reference.line + boost_extra(reference, &mut reference_bx, &mut reference_by, now);
|
||||
motion.cancel_axes(input.precise);
|
||||
reference_motion.cancel_axes(reference.precise);
|
||||
assert_eq!(coarse, reference_coarse, "{source:?}: the vertical burst remains unchanged");
|
||||
assert_eq!(motion.step(coarse, now, 1.0 / 60.0, true), reference_motion.step(reference_coarse, now, 1.0 / 60.0, true));
|
||||
}
|
||||
if let egui::Event::MouseWheel { delta, .. } = &mut diagonal {
|
||||
*delta = egui::vec2(1.0, -0.25);
|
||||
}
|
||||
let transposed = accumulate(&[diagonal], 100.0, false);
|
||||
assert_eq!(transposed.precise, egui::vec2(0.0, -25.0));
|
||||
assert_eq!(transposed.line, egui::vec2(100.0, 0.0));
|
||||
}
|
||||
}
|
||||
|
||||
/// Coarse and direct events in one frame keep their respective distance policies.
|
||||
#[test]
|
||||
fn mixed_coarse_and_direct_events_retain_both_buckets() {
|
||||
use egui::MouseWheelUnit::{Line, Point};
|
||||
let input = accumulate(&[wheel(Line, 0.0, -1.0), wheel(Line, 0.0, -0.25), wheel(Point, 2.0, -3.0)], 100.0, false);
|
||||
assert_eq!(input.line, egui::vec2(0.0, -100.0));
|
||||
assert_eq!(input.precise, egui::vec2(2.0, -28.0));
|
||||
let input = accumulate(&[wheel(Line, 2.0, -0.25)], 100.0, true);
|
||||
assert_eq!(input.precise, Vec2::ZERO);
|
||||
assert_eq!(input.line, egui::vec2(200.0, 0.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn single_and_slow_notches_stay_unboosted() {
|
||||
let mut b = WheelBoost::default();
|
||||
|
||||
@@ -0,0 +1,311 @@
|
||||
//! Clear egui's retained copy of wheel input already owned by the document canvas.
|
||||
//!
|
||||
//! The reset precedes fresh events and all panels. Its synthetic event is hidden from app
|
||||
//! motion routing; genuine input stays in its original order. No input is deferred or replayed.
|
||||
|
||||
use egui::{Context, Event, Id, Modifiers, MouseWheelSource, MouseWheelUnit, Plugin, RawInput, TouchPhase, Ui, Vec2, ViewportId};
|
||||
|
||||
/// Schedule a reset of this viewport's hidden egui wheel state before its next frame.
|
||||
pub(crate) fn consumed(ctx: &Context) {
|
||||
let _ = ctx.plugin_or_default::<WheelReset>();
|
||||
let key = pending(ctx.viewport_id());
|
||||
let frame = ctx.cumulative_frame_nr();
|
||||
ctx.data_mut(|data| data.insert_temp(key, frame));
|
||||
}
|
||||
|
||||
/// Whether this viewport's old egui wheel state was reset at the start of the current pass.
|
||||
pub(crate) fn reset_this_pass(ctx: &Context) -> bool {
|
||||
let viewport = ctx.viewport_id();
|
||||
let pass = ctx.cumulative_pass_nr_for(viewport);
|
||||
ctx.data(|data| data.get_temp::<u64>(applied(viewport)) == Some(pass))
|
||||
}
|
||||
|
||||
/// Separates reset requests belonging to different native viewports.
|
||||
fn pending(viewport: ViewportId) -> Id {
|
||||
Id::unique(("pdfcraft-wheel-reset-pending", viewport))
|
||||
}
|
||||
|
||||
/// Records whether this pass contains an internal reset that must be hidden from app routing.
|
||||
fn injected(viewport: ViewportId) -> Id {
|
||||
Id::unique(("pdfcraft-wheel-reset-injected", viewport))
|
||||
}
|
||||
|
||||
/// Shares reset ownership with app wheel readers only during the pass that applied it.
|
||||
fn applied(viewport: ViewportId) -> Id {
|
||||
Id::unique(("pdfcraft-wheel-reset-applied", viewport))
|
||||
}
|
||||
|
||||
/// A zero-distance cancellation clears egui's private wheel queue before fresh input arrives.
|
||||
fn reset_event() -> Event {
|
||||
Event::MouseWheel {
|
||||
unit: MouseWheelUnit::Point,
|
||||
delta: Vec2::ZERO,
|
||||
phase: TouchPhase::Cancel,
|
||||
modifiers: Modifiers::NONE,
|
||||
source: MouseWheelSource::Unknown,
|
||||
}
|
||||
}
|
||||
|
||||
/// Stateless plugin: per-viewport flags live in the context without retaining the context.
|
||||
#[derive(Default)]
|
||||
struct WheelReset;
|
||||
|
||||
impl Plugin for WheelReset {
|
||||
/// Identifies the input ownership hook in egui diagnostics.
|
||||
fn debug_name(&self) -> &'static str {
|
||||
"pdfcraft-wheel-reset"
|
||||
}
|
||||
|
||||
/// Cancel only the old wheel copy before egui processes this pass's fresh input.
|
||||
fn input_hook(&mut self, ctx: &Context, raw: &mut RawInput) {
|
||||
ctx.data_mut(|data| data.remove::<u64>(applied(raw.viewport_id)));
|
||||
let key = pending(raw.viewport_id);
|
||||
let Some(consumed_frame) = ctx.data(|data| data.get_temp::<u64>(key)) else {
|
||||
return;
|
||||
};
|
||||
// A flag can outlive a closed viewport. Create its replacement before querying the
|
||||
// counter, and discard stale ownership if this viewport has not received input yet.
|
||||
let initialized = ctx.viewport_for(raw.viewport_id, |viewport| viewport.input.raw.viewport_id == raw.viewport_id);
|
||||
if !initialized {
|
||||
ctx.data_mut(|data| data.remove::<u64>(key));
|
||||
return;
|
||||
}
|
||||
// run_pass snapshots begin-pass plugins before the frame, but refreshes input hooks
|
||||
// on each discard pass. A lazily registered plugin must wait for the next frame.
|
||||
if ctx.cumulative_frame_nr_for(raw.viewport_id) == consumed_frame {
|
||||
return;
|
||||
}
|
||||
if raw.events.try_reserve(1).is_err() {
|
||||
// Keep the pending flag so a later pass can retry without dropping fresh input.
|
||||
return;
|
||||
}
|
||||
// Index zero is always valid; the fallible reservation above admits the extra event.
|
||||
raw.events.insert(0, reset_event());
|
||||
ctx.data_mut(|data| {
|
||||
data.remove::<u64>(key);
|
||||
data.insert_temp(injected(raw.viewport_id), true);
|
||||
});
|
||||
}
|
||||
|
||||
/// Hide exactly our prepended reset before app motion or any panel inspects input events.
|
||||
fn on_begin_pass(&mut self, ui: &mut Ui) {
|
||||
let ctx = ui.ctx();
|
||||
let key = injected(ctx.viewport_id());
|
||||
let ours = ctx.data_mut(|data| data.remove_temp::<bool>(key).unwrap_or(false));
|
||||
if ours {
|
||||
let removed = ctx.input_mut(|input| {
|
||||
if input.events.first() == Some(&reset_event()) {
|
||||
// The first-event check proves index zero exists and belongs to this reset.
|
||||
input.events.remove(0);
|
||||
true
|
||||
} else {
|
||||
false
|
||||
}
|
||||
});
|
||||
if removed {
|
||||
let key = applied(ctx.viewport_id());
|
||||
let pass = ctx.cumulative_pass_nr();
|
||||
ctx.data_mut(|data| data.insert_temp(key, pass));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use egui::{Pos2, Rect, vec2};
|
||||
|
||||
#[derive(Clone)]
|
||||
struct Observed {
|
||||
scroll: Vec2,
|
||||
zoom: f32,
|
||||
events: Vec<Event>,
|
||||
reset: bool,
|
||||
}
|
||||
|
||||
fn context() -> Context {
|
||||
let ctx = Context::default();
|
||||
ctx.options_mut(|options| {
|
||||
options.max_passes = 3.try_into().unwrap();
|
||||
options.input_options.line_scroll_speed = 100.0;
|
||||
});
|
||||
ctx
|
||||
}
|
||||
|
||||
fn wheel(unit: MouseWheelUnit, amount: f32, modifiers: Modifiers) -> Event {
|
||||
Event::MouseWheel { unit, delta: vec2(0.0, amount), phase: TouchPhase::Move, source: MouseWheelSource::Unknown, modifiers }
|
||||
}
|
||||
|
||||
/// Run the actual hooks and input pipeline without an app raw-input hook.
|
||||
fn frame(ctx: &Context, viewport: ViewportId, time: f64, events: Vec<Event>, consume: bool, passes: usize) -> Vec<Observed> {
|
||||
let mut raw = RawInput {
|
||||
viewport_id: viewport,
|
||||
screen_rect: Some(Rect::from_min_size(Pos2::ZERO, vec2(600.0, 800.0))),
|
||||
time: Some(time),
|
||||
predicted_dt: 1.0 / 60.0,
|
||||
events,
|
||||
..Default::default()
|
||||
};
|
||||
raw.viewports.entry(viewport).or_default();
|
||||
let mut observed = Vec::new();
|
||||
let output = ctx.run_ui(raw, |ui| {
|
||||
let reset = reset_this_pass(ui.ctx());
|
||||
observed.push(ui.input(|input| Observed {
|
||||
scroll: input.smooth_scroll_delta,
|
||||
zoom: input.zoom_delta(),
|
||||
events: input.events.clone(),
|
||||
reset,
|
||||
}));
|
||||
if consume {
|
||||
consumed(ui.ctx());
|
||||
// The canvas drains the public value after taking ownership of the raw wheel.
|
||||
ui.input_mut(|input| input.smooth_scroll_delta = Vec2::ZERO);
|
||||
}
|
||||
if observed.len() < passes {
|
||||
ui.ctx().request_discard("wheel reset multipass regression");
|
||||
}
|
||||
});
|
||||
output.drop_without_applying_deltas();
|
||||
assert_eq!(observed.len(), passes);
|
||||
observed
|
||||
}
|
||||
|
||||
/// Draining the public delta alone leaves a hidden tail; the plugin clears it before UI.
|
||||
#[test]
|
||||
fn consumed_wheel_does_not_leak_into_the_next_frame_elsewhere() {
|
||||
let baseline = context();
|
||||
frame(&baseline, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], false, 1);
|
||||
baseline.input_mut(|input| input.smooth_scroll_delta = Vec2::ZERO);
|
||||
let elsewhere = vec![Event::PointerMoved(Pos2::new(10.0, 10.0))];
|
||||
assert!(frame(&baseline, ViewportId::ROOT, 1.0 / 60.0, elsewhere.clone(), false, 1)[0].scroll.y > 0.0);
|
||||
|
||||
let reset = context();
|
||||
frame(&reset, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], true, 1);
|
||||
let next = frame(&reset, ViewportId::ROOT, 1.0 / 60.0, elsewhere.clone(), false, 1);
|
||||
assert_eq!(next[0].scroll, Vec2::ZERO);
|
||||
assert_eq!(next[0].events, elsewhere);
|
||||
}
|
||||
|
||||
/// Resetting old motion preserves the complete distance of fresh Point and Line events.
|
||||
#[test]
|
||||
fn fresh_wheel_distance_is_preserved_after_the_reset() {
|
||||
for (unit, amount, expected) in [(MouseWheelUnit::Point, 60.0, 60.0), (MouseWheelUnit::Line, 1.0, 100.0)] {
|
||||
let ctx = context();
|
||||
frame(&ctx, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], true, 1);
|
||||
let fresh = wheel(unit, amount, Modifiers::NONE);
|
||||
let first = frame(&ctx, ViewportId::ROOT, 1.0 / 60.0, vec![fresh.clone()], false, 1);
|
||||
assert_eq!(first[0].events, vec![fresh]);
|
||||
let mut distance = first[0].scroll.y;
|
||||
for index in 2..120 {
|
||||
distance += frame(&ctx, ViewportId::ROOT, f64::from(index) / 60.0, Vec::new(), false, 1)[0].scroll.y;
|
||||
}
|
||||
assert!((distance - expected).abs() < 0.005, "{unit:?}: {distance}, expected {expected}");
|
||||
}
|
||||
}
|
||||
|
||||
/// A fresh Ctrl-wheel remains a zoom input after old non-zoom wheel state is cleared.
|
||||
#[test]
|
||||
fn fresh_ctrl_wheel_zoom_is_preserved() {
|
||||
let ctx = context();
|
||||
frame(&ctx, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], true, 1);
|
||||
let zoom = wheel(MouseWheelUnit::Point, 4.0, Modifiers::CTRL);
|
||||
let next = frame(&ctx, ViewportId::ROOT, 1.0 / 60.0, vec![zoom.clone()], false, 1);
|
||||
assert!(next[0].zoom > 1.0);
|
||||
assert_eq!(next[0].scroll, Vec2::ZERO);
|
||||
assert_eq!(next[0].events, vec![zoom]);
|
||||
}
|
||||
|
||||
/// A genuine zero-delta Cancel is retained, both with and without our preceding marker.
|
||||
#[test]
|
||||
fn genuine_cancel_events_are_not_removed() {
|
||||
for schedule in [false, true] {
|
||||
let ctx = context();
|
||||
let _ = ctx.plugin_or_default::<WheelReset>();
|
||||
if schedule {
|
||||
frame(&ctx, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], true, 1);
|
||||
}
|
||||
let events = vec![reset_event(), wheel(MouseWheelUnit::Point, 3.0, Modifiers::NONE)];
|
||||
let observed = frame(&ctx, ViewportId::ROOT, 1.0 / 60.0, events.clone(), false, 1);
|
||||
assert_eq!(observed[0].events, events);
|
||||
assert_eq!(observed[0].scroll.y, 3.0);
|
||||
assert_eq!(observed[0].reset, schedule);
|
||||
}
|
||||
}
|
||||
|
||||
/// Discard passes see no replay of wheel events or synthetic cancellation markers.
|
||||
#[test]
|
||||
fn discard_passes_do_not_replay_events_or_old_wheel_motion() {
|
||||
let ctx = context();
|
||||
frame(&ctx, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], true, 1);
|
||||
let fresh = wheel(MouseWheelUnit::Point, 4.0, Modifiers::NONE);
|
||||
let passes = frame(&ctx, ViewportId::ROOT, 1.0 / 60.0, vec![fresh.clone()], false, 3);
|
||||
assert_eq!(passes[0].events, vec![fresh]);
|
||||
assert_eq!(passes[0].scroll.y, 4.0);
|
||||
for pass in passes.iter().skip(1) {
|
||||
assert!(pass.events.is_empty());
|
||||
assert_eq!(pass.scroll, Vec2::ZERO);
|
||||
}
|
||||
}
|
||||
|
||||
/// Reset flags belong to a viewport, even when another viewport processes input first.
|
||||
#[test]
|
||||
fn another_viewport_does_not_consume_the_pending_reset() {
|
||||
let ctx = context();
|
||||
let other = ViewportId::from_hash_of("wheel-reset-other");
|
||||
frame(&ctx, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], true, 1);
|
||||
let other_events = vec![wheel(MouseWheelUnit::Point, 4.0, Modifiers::NONE)];
|
||||
let observed = frame(&ctx, other, 1.0 / 60.0, other_events.clone(), false, 1);
|
||||
assert_eq!(observed[0].events, other_events);
|
||||
assert_eq!(observed[0].scroll.y, 4.0);
|
||||
assert!(ctx.data(|data| data.get_temp::<u64>(pending(ViewportId::ROOT)).is_some()));
|
||||
let root = frame(&ctx, ViewportId::ROOT, 2.0 / 60.0, Vec::new(), false, 1);
|
||||
assert_eq!(root[0].scroll, Vec2::ZERO);
|
||||
assert!(root[0].events.is_empty());
|
||||
}
|
||||
|
||||
/// First-use registration during a discarded pass must not expose the reset to later passes.
|
||||
#[test]
|
||||
fn first_consumed_frame_can_discard_without_exposing_the_reset() {
|
||||
let ctx = context();
|
||||
let fresh = wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE);
|
||||
let passes = frame(&ctx, ViewportId::ROOT, 0.0, vec![fresh.clone()], true, 3);
|
||||
assert_eq!(passes[0].events, vec![fresh]);
|
||||
for pass in passes.iter().skip(1) {
|
||||
assert!(pass.events.is_empty(), "the newly registered input hook must not expose its reset before the begin-pass hook is active");
|
||||
}
|
||||
let next = frame(&ctx, ViewportId::ROOT, 1.0 / 60.0, Vec::new(), false, 1);
|
||||
assert_eq!(next[0].scroll, Vec2::ZERO);
|
||||
assert!(next[0].events.is_empty());
|
||||
}
|
||||
|
||||
/// App readers observe reset ownership only in the viewport and pass that applied it.
|
||||
#[test]
|
||||
fn reset_notification_is_scoped_to_the_pass_and_viewport() {
|
||||
let ctx = context();
|
||||
let first = frame(&ctx, ViewportId::ROOT, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], true, 1);
|
||||
assert!(!first[0].reset);
|
||||
let other = ViewportId::from_hash_of("wheel-reset-notification-other");
|
||||
assert!(!frame(&ctx, other, 1.0 / 60.0, Vec::new(), false, 1)[0].reset);
|
||||
let passes = frame(&ctx, ViewportId::ROOT, 2.0 / 60.0, Vec::new(), false, 3);
|
||||
assert!(passes[0].reset);
|
||||
assert!(passes.iter().skip(1).all(|pass| !pass.reset));
|
||||
assert!(!frame(&ctx, ViewportId::ROOT, 3.0 / 60.0, Vec::new(), false, 1)[0].reset);
|
||||
}
|
||||
|
||||
/// An old flag for a removed viewport must neither panic nor cancel a replacement's input.
|
||||
#[test]
|
||||
fn stale_reset_for_a_recreated_viewport_does_not_cancel_fresh_motion() {
|
||||
let ctx = context();
|
||||
let other = ViewportId::from_hash_of("wheel-reset-recreated");
|
||||
let _ = ctx.plugin_or_default::<WheelReset>();
|
||||
// Model the temporary flag surviving egui's removal of the old ViewportState.
|
||||
ctx.data_mut(|data| data.insert_temp(pending(other), 0u64));
|
||||
let first = frame(&ctx, other, 0.0, vec![wheel(MouseWheelUnit::Point, 200.0, Modifiers::NONE)], false, 1);
|
||||
assert!(!first[0].reset);
|
||||
assert!(ctx.data(|data| data.get_temp::<u64>(pending(other)).is_none()));
|
||||
let next = frame(&ctx, other, 1.0 / 60.0, Vec::new(), false, 1);
|
||||
assert!(next[0].scroll.y > 0.0, "fresh unconsumed wheel motion still belongs to the replacement viewport");
|
||||
assert!(!next[0].reset);
|
||||
}
|
||||
}
|
||||
@@ -13,15 +13,15 @@ use crate::{PdfCraftApp, QuickTool};
|
||||
/// [x0, y0, x1, y1]); a plain click has an empty rectangle.
|
||||
pub type Marquee = (usize, Rect, [f32; 4]);
|
||||
|
||||
/// Drag a rectangle on page `page` (Marquee Zoom, Snapshot).
|
||||
pub(crate) fn page_input(ui: &egui::Ui, resp: &egui::Response, xf: &PageXform, ptr: &PagePointer, page: usize, view: &mut DocView) {
|
||||
/// Drag a rectangle on page `page` (Marquee Zoom, Snapshot), with a press nobody holds (`free`).
|
||||
pub(crate) fn page_input(ui: &egui::Ui, resp: &egui::Response, xf: &PageXform, ptr: &PagePointer, page: usize, free: bool, view: &mut DocView) {
|
||||
let (pointer, origin) = (ptr.pos, ptr.origin);
|
||||
if pointer.is_some_and(|p| xf.rect.contains(p)) {
|
||||
view.cursor.claim(Layer::ToolArea, egui::CursorIcon::Crosshair);
|
||||
}
|
||||
// The tool's own press, of the primary button: nothing drawn over the page here holds it.
|
||||
// The tool's own press, of the primary button: one nobody holds.
|
||||
if resp.drag_started_by(egui::PointerButton::Primary)
|
||||
&& view.router.owner(page).is_none()
|
||||
&& free
|
||||
&& let Some(o) = origin.filter(|o| xf.rect.contains(*o))
|
||||
{
|
||||
view.marquee = Some((page, o));
|
||||
@@ -40,7 +40,8 @@ pub(crate) fn page_input(ui: &egui::Ui, resp: &egui::Response, xf: &PageXform, p
|
||||
view.marquee_done = Some((page, r, [a.0.min(b.0), a.1.min(b.1), a.0.max(b.0), a.1.max(b.1)]));
|
||||
}
|
||||
}
|
||||
if resp.clicked()
|
||||
if free
|
||||
&& resp.clicked()
|
||||
&& let Some(p) = pointer.filter(|p| xf.rect.contains(*p))
|
||||
{
|
||||
let v = xf.screen_to_view(p);
|
||||
|
||||
@@ -878,6 +878,9 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn localized_shortcut_labels_follow_language_and_platform() {
|
||||
if !crate::i18n::needs_catalogs() {
|
||||
return;
|
||||
}
|
||||
let previous = crate::i18n::current();
|
||||
let ctx = egui::Context::default();
|
||||
for os in [OperatingSystem::Windows, OperatingSystem::Nix] {
|
||||
|
||||
@@ -1092,6 +1092,9 @@ mod revert_draft_tests {
|
||||
/// interface language; a drawable value says nothing.
|
||||
#[test]
|
||||
fn a_value_its_font_cannot_draw_is_kept_and_explained() {
|
||||
if !crate::i18n::needs_catalogs() {
|
||||
return;
|
||||
}
|
||||
let mut app = app();
|
||||
let fill =
|
||||
|app: &mut PdfCraftApp, text: &str| app.apply_edit(Edit::SetFieldValue { name: "name".into(), value: FieldValue::Text(text.into()) });
|
||||
|
||||
@@ -317,6 +317,9 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn translated_card_description_leaves_room_for_the_action() {
|
||||
if !crate::i18n::needs_catalogs() {
|
||||
return;
|
||||
}
|
||||
let de = crate::i18n::Lang::from_code("de").unwrap();
|
||||
crate::i18n::set_current(de);
|
||||
let ctx = egui::Context::default();
|
||||
|
||||
@@ -799,6 +799,9 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn hotbar_search_matches_translated_and_canonical_labels() {
|
||||
if !crate::i18n::needs_catalogs() {
|
||||
return;
|
||||
}
|
||||
let ink = command("comment.ink").unwrap();
|
||||
crate::i18n::set_current(crate::i18n::lang_from_tag("fr").unwrap());
|
||||
assert_eq!(tl!(ink.label), "Dessiner à main levée");
|
||||
|
||||
+231
-279
@@ -1,19 +1,28 @@
|
||||
//! UI localisation. Strings in code stay English and are the default lookup keys; a per-language
|
||||
//! catalog (`*.tsv`, see `ja.tsv` for the format) maps them to display text at render time. Command
|
||||
//! ids, document text, file names, the control channel, the CLI and MCP never see translated text,
|
||||
//! so agents and scripts are unaffected. A string without a translation is shown in English, so
|
||||
//! coverage can grow incrementally.
|
||||
//! UI localisation. Strings in code stay English and are the default lookup keys; the craft-i18n
|
||||
//! catalogs map them to display text at render time. Command ids, document text, file names, the
|
||||
//! control channel, the CLI and MCP never see translated text, so agents and scripts are
|
||||
//! unaffected. A string without a translation is shown in English, so coverage can grow
|
||||
//! incrementally, and a missing translation never fails a build, a test or a release.
|
||||
//!
|
||||
//! The system is the one PhotoCraft uses (`photocraft/crates/ui-egui/src/i18n`), so catalogs and
|
||||
//! habits carry over between the two apps.
|
||||
//! The catalogs live in [storytold/craft-i18n](https://github.com/storytold/craft-i18n)
|
||||
//! (`locales/<code>/common.tsv`, shared by the Crafting Apps, and `pdfcraft.tsv`), not in this
|
||||
//! repository. `build.rs` embeds them from `CRAFT_I18N_DIR` (CI and releases check out the commit
|
||||
//! in `craft-i18n.rev`); without it the build is English only. Lookup, fallback (PdfCraft's rows
|
||||
//! over shared ones), plural forms (CLDR) and language names are the `craft-i18n` crate's
|
||||
//! (craft-libs). Which languages are offered, how the system locale picks one, right to left and
|
||||
//! `{name}` placeholders stay here.
|
||||
//!
|
||||
//! # Adding or changing a translation
|
||||
//! In craft-i18n: add rows to `locales/<code>/pdfcraft.tsv` (its `docs/integration.md`). They show
|
||||
//! here once `craft-i18n.rev` moves to a commit that has them. A feature PR here adds the English
|
||||
//! only.
|
||||
//!
|
||||
//! # Adding a language
|
||||
//! 1. Add `xx.tsv` next to `ja.tsv` (copy its header; translate from the *meaning* of the English
|
||||
//! text, clean-room, see `ja.tsv`).
|
||||
//! 2. Add one row to [`LANGUAGES`] (code, native name, catalog, plural rule).
|
||||
//! 1. craft-i18n gets `locales/<code>/pdfcraft.tsv` with its `@id language.name` row.
|
||||
//! 2. Add one row to [`LANGUAGES`] (code, right to left), and its English name to
|
||||
//! [`Lang::english_name`].
|
||||
//!
|
||||
//! That is all: the Preferences dropdown, the system-locale match and the catalog tests (parse,
|
||||
//! placeholders, plural forms) pick it up from the registry.
|
||||
//! The Preferences dropdown and the system-locale match pick it up from there.
|
||||
//!
|
||||
//! # Looking strings up
|
||||
//! - `tl!` / [`t`]: a plain string in the current language. [`tr`]: in a given one.
|
||||
@@ -23,323 +32,173 @@
|
||||
//! - [`trn`]: plural-aware (`{n}` is filled in). [`fmt`]: fill `{name}` placeholders after [`tr`];
|
||||
//! translators may reorder placeholders freely.
|
||||
|
||||
mod catalog;
|
||||
|
||||
use std::cell::Cell;
|
||||
use std::sync::OnceLock;
|
||||
use std::collections::HashSet;
|
||||
use std::sync::{LazyLock, OnceLock};
|
||||
|
||||
use catalog::Catalog;
|
||||
use craft_i18n::I18n;
|
||||
|
||||
include!(concat!(env!("OUT_DIR"), "/craft_i18n.rs"));
|
||||
|
||||
/// The embedded catalogs, offering exactly the languages in [`LANGUAGES`]. Built on first use; a
|
||||
/// locale is parsed on its first lookup.
|
||||
static I18N: LazyLock<I18n> = LazyLock::new(|| {
|
||||
let offered: Vec<&str> = LANGUAGES.iter().map(|l| l.code).collect();
|
||||
let (i18n, problems) = I18n::new(CRAFT_I18N, &offered);
|
||||
for problem in problems {
|
||||
log::warn!("interface catalogs: {problem}");
|
||||
}
|
||||
i18n
|
||||
});
|
||||
|
||||
/// The `language` preference value that follows the system locale.
|
||||
pub const AUTO: &str = "auto";
|
||||
|
||||
/// One supported UI language.
|
||||
/// One UI language PdfCraft offers, when its catalogs are embedded: what the app needs beyond
|
||||
/// them. Its name and translations come from craft-i18n.
|
||||
pub struct LangInfo {
|
||||
/// BCP 47 code, lowercase (`ja`, `zh-hans`, `pt-br`). Also the `language` preference value.
|
||||
/// BCP 47 code, lowercase (`ja`, `zh-hans`, `pt-br`). Also the `language` preference value and
|
||||
/// the craft-i18n locale.
|
||||
pub code: &'static str,
|
||||
/// The language's name in itself, shown in the Preferences dropdown.
|
||||
pub name: &'static str,
|
||||
/// Catalog file contents (empty for the built-in English).
|
||||
pub source: &'static str,
|
||||
/// Plural form index for a count (English: 0 = one, 1 = other; Japanese: always 0). A catalog's
|
||||
/// `@plural` entries list one form per index.
|
||||
pub plural: fn(u64) -> usize,
|
||||
/// The language is written right to left. Catalogs stay in logical order: the egui 0.37 fork
|
||||
/// owns bidi shaping/reordering (E5/E12), so preordering here would reverse Arabic twice.
|
||||
pub rtl: bool,
|
||||
catalog: OnceLock<Catalog>,
|
||||
}
|
||||
|
||||
fn plural_one_other(n: u64) -> usize {
|
||||
usize::from(n != 1)
|
||||
}
|
||||
/// How many languages [`LANGUAGES`] lists.
|
||||
const LANGUAGE_COUNT: usize = 35;
|
||||
|
||||
fn plural_none(_: u64) -> usize {
|
||||
0
|
||||
}
|
||||
|
||||
/// Romanian (CLDR `ro`): 1 is `one`; 0 and numbers whose last two digits are 1–19 (2, 19, 101,
|
||||
/// 119) are `few`; everything else (20, 100, 120) is `other`, the form with "de" ("20 de pagini").
|
||||
fn plural_ro(n: u64) -> usize {
|
||||
if n == 1 {
|
||||
0
|
||||
} else if n == 0 || (1..=19).contains(&(n % 100)) {
|
||||
1
|
||||
} else {
|
||||
2
|
||||
}
|
||||
}
|
||||
|
||||
/// Lithuanian: one (ending in 1 except 11), few (ending in 2–9 except 12–19), other otherwise.
|
||||
fn plural_lithuanian(n: u64) -> usize {
|
||||
match (n % 10, n % 100) {
|
||||
(1, 11) => 2,
|
||||
(1, _) => 0,
|
||||
(2..=9, 12..=19) => 2,
|
||||
(2..=9, _) => 1,
|
||||
_ => 2,
|
||||
}
|
||||
}
|
||||
|
||||
/// Czech: 1 → one, 2–4 → few, everything else (0, 5+) → other.
|
||||
fn plural_cs(n: u64) -> usize {
|
||||
match n {
|
||||
1 => 0,
|
||||
2..=4 => 1,
|
||||
_ => 2,
|
||||
}
|
||||
}
|
||||
|
||||
/// Portuguese: 0 and 1 take the singular, everything else the plural.
|
||||
fn plural_pt(n: u64) -> usize {
|
||||
usize::from(n > 1)
|
||||
}
|
||||
|
||||
/// French (CLDR `fr`): 0 and 1 take the singular, everything else the plural.
|
||||
fn plural_fr(n: u64) -> usize {
|
||||
usize::from(n > 1)
|
||||
}
|
||||
|
||||
/// Russian: 1 (but not 11) is `one`, 2–4 (but not 12–14) `few`, everything else `many`.
|
||||
fn plural_russian(n: u64) -> usize {
|
||||
match n % 100 {
|
||||
11..=14 => 2,
|
||||
_ => match n % 10 {
|
||||
1 => 0,
|
||||
2..=4 => 1,
|
||||
_ => 2,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
/// Ukrainian (CLDR `uk`, integer counts): one (1, 21), few (2–4, 22–24), many (0, 5–19).
|
||||
/// Counts ending in 11–14 always take many, regardless of the last digit.
|
||||
fn plural_ukrainian(n: u64) -> usize {
|
||||
match n % 100 {
|
||||
11..=14 => 2,
|
||||
_ => match n % 10 {
|
||||
1 => 0,
|
||||
2..=4 => 1,
|
||||
_ => 2,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
/// Arabic (CLDR `ar`, integer counts): zero (0), one (1), two (2), few (3–10, 103–110),
|
||||
/// many (11–99, 111–199), other (100–102, 200–202).
|
||||
fn plural_arabic(n: u64) -> usize {
|
||||
match (n, n % 100) {
|
||||
(0, _) => 0,
|
||||
(1, _) => 1,
|
||||
(2, _) => 2,
|
||||
(_, 3..=10) => 3,
|
||||
(_, 11..=99) => 4,
|
||||
_ => 5,
|
||||
}
|
||||
}
|
||||
|
||||
/// Polish integer counts: 1 is one; endings 2–4 except 12–14 are few; the rest are many.
|
||||
fn plural_polish(n: u64) -> usize {
|
||||
match (n, n % 100, n % 10) {
|
||||
(1, _, _) => 0,
|
||||
(_, 12..=14, _) => 2,
|
||||
(_, _, 2..=4) => 1,
|
||||
_ => 2,
|
||||
}
|
||||
}
|
||||
|
||||
/// Slovene (CLDR `sl`): one (1, 101, 201 ...) | two (2, 102 ...) | few (3, 4, 103 ...) | other.
|
||||
fn plural_sl(n: u64) -> usize {
|
||||
match n % 100 {
|
||||
1 => 0,
|
||||
2 => 1,
|
||||
3 | 4 => 2,
|
||||
_ => 3,
|
||||
}
|
||||
}
|
||||
|
||||
/// The registry. English first: it is the fallback and the source language.
|
||||
pub static LANGUAGES: [LangInfo; 35] = [
|
||||
LangInfo { code: "en", name: "English", source: "", plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "ja", name: "日本語", source: include_str!("i18n/ja.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new() },
|
||||
/// The languages PdfCraft offers. English first: it is the fallback and the source language.
|
||||
pub static LANGUAGES: [LangInfo; LANGUAGE_COUNT] = [
|
||||
LangInfo { code: "en", rtl: false },
|
||||
LangInfo { code: "ja", rtl: false },
|
||||
// Simplified Chinese; `zh`, `zh-CN`, `zh-SG` and `zh-Hans-*` locales resolve here (see `candidates`).
|
||||
LangInfo {
|
||||
code: "zh-hans",
|
||||
name: "简体中文",
|
||||
source: include_str!("i18n/zh-hans.tsv"),
|
||||
plural: plural_none,
|
||||
rtl: false,
|
||||
catalog: OnceLock::new(),
|
||||
},
|
||||
LangInfo { code: "zh-hans", rtl: false },
|
||||
// Traditional Chinese in the vocabulary used in Taiwan; `zh-TW`, `zh-HK`, `zh-MO` and `zh-Hant-*`
|
||||
// locales all resolve here (see `candidates`).
|
||||
LangInfo {
|
||||
code: "zh-hant",
|
||||
name: "繁體中文",
|
||||
source: include_str!("i18n/zh-hant.tsv"),
|
||||
plural: plural_none,
|
||||
rtl: false,
|
||||
catalog: OnceLock::new(),
|
||||
},
|
||||
LangInfo { code: "cs", name: "Čeština", source: include_str!("i18n/cs.tsv"), plural: plural_cs, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "zh-hant", rtl: false },
|
||||
LangInfo { code: "cs", rtl: false },
|
||||
// Brazilian Portuguese; `pt`, `pt-BR` and `pt-PT` locales all resolve here (see `candidates`).
|
||||
LangInfo {
|
||||
code: "pt-br",
|
||||
name: "Português (Brasil)",
|
||||
source: include_str!("i18n/pt-br.tsv"),
|
||||
plural: plural_pt,
|
||||
rtl: false,
|
||||
catalog: OnceLock::new(),
|
||||
},
|
||||
LangInfo { code: "pt-br", rtl: false },
|
||||
// German (informal "du"); every `de-*` locale (`de-DE`, `de-AT`, `de-CH` ...) resolves here.
|
||||
LangInfo { code: "de", name: "Deutsch", source: include_str!("i18n/de.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "de", rtl: false },
|
||||
// Spanish (European vocabulary); every `es-*` locale (`es-ES`, `es-MX`, `es-419` ...) resolves here.
|
||||
LangInfo { code: "es", name: "Español", source: include_str!("i18n/es.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "es", rtl: false },
|
||||
// French; every `fr-*` locale (`fr-FR`, `fr-CA`, `fr-BE` ...) resolves here.
|
||||
LangInfo { code: "fr", name: "Français", source: include_str!("i18n/fr.tsv"), plural: plural_fr, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "fr", rtl: false },
|
||||
// Russian; every `ru-*` locale (`ru-RU`, `ru-BY`, `ru-KZ` ...) resolves here.
|
||||
LangInfo {
|
||||
code: "ru", name: "Русский", source: include_str!("i18n/ru.tsv"), plural: plural_russian, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
LangInfo { code: "ru", rtl: false },
|
||||
// Kazakh; every `kk-*` locale (`kk-KZ`, `kk-KZ.UTF-8`) resolves here.
|
||||
LangInfo {
|
||||
code: "kk", name: "Қазақша", source: include_str!("i18n/kk.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
LangInfo { code: "kk", rtl: false },
|
||||
// Bulgarian; every `bg-*` locale (`bg-BG`) resolves here.
|
||||
LangInfo {
|
||||
code: "bg", name: "Български", source: include_str!("i18n/bg.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
LangInfo { code: "bg", rtl: false },
|
||||
// Telugu; every `te-*` locale (`te-IN`) resolves here.
|
||||
LangInfo {
|
||||
code: "te", name: "తెలుగు", source: include_str!("i18n/te.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
LangInfo { code: "te", rtl: false },
|
||||
// Hungarian; every `hu-*` locale (`hu-HU`) resolves here.
|
||||
LangInfo { code: "hu", name: "Magyar", source: include_str!("i18n/hu.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "hu", rtl: false },
|
||||
// Ukrainian; every `uk-*` locale (`uk-UA`, `uk_UA.UTF-8`) resolves here.
|
||||
LangInfo {
|
||||
code: "uk", name: "Українська", source: include_str!("i18n/uk.tsv"), plural: plural_ukrainian, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
LangInfo { code: "uk", rtl: false },
|
||||
// Italian; every `it-*` locale (`it-IT`) resolves here.
|
||||
LangInfo { code: "it", name: "Italiano", source: include_str!("i18n/it.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "it", rtl: false },
|
||||
// Arabic (Modern Standard, Western digits); every `ar-*` locale (`ar-MA`, `ar-EG`, `ar-SA` ...)
|
||||
// resolves here. Right to left: see `LangInfo::rtl`.
|
||||
LangInfo { code: "ar", name: "العربية", source: include_str!("i18n/ar.tsv"), plural: plural_arabic, rtl: true, catalog: OnceLock::new() },
|
||||
LangInfo { code: "ar", rtl: true },
|
||||
// Central Kurdish (Sorani); every `ckb-*` locale (`ckb-IQ`, `ckb-IR`) resolves here. Right to
|
||||
// left like Arabic: see `LangInfo::rtl`. CLDR `ckb` counts have two forms (one, other).
|
||||
LangInfo {
|
||||
code: "ckb",
|
||||
name: "کوردیی ناوەندی",
|
||||
source: include_str!("i18n/ckb.tsv"),
|
||||
plural: plural_one_other,
|
||||
rtl: true,
|
||||
catalog: OnceLock::new(),
|
||||
},
|
||||
LangInfo { code: "ckb", rtl: true },
|
||||
// Persian (Farsi); every `fa-*` locale (`fa-IR`, `fa_IR.UTF-8`, `fa-AF` ...) resolves here. Right
|
||||
// to left like Arabic: see `LangInfo::rtl`. CLDR `fa` counts have two forms (one: i = 0 or n = 1,
|
||||
// other), which for whole counts is the French rule, so `@plural` entries list two forms.
|
||||
LangInfo { code: "fa", name: "فارسی", source: include_str!("i18n/fa.tsv"), plural: plural_fr, rtl: true, catalog: OnceLock::new() },
|
||||
LangInfo { code: "fa", rtl: true },
|
||||
// Polish; every `pl-*` locale (`pl-pl`, `pl_pl.UTF-8`) resolves here.
|
||||
LangInfo { code: "pl", name: "Polski", source: include_str!("i18n/pl.tsv"), plural: plural_polish, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "pl", rtl: false },
|
||||
// Slovene; every `sl-*` locale (`sl-SI`) resolves here. Four plural forms (one, two, few, other).
|
||||
LangInfo { code: "sl", name: "Slovenščina", source: include_str!("i18n/sl.tsv"), plural: plural_sl, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo {
|
||||
code: "el", name: "Ελληνικά", source: include_str!("i18n/el.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
// Turkish; every `tr-*` locale (`tr-TR`, `tr_TR.UTF-8`) resolves here.
|
||||
LangInfo { code: "tr", name: "Türkçe", source: include_str!("i18n/tr.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "sl", rtl: false },
|
||||
LangInfo { code: "el", rtl: false },
|
||||
// Turkish; every `tr-*` locale (`tr-TR`, `tr_TR.UTF-8`) resolves here. CLDR `tr` has two forms
|
||||
// (one, other); the catalog's counted nouns read the same in both, so its `@plural` rows repeat
|
||||
// the one form.
|
||||
LangInfo { code: "tr", rtl: false },
|
||||
// Lithuanian; every `lt-*` locale (`lt-LT`, `lt_LT.UTF-8`) resolves here. Three plural forms (one, few, other).
|
||||
LangInfo { code: "lt", name: "Lietuvių", source: include_str!("i18n/lt.tsv"), plural: plural_lithuanian, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "lt", rtl: false },
|
||||
// Indonesian; every `id-*` locale (`id-ID`, `id_ID.UTF-8`) resolves here. CLDR `id` counts have
|
||||
// one form ("other"), so `@plural` entries list a single form.
|
||||
LangInfo { code: "id", name: "Bahasa Indonesia", source: include_str!("i18n/id.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "id", rtl: false },
|
||||
// Vietnamese; every `vi-*` locale (`vi-VN`, `vi_VN.UTF-8`) resolves here. CLDR `vi` counts have
|
||||
// one form ("other"), so `@plural` entries list a single form.
|
||||
LangInfo { code: "vi", name: "Tiếng Việt", source: include_str!("i18n/vi.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "vi", rtl: false },
|
||||
// Finnish; every `fi-*` locale (`fi-FI`, `fi_FI.UTF-8`) resolves here. Two plural forms (one, other):
|
||||
// the partitive singular follows any number but 1 (`1 sivu`, `2 sivua`).
|
||||
LangInfo { code: "fi", name: "Suomi", source: include_str!("i18n/fi.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "fi", rtl: false },
|
||||
// Albanian; every `sq-*` locale (`sq-AL`, `sq_AL.UTF-8`, `sq-XK`) resolves here. One/other plural, like English.
|
||||
LangInfo { code: "sq", name: "Shqip", source: include_str!("i18n/sq.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "sq", rtl: false },
|
||||
// Thai; every `th-*` locale (`th-TH`, `th_TH.UTF-8`) resolves here. No grammatical plural.
|
||||
LangInfo { code: "th", name: "ไทย", source: include_str!("i18n/th.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "th", rtl: false },
|
||||
// Catalan; every `ca-*` locale (`ca-ES`, `ca_ES.UTF-8`, `ca_ES@valencia`) resolves here.
|
||||
LangInfo { code: "ca", name: "Català", source: include_str!("i18n/ca.tsv"), plural: plural_one_other, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "ca", rtl: false },
|
||||
// Romanian; every `ro-*` locale (`ro-RO`, `ro_RO.UTF-8`, `ro-MD`) resolves here. Three plural forms (one, few, other).
|
||||
LangInfo { code: "ro", name: "Română", source: include_str!("i18n/ro.tsv"), plural: plural_ro, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "ro", rtl: false },
|
||||
// Lao; every `lo-*` locale (`lo-LA`, `lo_LA.UTF-8` ...) resolves here.
|
||||
LangInfo {
|
||||
code: "lo", name: "ພາສາລາວ", source: include_str!("i18n/lo.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
LangInfo { code: "lo", rtl: false },
|
||||
// Hindi; every `hi-*` locale (`hi-IN`, `hi_IN.UTF-8`) resolves here. CLDR `hi` has "one"
|
||||
// (0 and 1) and "other", but the catalog's nouns are the same in both ("{n} पृष्ठ"), so
|
||||
// `@plural` entries list a single form.
|
||||
LangInfo {
|
||||
code: "hi", name: "हिन्दी", source: include_str!("i18n/hi.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new()
|
||||
},
|
||||
// (0 and 1) and "other", but the catalog's nouns are the same in both ("{n} पृष्ठ"), so its
|
||||
// `@plural` rows repeat the one form.
|
||||
LangInfo { code: "hi", rtl: false },
|
||||
// Korean; every `ko-*` locale (`ko-KR`, `ko_KR.UTF-8`) resolves here. CLDR `ko` counts have
|
||||
// one form ("other"), so `@plural` entries list a single form.
|
||||
LangInfo { code: "ko", name: "한국어", source: include_str!("i18n/ko.tsv"), plural: plural_none, rtl: false, catalog: OnceLock::new() },
|
||||
LangInfo { code: "ko", rtl: false },
|
||||
// Norwegian Bokmål; every `nb-*` locale resolves here, and so do general Norwegian (`no-*`) and
|
||||
// Nynorsk (`nn-*`), which have no catalog of their own (see `candidates`).
|
||||
LangInfo {
|
||||
code: "nb",
|
||||
name: "Norsk bokmål",
|
||||
source: include_str!("i18n/nb.tsv"),
|
||||
plural: plural_one_other,
|
||||
rtl: false,
|
||||
catalog: OnceLock::new(),
|
||||
},
|
||||
LangInfo { code: "nb", rtl: false },
|
||||
];
|
||||
|
||||
impl LangInfo {
|
||||
/// How many plural forms the language's `@plural` entries list.
|
||||
fn plural_forms(&self) -> usize {
|
||||
(0..=1000).map(self.plural).max().unwrap_or(0).saturating_add(1)
|
||||
}
|
||||
/// Per language of [`LANGUAGES`], the (context, source) keys of PdfCraft's own catalog as written
|
||||
/// (escaped), read on first use ([`Lang::has_own`]).
|
||||
static OWN_ROWS: [OnceLock<HashSet<(&'static str, &'static str)>>; LANGUAGE_COUNT] = [const { OnceLock::new() }; LANGUAGE_COUNT];
|
||||
|
||||
/// Return the parsed catalogue, building it on first use and warning about entries that fall back to
|
||||
/// English.
|
||||
fn catalog(&self) -> &Catalog {
|
||||
self.catalog.get_or_init(|| {
|
||||
let (catalog, errors) = Catalog::parse(self.source, self.plural_forms());
|
||||
for error in errors {
|
||||
log::warn!("{} interface catalog: {error}; that entry shows in English", self.code);
|
||||
}
|
||||
// Catalogs keep logical text: the fork shapes and reorders each run once. Accessibility
|
||||
// names, copied text and search therefore see the same logical string as the source.
|
||||
catalog
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// A language the UI can be shown in (a handle into [`LANGUAGES`]).
|
||||
/// A language the UI can be shown in: English, or one of [`LANGUAGES`] whose catalogs are
|
||||
/// embedded.
|
||||
#[derive(Clone, Copy)]
|
||||
pub struct Lang(&'static LangInfo);
|
||||
pub struct Lang {
|
||||
lang: craft_i18n::Lang,
|
||||
/// The catalogs it is looked up in: the embedded ones ([`I18N`]), or a test fixture's.
|
||||
catalogs: Option<&'static I18n>,
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for Lang {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(f, "Lang({})", self.0.code)
|
||||
write!(f, "Lang({})", self.code())
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for Lang {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.0.code == other.0.code
|
||||
self.code() == other.code()
|
||||
}
|
||||
}
|
||||
|
||||
impl Eq for Lang {}
|
||||
|
||||
impl Lang {
|
||||
pub const EN: Lang = Lang(&LANGUAGES[0]);
|
||||
pub const EN: Lang = Lang { lang: craft_i18n::Lang::EN, catalogs: None };
|
||||
|
||||
pub fn code(self) -> &'static str {
|
||||
self.0.code
|
||||
fn i18n(self) -> &'static I18n {
|
||||
self.catalogs.unwrap_or_else(|| LazyLock::force(&I18N))
|
||||
}
|
||||
|
||||
/// A language by its exact code.
|
||||
fn info(self) -> Option<&'static LangInfo> {
|
||||
let code = self.code();
|
||||
LANGUAGES.iter().find(|l| l.code == code)
|
||||
}
|
||||
|
||||
pub fn code(self) -> &'static str {
|
||||
self.i18n().code(self.lang)
|
||||
}
|
||||
|
||||
/// A language by its exact code (any case): one of [`LANGUAGES`] whose catalogs are embedded.
|
||||
pub fn from_code(code: &str) -> Option<Lang> {
|
||||
LANGUAGES.iter().find(|l| l.code.eq_ignore_ascii_case(code)).map(Lang)
|
||||
let info = LANGUAGES.iter().find(|l| l.code.eq_ignore_ascii_case(code))?;
|
||||
I18N.from_code(info.code).map(|lang| Lang { lang, catalogs: None })
|
||||
}
|
||||
|
||||
/// Resolve the `language` preference: a language code, or [`AUTO`] (and anything unknown,
|
||||
@@ -348,9 +207,10 @@ impl Lang {
|
||||
Lang::from_code(pref).unwrap_or_else(system_lang)
|
||||
}
|
||||
|
||||
/// Every registered language.
|
||||
/// Every language the interface can be shown in: [`LANGUAGES`] in order, those whose catalogs
|
||||
/// are embedded (English alone in a build without craft-i18n).
|
||||
pub fn all() -> impl Iterator<Item = Lang> {
|
||||
LANGUAGES.iter().map(Lang)
|
||||
LANGUAGES.iter().filter_map(|l| Lang::from_code(l.code))
|
||||
}
|
||||
|
||||
/// Every registered language in the order a picker lists them: English first (the source
|
||||
@@ -372,8 +232,10 @@ impl Lang {
|
||||
std::iter::once(Lang::EN).chain(rest).collect()
|
||||
}
|
||||
|
||||
/// The language's name in itself (its `@id language.name` row), shown in the Preferences
|
||||
/// dropdown.
|
||||
pub fn name(self) -> &'static str {
|
||||
self.0.name
|
||||
self.i18n().name(self.lang)
|
||||
}
|
||||
|
||||
/// The language's name in English, used by [`picker_name`](Self::picker_name) when this
|
||||
@@ -417,7 +279,7 @@ impl Lang {
|
||||
"ko" => "Korean",
|
||||
// Only reached if a language is added to `LANGUAGES` without an English name; the
|
||||
// code still tells the reader which entry it is.
|
||||
_ => self.0.code,
|
||||
code => code,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -432,12 +294,46 @@ impl Lang {
|
||||
/// Whether the language is written right to left. Lookups stay logical; the egui fork
|
||||
/// shapes and reorders each run for display (see [`LangInfo::rtl`]).
|
||||
pub fn rtl(self) -> bool {
|
||||
self.0.rtl
|
||||
self.info().is_some_and(|l| l.rtl)
|
||||
}
|
||||
|
||||
fn catalog(self) -> &'static Catalog {
|
||||
self.0.catalog()
|
||||
/// Whether PdfCraft's own catalog (`pdfcraft.tsv`, not the shared `common.tsv`) has the row
|
||||
/// (`context`, `source`). The shared catalog's `@id` rows are keyed by the other apps' command
|
||||
/// ids, which can name another command (in Bulgarian and Indonesian its `file.close` row holds
|
||||
/// an id rather than a label), so command-id lookups ask this; every `@id` row PdfCraft had is
|
||||
/// in its own catalog. A test fixture has no shared catalog: its rows are its own.
|
||||
fn has_own(self, context: &str, source: &str) -> bool {
|
||||
if let Some(fixture) = self.catalogs {
|
||||
return fixture.get(self.lang, context, source).is_some();
|
||||
}
|
||||
let code = self.code();
|
||||
let Some(slot) = LANGUAGES.iter().position(|l| l.code == code).and_then(|i| OWN_ROWS.get(i)) else { return false };
|
||||
let rows: &HashSet<(&str, &str)> = slot.get_or_init(|| {
|
||||
let app = CRAFT_I18N.iter().find(|(c, ..)| c.eq_ignore_ascii_case(code)).map_or("", |(_, _, app)| *app);
|
||||
app.lines()
|
||||
.filter(|l| !l.starts_with('#'))
|
||||
.filter_map(|l| {
|
||||
let mut columns = l.split('\t');
|
||||
Some((columns.next()?, columns.next()?))
|
||||
})
|
||||
.collect()
|
||||
});
|
||||
let escape = |s: &str| s.replace('\\', "\\\\").replace('\n', "\\n").replace('\t', "\\t");
|
||||
rows.contains(&(escape(context).as_str(), escape(source).as_str()))
|
||||
}
|
||||
|
||||
/// The embedded catalog texts this language reads, the shared one then PdfCraft's; none for
|
||||
/// English. For checks that the interface fonts draw every translation.
|
||||
pub fn catalog_texts(self) -> impl Iterator<Item = &'static str> {
|
||||
let code = self.code();
|
||||
CRAFT_I18N.iter().filter(move |(c, ..)| c.eq_ignore_ascii_case(code)).flat_map(|(_, shared, app)| [*shared, *app])
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether this build embeds the craft-i18n catalogs (`CRAFT_I18N_DIR` was set). Without them the
|
||||
/// interface is English only; tests that need a translation skip with a note.
|
||||
pub fn catalogs_embedded() -> bool {
|
||||
!CRAFT_I18N.is_empty()
|
||||
}
|
||||
|
||||
/// The canonical `language` preference for user input: [`AUTO`] or a registered code (any case).
|
||||
@@ -500,10 +396,8 @@ pub fn system_lang() -> Lang {
|
||||
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
fn detect_system_lang() -> Lang {
|
||||
for var in ["LC_ALL", "LC_MESSAGES", "LANG"] {
|
||||
if let Some(l) = std::env::var(var).ok().and_then(|v| language_override(&v)) {
|
||||
return l;
|
||||
}
|
||||
if let Some(l) = env_lang(|var| std::env::var(var).ok()) {
|
||||
return l;
|
||||
}
|
||||
// Apps started from the Finder don't inherit LANG: use the macOS preferred-languages list.
|
||||
// The absolute path keeps a `defaults` earlier on PATH from running; any failure means English.
|
||||
@@ -521,6 +415,13 @@ fn detect_system_lang() -> Lang {
|
||||
Lang::EN
|
||||
}
|
||||
|
||||
/// The language the locale variables name, `LC_ALL` first, then `LC_MESSAGES`, then `LANG`;
|
||||
/// `var` reads one.
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
fn env_lang(var: impl Fn(&str) -> Option<String>) -> Option<Lang> {
|
||||
["LC_ALL", "LC_MESSAGES", "LANG"].into_iter().find_map(|name| var(name).and_then(|v| language_override(&v)))
|
||||
}
|
||||
|
||||
/// A named locale can override the display language. On Windows, the neutral
|
||||
/// C/POSIX locale inherited from a launcher says nothing about the user's UI language.
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
@@ -622,7 +523,7 @@ pub fn current() -> Lang {
|
||||
|
||||
/// Does `lang` have a catalog entry for this plain string? (English never does: it is the source.)
|
||||
pub fn has(lang: Lang, s: &str) -> bool {
|
||||
lang.catalog().plain(s).is_some()
|
||||
lang.i18n().get(lang.lang, "", s).is_some()
|
||||
}
|
||||
|
||||
/// Translate an English UI string into the current language ([`tr`] with [`current`]).
|
||||
@@ -633,12 +534,13 @@ pub fn t(s: &str) -> &str {
|
||||
/// The name of a keyboard key, distinct from a command such as Delete. Missing key-name
|
||||
/// translations use the English key name, never a plain command translation.
|
||||
pub fn key_name(s: &str) -> &str {
|
||||
current().catalog().contextual("key", s).unwrap_or(s)
|
||||
let lang = current();
|
||||
lang.i18n().get(lang.lang, "key", s).unwrap_or(s)
|
||||
}
|
||||
|
||||
/// Translate an English UI string; unknown strings come back unchanged.
|
||||
pub fn tr(lang: Lang, s: &str) -> &str {
|
||||
lang.catalog().plain(s).unwrap_or(s)
|
||||
lang.i18n().t(lang.lang, s)
|
||||
}
|
||||
|
||||
/// How the layers below say their own sentences in the current language.
|
||||
@@ -654,16 +556,41 @@ pub fn words(wording: &str) -> String {
|
||||
|
||||
/// Like [`tr`], for an English string that needs a disambiguating `context`.
|
||||
pub fn tr_ctx<'a>(lang: Lang, context: &str, s: &'a str) -> &'a str {
|
||||
lang.catalog().contextual(context, s).unwrap_or_else(|| tr(lang, s))
|
||||
lang.i18n().tc(lang.lang, context, s)
|
||||
}
|
||||
|
||||
/// A string keyed by its command id, falling back to the translation of the English `label`.
|
||||
/// A string keyed by its command id, falling back to the translation of the English `label`. Only
|
||||
/// PdfCraft's own `@id` rows count ([`own_id`]).
|
||||
pub fn tr_id<'a>(lang: Lang, id: &str, label: &'a str) -> &'a str {
|
||||
lang.catalog().id(id).unwrap_or_else(|| tr(lang, label))
|
||||
if own_id(lang, id, label) { lang.i18n().tid(lang.lang, id, label) } else { tr(lang, label) }
|
||||
}
|
||||
|
||||
/// Whether `lang` has PdfCraft's own `@id` row for `id` ([`Lang::has_own`]: command ids are each
|
||||
/// app's own) and it keeps the `{placeholders}` and trailing `…` of the English `label`. craft-i18n
|
||||
/// can't check that, because an `@id` row's source is the id, so a row that doesn't is skipped
|
||||
/// here and the label's translation shows instead.
|
||||
fn own_id(lang: Lang, id: &str, label: &str) -> bool {
|
||||
lang.has_own("@id", id) && lang.i18n().get(lang.lang, "@id", id).is_some_and(|translated| same_shape(translated, label))
|
||||
}
|
||||
|
||||
/// Whether `translated` has the `{placeholders}` (in any order) and the trailing `…` of `english`,
|
||||
/// the check craft-i18n makes on every row whose source is English text, and no `{` left open or
|
||||
/// `}` without its `{`.
|
||||
fn same_shape(translated: &str, english: &str) -> bool {
|
||||
let placeholders = |text: &str| -> Option<Vec<String>> {
|
||||
let mut names = text.split('{').skip(1).map(|p| p.split_once('}').map(|(name, _)| name.to_owned())).collect::<Option<Vec<_>>>()?;
|
||||
if text.matches('}').count() != names.len() {
|
||||
return None;
|
||||
}
|
||||
names.sort_unstable();
|
||||
Some(names)
|
||||
};
|
||||
translated.ends_with('…') == english.ends_with('…') && placeholders(translated).is_some_and(|names| Some(names) == placeholders(english))
|
||||
}
|
||||
|
||||
/// Fill `{name}` placeholders in one pass. Unknown placeholders are left as written, and inserted
|
||||
/// values are never read as templates again, so a file name containing `{n}` stays intact.
|
||||
/// values are never read as templates again, so a file name containing `{n}` stays intact. Unlike
|
||||
/// the crate's `fmt` it adds no bidi isolates: the egui fork orders each run for display.
|
||||
pub fn fmt(template: &str, args: &[(&str, &str)]) -> String {
|
||||
let mut out = String::with_capacity(template.len());
|
||||
let mut rest = template;
|
||||
@@ -728,12 +655,14 @@ pub fn edit_label(label: &pdfcraft_engine::Label) -> String {
|
||||
|
||||
/// A command label such as "Undo Insert pages from a.pdf" in the current language. A catalog
|
||||
/// whose word order doesn't put the verb first translates "Undo {action}" and "Redo {action}"
|
||||
/// as whole phrases; otherwise the translated verb goes before the action.
|
||||
/// as whole phrases, both of them; otherwise the translated verb goes before the action. (The
|
||||
/// shared catalog has "Undo {action}" without "Redo {action}" in some languages, where one phrase
|
||||
/// alone would word Undo and Redo differently.)
|
||||
pub fn command_label(text: &str) -> String {
|
||||
for (prefix, template) in [("Undo", "Undo {action}"), ("Redo", "Redo {action}")] {
|
||||
if let Some(action) = text.strip_prefix(prefix).and_then(|tail| tail.strip_prefix(' ')) {
|
||||
let action = action_label(action);
|
||||
if has(current(), template) {
|
||||
if has(current(), "Undo {action}") && has(current(), "Redo {action}") {
|
||||
return fmt(t(template), &[("action", &action)]);
|
||||
}
|
||||
return format!("{} {action}", t(prefix));
|
||||
@@ -742,20 +671,22 @@ pub fn command_label(text: &str) -> String {
|
||||
t(text).to_owned()
|
||||
}
|
||||
|
||||
/// A registered command's menu label: its `@id` catalog entry if there is one, otherwise
|
||||
/// [`command_label`] of the current English label.
|
||||
/// A registered command's menu label: its `@id` entry in PdfCraft's own catalog if there is one
|
||||
/// that keeps the label's shape ([`own_id`]), otherwise [`command_label`] of the current English
|
||||
/// label.
|
||||
pub fn menu_label(id: &str, label: &str) -> String {
|
||||
match current().catalog().id(id) {
|
||||
let lang = current();
|
||||
match own_id(lang, id, label).then(|| lang.i18n().get(lang.lang, "@id", id)).flatten() {
|
||||
Some(translated) => translated.to_owned(),
|
||||
None => command_label(label),
|
||||
}
|
||||
}
|
||||
|
||||
/// A plural-aware message: `one`/`other` are the English forms (with `{n}` where the count goes).
|
||||
/// The form is the language's CLDR category; `{n}` is written in `0`–`9` without grouping or
|
||||
/// isolate marks, as PdfCraft always has.
|
||||
pub fn trn(lang: Lang, n: u64, one: &str, other: &str) -> String {
|
||||
let idx = (lang.0.plural)(n);
|
||||
let text = lang.catalog().plural(one, other, idx).unwrap_or(if n == 1 { one } else { other });
|
||||
fmt(text, &[("n", &n.to_string())])
|
||||
lang.i18n().trn_plain(lang.lang, n, one, other)
|
||||
}
|
||||
|
||||
/// `name` lowercased with the Latin accents that occur in language names folded away, so a
|
||||
@@ -779,6 +710,27 @@ fn name_sort_key(name: &str) -> String {
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// A test language whose PdfCraft catalog is `source` (catalog format), so tests of lookup code
|
||||
/// don't depend on the embedded catalogs' wording. `code` picks the CLDR plural rules.
|
||||
#[cfg(test)]
|
||||
pub(crate) fn fixture_lang(code: &'static str, source: &'static str) -> Lang {
|
||||
let embedded: &'static craft_i18n::Embedded = Box::leak(Box::new([(code, "", source)]));
|
||||
let (i18n, _) = I18n::new(embedded, &[code]);
|
||||
let i18n: &'static I18n = Box::leak(Box::new(i18n));
|
||||
let lang = i18n.from_code(code).unwrap_or(craft_i18n::Lang::EN);
|
||||
Lang { lang, catalogs: Some(i18n) }
|
||||
}
|
||||
|
||||
/// For a test that needs the embedded catalogs: `false`, with a note, when none were embedded
|
||||
/// (`CRAFT_I18N_DIR` unset), so the test can skip; the interface is then English only.
|
||||
#[cfg(test)]
|
||||
pub(crate) fn needs_catalogs() -> bool {
|
||||
if !catalogs_embedded() {
|
||||
eprintln!("skipped: built without craft-i18n (set CRAFT_I18N_DIR to a craft-i18n checkout); the interface is English only");
|
||||
}
|
||||
catalogs_embedded()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -1,175 +0,0 @@
|
||||
//! Parser and lookup tables for translation catalogs (`*.tsv`, format documented in `ja.tsv`).
|
||||
//!
|
||||
//! Validation is strict (unknown escapes, unknown `@` contexts, placeholder, ellipsis and plural
|
||||
//! form mismatches, duplicates), but a bad line is only skipped and reported: the rest of the
|
||||
//! catalog still loads and the skipped string shows in English. The tests insist the bundled
|
||||
//! catalogs have no errors at all.
|
||||
|
||||
use std::collections::{HashMap, HashSet};
|
||||
|
||||
/// A catalog entry as read from the file.
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
pub struct Entry {
|
||||
pub context: String,
|
||||
pub source: String,
|
||||
pub translation: String,
|
||||
}
|
||||
|
||||
/// A parsed catalog. Values are owned for the life of the process (catalogs are built once).
|
||||
#[derive(Debug, Default)]
|
||||
pub struct Catalog {
|
||||
/// context-free strings: English source → translation (the hot path, looked up every frame)
|
||||
plain: HashMap<String, String>,
|
||||
/// strings with a disambiguating context: context → source → translation
|
||||
contextual: HashMap<String, HashMap<String, String>>,
|
||||
/// command-id keyed strings
|
||||
ids: HashMap<String, String>,
|
||||
/// plural messages: `one|other` → forms
|
||||
plurals: HashMap<String, Vec<String>>,
|
||||
}
|
||||
|
||||
fn unescape(text: &str) -> Result<String, String> {
|
||||
let mut out = String::with_capacity(text.len());
|
||||
let mut chars = text.chars();
|
||||
while let Some(c) = chars.next() {
|
||||
if c != '\\' {
|
||||
out.push(c);
|
||||
continue;
|
||||
}
|
||||
match chars.next() {
|
||||
Some('n') => out.push('\n'),
|
||||
Some('t') => out.push('\t'),
|
||||
Some('\\') => out.push('\\'),
|
||||
Some(other) => return Err(format!("unknown escape \\{other}; use \\n, \\t or \\\\")),
|
||||
None => return Err("trailing backslash; use \\\\ for a literal backslash".into()),
|
||||
}
|
||||
}
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
/// `{name}` placeholders of a template, sorted (translators may reorder them).
|
||||
pub fn placeholders(text: &str) -> Vec<&str> {
|
||||
let mut names = Vec::new();
|
||||
let mut rest = text;
|
||||
while let Some((_, after_open)) = rest.split_once('{') {
|
||||
let Some((name, after_close)) = after_open.split_once('}') else { break };
|
||||
names.push(name);
|
||||
rest = after_close;
|
||||
}
|
||||
names.sort_unstable();
|
||||
names
|
||||
}
|
||||
|
||||
/// Check one entry against its English source. `forms` is the language's number of plural forms.
|
||||
fn validate(entry: &Entry, forms: usize) -> Result<(), String> {
|
||||
let Entry { context, source, translation } = entry;
|
||||
match context.as_str() {
|
||||
// The source is a command id, not a template; the bundled-catalog tests check the id
|
||||
// exists and compare the translation with that command's English label.
|
||||
"@id" => Ok(()),
|
||||
"@plural" => {
|
||||
let english: Vec<&str> = source.split('|').collect();
|
||||
let [one, other] = english.as_slice() else { return Err("plural source must be one|other".into()) };
|
||||
if one.is_empty() || other.is_empty() || placeholders(one) != placeholders(other) {
|
||||
return Err("English plural forms must be nonempty and have matching placeholders".into());
|
||||
}
|
||||
let translated: Vec<&str> = translation.split('|').collect();
|
||||
if translated.len() != forms || translated.iter().any(|form| form.is_empty()) {
|
||||
return Err(format!("expected {forms} nonempty plural forms"));
|
||||
}
|
||||
if translated.iter().any(|form| placeholders(form) != placeholders(other)) {
|
||||
return Err("plural placeholders differ from the English source".into());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
_ if context.starts_with('@') => Err(format!("unknown reserved context {context:?}")),
|
||||
_ => {
|
||||
if placeholders(source) != placeholders(translation) {
|
||||
return Err("placeholders differ from the English source".into());
|
||||
}
|
||||
if source.ends_with('…') != translation.ends_with('…') {
|
||||
return Err("trailing ellipsis differs from the English source".into());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn parse_line(line: &str, forms: usize) -> Result<Entry, String> {
|
||||
let mut columns = line.split('\t');
|
||||
let (Some(context), Some(source), Some(translation), None) = (columns.next(), columns.next(), columns.next(), columns.next()) else {
|
||||
return Err("expected `context<TAB>source<TAB>translation`".into());
|
||||
};
|
||||
let entry = Entry { context: unescape(context)?, source: unescape(source)?, translation: unescape(translation)? };
|
||||
if entry.source.is_empty() || entry.translation.is_empty() {
|
||||
return Err("source and translation must be nonempty".into());
|
||||
}
|
||||
validate(&entry, forms)?;
|
||||
Ok(entry)
|
||||
}
|
||||
|
||||
/// Read the entries of a catalog file for a language with `forms` plural forms. Malformed lines
|
||||
/// and duplicates (the first entry wins) are returned as errors and skipped, so a bad translation
|
||||
/// never breaks the UI.
|
||||
pub fn parse_entries(text: &str, forms: usize) -> (Vec<Entry>, Vec<String>) {
|
||||
let mut entries = Vec::new();
|
||||
let mut errors = Vec::new();
|
||||
let mut seen = HashSet::new();
|
||||
for (index, line) in text.lines().enumerate() {
|
||||
if line.trim().is_empty() || line.starts_with('#') {
|
||||
continue;
|
||||
}
|
||||
let line_no = index.saturating_add(1);
|
||||
match parse_line(line, forms) {
|
||||
Ok(entry) if !seen.insert((entry.context.clone(), entry.source.clone())) => {
|
||||
errors.push(format!("line {line_no}: duplicate key {:?} / {:?}", entry.context, entry.source));
|
||||
}
|
||||
Ok(entry) => entries.push(entry),
|
||||
Err(error) => errors.push(format!("line {line_no}: {error}")),
|
||||
}
|
||||
}
|
||||
(entries, errors)
|
||||
}
|
||||
|
||||
impl Catalog {
|
||||
/// Build a catalog from its valid entries; the errors of the skipped lines come back too.
|
||||
pub fn parse(text: &str, forms: usize) -> (Catalog, Vec<String>) {
|
||||
let (entries, errors) = parse_entries(text, forms);
|
||||
let mut c = Catalog::default();
|
||||
for Entry { context, source, translation } in entries {
|
||||
match context.as_str() {
|
||||
"" => {
|
||||
c.plain.insert(source, translation);
|
||||
}
|
||||
"@id" => {
|
||||
c.ids.insert(source, translation);
|
||||
}
|
||||
"@plural" => {
|
||||
c.plurals.insert(source, translation.split('|').map(str::to_string).collect());
|
||||
}
|
||||
_ => {
|
||||
c.contextual.entry(context).or_default().insert(source, translation);
|
||||
}
|
||||
}
|
||||
}
|
||||
(c, errors)
|
||||
}
|
||||
|
||||
pub fn plain(&self, s: &str) -> Option<&str> {
|
||||
self.plain.get(s).map(String::as_str)
|
||||
}
|
||||
|
||||
pub fn contextual(&self, ctx: &str, s: &str) -> Option<&str> {
|
||||
self.contextual.get(ctx)?.get(s).map(String::as_str)
|
||||
}
|
||||
|
||||
pub fn id(&self, id: &str) -> Option<&str> {
|
||||
self.ids.get(id).map(String::as_str)
|
||||
}
|
||||
|
||||
/// The plural form `index` of the message whose English forms are `one|other`.
|
||||
pub fn plural(&self, one: &str, other: &str, index: usize) -> Option<&str> {
|
||||
let forms = self.plurals.get(&format!("{one}|{other}"))?;
|
||||
forms.get(index.min(forms.len().saturating_sub(1))).map(String::as_str)
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
+519
-188
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -185,6 +185,9 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn right_to_left_labels_match_a_query_typed_in_logical_order() {
|
||||
if !crate::i18n::needs_catalogs() {
|
||||
return;
|
||||
}
|
||||
let arabic = crate::i18n::Lang::from_code("ar").expect("Arabic is registered");
|
||||
let translated = crate::i18n::tr(arabic, "Organize pages");
|
||||
assert_eq!(translated, "تنظيم الصفحات", "the catalogue keeps logical text");
|
||||
|
||||
@@ -125,6 +125,11 @@ impl Motion {
|
||||
self.frame = None;
|
||||
return;
|
||||
}
|
||||
if crate::canvas::wheel_reset::reset_this_pass(ctx) {
|
||||
// The document's hidden cancel resets egui before fresh input. Its app reader
|
||||
// must forget the same older gesture modifiers before reading those events.
|
||||
self.wheel = WheelReader::default();
|
||||
}
|
||||
let options = ctx.options(|o| o.input_options);
|
||||
// One frame may run several passes (`request_discard`). Only the first pass has this
|
||||
// frame's events, and only it may hand the wheel on: a scroll area applies the delta to
|
||||
|
||||
@@ -166,6 +166,53 @@ fn reduced_motion_hands_egui_the_whole_step_and_stops_its_animations() {
|
||||
assert_eq!((style.animation_time, style.scroll_animation), (default.animation_time, default.scroll_animation));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn consumed_document_gesture_does_not_keep_shift_for_another_scroll_area() {
|
||||
let ctx = egui::Context::default();
|
||||
let mut motion = Motion::default();
|
||||
let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, vec2(300.0, 300.0));
|
||||
let pointer = Event::PointerMoved(screen.center());
|
||||
let raw = egui::RawInput {
|
||||
screen_rect: Some(screen),
|
||||
time: Some(0.1),
|
||||
events: vec![
|
||||
pointer.clone(),
|
||||
wheel(MouseWheelUnit::Point, Vec2::ZERO, TouchPhase::Start, Modifiers::SHIFT),
|
||||
wheel(MouseWheelUnit::Point, vec2(0.0, -30.0), TouchPhase::Move, Modifiers::SHIFT),
|
||||
],
|
||||
..Default::default()
|
||||
};
|
||||
ctx.run_ui(raw, |ui| {
|
||||
motion.begin_pass(ui.ctx(), AnimationEffects::Off);
|
||||
assert_eq!(ui.input(|input| input.smooth_scroll_delta), vec2(-30.0, 0.0));
|
||||
// The document owns the raw gesture and schedules its hidden-wheel reset.
|
||||
crate::canvas::wheel_reset::consumed(ui.ctx());
|
||||
ui.input_mut(|input| input.smooth_scroll_delta = Vec2::ZERO);
|
||||
})
|
||||
.drop_without_applying_deltas();
|
||||
|
||||
let fresh = wheel(MouseWheelUnit::Point, vec2(0.0, -18.0), TouchPhase::Move, Modifiers::NONE);
|
||||
let events = vec![pointer, fresh];
|
||||
let raw = egui::RawInput { screen_rect: Some(screen), time: Some(0.1 + 1.0 / 60.0), events: events.clone(), ..Default::default() };
|
||||
let mut offset = Vec2::ZERO;
|
||||
ctx.run_ui(raw, |ui| {
|
||||
// The real plugin already cleared egui's old gesture and hid its own Cancel.
|
||||
let eguis = ui.input(|input| input.smooth_scroll_delta);
|
||||
assert_eq!(eguis.x, 0.0);
|
||||
assert!(eguis.y < 0.0);
|
||||
assert_eq!(ui.input(|input| input.events.clone()), events);
|
||||
motion.begin_pass(ui.ctx(), AnimationEffects::Off);
|
||||
assert_eq!(ui.input(|input| input.smooth_scroll_delta), vec2(0.0, -18.0), "fresh motion follows the released modifier");
|
||||
let out =
|
||||
egui::ScrollArea::both().id_salt("motion-after-document").scroll_offset(vec2(200.0, 200.0)).auto_shrink([false, false]).show(ui, |ui| {
|
||||
ui.set_min_size(vec2(1000.0, 3000.0));
|
||||
});
|
||||
offset = out.state.clamped_offset();
|
||||
})
|
||||
.drop_without_applying_deltas();
|
||||
assert_eq!(offset, vec2(200.0, 218.0), "the other area receives the complete fresh vertical step");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_preference_overrides_the_system_for_every_animation() {
|
||||
use AnimationEffects::{Off, On, System};
|
||||
|
||||
@@ -4,6 +4,9 @@ use super::*;
|
||||
/// back. This is the `Style::right_to_left` half of the explicit RTL policy.
|
||||
#[test]
|
||||
fn arabic_chrome_is_right_to_left_after_the_language_changes() {
|
||||
if !crate::i18n::needs_catalogs() {
|
||||
return;
|
||||
}
|
||||
let previous = crate::i18n::current();
|
||||
let ctx = egui::Context::default();
|
||||
crate::i18n::set_current(crate::i18n::Lang::from_code("ar").expect("registered language"));
|
||||
|
||||
@@ -7,6 +7,7 @@ use egui::{Align2, Color32, CornerRadius, Pos2, Rect, Shape, Stroke, vec2};
|
||||
use crate::canvas::{DocView, PageXform, ViewAction};
|
||||
use crate::page_cursor::Layer;
|
||||
use crate::page_pointer::PagePointer;
|
||||
use crate::page_router::{Hit, Owner, PagePress};
|
||||
use crate::theme::Tokens;
|
||||
pub use pdfcraft_engine::camera_clean::Look;
|
||||
|
||||
@@ -59,8 +60,29 @@ fn screen(xf: &PageXform, c: [f32; 2]) -> Pos2 {
|
||||
xf.norm_to_screen(c[0] / xf.pw.max(1e-3), c[1] / xf.ph.max(1e-3))
|
||||
}
|
||||
|
||||
/// Corner dragging on one page. A press on a page without the quadrilateral moves it there.
|
||||
pub(crate) fn page_input(resp: &egui::Response, xf: &PageXform, ptr: &PagePointer, page: usize, view: &mut DocView, allowed: bool) {
|
||||
/// The corner of the quadrilateral under `p` on `page`, the nearest within reach: the one hit test
|
||||
/// of the camera tool, for the cursor and the press. `None` once the page is enhanced, on a page
|
||||
/// without the quadrilateral, or off the page (a press there is no page's), even where a corner at
|
||||
/// its edge would reach past it.
|
||||
pub(crate) fn hit(xf: &PageXform, page: usize, view: &DocView, p: Pos2) -> Option<Hit> {
|
||||
if view.camera_done.is_some() || !xf.rect.contains(p) {
|
||||
return None;
|
||||
}
|
||||
let q = view.camera.filter(|q| q.page == page)?;
|
||||
let corner = q
|
||||
.corners
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, &c)| (i, screen(xf, c).distance(p)))
|
||||
.filter(|(_, d)| *d <= GRAB)
|
||||
.min_by(|a, b| a.1.total_cmp(&b.1))
|
||||
.map(|(i, _)| i)?;
|
||||
Some(Hit::new(Owner::CameraCorner { corner }, Layer::Handle, egui::CursorIcon::Grab))
|
||||
}
|
||||
|
||||
/// Corner dragging on one page: a corner's own press ([`hit`]) drags it, and a press nobody holds
|
||||
/// on a page without the quadrilateral moves it there.
|
||||
pub(crate) fn page_input(resp: &egui::Response, xf: &PageXform, ptr: &PagePointer, page: usize, view: &mut DocView, allowed: bool, press: PagePress) {
|
||||
let (pointer, origin) = (ptr.pos, ptr.origin);
|
||||
if !allowed {
|
||||
if pointer.is_some_and(|p| xf.rect.contains(p)) {
|
||||
@@ -76,23 +98,25 @@ pub(crate) fn page_input(resp: &egui::Response, xf: &PageXform, ptr: &PagePointe
|
||||
if view.camera.is_none() && page == view.current {
|
||||
view.camera = Some(CameraQuad::inset(page, xf.pw, xf.ph));
|
||||
}
|
||||
if resp.drag_started() || resp.clicked() {
|
||||
let pressed = origin.filter(|o| xf.rect.contains(*o));
|
||||
if pressed.is_some() && view.camera.is_none_or(|q| q.page != page) {
|
||||
view.camera = Some(CameraQuad::inset(page, xf.pw, xf.ph));
|
||||
}
|
||||
if resp.drag_started()
|
||||
&& let (Some(o), Some(q)) = (pressed, view.camera.as_mut())
|
||||
{
|
||||
q.grab = (0..4)
|
||||
.map(|i| (i, screen(xf, q.corners[i]).distance(o)))
|
||||
.filter(|(_, d)| *d <= GRAB)
|
||||
.min_by(|a, b| a.1.total_cmp(&b.1))
|
||||
.map(|(i, _)| i);
|
||||
}
|
||||
// A press nobody holds on a page without the quadrilateral moves it there: a drag from where it
|
||||
// began, a click where it came up (egui has cleared the press's origin by its release, and the
|
||||
// pointer may have moved on in the same frame).
|
||||
let at = if resp.clicked() { ptr.released } else { origin };
|
||||
if (resp.drag_started() || resp.clicked())
|
||||
&& press == PagePress::Free
|
||||
&& at.is_some_and(|p| xf.rect.contains(p))
|
||||
&& view.camera.is_none_or(|q| q.page != page)
|
||||
{
|
||||
view.camera = Some(CameraQuad::inset(page, xf.pw, xf.ph));
|
||||
}
|
||||
if resp.drag_started()
|
||||
&& let PagePress::Mine(Owner::CameraCorner { corner }) = press
|
||||
&& let Some(q) = view.camera.as_mut().filter(|q| q.page == page)
|
||||
{
|
||||
q.grab = Some(corner);
|
||||
}
|
||||
let Some(q) = view.camera.as_mut().filter(|q| q.page == page) else { return };
|
||||
let near = pointer.is_some_and(|p| q.corners.iter().any(|&c| screen(xf, c).distance(p) <= GRAB));
|
||||
// Over a corner, its hit claims the grab cursor.
|
||||
if let Some(i) = q.grab {
|
||||
view.cursor.claim(Layer::Drag, egui::CursorIcon::Grabbing);
|
||||
if let Some(p) = pointer {
|
||||
@@ -101,11 +125,9 @@ pub(crate) fn page_input(resp: &egui::Response, xf: &PageXform, ptr: &PagePointe
|
||||
*c = [x.clamp(0.0, xf.pw), y.clamp(0.0, xf.ph)];
|
||||
}
|
||||
}
|
||||
if resp.drag_stopped() {
|
||||
if resp.drag_stopped() || !ptr.primary_down {
|
||||
q.grab = None;
|
||||
}
|
||||
} else if near {
|
||||
view.cursor.claim(Layer::Handle, egui::CursorIcon::Grab);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ pub(crate) use geometry::{corner_ratio, page_rotation, resized};
|
||||
pub use geometry::{drawn_text_box_rect, text_box_rect};
|
||||
#[cfg(test)]
|
||||
use input::hover_tip;
|
||||
pub(crate) use input::{describe, fill_grabs, hit, keys, nudge_keys, page_after_text, page_input};
|
||||
pub(crate) use input::{anchor, context, context_hit, describe, hit, keys, moving_on, nudge_keys, page_after_text, page_input};
|
||||
pub use menu::{CanvasAction, fill_picker, recent_custom_colours, remember_custom_colour, status_badge, swatch_grid};
|
||||
#[cfg(test)]
|
||||
use menu::{RECENT_CUSTOM, same_colour};
|
||||
|
||||
Loaded 100 of 147 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user