mirror of
https://github.com/storytold/gridcraft.git
synced 2026-11-16 11:00:21 -06:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7e6d9bfa92 |
@@ -18,7 +18,4 @@ jobs:
|
||||
sonarcloud:
|
||||
# Tracked at @main so org-wide CI improvements propagate without PR churn.
|
||||
uses: storytold/craft-common-actions/.github/workflows/sonarcloud.yml@main
|
||||
with:
|
||||
# Match the main CI gate so coverage exercises every glyph-sensitive UI case.
|
||||
fonts-ref: b076417b5880bd4154bd22f00695b1d28c6bea83
|
||||
secrets: inherit
|
||||
|
||||
@@ -121,7 +121,3 @@ People trust GridCraft with their numbers; a crash loses their work. **This outr
|
||||
- Some workflow files here still run their own jobs. Don't add to them. Moving a job into craft-common-actions is its own task, never part of another PR, and the job stays here until a shared workflow runs it.
|
||||
|
||||
New workspace crates include `workspace = true` under `[lints]` in `Cargo.toml`. Production crate roots declare the crate-level lint attributes before modules; crate-level `//!` documentation may precede them.
|
||||
|
||||
## Shared libraries
|
||||
|
||||
Before adding or changing file-format, codec, protocol, or reusable UI code, check `storytold/craft-libs` and its open PRs first; reuse or extend the shared library rather than duplicating it locally, keep app-specific policy and model mapping in the app, and preserve behavior, security/resource limits, attribution, and regression coverage during cutovers.
|
||||
|
||||
+1
-3
@@ -47,7 +47,5 @@ Generated-in-code art is original and has no file to list: the UI icon set (`cra
|
||||
| `docs/images/pivot.png` | GridCraft contributors | screenshot of GridCraft rendered offscreen (`crates/ui-egui/examples/snapshot.rs`) showing an original sample workbook | MIT OR Apache-2.0 | README screenshot; no third-party content |
|
||||
| `docs/images/format-chart.png` | GridCraft contributors | screenshot of GridCraft rendered offscreen (`crates/ui-egui/examples/snapshot.rs`) showing an original sample workbook | MIT OR Apache-2.0 | README screenshot; no third-party content |
|
||||
| `docs/images/page-break.png` | GridCraft contributors | screenshot of GridCraft rendered offscreen (`crates/ui-egui/examples/snapshot.rs`) showing an original sample workbook | MIT OR Apache-2.0 | README screenshot; no third-party content |
|
||||
| Core 14 AFM metric numbers in `crates/pdf/src/symbol.rs` (Symbol: character codes and advance widths) and `crates/pdf/src/metrics.rs` (Helvetica, Times and Courier advance widths); no font file | Adobe Systems Incorporated | Adobe's Core 14 AFM font metrics files (`Symbol.afm` 001.008 and the Helvetica, Times and Courier AFMs) | Adobe's Core 14 metrics notice: the files may be used, copied and distributed for any purpose and without charge, provided the notice is kept (quoted in `crates/pdf/src/metrics.rs`) | Numbers only, typed in from the public metrics. PDF export embeds none of these fonts: Symbol and the Times faces are base-14 fonts every PDF reader supplies, and non-Arabic text outside WinAnsiEncoding is set in a predefined, non-embedded Adobe-GB1 CID font |
|
||||
| Core 14 AFM metric numbers in `crates/pdf/src/symbol.rs` (Symbol: character codes and advance widths) and `crates/pdf/src/metrics.rs` (Helvetica, Times and Courier advance widths); no font file | Adobe Systems Incorporated | Adobe's Core 14 AFM font metrics files (`Symbol.afm` 001.008 and the Helvetica, Times and Courier AFMs) | Adobe's Core 14 metrics notice: the files may be used, copied and distributed for any purpose and without charge, provided the notice is kept (quoted in `crates/pdf/src/metrics.rs`) | Numbers only, typed in from the public metrics. PDF export embeds no font: Symbol and the Times faces are base-14 fonts every PDF reader supplies, and text outside WinAnsiEncoding is set in a predefined, non-embedded Adobe-GB1 CID font |
|
||||
| Unicode values of the Symbol encoding in `crates/pdf/src/symbol.rs` (the code-to-character map; numbers only, no file copied) | Unicode, Inc. | `symbol.txt`, "Adobe Symbol Encoding to Unicode", table version 1.0 (2011-07-12), at unicode.org/Public/MAPPINGS/VENDORS/ADOBE/ | Unicode, Inc.'s notice in the file: "Unicode, Inc. hereby grants the right to freely use the information supplied in this file in the creation of products supporting the Unicode Standard, and to make copies of this file in any form for internal or external distribution as long as this notice remains attached." The file is provided as-is, without warranties | Separate from Adobe's Core 14 notice (previous row), which covers the character codes and widths; the Unicode values come from this table |
|
||||
|
||||
Arabic PDF text uses Noto Sans Arabic from the optional [craft-fonts build input](https://github.com/storytold/craft-fonts), pinned by the release workflow. Author: The Noto Project Authors. Licence: SIL Open Font License 1.1. Native unbundled export uses an installed Noto Sans Arabic face. No new asset file is committed.
|
||||
|
||||
Generated
+18
-63
@@ -937,16 +937,6 @@ name = "craft-fonts-build"
|
||||
version = "0.1.0"
|
||||
source = "git+https://github.com/storytold/craft-libs?rev=aa84415bae3b765fef6b7ef42404f66ad1cff9d9#aa84415bae3b765fef6b7ef42404f66ad1cff9d9"
|
||||
|
||||
[[package]]
|
||||
name = "craft-gridcraft-format"
|
||||
version = "0.1.0"
|
||||
source = "git+https://github.com/storytold/craft-libs?rev=9a6d894200221fcfedc274870c30394d404f859d#9a6d894200221fcfedc274870c30394d404f859d"
|
||||
dependencies = [
|
||||
"serde",
|
||||
"serde_json",
|
||||
"thiserror 2.0.21",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "craft-i18n"
|
||||
version = "0.1.0"
|
||||
@@ -1017,17 +1007,6 @@ name = "craft-sheet"
|
||||
version = "0.1.0"
|
||||
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
|
||||
|
||||
[[package]]
|
||||
name = "craft-stream-codecs"
|
||||
version = "0.1.0"
|
||||
source = "git+https://github.com/storytold/craft-libs?rev=f7e0d7fd5577e102b4634bcbe062e649eb68165f#f7e0d7fd5577e102b4634bcbe062e649eb68165f"
|
||||
dependencies = [
|
||||
"fax",
|
||||
"hayro-ccitt",
|
||||
"hayro-jbig2",
|
||||
"thiserror 2.0.21",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "craft-ui"
|
||||
version = "0.1.0"
|
||||
@@ -2147,7 +2126,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"arboard",
|
||||
"chrono",
|
||||
@@ -2175,7 +2154,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-calc"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-core",
|
||||
"gridcraft-formula",
|
||||
@@ -2187,7 +2166,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-chart"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-calc",
|
||||
"gridcraft-core",
|
||||
@@ -2198,7 +2177,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-cli"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-engine",
|
||||
"gridcraft-mcp",
|
||||
@@ -2211,7 +2190,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-core"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"js-sys",
|
||||
@@ -2222,10 +2201,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-engine"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"craft-csv",
|
||||
"craft-gridcraft-format",
|
||||
"gridcraft-calc",
|
||||
"gridcraft-chart",
|
||||
"gridcraft-core",
|
||||
@@ -2241,14 +2219,13 @@ dependencies = [
|
||||
"serde",
|
||||
"serde_json",
|
||||
"thiserror 2.0.21",
|
||||
"unicode-segmentation",
|
||||
"web-time",
|
||||
"zip 3.0.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-formula"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-core",
|
||||
"serde",
|
||||
@@ -2257,7 +2234,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-functions"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-core",
|
||||
"regex",
|
||||
@@ -2265,7 +2242,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-math"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"ratex-font",
|
||||
"ratex-layout",
|
||||
@@ -2275,7 +2252,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-mcp"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-engine",
|
||||
"log",
|
||||
@@ -2284,7 +2261,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-model"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-core",
|
||||
"gridcraft-formula",
|
||||
@@ -2297,25 +2274,18 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-numfmt"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-core",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-pdf"
|
||||
version = "0.19.1"
|
||||
dependencies = [
|
||||
"craft-stream-codecs",
|
||||
"harfrust",
|
||||
"sha2 0.11.1",
|
||||
"skrifa",
|
||||
"unicode-bidi",
|
||||
]
|
||||
version = "0.20.0"
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-sandbox"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"landlock",
|
||||
"libc",
|
||||
@@ -2326,7 +2296,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-ui-egui"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"craft-ui",
|
||||
"craft-update",
|
||||
@@ -2353,7 +2323,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-web"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"craft-web-api",
|
||||
"craft-web-host",
|
||||
@@ -2372,14 +2342,13 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "gridcraft-xlsx"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"craft-cfb",
|
||||
"craft-csv",
|
||||
"craft-offcrypto",
|
||||
"craft-opc",
|
||||
"craft-xls",
|
||||
"craft-xml",
|
||||
"gridcraft-core",
|
||||
"gridcraft-formula",
|
||||
"gridcraft-functions",
|
||||
@@ -2472,20 +2441,6 @@ dependencies = [
|
||||
"foldhash 0.2.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hayro-ccitt"
|
||||
version = "0.3.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9f4d0e94ddd48749f06bbe4e5389fb9799a0c45bcaf00495042076ef05e3241a"
|
||||
|
||||
[[package]]
|
||||
name = "hayro-jbig2"
|
||||
version = "0.3.0"
|
||||
source = "git+https://github.com/storytold/craft-libs?rev=f7e0d7fd5577e102b4634bcbe062e649eb68165f#f7e0d7fd5577e102b4634bcbe062e649eb68165f"
|
||||
dependencies = [
|
||||
"hayro-ccitt",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "heck"
|
||||
version = "0.5.0"
|
||||
@@ -6881,7 +6836,7 @@ checksum = "e450f9b2ed1dff33c94c12589a87338689467b9c4f5d8a5710bd09a847d2c8a7"
|
||||
|
||||
[[package]]
|
||||
name = "xtask"
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
dependencies = [
|
||||
"gridcraft-engine",
|
||||
"serde_json",
|
||||
|
||||
+1
-6
@@ -4,7 +4,7 @@ members = ["crates/*", "apps/*", "xtask"]
|
||||
default-members = ["crates/*", "apps/gridcraft", "apps/gridcraft-cli", "xtask"]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.19.1"
|
||||
version = "0.20.0"
|
||||
edition = "2024"
|
||||
license = "MIT OR Apache-2.0"
|
||||
rust-version = "1.95"
|
||||
@@ -31,8 +31,6 @@ gridcraft-math = { path = "crates/math" }
|
||||
# craft-libs revision.
|
||||
# craft-update: app-specific pretend versions apply to startup and manual checks.
|
||||
craft-update = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "=0.1.0", features = ["egui"] }
|
||||
# PDF RunLength encoding; this revision also fixes the vendored JBIG2 dependency for Git consumers.
|
||||
craft-stream-codecs = { git = "https://github.com/storytold/craft-libs", rev = "f7e0d7fd5577e102b4634bcbe062e649eb68165f", version = "0.1.0" }
|
||||
# Compound files ([MS-CFB]) and password-encrypted OOXML packages ([MS-OFFCRYPTO]).
|
||||
craft-cfb = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
|
||||
craft-offcrypto = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
|
||||
@@ -41,10 +39,7 @@ craft-opc = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0
|
||||
# Delimited text (CSV, TSV) and SYLK; `crates/xlsx/src/csv.rs` and `crates/engine/src/io/sylk.rs`
|
||||
# turn them into workbooks.
|
||||
craft-csv = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
|
||||
# The native JSON workbook (`.json`, `.scjson`): read, written, and kept newer macros written back.
|
||||
craft-gridcraft-format = { git = "https://github.com/storytold/craft-libs", rev = "9a6d894200221fcfedc274870c30394d404f859d", version = "0.1.0" }
|
||||
# Excel 97-2003 (.xls, BIFF8) workbooks; `crates/xlsx/src/xls.rs` maps them onto the model.
|
||||
craft-xml = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
|
||||
craft-xls = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
|
||||
|
||||
# foundation
|
||||
|
||||
@@ -205,7 +205,7 @@ egui frontend is a separate crate, so the UI can be swapped without touching the
|
||||
|
||||
GridCraft is in **alpha**: the core workflow works end to end, but depth, fidelity and file
|
||||
compatibility are still rough. It covers 89% of standard ribbon commands in our catalog
|
||||
([`docs/parity-checklist.md`](docs/parity-checklist.md)) and 514 standard worksheet functions
|
||||
([`docs/parity-checklist.md`](docs/parity-checklist.md)) and 513 standard worksheet functions
|
||||
([`docs/function-parity.md`](docs/function-parity.md)); this is a parity inventory, not a count of working implementations. Weighted by what spreadsheet users rely on, we
|
||||
estimate it is about 50% ready for real work. Next up: XLSX fidelity on real-world files, very large
|
||||
workbooks and multi-threaded recalc, chart depth, text in every script, and `.xls` import. Stage,
|
||||
|
||||
+4
-9
@@ -2,7 +2,6 @@
|
||||
|
||||
**Stage: alpha** · next: beta, ~25 points of "ready for real work" and ~160–240 h away
|
||||
|
||||
> **Last reviewed:** 2026-11-15 · **Last updated:** 2026-11-15 · **Change:** minor (performance: formula entry and XLSX save win back time lost since 23829d8c (#2654), 465 → 420 ms and 540 → 488 ms on the 100k-row benchmark; Sandbox refuses fcntl's asynchronous notification and the socket ioctls that notify another process on Linux (#3846); CI provisions pinned fonts for coverage tests; the oversized pivot-cache warning's test names the part limit; readiness estimates unchanged) · **Target:** Microsoft Excel (Microsoft 365)
|
||||
> **Last reviewed:** 2026-11-01 · **Last updated:** 2026-11-05 · **Change:** minor (CJK fallback text shares the Latin baseline; earlier: form controls: buttons, sliders and spin buttons; earlier: RefEdit reference boxes in dialogs: Goal Seek, Solver and Data Analysis take ranges by selection on the grid; earlier: Python mode in the formula bar; earlier: Python cells stored and kept in files; earlier: equations: Insert › Equation, editor, gridcraft-math; earlier: What-if and analysis: Solver Sensitivity report for Simplex LP and GRG Nonlinear; earlier: floating objects: one selection, eight resize handles, keyboard delete; earlier: Chart data tables: live source values beneath column, bar, line, area and compatible combo charts; legend keys and borders; XLSX round-trip and print/PDF; earlier: Formulas › Function Library as labelled buttons with category menus; Recently Used and Insert Function categories; XLSX workbook-view selection, bounded tab ratios and sheet-edit regressions; readiness estimates unchanged; earlier: CSV and text open detects each column's date order, so day-first dates are not silently swapped) · **Target:** Microsoft Excel (Microsoft 365)
|
||||
|
||||
GridCraft aims at full Microsoft Excel parity, and at being better in places: faster, open (XLSX
|
||||
@@ -23,7 +22,7 @@ This page is the summary. The detail is in:
|
||||
| Number | Value | Kind |
|
||||
|---|---|---|
|
||||
| 2026-10-14 | Editing a cell with text that would read back as a number, boolean, date or formula (entered with a leading apostrophe) shows the apostrophe in the editor and formula bar, so Enter unchanged keeps it text (#1362) |
|
||||
| **Feature breadth** (weighted) | **~75%** | estimated, anchored on two measurements: ribbon catalog 281 / 296 (94.9%), worksheet functions 514 / 523 (98.3%; 505 working, 96.6%) |
|
||||
| **Feature breadth** (weighted) | **~75%** | estimated, anchored on two measurements: ribbon catalog 281 / 296 (94.9%), worksheet functions 513 / 523 (98.1%; 504 working, 96.4%) |
|
||||
| **Ready for real work** | **~50%** | estimated from written weights (51.6); [target-app-parity.md](docs/target-app-parity.md) |
|
||||
| **Mainstream practitioner** | **~50%** | estimated: typical analyst/finance user, weekly features, × 0.90 interaction × 0.92 stability × 0.88 file exchange; [method](docs/target-app-parity.md#mainstream-practitioner) |
|
||||
| **Essentials user** | **~63%** | estimated: core features only, × 0.92 launch/stability × 0.95 clarity × 0.90 opening sent files; [method](docs/target-app-parity.md#essentials-user) |
|
||||
@@ -75,7 +74,7 @@ collaboration, mobile, AI).
|
||||
| Area | Breadth | Ready | Hours | Doc |
|
||||
|---|---|---|---|---|
|
||||
| Formula language and calculation | ~92% | ~72% | 20–30 | [target-app-parity.md](docs/target-app-parity.md#feature-areas) |
|
||||
| Worksheet functions | 96.6% measured | ~82% | 15–25 | [function-parity.md](docs/function-parity.md) |
|
||||
| Worksheet functions | 96.6% measured | ~82% | 16–26 | [function-parity.md](docs/function-parity.md) |
|
||||
| Editing, navigation, clipboard, fill | ~90% | ~70% | 15–25 | [ui-parity.md](docs/ui-parity.md) |
|
||||
| Cell formatting, styles, conditional formatting | ~95% | ~80% | 8–14 | [target-app-parity.md](docs/target-app-parity.md#feature-areas) |
|
||||
| Sort, filter, tables, validation, outline | ~82% | ~70% | 10–16 | [target-app-parity.md](docs/target-app-parity.md#feature-areas) |
|
||||
@@ -150,8 +149,6 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
|
||||
| 2026-10-31 | Recently Used lists the functions most recently entered in a formula from any source (ribbon, control channel, MCP, scripts), kept with the preferences and returned by `formulas.recentlyUsed`; the Insert Function dialog takes Excel's title and a working category list (Most Recently Used, All, each category) |
|
||||
| 2026-10-31 | Formulas › Function Library as a big Insert Function button, the AutoSum split button and three columns of labelled small buttons, each category book in its own colour; category menus end with Insert Function… on that category; More Functions cascades into the remaining categories; Home › Editing shares the AutoSum menu; the MR key tip opens Recently Used |
|
||||
| 2026-10-31 | System and embedded CJK fallback text shares the Latin baseline in cells, editors and window titles (#1265, #2621). Symbol and emoji alignment, manual row heights and clipping are unchanged |
|
||||
| 2026-10-26 | PDF preserves Context/LTR/RTL reading direction through wrapping and drawing; RTL sheet cells, borders, headings, objects and sparklines mirror consistently |
|
||||
| 2026-10-26 | Arabic PDF export shapes licensed glyph outlines and preserves searchable logical text; characters the font lacks, or a missing Arabic font, fall back to the standard fonts instead of failing the export |
|
||||
| 2026-10-26 | Arabic bidi display/editing preserve logical source text; per-cell reading direction is editable and survives undo, XLSX and conditional-format priority |
|
||||
| 2026-10-26 | Arabic text shows in cells and the interface through a system, fontconfig or craft-fonts Arabic face; workbook fonts keep their script fallbacks |
|
||||
| 2026-10-25 | AutoSum over a selection does what Excel does: a selected row gets one total to its right (in its last cell if that is empty), not a one-cell total under each cell; a block whose last column is empty gets each row's total there, one whose last row is empty each column's, and with both the corner gets the total of the block; otherwise totals go under each column as before |
|
||||
@@ -183,6 +180,7 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
|
||||
| 2026-10-15 | File › Options › Formulas: Maximum Iterations and Maximum Change fields for iterative calculation, disabled while it is off, with Excel's limits (1 to 32767, 0 or more) |
|
||||
| 2026-10-15 | Function help follows the interface language: argument hints, autocomplete, Insert Function (search and readable categories) and the Formulas-tab menus read per-language tables of descriptions and argument names; Spanish keeps its 10 functions in the new format |
|
||||
| 2026-10-15 | Row auto-fit counts a cell's line breaks only when the cell wraps, as Excel does: a file whose unwrapped cells hold multi-line text no longer opens with tall rows (typing a break still turns wrap on and grows the row) |
|
||||
| 2026-10-14 | XLSX import warns when a pivot cache is missing, malformed or too large, naming the cache and saying its PivotTable was kept as plain cells, instead of dropping the PivotTable silently (#1039) |
|
||||
| 2026-10-14 | Set precision as displayed is applied: with the option on, formula results, spills and numbers typed or reformatted are stored as their number format shows them and formulas calculate from those values; `formulas.calculationOptions` gains `precisionAsDisplayed` (turning it on rounds existing constants; locked constants on a protected sheet keep their value; numbers written to a new sheet are rounded too) (#1343) |
|
||||
| 2026-10-14 | Lookups (MATCH, XMATCH, VLOOKUP, HLOOKUP, XLOOKUP, LOOKUP) compare numbers exactly like Excel, so a computed key such as `=0.1+0.2` no longer finds 0.3; `=` and COUNTIF/SUMIF keep their 15-digit comparison |
|
||||
| 2026-10-14 | Functions: EOMONTH, EDATE, WORKDAY, NETWORKDAYS, YEARFRAC, WEEKNUM, the bond and coupon functions, DISC, BIN2DEC, IM* and the other Analysis ToolPak functions give `#VALUE!` for a reference to more than one cell in a value argument, as Excel 365 does, instead of spilling; array constants and computed arrays still lift |
|
||||
@@ -203,7 +201,6 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
|
||||
| 2026-10-13 | Conditional formatting: a rule gathers range statistics only when it reads them (top/bottom, above average, duplicates, scales, bars, icons) and borrows them instead of copying them per cell, so the per-frame lookup of an expression or cell-value rule no longer visits its whole range (#1098, part 1) |
|
||||
| 2026-10-13 | Grid: resizing several selected columns or rows previews on the dragged one and applies the size to all on release; Esc cancels (#1082) |
|
||||
| 2026-10-12 | Next/previous sheet navigation stops at the first/last visible worksheet instead of activating a hidden boundary sheet; the current selection is retained |
|
||||
| 2026-10-12 | GETPIVOTDATA reads PivotTable values by field and items (#284) |
|
||||
| 2026-10-12 | PDF writer: objects are written straight to the output, identical pictures are stored once, style operators are emitted only when they change, `q` nesting is limited to 28 and polyline joins no longer leak into later strokes (#816) |
|
||||
| 2026-10-12 | Insert › Text › WordArt (`insert.wordArt`, `wordArt.set`): floating decorative text with 10 original styles, outline and shadow, in-place editing, XLSX and print (#784) |
|
||||
| 2026-10-12 | Number formatting: one table of built-in formats (xlsx); numbers, dates and General render with one scratch buffer instead of per-token strings; output unchanged, checked against digests recorded from the old code (#817) |
|
||||
@@ -289,8 +286,6 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
|
||||
| 2026-10-31 | minor | Progress log: Recently Used and Insert Function categories |
|
||||
| 2026-10-31 | minor | Progress log: Function Library |
|
||||
| 2026-10-31 | minor | Progress log: shared CJK/Latin baselines in cells, editors and window titles |
|
||||
| 2026-10-26 | minor | Progress log: PDF reading direction and RTL sheets |
|
||||
| 2026-10-26 | minor | Progress log: Arabic PDF text |
|
||||
| 2026-10-26 | minor | Progress log: Arabic bidi display and editing |
|
||||
| 2026-10-26 | minor | Progress log: Arabic font fallback |
|
||||
| 2026-10-25 | minor | Progress log: AutoSum over a selected row, and a selection's empty last row and column |
|
||||
@@ -311,6 +306,7 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
|
||||
| 2026-10-16 | minor | Progress log: floating pictures' textures bounded and kept per workbook |
|
||||
| 2026-10-16 | trivial | Progress log: web preferences kept between visits (#1562) |
|
||||
| 2026-10-16 | minor | Progress log: interface fonts held once instead of twice |
|
||||
| 2026-10-14 | trivial | Progress log: pivot cache import warnings (#1039) |
|
||||
| 2026-10-14 | minor | Progress log: Set precision as displayed applied in calculation (#1343) |
|
||||
| 2026-10-14 | minor | Progress log: `.xls` import reads cell formatting |
|
||||
| 2026-10-14 | minor | Progress log: lookups compare numbers exactly |
|
||||
@@ -323,7 +319,6 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
|
||||
| 2026-10-13 | trivial | Progress log: shared pictures written once on XLSX export (#985) |
|
||||
| 2026-10-13 | minor | Progress log: conditional-format lookups no longer scan the range for rules without statistics (#1098) |
|
||||
| 2026-10-12 | minor | Progress log: hidden-sheet navigation at workbook boundaries |
|
||||
| 2026-10-12 | minor | Worksheet functions 514 / 523 (GETPIVOTDATA); progress log row |
|
||||
| 2026-10-13 | trivial | Progress log: charts cached between frames (#1139) |
|
||||
| 2026-10-12 | minor | Progress log: PDF writer cleanup (#816) |
|
||||
| 2026-10-12 | minor | Catalog 276 → 277 / 292: Insert › WordArt (#784) |
|
||||
|
||||
@@ -368,8 +368,6 @@ pub fn check_bytes(path: &str, bytes: &[u8], opts: &Options) -> FileReport {
|
||||
}
|
||||
|
||||
fn check_inner(path: &str, bytes: &[u8], opts: &Options) -> FileReport {
|
||||
// GETPIVOTDATA needs the engine's pivot indexer; without it every such cell reads #REF!.
|
||||
let _ = gridcraft_engine::model::PIVOT_INDEXER.set(gridcraft_engine::pivot::index_cells);
|
||||
let mut report = FileReport { path: path.to_string(), ..Default::default() };
|
||||
let (cached, warnings) = match gridcraft_engine::io::open_bytes(path, bytes) {
|
||||
Ok(x) => x,
|
||||
|
||||
@@ -78,8 +78,6 @@ fn the_self_test_finds_every_denial() {
|
||||
] {
|
||||
assert!(out.contains(line), "missing `{line}` in:\n{out}");
|
||||
}
|
||||
#[cfg(target_os = "linux")]
|
||||
assert!(out.contains("denied: switch a descriptor's notifications on"), "missing the notification switch in:\n{out}");
|
||||
std::fs::remove_dir_all(home).unwrap();
|
||||
}
|
||||
|
||||
@@ -183,9 +181,7 @@ fn system_python() -> Option<(String, String)> {
|
||||
/// Confined, a program can't signal another process (this test, signal 0 delivering nothing), but can
|
||||
/// still signal itself and its own threads. On Linux, where the filter names them, it also can't
|
||||
/// change another process's limits or priority, or type into a terminal: no call here reaches a real
|
||||
/// terminal, since its standard input isn't one. Linux also refuses the `fcntl` commands that would
|
||||
/// have the kernel signal a process for it: naming the owner, choosing the signal, or switching the
|
||||
/// notification on.
|
||||
/// terminal, since its standard input isn't one.
|
||||
#[test]
|
||||
fn a_confined_program_leaves_other_processes_alone() {
|
||||
if !confines() {
|
||||
@@ -230,13 +226,6 @@ if sys.platform == "linux":
|
||||
assert refused(os.setpriority, os.PRIO_USER, 0, 0), "every process's priority"
|
||||
assert refused(os.sched_setaffinity, other, {0}), "another process's processors"
|
||||
assert refused(os.pidfd_open, other), "a handle on another process"
|
||||
read, write = os.pipe()
|
||||
assert refused(fcntl.fcntl, write, fcntl.F_SETOWN, other), "giving a descriptor's notifications to another process"
|
||||
# 15 is F_SETOWN_EX and 10 is F_SETSIG, which Python's fcntl doesn't name; the filter refuses
|
||||
# them whatever owner or signal they name, so the argument doesn't matter.
|
||||
assert refused(fcntl.fcntl, write, 15), "naming a descriptor's owner the extended way"
|
||||
assert refused(fcntl.fcntl, write, 10), "choosing a descriptor's notification signal"
|
||||
assert refused(fcntl.fcntl, write, fcntl.F_SETFL, fcntl.fcntl(write, fcntl.F_GETFL) | os.O_ASYNC), "switching a descriptor's notifications on"
|
||||
resource.prlimit(0, resource.RLIMIT_NOFILE)
|
||||
resource.prlimit(os.getpid(), resource.RLIMIT_NOFILE)
|
||||
os.setpriority(os.PRIO_PROCESS, 0, os.getpriority(os.PRIO_PROCESS, 0))
|
||||
@@ -251,101 +240,6 @@ print("left alone")
|
||||
assert!(String::from_utf8_lossy(&o.stdout).contains("left alone"), "{}", text(&o));
|
||||
}
|
||||
|
||||
/// A socket the parent made, which the program inherited as a standard stream, can't be pointed at
|
||||
/// another process through the ioctls that do what `fcntl`'s notification commands do: `FIOSETOWN`
|
||||
/// (0x8901) and `FIOASYNC` (0x5452), which Python's `fcntl` passes straight through. Linux only:
|
||||
/// macOS's profile has no rule for them, and its standard streams here are pipes.
|
||||
#[cfg(target_os = "linux")]
|
||||
#[test]
|
||||
fn a_confined_program_cant_point_an_inherited_socket_at_another_process() {
|
||||
if !confines() {
|
||||
return;
|
||||
}
|
||||
let Some((python, prefix)) = system_python() else {
|
||||
return;
|
||||
};
|
||||
let code = r#"
|
||||
import fcntl, sys
|
||||
other = int(sys.argv[1])
|
||||
def refused(call, *args):
|
||||
try:
|
||||
call(*args)
|
||||
except PermissionError:
|
||||
return True
|
||||
except OSError as e:
|
||||
print("other error", e)
|
||||
return False
|
||||
assert refused(fcntl.ioctl, 0, 0x8901, other), "giving a socket's notifications to another process"
|
||||
assert refused(fcntl.ioctl, 0, 0x5452, 1), "switching a socket's notifications on"
|
||||
print("socket quiet")
|
||||
"#;
|
||||
let (mine, _) = std::os::unix::net::UnixStream::pair().unwrap();
|
||||
let socket: std::os::fd::OwnedFd = mine.into();
|
||||
let me = std::process::id().to_string();
|
||||
let o = Command::new(env!("CARGO_BIN_EXE_gridcraft-cli"))
|
||||
.args(["sandbox-check", "--read", &prefix, "--", &python, "-I", "-c", code, &me])
|
||||
.stdin(std::process::Stdio::from(socket))
|
||||
.output()
|
||||
.unwrap();
|
||||
let out = text(&o);
|
||||
assert!(o.status.success(), "{out}");
|
||||
assert!(String::from_utf8_lossy(&o.stdout).contains("socket quiet"), "{out}");
|
||||
}
|
||||
|
||||
/// The same inherited socket, by both ioctls that name the process to notify, `FIOSETOWN` (0x8901)
|
||||
/// and `SIOCSPGRP` (0x8902), with the argument a real pointer. Named by value the kernel reads the
|
||||
/// number as an address and fails with `EFAULT` whether or not the filter refuses it, so that form
|
||||
/// shows only that a rule matched a request number; by pointer each call succeeds unconfined and is
|
||||
/// `EPERM` confined, which is the transition the page claims. Kept apart from the test above so a
|
||||
/// rule dropped for one request number fails for that request, not behind another. Linux only, as
|
||||
/// those rules are: macOS's profile has none, and its standard streams here are pipes.
|
||||
#[cfg(target_os = "linux")]
|
||||
#[test]
|
||||
fn a_confined_program_cant_point_an_inherited_socket_at_another_process_by_pointer() {
|
||||
if !confines() {
|
||||
return;
|
||||
}
|
||||
let Some((python, prefix)) = system_python() else {
|
||||
return;
|
||||
};
|
||||
let code = r#"
|
||||
import fcntl, socket, struct, sys
|
||||
other = int(sys.argv[1])
|
||||
def refused(call, *args):
|
||||
try:
|
||||
call(*args)
|
||||
except PermissionError:
|
||||
return True
|
||||
except OSError as e:
|
||||
print("other error", e)
|
||||
return False
|
||||
# Read first, so a standard stream that is not a socket can't pass for one: a pipe has no socket name.
|
||||
# Detached, not dropped: a socket object closes the descriptor it wrapped when it is collected, and then
|
||||
# the refusals below would be read off an invalid descriptor.
|
||||
wrapped = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM, fileno=0)
|
||||
name = wrapped.getsockname()
|
||||
wrapped.detach()
|
||||
assert name == ""
|
||||
# The process group is a pointer, as a C caller passes it; naming it by value has the kernel read the
|
||||
# number as an address and fail with EFAULT, which would leave the refusal unexplained by the filter.
|
||||
group = bytearray(struct.pack("i", other))
|
||||
assert refused(fcntl.ioctl, 0, 0x8901, group), "giving a socket's notifications to another process"
|
||||
assert refused(fcntl.ioctl, 0, 0x8902, group), "giving a socket's notifications to another process's group"
|
||||
print("socket owner quiet")
|
||||
"#;
|
||||
let (mine, _) = std::os::unix::net::UnixStream::pair().unwrap();
|
||||
let socket: std::os::fd::OwnedFd = mine.into();
|
||||
let me = std::process::id().to_string();
|
||||
let o = Command::new(env!("CARGO_BIN_EXE_gridcraft-cli"))
|
||||
.args(["sandbox-check", "--read", &prefix, "--", &python, "-I", "-c", code, &me])
|
||||
.stdin(std::process::Stdio::from(socket))
|
||||
.output()
|
||||
.unwrap();
|
||||
let out = text(&o);
|
||||
assert!(o.status.success(), "{out}");
|
||||
assert!(String::from_utf8_lossy(&o.stdout).contains("socket owner quiet"), "{out}");
|
||||
}
|
||||
|
||||
/// Confined, a program changes no file, whether the policy lets it read that file or not, by path or
|
||||
/// by a descriptor: not its contents, permissions, owner, extended attributes, times or flags.
|
||||
/// Skipped when there is no `python3`.
|
||||
|
||||
@@ -72,7 +72,6 @@ impl<'h> Evaluator<'h> {
|
||||
"XLOOKUP" => self.xlookup(args),
|
||||
"CELL" => self.cell_info(args),
|
||||
"TRIMRANGE" => self.trimrange(args),
|
||||
"GETPIVOTDATA" => self.getpivotdata(args),
|
||||
"SUBTOTAL" | "AGGREGATE" => self.subtotal(name, args),
|
||||
"TEXT" => {
|
||||
if args.len() != 2 {
|
||||
|
||||
@@ -136,25 +136,6 @@ impl Precedents<'_> {
|
||||
(_, Some(Expr::Number(_) | Expr::Text(_) | Expr::Bool(_) | Expr::Error(_) | Expr::Array(_) | Expr::Missing)) => {}
|
||||
_ => self.dynamic = true,
|
||||
},
|
||||
// GETPIVOTDATA reads the report cells, so it depends on the whole report its reference
|
||||
// points into (pivot commands recalculate everything). Any other reference is dynamic.
|
||||
Expr::Call(n, args) if n == "GETPIVOTDATA" => match args.get(1) {
|
||||
Some(Expr::Ref(r)) => {
|
||||
let si = match &r.sheet {
|
||||
SheetSel::Current => Some(self.sheet),
|
||||
SheetSel::Named(name) => self.wb.sheet_index(name),
|
||||
SheetSel::Span(..) => None,
|
||||
};
|
||||
let report = si
|
||||
.and_then(|i| self.wb.sheet(i))
|
||||
.and_then(|sh| sh.pivots.iter().find_map(|p| p.last_range.filter(|lr| lr.intersects(&r.range()))));
|
||||
match report {
|
||||
Some(lr) => self.push(r, lr, boxes),
|
||||
None => self.dynamic = true,
|
||||
}
|
||||
}
|
||||
_ => self.dynamic = true,
|
||||
},
|
||||
Expr::Call(n, _)
|
||||
if matches!(n.as_str(), "INDIRECT" | "OFFSET" | "NOW" | "TODAY" | "RAND" | "RANDBETWEEN" | "RANDARRAY" | "CELL" | "INFO") =>
|
||||
{
|
||||
@@ -218,7 +199,6 @@ fn is_special(n: &str) -> bool {
|
||||
| "INDEX"
|
||||
| "CELL"
|
||||
| "TRIMRANGE"
|
||||
| "GETPIVOTDATA"
|
||||
| "SUBTOTAL"
|
||||
| "AGGREGATE"
|
||||
| "TEXT"
|
||||
@@ -257,7 +237,6 @@ pub const SPECIAL_FUNCTIONS: &[&str] = &[
|
||||
"INDEX",
|
||||
"CELL",
|
||||
"TRIMRANGE",
|
||||
"GETPIVOTDATA",
|
||||
"SUBTOTAL",
|
||||
"AGGREGATE",
|
||||
"TEXT",
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
#![forbid(unsafe_code)]
|
||||
|
||||
pub mod eval;
|
||||
mod pivotdata;
|
||||
mod precision;
|
||||
pub mod recalc;
|
||||
mod spill_index;
|
||||
|
||||
@@ -1,149 +0,0 @@
|
||||
//! GETPIVOTDATA: a value from a PivotTable report, found by its value field and the row and
|
||||
//! column items that locate it (Excel's documented semantics). Each PivotTable's value cells are
|
||||
//! indexed in `PivotTable::data_index` (set on refresh and saved with the report; built on first
|
||||
//! use only for a pivot loaded without one, and only when it matches the stored report); the
|
||||
//! result is read from the report cell the sheet shows.
|
||||
|
||||
use gridcraft_core::{CellError, CellRef, Value};
|
||||
use gridcraft_formula::Expr;
|
||||
use gridcraft_model::{PIVOT_INDEXER, PivotDataCell, PivotItemRef, PivotLookup, PivotTable};
|
||||
|
||||
use crate::eval::{Ev, Evaluator};
|
||||
|
||||
/// Excel allows 126 field/item pairs.
|
||||
const MAX_PAIRS: usize = 126;
|
||||
|
||||
fn same_text(a: &str, b: &str) -> bool {
|
||||
a.trim().to_lowercase() == b.trim().to_lowercase()
|
||||
}
|
||||
|
||||
/// A number matches an item with that value (dates as serials) or with that label; anything
|
||||
/// else matches the label as text. With `exact`, a number matches only an item of that value.
|
||||
fn item_matches(item: &PivotItemRef, v: &Value, exact: bool) -> bool {
|
||||
if let Value::Number(n) = v {
|
||||
if let Value::Number(x) = &item.value
|
||||
&& n == x
|
||||
{
|
||||
return true;
|
||||
}
|
||||
if exact {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if let Value::Bool(b) = v {
|
||||
return item.value == Value::Bool(*b);
|
||||
}
|
||||
v.to_text().is_ok_and(|t| same_text(&t, &item.label))
|
||||
}
|
||||
|
||||
/// Whether `cell` is the value field asked for with exactly these items.
|
||||
fn cell_matches(cell: &PivotDataCell, data_field: &str, pairs: &[(String, Value)], exact: bool) -> bool {
|
||||
(same_text(&cell.data_field, data_field) || same_text(&cell.source_col, data_field))
|
||||
&& cell.items.len() == pairs.len()
|
||||
&& pairs.iter().all(|(f, v)| cell.items.iter().any(|it| same_text(&it.field, f) && item_matches(it, v, exact)))
|
||||
}
|
||||
|
||||
fn is_axis_field(pt: &PivotTable, field: &str) -> bool {
|
||||
pt.rows.iter().chain(pt.columns.iter()).any(|f| same_text(&f.source_col, field))
|
||||
}
|
||||
|
||||
/// The value cell whose value field and items are exactly those asked for. Text items hit the
|
||||
/// hash index; numbers and booleans also match by value, which a miss falls back to scanning for.
|
||||
/// A number prefers the item of that value: two numeric items can show the same label (0.6 and 1
|
||||
/// formatted as `0`), so a label hit counts only when no item has the exact value.
|
||||
fn find<'a>(cells: &'a PivotLookup, data_field: &str, pairs: &[(String, Value)]) -> Option<&'a PivotDataCell> {
|
||||
let labels: Option<Vec<(&str, String, bool)>> =
|
||||
pairs.iter().map(|(f, v)| v.to_text().ok().map(|t| (f.as_str(), t, matches!(v, Value::Bool(_))))).collect();
|
||||
let hit = labels.as_ref().and_then(|labels| {
|
||||
let refs: Vec<(&str, &str, bool)> = labels.iter().map(|(f, t, b)| (*f, t.as_str(), *b)).collect();
|
||||
cells.find(data_field, &refs)
|
||||
});
|
||||
if pairs.iter().all(|(_, v)| matches!(v, Value::Text(_))) {
|
||||
return hit;
|
||||
}
|
||||
if let Some(c) = hit.filter(|c| cell_matches(c, data_field, pairs, true)) {
|
||||
return Some(c);
|
||||
}
|
||||
let all = cells.cells()?;
|
||||
all.iter()
|
||||
.find(|cell| cell_matches(cell, data_field, pairs, true))
|
||||
.or(hit)
|
||||
.or_else(|| all.iter().find(|cell| cell_matches(cell, data_field, pairs, false)))
|
||||
}
|
||||
|
||||
impl Evaluator<'_> {
|
||||
pub(crate) fn getpivotdata(&mut self, args: &[Expr]) -> Ev {
|
||||
match self.pivot_value(args) {
|
||||
Ok(v) => Ev::V(v),
|
||||
Err(e) => Ev::V(Value::Error(e)),
|
||||
}
|
||||
}
|
||||
|
||||
fn scalar_arg(&mut self, e: &Expr) -> Result<Value, CellError> {
|
||||
match self.value(e).scalar() {
|
||||
Value::Error(e) => Err(e),
|
||||
v => Ok(v),
|
||||
}
|
||||
}
|
||||
|
||||
fn pivot_value(&mut self, args: &[Expr]) -> Result<Value, CellError> {
|
||||
let (Some(field_expr), Some(table_expr)) = (args.first(), args.get(1)) else { return Err(CellError::Value) };
|
||||
let rest = args.get(2..).unwrap_or_default();
|
||||
if rest.len() % 2 != 0 || rest.len() / 2 > MAX_PAIRS {
|
||||
return Err(CellError::Ref);
|
||||
}
|
||||
let data_field = self.scalar_arg(field_expr)?.to_text()?;
|
||||
let area = match self.eval(table_expr) {
|
||||
Ev::R(areas) => areas.first().copied().ok_or(CellError::Ref)?,
|
||||
Ev::V(Value::Error(e)) => return Err(e),
|
||||
_ => return Err(CellError::Ref),
|
||||
};
|
||||
let mut pairs: Vec<(String, Value)> = Vec::with_capacity(rest.len() / 2);
|
||||
for pair in rest.chunks(2) {
|
||||
let (Some(f), Some(i)) = (pair.first(), pair.get(1)) else { return Err(CellError::Ref) };
|
||||
let field = self.scalar_arg(f)?.to_text()?;
|
||||
let item = self.scalar_arg(i)?;
|
||||
if pairs.iter().any(|(g, _)| same_text(g, &field)) {
|
||||
return Err(CellError::Ref);
|
||||
}
|
||||
pairs.push((field, item));
|
||||
}
|
||||
let wb = self.host.workbook();
|
||||
let sheet = wb.sheet(area.sheet).ok_or(CellError::Ref)?;
|
||||
let pt = sheet.pivots.iter().find(|p| p.last_range.is_some_and(|r| r.intersects(&area.range))).ok_or(CellError::Ref)?;
|
||||
// A report filter field may be named when the report shows exactly that one item.
|
||||
let mut axis_pairs = Vec::with_capacity(pairs.len());
|
||||
for (field, item) in pairs {
|
||||
if is_axis_field(pt, &field) {
|
||||
axis_pairs.push((field, item));
|
||||
continue;
|
||||
}
|
||||
let filter = pt.filters.iter().find(|f| same_text(&f.source_col, &field)).ok_or(CellError::Ref)?;
|
||||
let shown = match filter.selected.as_deref() {
|
||||
Some([one]) => item.to_text().is_ok_and(|t| same_text(&t, one)),
|
||||
_ => false,
|
||||
};
|
||||
if !shown {
|
||||
return Err(CellError::Ref);
|
||||
}
|
||||
}
|
||||
// The report's value cells. A pivot loaded without them builds them once; a stored report
|
||||
// that no longer matches its source gets no index at all, so the lookup is #REF! until a
|
||||
// refresh — never an index cached from a failed build, because the shared lookup keeps
|
||||
// the first one set and undo or reopen could then never rebuild it.
|
||||
if pt.data_index.cells().is_none() {
|
||||
let build = PIVOT_INDEXER.get().ok_or(CellError::Ref)?;
|
||||
if let Ok(cells) = build(wb, area.sheet, pt) {
|
||||
pt.data_index.set_cells(cells);
|
||||
}
|
||||
}
|
||||
let cell = find(&pt.data_index, &data_field, &axis_pairs).ok_or(CellError::Ref)?;
|
||||
// The value is the one the sheet shows, so the formula and the report cell always agree.
|
||||
let report = pt.last_range.ok_or(CellError::Ref)?;
|
||||
let at = CellRef::new(report.start.row.saturating_add(cell.row), report.start.col.saturating_add(cell.col));
|
||||
if !report.contains(at) {
|
||||
return Err(CellError::Ref);
|
||||
}
|
||||
Ok(sheet.value(at))
|
||||
}
|
||||
}
|
||||
+4
-119
@@ -48,8 +48,6 @@ pub struct Calc {
|
||||
/// Cells whose formulas have errors from cycles.
|
||||
pub circular: Vec<Key>,
|
||||
pub last_recalc_cells: usize,
|
||||
/// Which anchors held a spill when the current calculation started (see [`Standing`]).
|
||||
standing: Standing,
|
||||
/// The cells whose value is `#SPILL!`, kept so that finding the formulas an emptied cell or a
|
||||
/// freed spill area may unblock doesn't walk every formula or window of cells. Filled in
|
||||
/// `rebuild`, kept up to date by `cells_changed` and by the write-back of a run; an entry is
|
||||
@@ -57,45 +55,6 @@ pub struct Calc {
|
||||
spill_errors: SpillErrors,
|
||||
}
|
||||
|
||||
/// Who gets the cells when two arrays want the same ones. Excel (measured by a reviewer on
|
||||
/// PR #2483) lets the spill that already exists keep its cells, whichever anchor comes first;
|
||||
/// the other formula shows `#SPILL!`, and clearing the winner lets it spill. The rule here:
|
||||
///
|
||||
/// 1. an anchor that held a spill before this calculation outranks one that did not;
|
||||
/// 2. otherwise the anchor first in reading order (row, then column) wins.
|
||||
///
|
||||
/// Rule 2 alone decides when nothing is remembered, so the result never depends on hash order
|
||||
/// or evaluation order. A full recalculation remembers the layout the sheet held before it
|
||||
/// started (rule 1), so it agrees with the incremental one; a workbook that is calculated for
|
||||
/// the first time has no such layout (rule 2 only).
|
||||
///
|
||||
/// Known limits: (a) the xlsx reader does not restore spill layouts, so a workbook opened from a
|
||||
/// file is laid out by rule 2 alone, although Excel keeps the layout the file records; (b) when
|
||||
/// both anchors held a spill and one grows into the other, rule 2 decides, where Excel keeps
|
||||
/// the cells the other already owns.
|
||||
#[derive(Clone, Debug, Default)]
|
||||
struct Standing {
|
||||
/// `true`: `keys` are the anchors that held a spill (full recalculation, which lays every
|
||||
/// spill out afresh). `false`: `keys` are the formulas that held none (incremental).
|
||||
held: bool,
|
||||
keys: HashSet<Key>,
|
||||
}
|
||||
|
||||
impl Standing {
|
||||
fn had_spill(&self, k: Key) -> bool {
|
||||
self.keys.contains(&k) == self.held
|
||||
}
|
||||
|
||||
/// Whether `a` takes cells from `b` when both want them.
|
||||
fn outranks(&self, a: Key, b: Key) -> bool {
|
||||
match (self.had_spill(a), self.had_spill(b)) {
|
||||
(true, false) => true,
|
||||
(false, true) => false,
|
||||
_ => (a.1.row, a.1.col) < (b.1.row, b.1.col),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A set of cells by row, each row's columns in their own set: a window of rows and columns is
|
||||
/// found by one column range per row that has an entry, so the cost follows the cells in the
|
||||
/// window, not those to the side of it in the same rows.
|
||||
@@ -142,7 +101,6 @@ impl Default for Calc {
|
||||
fixed_now: None,
|
||||
circular: vec![],
|
||||
last_recalc_cells: 0,
|
||||
standing: Standing::default(),
|
||||
spill_errors: SpillErrors::default(),
|
||||
}
|
||||
}
|
||||
@@ -311,14 +269,6 @@ impl Calc {
|
||||
/// Recalculates every formula (F9 / Ctrl+Alt+F9, and after loading).
|
||||
pub fn recalc_all(&mut self, wb: &mut Workbook) {
|
||||
self.rebuild(wb);
|
||||
// The layout the sheets hold now decides who keeps cells two arrays both want.
|
||||
// (A Python cell that holds a spill counts too, as it does in the incremental pass.)
|
||||
let mut held = HashSet::default();
|
||||
for i in 0..wb.sheets.len() {
|
||||
if let Some(sh) = wb.sheet(i) {
|
||||
held.extend(sh.spill_ranges.keys().filter(|a| sh.cell(**a).is_some_and(|c| c.formula.is_some() || c.py.is_some())).map(|a| (i, *a)));
|
||||
}
|
||||
}
|
||||
// Spills are laid out again from the formulas where they are now (a structural edit moves
|
||||
// or deletes the formulas, not the values they spilled).
|
||||
for i in 0..wb.sheets.len() {
|
||||
@@ -330,9 +280,7 @@ impl Calc {
|
||||
}
|
||||
}
|
||||
let all: Vec<Key> = self.graph.nodes.keys().copied().collect();
|
||||
self.standing = Standing { held: true, keys: held };
|
||||
self.run(wb, all, true);
|
||||
self.standing = Standing::default();
|
||||
}
|
||||
|
||||
/// Updates the graph for cells whose content changed and recalculates what depends on them.
|
||||
@@ -443,13 +391,6 @@ impl Calc {
|
||||
}
|
||||
}
|
||||
}
|
||||
// So can the area a removed formula spilled over.
|
||||
for (si, r) in &cleared {
|
||||
match emptied.iter_mut().find(|x| x.0 == *si) {
|
||||
Some(x) => x.1 = CellRef::new(x.1.row.max(r.end.row), x.1.col.max(r.end.col)),
|
||||
None => emptied.push((*si, r.end)),
|
||||
}
|
||||
}
|
||||
// An emptied cell can unblock an anchor any distance above or to the left of it.
|
||||
for (si, end) in emptied {
|
||||
seeds.extend(self.unblock_candidates(wb, si, end));
|
||||
@@ -531,22 +472,10 @@ impl Calc {
|
||||
fn run(&mut self, wb: &mut Workbook, mut dirty: Vec<Key>, full: bool) {
|
||||
let mut dynamic_again = !self.graph.dynamic.is_empty();
|
||||
self.last_recalc_cells = 0;
|
||||
let mut seen: HashSet<Key> = HashSet::default();
|
||||
if !full {
|
||||
self.standing = Standing::default();
|
||||
}
|
||||
for _round in 0..8 {
|
||||
if dirty.is_empty() {
|
||||
break;
|
||||
}
|
||||
if !full {
|
||||
// What each formula held before this calculation touched it.
|
||||
for &k in &dirty {
|
||||
if seen.insert(k) && wb.sheet(k.0).is_some_and(|s| !s.spill_ranges.contains_key(&k.1)) {
|
||||
self.standing.keys.insert(k);
|
||||
}
|
||||
}
|
||||
}
|
||||
// Row-major order is a good topological guess; on-demand evaluation fixes the rest.
|
||||
dirty.sort_by_key(|(s, c)| (*s, c.row, c.col));
|
||||
let mut exprs: HashMap<Key, std::sync::Arc<Expr>> = HashMap::with_capacity_and_hasher(dirty.len(), Default::default());
|
||||
@@ -564,7 +493,6 @@ impl Calc {
|
||||
let tp = prof_now();
|
||||
let (results, spills, cycles) = {
|
||||
let mut host = PassHost::new(wb, &exprs, &mut rng, now).with_python(python);
|
||||
host.standing = Some(&self.standing);
|
||||
host.iterate = wb.calc.iterative;
|
||||
for k in &dirty {
|
||||
host.calculate(*k);
|
||||
@@ -663,40 +591,7 @@ impl Calc {
|
||||
if let Some(array) = new {
|
||||
let end = CellRef::new(key.1.row.saturating_add(array.rows as u32 - 1), key.1.col.saturating_add(array.cols as u32 - 1));
|
||||
let range = RangeRef::new(key.1, end);
|
||||
// Two arrays that want the same cells (see [`Standing`]): a spill already laid out
|
||||
// that this anchor outranks is taken over, and recalculated.
|
||||
let standing = &self.standing;
|
||||
// A spill can only be in the way where it has cells besides its anchor, and an
|
||||
// anchor itself blocks the array. When no spilled cell lies in the range, the owners
|
||||
// are not scanned: a full recalculation of many disjoint spills stays linear.
|
||||
let outranked: Vec<(CellRef, RangeRef)> = if range.iter().any(|cell| cell != key.1 && sheet.spill.contains_key(&cell)) {
|
||||
#[cfg(test)]
|
||||
OWNER_SCANS.with(|n| n.set(n.get() + 1));
|
||||
sheet
|
||||
.spill_ranges
|
||||
.iter()
|
||||
.filter(|(o, r)| **o != key.1 && r.intersects(&range) && standing.outranks(*key, (key.0, **o)))
|
||||
.map(|(o, r)| (*o, *r))
|
||||
.collect()
|
||||
} else {
|
||||
Vec::new()
|
||||
};
|
||||
let blocked = spill_is_blocked(sheet, *key, range, end, standing);
|
||||
if !blocked {
|
||||
for (o, r) in outranked {
|
||||
for c in r.iter() {
|
||||
sheet.spill.remove(&c);
|
||||
}
|
||||
sheet.spill_ranges.remove(&o);
|
||||
if let Some(cell) = sheet.cells.get_mut(o) {
|
||||
cell.value = Value::Error(CellError::Spill);
|
||||
self.spill_errors.insert((key.0, o));
|
||||
}
|
||||
spill_changes.push((key.0, o));
|
||||
self.graph.dependents_of_range(key.0, r, &mut spill_changes);
|
||||
freed.push((key.0, r));
|
||||
}
|
||||
}
|
||||
let blocked = spill_is_blocked(sheet, key.1, range, end);
|
||||
if blocked {
|
||||
if let Some(cell) = sheet.cells.get_mut(key.1) {
|
||||
cell.value = Value::Error(CellError::Spill);
|
||||
@@ -733,22 +628,12 @@ impl Calc {
|
||||
}
|
||||
}
|
||||
|
||||
// Owner scans done by `write_back`, to check that disjoint spills never walk every owner.
|
||||
#[cfg(test)]
|
||||
thread_local! {
|
||||
pub(crate) static OWNER_SCANS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
|
||||
}
|
||||
|
||||
/// Whether the array at `anchor` can't be laid out over `range`. A spill already laid out that
|
||||
/// `anchor` outranks does not block it: it is taken over when written back.
|
||||
fn spill_is_blocked(sheet: &gridcraft_model::Sheet, anchor: Key, range: RangeRef, end: CellRef, standing: &Standing) -> bool {
|
||||
let outranked =
|
||||
|cell: CellRef| sheet.spill_ranges.iter().any(|(o, r)| *o != anchor.1 && r.contains(cell) && standing.outranks(anchor, (anchor.0, *o)));
|
||||
fn spill_is_blocked(sheet: &gridcraft_model::Sheet, anchor: CellRef, range: RangeRef, end: CellRef) -> bool {
|
||||
end.row >= gridcraft_core::MAX_ROWS
|
||||
|| end.col >= gridcraft_core::MAX_COLS
|
||||
|| range.iter().any(|cell| cell != anchor.1 && (sheet.cells.has(cell) || (sheet.spill.contains_key(&cell) && !outranked(cell))))
|
||||
|| range.iter().any(|cell| cell != anchor && (sheet.cells.has(cell) || sheet.spill.contains_key(&cell)))
|
||||
|| sheet.merges.iter().any(|merge| merge.intersects(&range))
|
||||
|| sheet.tables.iter().any(|table| table.range.contains(anchor.1))
|
||||
|| sheet.tables.iter().any(|table| table.range.contains(anchor))
|
||||
}
|
||||
|
||||
fn fill_spill(sheet: &mut gridcraft_model::Sheet, anchor: CellRef, range: RangeRef, array: &Array) {
|
||||
|
||||
@@ -31,8 +31,6 @@ pub(super) struct PassHost<'a> {
|
||||
/// every row, so once per sheet rather than once per range read.
|
||||
used: HashMap<usize, Option<RangeRef>>,
|
||||
rng: &'a mut u64,
|
||||
/// Who held a spill before the calculation; unset: every formula did (reading order decides).
|
||||
pub(super) standing: Option<&'a super::Standing>,
|
||||
now: f64,
|
||||
cycle: bool,
|
||||
pub(super) cycles: Vec<Key>,
|
||||
@@ -101,7 +99,6 @@ impl<'a> PassHost<'a> {
|
||||
spill_index: SpillIndex::default(),
|
||||
used: HashMap::default(),
|
||||
rng,
|
||||
standing: None,
|
||||
now,
|
||||
cycle: false,
|
||||
cycles: vec![],
|
||||
@@ -163,26 +160,19 @@ fn spill_hits_overlap(index: &SpillIndex, sheet: usize, hits: &[CellRef], range:
|
||||
}
|
||||
|
||||
/// Whether an array result at `k` can't spill: it is in a table, or its area runs off the sheet,
|
||||
/// overlaps merged cells, holds other cells, or the spill of another formula that outranks it
|
||||
/// (see `Standing`; unless that formula is recalculated in this pass, and so may spill elsewhere
|
||||
/// now). A spill it outranks gives way to it when written back.
|
||||
/// overlaps merged cells, holds other cells, or another formula's spill (unless that formula is
|
||||
/// recalculated in this pass, and so may spill elsewhere now).
|
||||
fn spill_blocked(host: &PassHost<'_>, (sheet, anchor): Key, a: &Array) -> bool {
|
||||
let Some(sh) = host.wb.sheet(sheet) else { return false };
|
||||
let end =
|
||||
CellRef::new(anchor.row.saturating_add((a.rows as u32).saturating_sub(1)), anchor.col.saturating_add((a.cols as u32).saturating_sub(1)));
|
||||
let range = RangeRef::new(anchor, end);
|
||||
let own = sh.spill_ranges.get(&anchor);
|
||||
let default = super::Standing::default();
|
||||
let standing = host.standing.unwrap_or(&default);
|
||||
let spilled_over = |c: CellRef| {
|
||||
!own.is_some_and(|o| o.contains(c))
|
||||
&& sh.spill_ranges.iter().any(|(o, r)| {
|
||||
// A formula or Python cell recalculated in this pass lays its array out again.
|
||||
*o != anchor
|
||||
&& r.contains(c)
|
||||
&& !host.exprs.contains_key(&(sheet, *o))
|
||||
&& !host.python.contains_key(&(sheet, *o))
|
||||
&& standing.outranks((sheet, *o), (sheet, anchor))
|
||||
*o != anchor && r.contains(c) && !host.exprs.contains_key(&(sheet, *o)) && !host.python.contains_key(&(sheet, *o))
|
||||
})
|
||||
};
|
||||
end.row >= gridcraft_core::MAX_ROWS
|
||||
|
||||
@@ -2960,105 +2960,6 @@ fn formulas_read_a_dirty_python_cell_after_it_is_laid_out() {
|
||||
assert_eq!((t.num("A1"), t.num("A2"), t.num("A3")), (5.0, 100.0, 111.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn disjoint_spills_do_not_scan_every_spill_owner() {
|
||||
// Many independent two-cell arrays: write-back must not walk all earlier owners for each one.
|
||||
let mut t = T::new();
|
||||
for i in 1..=2000 {
|
||||
t.wb.sheet_mut(0).unwrap().cells.set(c(&format!("A{}", i * 2 - 1)), Cell::formula(Formula::new("=SEQUENCE(2)")));
|
||||
}
|
||||
crate::recalc::OWNER_SCANS.with(|n| n.set(0));
|
||||
t.calc.recalc_all(&mut t.wb);
|
||||
assert_eq!((t.num("A2"), t.num("A4000")), (2.0, 2.0));
|
||||
let scans = crate::recalc::OWNER_SCANS.with(|n| n.get());
|
||||
assert!(scans < 10, "{scans} owner scans for 2000 disjoint spills");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn overlapping_spill_edit_sequences_match_a_full_recalc() {
|
||||
// Random short edit sequences on a small grid of arrays that run into each other (sizes from
|
||||
// shared cells, so one edit resizes several at once), with constants and clears in their way.
|
||||
// After every edit the incremental result must equal a full recalc of the same workbook.
|
||||
let seeds: u64 = std::env::var("GRIDCRAFT_SPILL_SEEDS").ok().and_then(|v| v.parse().ok()).unwrap_or(200);
|
||||
let steps: usize = std::env::var("GRIDCRAFT_SPILL_STEPS").ok().and_then(|v| v.parse().ok()).unwrap_or(20);
|
||||
let only: Option<u64> = std::env::var("GRIDCRAFT_SPILL_SEED").ok().and_then(|v| v.parse().ok());
|
||||
let next = |state: &mut u64| {
|
||||
*state = state.wrapping_add(0x9E37_79B9_7F4A_7C15);
|
||||
let mut z = *state;
|
||||
z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
|
||||
z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
|
||||
z ^ (z >> 31)
|
||||
};
|
||||
let seeds: Vec<u64> = match only {
|
||||
Some(s) => vec![s],
|
||||
None => (0..seeds).collect(),
|
||||
};
|
||||
for seed in seeds {
|
||||
let mut state = seed;
|
||||
let mut t = T::new();
|
||||
// Sizes in J1:J4.
|
||||
for (i, n) in [2, 3, 1, 4].iter().enumerate() {
|
||||
t.set(&format!("J{}", i + 1), &n.to_string());
|
||||
}
|
||||
let mut log: Vec<(String, String)> = Vec::new();
|
||||
for step in 0..steps {
|
||||
let r = next(&mut state);
|
||||
let at = format!("{}{}", (b'A' + (r % 6) as u8) as char, 1 + (r >> 8) % 6);
|
||||
let kind = (r >> 16) % 14;
|
||||
let (at, input) = match kind {
|
||||
0..=3 => {
|
||||
let a = 1 + (r >> 24) % 4;
|
||||
let b = 1 + (r >> 28) % 4;
|
||||
(at, format!("=SEQUENCE($J${a},$J${b})"))
|
||||
}
|
||||
4 => (at, format!("=SEQUENCE({},{})", 1 + (r >> 24) % 3, 1 + (r >> 28) % 3)),
|
||||
5 => (format!("J{}", 1 + (r >> 24) % 4), (1 + (r >> 28) % 4).to_string()),
|
||||
6 => (at, "x".to_string()),
|
||||
7 | 8 => (at, String::new()),
|
||||
9 => (format!("K{}", 1 + (r >> 24) % 6), "=SUM(A1:F6)".to_string()),
|
||||
10 => {
|
||||
// An earlier edit again (often putting back what a cell held before, as undo does).
|
||||
match log.len() {
|
||||
0 => (at, String::new()),
|
||||
n => log[(r >> 24) as usize % n].clone(),
|
||||
}
|
||||
}
|
||||
11 => (format!("{}{}", (b'A' + ((r >> 24) % 6) as u8) as char, 1 + (r >> 32) % 6), (1 + (r >> 40) % 3).to_string()),
|
||||
// Several cells in one edit (a fill, or clearing a range): a 2x2 block from `at`.
|
||||
12 => (format!("{at}+"), String::new()),
|
||||
_ => (format!("{at}+"), format!("=SEQUENCE($J${},$J${})", 1 + (r >> 24) % 4, 1 + (r >> 28) % 4)),
|
||||
};
|
||||
log.push((at.clone(), input.clone()));
|
||||
if let Some(from) = at.strip_suffix('+') {
|
||||
let from = c(from);
|
||||
let keys: Vec<(usize, CellRef)> =
|
||||
(0..2).flat_map(|dr| (0..2).map(move |dc| (0, CellRef { row: from.row + dr, col: from.col + dc }))).collect();
|
||||
for k in &keys {
|
||||
let cell = if input.is_empty() { Cell::value(Value::Empty) } else { Cell::formula(Formula::new(&input)) };
|
||||
t.wb.sheet_mut(0).unwrap().cells.set(k.1, cell);
|
||||
}
|
||||
t.calc.cells_changed(&mut t.wb, &keys);
|
||||
} else {
|
||||
t.set(&at, &input);
|
||||
}
|
||||
let mut fresh = t.wb.clone();
|
||||
Calc::new().recalc_all(&mut fresh);
|
||||
let (a, b) = (t.wb.sheet(0).unwrap(), fresh.sheet(0).unwrap());
|
||||
for row in 0..12 {
|
||||
for col in 0..12 {
|
||||
let cell = CellRef { row, col };
|
||||
assert_eq!(a.value(cell), b.value(cell), "seed {seed} step {step}: {cell} incremental vs full recalc after {log:?}");
|
||||
}
|
||||
}
|
||||
let mut ka: Vec<_> = a.spill_ranges.iter().map(|(k, v)| (*k, *v)).collect();
|
||||
let mut kb: Vec<_> = b.spill_ranges.iter().map(|(k, v)| (*k, *v)).collect();
|
||||
ka.sort_by_key(|(k, _)| (k.row, k.col));
|
||||
kb.sort_by_key(|(k, _)| (k.row, k.col));
|
||||
assert_eq!(ka, kb, "seed {seed} step {step}: spill layout after {log:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A computed criterion whose formula runs a database function over the same criteria counts as
|
||||
/// not met inside itself: before, each record's check ran the function again for every record, at
|
||||
/// every level, so the work grew exponentially with the nesting allowed.
|
||||
|
||||
@@ -22,12 +22,10 @@ thiserror = { workspace = true }
|
||||
log = { workspace = true }
|
||||
gridcraft-xlsx = { workspace = true }
|
||||
craft-csv = { workspace = true }
|
||||
craft-gridcraft-format = { workspace = true }
|
||||
gridcraft-chart = { workspace = true }
|
||||
gridcraft-pdf = { workspace = true }
|
||||
gridcraft-math = { workspace = true }
|
||||
image = { workspace = true }
|
||||
unicode-segmentation = "=1.13.3"
|
||||
|
||||
[dev-dependencies]
|
||||
gridcraft-xlsx = { workspace = true, features = ["test-support"] }
|
||||
|
||||
@@ -283,8 +283,5 @@ pub(super) fn subtotal(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let range = RangeRef::new(CellRef::new(first, *c), CellRef::new(last - 1, *c)).a1();
|
||||
s.execute("cell.set", json!({"sheet": sheet, "cell": CellRef::new(last, *c).a1(), "input": format!("=SUBTOTAL({code},{range})")}))?;
|
||||
}
|
||||
// One outer group over every data and subtotal row, summarised by the grand total, as in
|
||||
// Excel: outline level 1 then shows only the grand total, and level 2 the subtotals.
|
||||
s.execute("data.group", json!({"sheet": sheet, "rows": format!("{}:{}", first + 1, last)}))?;
|
||||
Ok(json!({"groups": inserted}))
|
||||
}
|
||||
|
||||
@@ -119,29 +119,15 @@ fn do_sort(s: &mut Session, sheet: usize, r: RangeRef, header: bool, keys: Vec<S
|
||||
for (ki, k) in keys.iter().enumerate() {
|
||||
let (va, ca) = &keyed[a as usize][ki];
|
||||
let (vb, cb) = &keyed[b as usize][ki];
|
||||
let plain = || {
|
||||
if case && va.is_text() && vb.is_text() {
|
||||
sort_compare(va, vb).then_with(|| case_order(va.as_text().unwrap_or(""), vb.as_text().unwrap_or("")))
|
||||
} else {
|
||||
sort_compare(va, vb)
|
||||
}
|
||||
};
|
||||
let o = if k.by != "values" {
|
||||
ca.cmp(cb)
|
||||
} else if let Some(list) = &k.list {
|
||||
let pos = |v: &Value| v.as_text().and_then(|t| list.iter().position(|x| x.eq_ignore_ascii_case(t)));
|
||||
match (pos(va), pos(vb)) {
|
||||
(Some(a), Some(b)) => a.cmp(&b),
|
||||
(Some(_), None) => Ordering::Less,
|
||||
(None, Some(_)) => Ordering::Greater,
|
||||
// Values not in the list follow the listed ones in the usual order, as in Excel.
|
||||
// A descending key is left as it was: they tie, so the next key decides.
|
||||
// A blank has no place in the list either, but still goes last.
|
||||
(None, None) if k.desc => va.is_empty().cmp(&vb.is_empty()),
|
||||
(None, None) => plain(),
|
||||
}
|
||||
let pos = |v: &Value| v.as_text().and_then(|t| list.iter().position(|x| x.eq_ignore_ascii_case(t))).unwrap_or(usize::MAX);
|
||||
pos(va).cmp(&pos(vb))
|
||||
} else if case && va.is_text() && vb.is_text() {
|
||||
sort_compare(va, vb).then_with(|| case_order(va.as_text().unwrap_or(""), vb.as_text().unwrap_or("")))
|
||||
} else {
|
||||
plain()
|
||||
sort_compare(va, vb)
|
||||
};
|
||||
// Blanks always sort last, whatever the order.
|
||||
let o = if k.desc && !(va.is_empty() || vb.is_empty()) { o.reverse() } else { o };
|
||||
|
||||
@@ -40,8 +40,8 @@ fn subtotal_puts_summary_rows_below_their_detail() {
|
||||
s.execute("data.subtotal", json!({"range": "A1:B4", "groupBy": "A", "columns": ["B"]})).unwrap();
|
||||
let sh = s.doc().unwrap().wb.active().unwrap().clone();
|
||||
assert!(sh.summary_below, "the totals sit below their groups");
|
||||
// East's detail is rows 2–3 and its total row 4: showing level 2 keeps the total showing.
|
||||
s.execute("data.showLevels", json!({"rows": 2})).unwrap();
|
||||
// East's detail is rows 2–3 and its total row 4: collapsing level 1 keeps the total showing.
|
||||
s.execute("data.showLevels", json!({"rows": 1})).unwrap();
|
||||
let hidden = |s: &Session, row: u32| s.doc().unwrap().wb.active().unwrap().is_row_hidden(row);
|
||||
assert!(hidden(&s, 1) && hidden(&s, 2), "East's detail rows are hidden");
|
||||
assert!(!hidden(&s, 3), "East Total stays visible");
|
||||
|
||||
@@ -36,28 +36,15 @@ pub(super) fn paste_special(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let whole = clip.areas.is_empty() && (clip.selected.is_full_cols() || clip.selected.is_full_rows()) && clip.selected.contains_range(&clip.range);
|
||||
let src = if whole { clip.selected } else { clip.range };
|
||||
let (h, w) = if transpose { (src.width(), src.height()) } else { (src.height(), src.width()) };
|
||||
// Tile the copy over a larger destination that is a multiple of its size. A selection
|
||||
// narrower than the copy but a multiple of its height takes it down every row, at the copy's
|
||||
// width (and a shorter one a multiple of its width across), as in Excel.
|
||||
let multiple = sel.height() % h == 0 && sel.width() % w == 0;
|
||||
let down = sel.width() < w && sel.height() > h && sel.height() % h == 0;
|
||||
let across = sel.height() < h && sel.width() > w && sel.width() % w == 0;
|
||||
// The cells the tiles cover: the selection itself, or for `down`/`across` the selection at the
|
||||
// copy's width/height, which can be much larger than what was selected.
|
||||
let area = if down {
|
||||
u64::from(sel.height()) * u64::from(w)
|
||||
} else if across {
|
||||
u64::from(h) * u64::from(sel.width())
|
||||
} else {
|
||||
sel.count()
|
||||
};
|
||||
let tile = (multiple || down || across)
|
||||
// Tile the copy over a larger destination that is a multiple of its size.
|
||||
let tile = sel.height() % h == 0
|
||||
&& sel.width() % w == 0
|
||||
&& !sel.is_single()
|
||||
&& cell_param_on(s, p, "at", dest_sheet)?.is_none()
|
||||
&& !sel.is_full_cols()
|
||||
&& !sel.is_full_rows()
|
||||
&& area <= 4_000_000;
|
||||
let (tiles_r, tiles_c) = if tile { ((sel.height() / h).max(1), (sel.width() / w).max(1)) } else { (1, 1) };
|
||||
&& sel.count() <= 4_000_000;
|
||||
let (tiles_r, tiles_c) = if tile { (sel.height() / h, sel.width() / w) } else { (1, 1) };
|
||||
// A single cell or row repeated down a filtered selection skips the rows the filter hides; a
|
||||
// taller block is pasted straight down, hidden rows included, as in Excel.
|
||||
let skip_rows = match s.doc()?.wb.sheet(dest_sheet) {
|
||||
|
||||
@@ -290,12 +290,6 @@ pub fn function_list() -> Vec<Json> {
|
||||
("SHEETS", "Information", "SHEETS([reference])", "Number of sheets."),
|
||||
("AREAS", "Lookup", "AREAS(reference)", "Number of areas in a reference."),
|
||||
("TRIMRANGE", "Lookup", "TRIMRANGE(range, [trim_rows], [trim_cols])", "A range or array without its blank outer rows and columns."),
|
||||
(
|
||||
"GETPIVOTDATA",
|
||||
"Lookup",
|
||||
"GETPIVOTDATA(data_field, pivot_table, [field1, item1], ...)",
|
||||
"A value from a PivotTable report, by value field and items.",
|
||||
),
|
||||
("ISOMITTED", "Information", "ISOMITTED(argument)", "TRUE when a LAMBDA argument was left out."),
|
||||
];
|
||||
for (n, c, sig, d) in specials {
|
||||
|
||||
+1586
-21
File diff suppressed because it is too large
Load Diff
@@ -1,38 +1,17 @@
|
||||
use super::{
|
||||
Anchor, CellRef, Chart, ChartKind, EngineError, Json, LegendPos, MAX_COLS, MAX_ROWS, RangeRef, Result, Series, Session, Sheet, anchor_mode_param,
|
||||
bad, block, bool_param, cell_param_on, edit, f64_param, json, size_cap, split_sheet, str_param, target_ranges, target_sheet, u32_param,
|
||||
Anchor, CellRef, Chart, ChartKind, EngineError, Json, LegendPos, RangeRef, Result, Series, Session, Sheet, anchor_mode_param, bad, block,
|
||||
bool_param, cell_param_on, edit, f64_param, json, split_sheet, str_param, target_ranges, target_sheet, u32_param,
|
||||
};
|
||||
|
||||
#[cfg(test)]
|
||||
pub(super) fn compiled() -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
fn chart_areas(s: &Session, p: &Json) -> Result<Vec<RangeRef>> {
|
||||
let mut areas = if p.get("range").is_some() {
|
||||
target_ranges(s, p)?
|
||||
} else if s.doc()?.selection.ranges.len() > 1 {
|
||||
s.doc()?.selection.ranges.clone()
|
||||
} else {
|
||||
vec![block(s, p)?]
|
||||
};
|
||||
// Whole columns/rows span a million cells: clip their far edges to the cells in use, so only
|
||||
// a block that really is too large gets refused. Bounded areas keep their extent as given.
|
||||
let sheet = target_sheet(s, p)?;
|
||||
if let Some(used) = s.doc()?.wb.sheet(sheet).and_then(|sh| sh.used_range()) {
|
||||
// Areas that start outside the used range keep their extent as given.
|
||||
for r in &mut areas {
|
||||
let whole_cols = r.start.row == 0 && r.end.row >= MAX_ROWS - 1;
|
||||
let whole_rows = r.start.col == 0 && r.end.col >= MAX_COLS - 1;
|
||||
if whole_cols && r.start.row <= used.end.row {
|
||||
r.end.row = r.end.row.min(used.end.row);
|
||||
}
|
||||
if whole_rows && r.start.col <= used.end.col {
|
||||
r.end.col = r.end.col.min(used.end.col);
|
||||
}
|
||||
}
|
||||
if p.get("range").is_some() {
|
||||
return target_ranges(s, p);
|
||||
}
|
||||
Ok(areas)
|
||||
let d = s.doc()?;
|
||||
if d.selection.ranges.len() > 1 {
|
||||
return Ok(d.selection.ranges.clone());
|
||||
}
|
||||
Ok(vec![block(s, p)?])
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------- charts
|
||||
@@ -284,8 +263,6 @@ pub fn build_chart(s: &Session, p: &Json) -> Result<(usize, Chart)> {
|
||||
data_table: None,
|
||||
gridlines: !matches!(kind, ChartKind::Pie | ChartKind::Doughnut | ChartKind::Treemap | ChartKind::Sunburst | ChartKind::Funnel),
|
||||
style: 1,
|
||||
hole_size: 75,
|
||||
first_slice_angle: 0,
|
||||
x_title: None,
|
||||
y_title: None,
|
||||
source: (areas.len() == 1).then(|| format!("{}!{}", gridcraft_formula::quote_sheet(&sh.name), bounds.a1())),
|
||||
@@ -331,11 +308,7 @@ pub(super) fn chart_set(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let Some(c) = sh.charts.get_mut(ci) else { return Ok(Json::Null) };
|
||||
if let Some(t) = str_param(p, "type") {
|
||||
c.kind = chart_kind(t, str_param(p, "subtype").unwrap_or(""));
|
||||
if !c.supports_data_table() {
|
||||
c.data_table = None;
|
||||
}
|
||||
}
|
||||
update_data_table(c, p, bool_param(p, "dataTable"))?;
|
||||
if let Some(method) = quartiles {
|
||||
for series in &mut c.series {
|
||||
series.quartiles = method;
|
||||
@@ -362,12 +335,6 @@ pub(super) fn chart_set(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
if let Some(v) = u32_param(p, "style") {
|
||||
c.style = v.clamp(1, 16);
|
||||
}
|
||||
if let Some(v) = u32_param(p, "holeSize") {
|
||||
c.hole_size = v.clamp(10, 90) as u8;
|
||||
}
|
||||
if let Some(v) = u32_param(p, "firstSliceAngle") {
|
||||
c.first_slice_angle = (v % 360) as u16;
|
||||
}
|
||||
if let Some(t) = p.get("xTitle") {
|
||||
c.x_title = t.as_str().map(str::to_string);
|
||||
}
|
||||
@@ -378,10 +345,10 @@ pub(super) fn chart_set(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
c.anchor.cell = at;
|
||||
}
|
||||
if let Some(w) = f64_param(p, "width") {
|
||||
c.anchor.width = w.clamp(20.0, size_cap(c.anchor.width)) as f32;
|
||||
c.anchor.width = w.clamp(20.0, 10000.0) as f32;
|
||||
}
|
||||
if let Some(h) = f64_param(p, "height") {
|
||||
c.anchor.height = h.clamp(20.0, size_cap(c.anchor.height)) as f32;
|
||||
c.anchor.height = h.clamp(20.0, 10000.0) as f32;
|
||||
}
|
||||
if let Some(v) = f64_param(p, "dx") {
|
||||
c.anchor.dx = v as f32;
|
||||
@@ -393,32 +360,6 @@ pub(super) fn chart_set(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
})
|
||||
}
|
||||
|
||||
/// Shared by Chart Properties and Add Chart Element; no separate UI state.
|
||||
pub(crate) fn update_data_table(c: &mut Chart, p: &Json, on: Option<bool>) -> Result<()> {
|
||||
if p.get("dataTable").is_some_and(|v| !v.is_boolean()) {
|
||||
return Err(bad("chart", "`dataTable` must be a boolean"));
|
||||
}
|
||||
if on == Some(false) {
|
||||
c.data_table = None;
|
||||
return Ok(());
|
||||
}
|
||||
let fields = ["dataTableKeys", "dataTableHorizontalBorder", "dataTableVerticalBorder", "dataTableOutline"];
|
||||
if on == Some(true) || fields.iter().any(|k| p.get(k).is_some()) {
|
||||
if !c.supports_data_table() {
|
||||
return Err(bad("chart", "data tables need a column, bar, line, area or compatible combo chart"));
|
||||
}
|
||||
let table = c.data_table.get_or_insert_with(Default::default);
|
||||
for (key, value) in
|
||||
fields.into_iter().zip([&mut table.show_keys, &mut table.horizontal_border, &mut table.vertical_border, &mut table.outline])
|
||||
{
|
||||
if let Some(v) = p.get(key) {
|
||||
*value = v.as_bool().ok_or_else(|| bad("chart", format!("`{key}` must be a boolean")))?;
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(super) fn chart_switch(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let (si, ci) = find_chart(s, p)?;
|
||||
edit(s, |cx| {
|
||||
|
||||
@@ -1,14 +1,8 @@
|
||||
use super::{
|
||||
Anchor, BorderLine, BorderStyle, Borders, CellRef, CfOperator, CfRule, CfValueKind, Color, CondFormat, EngineError, Fill, Json, RangeRef, Result,
|
||||
Session, Shape, ShapeKind, Style, anchor_mode_param, bad, bool_param, cell_param, edit, f64_param, json, ok, str_param, target_ranges,
|
||||
target_sheet, u32_param,
|
||||
Anchor, BorderLine, BorderStyle, Borders, CfOperator, CfRule, CfValueKind, Color, CondFormat, EngineError, Fill, Json, Result, Session, Shape,
|
||||
ShapeKind, Style, anchor_mode_param, bad, bool_param, cell_param, edit, f64_param, json, ok, str_param, target_ranges, target_sheet, u32_param,
|
||||
};
|
||||
|
||||
#[cfg(test)]
|
||||
pub(super) fn compiled() -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------- conditional formatting
|
||||
|
||||
fn preset_style(name: &str) -> Style {
|
||||
@@ -277,13 +271,7 @@ pub(super) fn clear_cf(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
sh.cond_formats.clear();
|
||||
} else {
|
||||
for cf in sh.cond_formats.iter_mut() {
|
||||
let before = RangeRef::top_left(&cf.ranges);
|
||||
cf.ranges.retain(|r| !ranges.iter().any(|x| x.intersects(r)));
|
||||
// The relative formulas are written for the top-left cell: when it goes, they're
|
||||
// rewritten for the new one, so the areas left keep reading the same cells.
|
||||
if let (Some(from), Some(to)) = (before, RangeRef::top_left(&cf.ranges)) {
|
||||
rebase_cf_formulas(&mut cf.rule, from, to);
|
||||
}
|
||||
}
|
||||
sh.cond_formats.retain(|c| !c.ranges.is_empty());
|
||||
}
|
||||
@@ -291,19 +279,6 @@ pub(super) fn clear_cf(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
})
|
||||
}
|
||||
|
||||
/// Moves the relative references of a rule's per-cell formulas written for `from` to `to`.
|
||||
fn rebase_cf_formulas(rule: &mut CfRule, from: CellRef, to: CellRef) {
|
||||
let mv = |f: &str| crate::cmd::data::move_rule_formula(f, from, to);
|
||||
match rule {
|
||||
CfRule::CellIs { a, b, .. } => {
|
||||
*a = mv(a);
|
||||
*b = b.as_deref().map(mv);
|
||||
}
|
||||
CfRule::Expression { formula, .. } => *formula = mv(formula),
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
|
||||
pub(super) fn manage_cf(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let sheet = target_sheet(s, p)?;
|
||||
if p.get("delete").is_none() && p.get("moveUp").is_none() && p.get("moveDown").is_none() {
|
||||
|
||||
@@ -3,11 +3,6 @@ use super::{
|
||||
split_sheet, str_param, target_ranges, target_sheet,
|
||||
};
|
||||
|
||||
#[cfg(test)]
|
||||
pub(super) fn compiled() -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------- links & comments
|
||||
|
||||
pub(super) fn insert_link(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
@@ -32,10 +27,8 @@ pub(super) fn insert_link(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
st.font.underline = Underline::Single;
|
||||
});
|
||||
let sh = cx.sheet_mut(sheet)?;
|
||||
if let Some(t) = text.clone().or_else(|| {
|
||||
(sh.spill_anchor(at).is_none() && sh.value(at).is_empty() && sh.cell(at).is_none_or(|cell| !cell.has_content())).then(|| target.clone())
|
||||
}) {
|
||||
sh.set_cell(at, Cell { value: gridcraft_core::Value::text(t.as_str()), formula: None, style: link_style, py: None });
|
||||
if let Some(t) = text.clone().or_else(|| sh.value(at).is_empty().then(|| target.clone())) {
|
||||
sh.set_cell(at, Cell { value: gridcraft_core::Value::text(t.as_str()), formula: None, style: link_style });
|
||||
} else {
|
||||
sh.set_style(at, link_style);
|
||||
}
|
||||
@@ -45,11 +38,9 @@ pub(super) fn insert_link(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
})
|
||||
}
|
||||
|
||||
/// Follows a link: a reference selects it; anything else is refused ([`crate::links::classify`]).
|
||||
/// An `http`/`https`/`mailto` address is refused too unless the host set
|
||||
/// [`crate::links::LinkPolicy::Allow`]: every caller of a command may be a script or an agent, so
|
||||
/// the user opens such links by clicking and confirming, and the UI then calls
|
||||
/// [`Session::open_confirmed_link`] (#2181). Opens no dialog.
|
||||
/// Follows a link: a reference selects it, an `http`/`https`/`mailto` address is handed to the
|
||||
/// host (`UiRequest::OpenUrl`); anything else is refused ([`crate::links::classify`]). Opens no
|
||||
/// dialog; the interactive click asks for confirmation first, in the UI.
|
||||
pub(super) fn open_link(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let target = match str_param(p, "url").or_else(|| str_param(p, "target")) {
|
||||
Some(t) => t.to_string(),
|
||||
@@ -65,9 +56,6 @@ pub(super) fn open_link(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
match crate::links::classify(&target) {
|
||||
crate::links::LinkKind::Internal(r) => crate::cmd::edit::go_to(s, &json!({"reference": r.trim_start_matches('#')})),
|
||||
crate::links::LinkKind::External(u) => {
|
||||
if s.link_policy != crate::links::LinkPolicy::Allow {
|
||||
return Err(EngineError::Other(crate::links::NEEDS_CONFIRMATION.into()));
|
||||
}
|
||||
s.ui_requests.push(crate::UiRequest::OpenUrl(u.clone()));
|
||||
Ok(json!({"opened": u}))
|
||||
}
|
||||
|
||||
@@ -1,14 +1,8 @@
|
||||
use super::{
|
||||
Anchor, CellPicture, CellRef, Color, EngineError, Image, Json, MAX_OBJECT_OFFSET, ObjKind, ObjRef, PROTECTED, Result, Session, Shape, ShapeKind,
|
||||
Sparkline, SparklineKind, anchor_mode_name, anchor_mode_param, bad, bool_param, cell_param, edit, f64_param, json, locked_cell_error, ok,
|
||||
size_cap, str_param, u32_param,
|
||||
Anchor, CellPicture, CellRef, Color, EngineError, Image, Json, PROTECTED, Result, Session, Shape, ShapeKind, Sparkline, SparklineKind,
|
||||
anchor_mode_name, anchor_mode_param, bad, bool_param, cell_param, edit, f64_param, json, locked_cell_error, ok, str_param, u32_param,
|
||||
};
|
||||
|
||||
#[cfg(test)]
|
||||
pub(super) fn compiled() -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
pub(super) fn insert_sparkline(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let src = str_param(p, "range").ok_or_else(|| bad("insert.sparkline", "missing `range`"))?.to_string();
|
||||
let loc = cell_param(s, p, "location")?.ok_or_else(|| bad("insert.sparkline", "missing `location`"))?;
|
||||
@@ -69,10 +63,6 @@ pub(super) fn insert_picture(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
.unwrap_or_else(|| if data.starts_with(&[0x89, b'P', b'N', b'G']) { "image/png".into() } else { "image/jpeg".into() });
|
||||
let (w, h) = crate::io::image_size(&data).unwrap_or((320, 240));
|
||||
let d = s.doc()?;
|
||||
// Sheet protection locks drawing objects, as for a text box's text.
|
||||
if d.wb.active().is_some_and(|sh| sh.is_protected()) {
|
||||
return Err(EngineError::Other(PROTECTED.into()));
|
||||
}
|
||||
let id = d.wb.next_object_id();
|
||||
let at = cell_param(s, p, "at")?.unwrap_or(d.selection.active);
|
||||
let scale = (640.0 / w.max(1) as f32).min(1.0);
|
||||
@@ -186,15 +176,9 @@ pub(super) fn shape_set_text(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let sheet = d.wb.active_sheet();
|
||||
let sh = d.wb.active().ok_or_else(|| bad("shape.setText", "no such text box"))?;
|
||||
let shape = sh.shapes.iter().find(|shape| shape.id == id).ok_or_else(|| bad("shape.setText", "no such text box"))?;
|
||||
if !matches!(shape.kind, ShapeKind::TextBox | ShapeKind::WordArt) {
|
||||
if shape.kind != ShapeKind::TextBox {
|
||||
return Err(bad("shape.setText", "the shape is not a text box"));
|
||||
}
|
||||
if shape.kind == ShapeKind::WordArt && text.is_empty() {
|
||||
return Err(bad("shape.setText", "WordArt text must not be empty"));
|
||||
}
|
||||
if shape.kind == ShapeKind::WordArt && text.chars().nth(crate::cmd::wordart::MAX_CHARS).is_some() {
|
||||
return Err(bad("shape.setText", format!("`text` is longer than {} characters", crate::cmd::wordart::MAX_CHARS)));
|
||||
}
|
||||
// Sheet protection locks drawing objects (there is no "edit objects" allowance yet).
|
||||
if sh.is_protected() {
|
||||
return Err(EngineError::Other(PROTECTED.into()));
|
||||
@@ -209,50 +193,51 @@ pub(super) fn shape_set_text(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
})
|
||||
}
|
||||
|
||||
/// The floating object a `{kind, id}` command names on the active sheet. Unknown kinds and
|
||||
/// objects are errors, so a stale id never succeeds silently.
|
||||
fn object_param(s: &Session, p: &Json, cmd: &str) -> Result<(usize, ObjRef)> {
|
||||
let id = u32_param(p, "id").ok_or_else(|| bad(cmd, "missing `id`"))?;
|
||||
let kind =
|
||||
str_param(p, "kind").and_then(ObjKind::parse).ok_or_else(|| bad(cmd, "kind must be chart, image, shape, slicer, equation or control"))?;
|
||||
let d = s.doc()?;
|
||||
let sheet = d.wb.active_sheet();
|
||||
let o = ObjRef::new(kind, id);
|
||||
if !d.wb.sheet(sheet).is_some_and(|sh| sh.has_object(o)) {
|
||||
return Err(bad(cmd, "no such object"));
|
||||
}
|
||||
// A locked form control on a protected sheet stays as it is.
|
||||
crate::cmd::controls::check_objects_unlocked(s, sheet, kind, &[id])?;
|
||||
Ok((sheet, o))
|
||||
}
|
||||
|
||||
pub(super) fn delete_object(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let (sheet, o) = object_param(s, p, "object.delete")?;
|
||||
let id = u32_param(p, "id").ok_or_else(|| bad("object.delete", "missing `id`"))?;
|
||||
let kind = str_param(p, "kind").unwrap_or("").to_string();
|
||||
let sheet = s.doc()?.wb.active_sheet();
|
||||
edit(s, |cx| {
|
||||
cx.sheet_mut(sheet)?.remove_object(o);
|
||||
Ok(json!({"deleted": o}))
|
||||
let sh = cx.sheet_mut(sheet)?;
|
||||
match kind.as_str() {
|
||||
"chart" => sh.charts.retain(|c| c.id != id),
|
||||
"image" => sh.images.retain(|c| c.id != id),
|
||||
"slicer" => sh.slicers.retain(|c| c.id != id),
|
||||
_ => sh.shapes.retain(|c| c.id != id),
|
||||
}
|
||||
Ok(Json::Null)
|
||||
})
|
||||
}
|
||||
|
||||
pub(super) fn move_object(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let (sheet, o) = object_param(s, p, "object.move")?;
|
||||
let id = u32_param(p, "id").ok_or_else(|| bad("object.move", "missing `id`"))?;
|
||||
let kind = str_param(p, "kind").unwrap_or("").to_string();
|
||||
let sheet = s.doc()?.wb.active_sheet();
|
||||
let at = cell_param(s, p, "at")?;
|
||||
edit(s, |cx| {
|
||||
let Some(a) = cx.sheet_mut(sheet)?.object_anchor_mut(o) else { return Err(bad("object.move", "no such object")) };
|
||||
let sh = cx.sheet_mut(sheet)?;
|
||||
let anchor = match kind.as_str() {
|
||||
"chart" => sh.charts.iter_mut().find(|c| c.id == id).map(|c| &mut c.anchor),
|
||||
"image" => sh.images.iter_mut().find(|c| c.id == id).map(|c| &mut c.anchor),
|
||||
"slicer" => sh.slicers.iter_mut().find(|c| c.id == id).map(|c| &mut c.anchor),
|
||||
"shape" => sh.shapes.iter_mut().find(|c| c.id == id).map(|c| &mut c.anchor),
|
||||
_ => None,
|
||||
};
|
||||
let Some(a) = anchor else { return Err(bad("object.move", "no such object")) };
|
||||
if let Some(at) = at {
|
||||
a.cell = at;
|
||||
}
|
||||
if let Some(v) = f64_param(p, "dx") {
|
||||
a.dx = v.clamp(-MAX_OBJECT_OFFSET, MAX_OBJECT_OFFSET) as f32;
|
||||
a.dx = v as f32;
|
||||
}
|
||||
if let Some(v) = f64_param(p, "dy") {
|
||||
a.dy = v.clamp(-MAX_OBJECT_OFFSET, MAX_OBJECT_OFFSET) as f32;
|
||||
a.dy = v as f32;
|
||||
}
|
||||
if let Some(v) = f64_param(p, "width") {
|
||||
a.width = v.clamp(1.0, size_cap(a.width)) as f32;
|
||||
a.width = v.clamp(1.0, 10000.0) as f32;
|
||||
}
|
||||
if let Some(v) = f64_param(p, "height") {
|
||||
a.height = v.clamp(0.0, size_cap(a.height)) as f32;
|
||||
a.height = v.clamp(0.0, 10000.0) as f32;
|
||||
}
|
||||
Ok(Json::Null)
|
||||
})
|
||||
@@ -262,10 +247,21 @@ pub(super) fn move_object(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
/// cells" / "Don't move or size with cells"), so it follows — or ignores — its rows and columns
|
||||
/// when the sheet is sorted or edited structurally.
|
||||
pub(super) fn set_anchor_mode(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let (sheet, o) = object_param(s, p, "object.setAnchorMode")?;
|
||||
let id = u32_param(p, "id").ok_or_else(|| bad("object.setAnchorMode", "missing `id`"))?;
|
||||
let kind = str_param(p, "kind").unwrap_or("").to_string();
|
||||
if !matches!(kind.as_str(), "chart" | "image" | "shape") {
|
||||
return Err(bad("object.setAnchorMode", "kind must be chart, image or shape"));
|
||||
}
|
||||
let mode = anchor_mode_param(p).ok_or_else(|| bad("object.setAnchorMode", "mode must be moveAndSize, moveOnly or absolute"))?;
|
||||
let sheet = s.doc()?.wb.active_sheet();
|
||||
edit(s, |cx| {
|
||||
let Some(a) = cx.sheet_mut(sheet)?.object_anchor_mut(o) else { return Err(bad("object.setAnchorMode", "no such object")) };
|
||||
let sh = cx.sheet_mut(sheet)?;
|
||||
let anchor = match kind.as_str() {
|
||||
"chart" => sh.charts.iter_mut().find(|c| c.id == id).map(|c| &mut c.anchor),
|
||||
"image" => sh.images.iter_mut().find(|c| c.id == id).map(|c| &mut c.anchor),
|
||||
_ => sh.shapes.iter_mut().find(|c| c.id == id).map(|c| &mut c.anchor),
|
||||
};
|
||||
let Some(a) = anchor else { return Err(bad("object.setAnchorMode", "no such object")) };
|
||||
a.mode = mode;
|
||||
Ok(json!({"mode": anchor_mode_name(mode)}))
|
||||
})
|
||||
|
||||
@@ -3,11 +3,6 @@ use super::{
|
||||
block, bool_param, edit, json, rewrite, shift_cell_features, str_param, target_range, target_sheet, with,
|
||||
};
|
||||
|
||||
#[cfg(test)]
|
||||
pub(super) fn compiled() -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------- tables
|
||||
|
||||
pub(super) fn insert_table(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
@@ -56,7 +51,7 @@ pub(super) fn insert_table(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
let sh = cx.sheet_mut(sheet)?;
|
||||
// The header row pushes the data down one row: never off the end of the sheet.
|
||||
let last = RangeRef::new(CellRef::new(MAX_ROWS - 1, r.start.col), CellRef::new(MAX_ROWS - 1, r.end.col));
|
||||
if sh.cells.iter_range(last).any(|(_, x)| x.has_content()) {
|
||||
if sh.cells.iter_range(last).any(|(_, x)| x.formula.is_some() || !x.value.is_empty()) {
|
||||
return Err(EngineError::Other("To prevent possible loss of data, cells can't be pushed off the end of the worksheet.".into()));
|
||||
}
|
||||
sh.cells.shift_rows_in_cols(r.start.col, r.end.col, r.start.row, 1);
|
||||
@@ -216,10 +211,7 @@ fn write_totals(sh: &mut Sheet, ti: usize) {
|
||||
let c = CellRef::new(row, t.range.start.col + i as u32);
|
||||
if let Some(code) = col.totals.subtotal_code() {
|
||||
let f = format!("=SUBTOTAL({code},{}[{}])", t.name, col.name);
|
||||
sh.set_cell(
|
||||
c,
|
||||
Cell { formula: Some(std::sync::Arc::new(Formula::new(&f))), value: gridcraft_core::Value::Empty, style: sh.style_id(c), py: None },
|
||||
);
|
||||
sh.set_cell(c, Cell { formula: Some(std::sync::Arc::new(Formula::new(&f))), value: gridcraft_core::Value::Empty, style: sh.style_id(c) });
|
||||
} else if let Some(l) = &col.totals_label {
|
||||
sh.set_value(c, gridcraft_core::Value::text(l.as_str()));
|
||||
} else {
|
||||
|
||||
@@ -628,312 +628,6 @@ fn calculated_field_errors() {
|
||||
assert!(matches!(s.ui_requests.last(), Some(crate::UiRequest::Dialog(n, _)) if n == "pivotCalculatedField"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_reads_the_report() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "columns": ["Product"], "values": ["Sales"]})).unwrap();
|
||||
assert_eq!(pt(&s).last_range.unwrap().a1(), "A3:E8");
|
||||
let gp = |s: &mut Session, cell: &str, f: &str| {
|
||||
s.execute("cell.set", json!({"cell": cell, "input": f})).unwrap();
|
||||
val(s, cell)
|
||||
};
|
||||
// Item cell, row subtotal by any cell of the report, grand total; names and items ignore case.
|
||||
assert_eq!(gp(&mut s, "G1", r#"=GETPIVOTDATA("Sales",$A$3,"Region","East","Product","Apples")"#), Value::Number(160.0));
|
||||
assert_eq!(gp(&mut s, "G2", r#"=GETPIVOTDATA("sales",C6,"region","east")"#), Value::Number(415.0));
|
||||
assert_eq!(gp(&mut s, "G3", r#"=GETPIVOTDATA("Sum of Sales",A3)"#), Value::Number(TOTAL));
|
||||
assert_eq!(gp(&mut s, "G4", r#"=GETPIVOTDATA("Sales",A3,"Product","Pears")"#), Value::Number(270.0));
|
||||
// Not in the report: unknown item, value field, field, unpaired field, not a pivot cell.
|
||||
for (cell, f) in [
|
||||
("H1", r#"=GETPIVOTDATA("Sales",A3,"Region","South")"#),
|
||||
("H2", r#"=GETPIVOTDATA("Units",A3)"#),
|
||||
("H3", r#"=GETPIVOTDATA("Sales",A3,"Date","East")"#),
|
||||
("H4", r#"=GETPIVOTDATA("Sales",A3,"Region")"#),
|
||||
("H5", r#"=GETPIVOTDATA("Sales",Z99)"#),
|
||||
("H6", r#"=GETPIVOTDATA("Sales",A3,"Region","East","Region","East")"#),
|
||||
] {
|
||||
assert_eq!(gp(&mut s, cell, f), Value::Error(CellError::Ref), "{f}");
|
||||
}
|
||||
assert_eq!(gp(&mut s, "H7", r#"=GETPIVOTDATA("Sales",A3,"Region",NA())"#), Value::Error(CellError::NA));
|
||||
// A refresh after a source edit updates the result.
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "E2", "input": "1100"})).unwrap();
|
||||
s.execute("data.refreshAll", json!({})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(val(&s, "G1"), Value::Number(1160.0));
|
||||
// Opening a saved workbook starts without an index (files don't carry it); the first
|
||||
// GETPIVOTDATA builds it.
|
||||
let wb = (*s.doc().unwrap().wb).clone();
|
||||
let (back, _) = gridcraft_xlsx::read_xlsx(&gridcraft_xlsx::write_xlsx(&wb).unwrap()).unwrap();
|
||||
s.add_document(crate::DocState::new(back, None, "Reopened".into(), crate::Trust::FromFile));
|
||||
let d = s.doc().unwrap();
|
||||
let sh = d.wb.sheet(d.wb.sheet_index("Sheet2").unwrap()).unwrap();
|
||||
assert!(sh.pivots.first().unwrap().data_index.cells().is_some());
|
||||
assert_eq!(sh.value(CellRef::parse("G1").unwrap()), Value::Number(1160.0));
|
||||
assert_eq!(sh.value(CellRef::parse("G3").unwrap()), Value::Number(TOTAL + 1000.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_reads_the_displayed_report() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "values": ["Sales"]})).unwrap();
|
||||
// The source changes after the last refresh, then the workbook is saved and reopened:
|
||||
// the report still shows the old numbers, and the formula agrees with the cell.
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "E2", "input": "1100"})).unwrap();
|
||||
let wb = (*s.doc().unwrap().wb).clone();
|
||||
let (back, _) = gridcraft_xlsx::read_xlsx(&gridcraft_xlsx::write_xlsx(&wb).unwrap()).unwrap();
|
||||
s.add_document(crate::DocState::new(back, None, "Reopened".into(), crate::Trust::FromFile));
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
let r = pt(&s).last_range.unwrap();
|
||||
let at = r.start.a1();
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": format!(r#"=GETPIVOTDATA("Sales",{at},"Region","East")"#)})).unwrap();
|
||||
let d = s.doc().unwrap();
|
||||
let sh = d.wb.sheet(d.wb.sheet_index("Sheet2").unwrap()).unwrap();
|
||||
let east = (r.start.row..=r.end.row).find(|row| sh.value(CellRef::new(*row, r.start.col)) == Value::Text("East".into())).unwrap();
|
||||
let shown = sh.value(CellRef::new(east, r.start.col + 1));
|
||||
assert_eq!(shown, Value::Number(415.0));
|
||||
assert_eq!(val(&s, "K1"), shown);
|
||||
}
|
||||
|
||||
/// `=GETPIVOTDATA("Sales", <report>, "Region", <region>)` evaluated in K1 of the active sheet.
|
||||
fn region_sales(s: &mut Session, region: &str) -> Value {
|
||||
let at = pt(s).last_range.unwrap().start.a1();
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": format!(r#"=GETPIVOTDATA("Sales",{at},"Region","{region}")"#)})).unwrap();
|
||||
val(s, "K1")
|
||||
}
|
||||
|
||||
fn reopen(s: &mut Session) {
|
||||
let wb = (*s.doc().unwrap().wb).clone();
|
||||
let (back, _) = gridcraft_xlsx::read_xlsx(&gridcraft_xlsx::write_xlsx(&wb).unwrap()).unwrap();
|
||||
s.add_document(crate::DocState::new(back, None, "Reopened".into(), crate::Trust::FromFile));
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_retries_after_a_lazy_build_fails() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "values": ["Sales"]})).unwrap();
|
||||
// A pivot read from a file carries no index, so the first lookup builds one.
|
||||
reopen(&mut s);
|
||||
assert!(pt(&s).data_index.cells().is_none());
|
||||
// The source changes, so the stored report is stale and the build finds nothing to trust.
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "A2", "input": "Alpha"})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Error(CellError::Ref));
|
||||
assert!(pt(&s).data_index.cells().is_none(), "the failed build caches nothing");
|
||||
// The lookup is shared, so caching a failure as an empty index would leave every state that
|
||||
// shares it #REF! for good. Restoring the source lets the lookup build the index.
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "A2", "input": "East"})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Number(285.0));
|
||||
assert!(pt(&s).data_index.cells().is_some(), "the lookup rebuilt after the failure");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_saves_no_index_when_the_lazy_build_fails() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "values": ["Sales"]})).unwrap();
|
||||
// A pivot read from a file carries no index; a source change makes the stored report stale,
|
||||
// so the lazy build fails and the lookup is #REF!.
|
||||
reopen(&mut s);
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "A2", "input": "Alpha"})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Error(CellError::Ref));
|
||||
// Saving the pivot must save no index at all, not an empty one: restoring an empty index
|
||||
// would count as an index and lock the reopened pivot against the lazy rebuild.
|
||||
let json = serde_json::to_string(&pt(&s)).unwrap();
|
||||
let back: gridcraft_model::PivotTable = serde_json::from_str(&json).unwrap();
|
||||
assert!(json.contains(r#""data_index":null"#), "a failed build saves no index, not an empty one: {json}");
|
||||
assert!(back.data_index.cells().is_none());
|
||||
// Reopened with the source restored, the lookup builds the index.
|
||||
reopen(&mut s);
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "A2", "input": "East"})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Number(285.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_keeps_the_refreshed_report_when_an_item_is_inserted() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "values": ["Sales"]})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Number(285.0));
|
||||
// A new first item in the source shifts every item of a fresh report down one row.
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "A2", "input": "Alpha"})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
// Before the refresh the report still shows the old items, and the lookup reads that report.
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Number(285.0));
|
||||
assert_eq!(region_sales(&mut s, "Alpha"), Value::Error(CellError::Ref));
|
||||
// Saved and reopened unrefreshed: the stored report no longer matches the source, so there
|
||||
// is no index to trust (never the shifted cell of a different item).
|
||||
reopen(&mut s);
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Error(CellError::Ref));
|
||||
assert_eq!(region_sales(&mut s, "Alpha"), Value::Error(CellError::Ref));
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("data.refreshAll", json!({})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "Alpha"), Value::Number(100.0));
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Number(285.0));
|
||||
assert_eq!(region_sales(&mut s, "East"), Value::Number(315.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_keeps_the_refreshed_report_when_an_item_is_removed() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "values": ["Sales"]})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "North"), Value::Number(135.0));
|
||||
// Every North row becomes East: North leaves the report and West moves up.
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
for a in ["A5", "A8", "A11"] {
|
||||
s.execute("cell.set", json!({"cell": a, "input": "East"})).unwrap();
|
||||
}
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "North"), Value::Number(135.0));
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Number(285.0));
|
||||
reopen(&mut s);
|
||||
assert_eq!(region_sales(&mut s, "North"), Value::Error(CellError::Ref));
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Error(CellError::Ref));
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("data.refreshAll", json!({})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
assert_eq!(region_sales(&mut s, "North"), Value::Error(CellError::Ref));
|
||||
assert_eq!(region_sales(&mut s, "West"), Value::Number(285.0));
|
||||
assert_eq!(region_sales(&mut s, "East"), Value::Number(550.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_index_is_saved_with_an_unrefreshed_pivot() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "values": ["Sales"]})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "A2", "input": "Alpha"})).unwrap();
|
||||
s.execute("sheet.activate", json!({"sheet": "Sheet2"})).unwrap();
|
||||
// The pivot as saved by the native format: the index of the stored report comes back with
|
||||
// it even though the source has since changed.
|
||||
let back: gridcraft_model::PivotTable = serde_json::from_str(&serde_json::to_string(&pt(&s)).unwrap()).unwrap();
|
||||
let cells = back.data_index.cells().expect("index saved");
|
||||
assert_eq!(cells, pt(&s).data_index.cells().unwrap());
|
||||
let west = back.data_index.find("Sales", &[("Region", "West", false)]).unwrap();
|
||||
assert_eq!((west.row, west.col), (3, 1));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_calculated_field() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Region"], "values": ["Sales"]})).unwrap();
|
||||
s.execute("pivot.calculatedField", json!({"name": "Double", "formula": "=Sales*2"})).unwrap();
|
||||
let at = pt(&s).last_range.unwrap().start.a1();
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": format!(r#"=GETPIVOTDATA("Double",{at},"Region","East")"#)})).unwrap();
|
||||
assert_eq!(val(&s, "K1"), Value::Number(830.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn getpivotdata_report_filter() {
|
||||
let mut s = sales();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Product"], "values": ["Sales"], "filters": ["Region"]})).unwrap();
|
||||
let at = pt(&s).last_range.unwrap().start.a1();
|
||||
let f = |region: &str| format!(r#"=GETPIVOTDATA("Sales",{at},"Region","{region}","Product","Apples")"#);
|
||||
// With every item shown, naming the filter field is #REF!.
|
||||
s.execute("cell.set", json!({"cell": "H1", "input": f("East")})).unwrap();
|
||||
assert_eq!(val(&s, "H1"), Value::Error(CellError::Ref));
|
||||
// Filtered to East: East matches, West doesn't.
|
||||
s.execute("pivot.filter", json!({"field": "Region", "selected": ["East"]})).unwrap();
|
||||
assert_eq!(val(&s, "H1"), Value::Number(160.0));
|
||||
s.execute("cell.set", json!({"cell": "H2", "input": f("West")})).unwrap();
|
||||
assert_eq!(val(&s, "H2"), Value::Error(CellError::Ref));
|
||||
}
|
||||
|
||||
/// A workbook whose Sheet1 holds `rows` under a two-column header, with a PivotTable of the first
|
||||
/// column (rows) and the second (sum) on a new sheet; the report sheet is active.
|
||||
fn two_column_pivot(header: [&str; 2], rows: Json, key_format: Option<&str>) -> Session {
|
||||
let mut s = Session::new();
|
||||
s.new_workbook();
|
||||
let n = rows.as_array().map_or(0, Vec::len);
|
||||
let mut all = vec![json!(header)];
|
||||
all.extend(rows.as_array().cloned().unwrap_or_default());
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": all})).unwrap();
|
||||
if let Some(code) = key_format {
|
||||
s.execute("home.numberFormat", json!({"range": format!("A2:A{}", n + 1), "code": code})).unwrap();
|
||||
}
|
||||
s.execute("selection.set", json!({"range": "A1"})).unwrap();
|
||||
s.execute("insert.pivotTable", json!({"rows": [header[0]], "values": [header[1]]})).unwrap();
|
||||
s
|
||||
}
|
||||
|
||||
/// The value the report shows for the row item `label` (one value field: the report's last column).
|
||||
fn shown(s: &Session, label: &str) -> Value {
|
||||
let r = pt(s).last_range.unwrap();
|
||||
let row = find_row(s, label).unwrap_or_else(|| panic!("{label} is not in the report"));
|
||||
val(s, &CellRef::new(row, r.end.col).a1())
|
||||
}
|
||||
|
||||
/// Inserting or deleting rows or columns inside a report keeps GETPIVOTDATA on the requested
|
||||
/// item's cell (the stored offsets move with the cells), and undo restores the old positions.
|
||||
#[test]
|
||||
fn getpivotdata_follows_rows_and_columns_edited_inside_the_report() {
|
||||
let mut s = two_column_pivot(["Region", "Sales"], json!([["East", 10], ["North", 30], ["West", 20]]), None);
|
||||
assert_eq!(pt(&s).last_range.unwrap().start.a1(), "A3");
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": r#"=GETPIVOTDATA("Sales",A3,"Region","West")"#})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "K2", "input": r#"=GETPIVOTDATA("Sales",A3,"Region","North")"#})).unwrap();
|
||||
assert_eq!(val(&s, "K1"), Value::Number(20.0));
|
||||
// Row 4 splits the header from the items; column B splits the labels from the values (and
|
||||
// moves the formulas from K to L).
|
||||
for (cmd, lines, west, north) in
|
||||
[("home.insertRows", json!({"rows": "4:4"}), "K1", "K2"), ("home.insertColumns", json!({"cols": "B:B"}), "L1", "L2")]
|
||||
{
|
||||
s.execute(cmd, lines).unwrap();
|
||||
assert_eq!(shown(&s, "West"), Value::Number(20.0), "{cmd}");
|
||||
assert_eq!(val(&s, west), shown(&s, "West"), "{cmd}");
|
||||
assert_eq!(val(&s, north), shown(&s, "North"), "{cmd}");
|
||||
}
|
||||
s.execute("edit.undo", json!({})).unwrap();
|
||||
s.execute("edit.undo", json!({})).unwrap();
|
||||
assert_eq!(pt(&s).last_range.unwrap().start.a1(), "A3");
|
||||
s.execute("cell.set", json!({"cell": "K3", "input": r#"=GETPIVOTDATA("Sales",A3,"Region","West")"#})).unwrap();
|
||||
assert_eq!(val(&s, "K3"), Value::Number(20.0), "undo restores the report and its offsets");
|
||||
// Deleting North's row moves West up; North itself is gone from the report.
|
||||
let north = find_row(&s, "North").unwrap() + 1;
|
||||
s.execute("home.deleteRows", json!({"rows": format!("{north}:{north}")})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": r#"=GETPIVOTDATA("Sales",A3,"Region","West")"#})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "K2", "input": r#"=GETPIVOTDATA("Sales",A3,"Region","North")"#})).unwrap();
|
||||
assert_eq!(val(&s, "K1"), Value::Number(20.0));
|
||||
assert_eq!(val(&s, "K1"), shown(&s, "West"));
|
||||
assert_eq!(val(&s, "K2"), Value::Error(CellError::Ref), "a deleted value cell is not read from its old place");
|
||||
// Lines inserted at the report's first line move the whole report, and lines right after it
|
||||
// leave it alone; either way the offsets stay what they were.
|
||||
for rows in ["3:3", "9:9"] {
|
||||
s.execute("home.insertRows", json!({"rows": rows})).unwrap();
|
||||
let at = pt(&s).last_range.unwrap().start.a1();
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": format!(r#"=GETPIVOTDATA("Sales",{at},"Region","West")"#)})).unwrap();
|
||||
assert_eq!(val(&s, "K1"), Value::Number(20.0), "insert {rows}");
|
||||
assert_eq!(val(&s, "K1"), shown(&s, "West"), "insert {rows}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Numeric items whose formatted labels collide are told apart by value: an exact numeric item
|
||||
/// wins over another item that only displays the same label.
|
||||
#[test]
|
||||
fn getpivotdata_matches_numeric_items_by_value_before_label() {
|
||||
let mut s = two_column_pivot(["Key", "Sales"], json!([[0.6, 10], [1, 20]]), Some("0"));
|
||||
let p = pt(&s);
|
||||
let labels: Vec<&str> = p.data_index.cells().unwrap().iter().flat_map(|c| c.items.iter().map(|i| i.label.as_str())).collect();
|
||||
assert_eq!(labels, ["1", "1"], "both items display as 1");
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": r#"=GETPIVOTDATA("Sales",A3,"Key",1)"#})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "K2", "input": r#"=GETPIVOTDATA("Sales",A3,"Key",0.6)"#})).unwrap();
|
||||
assert_eq!(val(&s, "K1"), Value::Number(20.0));
|
||||
assert_eq!(val(&s, "K2"), Value::Number(10.0));
|
||||
// Dates: two times on one day show the same date label; each serial finds its own item.
|
||||
let mut s = two_column_pivot(["Day", "Sales"], json!([[45000, 10], [45000.25, 20]]), Some("m/d/yyyy"));
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": r#"=GETPIVOTDATA("Sales",A3,"Day",45000.25)"#})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "K2", "input": r#"=GETPIVOTDATA("Sales",A3,"Day",45000)"#})).unwrap();
|
||||
assert_eq!(val(&s, "K1"), Value::Number(20.0));
|
||||
assert_eq!(val(&s, "K2"), Value::Number(10.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn replace_protection() {
|
||||
let mut s = sales();
|
||||
@@ -1368,34 +1062,6 @@ fn detail_cells_are_the_cells_show_details_takes() {
|
||||
assert!(crate::pivot::detail_cells(&d.wb, pt, d.wb.active_sheet()).unwrap_err().contains("out of date"));
|
||||
}
|
||||
|
||||
/// Measurement, not a check: `perf stat -e instructions:u` of this test with `PIVOT_BENCH_EDITS=0`
|
||||
/// and `=20` (and `PIVOT_BENCH_REOPEN=0/1`) gives the cost of edits on the report's sheet and of
|
||||
/// opening a saved workbook, with the setup subtracted. `PIVOT_BENCH_ROWS` is the source size.
|
||||
#[test]
|
||||
#[ignore = "measurement only"]
|
||||
fn bench_edit_on_sheet_with_large_report() {
|
||||
let env = |k: &str, d: usize| std::env::var(k).ok().and_then(|v| v.parse().ok()).unwrap_or(d);
|
||||
let (n, edits) = (env("PIVOT_BENCH_ROWS", 100_000), env("PIVOT_BENCH_EDITS", 0));
|
||||
let mut s = Session::new();
|
||||
s.new_workbook();
|
||||
let mut rows = vec![json!(["Id", "Product", "Sales"])];
|
||||
rows.extend((0..n).map(|i| {
|
||||
let (id, product) = (format!("id{i:07}"), ["Apples", "Pears", "Plums"][i % 3]);
|
||||
json!([id, product, i])
|
||||
}));
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": rows})).unwrap();
|
||||
s.execute("selection.set", json!({"range": "A1"})).unwrap();
|
||||
s.execute("insert.pivotTable", json!({"rows": ["Id"], "columns": ["Product"], "values": ["Sales"]})).unwrap();
|
||||
for i in 0..edits {
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": i.to_string()})).unwrap();
|
||||
}
|
||||
if env("PIVOT_BENCH_REOPEN", 0) == 1 {
|
||||
let wb = (*s.doc().unwrap().wb).clone();
|
||||
let (back, _) = gridcraft_xlsx::read_xlsx(&gridcraft_xlsx::write_xlsx(&wb).unwrap()).unwrap();
|
||||
s.add_document(crate::DocState::new(back, None, "Reopened".into(), crate::Trust::FromFile));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rank_ties_are_dense_and_count_numbers_is_captioned_count_of() {
|
||||
// #1448 items 10 and 12: Excel ranks 5, 4, 3, 3, 4 as 1, 2, 3, 3, 2 (GridCraft gave 1, 2, 4,
|
||||
|
||||
@@ -13,15 +13,13 @@ use gridcraft_core::{CellRef, MAX_COLS, MAX_ROWS, RangeRef, Value};
|
||||
#[cfg(test)]
|
||||
use gridcraft_model::{Alignment, Image, SheetViewMode};
|
||||
use gridcraft_model::{
|
||||
Anchor, BorderLine, BorderStyle, Borders, Color, HAlign, Orientation, PageOrder, PatternType, PrintSettings, ReadingOrder, ShapeKind, Sheet,
|
||||
Style, StyleId, StyleTable, Underline, VAlign, Visibility, Workbook,
|
||||
Anchor, BorderLine, BorderStyle, Borders, Color, HAlign, Orientation, PageOrder, PatternType, PrintSettings, ShapeKind, Sheet, Style, StyleId,
|
||||
StyleTable, Underline, VAlign, Visibility, Workbook,
|
||||
};
|
||||
use gridcraft_pdf::{Baseline, Font, Page, PdfDoc, Point, Rect, Rgb, TextDirection};
|
||||
use gridcraft_pdf::{Font, Page, PdfDoc, Point, Rect, Rgb};
|
||||
use serde_json::{Value as Json, json};
|
||||
|
||||
use super::{
|
||||
CommandSpec, EngineError, Result, Session, bad, bool_param, cmd, edit, f64_param, has_doc, split_sheet, str_param, target_sheet, u32_param,
|
||||
};
|
||||
use super::{CommandSpec, Result, Session, bad, bool_param, cmd, edit, f64_param, has_doc, split_sheet, str_param, target_sheet, u32_param};
|
||||
|
||||
mod draw;
|
||||
mod header_footer;
|
||||
@@ -153,17 +151,8 @@ pub(crate) const PX_TO_PT: f32 = 0.75;
|
||||
/// Most pages one export produces.
|
||||
pub const MAX_PAGES: usize = 2000;
|
||||
|
||||
/// A rendered PDF and whether some of its Arabic text was set without an Arabic face.
|
||||
pub struct RenderedPdf {
|
||||
pub bytes: Vec<u8>,
|
||||
pub pages: usize,
|
||||
pub missing_arabic_font: bool,
|
||||
}
|
||||
|
||||
const MISSING_ARABIC_FONT: &str = "Some Arabic text could not be drawn in this PDF because no Noto Sans Arabic face was found for it.";
|
||||
|
||||
/// Renders laid-out sheets to a PDF.
|
||||
pub fn render_pdf(wb: &Workbook, layouts: &[SheetLayout], file: &str, path: &str) -> Result<RenderedPdf> {
|
||||
pub fn render_pdf(wb: &Workbook, layouts: &[SheetLayout], file: &str, path: &str) -> (Vec<u8>, usize) {
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.info.title = if wb.props.title.is_empty() { file.to_string() } else { wb.props.title.clone() };
|
||||
doc.info.author = wb.props.author.clone();
|
||||
@@ -199,16 +188,7 @@ pub fn render_pdf(wb: &Workbook, layouts: &[SheetLayout], file: &str, path: &str
|
||||
let b = make_block(wb, lay.sheet, sh, *rs, *cs, (x, y), lay);
|
||||
draw_block(pg, &b, lay.settings.gridlines, &mut cf);
|
||||
draw_block_links(pg, &b, page_index, &mut pending_links);
|
||||
printed_blocks.push(PrintedBlock {
|
||||
page: page_index,
|
||||
sheet: lay.sheet,
|
||||
rows: *rs,
|
||||
cols: *cs,
|
||||
x,
|
||||
y,
|
||||
k,
|
||||
mirror_axis: sh.right_to_left.then_some(b.mirror_axis),
|
||||
});
|
||||
printed_blocks.push(PrintedBlock { page: page_index, sheet: lay.sheet, rows: *rs, cols: *cs, x, y, k });
|
||||
if lay.settings.headings {
|
||||
draw_headings(pg, &b, rsi == 0, csi == 0, (ox, oy), (lay.heading_w * k, lay.heading_h * k));
|
||||
}
|
||||
@@ -224,7 +204,6 @@ pub fn render_pdf(wb: &Workbook, layouts: &[SheetLayout], file: &str, path: &str
|
||||
}
|
||||
if lay.settings.headings {
|
||||
let fill = [0xF2, 0xF2, 0xF2];
|
||||
let ox = if sh.right_to_left { lay.page_w - ox - lay.heading_w * k } else { ox };
|
||||
pg.fill_rect(ox, oy, lay.heading_w * k, lay.heading_h * k, fill);
|
||||
pg.rect_stroke(ox, oy, lay.heading_w * k, lay.heading_h * k, 0.3, [0xA0, 0xA0, 0xA0]);
|
||||
}
|
||||
@@ -248,24 +227,18 @@ pub fn render_pdf(wb: &Workbook, layouts: &[SheetLayout], file: &str, path: &str
|
||||
page.link_page(Rect::new(lx, ly, w, h), target_page, Point::new(x, y));
|
||||
}
|
||||
}
|
||||
let pages = doc.page_count();
|
||||
let missing_arabic_font = doc.missing_arabic_font();
|
||||
let bytes = doc.finish().map_err(|error| EngineError::Other(error.to_string()))?;
|
||||
Ok(RenderedPdf { bytes, pages, missing_arabic_font })
|
||||
let n = doc.page_count();
|
||||
(doc.finish(), n)
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------- commands
|
||||
|
||||
fn build_pdf(s: &mut Session, p: &Json, cmd: &str) -> Result<(Vec<u8>, usize)> {
|
||||
fn build_pdf(s: &Session, p: &Json, cmd: &str) -> Result<(Vec<u8>, usize)> {
|
||||
let opts = PrintOptions::from_params(p, cmd)?;
|
||||
let d = s.doc()?;
|
||||
let lays = layouts(&d.wb, &opts);
|
||||
let path = d.path.clone().unwrap_or_default();
|
||||
let pdf = render_pdf(&d.wb, &lays, &d.display_title(), &path)?;
|
||||
if pdf.missing_arabic_font {
|
||||
s.ui_requests.push(crate::UiRequest::Message(MISSING_ARABIC_FONT.into()));
|
||||
}
|
||||
Ok((pdf.bytes, pdf.pages))
|
||||
Ok(render_pdf(&d.wb, &lays, &d.display_title(), &path))
|
||||
}
|
||||
|
||||
pub(crate) fn export_pdf(s: &mut Session, p: &Json) -> Result<Json> {
|
||||
|
||||
@@ -32,9 +32,6 @@ fn cell_look(wb: &Workbook, si: usize, sh: &Sheet, c: CellRef, cf: &mut Option<c
|
||||
};
|
||||
let cfl = cf.as_mut().and_then(|cache| cache.look(wb, si, c));
|
||||
if let Some(st) = cfl.as_ref().and_then(|l| l.style.as_ref()) {
|
||||
if st.align.reading_order.is_some() {
|
||||
style.align.reading_order = st.align.reading_order;
|
||||
}
|
||||
if st.fill.pattern != PatternType::None {
|
||||
style.fill = st.fill;
|
||||
}
|
||||
@@ -175,20 +172,9 @@ pub(super) struct Block<'a> {
|
||||
pub(super) ys: Vec<f32>,
|
||||
pub(super) k: f32,
|
||||
pub(super) scale: f32,
|
||||
pub(super) mirror_axis: f32,
|
||||
}
|
||||
|
||||
impl Block<'_> {
|
||||
fn point_x(&self, x: f32) -> f32 {
|
||||
if self.sh.right_to_left { self.mirror_axis - x } else { x }
|
||||
}
|
||||
pub(super) fn text_x(&self, x: f32, width: f32) -> f32 {
|
||||
if self.sh.right_to_left { self.mirror_axis - x - width } else { x }
|
||||
}
|
||||
pub(super) fn drawn_rect(&self, r: RangeRef) -> (f32, f32, f32, f32) {
|
||||
let (x, y, w, h) = self.rect(r);
|
||||
(self.text_x(x, w), y, w, h)
|
||||
}
|
||||
fn x(&self, col: u32) -> f32 {
|
||||
if col >= self.cols.0 && col <= self.cols.1 + 1 {
|
||||
return self.xs.get((col - self.cols.0) as usize).copied().unwrap_or(0.0);
|
||||
@@ -342,15 +328,15 @@ pub(super) fn draw_block(pg: &mut Page, b: &Block, gridlines: bool, cf: &mut Opt
|
||||
set
|
||||
};
|
||||
pg.save();
|
||||
pg.clip_rect(b.text_x(bx, bw), by, bw, bh);
|
||||
pg.clip_rect(bx, by, bw, bh);
|
||||
if gridlines {
|
||||
let grey = [0xB0, 0xB0, 0xB0];
|
||||
let lw = (0.35 * b.scale).clamp(0.1, 0.5);
|
||||
for x in &b.xs {
|
||||
pg.stroke_line(b.point_x(*x), by, b.point_x(*x), by + bh, lw, grey);
|
||||
pg.stroke_line(*x, by, *x, by + bh, lw, grey);
|
||||
}
|
||||
for y in &b.ys {
|
||||
pg.stroke_line(b.point_x(bx), *y, b.point_x(bx + bw), *y, lw, grey);
|
||||
pg.stroke_line(bx, *y, bx + bw, *y, lw, grey);
|
||||
}
|
||||
}
|
||||
// Cheap pre-filter: blank, unstyled cells outside tables and conditional formats draw nothing.
|
||||
@@ -393,17 +379,17 @@ pub(super) fn draw_block(pg: &mut Page, b: &Block, gridlines: bool, cf: &mut Opt
|
||||
continue;
|
||||
}
|
||||
if let Some(f) = l.fill {
|
||||
pg.fill_rect(b.text_x(x, w), y, w, h, f);
|
||||
pg.fill_rect(x, y, w, h, f);
|
||||
} else if merged && gridlines {
|
||||
pg.fill_rect(b.text_x(x, w), y, w, h, [255, 255, 255]);
|
||||
pg.fill_rect(x, y, w, h, [255, 255, 255]);
|
||||
}
|
||||
if merged && gridlines {
|
||||
pg.rect_stroke(b.text_x(x, w), y, w, h, (0.35 * b.scale).clamp(0.1, 0.5), [0xB0, 0xB0, 0xB0]);
|
||||
pg.rect_stroke(x, y, w, h, (0.35 * b.scale).clamp(0.1, 0.5), [0xB0, 0xB0, 0xB0]);
|
||||
}
|
||||
if let Some((frac, rgb, _)) = l.cf.as_ref().and_then(|cf| cf.bar) {
|
||||
let pad = 1.5 * b.k;
|
||||
let bwid = ((w - 2.0 * pad) * frac.clamp(0.0, 1.0)).max(0.0);
|
||||
pg.fill_rect(b.text_x(x + pad, bwid), y + pad, bwid, (h - 2.0 * pad).max(0.0), rgb);
|
||||
pg.fill_rect(x + pad, y + pad, bwid, (h - 2.0 * pad).max(0.0), rgb);
|
||||
}
|
||||
}
|
||||
// Borders.
|
||||
@@ -420,12 +406,12 @@ pub(super) fn draw_block(pg: &mut Page, b: &Block, gridlines: bool, cf: &mut Opt
|
||||
),
|
||||
None => (bd.right, bd.bottom),
|
||||
};
|
||||
draw_border(pg, &bd.top, b.wb, Point::new(b.point_x(x), y), Point::new(b.point_x(x + w), y), b.k);
|
||||
draw_border(pg, &bottom, b.wb, Point::new(b.point_x(x), y + h), Point::new(b.point_x(x + w), y + h), b.k);
|
||||
draw_border(pg, &bd.left, b.wb, Point::new(b.point_x(x), y), Point::new(b.point_x(x), y + h), b.k);
|
||||
draw_border(pg, &right, b.wb, Point::new(b.point_x(x + w), y), Point::new(b.point_x(x + w), y + h), b.k);
|
||||
draw_border(pg, &bd.diag_down, b.wb, Point::new(b.point_x(x), y), Point::new(b.point_x(x + w), y + h), b.k);
|
||||
draw_border(pg, &bd.diag_up, b.wb, Point::new(b.point_x(x), y + h), Point::new(b.point_x(x + w), y), b.k);
|
||||
draw_border(pg, &bd.top, b.wb, Point::new(x, y), Point::new(x + w, y), b.k);
|
||||
draw_border(pg, &bottom, b.wb, Point::new(x, y + h), Point::new(x + w, y + h), b.k);
|
||||
draw_border(pg, &bd.left, b.wb, Point::new(x, y), Point::new(x, y + h), b.k);
|
||||
draw_border(pg, &right, b.wb, Point::new(x + w, y), Point::new(x + w, y + h), b.k);
|
||||
draw_border(pg, &bd.diag_down, b.wb, Point::new(x, y), Point::new(x + w, y + h), b.k);
|
||||
draw_border(pg, &bd.diag_up, b.wb, Point::new(x, y + h), Point::new(x + w, y), b.k);
|
||||
}
|
||||
// Text.
|
||||
for (c, l) in &looks {
|
||||
@@ -434,9 +420,9 @@ pub(super) fn draw_block(pg: &mut Page, b: &Block, gridlines: bool, cf: &mut Opt
|
||||
continue;
|
||||
}
|
||||
if let Some(picture) = sh.cell_pictures.get(c) {
|
||||
draw_cell_picture(pg, &picture.data, (b.text_x(x, w), y, w, h), b.k);
|
||||
draw_cell_picture(pg, &picture.data, (x, y, w, h), b.k);
|
||||
} else if let Some(on) = checkbox_state(l, &sh.value(*c)) {
|
||||
draw_checkbox(pg, (b.text_x(x, w), y, w, h), b.k, on);
|
||||
draw_checkbox(pg, (x, y, w, h), b.k, on);
|
||||
} else {
|
||||
draw_text(pg, b, TextPlacement { cell: *c, look: l, rect: (x, y, w, h), merged, merges: &merges, limits: (bx, bx + bw) });
|
||||
}
|
||||
@@ -490,8 +476,6 @@ pub(super) struct PrintedBlock {
|
||||
pub(super) x: f32,
|
||||
pub(super) y: f32,
|
||||
pub(super) k: f32,
|
||||
/// The page x that right-to-left sheets are mirrored about; `None` for left-to-right sheets.
|
||||
pub(super) mirror_axis: Option<f32>,
|
||||
}
|
||||
|
||||
/// PDF annotations are not affected by graphics clipping, so intersect each cell with its page
|
||||
@@ -511,7 +495,7 @@ pub(super) fn draw_block_links(pg: &mut Page, b: &Block, page: usize, pending: &
|
||||
if x1 <= x0 || y1 <= y0 {
|
||||
continue;
|
||||
}
|
||||
let rect = (b.text_x(x0, x1 - x0), y0, x1 - x0, y1 - y0);
|
||||
let rect = (x0, y0, x1 - x0, y1 - y0);
|
||||
match crate::links::classify(&link.target) {
|
||||
crate::links::LinkKind::External(uri) => pg.link_uri(rect.0, rect.1, rect.2, rect.3, &uri),
|
||||
crate::links::LinkKind::Internal(target) if !link.external => {
|
||||
@@ -530,10 +514,6 @@ pub(super) fn printed_target(wb: &Workbook, blocks: &[PrintedBlock], source_shee
|
||||
let sh = wb.sheet(sheet)?;
|
||||
let block = blocks.iter().find(|b| b.sheet == sheet && (b.rows.0..=b.rows.1).contains(&cell.row) && (b.cols.0..=b.cols.1).contains(&cell.col))?;
|
||||
let x = block.x + (sh.col_left(cell.col) - sh.col_left(block.cols.0)) as f32 * block.k;
|
||||
let x = match block.mirror_axis {
|
||||
Some(axis) => axis - x - (sh.col_left(cell.col.saturating_add(1)) - sh.col_left(cell.col)) as f32 * block.k,
|
||||
None => x,
|
||||
};
|
||||
let y = block.y + (sh.row_top(cell.row) - sh.row_top(block.rows.0)) as f32 * block.k;
|
||||
Some((block.page, x, y))
|
||||
}
|
||||
@@ -550,11 +530,11 @@ pub(super) fn draw_headings(pg: &mut Page, b: &Block, col_heads: bool, row_heads
|
||||
if x1 - x0 <= 0.0 {
|
||||
continue;
|
||||
}
|
||||
pg.fill_rect(b.text_x(x0, x1 - x0), y, x1 - x0, size.1, fill);
|
||||
pg.rect_stroke(b.text_x(x0, x1 - x0), y, x1 - x0, size.1, lw, line);
|
||||
pg.fill_rect(x0, y, x1 - x0, size.1, fill);
|
||||
pg.rect_stroke(x0, y, x1 - x0, size.1, lw, line);
|
||||
let t = gridcraft_core::col_to_letters(col);
|
||||
let tw = gridcraft_pdf::text_width(Font::Helvetica, fsize, &t);
|
||||
pg.text(b.text_x(x0 + (x1 - x0 - tw) / 2.0, tw), y + size.1 / 2.0 + fsize * 0.35, fsize, Font::Helvetica, [0x40, 0x40, 0x40], &t);
|
||||
pg.text(x0 + (x1 - x0 - tw) / 2.0, y + size.1 / 2.0 + fsize * 0.35, fsize, Font::Helvetica, [0x40, 0x40, 0x40], &t);
|
||||
}
|
||||
}
|
||||
if row_heads {
|
||||
@@ -564,11 +544,11 @@ pub(super) fn draw_headings(pg: &mut Page, b: &Block, col_heads: bool, row_heads
|
||||
if y1 - y0 <= 0.0 {
|
||||
continue;
|
||||
}
|
||||
pg.fill_rect(b.text_x(x, size.0), y0, size.0, y1 - y0, fill);
|
||||
pg.rect_stroke(b.text_x(x, size.0), y0, size.0, y1 - y0, lw, line);
|
||||
pg.fill_rect(x, y0, size.0, y1 - y0, fill);
|
||||
pg.rect_stroke(x, y0, size.0, y1 - y0, lw, line);
|
||||
let t = (row + 1).to_string();
|
||||
let tw = gridcraft_pdf::text_width(Font::Helvetica, fsize, &t);
|
||||
pg.text(b.text_x(x + (size.0 - tw) / 2.0, tw), y0 + (y1 - y0) / 2.0 + fsize * 0.35, fsize, Font::Helvetica, [0x40, 0x40, 0x40], &t);
|
||||
pg.text(x + (size.0 - tw) / 2.0, y0 + (y1 - y0) / 2.0 + fsize * 0.35, fsize, Font::Helvetica, [0x40, 0x40, 0x40], &t);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -599,7 +579,7 @@ pub(super) fn make_block<'a>(
|
||||
acc += sh.row_height(r) * k;
|
||||
ys.push(acc);
|
||||
}
|
||||
Block { wb, si, sh, rows, cols, xs, ys, k, scale: lay.scale, mirror_axis: lay.page_w }
|
||||
Block { wb, si, sh, rows, cols, xs, ys, k, scale: lay.scale }
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
use super::draw::{Block, PdfMeasure, Xf, draw_prims, rgb_of};
|
||||
use super::text::wrap_lines;
|
||||
use super::{Anchor, Font, Page, Point, RangeRef, Rect, ShapeKind, Sheet, TextDirection, Value, Workbook};
|
||||
use super::{Anchor, Font, Page, RangeRef, Rect, ShapeKind, Sheet, Value, Workbook};
|
||||
|
||||
/// Cell pictures fit the current cell (or merged-cell) rectangle without changing aspect ratio.
|
||||
pub(super) fn draw_cell_picture(pg: &mut Page, data: &[u8], rect: (f32, f32, f32, f32), k: f32) {
|
||||
@@ -76,11 +76,9 @@ pub(super) fn draw_objects(pg: &mut Page, wb: &Workbook, si: usize, sh: &Sheet,
|
||||
let (bx, by) = (b.xs.first().copied().unwrap_or(0.0), b.ys.first().copied().unwrap_or(0.0));
|
||||
let (bw, bh) = (b.xs.last().copied().unwrap_or(bx) - bx, b.ys.last().copied().unwrap_or(by) - by);
|
||||
let visible = |r: (f64, f64, f64, f64)| r.2 > 0.0 && r.3 > 0.0 && r.0 < sx1 && r.0 + r.2 > sx0 && r.1 < sy1 && r.1 + r.3 > sy0;
|
||||
let place = |r: (f64, f64, f64, f64)| {
|
||||
(b.text_x(bx + ((r.0 - sx0) as f32) * b.k, r.2 as f32 * b.k), by + ((r.1 - sy0) as f32) * b.k, r.2 as f32 * b.k, r.3 as f32 * b.k)
|
||||
};
|
||||
let place = |r: (f64, f64, f64, f64)| (bx + ((r.0 - sx0) as f32) * b.k, by + ((r.1 - sy0) as f32) * b.k, r.2 as f32 * b.k, r.3 as f32 * b.k);
|
||||
pg.save();
|
||||
pg.clip_rect(b.text_x(bx, bw), by, bw, bh);
|
||||
pg.clip_rect(bx, by, bw, bh);
|
||||
draw_sparklines(pg, wb, si, sh, b, block);
|
||||
for (imi, im) in sh.images.iter().enumerate() {
|
||||
let r = anchor_rect(sh, &im.anchor);
|
||||
@@ -155,19 +153,9 @@ fn draw_sparklines(pg: &mut Page, wb: &Workbook, si: usize, sh: &Sheet, b: &Bloc
|
||||
v => vec![v.as_f64()],
|
||||
};
|
||||
let color = rgb_of(sp.color, wb).unwrap_or([0x15, 0x60, 0x82]);
|
||||
let (x, y, w, h) = b.drawn_rect(RangeRef::cell(sp.cell));
|
||||
let (x, y, w, h) = b.rect(RangeRef::cell(sp.cell));
|
||||
let (wpx, hpx) = (w / b.k, h / b.k);
|
||||
let mut prims = gridcraft_chart::render_sparkline(sp.kind, &vals, [color[0], color[1], color[2], 255], sp.markers, wpx, hpx);
|
||||
if sh.right_to_left {
|
||||
for prim in &mut prims {
|
||||
match prim {
|
||||
gridcraft_chart::Prim::Rect { x, w, .. } => *x = wpx - *x - *w,
|
||||
gridcraft_chart::Prim::Line { pts, .. } => pts.iter_mut().for_each(|p| p[0] = wpx - p[0]),
|
||||
gridcraft_chart::Prim::Circle { cx, .. } => *cx = wpx - *cx,
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
}
|
||||
let prims = gridcraft_chart::render_sparkline(sp.kind, &vals, [color[0], color[1], color[2], 255], sp.markers, wpx, hpx);
|
||||
draw_prims(pg, &prims, Xf { ox: x, oy: y, k: b.k });
|
||||
}
|
||||
}
|
||||
@@ -211,7 +199,7 @@ fn draw_shape(pg: &mut Page, wb: &Workbook, shp: &gridcraft_model::Shape, b: &Bl
|
||||
let color = fm.text_color.and_then(|c| rgb_of(c, wb)).unwrap_or([0, 0, 0]);
|
||||
let align = fm.align.unwrap_or(if text_box { ShapeTextAlign::Left } else { ShapeTextAlign::Center });
|
||||
let anchor = fm.anchor.unwrap_or(if text_box { ShapeTextAnchor::Top } else { ShapeTextAnchor::Middle });
|
||||
let lines = wrap_lines(&shp.text, font, size, (w - 4.0 * b.k).max(size), TextDirection::Auto);
|
||||
let lines = wrap_lines(&shp.text, font, size, (w - 4.0 * b.k).max(size));
|
||||
let block_h = lines.len().min(500) as f32 * size * 1.2;
|
||||
let mut yy = match anchor {
|
||||
ShapeTextAnchor::Top => y + 2.0 * b.k,
|
||||
@@ -219,7 +207,7 @@ fn draw_shape(pg: &mut Page, wb: &Workbook, shp: &gridcraft_model::Shape, b: &Bl
|
||||
ShapeTextAnchor::Bottom => y + h - 2.0 * b.k - block_h,
|
||||
} + size * 0.8;
|
||||
for l in lines.iter().take(500) {
|
||||
let lw = gridcraft_pdf::text_width_with_direction(font, size, &l.text, l.direction);
|
||||
let lw = gridcraft_pdf::text_width(font, size, l);
|
||||
let lx = match align {
|
||||
ShapeTextAlign::Left => x + 2.0 * b.k,
|
||||
ShapeTextAlign::Center => x + (w - lw) / 2.0,
|
||||
@@ -228,7 +216,7 @@ fn draw_shape(pg: &mut Page, wb: &Workbook, shp: &gridcraft_model::Shape, b: &Bl
|
||||
// WordArt's drop shadow: the line again, offset, in the shadow colour (under the text).
|
||||
if let Some(sc) = fm.text_shadow.and_then(|c| rgb_of(c, wb)) {
|
||||
let off = (size * 0.06).max(0.5);
|
||||
pg.text_with_direction(Point::new(lx + off, yy + off), size, font, sc, &l.text, l.direction);
|
||||
pg.text(lx + off, yy + off, size, font, sc, l);
|
||||
}
|
||||
// WordArt's text outline, as on screen: the line in the outline colour, offset in eight
|
||||
// directions by half the outline width, under the filled text.
|
||||
@@ -237,10 +225,10 @@ fn draw_shape(pg: &mut Page, wb: &Workbook, shp: &gridcraft_model::Shape, b: &Bl
|
||||
{
|
||||
let d = (ow * b.scale / 2.0).clamp(0.25, 20.0);
|
||||
for (dx, dy) in [(-1.0, -1.0), (0.0, -1.0), (1.0, -1.0), (-1.0, 0.0), (1.0, 0.0), (-1.0, 1.0), (0.0, 1.0), (1.0, 1.0)] {
|
||||
pg.text_with_direction(Point::new(lx + dx * d, yy + dy * d), size, font, oc, &l.text, l.direction);
|
||||
pg.text(lx + dx * d, yy + dy * d, size, font, oc, l);
|
||||
}
|
||||
}
|
||||
pg.text_with_direction(Point::new(lx, yy), size, font, color, &l.text, l.direction);
|
||||
pg.text(lx, yy, size, font, color, l);
|
||||
yy += size * 1.2;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
use gridcraft_model::{Sparkline, SparklineKind};
|
||||
use serde_json::json;
|
||||
|
||||
use super::*;
|
||||
@@ -16,35 +15,6 @@ fn pdf_of(s: &mut Session, p: Json) -> (Vec<u8>, u64) {
|
||||
fn contains(hay: &[u8], needle: &str) -> bool {
|
||||
hay.windows(needle.len()).any(|w| w == needle.as_bytes())
|
||||
}
|
||||
fn arabic_face_available() -> bool {
|
||||
let mut doc = gridcraft_pdf::PdfDoc::new();
|
||||
doc.add_page(100.0, 100.0).text(0.0, 50.0, 10.0, Font::Helvetica, [0, 0, 0], "مرحبا");
|
||||
!doc.missing_arabic_font()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn right_to_left_sheets_mirror_link_rectangles_and_targets() {
|
||||
fn numbers_after(pdf: &[u8], key: &str, n: usize) -> Vec<f32> {
|
||||
let text = String::from_utf8_lossy(pdf);
|
||||
let at = text.find(key).unwrap() + key.len();
|
||||
text[at..].split([' ', ']']).filter_map(|t| t.parse().ok()).take(n).collect()
|
||||
}
|
||||
let mut s = s();
|
||||
s.execute("insert.link", json!({"cell": "A1", "target": "https://example.org/report"})).unwrap();
|
||||
s.execute("insert.link", json!({"cell": "A2", "target": "Sheet1!B60"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "B60", "input": "Destination"})).unwrap();
|
||||
let (ltr, _) = pdf_of(&mut s, json!({}));
|
||||
s.execute("view.rightToLeft", json!({"on": true})).unwrap();
|
||||
let (rtl, _) = pdf_of(&mut s, json!({}));
|
||||
let axis = numbers_after(<r, "/MediaBox [", 4)[2];
|
||||
let (l, r) = (numbers_after(<r, "/Rect [", 4), numbers_after(&rtl, "/Rect [", 4));
|
||||
assert!((r[0] - (axis - l[2])).abs() < 0.01 && (r[2] - (axis - l[0])).abs() < 0.01, "{l:?} mirrors to {r:?}");
|
||||
assert_eq!(r[1], l[1]);
|
||||
let b_width = s.doc().unwrap().wb.active().unwrap().col_width(1);
|
||||
let (lx, rx) = (numbers_after(<r, "/XYZ ", 1)[0], numbers_after(&rtl, "/XYZ ", 1)[0]);
|
||||
let k = (l[2] - l[0]) / s.doc().unwrap().wb.active().unwrap().col_width(0);
|
||||
assert!((rx - (axis - lx - b_width * k)).abs() < 0.01, "target {lx} mirrors to {rx}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chart_data_table_prints_formatted_values_and_follows_recalculation() {
|
||||
@@ -88,199 +58,6 @@ fn pdf_export_keeps_safe_links_on_their_printed_pages() {
|
||||
assert!(!cropped.contains("/Dest ["));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_with_characters_its_font_lacks_still_exports() {
|
||||
let mut s = s();
|
||||
s.execute("cell.set", json!({"cell": "A1", "input": "مرحبا 😀"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "A2", "input": "مرحبا Привет"})).unwrap();
|
||||
let out = s.execute("file.exportPdf", json!({})).unwrap();
|
||||
assert_eq!(out["pages"], 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn wrapping_keeps_combining_marks_with_their_letters() {
|
||||
let word = "a\u{301}a\u{301}a\u{301}a\u{301}";
|
||||
let lines = wrap_lines(word, Font::Helvetica, 10.0, 7.0, TextDirection::Auto);
|
||||
assert_eq!(lines.iter().map(|line| line.text.as_str()).collect::<String>(), word);
|
||||
assert!(lines.iter().all(|line| line.text == "a\u{301}"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_cells_headers_and_charts_export_searchable_shaped_text() {
|
||||
if !arabic_face_available() && std::env::var_os("CRAFT_FONTS_REQUIRED").is_none() {
|
||||
return;
|
||||
}
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["مَرْحَبًا 123 (ABC)", "القيمة"], ["تفاح", 3], ["كمثرى", 5], ["العَرَبِيَّة العَرَبِيَّة العَرَبِيَّة العَرَبِيَّة العَرَبِيَّة", null], ["تقرير ١٢٣ (ABC)", null], ["مرحبا", null]]})).unwrap();
|
||||
s.execute("home.columnWidth", json!({"cols": "A:B", "chars": 32})).unwrap();
|
||||
s.execute("home.rowHeight", json!({"rows": "1:6", "height": 50})).unwrap();
|
||||
s.execute("home.fontSize", json!({"range": "A1:B6", "size": 20})).unwrap();
|
||||
s.execute("home.rowHeight", json!({"rows": "4:4", "height": 90})).unwrap();
|
||||
s.execute("home.bold", json!({"range": "A2"})).unwrap();
|
||||
s.execute("home.italic", json!({"range": "A3"})).unwrap();
|
||||
s.execute("home.wrapText", json!({"range": "A4"})).unwrap();
|
||||
s.execute("home.orientation", json!({"range": "A6", "angle": 30})).unwrap();
|
||||
s.execute("pageLayout.pageSetup", json!({"header": "&Cتقرير المبيعات 2026", "gridlines": true})).unwrap();
|
||||
s.execute("insert.chart", json!({"range": "A1:B3", "type": "column"})).unwrap();
|
||||
{
|
||||
let d = s.doc_mut().unwrap();
|
||||
let wb = std::sync::Arc::make_mut(&mut d.wb);
|
||||
for chart in &mut wb.sheet_mut(0).unwrap().charts {
|
||||
chart.anchor.cell = CellRef::new(8, 0);
|
||||
chart.anchor.width = 500.0;
|
||||
chart.anchor.height = 280.0;
|
||||
}
|
||||
}
|
||||
let (pdf, pages) = pdf_of(&mut s, json!({"fitToPage": true}));
|
||||
assert_eq!(pages, 1);
|
||||
assert!(contains(&pdf, "/Subtype /Type3"));
|
||||
for text in ["مَرْحَبًا 123 (ABC)", "تقرير المبيعات 2026", "القيمة", "تفاح", "كمثرى"] {
|
||||
let utf16 = text.encode_utf16().map(|unit| format!("{unit:04X}")).collect::<String>();
|
||||
assert!(contains(&pdf, &format!("/ActualText <FEFF{utf16}>")), "missing text {text}");
|
||||
}
|
||||
let lines = wrap_lines("العَرَبِيَّةالعَرَبِيَّة", Font::Helvetica, 20.0, 40.0, TextDirection::Auto);
|
||||
assert_eq!(lines.iter().map(|line| line.text.as_str()).collect::<String>(), "العَرَبِيَّةالعَرَبِيَّة");
|
||||
assert!(lines.iter().all(|line| !line.text.starts_with(['َ', 'ِ', 'ُ', 'ّ', 'ْ'])));
|
||||
assert!(lines.iter().all(|line| gridcraft_pdf::text_width_with_direction(Font::Helvetica, 20.0, &line.text, line.direction) <= 40.0));
|
||||
let path = std::env::temp_dir().join(format!("gridcraft-arabic-export-{}.pdf", std::process::id()));
|
||||
std::fs::write(&path, &pdf).unwrap();
|
||||
eprintln!("Arabic PDF artifact: {}", path.display());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_reading_order_export_artifact() {
|
||||
if !arabic_face_available() && std::env::var_os("CRAFT_FONTS_REQUIRED").is_none() {
|
||||
return;
|
||||
}
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["Context", "LeftToRight", "RightToLeft"], ["مرحبا ABC !", "مرحبا ABC !", "مرحبا ABC !"], ["123 مرحبا ABC", "123 مرحبا ABC", "123 مرحبا ABC"], ["(مرحبا) ABC", "(مرحبا) ABC", "(مرحبا) ABC"], ["مرحبا ABC ! DEF ? مرحبا", "مرحبا ABC ! DEF ? مرحبا", "مرحبا ABC ! DEF ? مرحبا"]]})).unwrap();
|
||||
s.execute("home.columnWidth", json!({"cols": "A:C", "chars": 24})).unwrap();
|
||||
s.execute("home.rowHeight", json!({"rows": "1:5", "height": 60})).unwrap();
|
||||
s.execute("home.fontSize", json!({"range": "A2:C5", "size": 18})).unwrap();
|
||||
for (range, order) in [("A2:A5", "Context"), ("B2:B5", "LeftToRight"), ("C2:C5", "RightToLeft")] {
|
||||
s.execute("home.formatCells", json!({"range": range, "style": {"align": {"reading_order": order}}})).unwrap();
|
||||
}
|
||||
s.execute("home.wrapText", json!({"range": "A5:C5"})).unwrap();
|
||||
s.execute("pageLayout.pageSetup", json!({"gridlines": true, "header": "&CArabic cell reading order"})).unwrap();
|
||||
let (pdf, _) = pdf_of(&mut s, json!({}));
|
||||
for text in ["مرحبا ABC !", "123 مرحبا ABC", "(مرحبا) ABC"] {
|
||||
let utf16 = text.encode_utf16().map(|unit| format!("{unit:04X}")).collect::<String>();
|
||||
assert!(contains(&pdf, &format!("/ActualText <FEFF{utf16}>")));
|
||||
}
|
||||
let path = std::env::temp_dir().join(format!("gridcraft-arabic-reading-order-{}.pdf", std::process::id()));
|
||||
std::fs::write(&path, &pdf).unwrap();
|
||||
eprintln!("Arabic reading-order PDF artifact: {}", path.display());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn wrapped_lines_keep_the_paragraph_direction() {
|
||||
let lines = wrap_lines("مرحبا ABC ! DEF ?\nLatin مرحبا !", Font::Helvetica, 10.0, 30.0, TextDirection::Auto);
|
||||
let split = lines.iter().position(|l| l.text.starts_with("Latin")).unwrap();
|
||||
assert!(split > 0);
|
||||
assert!(lines[..split].iter().all(|l| l.direction == TextDirection::RightToLeft));
|
||||
assert!(lines[split..].iter().all(|l| l.direction == TextDirection::LeftToRight));
|
||||
let lines = wrap_lines("123 مرحبا ABC !", Font::Helvetica, 10.0, 30.0, TextDirection::Context.resolve("123 مرحبا ABC !"));
|
||||
assert!(lines.iter().all(|l| l.direction == TextDirection::LeftToRight));
|
||||
}
|
||||
|
||||
fn exported_text_x(pdf: &[u8], text: &str) -> f32 {
|
||||
let pdf = String::from_utf8_lossy(pdf);
|
||||
let marker = format!("({text}) Tj");
|
||||
let before = &pdf[..pdf.find(&marker).unwrap()];
|
||||
let matrix = before.lines().rev().find(|line| line.ends_with(" Tm")).unwrap();
|
||||
matrix.split_whitespace().nth(4).unwrap().parse().unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cell_reading_order_and_conditional_context_reach_pdf() {
|
||||
let mut s = s();
|
||||
s.execute("cell.set", json!({"cell": "A1", "input": "ABC !"})).unwrap();
|
||||
s.execute("home.formatCells", json!({"range": "A1", "style": {"align": {"reading_order": "RightToLeft"}}})).unwrap();
|
||||
let (rtl, _) = pdf_of(&mut s, json!({}));
|
||||
assert!(contains(&rtl, "(! ABC) Tj"));
|
||||
assert!(!contains(&rtl, "/Subtype /Type3"));
|
||||
s.execute("home.conditionalFormat", json!({"range": "A1", "rule": {"type": "noBlanks", "style": {"align": {"reading_order": "Context"}}}}))
|
||||
.unwrap();
|
||||
let (context, _) = pdf_of(&mut s, json!({}));
|
||||
assert!(contains(&context, "(ABC !) Tj"));
|
||||
assert!(!contains(&context, "(! ABC) Tj"));
|
||||
assert!(exported_text_x(&rtl, "! ABC") > exported_text_x(&context, "ABC !"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rtl_sheet_sparkline_reflects_with_cell_geometry() {
|
||||
let mut wb = Workbook::new();
|
||||
let sh = wb.sheet_mut(0).unwrap();
|
||||
sh.set_value(CellRef::new(0, 0), Value::Number(1.0));
|
||||
sh.set_value(CellRef::new(1, 0), Value::Number(3.0));
|
||||
sh.sparklines.push(Sparkline {
|
||||
cell: CellRef::new(0, 1),
|
||||
source: "A1:A2".into(),
|
||||
kind: SparklineKind::Line,
|
||||
color: Color::rgb(255, 0, 0),
|
||||
markers: false,
|
||||
});
|
||||
let options = PrintOptions { range: RangeRef::parse("A1:B2"), ..PrintOptions::default() };
|
||||
let ltr = render_pdf(&wb, &layouts(&wb, &options), "", "").unwrap().bytes;
|
||||
wb.sheet_mut(0).unwrap().right_to_left = true;
|
||||
let rtl = render_pdf(&wb, &layouts(&wb, &options), "", "").unwrap().bytes;
|
||||
let points = |pdf: &[u8]| {
|
||||
let pdf = String::from_utf8_lossy(pdf);
|
||||
let after = pdf.split("1 0 0 RG\n").nth(1).unwrap();
|
||||
let line = after.lines().find(|line| line.ends_with(" l S")).unwrap();
|
||||
let values: Vec<_> = line.split_whitespace().collect();
|
||||
(values[0].parse::<f32>().unwrap(), values[3].parse::<f32>().unwrap())
|
||||
};
|
||||
let (left0, left1) = points(<r);
|
||||
let (right0, right1) = points(&rtl);
|
||||
assert!(left0 < left1 && right0 > right1);
|
||||
assert!((left0 + right0 - 612.0).abs() < 0.001);
|
||||
assert!((left1 + right1 - 612.0).abs() < 0.001);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn explicit_left_and_right_keep_their_side_on_a_right_to_left_sheet() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["LEFT"], ["RIGHT"]]})).unwrap();
|
||||
s.execute("home.alignLeft", json!({"range": "A1"})).unwrap();
|
||||
s.execute("home.alignRight", json!({"range": "A2"})).unwrap();
|
||||
let (ltr, _) = pdf_of(&mut s, json!({}));
|
||||
s.execute("view.rightToLeft", json!({"on": true})).unwrap();
|
||||
let (rtl, _) = pdf_of(&mut s, json!({}));
|
||||
let width = |label| gridcraft_pdf::text_width(Font::Helvetica, 11.0, label);
|
||||
let (left, right) = (width("LEFT"), width("RIGHT"));
|
||||
let ltr_gap = exported_text_x(<r, "RIGHT") + right - exported_text_x(<r, "LEFT");
|
||||
let rtl_gap = exported_text_x(&rtl, "RIGHT") + right - exported_text_x(&rtl, "LEFT");
|
||||
assert!((ltr_gap - rtl_gap).abs() < 0.01, "Left stays left of Right in the cell: {ltr_gap}, {rtl_gap}");
|
||||
assert!(exported_text_x(&rtl, "LEFT") + left < exported_text_x(&rtl, "RIGHT") + right);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rtl_sheet_pdf_mirrors_cells_merges_headings_and_object_anchors() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["FIRST", "SECOND"], [null, "MERGED"]]})).unwrap();
|
||||
s.execute("home.mergeCenter", json!({"range": "B2:C2"})).unwrap();
|
||||
s.execute("pageLayout.pageSetup", json!({"printArea": "A1:D5", "headings": true, "gridlines": true, "left": 0.8, "right": 0.4})).unwrap();
|
||||
s.execute("insert.shape", json!({"kind": "rectangle", "at": "B4", "width": 128, "height": 30, "text": "OBJECT"})).unwrap();
|
||||
let (ltr, _) = pdf_of(&mut s, json!({}));
|
||||
s.execute("view.rightToLeft", json!({"on": true})).unwrap();
|
||||
let (rtl, _) = pdf_of(&mut s, json!({}));
|
||||
for label in ["FIRST", "SECOND", "MERGED", "A", "B", "C", "D", "1", "2", "OBJECT"] {
|
||||
let left = exported_text_x(<r, label);
|
||||
let right = exported_text_x(&rtl, label);
|
||||
let font_size = if ["A", "B", "C", "D", "1", "2"].contains(&label) { 9.0 } else { 11.0 };
|
||||
let width = gridcraft_pdf::text_width(Font::Helvetica, font_size, label);
|
||||
assert!((left + right + width - 612.0).abs() < 0.01, "{label}: {left}, {right}, {width}");
|
||||
}
|
||||
assert!(exported_text_x(<r, "FIRST") < exported_text_x(<r, "SECOND"));
|
||||
assert!(exported_text_x(&rtl, "FIRST") > exported_text_x(&rtl, "SECOND"));
|
||||
for (name, pdf) in [("ltr", ltr), ("rtl", rtl)] {
|
||||
let path = std::env::temp_dir().join(format!("gridcraft-print-direction-{name}-{}.pdf", std::process::id()));
|
||||
std::fs::write(&path, pdf).unwrap();
|
||||
eprintln!("Print direction PDF artifact: {}", path.display());
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn header_sections_split_join_and_field_names() {
|
||||
let spec = "&L&\"Arial,Bold\"Sales &&Co&CPage &P of &N&R&D";
|
||||
@@ -917,32 +694,11 @@ fn bands_unit() {
|
||||
let b = bands(0, 2, |r| if r == 1 { 100.0 } else { 10.0 }, |_| 35.0, &[], 100);
|
||||
assert_eq!(b, vec![(0, 0), (1, 1), (2, 2)]);
|
||||
assert_eq!(bands(0, 1_000_000, |_| 10.0, |_| 5.0, &[], 3).len(), 3);
|
||||
let w = wrap_lines("the quick brown fox jumps", Font::Helvetica, 10.0, 50.0, TextDirection::Auto);
|
||||
let w = wrap_lines("the quick brown fox jumps", Font::Helvetica, 10.0, 50.0);
|
||||
assert!(w.len() >= 2);
|
||||
assert!(w.iter().all(|l| gridcraft_pdf::text_width_with_direction(Font::Helvetica, 10.0, &l.text, l.direction) <= 50.0 || !l.text.contains(' ')));
|
||||
let w = wrap_lines("Supercalifragilistic", Font::Helvetica, 10.0, 20.0, TextDirection::Auto);
|
||||
assert!(w.iter().all(|l| gridcraft_pdf::text_width(Font::Helvetica, 10.0, l) <= 50.0 || !l.contains(' ')));
|
||||
let w = wrap_lines("Supercalifragilistic", Font::Helvetica, 10.0, 20.0);
|
||||
assert!(w.len() > 2);
|
||||
let long = "abcdefghij".repeat(300);
|
||||
let w = wrap_lines(&long, Font::Helvetica, 10.0, 50.0, TextDirection::Auto);
|
||||
assert_eq!(w.iter().map(|l| l.text.as_str()).collect::<String>(), long);
|
||||
assert!(w.iter().all(|l| gridcraft_pdf::text_width_with_direction(Font::Helvetica, 10.0, &l.text, l.direction) <= 50.0));
|
||||
let mut at = 0;
|
||||
for l in &w[..w.len() - 1] {
|
||||
let one_more = &long[at..at + l.text.len() + 1];
|
||||
assert!(gridcraft_pdf::text_width_with_direction(Font::Helvetica, 10.0, one_more, l.direction) > 50.0, "each split is as long as fits");
|
||||
at += l.text.len();
|
||||
}
|
||||
}
|
||||
|
||||
fn wrapped_text(text: &str, font: Font, size: f32, width: f32) -> Vec<String> {
|
||||
wrap_lines(text, font, size, width, TextDirection::Auto).into_iter().map(|line| line.text).collect()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn wrapping_ignores_the_width_of_undrawn_bidi_marks() {
|
||||
let word = "i\u{200e}".repeat(20);
|
||||
assert!(gridcraft_pdf::text_width(Font::Helvetica, 10.0, &word) <= 50.0);
|
||||
assert_eq!(wrapped_text(&word, Font::Helvetica, 10.0, 50.0), vec![word.clone()]);
|
||||
}
|
||||
|
||||
/// The wrapper `wrap_lines` replaced, re-measuring strings, as the reference for its lines.
|
||||
@@ -999,11 +755,7 @@ fn wrap_lines_matches_the_remeasuring_wrapper() {
|
||||
for text in texts {
|
||||
for font in [Font::Helvetica, Font::HelveticaBold, Font::Courier] {
|
||||
for (size, width) in [(10.0, 50.0), (10.0, 20.0), (11.0, 1.0), (8.0, 300.0), (12.0, 0.0)] {
|
||||
assert_eq!(
|
||||
wrapped_text(text, font, size, width),
|
||||
wrap_lines_remeasuring(text, font, size, width),
|
||||
"{text:?} {font:?} {size} {width}"
|
||||
);
|
||||
assert_eq!(wrap_lines(text, font, size, width), wrap_lines_remeasuring(text, font, size, width), "{text:?} {font:?} {size} {width}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1014,24 +766,12 @@ fn wrapping_a_long_word_in_a_narrow_box_stops_at_the_line_limit() {
|
||||
// One character per line: the old wrapper re-measured and copied the rest of the word for
|
||||
// each of the 100,000 lines before checking the limit.
|
||||
let word = "w".repeat(100_000);
|
||||
let lines = wrapped_text(&word, Font::Helvetica, 10.0, 1.0);
|
||||
let lines = wrap_lines(&word, Font::Helvetica, 10.0, 1.0);
|
||||
assert!(lines.len() <= 2002, "{}", lines.len());
|
||||
assert!(lines.iter().all(|l| l == "w"));
|
||||
// A long paragraph in a very wide box is one line.
|
||||
let para = vec!["word"; 50_000].join(" ");
|
||||
assert_eq!(wrapped_text(¶, Font::Helvetica, 10.0, 1.0e9), vec![para.clone()]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn wrapping_a_long_arabic_word_measures_pieces_not_the_rest_of_the_word() {
|
||||
let word = "مرحبا".repeat(10_000);
|
||||
if !arabic_face_available() {
|
||||
return;
|
||||
}
|
||||
let lines = wrapped_text(&word, Font::Helvetica, 10.0, 20.0);
|
||||
assert!(lines.len() > 2000 && lines.len() <= 2002, "{}", lines.len());
|
||||
assert!(lines.iter().take(2000).all(|line| gridcraft_pdf::text_width(Font::Helvetica, 10.0, line) <= 20.0));
|
||||
assert!(word.starts_with(&lines.concat()));
|
||||
assert_eq!(wrap_lines(¶, Font::Helvetica, 10.0, 1.0e9), vec![para.clone()]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -1,176 +1,78 @@
|
||||
use super::draw::{Block, Look, rgb_of};
|
||||
use super::{
|
||||
Baseline, CellRef, Color, Font, HAlign, MAX_COLS, Page, Point, RangeRef, ReadingOrder, Sheet, Style, StyleTable, TextDirection, Underline,
|
||||
VAlign, Value,
|
||||
};
|
||||
use unicode_segmentation::UnicodeSegmentation;
|
||||
use super::{CellRef, Color, Font, HAlign, MAX_COLS, Page, Point, RangeRef, Sheet, Style, StyleTable, Underline, VAlign, Value};
|
||||
|
||||
const PAD_PX: f32 = 2.0;
|
||||
|
||||
/// Most lines [`wrap_lines`] returns (it may return one more, the rest of a paragraph).
|
||||
const MAX_WRAP_LINES: usize = 2000;
|
||||
|
||||
pub(super) struct TextLine {
|
||||
pub(super) text: String,
|
||||
pub(super) direction: TextDirection,
|
||||
}
|
||||
|
||||
/// Word-wraps `text` to `width` points, keeping each paragraph's base direction on every
|
||||
/// continuation line.
|
||||
/// Word-wraps `text` to `width` points.
|
||||
///
|
||||
/// Widths are kept as running sums of glyph widths (the sum `text_width` makes), so each
|
||||
/// character is measured once: re-measuring the line for every word, or the rest of an
|
||||
/// over-long word for every piece cut from it, made a long paragraph or word quadratic.
|
||||
/// A paragraph whose width is not that sum is measured as drawn by [`wrap_measured_paragraph`].
|
||||
pub(super) fn wrap_lines(text: &str, font: Font, size: f32, width: f32, direction: TextDirection) -> Vec<TextLine> {
|
||||
let mut out = Vec::new();
|
||||
for para in text.split('\n') {
|
||||
let direction = direction.resolve(para);
|
||||
if gridcraft_pdf::width_is_char_sum(font, para, direction) {
|
||||
wrap_summed_paragraph(para, font, size, width, direction, &mut out);
|
||||
} else {
|
||||
let fits = |s: &str| gridcraft_pdf::text_width_with_direction(font, size, s, direction) <= width;
|
||||
wrap_measured_paragraph(para, &fits, direction, &mut out);
|
||||
}
|
||||
if out.len() > MAX_WRAP_LINES {
|
||||
return out;
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
fn wrap_summed_paragraph(para: &str, font: Font, size: f32, width: f32, direction: TextDirection, out: &mut Vec<TextLine>) {
|
||||
pub(super) fn wrap_lines(text: &str, font: Font, size: f32, width: f32) -> Vec<String> {
|
||||
let units_of = |s: &str| -> u64 { s.chars().map(|c| u64::from(font.char_width(c))).sum() };
|
||||
let fits = |units: u64| units as f32 * size / 1000.0 <= width;
|
||||
let space = units_of(" ");
|
||||
let mut line = String::new();
|
||||
let mut line_units: u64 = 0;
|
||||
for word in para.split(' ') {
|
||||
let word_units = units_of(word);
|
||||
if line.is_empty() {
|
||||
line.push_str(word);
|
||||
line_units = word_units;
|
||||
} else if fits(line_units + space + word_units) {
|
||||
line.push(' ');
|
||||
line.push_str(word);
|
||||
line_units += space + word_units;
|
||||
} else {
|
||||
out.push(TextLine { text: std::mem::take(&mut line), direction });
|
||||
line.push_str(word);
|
||||
line_units = word_units;
|
||||
}
|
||||
if !fits(line_units) && line.graphemes(true).nth(1).is_some() {
|
||||
let mut piece = String::new();
|
||||
let mut units: u64 = 0;
|
||||
for g in line.graphemes(true) {
|
||||
let w = units_of(g);
|
||||
if !piece.is_empty() && !fits(units + w) {
|
||||
out.push(TextLine { text: std::mem::take(&mut piece), direction });
|
||||
units = 0;
|
||||
if out.len() > MAX_WRAP_LINES {
|
||||
return;
|
||||
let mut out = Vec::new();
|
||||
for para in text.split('\n') {
|
||||
let mut line = String::new();
|
||||
let mut line_units: u64 = 0;
|
||||
for word in para.split(' ') {
|
||||
let word_units = units_of(word);
|
||||
if line.is_empty() {
|
||||
line.push_str(word);
|
||||
line_units = word_units;
|
||||
} else if fits(line_units + space + word_units) {
|
||||
line.push(' ');
|
||||
line.push_str(word);
|
||||
line_units += space + word_units;
|
||||
} else {
|
||||
out.push(std::mem::take(&mut line));
|
||||
line.push_str(word);
|
||||
line_units = word_units;
|
||||
}
|
||||
// Break a single over-long word by characters: each piece is the longest that fits
|
||||
// (at least one character).
|
||||
if !fits(line_units) && line.chars().nth(1).is_some() {
|
||||
let mut piece = String::new();
|
||||
let mut units: u64 = 0;
|
||||
for c in line.chars() {
|
||||
let w = u64::from(font.char_width(c));
|
||||
if !piece.is_empty() && !fits(units + w) {
|
||||
out.push(std::mem::take(&mut piece));
|
||||
units = 0;
|
||||
if out.len() > MAX_WRAP_LINES {
|
||||
return out;
|
||||
}
|
||||
}
|
||||
piece.push(c);
|
||||
units += w;
|
||||
}
|
||||
piece.push_str(g);
|
||||
units += w;
|
||||
line = piece;
|
||||
line_units = units;
|
||||
}
|
||||
line = piece;
|
||||
line_units = units;
|
||||
}
|
||||
if out.len() > MAX_WRAP_LINES {
|
||||
return;
|
||||
}
|
||||
}
|
||||
out.push(TextLine { text: line, direction });
|
||||
}
|
||||
|
||||
/// One paragraph of [`wrap_lines`] whose width is not a sum of character widths (shaped Arabic,
|
||||
/// right-to-left reordering or bidi controls), measuring each candidate line as drawn.
|
||||
fn wrap_measured_paragraph(para: &str, fits: &impl Fn(&str) -> bool, direction: TextDirection, out: &mut Vec<TextLine>) {
|
||||
let mut line = String::new();
|
||||
for word in para.split(' ') {
|
||||
if !line.is_empty() {
|
||||
let candidate = format!("{line} {word}");
|
||||
if fits(&candidate) {
|
||||
line = candidate;
|
||||
continue;
|
||||
if out.len() > MAX_WRAP_LINES {
|
||||
return out;
|
||||
}
|
||||
out.push(TextLine { text: std::mem::take(&mut line), direction });
|
||||
}
|
||||
line = if fits(word) { word.to_string() } else { break_measured_word(word, fits, direction, out) };
|
||||
if out.len() > MAX_WRAP_LINES {
|
||||
return;
|
||||
}
|
||||
}
|
||||
out.push(TextLine { text: line, direction });
|
||||
}
|
||||
|
||||
/// Cuts `word` into the longest grapheme prefixes that fit (at least one grapheme each), pushes
|
||||
/// all but the last to `out` and returns the last. Each cut gallops from one grapheme, so it
|
||||
/// measures prefixes about as long as the piece rather than the rest of the word.
|
||||
fn break_measured_word(word: &str, fits: &impl Fn(&str) -> bool, direction: TextDirection, out: &mut Vec<TextLine>) -> String {
|
||||
let ends: Vec<usize> = word.grapheme_indices(true).map(|(i, g)| i + g.len()).collect();
|
||||
let (mut start, mut first) = (0, 0);
|
||||
loop {
|
||||
let len = ends.len().saturating_sub(first);
|
||||
let end = |count: usize| ends.get(first + count.saturating_sub(1)).copied().unwrap_or(word.len());
|
||||
let fits_prefix = |count: usize| fits(word.get(start..end(count)).unwrap_or_default());
|
||||
let (mut fit, mut over, mut probe) = (1, len + 1, 2);
|
||||
while fit < len {
|
||||
let count = probe.min(len);
|
||||
if fits_prefix(count) {
|
||||
fit = count;
|
||||
probe = count.saturating_mul(2);
|
||||
} else {
|
||||
over = count;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if fit >= len {
|
||||
return word.get(start..).unwrap_or_default().to_string();
|
||||
}
|
||||
while over - fit > 1 {
|
||||
let mid = fit + (over - fit) / 2;
|
||||
if fits_prefix(mid) {
|
||||
fit = mid;
|
||||
} else {
|
||||
over = mid;
|
||||
}
|
||||
}
|
||||
let cut = end(fit);
|
||||
out.push(TextLine { text: word.get(start..cut).unwrap_or_default().to_string(), direction });
|
||||
start = cut;
|
||||
first += fit;
|
||||
if out.len() > MAX_WRAP_LINES {
|
||||
return word.get(start..).unwrap_or_default().to_string();
|
||||
}
|
||||
out.push(line);
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
fn font_for(style: &Style) -> Font {
|
||||
Font::styled(Font::family_for(&style.font.name), style.font.bold, style.font.italic)
|
||||
}
|
||||
|
||||
fn text_direction(order: ReadingOrder) -> TextDirection {
|
||||
match order {
|
||||
ReadingOrder::Context => TextDirection::Context,
|
||||
ReadingOrder::LeftToRight => TextDirection::LeftToRight,
|
||||
ReadingOrder::RightToLeft => TextDirection::RightToLeft,
|
||||
}
|
||||
}
|
||||
|
||||
/// The alignment a cell is laid out with before a right-to-left sheet is mirrored. Explicit Left
|
||||
/// and Right are swapped there, as in the grid, so they print on the side the user chose.
|
||||
fn text_align(align: HAlign, value: &Value, direction: TextDirection, right_to_left_sheet: bool) -> HAlign {
|
||||
fn text_align(align: HAlign, value: &Value) -> HAlign {
|
||||
match align {
|
||||
HAlign::General => match value {
|
||||
Value::Number(_) => HAlign::Right,
|
||||
Value::Bool(_) | Value::Error(_) => HAlign::Center,
|
||||
_ if direction == TextDirection::RightToLeft && !right_to_left_sheet => HAlign::Right,
|
||||
_ => HAlign::Left,
|
||||
},
|
||||
HAlign::Left if right_to_left_sheet => HAlign::Right,
|
||||
HAlign::Right if right_to_left_sheet => HAlign::Left,
|
||||
HAlign::CenterAcross | HAlign::Distributed => HAlign::Center,
|
||||
HAlign::Justify | HAlign::Fill => HAlign::Left,
|
||||
other => other,
|
||||
@@ -281,46 +183,32 @@ pub(super) fn draw_text(pg: &mut Page, b: &Block, placement: TextPlacement<'_>)
|
||||
if text.is_empty() {
|
||||
return;
|
||||
}
|
||||
let direction = text_direction(st.align.reading_order.unwrap_or_default()).resolve(&text);
|
||||
let mut tw = gridcraft_pdf::text_width_with_direction(font, size, &text, direction);
|
||||
let mut tw = gridcraft_pdf::text_width(font, size, &text);
|
||||
if st.align.shrink && !wrap && tw > avail && tw > 0.0 {
|
||||
size = (size * avail / tw).max(1.0);
|
||||
tw = gridcraft_pdf::text_width_with_direction(font, size, &text, direction);
|
||||
tw = gridcraft_pdf::text_width(font, size, &text);
|
||||
}
|
||||
if is_num && !wrap && tw > avail + 0.01 && !sh.show_formulas {
|
||||
let hash = gridcraft_pdf::text_width(font, size, "#").max(0.1);
|
||||
text = "#".repeat(((avail / hash).floor().max(1.0) as usize).min(255));
|
||||
tw = gridcraft_pdf::text_width_with_direction(font, size, &text, direction);
|
||||
tw = gridcraft_pdf::text_width(font, size, &text);
|
||||
}
|
||||
let h_align = text_align(st.align.h, &v, direction, sh.right_to_left);
|
||||
let h_align = text_align(st.align.h, &v);
|
||||
let rot = st.align.rotation;
|
||||
let rotated = rot != 0 && rot != 255;
|
||||
// Rotated text wraps along its own direction: upright (±90°) text to the row height.
|
||||
let lines: Vec<TextLine> = match (wrap, rotated) {
|
||||
(true, false) => wrap_lines(&text, font, size, avail.max(size), direction),
|
||||
(true, true) if rot.abs() == 90 => wrap_lines(&text, font, size, (h - 2.0 * pad).max(size), direction),
|
||||
(true, true) => vec![TextLine { text: text.lines().next().unwrap_or_default().to_string(), direction }],
|
||||
(false, _) => vec![TextLine { text, direction }],
|
||||
let lines: Vec<String> = match (wrap, rotated) {
|
||||
(true, false) => wrap_lines(&text, font, size, avail.max(size)),
|
||||
(true, true) if rot.abs() == 90 => wrap_lines(&text, font, size, (h - 2.0 * pad).max(size)),
|
||||
(true, true) => vec![text.lines().next().unwrap_or_default().to_string()],
|
||||
(false, _) => vec![text],
|
||||
};
|
||||
let extents = lines
|
||||
.iter()
|
||||
.filter_map(|line| pg.text_vertical_extents_with_direction(font, size, &line.text, line.direction))
|
||||
.reduce(|a, b| (a.0.max(b.0), a.1.max(b.1)))
|
||||
.map(|(ascent, descent)| (ascent.max(size * 0.8), descent.max(size * 0.22)));
|
||||
let line_h = extents.map_or(size * 1.2, |(ascent, descent)| (ascent + descent + size * 0.2).max(size * 1.2));
|
||||
let line_h = size * 1.2;
|
||||
let n = lines.len().max(1) as f32;
|
||||
let first_baseline = if let Some((ascent, descent)) = extents {
|
||||
match st.align.v {
|
||||
VAlign::Top => y + pad + ascent,
|
||||
VAlign::Center | VAlign::Justify | VAlign::Distributed => y + (h - (n - 1.0) * line_h - ascent - descent) / 2.0 + ascent,
|
||||
VAlign::Bottom => y + h - pad - descent - (n - 1.0) * line_h,
|
||||
}
|
||||
} else {
|
||||
match st.align.v {
|
||||
VAlign::Top => y + pad + size * 0.8,
|
||||
VAlign::Center | VAlign::Justify | VAlign::Distributed => y + (h - n * line_h) / 2.0 + line_h * 0.5 + size * 0.33,
|
||||
VAlign::Bottom => y + h - pad - size * 0.22 - (n - 1.0) * line_h,
|
||||
}
|
||||
let first_baseline = match st.align.v {
|
||||
VAlign::Top => y + pad + size * 0.8,
|
||||
VAlign::Center | VAlign::Justify | VAlign::Distributed => y + (h - n * line_h) / 2.0 + line_h * 0.5 + size * 0.33,
|
||||
VAlign::Bottom => y + h - pad - size * 0.22 - (n - 1.0) * line_h,
|
||||
};
|
||||
// Overflow into empty neighbours (single-line text, not merged).
|
||||
// Center Across Selection spans the empty Center Across cells to its right; the text stays within that run.
|
||||
@@ -334,7 +222,7 @@ pub(super) fn draw_text(pg: &mut Page, b: &Block, placement: TextPlacement<'_>)
|
||||
let clip_l = clip_l.max(limits.0);
|
||||
let clip_r = clip_r.min(limits.1);
|
||||
pg.save();
|
||||
pg.clip_rect(b.text_x(clip_l, clip_r - clip_l), y, (clip_r - clip_l).max(0.0), h);
|
||||
pg.clip_rect(clip_l, y, (clip_r - clip_l).max(0.0), h);
|
||||
if rotated {
|
||||
// Rotated text: anchored at the bottom-left (upward) or top-left (downward) of the cell.
|
||||
// Wrapped lines stack rightward for upward text and leftward for downward text, so
|
||||
@@ -345,27 +233,23 @@ pub(super) fn draw_text(pg: &mut Page, b: &Block, placement: TextPlacement<'_>)
|
||||
for (i, t) in lines.iter().enumerate() {
|
||||
let i = i as f32;
|
||||
let (ox, oy) = if deg > 0.0 {
|
||||
(x + pad + extents.map_or(size * 0.8, |e| e.0) * deg.to_radians().sin() + i * line_h, y + h - pad)
|
||||
(x + pad + size * 0.8 * deg.to_radians().sin() + i * line_h, y + h - pad)
|
||||
} else {
|
||||
(x + pad + (last - i) * line_h, y + pad + extents.map_or(size * 0.8, |e| e.0))
|
||||
(x + pad + (last - i) * line_h, y + pad + size * 0.8)
|
||||
};
|
||||
let tw = gridcraft_pdf::text_width_with_direction(font, size, &t.text, t.direction);
|
||||
let (sn, cs) = angle.sin_cos();
|
||||
let (ascent, descent) = extents.unwrap_or((size * 0.8, size * 0.22));
|
||||
let ox = if sh.right_to_left { b.mirror_axis - ox - tw * cs - (ascent - descent) * sn } else { ox };
|
||||
pg.text_rotated_with_direction(Baseline { origin: Point::new(ox, oy), angle }, size, font, color, &t.text, t.direction);
|
||||
pg.text_rotated(Point::new(ox, oy), size, font, color, t, angle);
|
||||
}
|
||||
pg.restore();
|
||||
return;
|
||||
}
|
||||
if rot == 255 {
|
||||
// Vertical stacked text.
|
||||
let stacked: String = lines.iter().map(|line| line.text.as_str()).collect();
|
||||
let chars: Vec<&str> = stacked.graphemes(true).take(500).collect();
|
||||
let mut yy = y + pad + extents.map_or(size * 0.8, |e| e.0);
|
||||
let chars: Vec<char> = lines.concat().chars().take(500).collect();
|
||||
let mut yy = y + pad + size * 0.8;
|
||||
for ch in chars {
|
||||
let cw = gridcraft_pdf::text_width(font, size, ch);
|
||||
pg.text_with_direction(Point::new(b.text_x(x + (w - cw) / 2.0, cw), yy), size, font, color, ch, direction);
|
||||
let s = ch.to_string();
|
||||
let cw = gridcraft_pdf::text_width(font, size, &s);
|
||||
pg.text(x + (w - cw) / 2.0, yy, size, font, color, &s);
|
||||
yy += line_h;
|
||||
if yy > y + h + line_h {
|
||||
break;
|
||||
@@ -375,7 +259,7 @@ pub(super) fn draw_text(pg: &mut Page, b: &Block, placement: TextPlacement<'_>)
|
||||
return;
|
||||
}
|
||||
for (i, line) in lines.iter().enumerate() {
|
||||
let lw = gridcraft_pdf::text_width_with_direction(font, size, &line.text, line.direction);
|
||||
let lw = gridcraft_pdf::text_width(font, size, line);
|
||||
let lx = match h_align {
|
||||
HAlign::Right => x + w - pad - lw - indent,
|
||||
HAlign::Center => x + (w + across - lw) / 2.0,
|
||||
@@ -385,8 +269,7 @@ pub(super) fn draw_text(pg: &mut Page, b: &Block, placement: TextPlacement<'_>)
|
||||
if ly - size > y + h || ly < y - line_h {
|
||||
continue;
|
||||
}
|
||||
let lx = b.text_x(lx, lw);
|
||||
pg.text_with_direction(Point::new(lx, ly), size, font, color, &line.text, line.direction);
|
||||
pg.text(lx, ly, size, font, color, line);
|
||||
if st.font.underline != Underline::None {
|
||||
let uw = (size * 0.06).max(0.2);
|
||||
pg.stroke_line(lx, ly + size * 0.12, lx + lw, ly + size * 0.12, uw, color);
|
||||
|
||||
@@ -4,7 +4,7 @@ use std::sync::Arc;
|
||||
|
||||
use gridcraft_core::{CellRef, MAX_COLS, MAX_ROWS, RangeRef};
|
||||
use gridcraft_formula::adjust::{Axis, Edit};
|
||||
use gridcraft_model::{Anchor, AnchorMode, PivotDataCell, PivotLookup, Sheet, Visibility};
|
||||
use gridcraft_model::{Anchor, AnchorMode, Sheet, Visibility};
|
||||
use serde_json::{Value as Json, json};
|
||||
|
||||
use super::{
|
||||
@@ -211,31 +211,7 @@ fn shift_sheet_features(sh: &mut Sheet, axis: Axis, at: u32, count: u32, insert:
|
||||
Axis::Rows => CellRef::new(at, pt.anchor.col),
|
||||
Axis::Cols => CellRef::new(pt.anchor.row, at),
|
||||
});
|
||||
let old = pt.last_range;
|
||||
pt.last_range = old.and_then(map_range);
|
||||
// GETPIVOTDATA's value cells are stored as offsets from the report's top-left cell, so
|
||||
// lines inserted or deleted inside the report move them as well. The moved cells go into
|
||||
// a new index (the shared one stays with the undo snapshots); a value cell deleted with
|
||||
// its line drops out, so it is #REF! rather than read from whatever took its place.
|
||||
let index = pt.data_index.clone();
|
||||
if let (Some(o), Some(n), Some(cells)) = (old, pt.last_range, index.cells()) {
|
||||
let (lo, hi) = if axis == Axis::Rows { (o.start.row, o.end.row) } else { (o.start.col, o.end.col) };
|
||||
let inside = at <= hi && if insert { at > lo } else { at.saturating_add(count) > lo };
|
||||
if inside {
|
||||
let moved: Vec<PivotDataCell> = cells
|
||||
.iter()
|
||||
.filter_map(|c| {
|
||||
let to = map_cell(CellRef::new(o.start.row.checked_add(c.row)?, o.start.col.checked_add(c.col)?))?;
|
||||
Some(PivotDataCell { row: to.row.checked_sub(n.start.row)?, col: to.col.checked_sub(n.start.col)?, ..c.clone() })
|
||||
})
|
||||
.collect();
|
||||
let lookup = PivotLookup::default();
|
||||
if !moved.is_empty() {
|
||||
lookup.set_cells(moved);
|
||||
}
|
||||
pt.data_index = lookup;
|
||||
}
|
||||
}
|
||||
pt.last_range = pt.last_range.and_then(map_range);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ impl FileKind {
|
||||
"ods" => FileKind::Ods,
|
||||
"csv" => FileKind::Csv,
|
||||
"tsv" | "tab" | "txt" => FileKind::Tsv,
|
||||
ext if craft_gridcraft_format::is_extension(ext) => FileKind::Json,
|
||||
"json" | "scjson" => FileKind::Json,
|
||||
"html" | "htm" => FileKind::Html,
|
||||
"slk" => FileKind::Sylk,
|
||||
_ => return None,
|
||||
@@ -316,7 +316,7 @@ fn read_plain(name: &str, bytes: &[u8], csv_as_text: bool) -> Result<(Workbook,
|
||||
}
|
||||
match kind {
|
||||
Some(FileKind::Json) => {
|
||||
let mut wb: Workbook = craft_gridcraft_format::read(bytes).map_err(|e| EngineError::Other(e.to_string()))?;
|
||||
let mut wb: Workbook = serde_json::from_slice(bytes).map_err(|e| EngineError::Other(format!("not a GridCraft JSON workbook: {e}")))?;
|
||||
wb.styles.rebuild_index();
|
||||
if wb.sheets.is_empty() {
|
||||
// The file's macros are read after this (`macros::load`), so they come along.
|
||||
|
||||
@@ -323,7 +323,6 @@ impl DocState {
|
||||
/// read from bytes (a file, a download, a recovery copy), [`Trust::Local`] only for a workbook
|
||||
/// made in this session.
|
||||
pub fn new(mut wb: Workbook, path: Option<String>, title: String, trust: Trust) -> DocState {
|
||||
let _ = gridcraft_model::PIVOT_INDEXER.set(pivot::index_cells);
|
||||
let mut calc = Calc::new();
|
||||
calc.recalc_all(&mut wb);
|
||||
Self::with_calc(wb, calc, path, title, trust)
|
||||
|
||||
@@ -213,7 +213,17 @@ pub fn json_bytes(wb: &Workbook) -> crate::Result<Vec<u8>> {
|
||||
for m in &wb.macros {
|
||||
check(m).map_err(crate::EngineError::Other)?;
|
||||
}
|
||||
craft_gridcraft_format::write_with_kept(wb, "macros", &wb.macros_unread).map_err(|e| crate::EngineError::Other(e.to_string()))
|
||||
let bytes = if wb.macros_unread.is_empty() {
|
||||
serde_json::to_vec_pretty(wb)
|
||||
} else {
|
||||
serde_json::to_value(wb).and_then(|mut v| {
|
||||
if let Some(list) = v.as_object_mut().map(|o| o.entry("macros").or_insert_with(|| Json::Array(vec![]))).and_then(Json::as_array_mut) {
|
||||
list.extend(wb.macros_unread.iter().cloned());
|
||||
}
|
||||
serde_json::to_vec_pretty(&v)
|
||||
})
|
||||
};
|
||||
bytes.map_err(|e| crate::EngineError::Other(e.to_string()))
|
||||
}
|
||||
|
||||
/// Whether `v` is a macro in a newer format than this build reads.
|
||||
|
||||
@@ -12,8 +12,8 @@ use gridcraft_core::date::datetime_from_serial;
|
||||
pub use gridcraft_core::quote_sheet;
|
||||
use gridcraft_core::{CellError, CellRef, MAX_COLS, MAX_ROWS, RangeRef, Value, split_sheet};
|
||||
use gridcraft_model::{
|
||||
BorderLine, BorderStyle, Cell, Chart, Color, Fill, HAlign, NumFmt, PivotDataCell, PivotDateGroup, PivotField, PivotFilter, PivotFunc,
|
||||
PivotItemRef, PivotLayout, PivotLookup, PivotShowAs, PivotSort, PivotTable, PivotValue, Series, Style, StyleId, Workbook,
|
||||
BorderLine, BorderStyle, Cell, Chart, Color, Fill, HAlign, NumFmt, PivotDateGroup, PivotField, PivotFilter, PivotFunc, PivotLayout, PivotShowAs,
|
||||
PivotSort, PivotTable, PivotValue, Series, Style, StyleId, Workbook,
|
||||
};
|
||||
|
||||
use crate::pivot_calc::CalcSet;
|
||||
@@ -41,9 +41,6 @@ pub const MAX_OUTPUT_CELLS: u64 = 2_000_000;
|
||||
pub const MAX_AXIS_FIELDS: usize = 32;
|
||||
/// Most fields in the Values area.
|
||||
pub const MAX_VALUE_FIELDS: usize = 256;
|
||||
/// Most report value cells a report may have (every one is indexed for GETPIVOTDATA; bigger
|
||||
/// reports are rejected).
|
||||
pub const MAX_INDEXED_CELLS: usize = 1_000_000;
|
||||
|
||||
const MONTHS: [&str; 12] = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
|
||||
|
||||
@@ -317,42 +314,9 @@ pub fn refresh(wb: &mut Workbook, sheet: usize, idx: usize, replace: bool) -> Re
|
||||
}
|
||||
let sheet_name = shm.name.clone();
|
||||
rebind_charts(wb, &sheet_name, &pt.name, origin, &out);
|
||||
// The index of the new report; its lookup hash is built on the first GETPIVOTDATA.
|
||||
if let Some(p) = wb.sheet_mut(sheet).and_then(|s| s.pivots.get_mut(idx)) {
|
||||
let index = PivotLookup::default();
|
||||
index.set_cells(out.data);
|
||||
p.data_index = index;
|
||||
}
|
||||
Ok(area)
|
||||
}
|
||||
|
||||
/// The value cells of a PivotTable's report, for GETPIVOTDATA when a refresh did not set the
|
||||
/// index (a workbook just opened from XLSX). The positions must describe the report as it is
|
||||
/// stored on the sheet, not as the current source would render it: the source is recomputed only
|
||||
/// to learn the layout, and the result is accepted when every label and header cell of that
|
||||
/// layout equals the stored cell at the same place. A source changed since the last refresh gives
|
||||
/// a different layout, so there is no trustworthy index and the lookup fails until a refresh.
|
||||
pub fn index_cells(wb: &Workbook, sheet: usize, pt: &PivotTable) -> Result<Vec<PivotDataCell>, String> {
|
||||
const STALE: &str = "The stored report no longer matches the source. Refresh the PivotTable.";
|
||||
let report = pt.last_range.ok_or("The PivotTable has no report.")?;
|
||||
let out = compute(wb, pt, sheet)?;
|
||||
let sh = wb.sheet(sheet).ok_or("There's no such sheet.")?;
|
||||
let rows = u64::from(report.end.row) - u64::from(report.start.row) + 1;
|
||||
let cols = u64::from(report.end.col) - u64::from(report.start.col) + 1;
|
||||
if rows != u64::from(out.height().max(1)) || cols != u64::from(out.width.max(1)) {
|
||||
return Err(STALE.into());
|
||||
}
|
||||
let labels = [CellKind::Header, CellKind::RowLabel, CellKind::ColLabel, CellKind::Filter];
|
||||
for (r, row) in out.grid.iter().enumerate() {
|
||||
for (c, oc) in row.iter().enumerate() {
|
||||
if labels.contains(&oc.kind) && sh.value(CellRef::new(report.start.row + r as u32, report.start.col + c as u32)) != oc.value {
|
||||
return Err(STALE.into());
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(out.data)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod fit_tests {
|
||||
use super::data_cols_exceed_sheet;
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
use super::output::Output;
|
||||
use super::{CellRef, Chart, PivotLookup, Series, Workbook, quote_sheet};
|
||||
use super::{CellRef, Chart, Series, Workbook, quote_sheet};
|
||||
|
||||
// ---------------------------------------------------------------- PivotCharts
|
||||
|
||||
@@ -109,7 +109,6 @@ pub fn clear_output(wb: &mut Workbook, sheet: usize, idx: usize) {
|
||||
shm.take_cells(r);
|
||||
if let Some(p) = shm.pivots.get_mut(idx) {
|
||||
p.last_range = None;
|
||||
p.data_index = PivotLookup::default();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -127,7 +126,6 @@ mod tests {
|
||||
chart_rows: vec![1, 2, 3],
|
||||
chart_cols: (1..1000).map(|c| (c, format!("S{c}"))).collect(),
|
||||
label_col: Some(0),
|
||||
data: vec![],
|
||||
};
|
||||
assert_eq!(chart_series("Sheet1", CellRef::new(0, 0), &out).len(), MAX_CHART_SERIES);
|
||||
}
|
||||
|
||||
@@ -3,8 +3,8 @@ use super::output::{
|
||||
AggMap, CellKind, ColKind, ColSpec, Ctx, Grid, Line, LineKind, Output, RowKind, ValSrc, caption, data_cols_exceed_sheet, flatten_cols,
|
||||
};
|
||||
use super::{
|
||||
CalcSet, CellError, CellRef, HashMap, HashSet, MAX_AXIS_FIELDS, MAX_COLS, MAX_INDEXED_CELLS, MAX_VALUE_FIELDS, PivotDataCell, PivotDateGroup,
|
||||
PivotField, PivotFilter, PivotFunc, PivotItemRef, PivotLayout, PivotShowAs, PivotTable, PivotValue, Source, Value, Workbook, read_source,
|
||||
CalcSet, CellError, CellRef, HashMap, HashSet, MAX_AXIS_FIELDS, MAX_COLS, MAX_VALUE_FIELDS, PivotDateGroup, PivotField, PivotFilter, PivotFunc,
|
||||
PivotLayout, PivotShowAs, PivotTable, PivotValue, Source, Value, Workbook, read_source,
|
||||
};
|
||||
|
||||
/// Why Show Details turns a cell down when it isn't a value cell of a PivotTable (the front end
|
||||
@@ -653,7 +653,6 @@ pub(super) fn compute_from(wb: &Workbook, pt: &PivotTable, src: &Source, mut pro
|
||||
chart_rows: vec![],
|
||||
chart_cols: vec![],
|
||||
label_col: None,
|
||||
data: vec![],
|
||||
});
|
||||
}
|
||||
|
||||
@@ -729,16 +728,6 @@ pub(super) fn compute_from(wb: &Workbook, pt: &PivotTable, src: &Source, mut pro
|
||||
} else {
|
||||
Some(row_levels.saturating_sub(1) as u32)
|
||||
};
|
||||
let item_refs = |fields: &[&PivotField], items: &[FieldItems], path: &[u32]| -> Vec<PivotItemRef> {
|
||||
path.iter()
|
||||
.enumerate()
|
||||
.filter_map(|(d, it)| {
|
||||
let (f, item) = (fields.get(d)?, items.get(d)?.get(*it)?);
|
||||
Some(PivotItemRef { field: f.source_col.clone(), label: item.label.clone(), value: item.value.clone() })
|
||||
})
|
||||
.collect()
|
||||
};
|
||||
let mut data: Vec<PivotDataCell> = Vec::new();
|
||||
for line in &lines {
|
||||
let rk = match line.kind {
|
||||
LineKind::Item(b) => RowKind::Item(b),
|
||||
@@ -769,21 +758,6 @@ pub(super) fn compute_from(wb: &Workbook, pt: &PivotTable, src: &Source, mut pro
|
||||
let Some(raw) = lookup.get(rp, cp, *vi) else { continue };
|
||||
let context = ShowContext { row_path: rp, col_path: cp, value_index: *vi, level0: &level0, siblings: &siblings, cache: &show_cache };
|
||||
let shown = show_value(vdef, raw, &lookup, &context);
|
||||
// Every value cell of the report is indexed, so a report that needs more cells than
|
||||
// the index cap is rejected outright — never written with a truncated index that
|
||||
// would answer #REF! for the values the sheet shows.
|
||||
if data.len() >= MAX_INDEXED_CELLS {
|
||||
return Err(format!("A PivotTable report can have at most {MAX_INDEXED_CELLS} value cells."));
|
||||
}
|
||||
let mut items = item_refs(&ctx.rows, &ctx.row_items, rp);
|
||||
items.extend(item_refs(&col_fields, &col_items, cp));
|
||||
data.push(PivotDataCell {
|
||||
data_field: vdef.name.clone(),
|
||||
source_col: vdef.source_col.clone(),
|
||||
items,
|
||||
row: u32::try_from(r).unwrap_or(u32::MAX),
|
||||
col: u32::try_from(l + j).unwrap_or(u32::MAX),
|
||||
});
|
||||
if let Some(pr) = probe.as_deref_mut() {
|
||||
if pr.at == Some((r, l + j)) {
|
||||
pr.hit = Some((rp.to_vec(), cp.to_vec()));
|
||||
@@ -795,5 +769,5 @@ pub(super) fn compute_from(wb: &Workbook, pt: &PivotTable, src: &Source, mut pro
|
||||
g.set(r, l + j, shown, ck.1, 0, data_fmt.get(*vi).cloned().flatten());
|
||||
}
|
||||
}
|
||||
Ok(Output { width: g.width as u32, grid: g.rows, row_kinds: g.kinds, body_offset, chart_rows, chart_cols, label_col, data })
|
||||
Ok(Output { width: g.width as u32, grid: g.rows, row_kinds: g.kinds, body_offset, chart_rows, chart_cols, label_col })
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
use super::items::{Acc, FieldItems, Node, is_collapsed};
|
||||
use super::{
|
||||
BorderLine, BorderStyle, Color, Fill, HAlign, HashMap, MAX_COLS, MAX_OUTPUT_CELLS, MAX_ROWS, NumFmt, PivotDataCell, PivotField, PivotLayout,
|
||||
PivotTable, Style, Value,
|
||||
BorderLine, BorderStyle, Color, Fill, HAlign, HashMap, MAX_COLS, MAX_OUTPUT_CELLS, MAX_ROWS, NumFmt, PivotField, PivotLayout, PivotTable, Style,
|
||||
Value,
|
||||
};
|
||||
|
||||
// ---------------------------------------------------------------- output
|
||||
@@ -61,8 +61,6 @@ pub struct Output {
|
||||
pub chart_cols: Vec<(u32, String)>,
|
||||
/// Grid column holding the innermost row labels (`None` without row fields).
|
||||
pub label_col: Option<u32>,
|
||||
/// Every value cell with the items that locate it (for GETPIVOTDATA).
|
||||
pub data: Vec<PivotDataCell>,
|
||||
}
|
||||
|
||||
impl Output {
|
||||
|
||||
+1
-255
@@ -1621,44 +1621,6 @@ fn case_sensitive_sort_puts_lowercase_first() {
|
||||
assert_eq!(col, ["a", "A", "aB", "Ab", "b", "B"].map(Value::from));
|
||||
}
|
||||
|
||||
/// #3949: Excel sorts values that are not in the custom list A to Z after the listed ones.
|
||||
#[test]
|
||||
fn custom_list_sort_puts_unlisted_values_after_the_list_in_order() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["Priority"], ["Zulu"], ["Alpha"], ["Low"], ["High"], ["Medium"]]})).unwrap();
|
||||
let key = json!({"column": "A", "order": "asc", "customList": ["High", "Medium", "Low"]});
|
||||
s.execute("data.sort", json!({"range": "A1:A6", "header": true, "keys": [key]})).unwrap();
|
||||
let col: Vec<Value> = (1..=6).map(|r| v(&s, &format!("A{r}"))).collect();
|
||||
assert_eq!(col, ["Priority", "High", "Medium", "Low", "Alpha", "Zulu"].map(Value::from));
|
||||
}
|
||||
|
||||
/// #3949 changes only an ascending custom-list key: with a descending one, two values not in the
|
||||
/// list still tie, so the next key orders them.
|
||||
#[test]
|
||||
fn descending_custom_list_sort_leaves_unlisted_values_to_the_next_key() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["Name", "N"], ["Zulu", 2], ["Alpha", 1], ["High", 3]]})).unwrap();
|
||||
let keys = json!([
|
||||
{"column": "A", "order": "desc", "customList": ["High", "Medium", "Low"]},
|
||||
{"column": "B", "order": "asc"}
|
||||
]);
|
||||
s.execute("data.sort", json!({"range": "A1:B4", "header": true, "keys": keys})).unwrap();
|
||||
let col: Vec<Value> = (2..=4).map(|r| v(&s, &format!("A{r}"))).collect();
|
||||
assert_eq!(col, ["Alpha", "Zulu", "High"].map(Value::from));
|
||||
}
|
||||
|
||||
/// A blank in a descending custom-list key goes last, after the list, rather than tying with the
|
||||
/// values that are not in the list (which come first), so the order is the same whatever the input.
|
||||
#[test]
|
||||
fn descending_custom_list_sort_puts_blanks_last() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["Name"], [null], ["High"], ["Zulu"]]})).unwrap();
|
||||
let key = json!({"column": "A", "order": "desc", "customList": ["High", "Medium", "Low"]});
|
||||
s.execute("data.sort", json!({"range": "A1:A4", "header": true, "keys": [key]})).unwrap();
|
||||
let col: Vec<Value> = (2..=4).map(|r| v(&s, &format!("A{r}"))).collect();
|
||||
assert_eq!(col, [Value::from("Zulu"), Value::from("High"), Value::Empty]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn data_sort_orders_vowelled_arabic_by_letters() {
|
||||
let mut s = s();
|
||||
@@ -1797,7 +1759,7 @@ fn subtotal_with_a_sheet_prefix_works_on_the_named_sheet() {
|
||||
assert_eq!(col(prices, 0), ["Item", "a", "a", "a Total", "b", "b Total", "Grand Total"].map(Value::from));
|
||||
assert_eq!(col(prices, 1)[1..], [1.0, 2.0, 3.0, 4.0, 4.0, 7.0].map(Value::from));
|
||||
assert!(wb.styles.get(prices.style_id(CellRef::new(3, 0))).font.bold);
|
||||
assert_eq!(prices.rows.get(&1).map(|l| l.outline), Some(2));
|
||||
assert_eq!(prices.rows.get(&1).map(|l| l.outline), Some(1));
|
||||
let sheet1 = wb.sheet(wb.sheet_index("Sheet1").unwrap()).unwrap();
|
||||
assert_eq!(col(sheet1, 0)[..4], ["Name", "x", "x", "y"].map(Value::from));
|
||||
assert!(sheet1.value(CellRef::new(4, 0)).is_empty());
|
||||
@@ -1805,24 +1767,6 @@ fn subtotal_with_a_sheet_prefix_works_on_the_named_sheet() {
|
||||
assert!(s.execute("data.group", json!({"sheet": "Prices"})).is_err());
|
||||
}
|
||||
|
||||
/// #3945: Excel groups every data and subtotal row under the grand total, so the details are at
|
||||
/// level 2, the subtotals at level 1, and showing level 1 leaves only the grand total.
|
||||
#[test]
|
||||
fn subtotal_groups_everything_under_the_grand_total() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [["Group", "Amount"], ["A", 10], ["A", 20], ["B", 30]]})).unwrap();
|
||||
s.execute("data.subtotal", json!({"range": "A1:B4", "groupBy": "A", "columns": ["B"], "function": "sum"})).unwrap();
|
||||
let sh = s.doc().unwrap().wb.active().unwrap();
|
||||
let levels: Vec<u8> = (0..7).map(|r| sh.rows.get(&r).map_or(0, |l| l.outline)).collect();
|
||||
assert_eq!(levels, [0, 2, 2, 1, 2, 1, 0]);
|
||||
let shown = |s: &Session| -> Vec<u32> { (0..7).filter(|&r| !s.doc().unwrap().wb.active().unwrap().is_row_hidden(r)).map(|r| r + 1).collect() };
|
||||
s.execute("data.showLevels", json!({"rows": 1})).unwrap();
|
||||
assert_eq!(shown(&s), [1, 7]);
|
||||
s.execute("data.showLevels", json!({"rows": 2})).unwrap();
|
||||
assert_eq!(shown(&s), [1, 4, 6, 7]);
|
||||
assert_eq!(v(&s, "B7"), Value::Number(60.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn formatting_and_styles() {
|
||||
let mut s = s();
|
||||
@@ -2457,35 +2401,6 @@ fn merging_over_a_spill_blocks_it_and_unmerging_unblocks_it() {
|
||||
assert_eq!(v(&s, "A3"), Value::Number(3.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn inserting_a_link_without_text_preserves_a_spill_child() {
|
||||
let mut s = s();
|
||||
s.execute("cell.set", json!({"cell": "A1", "input": "=SEQUENCE(3)"})).unwrap();
|
||||
assert_eq!(v(&s, "A2"), Value::Number(2.0));
|
||||
s.execute("insert.link", json!({"cell": "A2", "target": "https://example.org"})).unwrap();
|
||||
assert_eq!(v(&s, "A1"), Value::Number(1.0));
|
||||
assert_eq!(v(&s, "A2"), Value::Number(2.0));
|
||||
let d = s.doc().unwrap();
|
||||
let at = CellRef::parse("A2").unwrap();
|
||||
assert_eq!(d.wb.active().unwrap().hyperlinks.get(&at).map(|link| link.target.as_str()), Some("https://example.org"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn inserting_a_link_without_text_preserves_an_empty_spill_child() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1:C3", "values": [["a", "x", 1], ["b", "x", 2], ["a", "y", 3]]})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "K1", "input": "=PIVOTBY(A1:A3,B1:B3,C1:C3,LAMBDA(x,SUM(x)))"})).unwrap();
|
||||
assert_eq!(v(&s, "K1"), Value::Empty);
|
||||
let at = CellRef::parse("M3").unwrap();
|
||||
assert_eq!(v(&s, "M3"), Value::Empty);
|
||||
assert_eq!(s.doc().unwrap().wb.active().unwrap().spill_anchor(at), Some(CellRef::parse("K1").unwrap()));
|
||||
s.execute("insert.link", json!({"cell": "M3", "target": "https://example.org"})).unwrap();
|
||||
assert_eq!(v(&s, "K1"), Value::Empty);
|
||||
assert_eq!(v(&s, "M3"), Value::Empty);
|
||||
let d = s.doc().unwrap();
|
||||
assert_eq!(d.wb.active().unwrap().hyperlinks.get(&at).map(|link| link.target.as_str()), Some("https://example.org"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn multi_cell_array_formulas_and_tables_dont_overlap() {
|
||||
// Found by the command-sequence fuzzer: an array over a table header lost its value to the
|
||||
@@ -3025,127 +2940,6 @@ fn validation_formulas_are_relative_and_see_the_new_value() {
|
||||
assert!(!ok(&mut s, "C1", "50"));
|
||||
}
|
||||
|
||||
/// Every value of the active sheet as the incremental recalculation left it must equal a full one.
|
||||
fn assert_matches_full_recalc(s: &Session) {
|
||||
let wb = &s.doc().unwrap().wb;
|
||||
let mut fresh = (**wb).clone();
|
||||
gridcraft_calc::Calc::new().recalc_all(&mut fresh);
|
||||
let (a, b) = (wb.active().unwrap(), fresh.active().unwrap());
|
||||
for row in 0..30 {
|
||||
for col in 0..12 {
|
||||
let cell = CellRef { row, col };
|
||||
assert_eq!(a.value(cell), b.value(cell), "{cell} in memory vs after a full recalc");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn filling_a_formula_next_to_a_spill_matches_a_full_recalc() {
|
||||
// Found by the command-sequence fuzzer: C14 spills along row 14; filling `=D14:E18` over
|
||||
// E13:F13 puts two array formulas whose areas run into that spill and into each other. The
|
||||
// incremental pass left F13 as #SPILL! while a full recalc gave F13 its array and C14
|
||||
// #SPILL!. The spill that already exists keeps its cells (as in Excel), in both.
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "B18", "values": [[1], [2], [3], [4], [5], [6], [7]]})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "C14", "input": "=TRANSPOSE(B18:B24)"})).unwrap();
|
||||
s.execute("selection.set", json!({"range": "E13"})).unwrap();
|
||||
s.execute("range.fill", json!({"range": "E13:F13", "input": "=D14:E18"})).unwrap();
|
||||
assert_eq!(v(&s, "C14"), Value::Number(1.0));
|
||||
assert_eq!(v(&s, "I14"), Value::Number(7.0));
|
||||
assert_eq!(v(&s, "F13"), Value::Error(gridcraft_core::CellError::Spill));
|
||||
assert_matches_full_recalc(&s);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn overlapping_spills_keep_the_one_that_exists_whichever_anchor_is_first() {
|
||||
use gridcraft_core::CellError::Spill;
|
||||
// E10 spills along row 10, F8 down over F10: F8 is first in reading order, E10 may be first
|
||||
// to spill. Excel keeps whichever spilled first.
|
||||
for (first, second) in [(("E10", "=SEQUENCE(1,3)"), ("F8", "=SEQUENCE(5)")), (("F8", "=SEQUENCE(5)"), ("E10", "=SEQUENCE(1,3)"))] {
|
||||
let mut s = s();
|
||||
s.execute("cell.set", json!({"cell": first.0, "input": first.1})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": second.0, "input": second.1})).unwrap();
|
||||
assert_ne!(v(&s, first.0), Value::Error(Spill), "{} keeps its cells", first.0);
|
||||
assert_eq!(v(&s, second.0), Value::Error(Spill), "{} is blocked", second.0);
|
||||
assert_matches_full_recalc(&s);
|
||||
// Clearing the winner lets the other one spill.
|
||||
s.execute("edit.clearContents", json!({"range": first.0})).unwrap();
|
||||
assert_ne!(v(&s, second.0), Value::Error(Spill), "{} spills once {} is cleared", second.0, first.0);
|
||||
assert_matches_full_recalc(&s);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_spill_growing_into_another_and_back_matches_a_full_recalc_at_every_step() {
|
||||
use gridcraft_core::CellError::Spill;
|
||||
// Both arrays already spill; F8 (first in reading order) grows down over E10's spill, takes
|
||||
// its cells, shrinks back and lets it spill again, then the steps are undone, redone, edited
|
||||
// inside the contested area and cleared. Every state must match a full recalc.
|
||||
let mut s = s();
|
||||
s.execute("cell.set", json!({"cell": "H1", "input": "1"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "F8", "input": "=SEQUENCE(H1)"})).unwrap();
|
||||
s.execute("cell.set", json!({"cell": "E10", "input": "=SEQUENCE(1,3)*10"})).unwrap();
|
||||
assert_eq!(v(&s, "G10"), Value::Number(30.0));
|
||||
assert_matches_full_recalc(&s);
|
||||
let steps: [(&str, serde_json::Value); 9] = [
|
||||
("cell.set", json!({"cell": "H1", "input": "5"})),
|
||||
("cell.set", json!({"cell": "E10", "input": "=SEQUENCE(1,2)*10"})),
|
||||
("cell.set", json!({"cell": "H1", "input": "1"})),
|
||||
("edit.undo", json!({})),
|
||||
("edit.undo", json!({})),
|
||||
("edit.redo", json!({})),
|
||||
("cell.set", json!({"cell": "F11", "input": "x"})),
|
||||
("cell.set", json!({"cell": "H1", "input": "2"})),
|
||||
("edit.clearContents", json!({"range": "E8:F10"})),
|
||||
];
|
||||
for (i, (id, params)) in steps.iter().enumerate() {
|
||||
s.execute(id, params.clone()).unwrap();
|
||||
assert_matches_full_recalc(&s);
|
||||
if i == 0 {
|
||||
// Both held a spill: reading order gives F8 the cells.
|
||||
assert_eq!(v(&s, "F12"), Value::Number(5.0));
|
||||
assert_eq!(v(&s, "E10"), Value::Error(Spill));
|
||||
}
|
||||
if i == 2 {
|
||||
assert_eq!(v(&s, "E10"), Value::Number(10.0));
|
||||
assert_eq!(v(&s, "F10"), Value::Number(20.0));
|
||||
}
|
||||
if i == 3 {
|
||||
// Undone back to the grown F8.
|
||||
assert_eq!(v(&s, "F12"), Value::Number(5.0));
|
||||
assert_eq!(v(&s, "E10"), Value::Error(Spill));
|
||||
}
|
||||
if i == 8 {
|
||||
assert_eq!((v(&s, "F8"), v(&s, "E10"), v(&s, "F9")), (Value::Empty, Value::Empty, Value::Empty));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn overlapping_spills_with_no_history_go_to_the_earlier_anchor() {
|
||||
use gridcraft_core::CellError::Spill;
|
||||
// A workbook calculated for the first time (a file that carries no layout) has no entry
|
||||
// order: the anchor first in reading order wins, whatever order the formulas were set in.
|
||||
for order in [["E10", "F8"], ["F8", "E10"]] {
|
||||
let mut s = s();
|
||||
for a in order {
|
||||
let input = if a == "E10" { "=SEQUENCE(1,3)" } else { "=SEQUENCE(5)" };
|
||||
s.execute("cell.set", json!({"cell": a, "input": input})).unwrap();
|
||||
}
|
||||
let mut fresh = (*s.doc().unwrap().wb).clone();
|
||||
for i in 0..fresh.sheets.len() {
|
||||
let sh = fresh.sheet_mut(i).unwrap();
|
||||
sh.spill.clear();
|
||||
sh.spill_ranges.clear();
|
||||
}
|
||||
gridcraft_calc::Calc::new().recalc_all(&mut fresh);
|
||||
let a = fresh.active().unwrap();
|
||||
let cell = |r: &str| a.value(CellRef::parse(r).unwrap());
|
||||
assert_ne!(cell("F8"), Value::Error(Spill), "order {order:?}");
|
||||
assert_eq!(cell("E10"), Value::Error(Spill), "order {order:?}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn multi_area_rule_formulas_are_relative_to_the_top_left_cell_of_all_areas() {
|
||||
// Issue #3152: Excel writes the formula for the top-left cell of all the areas (H26), whatever
|
||||
@@ -5836,53 +5630,6 @@ fn tiled_paste_clears_destination_cells_under_blank_source_cells() {
|
||||
assert_eq!(v(&s, "C4"), Value::Empty);
|
||||
}
|
||||
|
||||
/// #3934: a row copied into a taller, narrower selection repeats down every selected row at the
|
||||
/// copy's width, as in Excel; a column copied into a wider, shorter one repeats across.
|
||||
#[test]
|
||||
fn paste_into_a_narrower_selection_repeats_the_copy_down_its_rows() {
|
||||
for dest in ["A3:A6", "A3:B6"] {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [[1, 2]]})).unwrap();
|
||||
s.execute("edit.copy", json!({"range": "A1:B1"})).unwrap();
|
||||
s.execute("selection.set", json!({"range": dest})).unwrap();
|
||||
let r = s.execute("edit.paste", json!({})).unwrap();
|
||||
assert_eq!(r["pasted"], json!("A3:B6"), "{dest}");
|
||||
for row in 3..=6 {
|
||||
assert_eq!(v(&s, &format!("A{row}")), Value::Number(1.0), "{dest} row {row}");
|
||||
assert_eq!(v(&s, &format!("B{row}")), Value::Number(2.0), "{dest} row {row}");
|
||||
}
|
||||
assert_eq!(v(&s, "A2"), Value::Empty);
|
||||
assert_eq!(v(&s, "A7"), Value::Empty);
|
||||
}
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [[1], [2]]})).unwrap();
|
||||
s.execute("edit.copy", json!({"range": "A1:A2"})).unwrap();
|
||||
s.execute("selection.set", json!({"range": "C1:F1"})).unwrap();
|
||||
let r = s.execute("edit.paste", json!({})).unwrap();
|
||||
assert_eq!(r["pasted"], json!("C1:F2"));
|
||||
for col in ["C", "D", "E", "F"] {
|
||||
assert_eq!(v(&s, &format!("{col}1")), Value::Number(1.0), "{col}1");
|
||||
assert_eq!(v(&s, &format!("{col}2")), Value::Number(2.0), "{col}2");
|
||||
}
|
||||
}
|
||||
|
||||
/// #3934: repeating a wide copy down a narrow selection writes the copy's width on every row, so
|
||||
/// the 4,000,000-cell limit on a tiled paste counts that area, not the selection's. Past it the
|
||||
/// copy is pasted once, as a tiled paste over too large a selection already is.
|
||||
#[test]
|
||||
fn a_row_repeated_down_a_narrow_selection_is_bounded_by_the_area_it_fills() {
|
||||
let mut s = s();
|
||||
s.execute("range.setValues", json!({"range": "A1", "values": [[1]]})).unwrap();
|
||||
s.execute("range.setValues", json!({"range": "P1", "values": [[2]]})).unwrap();
|
||||
s.execute("edit.copy", json!({"range": "A1:P1"})).unwrap();
|
||||
// 300,000 rows selected, 4,800,000 cells once the copy's 16 columns are repeated down them.
|
||||
s.execute("selection.set", json!({"range": "A3:A300002"})).unwrap();
|
||||
let r = s.execute("edit.paste", json!({})).unwrap();
|
||||
assert_eq!(r["pasted"], json!("A3:P3"));
|
||||
assert_eq!(v(&s, "P3"), Value::Number(2.0));
|
||||
assert_eq!(v(&s, "A4"), Value::Empty);
|
||||
}
|
||||
|
||||
/// Excel refuses a paste that would run off the sheet rather than pasting part of it: whole
|
||||
/// columns below row 1, whole rows right of column A, a whole column transposed, or a block at
|
||||
/// the last row or column.
|
||||
@@ -6626,7 +6373,6 @@ fn a_script_cannot_switch_windows() {
|
||||
|
||||
mod controls;
|
||||
mod equation;
|
||||
mod json_golden;
|
||||
mod macros;
|
||||
mod objects;
|
||||
mod python_cells;
|
||||
|
||||
@@ -1,80 +0,0 @@
|
||||
//! Byte-for-byte checks on the native JSON workbook (`.json`, `.scjson`). The files in
|
||||
//! `crates/engine/tests/golden` were written before the format moved to `craft-gridcraft-format`
|
||||
//! (storytold/craft-libs). Saving the same workbook must give the same bytes, and opening a
|
||||
//! golden file and saving it again must give it back.
|
||||
//! `GRIDCRAFT_BLESS_GOLDEN=1` rewrites them. Only do that for a deliberate format change.
|
||||
|
||||
use std::path::PathBuf;
|
||||
|
||||
use serde_json::json;
|
||||
|
||||
use super::s;
|
||||
use crate::Session;
|
||||
|
||||
fn golden(name: &str) -> PathBuf {
|
||||
PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("tests").join("golden").join(name)
|
||||
}
|
||||
|
||||
fn check(name: &str, actual: &[u8]) {
|
||||
let path = golden(name);
|
||||
if std::env::var_os("GRIDCRAFT_BLESS_GOLDEN").is_some() {
|
||||
std::fs::write(&path, actual).unwrap_or_else(|e| panic!("{}: {e}", path.display()));
|
||||
return;
|
||||
}
|
||||
let expected = std::fs::read(&path).unwrap_or_else(|e| panic!("{}: {e}", path.display()));
|
||||
assert!(expected == actual, "{name} changed ({} bytes, golden has {})", actual.len(), expected.len());
|
||||
}
|
||||
|
||||
fn save(s: &mut Session) -> Vec<u8> {
|
||||
let r = s.execute("file.saveBytes", json!({"format": "json"})).unwrap();
|
||||
crate::io::base64_decode(r["base64"].as_str().unwrap()).unwrap()
|
||||
}
|
||||
|
||||
fn open(s: &mut Session, name: &str, bytes: &[u8]) {
|
||||
s.execute("file.open", json!({"name": name, "base64": crate::io::base64_encode(bytes)})).unwrap();
|
||||
}
|
||||
|
||||
/// A workbook with text, numbers, a formula, a style, a number format, a second sheet and a macro.
|
||||
fn book() -> Session {
|
||||
let mut s = s();
|
||||
for (cell, input) in [("A1", "Item"), ("B1", "Qty"), ("A2", "Äpfel ✓"), ("B2", "3.5"), ("A3", "Pears"), ("B3", "2"), ("B4", "=SUM(B2:B3)")] {
|
||||
s.execute("cell.set", json!({"cell": cell, "input": input})).unwrap();
|
||||
}
|
||||
s.execute("home.bold", json!({"range": "A1:B1"})).unwrap();
|
||||
s.execute("home.numberFormat", json!({"range": "B2:B4", "format": "0.00"})).unwrap();
|
||||
s.execute("macro.save", json!({"name": "Fill", "steps": [{"command": "cell.set", "params": {"cell": "C1", "input": "x"}}]})).unwrap();
|
||||
s
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_save_writes_the_golden_workbook_bytes() {
|
||||
let mut s = book();
|
||||
check("book.json", &save(&mut s));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_golden_workbook_opens_and_saves_back_unchanged() {
|
||||
let bytes = std::fs::read(golden("book.json")).unwrap();
|
||||
for name in ["book.json", "book.scjson"] {
|
||||
let mut s = s();
|
||||
open(&mut s, name, &bytes);
|
||||
assert_eq!(super::v(&s, "B4"), gridcraft_core::Value::Number(5.5), "{name}");
|
||||
assert!(save(&mut s) == bytes, "{name} saved back differently");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn macros_in_a_newer_format_are_written_back_as_the_file_held_them() {
|
||||
// The save that splices kept macros back into `macros` goes through a JSON value.
|
||||
let mut v: serde_json::Value = serde_json::from_slice(&std::fs::read(golden("book.json")).unwrap()).unwrap();
|
||||
v["macros"].as_array_mut().unwrap().push(json!({"name": "Future", "v": gridcraft_model::MACRO_VERSION + 1, "extra": [1, 2]}));
|
||||
let mut s = s();
|
||||
open(&mut s, "kept.json", &serde_json::to_vec_pretty(&v).unwrap());
|
||||
check("kept.json", &save(&mut s));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn what_is_not_a_json_workbook_says_so() {
|
||||
let err = crate::io::open_bytes("bad.json", b"{\"sheets\": 7}").unwrap_err().to_string();
|
||||
check("bad.error.txt", err.as_bytes());
|
||||
}
|
||||
@@ -530,16 +530,3 @@ fn python_code_with_an_empty_value_counts_as_content() {
|
||||
s.execute("edit.copy", json!({"range": "T1"})).unwrap();
|
||||
assert!(s.execute("edit.paste", json!({"at": "R2"})).is_err_and(|e| e.to_string().contains("part of an array")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn inserting_a_link_without_text_preserves_an_empty_python_cell() {
|
||||
let mut s = s();
|
||||
plant_empty(&mut s, "A1");
|
||||
s.execute("insert.link", json!({"cell": "A1", "target": "https://example.org"})).unwrap();
|
||||
assert_eq!(code(&s, 0, "A1"), Some("x = 1".into()));
|
||||
let d = s.doc().unwrap();
|
||||
let sh = d.wb.sheet(0).unwrap();
|
||||
let at = CellRef::parse("A1").unwrap();
|
||||
assert_eq!(sh.value(at), Value::Empty);
|
||||
assert_eq!(sh.hyperlinks.get(&at).map(|link| link.target.as_str()), Some("https://example.org"));
|
||||
}
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
# Golden files are compared byte for byte: no line-ending conversion on checkout.
|
||||
* -text
|
||||
@@ -1 +0,0 @@
|
||||
not a GridCraft JSON workbook: invalid type: integer `7`, expected a sequence at line 1 column 12
|
||||
@@ -1,440 +0,0 @@
|
||||
{
|
||||
"sheets": [
|
||||
{
|
||||
"name": "Sheet1",
|
||||
"cells": {
|
||||
"bands": {
|
||||
"0": {
|
||||
"rows": {
|
||||
"0": {
|
||||
"0": {
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Item"
|
||||
},
|
||||
"formula": null,
|
||||
"style": 1
|
||||
},
|
||||
"1": {
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Qty"
|
||||
},
|
||||
"formula": null,
|
||||
"style": 1
|
||||
}
|
||||
},
|
||||
"1": {
|
||||
"0": {
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Äpfel ✓"
|
||||
},
|
||||
"formula": null,
|
||||
"style": 0
|
||||
},
|
||||
"1": {
|
||||
"value": {
|
||||
"t": "Number",
|
||||
"v": 3.5
|
||||
},
|
||||
"formula": null,
|
||||
"style": 2
|
||||
}
|
||||
},
|
||||
"2": {
|
||||
"0": {
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Pears"
|
||||
},
|
||||
"formula": null,
|
||||
"style": 0
|
||||
},
|
||||
"1": {
|
||||
"value": {
|
||||
"t": "Number",
|
||||
"v": 2.0
|
||||
},
|
||||
"formula": null,
|
||||
"style": 2
|
||||
}
|
||||
},
|
||||
"3": {
|
||||
"1": {
|
||||
"value": {
|
||||
"t": "Number",
|
||||
"v": 5.5
|
||||
},
|
||||
"formula": {
|
||||
"text": "SUM(B2:B3)",
|
||||
"array": null
|
||||
},
|
||||
"style": 2
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"len": 7
|
||||
},
|
||||
"cols": {},
|
||||
"rows": {},
|
||||
"default_col_width": 64.0,
|
||||
"default_row_height": 20.0,
|
||||
"merges": [],
|
||||
"freeze": null,
|
||||
"tab_color": null,
|
||||
"visibility": "Visible",
|
||||
"show_gridlines": true,
|
||||
"show_headings": true,
|
||||
"show_formulas": false,
|
||||
"show_zeros": true,
|
||||
"show_outline_symbols": true,
|
||||
"summary_below": true,
|
||||
"summary_right": true,
|
||||
"right_to_left": false,
|
||||
"zoom": 100,
|
||||
"cond_formats": [],
|
||||
"validations": [],
|
||||
"tables": [],
|
||||
"autofilter": null,
|
||||
"comments": {},
|
||||
"hyperlinks": {},
|
||||
"charts": [],
|
||||
"images": [],
|
||||
"shapes": [],
|
||||
"sparklines": [],
|
||||
"slicers": [],
|
||||
"pivots": [],
|
||||
"protection": null,
|
||||
"print": {
|
||||
"orientation": "Portrait",
|
||||
"paper": "Letter",
|
||||
"margins": [
|
||||
0.7,
|
||||
0.7,
|
||||
0.75,
|
||||
0.75,
|
||||
0.3,
|
||||
0.3
|
||||
],
|
||||
"print_area": null,
|
||||
"title_rows": null,
|
||||
"title_cols": null,
|
||||
"scale": 100,
|
||||
"fit_to": null,
|
||||
"gridlines": false,
|
||||
"headings": false,
|
||||
"center_h": false,
|
||||
"center_v": false,
|
||||
"header": "",
|
||||
"footer": "",
|
||||
"row_breaks": [],
|
||||
"col_breaks": [],
|
||||
"different_first": false,
|
||||
"different_odd_even": false,
|
||||
"first_header": "",
|
||||
"first_footer": "",
|
||||
"even_header": "",
|
||||
"even_footer": "",
|
||||
"hf_scale_with_doc": true,
|
||||
"hf_align_with_margins": true,
|
||||
"page_order": "downThenOver"
|
||||
},
|
||||
"view_active": {
|
||||
"row": 0,
|
||||
"col": 0
|
||||
},
|
||||
"view_top_left": {
|
||||
"row": 0,
|
||||
"col": 0
|
||||
},
|
||||
"view": "normal"
|
||||
}
|
||||
],
|
||||
"names": [],
|
||||
"styles": {
|
||||
"styles": [
|
||||
{
|
||||
"font": {
|
||||
"name": "Calibri",
|
||||
"size": 11.0,
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"underline": "None",
|
||||
"strike": false,
|
||||
"color": "Auto",
|
||||
"vert": "Baseline",
|
||||
"charset": null,
|
||||
"family": null,
|
||||
"minor": true
|
||||
},
|
||||
"fill": {
|
||||
"pattern": "None",
|
||||
"fg": "Auto",
|
||||
"bg": "Auto"
|
||||
},
|
||||
"borders": {
|
||||
"left": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"right": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"top": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"bottom": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"diag_down": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"diag_up": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
}
|
||||
},
|
||||
"align": {
|
||||
"h": "General",
|
||||
"v": "Bottom",
|
||||
"wrap": false,
|
||||
"shrink": false,
|
||||
"indent": 0,
|
||||
"rotation": 0,
|
||||
"reading_order": null
|
||||
},
|
||||
"num_fmt": "General",
|
||||
"protection": {
|
||||
"locked": true,
|
||||
"hidden": false
|
||||
},
|
||||
"dxf_stated": {
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"strike": false,
|
||||
"underline": false,
|
||||
"size": false,
|
||||
"name": false,
|
||||
"scheme": null,
|
||||
"protection": false
|
||||
}
|
||||
},
|
||||
{
|
||||
"font": {
|
||||
"name": "Calibri",
|
||||
"size": 11.0,
|
||||
"bold": true,
|
||||
"italic": false,
|
||||
"underline": "None",
|
||||
"strike": false,
|
||||
"color": "Auto",
|
||||
"vert": "Baseline",
|
||||
"charset": null,
|
||||
"family": null,
|
||||
"minor": true
|
||||
},
|
||||
"fill": {
|
||||
"pattern": "None",
|
||||
"fg": "Auto",
|
||||
"bg": "Auto"
|
||||
},
|
||||
"borders": {
|
||||
"left": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"right": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"top": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"bottom": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"diag_down": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"diag_up": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
}
|
||||
},
|
||||
"align": {
|
||||
"h": "General",
|
||||
"v": "Bottom",
|
||||
"wrap": false,
|
||||
"shrink": false,
|
||||
"indent": 0,
|
||||
"rotation": 0,
|
||||
"reading_order": null
|
||||
},
|
||||
"num_fmt": "General",
|
||||
"protection": {
|
||||
"locked": true,
|
||||
"hidden": false
|
||||
},
|
||||
"dxf_stated": {
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"strike": false,
|
||||
"underline": false,
|
||||
"size": false,
|
||||
"name": false,
|
||||
"scheme": null,
|
||||
"protection": false
|
||||
}
|
||||
},
|
||||
{
|
||||
"font": {
|
||||
"name": "Calibri",
|
||||
"size": 11.0,
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"underline": "None",
|
||||
"strike": false,
|
||||
"color": "Auto",
|
||||
"vert": "Baseline",
|
||||
"charset": null,
|
||||
"family": null,
|
||||
"minor": true
|
||||
},
|
||||
"fill": {
|
||||
"pattern": "None",
|
||||
"fg": "Auto",
|
||||
"bg": "Auto"
|
||||
},
|
||||
"borders": {
|
||||
"left": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"right": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"top": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"bottom": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"diag_down": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
},
|
||||
"diag_up": {
|
||||
"style": "None",
|
||||
"color": "Auto"
|
||||
}
|
||||
},
|
||||
"align": {
|
||||
"h": "General",
|
||||
"v": "Bottom",
|
||||
"wrap": false,
|
||||
"shrink": false,
|
||||
"indent": 0,
|
||||
"rotation": 0,
|
||||
"reading_order": null
|
||||
},
|
||||
"num_fmt": "0.00",
|
||||
"protection": {
|
||||
"locked": true,
|
||||
"hidden": false
|
||||
},
|
||||
"dxf_stated": {
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"strike": false,
|
||||
"underline": false,
|
||||
"size": false,
|
||||
"name": false,
|
||||
"scheme": null,
|
||||
"protection": false
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"theme": {
|
||||
"name": "Craft",
|
||||
"colors": [
|
||||
16777215,
|
||||
0,
|
||||
15263976,
|
||||
927809,
|
||||
1400962,
|
||||
15298866,
|
||||
1665828,
|
||||
1023701,
|
||||
10496915,
|
||||
5154606,
|
||||
4618374,
|
||||
9855101
|
||||
],
|
||||
"major_font": "Calibri",
|
||||
"minor_font": "Calibri",
|
||||
"major_font_ea": "",
|
||||
"minor_font_ea": "",
|
||||
"major_font_cs": "",
|
||||
"minor_font_cs": "",
|
||||
"major_font_scripts": [],
|
||||
"minor_font_scripts": []
|
||||
},
|
||||
"date_system": "D1900",
|
||||
"calc": {
|
||||
"mode": "Automatic",
|
||||
"iterative": false,
|
||||
"max_iterations": 100,
|
||||
"max_change": 0.001,
|
||||
"precision_as_displayed": false,
|
||||
"r1c1": false
|
||||
},
|
||||
"active_sheet": 0,
|
||||
"props": {
|
||||
"title": "",
|
||||
"subject": "",
|
||||
"author": "GridCraft User",
|
||||
"company": "",
|
||||
"keywords": "",
|
||||
"description": ""
|
||||
},
|
||||
"protected_structure": false,
|
||||
"custom_lists": [],
|
||||
"cell_styles": [],
|
||||
"vba_project": null,
|
||||
"macros": [
|
||||
{
|
||||
"v": 1,
|
||||
"name": "Fill",
|
||||
"description": "",
|
||||
"inputs": [],
|
||||
"steps": [
|
||||
{
|
||||
"type": "command",
|
||||
"id": "cell.set",
|
||||
"params": {
|
||||
"cell": "C1",
|
||||
"input": "x"
|
||||
}
|
||||
}
|
||||
],
|
||||
"output": {
|
||||
"onConflict": "ask"
|
||||
},
|
||||
"permissions": []
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,448 +0,0 @@
|
||||
{
|
||||
"active_sheet": 0,
|
||||
"calc": {
|
||||
"iterative": false,
|
||||
"max_change": 0.001,
|
||||
"max_iterations": 100,
|
||||
"mode": "Automatic",
|
||||
"precision_as_displayed": false,
|
||||
"r1c1": false
|
||||
},
|
||||
"cell_styles": [],
|
||||
"custom_lists": [],
|
||||
"date_system": "D1900",
|
||||
"macros": [
|
||||
{
|
||||
"description": "",
|
||||
"inputs": [],
|
||||
"name": "Fill",
|
||||
"output": {
|
||||
"onConflict": "ask"
|
||||
},
|
||||
"permissions": [],
|
||||
"steps": [
|
||||
{
|
||||
"id": "cell.set",
|
||||
"params": {
|
||||
"cell": "C1",
|
||||
"input": "x"
|
||||
},
|
||||
"type": "command"
|
||||
}
|
||||
],
|
||||
"v": 1
|
||||
},
|
||||
{
|
||||
"extra": [
|
||||
1,
|
||||
2
|
||||
],
|
||||
"name": "Future",
|
||||
"v": 2
|
||||
}
|
||||
],
|
||||
"names": [],
|
||||
"props": {
|
||||
"author": "GridCraft User",
|
||||
"company": "",
|
||||
"description": "",
|
||||
"keywords": "",
|
||||
"subject": "",
|
||||
"title": ""
|
||||
},
|
||||
"protected_structure": false,
|
||||
"sheets": [
|
||||
{
|
||||
"autofilter": null,
|
||||
"cells": {
|
||||
"bands": {
|
||||
"0": {
|
||||
"rows": {
|
||||
"0": {
|
||||
"0": {
|
||||
"formula": null,
|
||||
"style": 1,
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Item"
|
||||
}
|
||||
},
|
||||
"1": {
|
||||
"formula": null,
|
||||
"style": 1,
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Qty"
|
||||
}
|
||||
}
|
||||
},
|
||||
"1": {
|
||||
"0": {
|
||||
"formula": null,
|
||||
"style": 0,
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Äpfel ✓"
|
||||
}
|
||||
},
|
||||
"1": {
|
||||
"formula": null,
|
||||
"style": 2,
|
||||
"value": {
|
||||
"t": "Number",
|
||||
"v": 3.5
|
||||
}
|
||||
}
|
||||
},
|
||||
"2": {
|
||||
"0": {
|
||||
"formula": null,
|
||||
"style": 0,
|
||||
"value": {
|
||||
"t": "Text",
|
||||
"v": "Pears"
|
||||
}
|
||||
},
|
||||
"1": {
|
||||
"formula": null,
|
||||
"style": 2,
|
||||
"value": {
|
||||
"t": "Number",
|
||||
"v": 2.0
|
||||
}
|
||||
}
|
||||
},
|
||||
"3": {
|
||||
"1": {
|
||||
"formula": {
|
||||
"array": null,
|
||||
"text": "SUM(B2:B3)"
|
||||
},
|
||||
"style": 2,
|
||||
"value": {
|
||||
"t": "Number",
|
||||
"v": 5.5
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"len": 7
|
||||
},
|
||||
"charts": [],
|
||||
"cols": {},
|
||||
"comments": {},
|
||||
"cond_formats": [],
|
||||
"default_col_width": 64.0,
|
||||
"default_row_height": 20.0,
|
||||
"freeze": null,
|
||||
"hyperlinks": {},
|
||||
"images": [],
|
||||
"merges": [],
|
||||
"name": "Sheet1",
|
||||
"pivots": [],
|
||||
"print": {
|
||||
"center_h": false,
|
||||
"center_v": false,
|
||||
"col_breaks": [],
|
||||
"different_first": false,
|
||||
"different_odd_even": false,
|
||||
"even_footer": "",
|
||||
"even_header": "",
|
||||
"first_footer": "",
|
||||
"first_header": "",
|
||||
"fit_to": null,
|
||||
"footer": "",
|
||||
"gridlines": false,
|
||||
"header": "",
|
||||
"headings": false,
|
||||
"hf_align_with_margins": true,
|
||||
"hf_scale_with_doc": true,
|
||||
"margins": [
|
||||
0.699999988079071,
|
||||
0.699999988079071,
|
||||
0.75,
|
||||
0.75,
|
||||
0.30000001192092896,
|
||||
0.30000001192092896
|
||||
],
|
||||
"orientation": "Portrait",
|
||||
"page_order": "downThenOver",
|
||||
"paper": "Letter",
|
||||
"print_area": null,
|
||||
"row_breaks": [],
|
||||
"scale": 100,
|
||||
"title_cols": null,
|
||||
"title_rows": null
|
||||
},
|
||||
"protection": null,
|
||||
"right_to_left": false,
|
||||
"rows": {},
|
||||
"shapes": [],
|
||||
"show_formulas": false,
|
||||
"show_gridlines": true,
|
||||
"show_headings": true,
|
||||
"show_outline_symbols": true,
|
||||
"show_zeros": true,
|
||||
"slicers": [],
|
||||
"sparklines": [],
|
||||
"summary_below": true,
|
||||
"summary_right": true,
|
||||
"tab_color": null,
|
||||
"tables": [],
|
||||
"validations": [],
|
||||
"view": "normal",
|
||||
"view_active": {
|
||||
"col": 0,
|
||||
"row": 0
|
||||
},
|
||||
"view_top_left": {
|
||||
"col": 0,
|
||||
"row": 0
|
||||
},
|
||||
"visibility": "Visible",
|
||||
"zoom": 100
|
||||
}
|
||||
],
|
||||
"styles": {
|
||||
"styles": [
|
||||
{
|
||||
"align": {
|
||||
"h": "General",
|
||||
"indent": 0,
|
||||
"reading_order": null,
|
||||
"rotation": 0,
|
||||
"shrink": false,
|
||||
"v": "Bottom",
|
||||
"wrap": false
|
||||
},
|
||||
"borders": {
|
||||
"bottom": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"diag_down": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"diag_up": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"left": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"right": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"top": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
}
|
||||
},
|
||||
"dxf_stated": {
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"name": false,
|
||||
"protection": false,
|
||||
"scheme": null,
|
||||
"size": false,
|
||||
"strike": false,
|
||||
"underline": false
|
||||
},
|
||||
"fill": {
|
||||
"bg": "Auto",
|
||||
"fg": "Auto",
|
||||
"pattern": "None"
|
||||
},
|
||||
"font": {
|
||||
"bold": false,
|
||||
"charset": null,
|
||||
"color": "Auto",
|
||||
"family": null,
|
||||
"italic": false,
|
||||
"minor": true,
|
||||
"name": "Calibri",
|
||||
"size": 11.0,
|
||||
"strike": false,
|
||||
"underline": "None",
|
||||
"vert": "Baseline"
|
||||
},
|
||||
"num_fmt": "General",
|
||||
"protection": {
|
||||
"hidden": false,
|
||||
"locked": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"align": {
|
||||
"h": "General",
|
||||
"indent": 0,
|
||||
"reading_order": null,
|
||||
"rotation": 0,
|
||||
"shrink": false,
|
||||
"v": "Bottom",
|
||||
"wrap": false
|
||||
},
|
||||
"borders": {
|
||||
"bottom": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"diag_down": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"diag_up": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"left": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"right": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"top": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
}
|
||||
},
|
||||
"dxf_stated": {
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"name": false,
|
||||
"protection": false,
|
||||
"scheme": null,
|
||||
"size": false,
|
||||
"strike": false,
|
||||
"underline": false
|
||||
},
|
||||
"fill": {
|
||||
"bg": "Auto",
|
||||
"fg": "Auto",
|
||||
"pattern": "None"
|
||||
},
|
||||
"font": {
|
||||
"bold": true,
|
||||
"charset": null,
|
||||
"color": "Auto",
|
||||
"family": null,
|
||||
"italic": false,
|
||||
"minor": true,
|
||||
"name": "Calibri",
|
||||
"size": 11.0,
|
||||
"strike": false,
|
||||
"underline": "None",
|
||||
"vert": "Baseline"
|
||||
},
|
||||
"num_fmt": "General",
|
||||
"protection": {
|
||||
"hidden": false,
|
||||
"locked": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"align": {
|
||||
"h": "General",
|
||||
"indent": 0,
|
||||
"reading_order": null,
|
||||
"rotation": 0,
|
||||
"shrink": false,
|
||||
"v": "Bottom",
|
||||
"wrap": false
|
||||
},
|
||||
"borders": {
|
||||
"bottom": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"diag_down": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"diag_up": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"left": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"right": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
},
|
||||
"top": {
|
||||
"color": "Auto",
|
||||
"style": "None"
|
||||
}
|
||||
},
|
||||
"dxf_stated": {
|
||||
"bold": false,
|
||||
"italic": false,
|
||||
"name": false,
|
||||
"protection": false,
|
||||
"scheme": null,
|
||||
"size": false,
|
||||
"strike": false,
|
||||
"underline": false
|
||||
},
|
||||
"fill": {
|
||||
"bg": "Auto",
|
||||
"fg": "Auto",
|
||||
"pattern": "None"
|
||||
},
|
||||
"font": {
|
||||
"bold": false,
|
||||
"charset": null,
|
||||
"color": "Auto",
|
||||
"family": null,
|
||||
"italic": false,
|
||||
"minor": true,
|
||||
"name": "Calibri",
|
||||
"size": 11.0,
|
||||
"strike": false,
|
||||
"underline": "None",
|
||||
"vert": "Baseline"
|
||||
},
|
||||
"num_fmt": "0.00",
|
||||
"protection": {
|
||||
"hidden": false,
|
||||
"locked": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"theme": {
|
||||
"colors": [
|
||||
16777215,
|
||||
0,
|
||||
15263976,
|
||||
927809,
|
||||
1400962,
|
||||
15298866,
|
||||
1665828,
|
||||
1023701,
|
||||
10496915,
|
||||
5154606,
|
||||
4618374,
|
||||
9855101
|
||||
],
|
||||
"major_font": "Calibri",
|
||||
"major_font_cs": "",
|
||||
"major_font_ea": "",
|
||||
"major_font_scripts": [],
|
||||
"minor_font": "Calibri",
|
||||
"minor_font_cs": "",
|
||||
"minor_font_ea": "",
|
||||
"minor_font_scripts": [],
|
||||
"name": "Craft"
|
||||
},
|
||||
"vba_project": null
|
||||
}
|
||||
@@ -9,10 +9,7 @@ use crate::style::{Color, Style};
|
||||
mod pivot;
|
||||
mod print;
|
||||
|
||||
pub use pivot::{
|
||||
PIVOT_INDEXER, PivotCalcField, PivotDataCell, PivotDateGroup, PivotField, PivotFilter, PivotFunc, PivotIndexer, PivotItemRef, PivotLayout,
|
||||
PivotLookup, PivotShowAs, PivotSort, PivotTable, PivotValue, pivot_key,
|
||||
};
|
||||
pub use pivot::{PivotCalcField, PivotDateGroup, PivotField, PivotFilter, PivotFunc, PivotLayout, PivotShowAs, PivotSort, PivotTable, PivotValue};
|
||||
pub use print::{EditRange, HfPage, LineInfo, Orientation, PageOrder, PrintSettings, SheetProtection, password_hash};
|
||||
|
||||
// ---------------------------------------------------------------- tables
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
use gridcraft_core::Value;
|
||||
|
||||
use super::{CellRef, RangeRef};
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
@@ -133,11 +131,6 @@ pub struct PivotTable {
|
||||
pub last_range: Option<RangeRef>,
|
||||
/// Calculated fields, usable in the Values area by name.
|
||||
pub calculated_fields: Vec<PivotCalcField>,
|
||||
/// Where GETPIVOTDATA finds the report's value cells, as of the last refresh. Shared between
|
||||
/// workbook clones (so editing the pivot's sheet doesn't copy it), set on refresh and saved
|
||||
/// with the report, so a reopened unrefreshed pivot still reads the report it stored. Only a
|
||||
/// pivot loaded without one (XLSX) builds it on first use, checked against the stored report.
|
||||
pub data_index: PivotLookup,
|
||||
/// The Σ Values pseudo-field (it exists with two or more value fields) sits in Rows rather
|
||||
/// than Columns (Excel's "values on rows").
|
||||
pub values_on_rows: bool,
|
||||
@@ -156,143 +149,6 @@ pub struct PivotCalcField {
|
||||
pub formula: String,
|
||||
}
|
||||
|
||||
/// One value cell of a computed PivotTable report: the value field, the row and column items
|
||||
/// that locate it (fewer for subtotals, none for the grand total) and where the report shows it.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
|
||||
pub struct PivotDataCell {
|
||||
/// The value field's caption ("Sum of Sales").
|
||||
pub data_field: String,
|
||||
/// The value field's source column ("Sales").
|
||||
pub source_col: String,
|
||||
pub items: Vec<PivotItemRef>,
|
||||
/// Row and column of the cell, counted from the report's top-left cell.
|
||||
pub row: u32,
|
||||
pub col: u32,
|
||||
}
|
||||
|
||||
/// Builds a PivotTable's value cells from its source (`sheet` is the pivot's sheet). The engine
|
||||
/// sets it; the model can't compute reports.
|
||||
pub type PivotIndexer = fn(&crate::Workbook, usize, &PivotTable) -> Result<Vec<PivotDataCell>, String>;
|
||||
pub static PIVOT_INDEXER: std::sync::OnceLock<PivotIndexer> = std::sync::OnceLock::new();
|
||||
|
||||
fn norm(s: &str) -> String {
|
||||
s.trim().to_lowercase()
|
||||
}
|
||||
|
||||
/// One part of a lookup key: length-prefixed, so no label text can imitate a separator.
|
||||
fn key_part(out: &mut String, s: &str) {
|
||||
out.push_str(&s.len().to_string());
|
||||
out.push(':');
|
||||
out.push_str(s);
|
||||
}
|
||||
|
||||
/// The lookup key of a value field with field/item labels (names ignore case and outer blanks).
|
||||
/// Each item is `(field, label, is_bool)`: a Boolean item and a text item with the same label
|
||||
/// are different items.
|
||||
pub fn pivot_key(data_field: &str, items: &[(&str, &str, bool)]) -> String {
|
||||
let mut parts: Vec<String> = items
|
||||
.iter()
|
||||
.map(|(f, l, b)| {
|
||||
let mut p = String::new();
|
||||
key_part(&mut p, &norm(f));
|
||||
key_part(&mut p, &norm(l));
|
||||
p.push(if *b { 'b' } else { 't' });
|
||||
p
|
||||
})
|
||||
.collect();
|
||||
parts.sort_unstable();
|
||||
let mut key = String::new();
|
||||
key_part(&mut key, &norm(data_field));
|
||||
key.push_str(&parts.len().to_string());
|
||||
key.push('|');
|
||||
for p in parts {
|
||||
key.push_str(&p);
|
||||
}
|
||||
key
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct LookupInner {
|
||||
cells: std::sync::OnceLock<Vec<PivotDataCell>>,
|
||||
keys: std::sync::OnceLock<std::collections::HashMap<String, usize>>,
|
||||
}
|
||||
|
||||
/// A PivotTable's GETPIVOTDATA index. Clones share it, so `Workbook` clones per command stay
|
||||
/// cheap however large the report is. The cells are set on refresh or on first use; the hash of
|
||||
/// them is built on the first lookup.
|
||||
#[derive(Clone, Default)]
|
||||
pub struct PivotLookup(std::sync::Arc<LookupInner>);
|
||||
|
||||
impl PivotLookup {
|
||||
/// The value cells, if they were set.
|
||||
pub fn cells(&self) -> Option<&[PivotDataCell]> {
|
||||
self.0.cells.get().map(Vec::as_slice)
|
||||
}
|
||||
|
||||
/// Sets the value cells (the first set wins) and returns them.
|
||||
pub fn set_cells(&self, cells: Vec<PivotDataCell>) -> &[PivotDataCell] {
|
||||
self.0.cells.get_or_init(|| cells)
|
||||
}
|
||||
|
||||
/// The cell with this value field and exactly these items, by hash.
|
||||
pub fn find(&self, data_field: &str, items: &[(&str, &str, bool)]) -> Option<&PivotDataCell> {
|
||||
let cells = self.0.cells.get()?;
|
||||
let keys = self.0.keys.get_or_init(|| {
|
||||
let mut m = std::collections::HashMap::with_capacity(cells.len());
|
||||
for (i, c) in cells.iter().enumerate() {
|
||||
let items: Vec<(&str, &str, bool)> =
|
||||
c.items.iter().map(|it| (it.field.as_str(), it.label.as_str(), matches!(it.value, Value::Bool(_)))).collect();
|
||||
m.entry(pivot_key(&c.data_field, &items)).or_insert(i);
|
||||
m.entry(pivot_key(&c.source_col, &items)).or_insert(i);
|
||||
}
|
||||
m
|
||||
});
|
||||
keys.get(&pivot_key(data_field, items)).and_then(|i| cells.get(*i))
|
||||
}
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for PivotLookup {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(f, "PivotLookup({} cells)", self.cells().map_or(0, <[PivotDataCell]>::len))
|
||||
}
|
||||
}
|
||||
|
||||
/// Saved as the list of value cells (or nothing before the first refresh); the hash is rebuilt.
|
||||
/// An empty list is never saved: it is no index, and restoring one would lock the shared lookup
|
||||
/// against the lazy rebuild that a reopened workbook needs.
|
||||
impl Serialize for PivotLookup {
|
||||
fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
|
||||
self.cells().filter(|cells| !cells.is_empty()).serialize(s)
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de> Deserialize<'de> for PivotLookup {
|
||||
fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
|
||||
let l = PivotLookup::default();
|
||||
if let Some(cells) = Option::<Vec<PivotDataCell>>::deserialize(d)?
|
||||
&& !cells.is_empty()
|
||||
{
|
||||
l.set_cells(cells);
|
||||
}
|
||||
Ok(l)
|
||||
}
|
||||
}
|
||||
|
||||
/// The index is a cache, not part of a PivotTable's identity.
|
||||
impl PartialEq for PivotLookup {
|
||||
fn eq(&self, _: &Self) -> bool {
|
||||
true
|
||||
}
|
||||
}
|
||||
|
||||
/// A row or column field item: the field's source column, the item's label and its value.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
|
||||
pub struct PivotItemRef {
|
||||
pub field: String,
|
||||
pub label: String,
|
||||
pub value: Value,
|
||||
}
|
||||
|
||||
impl Default for PivotTable {
|
||||
fn default() -> Self {
|
||||
PivotTable {
|
||||
@@ -314,65 +170,8 @@ impl Default for PivotTable {
|
||||
show_headers: true,
|
||||
last_range: None,
|
||||
calculated_fields: vec![],
|
||||
data_index: PivotLookup::default(),
|
||||
values_on_rows: false,
|
||||
values_position: None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod pivot_lookup_tests {
|
||||
use super::*;
|
||||
|
||||
fn cell(field: &str, label: &str, value: Value, row: u32) -> PivotDataCell {
|
||||
PivotDataCell {
|
||||
data_field: "Sum of Sales".into(),
|
||||
source_col: "Sales".into(),
|
||||
items: vec![PivotItemRef { field: field.into(), label: label.into(), value }],
|
||||
row,
|
||||
col: 1,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn labels_with_separator_characters_do_not_collide() {
|
||||
let l = PivotLookup::default();
|
||||
// Two different (field, label) pairs that a separator-joined key would make identical.
|
||||
l.set_cells(vec![cell("A\u{2}B", "C", Value::Text("C".into()), 1), cell("A", "B\u{2}C", Value::Text("B\u{2}C".into()), 2)]);
|
||||
assert_eq!(l.find("Sales", &[("A\u{2}B", "C", false)]).unwrap().row, 1);
|
||||
assert_eq!(l.find("Sales", &[("A", "B\u{2}C", false)]).unwrap().row, 2);
|
||||
// A label carrying the old pair separator cannot stand for two items.
|
||||
assert!(l.find("Sales", &[("A", "B", false), ("C", "D", false)]).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn boolean_and_text_items_with_one_label_are_different_items() {
|
||||
let l = PivotLookup::default();
|
||||
l.set_cells(vec![cell("Flag", "TRUE", Value::Text("TRUE".into()), 1), cell("Flag", "TRUE", Value::Bool(true), 2)]);
|
||||
assert_eq!(l.find("Sales", &[("Flag", "TRUE", true)]).unwrap().row, 2);
|
||||
assert_eq!(l.find("Sales", &[("Flag", "TRUE", false)]).unwrap().row, 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn index_round_trips_through_serde() {
|
||||
let l = PivotLookup::default();
|
||||
l.set_cells(vec![cell("Region", "East", Value::Text("East".into()), 1)]);
|
||||
let back: PivotLookup = serde_json::from_str(&serde_json::to_string(&l).unwrap()).unwrap();
|
||||
assert_eq!(back.find("Sales", &[("Region", "East", false)]).unwrap().row, 1);
|
||||
let none: PivotLookup = serde_json::from_str(&serde_json::to_string(&PivotLookup::default()).unwrap()).unwrap();
|
||||
assert!(none.cells().is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_empty_lookup_is_saved_as_no_index() {
|
||||
// An empty cell list is no index, so it must not be saved as an empty one: restoring an
|
||||
// empty index counts as an initialized lookup, which blocks the lazy rebuild.
|
||||
let l = PivotLookup::default();
|
||||
l.set_cells(vec![]);
|
||||
let saved = serde_json::to_string(&l).unwrap();
|
||||
assert_eq!(saved, "null", "an empty lookup saves no index: {saved}");
|
||||
let back: PivotLookup = serde_json::from_str("[]").unwrap();
|
||||
assert!(back.cells().is_none(), "an empty saved list restores no index");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,18 +3,10 @@ name = "gridcraft-pdf"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
description = "GridCraft PDF 1.7 writer with shaped Arabic text, vector drawing and RGBA images"
|
||||
description = "GridCraft's tiny self-contained PDF 1.7 writer (standard 14 fonts, vector drawing, RGBA images)"
|
||||
readme = "README.md"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
craft-stream-codecs.workspace = true
|
||||
harfrust = "=0.12.0"
|
||||
skrifa = { workspace = true }
|
||||
unicode-bidi = "=0.3.18"
|
||||
|
||||
[build-dependencies]
|
||||
sha2 = { workspace = true }
|
||||
skrifa = { workspace = true }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# gridcraft-pdf
|
||||
|
||||
A small PDF 1.7 writer for shaped Arabic text, vector drawing and RGBA images.
|
||||
A small, dependency-free PDF 1.7 writer for vector drawing and RGBA images.
|
||||
|
||||
## API migration
|
||||
|
||||
|
||||
@@ -1,88 +0,0 @@
|
||||
use std::fmt::Write as _;
|
||||
|
||||
fn main() -> Result<(), String> {
|
||||
arabic_fonts()
|
||||
}
|
||||
|
||||
/// Embed only Arabic fallback faces from the optional, separately licensed font bundle.
|
||||
fn arabic_fonts() -> Result<(), String> {
|
||||
use std::path::PathBuf;
|
||||
println!("cargo::rerun-if-env-changed=CRAFT_FONTS_DIR");
|
||||
println!("cargo::rerun-if-env-changed=CRAFT_FONTS_REQUIRED");
|
||||
let required = std::env::var_os("CRAFT_FONTS_REQUIRED").is_some();
|
||||
let entries = match std::env::var_os("CRAFT_FONTS_DIR").map(PathBuf::from) {
|
||||
Some(dir) => arabic_font_entries(&dir),
|
||||
None if required => Err("CRAFT_FONTS_REQUIRED needs CRAFT_FONTS_DIR".into()),
|
||||
None => Ok(String::new()),
|
||||
};
|
||||
let entries = match entries {
|
||||
Ok(entries) => entries,
|
||||
Err(e) if required => return Err(e),
|
||||
Err(e) => {
|
||||
println!("cargo::warning=building without bundled Arabic fonts: {e}");
|
||||
String::new()
|
||||
}
|
||||
};
|
||||
let out = PathBuf::from(std::env::var_os("OUT_DIR").unwrap_or_default()).join("arabic_fonts.rs");
|
||||
std::fs::write(&out, format!("pub(crate) static ARABIC_FONTS: &[(&str, &[u8])] = &[\n{entries}];\n"))
|
||||
.map_err(|e| format!("writing {}: {e}", out.display()))
|
||||
}
|
||||
|
||||
fn arabic_font_entries(dir: &std::path::Path) -> Result<String, String> {
|
||||
use sha2::{Digest, Sha256};
|
||||
use skrifa::MetadataProvider;
|
||||
let root = dir.canonicalize().map_err(|e| format!("craft-fonts directory: {e}"))?;
|
||||
let manifest = root.join("fonts/manifest.txt");
|
||||
println!("cargo::rerun-if-changed={}", manifest.display());
|
||||
let text = String::from_utf8(read_font_input(&manifest, 1 << 20)?).map_err(|e| e.to_string())?;
|
||||
let mut out = String::new();
|
||||
let mut has_regular = false;
|
||||
for (line_number, line) in text.lines().enumerate() {
|
||||
let line = line.trim();
|
||||
if line.is_empty() || line.starts_with('#') {
|
||||
continue;
|
||||
}
|
||||
let fields: Vec<_> = line.split(" | ").map(str::trim).collect();
|
||||
let [family, style, file, scripts, _licence, licence_file, checksum, _source] = fields.as_slice() else {
|
||||
return Err(format!("malformed craft-fonts manifest line {}", line_number + 1));
|
||||
};
|
||||
if !scripts.split(',').any(|script| script.trim() == "Arab") {
|
||||
continue;
|
||||
}
|
||||
let path = root.join(file).canonicalize().map_err(|e| format!("{file}: {e}"))?;
|
||||
let licence = root.join(licence_file).canonicalize().map_err(|e| format!("{licence_file}: {e}"))?;
|
||||
if !path.starts_with(&root) || !licence.starts_with(&root) {
|
||||
return Err("craft-fonts paths must stay inside the checkout".into());
|
||||
}
|
||||
println!("cargo::rerun-if-changed={}", path.display());
|
||||
println!("cargo::rerun-if-changed={}", licence.display());
|
||||
let bytes = read_font_input(&path, 64 << 20)?;
|
||||
if Sha256::digest(&bytes).iter().map(|byte| format!("{byte:02x}")).collect::<String>() != *checksum {
|
||||
return Err(format!("checksum mismatch for {file}"));
|
||||
}
|
||||
let font = skrifa::FontRef::from_index(&bytes, 0).map_err(|e| format!("invalid Arabic font {file}: {e}"))?;
|
||||
if !"العربية١٢٣".chars().all(|ch| font.charmap().map(ch).is_some()) {
|
||||
return Err(format!("{file} lacks Arabic glyphs"));
|
||||
}
|
||||
let _ = writeln!(out, " ({:?}, include_bytes!({:?})),", format!("craft:{family}:{style}"), path);
|
||||
has_regular |= *style != "Bold";
|
||||
}
|
||||
if out.is_empty() {
|
||||
return Err("craft-fonts manifest contains no Arabic face; update the checkout".into());
|
||||
}
|
||||
if !has_regular {
|
||||
return Err("craft-fonts manifest has only bold Arabic faces; regular text needs a regular or variable face".into());
|
||||
}
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
fn read_font_input(path: &std::path::Path, limit: u64) -> Result<Vec<u8>, String> {
|
||||
use std::io::Read as _;
|
||||
let file = std::fs::File::open(path).map_err(|e| format!("{}: {e}", path.display()))?;
|
||||
let mut bytes = Vec::new();
|
||||
file.take(limit + 1).read_to_end(&mut bytes).map_err(|e| format!("{}: {e}", path.display()))?;
|
||||
if bytes.len() as u64 > limit {
|
||||
return Err(format!("{} exceeds the font input size limit", path.display()));
|
||||
}
|
||||
Ok(bytes)
|
||||
}
|
||||
@@ -1,669 +0,0 @@
|
||||
//! Arabic shaping and subset Type3 fonts. Outlines use the same variation coordinates as the
|
||||
//! shaper; ActualText preserves the logical source independently of visual glyph order.
|
||||
use std::{borrow::Cow, collections::BTreeMap, fmt::Write as _, sync::OnceLock};
|
||||
|
||||
use harfrust::{Direction, ShaperData, ShaperInstance, UnicodeBuffer};
|
||||
use skrifa::{
|
||||
FontRef, MetadataProvider,
|
||||
instance::Size,
|
||||
outline::{DrawSettings, OutlinePen},
|
||||
};
|
||||
use unicode_bidi::BidiInfo;
|
||||
|
||||
use crate::{CID_FONT, Error, Font, TextDirection, dict_obj, n, needs_cid, pdf_string, pdf_utf16_string, stream_obj};
|
||||
|
||||
include!(concat!(env!("OUT_DIR"), "/arabic_fonts.rs"));
|
||||
|
||||
const MAX_TEXT_BYTES: usize = 128 * 1024;
|
||||
const MAX_OUTLINE_BYTES: usize = 256 * 1024;
|
||||
const MAX_SUBSET_BYTES: usize = 64 * 1024 * 1024;
|
||||
const MAX_SUBSET_GLYPHS: usize = 16_384;
|
||||
const SYNTHETIC_BOLD_STROKE: f32 = 30.0;
|
||||
|
||||
/// How `text` set in `font` is drawn. Symbol keeps its own one-run encoding, and Arabic without
|
||||
/// an installed or bundled face falls back to the standard fonts.
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub(crate) enum Shaping {
|
||||
Plain,
|
||||
Shaped,
|
||||
NoFont,
|
||||
}
|
||||
|
||||
pub(crate) fn shaping(font: Font, text: &str) -> Shaping {
|
||||
if font == Font::Symbol || !needed(text) {
|
||||
return Shaping::Plain;
|
||||
}
|
||||
match face(bold(font)) {
|
||||
Ok(None) => Shaping::NoFont,
|
||||
Ok(Some(_)) | Err(_) => Shaping::Shaped,
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn shaped(font: Font, text: &str) -> bool {
|
||||
shaping(font, text) == Shaping::Shaped
|
||||
}
|
||||
|
||||
pub(crate) fn needed(text: &str) -> bool {
|
||||
text.chars().any(|ch| matches!(ch as u32, 0x0600..=0x06ff | 0x0750..=0x077f | 0x0870..=0x089f | 0x08a0..=0x08ff | 0xfb50..=0xfdff | 0xfe70..=0xfefc | 0x10e60..=0x10e7f | 0x1ee00..=0x1eeff))
|
||||
}
|
||||
|
||||
fn bold(font: Font) -> bool {
|
||||
matches!(
|
||||
font,
|
||||
Font::HelveticaBold | Font::HelveticaBoldOblique | Font::TimesBold | Font::TimesBoldItalic | Font::CourierBold | Font::CourierBoldOblique
|
||||
)
|
||||
}
|
||||
|
||||
fn italic(font: Font) -> bool {
|
||||
matches!(
|
||||
font,
|
||||
Font::HelveticaOblique
|
||||
| Font::HelveticaBoldOblique
|
||||
| Font::TimesItalic
|
||||
| Font::TimesBoldItalic
|
||||
| Font::CourierOblique
|
||||
| Font::CourierBoldOblique
|
||||
)
|
||||
}
|
||||
|
||||
struct Face {
|
||||
bytes: Cow<'static, [u8]>,
|
||||
data: ShaperData,
|
||||
instance: ShaperInstance,
|
||||
synthetic_bold: bool,
|
||||
}
|
||||
|
||||
impl Face {
|
||||
fn new(bytes: Cow<'static, [u8]>, bold: bool) -> Result<Self, Error> {
|
||||
let font = FontRef::from_index(&bytes, 0).map_err(|e| Error(format!("Invalid Arabic PDF font: {e}")))?;
|
||||
if !"العربية١٢٣".chars().all(|ch| font.charmap().map(ch).is_some()) {
|
||||
return Err(Error("The PDF font lacks Arabic glyphs".into()));
|
||||
}
|
||||
let data = ShaperData::new(&font);
|
||||
let instance = ShaperInstance::from_variations(&font, [("wght", if bold { 700.0 } else { 400.0 })]);
|
||||
Ok(Self { bytes, data, instance, synthetic_bold: false })
|
||||
}
|
||||
|
||||
fn font(&self) -> Result<FontRef<'_>, Error> {
|
||||
FontRef::from_index(&self.bytes, 0).map_err(|e| Error(format!("Invalid Arabic PDF font: {e}")))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) fn bold_face_is_synthetic() -> bool {
|
||||
face(true).is_ok_and(|face| face.is_some_and(|face| face.synthetic_bold))
|
||||
}
|
||||
|
||||
/// The Arabic face for a weight, or `None` when none is bundled or installed. The search runs
|
||||
/// once per weight, so measuring text never rescans the font directories.
|
||||
fn face(is_bold: bool) -> Result<Option<&'static Face>, Error> {
|
||||
static REGULAR: OnceLock<Result<Option<Face>, Error>> = OnceLock::new();
|
||||
static BOLD: OnceLock<Result<Option<Face>, Error>> = OnceLock::new();
|
||||
let cache = if is_bold { &BOLD } else { ®ULAR };
|
||||
cache.get_or_init(|| find_face(ARABIC_FONTS, &system_font_dirs(), is_bold)).as_ref().map(Option::as_ref).map_err(Error::clone)
|
||||
}
|
||||
|
||||
fn loaded_face(font: Font) -> Result<&'static Face, Error> {
|
||||
face(bold(font))?.ok_or_else(|| Error("Arabic PDF export needs Noto Sans Arabic".into()))
|
||||
}
|
||||
|
||||
fn bundled_match(fonts: &[(&str, &'static [u8])], is_bold: bool) -> Option<&'static [u8]> {
|
||||
fonts
|
||||
.iter()
|
||||
.find(|(name, bytes)| if is_bold { name.ends_with(":Bold") || has_weight_axis(bytes) } else { !name.ends_with(":Bold") })
|
||||
.map(|&(_, bytes)| bytes)
|
||||
}
|
||||
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
fn system_font_dirs() -> Vec<std::path::PathBuf> {
|
||||
use std::path::PathBuf;
|
||||
let mut dirs: Vec<PathBuf> = [
|
||||
"/usr/share/fonts/noto",
|
||||
"/usr/share/fonts/google-noto-vf",
|
||||
"/usr/share/fonts/truetype/noto",
|
||||
"/usr/share/fonts/TTF",
|
||||
"/usr/local/share/fonts",
|
||||
"/usr/local/share/fonts/noto",
|
||||
"/usr/local/share/fonts/TTF",
|
||||
"/Library/Fonts",
|
||||
]
|
||||
.into_iter()
|
||||
.map(Into::into)
|
||||
.collect();
|
||||
if let Some(home) = std::env::var_os("HOME").or_else(|| std::env::var_os("USERPROFILE")) {
|
||||
let home = PathBuf::from(home);
|
||||
dirs.extend([home.join(".local/share/fonts"), home.join(".fonts"), home.join("Library/Fonts")]);
|
||||
}
|
||||
if let Some(root) = std::env::var_os("WINDIR") {
|
||||
dirs.push(PathBuf::from(root).join("Fonts"));
|
||||
}
|
||||
if let Some(root) = std::env::var_os("LOCALAPPDATA") {
|
||||
dirs.push(PathBuf::from(root).join("Microsoft/Windows/Fonts"));
|
||||
}
|
||||
dirs
|
||||
}
|
||||
|
||||
#[cfg(target_arch = "wasm32")]
|
||||
fn system_font_dirs() -> Vec<std::path::PathBuf> {
|
||||
Vec::new()
|
||||
}
|
||||
|
||||
fn find_face(bundled: &[(&str, &'static [u8])], dirs: &[std::path::PathBuf], is_bold: bool) -> Result<Option<Face>, Error> {
|
||||
use std::io::Read as _;
|
||||
if let Some(bytes) = bundled_match(bundled, is_bold) {
|
||||
return Face::new(Cow::Borrowed(bytes), is_bold).map(Some);
|
||||
}
|
||||
let filename = if is_bold { "NotoSansArabic-Bold.ttf" } else { "NotoSansArabic-Regular.ttf" };
|
||||
for dir in dirs {
|
||||
for name in ["NotoSansArabic.ttf", "NotoSansArabic[wght].ttf", filename] {
|
||||
let path = dir.join(name);
|
||||
let file = match std::fs::File::open(&path) {
|
||||
Ok(file) => file,
|
||||
Err(e) if e.kind() == std::io::ErrorKind::NotFound => continue,
|
||||
Err(e) => return Err(Error(format!("Cannot read Arabic PDF font {}: {e}", path.display()))),
|
||||
};
|
||||
let mut bytes = Vec::new();
|
||||
file.take((64 << 20) + 1).read_to_end(&mut bytes).map_err(|e| Error(format!("Cannot read Arabic PDF font: {e}")))?;
|
||||
if bytes.len() > 64 << 20 {
|
||||
return Err(Error("Arabic PDF font exceeds 64 MiB".into()));
|
||||
}
|
||||
if is_bold && name != filename && !has_weight_axis(&bytes) {
|
||||
continue;
|
||||
}
|
||||
return Face::new(Cow::Owned(bytes), is_bold).map(Some);
|
||||
}
|
||||
}
|
||||
if let Some((name, bytes)) = bundled_fallback(bundled, is_bold) {
|
||||
let mut face = Face::new(Cow::Borrowed(bytes), is_bold)?;
|
||||
face.synthetic_bold = needs_synthetic_bold(name, bytes, is_bold);
|
||||
return Ok(Some(face));
|
||||
}
|
||||
Ok(None)
|
||||
}
|
||||
|
||||
/// The bundled face to use when no face matches the requested weight: regular text never borrows a bold face.
|
||||
fn bundled_fallback<'a>(fonts: &[(&'a str, &'static [u8])], is_bold: bool) -> Option<(&'a str, &'static [u8])> {
|
||||
fonts.iter().find(|(name, _)| is_bold || !name.ends_with(":Bold")).copied()
|
||||
}
|
||||
|
||||
/// A bold request served by a static regular face is emboldened by stroking its outlines.
|
||||
fn needs_synthetic_bold(name: &str, bytes: &[u8], is_bold: bool) -> bool {
|
||||
is_bold && !name.ends_with(":Bold") && !has_weight_axis(bytes)
|
||||
}
|
||||
|
||||
fn has_weight_axis(bytes: &[u8]) -> bool {
|
||||
FontRef::from_index(bytes, 0).is_ok_and(|font| font.axes().iter().any(|axis| axis.tag() == skrifa::raw::types::Tag::new(b"wght")))
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub(crate) enum Item {
|
||||
Glyph { id: u32, x: f32, y: f32, source: String },
|
||||
Latin { text: String, x: f32 },
|
||||
Cid { text: String, x: f32 },
|
||||
}
|
||||
|
||||
pub(crate) struct Layout {
|
||||
pub items: Vec<Item>,
|
||||
pub width: f32,
|
||||
}
|
||||
|
||||
/// Positions are in 1/1000 em, matching the Type3 font matrix.
|
||||
pub(crate) fn layout(font: Font, text: &str, direction: TextDirection) -> Result<Layout, Error> {
|
||||
if text.len() > MAX_TEXT_BYTES {
|
||||
return Err(Error("Arabic PDF text exceeds the 128 KiB per-line limit".into()));
|
||||
}
|
||||
let direction = if direction == TextDirection::Context { direction.resolve(text) } else { direction };
|
||||
let face = loaded_face(font)?;
|
||||
let raw = face.font()?;
|
||||
let shaper = face.data.shaper(&raw).instance(Some(&face.instance)).build();
|
||||
let units = shaper.units_per_em();
|
||||
if units <= 0 {
|
||||
return Err(Error("Arabic PDF font has invalid units per em".into()));
|
||||
}
|
||||
let scale = 1000.0 / units as f32;
|
||||
let single_line: String = text.chars().map(|ch| if is_paragraph_break(ch) { ' ' } else { ch }).collect();
|
||||
let text = single_line.as_str();
|
||||
let bidi = BidiInfo::new(text, direction.level());
|
||||
let mut layout = Layout { items: Vec::new(), width: 0.0 };
|
||||
for para in &bidi.paragraphs {
|
||||
let (levels, runs) = bidi.visual_runs(para, para.range.clone());
|
||||
for run in runs {
|
||||
let rtl = levels.get(run.start).is_some_and(|level| level.is_rtl());
|
||||
let run_text = text.get(run.clone()).ok_or_else(|| Error("Invalid PDF text boundary".into()))?;
|
||||
let mut spans = Vec::new();
|
||||
let mut start = 0;
|
||||
let mut embedded = None;
|
||||
for (i, ch) in run_text.char_indices() {
|
||||
let supported = embeddable(raw.charmap().map(ch).is_some(), ch);
|
||||
if embedded.is_some_and(|v| v != supported) {
|
||||
spans.push((start..i, embedded.unwrap_or(false)));
|
||||
start = i;
|
||||
}
|
||||
embedded = Some(supported);
|
||||
}
|
||||
spans.push((start..run_text.len(), embedded.unwrap_or(false)));
|
||||
if rtl {
|
||||
spans.reverse();
|
||||
}
|
||||
for (span, embedded) in spans {
|
||||
let part = run_text.get(span.clone()).ok_or_else(|| Error("Invalid PDF text boundary".into()))?;
|
||||
if !embedded {
|
||||
let part = part.chars().map(|ch| if is_line_break(ch) { ' ' } else { ch });
|
||||
let part: Vec<char> = if rtl { part.rev().map(mirror_ansi).collect() } else { part.collect() };
|
||||
for run in part.chunk_by(|a, b| needs_cid(*a) == needs_cid(*b)) {
|
||||
let (text, x) = (run.iter().collect(), layout.width);
|
||||
layout.width += run.iter().map(|&ch| f32::from(font.char_width(ch))).sum::<f32>();
|
||||
layout.items.push(if run.first().is_some_and(|&ch| needs_cid(ch)) { Item::Cid { text, x } } else { Item::Latin { text, x } });
|
||||
}
|
||||
continue;
|
||||
}
|
||||
let mut buffer = UnicodeBuffer::new();
|
||||
buffer.push_str(part);
|
||||
buffer.set_pre_context(run_text.get(..span.start).unwrap_or_default());
|
||||
buffer.set_post_context(run_text.get(span.end..).unwrap_or_default());
|
||||
buffer.set_direction(if rtl { Direction::RightToLeft } else { Direction::LeftToRight });
|
||||
buffer.set_flags(harfrust::BufferFlags::REMOVE_DEFAULT_IGNORABLES);
|
||||
if needed(part) {
|
||||
buffer.set_script(harfrust::script::ARABIC);
|
||||
}
|
||||
buffer.guess_segment_properties();
|
||||
let shaped = shaper.shape(buffer, harfrust::ShapeOptions::new());
|
||||
let mut clusters: Vec<_> = shaped.glyph_infos().iter().map(|g| g.cluster as usize).collect();
|
||||
clusters.push(part.len());
|
||||
clusters.sort_unstable();
|
||||
clusters.dedup();
|
||||
let mut previous_cluster = None;
|
||||
for (info, pos) in shaped.glyph_infos().iter().zip(shaped.glyph_positions()) {
|
||||
if info.glyph_id == 0 {
|
||||
return Err(Error("The Arabic PDF font produced a missing glyph".into()));
|
||||
}
|
||||
let cluster = info.cluster as usize;
|
||||
let source = if previous_cluster == Some(cluster) {
|
||||
String::new()
|
||||
} else {
|
||||
let index = clusters.binary_search(&cluster).map_err(|_| Error("Invalid PDF glyph cluster".into()))?;
|
||||
let end = clusters.get(index + 1).copied().ok_or_else(|| Error("Invalid PDF glyph cluster".into()))?;
|
||||
part.get(cluster..end).ok_or_else(|| Error("Invalid PDF glyph cluster".into()))?.to_string()
|
||||
};
|
||||
previous_cluster = Some(cluster);
|
||||
layout.items.push(Item::Glyph {
|
||||
id: info.glyph_id,
|
||||
x: layout.width + pos.x_offset as f32 * scale,
|
||||
y: pos.y_offset as f32 * scale,
|
||||
source,
|
||||
});
|
||||
layout.width += pos.x_advance as f32 * scale;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(layout)
|
||||
}
|
||||
|
||||
pub(crate) fn vertical_extents(font: Font, text: &str, direction: TextDirection) -> Result<(f32, f32), Error> {
|
||||
let layout = layout(font, text, direction)?;
|
||||
let face = loaded_face(font)?;
|
||||
let raw = face.font()?;
|
||||
let metrics = raw.glyph_metrics(Size::new(1000.0), skrifa::instance::LocationRef::new(face.instance.coords()));
|
||||
let (mut ascent, mut descent) = (0.0_f32, 0.0_f32);
|
||||
for item in layout.items {
|
||||
match item {
|
||||
Item::Glyph { id, y, .. } => {
|
||||
let (bottom, top) = if let Some(bounds) = metrics.bounds(id.into()) {
|
||||
(bounds.y_min, bounds.y_max)
|
||||
} else {
|
||||
let glyph = raw.outline_glyphs().get(id.into()).ok_or_else(|| Error("Missing Arabic PDF glyph outline".into()))?;
|
||||
let mut pen = Pen::default();
|
||||
glyph
|
||||
.draw(DrawSettings::unhinted(Size::new(1000.0), skrifa::instance::LocationRef::new(face.instance.coords())), &mut pen)
|
||||
.map_err(|e| Error(format!("Cannot measure Arabic PDF glyph: {e}")))?;
|
||||
if pen.full {
|
||||
return Err(Error("Arabic PDF glyph exceeds the outline size limit".into()));
|
||||
}
|
||||
(pen.bounds[1], pen.bounds[3])
|
||||
};
|
||||
ascent = ascent.max(y + top);
|
||||
descent = descent.max(-y - bottom);
|
||||
}
|
||||
Item::Latin { .. } | Item::Cid { .. } => {
|
||||
ascent = ascent.max(800.0);
|
||||
descent = descent.max(220.0);
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok((ascent, descent))
|
||||
}
|
||||
|
||||
/// Whether standard-font `text` is drawn in its logical order, unchanged.
|
||||
pub(crate) fn is_logical_order(text: &str, direction: TextDirection) -> bool {
|
||||
direction != TextDirection::RightToLeft && !text.chars().any(is_control)
|
||||
}
|
||||
|
||||
/// Bidi reordering for standard-font text requires no optional Arabic font.
|
||||
pub(crate) fn latin_visual(text: &str, direction: TextDirection) -> Result<Cow<'_, str>, Error> {
|
||||
if is_logical_order(text, direction) {
|
||||
return Ok(Cow::Borrowed(text));
|
||||
}
|
||||
if text.len() > MAX_TEXT_BYTES {
|
||||
return Err(Error("Bidirectional PDF text exceeds the 128 KiB per-line limit".into()));
|
||||
}
|
||||
let single_line: String = text.chars().map(|ch| if is_paragraph_break(ch) { ' ' } else { ch }).collect();
|
||||
let text = single_line.as_str();
|
||||
let bidi = BidiInfo::new(text, direction.level());
|
||||
let mut out = String::with_capacity(text.len());
|
||||
for para in &bidi.paragraphs {
|
||||
let (levels, runs) = bidi.visual_runs(para, para.range.clone());
|
||||
for run in runs {
|
||||
let part = text.get(run.clone()).unwrap_or_default();
|
||||
if levels.get(run.start).is_some_and(|level| level.is_rtl()) {
|
||||
out.extend(part.chars().rev().filter(|ch| !is_control(*ch)).map(mirror_ansi));
|
||||
} else {
|
||||
out.extend(part.chars().filter(|ch| !is_control(*ch)));
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(Cow::Owned(out))
|
||||
}
|
||||
|
||||
fn mirror_ansi(ch: char) -> char {
|
||||
match ch {
|
||||
'(' => ')',
|
||||
')' => '(',
|
||||
'[' => ']',
|
||||
']' => '[',
|
||||
'{' => '}',
|
||||
'}' => '{',
|
||||
'<' => '>',
|
||||
'>' => '<',
|
||||
'«' => '»',
|
||||
'»' => '«',
|
||||
'‹' => '›',
|
||||
'›' => '‹',
|
||||
other => other,
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether a character is drawn from the embedded Arabic face. Line breaks never are, so the
|
||||
/// fallback path draws them as spaces even when the face maps them.
|
||||
fn embeddable(mapped: bool, ch: char) -> bool {
|
||||
(mapped || is_control(ch)) && !is_line_break(ch)
|
||||
}
|
||||
|
||||
fn is_line_break(ch: char) -> bool {
|
||||
matches!(ch, '\n' | '\r' | '\u{2028}' | '\u{2029}')
|
||||
}
|
||||
|
||||
/// Bidi paragraph separators (class B). A drawn line is one paragraph: left in, they would split it
|
||||
/// into paragraphs laid out left to right, swapping the parts of a right-to-left line.
|
||||
fn is_paragraph_break(ch: char) -> bool {
|
||||
matches!(ch, '\n' | '\r' | '\u{1C}'..='\u{1E}' | '\u{85}' | '\u{2029}')
|
||||
}
|
||||
|
||||
fn is_control(ch: char) -> bool {
|
||||
matches!(ch, '\u{061c}' | '\u{200c}'..='\u{200f}' | '\u{202a}'..='\u{202e}' | '\u{2066}'..='\u{2069}')
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
pub(crate) struct Subset {
|
||||
keys: BTreeMap<(u32, bool, bool, String), usize>,
|
||||
glyphs: Vec<Glyph>,
|
||||
bytes: usize,
|
||||
/// Some text on the page set a run in the CJK CID font, so the page must declare it.
|
||||
pub(crate) uses_cid: bool,
|
||||
}
|
||||
|
||||
struct Glyph {
|
||||
path: String,
|
||||
width: f32,
|
||||
source: String,
|
||||
bounds: [f32; 4],
|
||||
emboldened: bool,
|
||||
}
|
||||
|
||||
/// The Type3 glyph procedure: a filled outline, also stroked in the text colour when emboldened.
|
||||
fn glyph_procedure(glyph: &Glyph) -> String {
|
||||
if glyph.emboldened {
|
||||
format!("{} 0 d0\n{} w 1 j\n{}B\n", n(glyph.width), n(SYNTHETIC_BOLD_STROKE), glyph.path)
|
||||
} else {
|
||||
format!("{} 0 d0\n{}f\n", n(glyph.width), glyph.path)
|
||||
}
|
||||
}
|
||||
|
||||
impl Subset {
|
||||
fn insert(&mut self, font: Font, id: u32, source: String) -> Result<usize, Error> {
|
||||
let key = (id, bold(font), italic(font), source.clone());
|
||||
if let Some(index) = self.keys.get(&key) {
|
||||
return Ok(*index);
|
||||
}
|
||||
if self.glyphs.len() >= MAX_SUBSET_GLYPHS {
|
||||
return Err(Error("PDF page has too many distinct Arabic glyphs".into()));
|
||||
}
|
||||
let face = loaded_face(font)?;
|
||||
let raw = face.font()?;
|
||||
let location = skrifa::instance::LocationRef::new(face.instance.coords());
|
||||
let glyph = raw.outline_glyphs().get(id.into()).ok_or_else(|| Error("Missing Arabic PDF glyph outline".into()))?;
|
||||
let width =
|
||||
raw.glyph_metrics(Size::new(1000.0), location).advance_width(id.into()).ok_or_else(|| Error("Missing Arabic PDF glyph width".into()))?;
|
||||
let mut pen = Pen { shear: if italic(font) { 0.212_556_56 } else { 0.0 }, ..Default::default() };
|
||||
glyph.draw(DrawSettings::unhinted(Size::new(1000.0), location), &mut pen).map_err(|e| Error(format!("Cannot draw Arabic PDF glyph: {e}")))?;
|
||||
if pen.full || self.bytes.saturating_add(pen.path.len()).saturating_add(source.len().saturating_mul(2)) > MAX_SUBSET_BYTES {
|
||||
return Err(Error("Arabic PDF outlines exceed the page size limit".into()));
|
||||
}
|
||||
let index = self.glyphs.len();
|
||||
self.bytes += pen.path.len() + source.len() * 2;
|
||||
let emboldened = face.synthetic_bold;
|
||||
let grow = if emboldened { SYNTHETIC_BOLD_STROKE / 2.0 } else { 0.0 };
|
||||
let [x0, y0, x1, y1] = pen.bounds;
|
||||
self.glyphs.push(Glyph { path: pen.path, width, source, bounds: [x0 - grow, y0 - grow, x1 + grow, y1 + grow], emboldened });
|
||||
self.keys.insert(key, index);
|
||||
Ok(index)
|
||||
}
|
||||
|
||||
pub(crate) fn text(&mut self, font: Font, text: &str, size: f32, direction: TextDirection) -> Result<String, Error> {
|
||||
let layout = layout(font, text, direction)?;
|
||||
let mut out = format!("/Span << /ActualText {} >> BDC\nBT\n", unicode_string(text, true));
|
||||
for item in layout.items {
|
||||
match item {
|
||||
Item::Glyph { id, x, y, source } => {
|
||||
let index = self.insert(font, id, source)?;
|
||||
let _ = writeln!(
|
||||
out,
|
||||
"/A{} {} Tf 1 0 0 1 {} {} Tm <{:02X}> Tj",
|
||||
index / 255 + 1,
|
||||
n(size),
|
||||
n(x * size / 1000.0),
|
||||
n(y * size / 1000.0),
|
||||
index % 255 + 1
|
||||
);
|
||||
}
|
||||
Item::Latin { text, x } => {
|
||||
let _ = writeln!(out, "/F{} {} Tf 1 0 0 1 {} 0 Tm {} Tj", font.index() + 1, n(size), n(x * size / 1000.0), pdf_string(&text));
|
||||
}
|
||||
Item::Cid { text, x } => {
|
||||
self.uses_cid = true;
|
||||
let _ = writeln!(out, "/F{} {} Tf 1 0 0 1 {} 0 Tm {} Tj", CID_FONT + 1, n(size), n(x * size / 1000.0), pdf_utf16_string(&text));
|
||||
}
|
||||
}
|
||||
}
|
||||
out.push_str("ET\nEMC");
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
/// Writes the subset fonts into `out` and returns their page resource entries.
|
||||
pub(crate) fn write_objects(&self, next: &mut u32, out: &mut Vec<u8>, offsets: &mut Vec<usize>) -> String {
|
||||
let mut resources = String::new();
|
||||
for (batch, glyphs) in self.glyphs.chunks(255).enumerate() {
|
||||
let id = *next;
|
||||
let cmap_id = id + 1;
|
||||
*next += 2;
|
||||
let mut procs = String::new();
|
||||
let mut names = String::new();
|
||||
let mut widths = String::new();
|
||||
let mut mappings = Vec::new();
|
||||
let mut bounds = [0.0_f32; 4];
|
||||
for (i, glyph) in glyphs.iter().enumerate() {
|
||||
let code = i + 1;
|
||||
let _ = write!(procs, "/g{code} {} 0 R ", *next);
|
||||
let _ = write!(names, "/g{code} ");
|
||||
let _ = write!(widths, "{} ", n(glyph.width));
|
||||
let body = glyph_procedure(glyph);
|
||||
stream_obj(out, offsets, *next, "", body.as_bytes());
|
||||
*next += 1;
|
||||
bounds[0] = bounds[0].min(glyph.bounds[0]);
|
||||
bounds[1] = bounds[1].min(glyph.bounds[1]);
|
||||
bounds[2] = bounds[2].max(glyph.bounds[2]);
|
||||
bounds[3] = bounds[3].max(glyph.bounds[3]);
|
||||
if !glyph.source.is_empty() {
|
||||
mappings.push(format!("<{code:02X}> {}\n", unicode_string(&glyph.source, false)));
|
||||
}
|
||||
}
|
||||
let mut cmap = "/CIDInit /ProcSet findresource begin\n12 dict begin\nbegincmap\n/CIDSystemInfo << /Registry (Adobe) /Ordering (UCS) /Supplement 0 >> def\n/CMapName /GridCraftArabicUnicode def\n/CMapType 2 def\n1 begincodespacerange\n<00> <FF>\nendcodespacerange\n".to_string();
|
||||
for group in mappings.chunks(100) {
|
||||
let _ = writeln!(cmap, "{} beginbfchar", group.len());
|
||||
for mapping in group {
|
||||
cmap.push_str(mapping);
|
||||
}
|
||||
cmap.push_str("endbfchar\n");
|
||||
}
|
||||
cmap.push_str("endcmap\nCMapName currentdict /CMap defineresource pop\nend\nend\n");
|
||||
stream_obj(out, offsets, cmap_id, "", cmap.as_bytes());
|
||||
dict_obj(
|
||||
out,
|
||||
offsets,
|
||||
id,
|
||||
&format!(
|
||||
"<< /Type /Font /Subtype /Type3 /Name /GridCraftArabic /FontBBox [{} {} {} {}] /FontMatrix [0.001 0 0 0.001 0 0] /CharProcs << {procs}>> /Encoding << /Type /Encoding /Differences [1 {names}] >> /FirstChar 1 /LastChar {} /Widths [{widths}] /Resources << >> /ToUnicode {cmap_id} 0 R >>",
|
||||
n(bounds[0]),
|
||||
n(bounds[1]),
|
||||
n(bounds[2]),
|
||||
n(bounds[3]),
|
||||
glyphs.len()
|
||||
),
|
||||
);
|
||||
let _ = write!(resources, "/A{} {id} 0 R ", batch + 1);
|
||||
}
|
||||
resources
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn unicode_string(text: &str, bom: bool) -> String {
|
||||
let mut out = if bom { "<FEFF".to_string() } else { "<".to_string() };
|
||||
for unit in text.encode_utf16() {
|
||||
let _ = write!(out, "{unit:04X}");
|
||||
}
|
||||
out.push('>');
|
||||
out
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct Pen {
|
||||
path: String,
|
||||
point: [f32; 2],
|
||||
bounds: [f32; 4],
|
||||
shear: f32,
|
||||
full: bool,
|
||||
}
|
||||
|
||||
impl Pen {
|
||||
fn point(&mut self, x: f32, y: f32) -> [f32; 2] {
|
||||
let x = x + self.shear * y;
|
||||
self.bounds[0] = self.bounds[0].min(x);
|
||||
self.bounds[1] = self.bounds[1].min(y);
|
||||
self.bounds[2] = self.bounds[2].max(x);
|
||||
self.bounds[3] = self.bounds[3].max(y);
|
||||
[x, y]
|
||||
}
|
||||
fn op(&mut self, value: &str) {
|
||||
if self.path.len().saturating_add(value.len()) > MAX_OUTLINE_BYTES {
|
||||
self.full = true;
|
||||
}
|
||||
if !self.full {
|
||||
self.path.push_str(value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl OutlinePen for Pen {
|
||||
fn move_to(&mut self, x: f32, y: f32) {
|
||||
let [px, py] = self.point(x, y);
|
||||
self.op(&format!("{} {} m\n", n(px), n(py)));
|
||||
self.point = [x, y];
|
||||
}
|
||||
fn line_to(&mut self, x: f32, y: f32) {
|
||||
let [px, py] = self.point(x, y);
|
||||
self.op(&format!("{} {} l\n", n(px), n(py)));
|
||||
self.point = [x, y];
|
||||
}
|
||||
fn quad_to(&mut self, cx: f32, cy: f32, x: f32, y: f32) {
|
||||
self.curve_to(
|
||||
self.point[0] + (cx - self.point[0]) * 2.0 / 3.0,
|
||||
self.point[1] + (cy - self.point[1]) * 2.0 / 3.0,
|
||||
x + (cx - x) * 2.0 / 3.0,
|
||||
y + (cy - y) * 2.0 / 3.0,
|
||||
x,
|
||||
y,
|
||||
);
|
||||
}
|
||||
fn curve_to(&mut self, cx: f32, cy: f32, dx: f32, dy: f32, x: f32, y: f32) {
|
||||
let [cx, cy] = self.point(cx, cy);
|
||||
let [dx, dy] = self.point(dx, dy);
|
||||
let [px, py] = self.point(x, y);
|
||||
self.op(&format!("{} {} {} {} {} {} c\n", n(cx), n(cy), n(dx), n(dy), n(px), n(py)));
|
||||
self.point = [x, y];
|
||||
}
|
||||
fn close(&mut self) {
|
||||
self.op("h\n");
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
fn fallback_mirrors_only_paired_ansi_punctuation() {
|
||||
let visual: String = "(مرحبا)".chars().rev().map(super::mirror_ansi).collect();
|
||||
assert_eq!(visual, "(ابحرم)");
|
||||
assert_eq!("[(<«‹abc›»>)]".chars().rev().map(super::mirror_ansi).collect::<String>(), "[(<«‹cba›»>)]");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_bold_request_served_by_a_static_regular_face_is_emboldened() {
|
||||
assert!(super::needs_synthetic_bold("craft:Noto Sans Arabic:Regular", b"static", true));
|
||||
assert!(!super::needs_synthetic_bold("craft:Noto Sans Arabic:Regular", b"static", false));
|
||||
assert!(!super::needs_synthetic_bold("craft:Noto Sans Arabic:Bold", b"static", true));
|
||||
let glyph =
|
||||
|emboldened| super::Glyph { path: "0 0 m 10 0 l 10 10 l h\n".into(), width: 500.0, source: String::new(), bounds: [0.0; 4], emboldened };
|
||||
assert_eq!(super::glyph_procedure(&glyph(false)), "500 0 d0\n0 0 m 10 0 l 10 10 l h\nf\n");
|
||||
assert_eq!(super::glyph_procedure(&glyph(true)), "500 0 d0\n30 w 1 j\n0 0 m 10 0 l 10 10 l h\nB\n");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn line_breaks_never_use_the_embedded_face() {
|
||||
for ch in ['\n', '\r', '\u{2028}', '\u{2029}'] {
|
||||
assert!(!super::embeddable(true, ch), "{ch:?}");
|
||||
}
|
||||
assert!(super::embeddable(true, 'م'));
|
||||
assert!(super::embeddable(false, '\u{200f}'));
|
||||
assert!(!super::embeddable(false, 'A'));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn no_bundled_or_installed_face_is_not_an_error() {
|
||||
for bold in [false, true] {
|
||||
assert!(matches!(super::find_face(&[], &[], bold), Ok(None)));
|
||||
assert!(matches!(super::find_face(&[], &[std::env::temp_dir().join("gridcraft-no-fonts-here")], bold), Ok(None)));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bundled_faces_match_the_requested_weight() {
|
||||
const REGULAR: &[u8] = b"regular";
|
||||
const BOLD: &[u8] = b"bold";
|
||||
let bold_first = [("Noto Sans Arabic:Bold", BOLD), ("Noto Sans Arabic", REGULAR)];
|
||||
assert_eq!(super::bundled_match(&bold_first, false), Some(REGULAR));
|
||||
assert_eq!(super::bundled_match(&bold_first, true), Some(BOLD));
|
||||
assert_eq!(super::bundled_match(&[("Noto Sans Arabic", REGULAR)], true), None);
|
||||
assert_eq!(super::bundled_match(&[], false), None);
|
||||
assert_eq!(super::bundled_fallback(&[("Noto Sans Arabic:Bold", BOLD)], false), None);
|
||||
assert_eq!(super::bundled_fallback(&[("Noto Sans Arabic:Regular", REGULAR)], true), Some(("Noto Sans Arabic:Regular", REGULAR)));
|
||||
}
|
||||
}
|
||||
+66
-191
@@ -5,64 +5,20 @@
|
||||
//! WinAnsiEncoding (CJK and other scripts) are set in a predefined, non-embedded Adobe-GB1 CID
|
||||
//! font with the `UniGB-UTF16-H` CMap instead of being replaced by `?`. Symbol uses its own
|
||||
//! built-in encoding ([`symbol_code`]), for Greek letters and mathematical operators.
|
||||
//! - Arabic is shaped and set in embedded Type3 subsets, with exact shaped advances.
|
||||
//! - Vector drawing: rectangles, lines (solid or dashed), polygons, circles (Bézier), clipping.
|
||||
//! - RGBA images as RGB image XObjects with a soft mask for alpha (run-length encoded).
|
||||
//! - Coordinates are points with a **top-left origin** (y grows down); text `y` is the baseline.
|
||||
//!
|
||||
//! Streams are written uncompressed (images use the RunLengthDecode filter).
|
||||
//! Streams are written uncompressed (images use the trivial RunLengthDecode filter) so the crate
|
||||
//! needs no dependencies.
|
||||
#![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)]
|
||||
#![forbid(unsafe_code)]
|
||||
|
||||
mod arabic;
|
||||
mod metrics;
|
||||
mod symbol;
|
||||
|
||||
pub use symbol::{symbol_code, symbol_width};
|
||||
|
||||
/// Paragraph base direction. Context follows spreadsheet reading order: the first
|
||||
/// non-whitespace character determines direction, including digits and punctuation.
|
||||
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
|
||||
pub enum TextDirection {
|
||||
#[default]
|
||||
Auto,
|
||||
Context,
|
||||
LeftToRight,
|
||||
RightToLeft,
|
||||
}
|
||||
|
||||
impl TextDirection {
|
||||
/// Resolve once for a paragraph before wrapping it into visual lines.
|
||||
pub fn resolve(self, text: &str) -> Self {
|
||||
use unicode_bidi::{BidiClass, BidiInfo, bidi_class};
|
||||
let rtl = match self {
|
||||
Self::Auto => BidiInfo::new(text, None).paragraphs.first().is_some_and(|p| p.level.is_rtl()),
|
||||
Self::Context => text.chars().find(|ch| !ch.is_whitespace()).is_some_and(|ch| matches!(bidi_class(ch), BidiClass::R | BidiClass::AL)),
|
||||
explicit => return explicit,
|
||||
};
|
||||
if rtl { Self::RightToLeft } else { Self::LeftToRight }
|
||||
}
|
||||
|
||||
fn level(self) -> Option<unicode_bidi::Level> {
|
||||
match self {
|
||||
Self::Auto => None,
|
||||
Self::LeftToRight | Self::Context => Some(unicode_bidi::Level::ltr()),
|
||||
Self::RightToLeft => Some(unicode_bidi::Level::rtl()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A PDF export could not preserve the requested text.
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct Error(String);
|
||||
|
||||
impl std::fmt::Display for Error {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.write_str(&self.0)
|
||||
}
|
||||
}
|
||||
impl std::error::Error for Error {}
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::collections::hash_map::DefaultHasher;
|
||||
use std::fmt::Write as _;
|
||||
@@ -84,13 +40,6 @@ impl Point {
|
||||
}
|
||||
}
|
||||
|
||||
/// A text baseline origin and its clockwise rotation in radians.
|
||||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||||
pub struct Baseline {
|
||||
pub origin: Point,
|
||||
pub angle: f32,
|
||||
}
|
||||
|
||||
/// A page-space rectangle described by its top-left corner and extent.
|
||||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||||
pub struct Rect {
|
||||
@@ -253,29 +202,10 @@ impl Font {
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether [`text_width_with_direction`] is the sum of `text`'s character widths: not shaped,
|
||||
/// not reordered right to left and holding no bidi controls. A prefix's width is then a running sum.
|
||||
pub fn width_is_char_sum(font: Font, text: &str, direction: TextDirection) -> bool {
|
||||
let direction = if direction == TextDirection::Context { direction.resolve(text) } else { direction };
|
||||
!arabic::shaped(font, text) && arabic::is_logical_order(text, direction)
|
||||
}
|
||||
|
||||
/// Width of `text` in points when set in `font` at `size` points.
|
||||
/// Arabic uses shaped advances. If its font cannot render the text, measurement returns zero
|
||||
/// and drawing that text causes [`PdfDoc::finish`] to return the rendering error.
|
||||
pub fn text_width(font: Font, size: f32, text: &str) -> f32 {
|
||||
text_width_with_direction(font, size, text, TextDirection::Auto)
|
||||
}
|
||||
|
||||
/// Width measured with the same base direction as drawing.
|
||||
pub fn text_width_with_direction(font: Font, size: f32, text: &str, direction: TextDirection) -> f32 {
|
||||
let direction = if direction == TextDirection::Context { direction.resolve(text) } else { direction };
|
||||
if arabic::shaped(font, text) {
|
||||
return arabic::layout(font, text, direction).map(|layout| layout.width * size / 1000.0).unwrap_or(0.0);
|
||||
}
|
||||
// u64: a u32 sum overflows for ~8 million characters.
|
||||
let Ok(visual) = arabic::latin_visual(text, direction) else { return 0.0 };
|
||||
let units: u64 = visual.chars().map(|c| u64::from(font.char_width(c))).sum();
|
||||
let units: u64 = text.chars().map(|c| u64::from(font.char_width(c))).sum();
|
||||
units as f32 * size / 1000.0
|
||||
}
|
||||
|
||||
@@ -516,9 +446,6 @@ pub struct Page {
|
||||
/// `save` calls refused at the nesting limit; the same number of `restore` calls are ignored.
|
||||
refused: u32,
|
||||
links: Vec<LinkAnnotation>,
|
||||
arabic: arabic::Subset,
|
||||
error: Option<Error>,
|
||||
missing_arabic_font: bool,
|
||||
}
|
||||
|
||||
/// Most bytes of content per page before further drawing is dropped (keeps hostile inputs from
|
||||
@@ -779,132 +706,64 @@ impl Page {
|
||||
self.op(&s);
|
||||
}
|
||||
|
||||
/// Arabic ink extents above and below the baseline, in points. Standard font text returns
|
||||
/// `None`. Font errors are recorded for [`PdfDoc::finish`], just as when drawing text.
|
||||
pub fn text_vertical_extents(&mut self, font: Font, size: f32, text: &str) -> Option<(f32, f32)> {
|
||||
self.text_vertical_extents_with_direction(font, size, text, TextDirection::Auto)
|
||||
}
|
||||
|
||||
/// Arabic ink extents with an explicit paragraph base direction.
|
||||
pub fn text_vertical_extents_with_direction(&mut self, font: Font, size: f32, text: &str, direction: TextDirection) -> Option<(f32, f32)> {
|
||||
if !arabic::shaped(font, text) {
|
||||
return None;
|
||||
}
|
||||
match arabic::vertical_extents(font, text, direction) {
|
||||
Ok((ascent, descent)) => Some((ascent * size / 1000.0, descent * size / 1000.0)),
|
||||
Err(error) => {
|
||||
self.error.get_or_insert(error);
|
||||
None
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Text with its baseline starting at `(x, y)`.
|
||||
pub fn text(&mut self, x: f32, y: f32, size: f32, font: Font, color: Rgb, text: &str) {
|
||||
self.text_with_direction(Point::new(x, y), size, font, color, text, TextDirection::Auto);
|
||||
}
|
||||
|
||||
/// Text drawn with an explicit paragraph base direction.
|
||||
pub fn text_with_direction(&mut self, origin: Point, size: f32, font: Font, color: Rgb, text: &str, direction: TextDirection) {
|
||||
self.text_rotated_with_direction(Baseline { origin, angle: 0.0 }, size, font, color, text, direction);
|
||||
self.text_rotated(Point::new(x, y), size, font, color, text, 0.0);
|
||||
}
|
||||
|
||||
/// Text rotated by `angle` radians (clockwise on the page, like the y-down coordinate
|
||||
/// system) about its baseline origin.
|
||||
pub fn text_rotated(&mut self, origin: Point, size: f32, font: Font, color: Rgb, text: &str, angle: f32) {
|
||||
self.text_rotated_with_direction(Baseline { origin, angle }, size, font, color, text, TextDirection::Auto);
|
||||
}
|
||||
|
||||
/// Rotated text with an explicit paragraph base direction.
|
||||
pub fn text_rotated_with_direction(&mut self, baseline: Baseline, size: f32, font: Font, color: Rgb, text: &str, direction: TextDirection) {
|
||||
let Baseline { origin, angle } = baseline;
|
||||
if text.is_empty() || !extent(size) || !finite(&[origin.x, origin.y]) {
|
||||
return;
|
||||
}
|
||||
let direction = if direction == TextDirection::Context { direction.resolve(text) } else { direction };
|
||||
let fi = font.index();
|
||||
let size = n(size.min(10_000.0));
|
||||
let (sn, cs) = if angle.is_finite() { angle.sin_cos() } else { (0.0, 1.0) };
|
||||
// Clockwise in y-down = counter-clockwise negated in PDF's y-up space.
|
||||
let matrix = format!("{} {} {} {} {} {}", n(cs), n(-sn), n(sn), n(cs), n(origin.x), n(self.y(origin.y)));
|
||||
let size = size.min(10_000.0);
|
||||
let shaping = arabic::shaping(font, text);
|
||||
self.missing_arabic_font |= shaping == arabic::Shaping::NoFont;
|
||||
if shaping == arabic::Shaping::Shaped {
|
||||
self.shaped_text(&matrix, size, font, color, text, direction);
|
||||
} else {
|
||||
self.standard_text(&matrix, size, font, color, text, direction);
|
||||
}
|
||||
}
|
||||
|
||||
fn shaped_text(&mut self, matrix: &str, size: f32, font: Font, color: Rgb, text: &str, direction: TextDirection) {
|
||||
if self.saved.len() >= MAX_SAVE_DEPTH {
|
||||
return;
|
||||
}
|
||||
let body = match self.arabic.text(font, text, size, direction) {
|
||||
Ok(body) => body,
|
||||
Err(error) => {
|
||||
self.error.get_or_insert(error);
|
||||
return;
|
||||
}
|
||||
};
|
||||
for slot in [Some(font.index()), self.arabic.uses_cid.then_some(CID_FONT)].into_iter().flatten() {
|
||||
if let Some(f) = self.fonts.get_mut(slot) {
|
||||
let tm = format!("{} {} {} {} {} {} Tm\n", n(cs), n(-sn), n(sn), n(cs), n(origin.x), n(self.y(origin.y)));
|
||||
// Symbol text is one run in Symbol's own encoding (the CID font has no maths symbols).
|
||||
if font == Font::Symbol {
|
||||
if let Some(f) = self.fonts.get_mut(fi) {
|
||||
*f = true;
|
||||
}
|
||||
}
|
||||
let mut s = format!("q\n{matrix} cm\n");
|
||||
push_rgb(&mut s, color, false);
|
||||
s.push(' ');
|
||||
push_rgb(&mut s, color, true);
|
||||
let _ = write!(s, "\n{body}\nQ");
|
||||
self.text_op(&s);
|
||||
}
|
||||
|
||||
fn standard_text(&mut self, matrix: &str, size: f32, font: Font, color: Rgb, text: &str, direction: TextDirection) {
|
||||
let visual = match arabic::latin_visual(text, direction) {
|
||||
Ok(visual) => visual,
|
||||
Err(error) => {
|
||||
self.error.get_or_insert(error);
|
||||
if self.full() {
|
||||
return;
|
||||
}
|
||||
};
|
||||
let fi = font.index();
|
||||
let size = n(size);
|
||||
let mut runs = String::new();
|
||||
let mut s = String::new();
|
||||
self.set_fill(&mut s, color);
|
||||
let _ = write!(s, "BT\n{tm}/F{} {} Tf\n{} Tj\nET", fi + 1, size, pdf_string_in(text, true));
|
||||
self.op(&s);
|
||||
return;
|
||||
}
|
||||
// Runs of WinAnsi text use `font`; runs it cannot encode use the CID font. Each `Tj`
|
||||
// advances the text position, so the runs follow each other on the baseline.
|
||||
// Symbol text is one run in Symbol's own encoding (the CID font has no maths symbols).
|
||||
let symbol = font == Font::Symbol;
|
||||
let uses_cid = |c: char| !symbol && needs_cid(c);
|
||||
let mut rest: &str = &visual;
|
||||
let mut runs = String::new();
|
||||
let mut rest = text;
|
||||
while let Some(first) = rest.chars().next() {
|
||||
let cid = uses_cid(first);
|
||||
let end = rest.char_indices().find(|(_, c)| uses_cid(*c) != cid).map_or(rest.len(), |(i, _)| i);
|
||||
let cid = needs_cid(first);
|
||||
let end = rest.char_indices().find(|(_, c)| needs_cid(*c) != cid).map_or(rest.len(), |(i, _)| i);
|
||||
let (run, tail) = rest.split_at(end);
|
||||
let (slot, string) = if cid { (CID_FONT, pdf_utf16_string(run)) } else { (fi, pdf_string_in(run, symbol)) };
|
||||
let (slot, string) = if cid { (CID_FONT, pdf_utf16_string(run)) } else { (fi, pdf_string(run)) };
|
||||
if let Some(f) = self.fonts.get_mut(slot) {
|
||||
*f = true;
|
||||
}
|
||||
let first_run = runs.is_empty();
|
||||
let _ = writeln!(runs, "/F{} {} Tf", slot + 1, size);
|
||||
if first_run {
|
||||
let _ = writeln!(runs, "{matrix} Tm");
|
||||
runs.push_str(&tm);
|
||||
}
|
||||
let _ = writeln!(runs, "{string} Tj");
|
||||
rest = tail;
|
||||
}
|
||||
let mut s = String::new();
|
||||
self.set_fill(&mut s, color);
|
||||
let _ = write!(s, "BT\n{runs}ET");
|
||||
let s = if visual != text { format!("/Span << /ActualText {} >> BDC\n{s}\nEMC", arabic::unicode_string(text, true)) } else { s };
|
||||
self.text_op(&s);
|
||||
}
|
||||
|
||||
fn text_op(&mut self, s: &str) {
|
||||
if self.content.len().saturating_add(s.len()).saturating_add(1) > MAX_PAGE_CONTENT {
|
||||
self.error.get_or_insert_with(|| Error("PDF page text exceeds the size limit".into()));
|
||||
} else {
|
||||
self.op(s);
|
||||
if self.full() {
|
||||
return;
|
||||
}
|
||||
// The colour goes in front of the text object, so it is tracked like any other style.
|
||||
let mut colour = String::new();
|
||||
self.set_fill(&mut colour, color);
|
||||
let s = format!("{colour}BT\n{runs}ET");
|
||||
self.op(&s);
|
||||
}
|
||||
|
||||
/// Draws an RGBA image (`pw`×`ph` pixels, row-major, straight alpha) into the box
|
||||
@@ -979,7 +838,39 @@ pub struct PdfDoc {
|
||||
|
||||
/// PackBits-style run-length encoding (PDF `RunLengthDecode`).
|
||||
fn run_length(data: &[u8]) -> Vec<u8> {
|
||||
craft_stream_codecs::runlength::encode(data)
|
||||
let mut out = Vec::with_capacity(data.len() / 2 + 16);
|
||||
let mut i = 0;
|
||||
while i < data.len() {
|
||||
let b = data[i];
|
||||
let mut run = 1;
|
||||
while i + run < data.len() && run < 128 && data[i + run] == b {
|
||||
run += 1;
|
||||
}
|
||||
if run >= 2 {
|
||||
out.push((257 - run) as u8);
|
||||
out.push(b);
|
||||
i += run;
|
||||
continue;
|
||||
}
|
||||
// Literal run until the next repeat of 3+ or 128 bytes.
|
||||
let start = i;
|
||||
let mut len = 0;
|
||||
while i < data.len() && len < 128 {
|
||||
if i + 2 < data.len() && data[i] == data[i + 1] && data[i] == data[i + 2] {
|
||||
break;
|
||||
}
|
||||
i += 1;
|
||||
len += 1;
|
||||
}
|
||||
if len == 0 {
|
||||
// Next is a repeat; loop will handle it.
|
||||
continue;
|
||||
}
|
||||
out.push((len - 1) as u8);
|
||||
out.extend_from_slice(&data[start..start + len]);
|
||||
}
|
||||
out.push(128);
|
||||
out
|
||||
}
|
||||
|
||||
/// Longest Info string written, in characters; longer values are cut on a character boundary.
|
||||
@@ -1066,9 +957,6 @@ impl PdfDoc {
|
||||
style: Style::default(),
|
||||
saved: Vec::new(),
|
||||
refused: 0,
|
||||
arabic: arabic::Subset::default(),
|
||||
error: None,
|
||||
missing_arabic_font: false,
|
||||
});
|
||||
let i = self.pages.len() - 1;
|
||||
&mut self.pages[i]
|
||||
@@ -1083,12 +971,6 @@ impl PdfDoc {
|
||||
self.pages.get_mut(i)
|
||||
}
|
||||
|
||||
/// Whether some Arabic text was set in the standard and CID fonts, which have no Arabic glyphs,
|
||||
/// because no Arabic face was found for its weight.
|
||||
pub fn missing_arabic_font(&self) -> bool {
|
||||
self.pages.iter().any(|page| page.missing_arabic_font)
|
||||
}
|
||||
|
||||
/// Serializes the document. A document without pages gets one blank Letter page.
|
||||
///
|
||||
/// Every object is written straight into the output buffer (nothing is staged in an
|
||||
@@ -1096,12 +978,7 @@ impl PdfDoc {
|
||||
/// the ids are contiguous from 1. Objects are therefore in the file in the order they are
|
||||
/// numbered during writing (fonts, then per page its new images, content stream and page
|
||||
/// dictionary), with the catalog, page tree and info dictionary last.
|
||||
///
|
||||
/// Returns an error if the Arabic font is unusable or Arabic text exceeds a size limit.
|
||||
pub fn finish(mut self) -> Result<Vec<u8>, Error> {
|
||||
if let Some(error) = self.pages.iter().find_map(|page| page.error.clone()) {
|
||||
return Err(error);
|
||||
}
|
||||
pub fn finish(mut self) -> Vec<u8> {
|
||||
if self.pages.is_empty() {
|
||||
self.add_page(612.0, 792.0);
|
||||
}
|
||||
@@ -1178,8 +1055,6 @@ impl PdfDoc {
|
||||
// confirmed by comparing the pixels before an object is shared.
|
||||
let mut written: HashMap<u64, Vec<(usize, usize, u32)>> = HashMap::new();
|
||||
for (pi, ((page, content), links)) in self.pages.iter().zip(contents).zip(page_links).enumerate() {
|
||||
let arabic_fonts = page.arabic.write_objects(&mut next, &mut out, &mut offsets);
|
||||
let page_fonts = format!("{font_dict}{arabic_fonts}");
|
||||
let mut xobjects = String::new();
|
||||
for (k, img) in page.images.iter().enumerate() {
|
||||
let known = written.get(&img.hash).and_then(|c| {
|
||||
@@ -1243,7 +1118,7 @@ impl PdfDoc {
|
||||
"<< /Type /Page /Parent 2 0 R /MediaBox [0 0 {} {}] /Resources << /Font << {}>>{} >> /Contents {} 0 R{} >>",
|
||||
n(page.width),
|
||||
n(page.height),
|
||||
page_fonts,
|
||||
font_dict,
|
||||
xo,
|
||||
content_id,
|
||||
annots
|
||||
@@ -1288,7 +1163,7 @@ impl PdfDoc {
|
||||
let _ = writeln!(Utf8(&mut out), "{off:010} 00000 n ");
|
||||
}
|
||||
let _ = write!(Utf8(&mut out), "trailer\n<< /Size {} /Root 1 0 R /Info 3 0 R >>\nstartxref\n{}\n%%EOF\n", next, xref);
|
||||
Ok(out)
|
||||
out
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+25
-360
@@ -5,36 +5,6 @@ use std::io;
|
||||
mod reference;
|
||||
use reference::{OldPage, interpret};
|
||||
|
||||
#[test]
|
||||
fn rtl_marked_text_limit_fails_without_appending_partial_content() {
|
||||
let mut doc = PdfDoc::new();
|
||||
let page = doc.add_page(600.0, 300.0);
|
||||
page.content = " ".repeat(MAX_PAGE_CONTENT - 8);
|
||||
let before = page.content.len();
|
||||
page.text_with_direction(Point::new(10.0, 20.0), 12.0, Font::Helvetica, [0, 0, 0], "ABC !", TextDirection::RightToLeft);
|
||||
assert_eq!(page.content.len(), before, "the marked-content block must append atomically");
|
||||
assert!(doc.finish().unwrap_err().to_string().contains("size limit"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_paragraph_separator_keeps_right_to_left_latin_on_one_line() {
|
||||
let visual = |text| arabic::latin_visual(text, TextDirection::RightToLeft).unwrap().into_owned();
|
||||
assert_eq!(visual("ABC\r"), visual("ABC "));
|
||||
assert_eq!(visual("ABC\u{2029}DEF"), visual("ABC DEF"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cjk_in_a_right_to_left_cell_keeps_the_cid_font() {
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.add_page(600.0, 300.0).text_with_direction(Point::new(10.0, 20.0), 12.0, Font::Helvetica, [0, 0, 0], "编号!", TextDirection::RightToLeft);
|
||||
let pdf = doc.finish().unwrap();
|
||||
check_xref(&pdf).unwrap();
|
||||
let cjk = find(&pdf, b"<7F1653F7> Tj").expect("CJK run set in the CID font");
|
||||
assert!(find(&pdf, b"/Encoding /UniGB-UTF16-H").is_some());
|
||||
assert!(find(&pdf, b"(!) Tj").is_some_and(|bang| bang < cjk), "the trailing ! is drawn left of the CJK run");
|
||||
assert_eq!(utf16_entry(&pdf, "/ActualText").unwrap(), "编号!");
|
||||
}
|
||||
|
||||
fn find(hay: &[u8], needle: &[u8]) -> Option<usize> {
|
||||
hay.windows(needle.len()).position(|w| w == needle)
|
||||
}
|
||||
@@ -73,7 +43,7 @@ fn check_xref(pdf: &[u8]) -> Result<usize, Box<dyn Error>> {
|
||||
|
||||
#[test]
|
||||
fn minimal_document() -> Result<(), Box<dyn Error>> {
|
||||
let pdf = PdfDoc::new().finish()?;
|
||||
let pdf = PdfDoc::new().finish();
|
||||
assert!(pdf.starts_with(b"%PDF-1.7"));
|
||||
assert!(pdf.ends_with(b"%%EOF\n"));
|
||||
assert!(check_xref(&pdf)? >= 5);
|
||||
@@ -99,7 +69,7 @@ fn drawing_and_text() -> Result<(), Box<dyn Error>> {
|
||||
let p2 = d.add_page(842.0, 595.0);
|
||||
p2.text(10.0, 20.0, 10.0, Font::CourierBold, [0, 0, 0], "Second");
|
||||
assert_eq!(d.page_count(), 2);
|
||||
let pdf = d.finish()?;
|
||||
let pdf = d.finish();
|
||||
check_xref(&pdf)?;
|
||||
assert!(find(&pdf, b"(Hello \\(world\\) \\\\ caf\\351 \\2005) Tj").is_some());
|
||||
assert!(find(&pdf, b"(Second) Tj").is_some());
|
||||
@@ -125,7 +95,7 @@ fn uri_and_page_links_are_real_pdf_annotations() -> Result<(), Box<dyn Error>> {
|
||||
first.link_uri(0.0, 0.0, 10.0, 10.0, "javascript:alert(1)");
|
||||
let second = d.add_page(100.0, 200.0);
|
||||
second.link_page(Rect::new(0.0, 0.0, 10.0, 10.0), 99, Point::new(0.0, 0.0));
|
||||
let pdf = d.finish()?;
|
||||
let pdf = d.finish();
|
||||
check_xref(&pdf)?;
|
||||
let s = String::from_utf8_lossy(&pdf);
|
||||
assert_eq!(s.matches("/Subtype /Link").count(), 3);
|
||||
@@ -149,7 +119,7 @@ fn images_with_alpha() -> Result<(), Box<dyn Error>> {
|
||||
p.image_rgba(Rect::new(10.0, 10.0, 40.0, 40.0), &px, [4, 4]);
|
||||
p.image_rgba(Rect::new(10.0, 10.0, 40.0, 40.0), &[255; 16], [2, 2]); // opaque: no mask
|
||||
p.image_rgba(Rect::new(0.0, 0.0, 1.0, 1.0), &[1, 2, 3], [4, 4]); // too short: ignored
|
||||
let pdf = d.finish()?;
|
||||
let pdf = d.finish();
|
||||
check_xref(&pdf)?;
|
||||
assert!(find(&pdf, b"/SMask").is_some());
|
||||
assert!(find(&pdf, b"/Im1 Do").is_some());
|
||||
@@ -217,7 +187,7 @@ fn hostile_inputs_never_panic() -> Result<(), Box<dyn Error>> {
|
||||
p.restore();
|
||||
p.save();
|
||||
p.image_rgba(Rect::new(0.0, 0.0, 10.0, 10.0), &[], [u32::MAX, u32::MAX]);
|
||||
let pdf = d.finish()?;
|
||||
let pdf = d.finish();
|
||||
check_xref(&pdf)?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -457,7 +427,7 @@ fn corpus_doc(seed: u64) -> (Vec<u8>, Vec<String>) {
|
||||
}
|
||||
old_pages.push(old.content);
|
||||
}
|
||||
(doc.finish().unwrap(), old_pages)
|
||||
(doc.finish(), old_pages)
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -501,7 +471,7 @@ fn structure_is_valid_for_all_documents() -> Result<(), Box<dyn Error>> {
|
||||
check_xref(&pdf)?;
|
||||
parse_objects(&pdf); // every /Length matches its data
|
||||
}
|
||||
let empty = PdfDoc::new().finish()?;
|
||||
let empty = PdfDoc::new().finish();
|
||||
check_xref(&empty)?;
|
||||
parse_objects(&empty);
|
||||
Ok(())
|
||||
@@ -517,7 +487,7 @@ fn images_decode_to_their_pixels() {
|
||||
p.image_rgba(Rect::new(1.0, 1.0, 20.0, 20.0), px, [*w, *h]);
|
||||
}
|
||||
}
|
||||
let pdf = d.finish().unwrap();
|
||||
let pdf = d.finish();
|
||||
let (objs, pages) = parse_pages(&pdf);
|
||||
assert_eq!(pages.len(), 2);
|
||||
for page in &pages {
|
||||
@@ -544,7 +514,7 @@ fn opaque_images_have_no_soft_mask() {
|
||||
let p = d.add_page(100.0, 100.0);
|
||||
p.image_rgba(Rect::new(0.0, 0.0, 10.0, 10.0), &[255; 4 * 12], [4, 3]);
|
||||
assert!(p.images[0].alpha.is_none());
|
||||
let pdf = d.finish().unwrap();
|
||||
let pdf = d.finish();
|
||||
assert!(find(&pdf, b"/SMask").is_none());
|
||||
assert_eq!(pdf.windows(15).filter(|w| *w == b"/Subtype /Image").count(), 1);
|
||||
|
||||
@@ -553,7 +523,7 @@ fn opaque_images_have_no_soft_mask() {
|
||||
px[translucent * 4 + 3] = 7;
|
||||
let mut d = PdfDoc::new();
|
||||
d.add_page(100.0, 100.0).image_rgba(Rect::new(0.0, 0.0, 10.0, 10.0), &px, [4, 3]);
|
||||
let (objs, pages) = parse_pages(&d.finish().unwrap());
|
||||
let (objs, pages) = parse_pages(&d.finish());
|
||||
let (_, _, _, alpha) = decode_image(&objs, pages[0].xobjects[0].1);
|
||||
let mut want = vec![255u8; 12];
|
||||
want[translucent] = 7;
|
||||
@@ -572,7 +542,7 @@ fn identical_images_are_stored_once() -> Result<(), Box<dyn Error>> {
|
||||
p.image_rgba(Rect::new(1.0, 1.0, 20.0, 20.0), px, [*w, *h]);
|
||||
p.image_rgba(Rect::new(30.0, 1.0, 20.0, 20.0), px, [*w, *h]); // twice on one page
|
||||
}
|
||||
let pdf = d.finish()?;
|
||||
let pdf = d.finish();
|
||||
check_xref(&pdf)?;
|
||||
assert_eq!(pdf.windows(15).filter(|w| *w == b"/Subtype /Image").count(), 2, "one image + one soft mask");
|
||||
let (_, pages) = parse_pages(&pdf);
|
||||
@@ -597,7 +567,7 @@ fn different_images_are_not_merged() {
|
||||
p.image_rgba(Rect::new(0.0, 0.0, 5.0, 5.0), &b, [4, 1]);
|
||||
p.image_rgba(Rect::new(0.0, 0.0, 5.0, 5.0), &a, [2, 2]);
|
||||
d.add_page(100.0, 100.0).image_rgba(Rect::new(0.0, 0.0, 5.0, 5.0), &a, [4, 1]);
|
||||
let pdf = d.finish().unwrap();
|
||||
let pdf = d.finish();
|
||||
assert_eq!(pdf.windows(15).filter(|w| *w == b"/Subtype /Image").count(), 6, "three distinct pictures, each with a soft mask (alpha 50)");
|
||||
}
|
||||
|
||||
@@ -617,7 +587,7 @@ fn many_distinct_images_on_one_page_are_not_compared_pairwise() {
|
||||
assert_eq!(p.images.len(), N as usize);
|
||||
assert!(p.content.ends_with("/Im1 Do Q\n"), "the repeated picture reuses /Im1");
|
||||
assert!(p.image_comparisons <= 1, "{} pixel comparisons for {N} distinct pictures", p.image_comparisons);
|
||||
let pdf = d.finish().unwrap();
|
||||
let pdf = d.finish();
|
||||
assert_eq!(pdf.windows(15).filter(|w| *w == b"/Subtype /Image").count(), N as usize);
|
||||
}
|
||||
|
||||
@@ -631,7 +601,7 @@ fn hash_collisions_do_not_merge_images() {
|
||||
for p in 0..2 {
|
||||
d.page_mut(p).unwrap().images[0].hash = 42; // forced collision
|
||||
}
|
||||
let (objs, pages) = parse_pages(&d.finish().unwrap());
|
||||
let (objs, pages) = parse_pages(&d.finish());
|
||||
let ids: Vec<usize> = pages.iter().map(|p| p.xobjects[0].1).collect();
|
||||
assert_ne!(ids[0], ids[1]);
|
||||
assert_eq!(decode_image(&objs, ids[0]).2, vec![10; 12]);
|
||||
@@ -736,7 +706,7 @@ fn save_nesting_is_limited_to_28() -> Result<(), Box<dyn Error>> {
|
||||
p.restore();
|
||||
p.image_rgba(Rect::new(0.0, 0.0, 5.0, 5.0), &[9; 16], [2, 2]);
|
||||
assert!(p.content.contains(" Do"));
|
||||
let pdf = d.finish()?;
|
||||
let pdf = d.finish();
|
||||
check_xref(&pdf)?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -749,7 +719,7 @@ fn finish_closes_open_saves() -> Result<(), Box<dyn Error>> {
|
||||
for _ in 0..33 {
|
||||
p.save();
|
||||
}
|
||||
let (_, pages) = parse_pages(&d.finish()?);
|
||||
let (_, pages) = parse_pages(&d.finish());
|
||||
let i = interpret(&pages[0].content);
|
||||
assert!(i.balanced);
|
||||
assert_eq!(i.qs, 28);
|
||||
@@ -855,7 +825,7 @@ fn every_draw_method_survives_hostile_numbers() -> Result<(), Box<dyn Error>> {
|
||||
p.stroke_line_dashed(Point::new(0.0, 0.0), Point::new(1.0, 1.0), 1.0, [0, 0, 0], &[0.0; 100]);
|
||||
let c = page_content(&d);
|
||||
assert!(!c.contains("NaN") && !c.contains("inf"));
|
||||
let pdf = d.finish()?;
|
||||
let pdf = d.finish();
|
||||
check_xref(&pdf)?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -878,7 +848,7 @@ fn info_strings_with_non_ascii_are_utf16be() -> Result<(), Box<dyn Error>> {
|
||||
doc.add_page(200.0, 200.0);
|
||||
doc.info.title = "Übersicht €5 – “Q1” 日本 😀".into();
|
||||
doc.info.author = "Müller & Søn".into();
|
||||
let pdf = doc.finish()?;
|
||||
let pdf = doc.finish();
|
||||
assert_eq!(utf16_entry(&pdf, "/Title")?, "Übersicht €5 – “Q1” 日本 😀");
|
||||
assert_eq!(utf16_entry(&pdf, "/Author")?, "Müller & Søn");
|
||||
Ok(())
|
||||
@@ -889,7 +859,7 @@ fn ascii_info_strings_stay_literal_and_escaped() {
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.add_page(200.0, 200.0);
|
||||
doc.info.title = r"Q1 (draft) a\b".into();
|
||||
let pdf = doc.finish().unwrap();
|
||||
let pdf = doc.finish();
|
||||
assert!(find(&pdf, br"/Title (Q1 \(draft\) a\\b)").is_some());
|
||||
assert!(find(&pdf, b"/Producer (GridCraft PDF)").is_some());
|
||||
}
|
||||
@@ -899,7 +869,7 @@ fn info_strings_are_capped() -> Result<(), Box<dyn Error>> {
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.add_page(200.0, 200.0);
|
||||
doc.info.title = "日".repeat(100_000);
|
||||
let pdf = doc.finish()?;
|
||||
let pdf = doc.finish();
|
||||
assert_eq!(utf16_entry(&pdf, "/Title")?.chars().count(), MAX_INFO_CHARS);
|
||||
Ok(())
|
||||
}
|
||||
@@ -910,7 +880,7 @@ fn cjk_text_is_not_replaced_by_question_marks() -> Result<(), Box<dyn Error>> {
|
||||
let p = doc.add_page(612.0, 792.0);
|
||||
p.text(10.0, 20.0, 10.0, Font::Helvetica, [0, 0, 0], "签字清单");
|
||||
p.text(10.0, 40.0, 10.0, Font::Helvetica, [0, 0, 0], "No. 编号 2");
|
||||
let pdf = doc.finish()?;
|
||||
let pdf = doc.finish();
|
||||
check_xref(&pdf)?;
|
||||
assert!(find(&pdf, b"(????) Tj").is_none(), "CJK text written as question marks");
|
||||
assert!(find(&pdf, b"<7B7E5B576E055355> Tj").is_some());
|
||||
@@ -923,284 +893,12 @@ fn cjk_text_is_not_replaced_by_question_marks() -> Result<(), Box<dyn Error>> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_is_shaped_and_preserved_or_falls_back_without_a_font() {
|
||||
let text = "مَرْحَبًا 123 (ABC)";
|
||||
let mut doc = PdfDoc::new();
|
||||
let page = doc.add_page(600.0, 300.0);
|
||||
page.text(30.0, 70.0, 20.0, Font::Helvetica, [0, 0, 0], text);
|
||||
let layout = arabic::layout(Font::Helvetica, text, TextDirection::Auto);
|
||||
let Ok(layout) = layout else {
|
||||
assert!(doc.missing_arabic_font());
|
||||
check_xref(&doc.finish().unwrap()).unwrap();
|
||||
return;
|
||||
};
|
||||
assert!(layout.width > 0.0);
|
||||
assert!((text_width(Font::Helvetica, 20.0, text) - layout.width * 0.02).abs() < 0.001);
|
||||
let pdf = doc.finish().unwrap();
|
||||
check_xref(&pdf).unwrap();
|
||||
assert_eq!(utf16_entry(&pdf, "/ActualText").unwrap(), text);
|
||||
assert!(find(&pdf, b"/Subtype /Type3").is_some());
|
||||
assert!(find(&pdf, b"/ToUnicode").is_some());
|
||||
assert!(find(&pdf, b"beginbfchar").is_some());
|
||||
assert!(find(&pdf, b"(?) Tj").is_none());
|
||||
assert!(find(&pdf, b"/UniGB-UTF16-H").is_none(), "Arabic is never set in the CJK font");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn latin_inside_arabic_text_declares_its_page_font() {
|
||||
if arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).is_err() && arabic::ARABIC_FONTS.is_empty() {
|
||||
return;
|
||||
}
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.add_page(600.0, 300.0).text(30.0, 70.0, 20.0, Font::Helvetica, [0, 0, 0], "مرحبا\u{2028}عالم");
|
||||
let pdf = doc.finish().unwrap();
|
||||
check_xref(&pdf).unwrap();
|
||||
assert!(find(&pdf, b"/F1 20 Tf").is_some(), "the line break is drawn as a Helvetica space");
|
||||
assert!(find(&pdf, b"/Font << /F1 ").is_some(), "the page declares the font its Latin run uses");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cjk_inside_arabic_text_uses_the_cid_font() {
|
||||
if arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).is_err() && arabic::ARABIC_FONTS.is_empty() {
|
||||
return;
|
||||
}
|
||||
let text = "مرحبا 编号";
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.add_page(600.0, 300.0).text(30.0, 70.0, 20.0, Font::Helvetica, [0, 0, 0], text);
|
||||
let pdf = doc.finish().unwrap();
|
||||
check_xref(&pdf).unwrap();
|
||||
assert!(find(&pdf, b"<7F1653F7> Tj").is_some(), "the CJK run is set in the CID font");
|
||||
assert!(find(&pdf, b"/Encoding /UniGB-UTF16-H").is_some(), "the page declares the CID font");
|
||||
assert_eq!(utf16_entry(&pdf, "/ActualText").unwrap(), text);
|
||||
assert!(text_width(Font::Helvetica, 20.0, text) >= text_width(Font::Helvetica, 20.0, "مرحبا") + 40.0, "two full-width ideographs");
|
||||
for (text, cid_run) in [("مرحبا 😀", &b"<D83DDE00> Tj"[..]), ("مرحبا Привет", &b"<041F04400438043204350442> Tj"[..])] {
|
||||
let mut uncovered = PdfDoc::new();
|
||||
uncovered.add_page(600.0, 300.0).text(30.0, 70.0, 20.0, Font::Helvetica, [0, 0, 0], text);
|
||||
assert!(!uncovered.missing_arabic_font());
|
||||
let pdf = uncovered.finish().unwrap();
|
||||
check_xref(&pdf).unwrap();
|
||||
assert!(find(&pdf, cid_run).is_some(), "{text}: characters the Arabic face lacks fall back like non-Arabic text");
|
||||
assert_eq!(utf16_entry(&pdf, "/ActualText").unwrap(), text);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn oversized_arabic_text_is_an_error_instead_of_partial_pdf() {
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.add_page(600.0, 300.0).text(0.0, 50.0, 10.0, Font::Helvetica, [0, 0, 0], &"ب".repeat(65_537));
|
||||
if doc.missing_arabic_font() {
|
||||
check_xref(&doc.finish().unwrap()).unwrap();
|
||||
return;
|
||||
}
|
||||
assert!(doc.finish().unwrap_err().to_string().contains("128 KiB"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_joining_marks_styles_and_rotation() {
|
||||
if arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).is_err() && arabic::ARABIC_FONTS.is_empty() {
|
||||
return;
|
||||
}
|
||||
for (text, expected) in [("مرحبا 123 (ABC)", "(ABC)"), ("مرحبا [ABC]", "[ABC]"), ("مرحبا <ABC>", "<ABC>")] {
|
||||
let mixed = arabic::layout(Font::Helvetica, text, TextDirection::Auto).unwrap();
|
||||
let latin: String = mixed
|
||||
.items
|
||||
.iter()
|
||||
.filter_map(|item| match item {
|
||||
arabic::Item::Latin { text, .. } => Some(text.as_str()),
|
||||
_ => None,
|
||||
})
|
||||
.collect();
|
||||
if !latin.is_empty() {
|
||||
assert_eq!(latin, expected);
|
||||
}
|
||||
}
|
||||
let mut metrics = PdfDoc::new();
|
||||
let (ascent, descent) = metrics.add_page(100.0, 100.0).text_vertical_extents(Font::Helvetica, 20.0, "كمثرى").unwrap();
|
||||
assert!(ascent > 0.0 && descent > 20.0 * 0.22, "Arabic descenders exceed the old Latin baseline allowance");
|
||||
assert!(
|
||||
metrics.page_mut(0).unwrap().text_vertical_extents(Font::Helvetica, 20.0, "مرحبا 123 (ABC)").is_some(),
|
||||
"spaces in variable fonts have empty outlines"
|
||||
);
|
||||
metrics.finish().unwrap();
|
||||
let joined = arabic::layout(Font::Helvetica, "سلام", TextDirection::Auto).unwrap();
|
||||
let separate_width: f32 = "سلام".chars().map(|c| text_width(Font::Helvetica, 1000.0, &c.to_string())).sum();
|
||||
assert!((joined.width - separate_width).abs() > 10.0, "joining changes advances");
|
||||
let marked = arabic::layout(Font::Helvetica, "مَرْحَبًا", TextDirection::Auto).unwrap();
|
||||
let plain = arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).unwrap();
|
||||
assert!(marked.items.len() > plain.items.len());
|
||||
assert!(marked.items.iter().any(|item| matches!(item, arabic::Item::Glyph { y, .. } if *y != 0.0)));
|
||||
let bold_available = match arabic::layout(Font::HelveticaBold, "مرحبا", TextDirection::Auto) {
|
||||
Ok(bold) if arabic::bold_face_is_synthetic() => {
|
||||
assert!(bold.width >= plain.width, "synthetic bold keeps the regular advances");
|
||||
true
|
||||
}
|
||||
Ok(bold) => {
|
||||
assert!(bold.width > plain.width, "bold metrics use the bold font instance");
|
||||
true
|
||||
}
|
||||
Err(e) => {
|
||||
assert!(arabic::ARABIC_FONTS.is_empty(), "a bundled face always serves bold text: {e:?}");
|
||||
false
|
||||
}
|
||||
};
|
||||
let mut regular = PdfDoc::new();
|
||||
regular.add_page(500.0, 300.0).text(30.0, 60.0, 20.0, Font::Helvetica, [0, 0, 0], "مرحبا");
|
||||
let regular = regular.finish().unwrap();
|
||||
let mut italic = PdfDoc::new();
|
||||
italic.add_page(500.0, 300.0).text(30.0, 60.0, 20.0, Font::HelveticaOblique, [0, 0, 0], "مرحبا");
|
||||
let italic = italic.finish().unwrap();
|
||||
assert_ne!(regular, italic, "italic shears the actual outlines");
|
||||
let rotated_font = if bold_available { Font::HelveticaBoldOblique } else { Font::HelveticaOblique };
|
||||
let mut rotated = PdfDoc::new();
|
||||
rotated.add_page(500.0, 300.0).text_rotated(Point::new(100.0, 100.0), 20.0, rotated_font, [0, 0, 0], "مرحبا 123", -std::f32::consts::FRAC_PI_2);
|
||||
let rotated = rotated.finish().unwrap();
|
||||
check_xref(&rotated).unwrap();
|
||||
assert_eq!(utf16_entry(&rotated, "/ActualText").unwrap(), "مرحبا 123");
|
||||
assert!(find(&rotated, b"0 1 -1 0 100 200 cm").is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn line_breaks_in_arabic_text_draw_as_spaces() {
|
||||
if arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).is_err() && arabic::ARABIC_FONTS.is_empty() {
|
||||
return;
|
||||
}
|
||||
for (text, direction) in ["مرحبا\r\nعالم", "مرحبا\u{2028}عالم", "مرحبا\u{2029}ABC\r"]
|
||||
.into_iter()
|
||||
.flat_map(|text| [TextDirection::Auto, TextDirection::LeftToRight, TextDirection::RightToLeft].map(|direction| (text, direction)))
|
||||
{
|
||||
let layout = arabic::layout(Font::Helvetica, text, direction).unwrap();
|
||||
for item in &layout.items {
|
||||
if let arabic::Item::Latin { text: drawn, .. } = item {
|
||||
assert!(!drawn.chars().any(|ch| matches!(ch, '\n' | '\r' | '\u{2028}' | '\u{2029}')), "{drawn:?} from {text:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
let drawn = |text: &str| format!("{:?}", arabic::layout(Font::Helvetica, text, TextDirection::RightToLeft).unwrap().items);
|
||||
assert_eq!(drawn("مرحبا\u{2029}عالم"), drawn("مرحبا عالم"), "a paragraph separator keeps right-to-left reading order");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_text_respects_the_save_nesting_limit() -> Result<(), Box<dyn Error>> {
|
||||
if arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).is_err() && arabic::ARABIC_FONTS.is_empty() {
|
||||
return Ok(());
|
||||
}
|
||||
let mut d = PdfDoc::new();
|
||||
let p = d.add_page(100.0, 100.0);
|
||||
for _ in 0..28 {
|
||||
p.save();
|
||||
}
|
||||
p.text(10.0, 50.0, 12.0, Font::Helvetica, [0, 0, 0], "مرحبا");
|
||||
assert_eq!(interpret(&p.content).max_depth, 28);
|
||||
p.restore();
|
||||
p.text(10.0, 50.0, 12.0, Font::Helvetica, [0, 0, 0], "مرحبا");
|
||||
assert!(p.content.contains("/ActualText"));
|
||||
check_xref(&d.finish()?)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_subsets_split_after_255_character_codes() -> Result<(), Box<dyn Error>> {
|
||||
if arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).is_err() && arabic::ARABIC_FONTS.is_empty() {
|
||||
return Ok(());
|
||||
}
|
||||
let mut doc = PdfDoc::new();
|
||||
let page = doc.add_page(600.0, 300.0);
|
||||
let marks = ['َ', 'ُ', 'ِ', 'ّ', 'ْ', 'ً', 'ٌ', 'ٍ'];
|
||||
for i in 0..260 {
|
||||
let text = format!("ب{}{}{}", marks[i % 8], marks[(i / 8) % 8], marks[(i / 64) % 8]);
|
||||
page.text(20.0, 50.0, 10.0, Font::Helvetica, [0, 0, 0], &text);
|
||||
}
|
||||
let pdf = doc.finish().unwrap();
|
||||
check_xref(&pdf).unwrap();
|
||||
assert!(find(&pdf, b"/A2 ").is_some());
|
||||
assert!(find(&pdf, b"/LastChar 255").is_some());
|
||||
assert!(find(&pdf, b"<100> Tj").is_none(), "Type3 codes are always one byte");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn spreadsheet_context_is_first_character_not_first_strong() {
|
||||
use TextDirection::{Auto, Context, LeftToRight as Ltr, RightToLeft as Rtl};
|
||||
for (text, expected) in [(" مرحبا", Rtl), ("123 مرحبا", Ltr), ("(مرحبا)", Ltr), (" ١٢٣ مرحبا", Ltr), ("\t\n", Ltr)] {
|
||||
assert_eq!(Context.resolve(text), expected, "{text}");
|
||||
}
|
||||
assert_eq!(Auto.resolve("123 مرحبا"), Rtl);
|
||||
assert_eq!(Auto.resolve("(مرحبا)"), Rtl);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn explicit_rtl_standard_text_reorders_without_an_arabic_font() {
|
||||
let source = "ABC !";
|
||||
let mut doc = PdfDoc::new();
|
||||
let page = doc.add_page(300.0, 100.0);
|
||||
page.text_with_direction(Point::new(10.0, 30.0), 12.0, Font::Helvetica, [0, 0, 0], source, TextDirection::RightToLeft);
|
||||
assert!(page.content.contains("(! ABC) Tj"), "{}", page.content);
|
||||
assert!(page.arabic.write_objects(&mut 4, &mut Vec::new(), &mut Vec::new()).is_empty());
|
||||
assert_eq!(text_width_with_direction(Font::Helvetica, 12.0, source, TextDirection::RightToLeft), text_width(Font::Helvetica, 12.0, source));
|
||||
let pdf = doc.finish().unwrap();
|
||||
assert_eq!(utf16_entry(&pdf, "/ActualText").unwrap(), source);
|
||||
assert!(find(&pdf, b"/Subtype /Type3").is_none());
|
||||
|
||||
let mut huge = PdfDoc::new();
|
||||
huge.add_page(300.0, 100.0).text_with_direction(
|
||||
Point::new(10.0, 30.0),
|
||||
12.0,
|
||||
Font::Helvetica,
|
||||
[0, 0, 0],
|
||||
&"A".repeat(128 * 1024 + 1),
|
||||
TextDirection::RightToLeft,
|
||||
);
|
||||
assert!(huge.finish().unwrap_err().to_string().contains("128 KiB"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arabic_explicit_base_changes_visual_order_and_preserves_logical_text() {
|
||||
if arabic::layout(Font::Helvetica, "مرحبا", TextDirection::Auto).is_err() && arabic::ARABIC_FONTS.is_empty() {
|
||||
return;
|
||||
}
|
||||
let sources = |text: &str, direction| {
|
||||
arabic::layout(Font::Helvetica, text, direction)
|
||||
.unwrap()
|
||||
.items
|
||||
.into_iter()
|
||||
.map(|item| match item {
|
||||
arabic::Item::Glyph { source, .. } => source,
|
||||
arabic::Item::Latin { text, .. } | arabic::Item::Cid { text, .. } => text,
|
||||
})
|
||||
.collect::<String>()
|
||||
};
|
||||
let text = "مرحبا ABC";
|
||||
let ltr = sources(text, TextDirection::LeftToRight);
|
||||
let rtl = sources(text, TextDirection::RightToLeft);
|
||||
assert!(ltr.ends_with("ABC"), "{ltr}");
|
||||
assert!(rtl.starts_with("ABC"), "{rtl}");
|
||||
assert_ne!(ltr, rtl);
|
||||
assert_eq!(sources("123 مرحبا", TextDirection::Context), sources("123 مرحبا", TextDirection::LeftToRight));
|
||||
let mut documents = Vec::new();
|
||||
for direction in [TextDirection::LeftToRight, TextDirection::RightToLeft] {
|
||||
let mut doc = PdfDoc::new();
|
||||
doc.add_page(300.0, 100.0).text_rotated_with_direction(
|
||||
Baseline { origin: Point::new(30.0, 70.0), angle: 0.3 },
|
||||
20.0,
|
||||
Font::Helvetica,
|
||||
[0, 0, 0],
|
||||
text,
|
||||
direction,
|
||||
);
|
||||
let pdf = doc.finish().unwrap();
|
||||
assert_eq!(utf16_entry(&pdf, "/ActualText").unwrap(), text);
|
||||
documents.push(pdf);
|
||||
}
|
||||
assert_ne!(documents[0], documents[1]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn many_alternating_runs_share_one_text_matrix() {
|
||||
let mut doc = PdfDoc::new();
|
||||
let p = doc.add_page(612.0, 792.0);
|
||||
p.text(10.0, 20.0, 10.0, Font::Helvetica, [0, 0, 0], &"a\u{4e2d}".repeat(2000));
|
||||
let pdf = doc.finish().unwrap();
|
||||
let pdf = doc.finish();
|
||||
let count = |needle: &[u8]| pdf.windows(needle.len()).filter(|w| *w == needle).count();
|
||||
assert_eq!(count(b" Tm\n"), 1, "the position is set once, before the first run");
|
||||
assert_eq!(count(b" Tf\n"), 4000, "every run selects its font");
|
||||
@@ -1208,52 +906,19 @@ fn many_alternating_runs_share_one_text_matrix() {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn symbol_font_draws_maths_in_its_own_encoding() -> Result<(), Box<dyn Error>> {
|
||||
fn symbol_font_draws_maths_in_its_own_encoding() {
|
||||
let mut doc = PdfDoc::new();
|
||||
let p = doc.add_page(200.0, 200.0);
|
||||
p.text(10.0, 50.0, 12.0, Font::Symbol, [0, 0, 0], "\u{2211}\u{03B1}\u{2264}\u{221E}x");
|
||||
p.text(10.0, 80.0, 12.0, Font::TimesItalic, [0, 0, 0], "x");
|
||||
let pdf = doc.finish()?;
|
||||
let pdf = doc.finish();
|
||||
let s = String::from_utf8_lossy(&pdf);
|
||||
assert!(s.contains("/BaseFont /Symbol >>"), "Symbol has no WinAnsi encoding");
|
||||
assert!(s.contains("/BaseFont /Times-Italic /Encoding /WinAnsiEncoding"));
|
||||
// The sum, alpha, less-or-equal and infinity codes; x is not in Symbol and becomes `?`.
|
||||
assert!(s.contains("(\\345a\\243\\245?) Tj"), "{s}");
|
||||
check_xref(&pdf)?;
|
||||
check_xref(&pdf).unwrap();
|
||||
assert!(Font::Symbol.can_encode('\u{2211}') && !Font::Symbol.can_encode('x'));
|
||||
assert!(Font::TimesRoman.can_encode('x') && !Font::TimesRoman.can_encode('\u{2211}'));
|
||||
assert_eq!(text_width(Font::Symbol, 10.0, "\u{2211}"), 7.13);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn symbol_text_is_never_shaped_as_arabic() -> Result<(), Box<dyn Error>> {
|
||||
let mut doc = PdfDoc::new();
|
||||
let page = doc.add_page(200.0, 200.0);
|
||||
assert_eq!(page.text_vertical_extents(Font::Symbol, 12.0, "\u{03B1}ب"), None);
|
||||
page.text(10.0, 50.0, 12.0, Font::Symbol, [0, 0, 0], "\u{03B1}ب");
|
||||
let pdf = doc.finish()?;
|
||||
check_xref(&pdf)?;
|
||||
assert!(find(&pdf, b"(a?) Tj").is_some());
|
||||
assert!(find(&pdf, b"/ActualText").is_none());
|
||||
assert_eq!(text_width(Font::Symbol, 10.0, "\u{03B1}ب"), f32::from(Font::Symbol.char_width('\u{03B1}') + Font::Symbol.char_width('ب')) / 100.0);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn shared_run_length_preserves_pixels_at_packet_boundaries() {
|
||||
for len in [0, 1, 2, 3, 127, 128, 129, 255, 256, 257, 1024] {
|
||||
for seed in [0u8, 127, 128, 255] {
|
||||
let repeats = vec![seed; len];
|
||||
let literals: Vec<u8> = (0..len).map(|i| seed.wrapping_add(i as u8)).collect();
|
||||
let pairs: Vec<u8> = (0..len).map(|i| (i / 2) as u8).collect();
|
||||
for pixels in [repeats, literals, pairs] {
|
||||
let encoded = run_length(&pixels);
|
||||
assert_eq!(encoded.last(), Some(&128));
|
||||
assert_eq!(rle_decode(&encoded), pixels);
|
||||
}
|
||||
}
|
||||
}
|
||||
// Two equal bytes may now terminate a literal packet. PDF pixel values stay exact.
|
||||
assert_eq!(run_length(&[1, 2, 2, 3]), [0, 1, 255, 2, 0, 3, 128]);
|
||||
}
|
||||
|
||||
@@ -268,38 +268,12 @@ const TIOCLINUX: u64 = libc::TIOCLINUX as u64;
|
||||
const IOC_WRITE: u64 = 0x4000_0000;
|
||||
/// Changes a directory, though its number says it only reads, as the kernel's headers have it.
|
||||
const FS_IOC_SET_ENCRYPTION_POLICY: u64 = 0x800C_6613;
|
||||
#[allow(clippy::unnecessary_cast)]
|
||||
const F_SETOWN: u64 = libc::F_SETOWN as u64;
|
||||
#[allow(clippy::unnecessary_cast)]
|
||||
const F_SETFL: u64 = libc::F_SETFL as u64;
|
||||
#[allow(clippy::unnecessary_cast)]
|
||||
const O_ASYNC: u64 = libc::O_ASYNC as u64;
|
||||
/// The two `fcntl` commands of the same family that the kernel's headers name and `libc` doesn't;
|
||||
/// the numbers are the same on every architecture (`asm-generic/fcntl.h`).
|
||||
const F_SETOWN_EX: u64 = 15;
|
||||
const F_SETSIG: u64 = 10;
|
||||
/// Socket ioctls that do what those commands do: `FIOSETOWN` and `SIOCSPGRP` name the process to
|
||||
/// notify, and `FIOASYNC` switches the notification on. Their requests carry no data-direction
|
||||
/// bit, so the [`IOC_WRITE`] rule doesn't name them. `libc` doesn't name them; the numbers are
|
||||
/// the kernel's, the same on every architecture (`asm-generic/sockios.h`).
|
||||
const FIOSETOWN: u64 = 0x8901;
|
||||
const SIOCSPGRP: u64 = 0x8902;
|
||||
const FIOASYNC: u64 = 0x5452;
|
||||
|
||||
/// What the main filter refuses with `EPERM`: the calls above, and these when their arguments match.
|
||||
/// - `clone` without `CLONE_THREAD`: a new process.
|
||||
/// - A signal to any process but `me`, whose ID `exec` keeps. Landlock's signal scope needs a newer
|
||||
/// kernel than the rest (ABI 6), and `kill(-1, 9)` must not get through on an older one.
|
||||
/// - A change to the limits, priority or scheduling of any process but `me`.
|
||||
/// - The `fcntl` commands that arrange asynchronous notification: naming the process to notify
|
||||
/// (`F_SETOWN`, `F_SETOWN_EX`), choosing its signal (`F_SETSIG`), and `F_SETFL` when it sets
|
||||
/// `O_ASYNC`, the switch without which nothing is sent. None is a signal call, and the only rule
|
||||
/// that would cover them is Landlock's signal scope, which needs ABI 6, newer than a launch
|
||||
/// requires; without these a confined program could have the kernel signal any process of its
|
||||
/// user. `F_SETFL` itself still works, as `O_NONBLOCK` comes from it. A socket answers the same
|
||||
/// arrangement through ioctls — `FIOSETOWN` and `SIOCSPGRP` to name the process, `FIOASYNC` to
|
||||
/// switch the notification on — and those requests carry no data-direction bit, so they are
|
||||
/// named alongside the others.
|
||||
/// - `TIOCSTI` and `TIOCLINUX`, which type into a terminal the program inherited, as when
|
||||
/// `gridcraft-cli sandbox-check` runs a program from a shell.
|
||||
/// - An `ioctl` that hands the kernel data ([`IOC_WRITE`]), as those that change a file's flags or
|
||||
@@ -333,22 +307,10 @@ fn main_rules(me: u32) -> Result<BTreeMap<i64, Vec<SeccompRule>>> {
|
||||
vec![
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, TIOCSTI)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, TIOCLINUX)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, FIOSETOWN)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, SIOCSPGRP)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, FIOASYNC)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::MaskedEq(IOC_WRITE), IOC_WRITE)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, FS_IOC_SET_ENCRYPTION_POLICY)?])?,
|
||||
],
|
||||
);
|
||||
rules.insert(
|
||||
libc::SYS_fcntl,
|
||||
vec![
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, F_SETOWN)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, F_SETOWN_EX)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, F_SETSIG)?])?,
|
||||
rule(vec![word(1, SeccompCmpOp::Eq, F_SETFL)?, word(2, SeccompCmpOp::MaskedEq(O_ASYNC), O_ASYNC)?])?,
|
||||
],
|
||||
);
|
||||
Ok(rules)
|
||||
}
|
||||
|
||||
@@ -416,9 +378,6 @@ mod tests {
|
||||
#[test]
|
||||
fn the_calls_that_reach_another_process_have_rules() {
|
||||
let rules = main_rules(4242).unwrap();
|
||||
// `fcntl`'s notification commands: naming the owner to notify, both ways, choosing its
|
||||
// signal, and the switch itself.
|
||||
assert_eq!(rules.get(&libc::SYS_fcntl).map(Vec::len), Some(4), "the asynchronous-notification commands");
|
||||
for nr in [
|
||||
libc::SYS_kill,
|
||||
libc::SYS_tkill,
|
||||
@@ -456,9 +415,7 @@ mod tests {
|
||||
] {
|
||||
assert_eq!(rules.get(&nr).map(Vec::len), Some(0), "{nr} is refused outright");
|
||||
}
|
||||
// The terminal rules, the socket notification ioctls (`FIOSETOWN`, `SIOCSPGRP`,
|
||||
// `FIOASYNC`), the data-carrying rule and the encryption rule.
|
||||
assert_eq!(rules.get(&libc::SYS_ioctl).map(Vec::len), Some(7));
|
||||
assert_eq!(rules.get(&libc::SYS_ioctl).map(Vec::len), Some(4));
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -44,8 +44,6 @@ pub fn enforcement(canary: &Path, exe: &Path, target: u32) -> Vec<Check> {
|
||||
Check { name: "TCP connection", outcome: denied(tcp_probe()) },
|
||||
Check { name: "start a process", outcome: spawn_probe(exe) },
|
||||
Check { name: "signal another process", outcome: signal_probe(target) },
|
||||
#[cfg(target_os = "linux")]
|
||||
Check { name: "switch a descriptor's notifications on", outcome: async_probe() },
|
||||
]
|
||||
}
|
||||
|
||||
@@ -130,20 +128,6 @@ fn write_probe(dir: &Path) -> Outcome {
|
||||
denied(r.map(drop))
|
||||
}
|
||||
|
||||
/// `O_ASYNC` on a descriptor of the program's own: the switch that has the kernel signal the
|
||||
/// descriptor's owner when its state changes. The owner may be a process the program didn't name, a
|
||||
/// standard stream the parent made, so on Linux the filter refuses setting it, the same way it
|
||||
/// refuses the commands that name another owner. Naming one can't be asked here without `fcntl`'s
|
||||
/// variable-argument form, which no safe API wraps; the rules refuse those commands, and the
|
||||
/// confined-program test covers them.
|
||||
#[cfg(target_os = "linux")]
|
||||
fn async_probe() -> Outcome {
|
||||
let r = nix::unistd::pipe().map_err(std::io::Error::from).and_then(|(_, write)| {
|
||||
nix::fcntl::fcntl(write, nix::fcntl::FcntlArg::F_SETFL(nix::fcntl::OFlag::O_ASYNC)).map(drop).map_err(std::io::Error::from)
|
||||
});
|
||||
denied(r)
|
||||
}
|
||||
|
||||
fn tcp_probe() -> std::io::Result<()> {
|
||||
TcpStream::connect_timeout(&SocketAddr::from(TCP_TARGET), Duration::from_secs(2)).map(drop)
|
||||
}
|
||||
@@ -232,15 +216,6 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
/// Unconfined, the notification probe reports what the system allows; confined, the launch
|
||||
/// check needs it `Denied`. Either way it comes out of the same three calls, so this proves
|
||||
/// the probe runs and classifies rather than failing outright.
|
||||
#[cfg(target_os = "linux")]
|
||||
#[test]
|
||||
fn the_notification_probe_classifies() {
|
||||
assert!(matches!(async_probe(), Outcome::Allowed(_)), "unconfined the switch can be set");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_checks_on_the_canary_change_nothing_where_they_are_allowed() {
|
||||
let canary = crate::Canary::create().unwrap();
|
||||
|
||||
@@ -23,7 +23,6 @@ craft-csv = { workspace = true }
|
||||
craft-offcrypto = { workspace = true }
|
||||
craft-opc = { workspace = true }
|
||||
craft-xls = { workspace = true }
|
||||
craft-xml = { workspace = true }
|
||||
thiserror = { workspace = true }
|
||||
quick-xml = { workspace = true }
|
||||
zip = { workspace = true }
|
||||
|
||||
@@ -116,7 +116,6 @@ fn workbook() -> Workbook {
|
||||
show_headers: false,
|
||||
last_range: Some(rr("A2:H12")),
|
||||
calculated_fields: vec![],
|
||||
data_index: Default::default(),
|
||||
values_on_rows: false,
|
||||
values_position: None,
|
||||
};
|
||||
@@ -177,7 +176,6 @@ fn workbook() -> Workbook {
|
||||
show_headers: true,
|
||||
last_range: Some(rr("K2:Z30")),
|
||||
calculated_fields: vec![],
|
||||
data_index: Default::default(),
|
||||
values_on_rows: false,
|
||||
values_position: None,
|
||||
};
|
||||
|
||||
+48
-21
@@ -359,11 +359,31 @@ pub fn parse_streaming(xml: &[u8], split: &[&str], cb: &mut dyn FnMut(El) -> Res
|
||||
|
||||
// ---------------------------------------------------------------- writing helpers
|
||||
|
||||
// XML 1.0 byte escaping is shared; spreadsheet string and phonetic policy stays here.
|
||||
use craft_xml::is_xml_char;
|
||||
#[cfg(test)]
|
||||
use craft_xml::push_esc;
|
||||
pub use craft_xml::{esc, esc_attr};
|
||||
/// Escapes text content.
|
||||
pub fn esc(s: &str) -> String {
|
||||
let mut o = String::with_capacity(s.len());
|
||||
push_esc(&mut o, s);
|
||||
o
|
||||
}
|
||||
|
||||
/// Appends [`esc`]`(s)` to `o`.
|
||||
pub fn push_esc(o: &mut String, s: &str) {
|
||||
if s.bytes().all(|b| matches!(b, b'\t' | b'\n' | 0x20..=0x7E) && !matches!(b, b'&' | b'<' | b'>')) {
|
||||
o.push_str(s);
|
||||
return;
|
||||
}
|
||||
o.reserve(s.len());
|
||||
for c in s.chars() {
|
||||
match c {
|
||||
'&' => o.push_str("&"),
|
||||
'<' => o.push_str("<"),
|
||||
'>' => o.push_str(">"),
|
||||
'\r' => o.push_str(" "),
|
||||
c if is_xml_char(c) => o.push(c),
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Appends `n` in decimal.
|
||||
pub fn push_u64(o: &mut String, mut n: u64) {
|
||||
@@ -402,6 +422,29 @@ pub fn push_a1(o: &mut String, c: gridcraft_core::CellRef) {
|
||||
push_u64(o, u64::from(c.row) + 1);
|
||||
}
|
||||
|
||||
/// Escapes an attribute value (double-quoted).
|
||||
pub fn esc_attr(s: &str) -> String {
|
||||
let mut o = String::with_capacity(s.len());
|
||||
for c in s.chars() {
|
||||
match c {
|
||||
'&' => o.push_str("&"),
|
||||
'<' => o.push_str("<"),
|
||||
'>' => o.push_str(">"),
|
||||
'"' => o.push_str("""),
|
||||
'\n' => o.push_str(" "),
|
||||
'\r' => o.push_str(" "),
|
||||
'\t' => o.push_str("	"),
|
||||
c if is_xml_char(c) => o.push(c),
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
o
|
||||
}
|
||||
|
||||
fn is_xml_char(c: char) -> bool {
|
||||
matches!(c, '\t' | '\n' | '\r' | '\u{20}'..='\u{D7FF}' | '\u{E000}'..='\u{FFFD}' | '\u{10000}'..='\u{10FFFF}')
|
||||
}
|
||||
|
||||
/// ST_Xstring encoding for cell text: characters XML can't carry and carriage returns become
|
||||
/// `_xHHHH_`, and literal `_xHHHH_` sequences are protected with `_x005F_`. The result still needs
|
||||
/// [`esc`].
|
||||
@@ -762,19 +805,3 @@ mod tests {
|
||||
assert_eq!("1.5E20".parse::<f64>().unwrap(), 1.5e20);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod shared_escape_parity {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn xml_content_and_attributes_preserve_grid_bytes() {
|
||||
let value = "&<>\"'\t\n\r\0\u{1f}\u{fffe}\u{ffff}é😀";
|
||||
assert_eq!(esc(value), "&<>\"'\t\n é😀");
|
||||
assert_eq!(esc_attr(value), "&<>"'	 é😀");
|
||||
let mut appended = "prefix:".to_owned();
|
||||
push_esc(&mut appended, value);
|
||||
assert_eq!(appended, format!("prefix:{}", esc(value)));
|
||||
assert_eq!(esc("plain ASCII\t\n"), "plain ASCII\t\n");
|
||||
assert_eq!(decode_xstring(&encode_xstring("_x000D_\r\0😀")), "_x000D_\r\0😀");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# File-format parity
|
||||
|
||||
> **Last reviewed:** 2026-11-01 · **Last updated:** 2026-11-13 · **Change:** minor (PDF honours cell reading direction and mirrors right-to-left sheets; earlier: Arabic PDF export no longer fails when a character or the Arabic font is missing; earlier: Arabic PDF text is shaped with embedded Noto Arabic glyphs beside the non-embedded standard, Symbol and CID fonts; earlier: .xls data validation is read; earlier: .xls is read by the shared craft-xls crate: the workbook opens on the sheet it was saved on, and rich-text (RString) cells are read; earlier: form controls: buttons, scroll bars and spin buttons read and written; earlier: a web page's first table opens as a sheet, also when the page is named `.xls`; earlier: `workbookPr filterPrivacy` kept, and honoured on save; earlier: a workbook's R1C1 reference style, `calcPr refMode`, is kept through open and save; earlier: XLSX page margins are written as their decimals, `0.3` rather than `0.30000001192092896`; earlier: Python cells in `.xlsx` as [MS-XLSX] specifies, `_xlfn._xlws.PY(…)` naming code in the Python part, with cached values, and in GridCraft JSON, with limits on open; earlier: equations in xlsx as Office Math with a marker in `descr` so an edit made in Excel reads back, read back only up to the equation source cap, and a brace with a label and a script on its other side keeps both; Symbol font in PDF; earlier: XLSX reads and writes Page Setup's page order, `pageSetup pageOrder`, and PDF export follows it; earlier: chart data tables: native c:dTable import/export; earlier: XLSX workbook-view selection, normalized tab ratios and sheet-edit regressions; fidelity estimates unchanged; earlier: formulas from Google Sheets' XLSX export open as the original formula instead of `IFERROR(__xludf.DUMMYFUNCTION(…),…)` when GridCraft calculates every function in it, and save as it; `file.exportCsv {values: true}` writes raw values for automation; .xls dialog sheets are skipped instead of read as worksheets; `.xls` import reads each sheet's display options from WINDOW2: right-to-left, gridlines, headings, zeros, formulas; XLSX text boxes and shapes keep their paragraphs' right-to-left direction on save; CSV/TSV/TXT can open with every field kept as text via `file.open {csvAsText}`; formulas over Excel's 8,192 characters, and `%` or call chains past the nesting limit, are parse errors instead of stack overflows when a file is opened; XLSX PivotTables read and write `rowGrandTotals`/`colGrandTotals` the way Excel does, so a table saved with only one grand total opens with the right one; HTML export keeps right-to-left; CSV and text import detects likely Windows-1256 Arabic when invalid UTF-8 has Arabic byte runs; other invalid UTF-8 remains Windows-1252; HTML export places pictures and charts, as inline SVG, at their anchors; earlier: `file.exportCsv {values: true}` writes raw values for automation; .xls dialog sheets are skipped instead of read as worksheets; `.xls` import reads each sheet's display options from WINDOW2: right-to-left, gridlines, headings, zeros, formulas; XLSX text boxes and shapes keep their paragraphs' right-to-left direction on save; CSV/TSV/TXT can open with every field kept as text via `file.open {csvAsText}`; formulas over Excel's 8,192 characters, and `%` or call chains past the nesting limit, are parse errors instead of stack overflows when a file is opened; XLSX PivotTables read and write `rowGrandTotals`/`colGrandTotals` the way Excel does, so a table saved with only one grand total opens with the right one; HTML export keeps right-to-left; CSV and text import detects likely Windows-1256 Arabic when invalid UTF-8 has Arabic byte runs; other invalid UTF-8 remains Windows-1252; HTML export places pictures and charts, as inline SVG, at their anchors; CSV and text open detects each column's date order from values that read only one way, warns when every date is ambiguous, and keeps a column with both kinds as text (#2765)) · **Target:** Microsoft Excel (Microsoft 365), Excel for Mac 16.113.4
|
||||
> **Last reviewed:** 2026-11-01 · **Last updated:** 2026-11-12 · **Change:** minor (.xls data validation is read; earlier: .xls is read by the shared craft-xls crate: the workbook opens on the sheet it was saved on, and rich-text (RString) cells are read; earlier: form controls: buttons, scroll bars and spin buttons read and written; earlier: a web page's first table opens as a sheet, also when the page is named `.xls`; earlier: `workbookPr filterPrivacy` kept, and honoured on save; earlier: a workbook's R1C1 reference style, `calcPr refMode`, is kept through open and save; earlier: XLSX page margins are written as their decimals, `0.3` rather than `0.30000001192092896`; earlier: Python cells in `.xlsx` as [MS-XLSX] specifies, `_xlfn._xlws.PY(…)` naming code in the Python part, with cached values, and in GridCraft JSON, with limits on open; earlier: equations in xlsx as Office Math with a marker in `descr` so an edit made in Excel reads back, read back only up to the equation source cap, and a brace with a label and a script on its other side keeps both; Symbol font in PDF; earlier: XLSX reads and writes Page Setup's page order, `pageSetup pageOrder`, and PDF export follows it; earlier: chart data tables: native c:dTable import/export; earlier: XLSX workbook-view selection, normalized tab ratios and sheet-edit regressions; fidelity estimates unchanged; earlier: formulas from Google Sheets' XLSX export open as the original formula instead of `IFERROR(__xludf.DUMMYFUNCTION(…),…)` when GridCraft calculates every function in it, and save as it; `file.exportCsv {values: true}` writes raw values for automation; .xls dialog sheets are skipped instead of read as worksheets; `.xls` import reads each sheet's display options from WINDOW2: right-to-left, gridlines, headings, zeros, formulas; XLSX text boxes and shapes keep their paragraphs' right-to-left direction on save; CSV/TSV/TXT can open with every field kept as text via `file.open {csvAsText}`; formulas over Excel's 8,192 characters, and `%` or call chains past the nesting limit, are parse errors instead of stack overflows when a file is opened; XLSX PivotTables read and write `rowGrandTotals`/`colGrandTotals` the way Excel does, so a table saved with only one grand total opens with the right one; HTML export keeps right-to-left; CSV and text import detects likely Windows-1256 Arabic when invalid UTF-8 has Arabic byte runs; other invalid UTF-8 remains Windows-1252; HTML export places pictures and charts, as inline SVG, at their anchors; earlier: `file.exportCsv {values: true}` writes raw values for automation; .xls dialog sheets are skipped instead of read as worksheets; `.xls` import reads each sheet's display options from WINDOW2: right-to-left, gridlines, headings, zeros, formulas; XLSX text boxes and shapes keep their paragraphs' right-to-left direction on save; CSV/TSV/TXT can open with every field kept as text via `file.open {csvAsText}`; formulas over Excel's 8,192 characters, and `%` or call chains past the nesting limit, are parse errors instead of stack overflows when a file is opened; XLSX PivotTables read and write `rowGrandTotals`/`colGrandTotals` the way Excel does, so a table saved with only one grand total opens with the right one; HTML export keeps right-to-left; CSV and text import detects likely Windows-1256 Arabic when invalid UTF-8 has Arabic byte runs; other invalid UTF-8 remains Windows-1252; HTML export places pictures and charts, as inline SVG, at their anchors; CSV and text open detects each column's date order from values that read only one way, warns when every date is ambiguous, and keeps a column with both kinds as text (#2765)) · **Target:** Microsoft Excel (Microsoft 365), Excel for Mac 16.113.4
|
||||
|
||||
Every format Excel opens or saves, with GridCraft's read and write support, fidelity and tests.
|
||||
Part of [target-app-parity.md](target-app-parity.md). **File formats: ~50% ready, 80–120 h**
|
||||
@@ -14,8 +14,6 @@ support comes from `crates/engine/src/io.rs` (`FileKind`), `crates/xlsx/src` and
|
||||
Legacy scalar `INDEX(range, MATCH(...))` formulas remain ordinary formulas on save, including when
|
||||
shared formulas are expanded during import (`array_export.rs`, #1505).
|
||||
|
||||
Arabic PDF output uses harfrust shaping, Unicode bidi and licensed Noto Arabic glyph outlines with ToUnicode and logical ActualText. Cells, headers and chart labels support marks, digits, rotation and style. Bundled builds use the optional `CRAFT_FONTS_DIR` input; unbundled native builds look for Noto Sans Arabic. Characters the Arabic face lacks fall back to the standard and CID fonts, and without an Arabic face for the text's weight Arabic is set in the CID font, which has no Arabic glyphs, with a message. Cell Context/LTR/RTL direction is carried through measurement, wrapping and drawing. RTL sheet geometry mirrors while text stays readable. Latin-only RTL text uses bidi ordering without requiring an Arabic font.
|
||||
|
||||
Cell text now uses shared Unicode bidi layout while retaining logical source indexes for editing, copy and XLSX. Format Cells exposes Context, Left to right and Right to left reading direction, independent of sheet geometry. OOXML Context uses the first non-whitespace character. Optional direction preserves absent versus explicit Context in differential styles. The renderer is pinned to a reviewed egui 0.36.2 backport with real-font, editing, accessibility and WASM checks. Physical screen-reader behavior remains unverified.
|
||||
|
||||
## Workbook window settings
|
||||
@@ -124,7 +122,7 @@ past the parser's limit, and a wrapper inside the text. **Saving writes the real
|
||||
|
||||
| Format | Excel | GridCraft | Notes |
|
||||
|---|---|---|---|
|
||||
| PDF | Save As / Export | yes (own PDF 1.7 writer; CLI `convert` output) | Printed cell hyperlinks export as clickable HTTP(S)/mailto links or destinations within printed pages (#954); unsafe schemes and destinations outside the print range are omitted. Latin text uses the standard Helvetica, Times and Courier faces (13 base-14 entries with Symbol), not embedded; Arabic exports as shaped, embedded Noto Arabic glyphs; cell reading direction and RTL sheet geometry are kept; other characters outside WinAnsiEncoding are set in a predefined, non-embedded CID font (STSong-Light, Adobe-GB1, `UniGB-UTF16-H`, #1912), so **Simplified Chinese displays where the reader supplies that font, and scripts outside Adobe-GB1 (Devanagari, Thai) export as code points but show as the reader's missing-glyph box**; equations use Symbol for the Greek letters and operators it has, the Times faces for letters and digits, and a `[?]` box for the rest; web build exports without a file prompt (#141) |
|
||||
| PDF | Save As / Export | yes (own PDF 1.7 writer; CLI `convert` output) | Printed cell hyperlinks export as clickable HTTP(S)/mailto links or destinations within printed pages (#954); unsafe schemes and destinations outside the print range are omitted. No font is embedded: text uses the standard Helvetica, Times and Courier faces (13 base-14 entries with Symbol), and characters outside WinAnsiEncoding are set in a predefined, non-embedded CID font (STSong-Light, Adobe-GB1, `UniGB-UTF16-H`), so **Simplified Chinese displays where the reader supplies that font, and scripts outside Adobe-GB1 (Arabic, Devanagari, Thai) export as code points but show as the reader's missing-glyph box**; equations use Symbol for the Greek letters and operators it has, the Times faces for letters and digits, and a `[?]` box for the rest; web build exports without a file prompt (#141) |
|
||||
| XPS | Windows | no | Low priority |
|
||||
| Print | yes | yes (via PDF, system dialog on desktop; PR #143 for web) | Pages print in the sheet's page order: down, then over (the default) or over, then down |
|
||||
| Images of ranges/charts (Copy as Picture) | yes | chart raster in `crates/chart` | No range-to-image command |
|
||||
@@ -163,12 +161,9 @@ refresh. Counted under features (Get & Transform, ~10% ready), not here.
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-11-13 | minor | PDF of a right-to-left sheet keeps explicit Left and Right alignment on the side the grid shows them |
|
||||
| 2026-11-12 | minor | `.xls` files open with their data validation (drop-down lists, input messages, error alerts and the rules), read by craft-xls and mapped as the `.xlsx` reader maps the same rules. A rule Excel would refuse, or one past 65,536 in a workbook, is skipped with a warning (#3634, from #3636) |
|
||||
| 2026-11-12 | minor | .xls import reads the file with craft-xls (storytold/craft-libs), the reader that moved there from this repository; GridCraft keeps the mapping onto its model. The workbook now opens on the sheet it was saved on (WINDOW1 `itabCur`), falling back to the first visible sheet as before (from #3551), and cells saved as RString records (text with formatting runs) are read as text instead of skipped |
|
||||
| 2026-11-10 | minor | `.xls` import: every formula except a Ctrl+Shift+Enter array is read as a legacy one with Excel's implicit `@` (a title row `=Other!A1:G1` shows its first cell instead of `#SPILL!`), one-cell Ctrl+Shift+Enter arrays stay arrays, and `@` of a 2-D range meets the formula's row and column (#410, PR #1367) |
|
||||
| 2026-11-09 | minor | Arabic PDF export no longer fails on a character the Arabic face lacks (it falls back like other text) or when no Arabic font is available (Arabic is set in the CID font, which has no Arabic glyphs, and a message says so) |
|
||||
| 2026-11-03 | trivial | The PDF row lists Arabic's shaped, embedded Noto glyphs beside the non-embedded standard faces, Symbol and the Adobe-GB1 CID font; Symbol text keeps its own encoding and is never shaped as Arabic |
|
||||
| 2026-11-02 | minor | XLSX: buttons, scroll bars and spin buttons read and written (control properties parts, `<controls>`, VML `x:ClientData`); other form controls stay with pass-through; a button's command, fixed input or output cell travels in a hidden defined name and comes back only while the file still assigns the button's macro (or none, for a command) |
|
||||
| 2026-11-03 | minor | SYLK (`.slk`) import: values, R1C1 formulas as A1 (shared formulas too) with cached results, number formats and column widths; import only (#1481) |
|
||||
| 2026-11-03 | minor | Opening a web page (HTML) reads its first table as a sheet, whatever the file is called: a web app's "Export to Excel" saved as `.xls` no longer opens as lines of markup. Values read as in a CSV (or as text with `csvAsText`), `<th>` cells are bold and centred, `<x:Name>` names the sheet, and a page not named `.htm`/`.html` opens with a warning (#3166) |
|
||||
@@ -190,8 +185,6 @@ refresh. Counted under features (Get & Transform, ~10% ready), not here.
|
||||
| 2026-11-01 | trivial | XLSX selects the first visible workbook view as one unit and bounds imported/exported tab ratios; isolated attributes and sheet-edit round trips covered, with firstSheet left to #2264 (#3057) |
|
||||
| 2026-10-31 | minor | CSV and text open detects each column's date order: a value that reads only day first (`31/05/2026`) makes the column day first, a value that reads only month first (`12/31/2026`) makes it month first, an all-ambiguous column keeps month first with a warning, and a column with both kinds stays text with a warning (#2765) |
|
||||
| 2026-10-31 | minor | XLSX open reads Google Sheets' `IFERROR(__xludf.DUMMYFUNCTION("…"),cached)` export wrapper as the formula inside when GridCraft calculates every function in it (plain, shared and array formulas, whole or nested; Google-only functions and unparseable, over-long or over-deep inner text keep the wrapper and the cached value) and keeps the cached value; saving writes the real formula with Excel's `_xlfn.` prefixes (#2871) |
|
||||
| 2026-10-26 | minor | PDF honors cell Context/LTR/RTL, preserves paragraph direction across wrapping, and mirrors RTL sheet geometry without reversing glyphs |
|
||||
| 2026-10-26 | minor | Arabic PDF export embeds licensed glyph outlines, joins letters and marks, preserves logical text and reports unsupported glyphs before writing; Arabic runs take the embedded faces ahead of the CJK CID font, and CJK inside Arabic text is set in the CID font instead of failing the export |
|
||||
| 2026-10-26 | minor | Alignment readingOrder 0/1/2 survives cell, named-style and differential-style round-trips; Format Cells exposes reading direction and CF priority preserves unspecified inheritance |
|
||||
| 2026-10-21 | minor | HTML (Save as Web Page) writes pictures (`data:` URI `<img>`) and charts (inline SVG from the chart crate's drawing primitives, text included) at their anchors; the table uses the sheet's column widths and row heights when the sheet has either, and output for sheets without pictures or charts is unchanged |
|
||||
| 2026-10-20 | trivial | XLSX shared strings: Japanese phonetic runs (ふりがな, `<rPh sb="…" eb="…">` with `<phoneticPr>`) are read into the workbook and written back next to the string with the same text, so an open + save no longer deletes them; bad offsets and readings are dropped with a warning, a `<phoneticPr>` without runs is kept on its own, and when duplicate `<si>` items share a text but not a reading only the first reading is written (reported on open) (`phonetic_tests.rs`) |
|
||||
@@ -216,6 +209,7 @@ refresh. Counted under features (Get & Transform, ~10% ready), not here.
|
||||
| 2026-10-15 | minor | XLSX: formulas and PivotTable sources quote sheet names like Excel (a leading `.`, R1C1-like and cell-like names), so `'.x'!A1` no longer saves as `.x!A1`, which Excel could not open (#1458) |
|
||||
| 2026-10-15 | minor | XLSX text preserves CR and CRLF across save/reopen; shared strings use `_x000D_` and other XML text uses ` ` (#1488) |
|
||||
| 2026-10-15 | minor | XLSX save keeps legacy `INDEX`/`MATCH` formulas scalar instead of marking them as dynamic arrays (#1505) |
|
||||
| 2026-10-14 | trivial | XLSX import warns when a pivot cache is missing, malformed or too large instead of dropping its PivotTable silently (#1039) |
|
||||
| 2026-10-14 | minor | `.xls` import reads cell formatting from the Font, XF, Palette and Style records: fonts, fills, borders, alignment, protection, the custom palette, the Normal font and user cell styles |
|
||||
| 2026-10-14 | trivial | Formula parser: text longer than Excel's 8,192 characters, and postfix chains (`1%%%…`, `f(1)(1)…`) past the 256-level nesting limit, are parse errors (the cell keeps its formula text and cached value) instead of trees deep enough to overflow the stack when a hostile file is opened, saved or dropped |
|
||||
| 2026-10-14 | minor | XLSX formulas read with dynamic-array metadata (`cm`) keep it on save, so Excel does not recalculate them with implicit intersection |
|
||||
|
||||
+13
-10
@@ -12,9 +12,13 @@ Excel's worksheet functions, category by category, against GridCraft's function
|
||||
them), plus 14 text functions the page lists under combined entries (FIND/FINDB, LEFT/LEFTB,
|
||||
LEN/LENB, MID/MIDB, REPLACE/REPLACEB, RIGHT/RIGHTB, SEARCH/SEARCHB), BETA.INV, and COPILOT and
|
||||
PY (Microsoft 365 functions not on that page when fetched).
|
||||
- **Ours (514):** every function spec in `crates/functions/src/*.rs` (`f!("NAME", …)`) plus the
|
||||
- **Ours (505):** every function spec in `crates/functions/src/*.rs` (`f!("NAME", …)`) plus the
|
||||
- **Ours (503):** every function spec in `crates/functions/src/*.rs` (`f!("NAME", …)`) plus the
|
||||
- **Ours (502):** every function spec in `crates/functions/src/*.rs` (`f!("NAME", …)`) plus the
|
||||
- **Ours (502):** every function spec in `crates/functions/src/*.rs` (`f!("NAME", …)`) plus the
|
||||
- **Ours (505):** every function spec in `crates/functions/src/*.rs` (`f!("NAME", …)`) plus the
|
||||
evaluator's special forms in `crates/calc/src/eval.rs` (`SPECIAL_FUNCTIONS`: IF, IFS, CHOOSE,
|
||||
OFFSET, INDIRECT, INDEX, GETPIVOTDATA, SUBTOTAL, AGGREGATE, TEXT, LET, LAMBDA, MAP, REDUCE, SCAN, BYROW, BYCOL,
|
||||
OFFSET, INDIRECT, INDEX, SUBTOTAL, AGGREGATE, TEXT, LET, LAMBDA, MAP, REDUCE, SCAN, BYROW, BYCOL,
|
||||
MAKEARRAY…), excluding the test-only `ADD2`. Every one is an Excel name.
|
||||
- **Not on Microsoft's list:** USDOLLAR and ECMA.CEILING, legacy functions Excel still evaluates (like DOLLAR),
|
||||
are in our library as Compatibility functions for files that use them. They are not counted above.
|
||||
@@ -25,7 +29,7 @@ Excel's worksheet functions, category by category, against GridCraft's function
|
||||
|
||||
## Coverage
|
||||
|
||||
**Measured: 514 / 523 by name (98.3%); 505 / 523 working (96.6%).**
|
||||
**Measured: 513 / 523 by name (98.1%); 504 / 523 working (96.4%).**
|
||||
|
||||
| Category | Excel | Ours | Working | % working | Missing |
|
||||
|---|---|---|---|---|---|
|
||||
@@ -34,7 +38,7 @@ Excel's worksheet functions, category by category, against GridCraft's function
|
||||
| Financial | 55 | 55 | 55 | 100% | — |
|
||||
| Engineering | 54 | 54 | 54 | 100% | — |
|
||||
| Text | 50 | 48 | 48 | 96% | DETECTLANGUAGE, TRANSLATE |
|
||||
| Lookup and reference | 40 | 38 | 38 | 95% | IMAGE, RTD |
|
||||
| Lookup and reference | 40 | 36 | 36 | 90% | GETPIVOTDATA, IMAGE, RTD, TRIMRANGE |
|
||||
| Compatibility | 40 | 40 | 40 | 100% | — |
|
||||
| Date and time | 25 | 25 | 25 | 100% | — |
|
||||
| Information | 22 | 21 | 21 | 95% | STOCKHISTORY |
|
||||
@@ -44,10 +48,10 @@ Excel's worksheet functions, category by category, against GridCraft's function
|
||||
| Web | 3 | 3 | 1 | 33% | (WEBSERVICE, FILTERXML are stubs; ENCODEURL works) |
|
||||
| Add-in and Automation | 3 | 1 | 1 | 33% | CALL, REGISTER.ID |
|
||||
| AI and Python | 2 | 0 | 0 | 0% | COPILOT, PY |
|
||||
| **Total** | **523** | **514** | **505** | **96.6%** | 9 missing, 9 stubs |
|
||||
| **Total** | **523** | **505** | **496** | **94.8%** | 18 missing, 9 stubs |
|
||||
|
||||
By the Excel version that introduced them (working / total): before 2010 349 / 360, 2010
|
||||
56 / 56, 2013 49 / 51, 2016 5 / 5, 2019 6 / 6, 2021 11 / 11, 2024 22 / 23, Microsoft 365 7 / 11.
|
||||
By the Excel version that introduced them (working / total): before 2010 346 / 360, 2010
|
||||
56 / 56, 2013 49 / 51, 2016 1 / 5, 2019 6 / 6, 2021 11 / 11, 2024 22 / 23, Microsoft 365 5 / 11.
|
||||
Dynamic-array and LAMBDA-era functions (FILTER, SORT, UNIQUE, XLOOKUP, VSTACK, TAKE, GROUPBY,
|
||||
PIVOTBY, REGEXTEST…) are all present.
|
||||
|
||||
@@ -62,7 +66,7 @@ This improves series preparation; it does not change the model-fitting or season
|
||||
|---|---|---|---|
|
||||
| FORECAST.ETS family (4) | yes | 4–6 h | AAA exponential smoothing with seasonality detection; needed for Forecast Sheet too |
|
||||
| ODDFPRICE, ODDFYIELD, ODDLPRICE, ODDLYIELD | yes | 2–4 h | Odd first/last period bond maths |
|
||||
| Generate GetPivotData | yes | 1–2 h | GETPIVOTDATA works; clicking a PivotTable value while typing a formula doesn't insert it yet |
|
||||
| GETPIVOTDATA | yes | 2–3 h | Needs the pivot engine's result cache; also the "Generate GetPivotData" option |
|
||||
| IMAGE | yes | 3–5 h | Pictures in cells (see PR #105); fetching URLs needs a privacy decision |
|
||||
| CUBE* (7), WEBSERVICE, FILTERXML | partly | 4–8 h | FILTERXML can work offline; CUBE needs an OLAP/data-model source |
|
||||
| TRANSLATE, DETECTLANGUAGE, STOCKHISTORY, COPILOT, PY | no (cloud) | — | Microsoft cloud services; open equivalents only by owner decision |
|
||||
@@ -124,7 +128,7 @@ inputs, so large finite middle values do not become `#NUM!` merely because their
|
||||
Sorting, argument coercion and error propagation are unchanged; this is a numerical correction
|
||||
under the documented median rule, not an extreme-value comparison against desktop Excel.
|
||||
|
||||
Work to close (15–25 h in total): the in-scope missing functions (10–16 h with the table above),
|
||||
Work to close (16–26 h in total): the in-scope missing functions (10–16 h with the table above),
|
||||
an oracle corpus of Excel-computed results per function (owner runs Excel on generated
|
||||
workbooks; results checked in as data, not Excel files) and fixing what it finds (6–10 h).
|
||||
|
||||
@@ -179,7 +183,6 @@ Positive fractional inputs still truncate, and signed zero remains valid. Covere
|
||||
| 2026-10-14 | minor | Bounded references up to 1,048,576 cells (`D3:AZ400`) keep their full shape instead of stopping at the used range, so `SUMPRODUCT(D3:AZ400*B3:B400,(A3:A400=x)*(D1:AZ1=y))` broadcasts like Excel and `ROWS`, `COUNTBLANK` and `--(r="")` count the blanks; references that run to the edge of the sheet (`A:A`) still stop at the used range (#1010) |
|
||||
| 2026-10-13 | minor | Legacy formulas from files (no dynamic-array metadata) evaluate with implicit intersection: cells differing from Excel's cached values 68,964 → 49,866 across 4,224 test-corpus workbooks (none gets more) |
|
||||
| 2026-10-13 | minor | Clear reports changed stored cells sparsely, including those beyond the first million coordinates; dependent formulas and removed spills update, while clearing empty merges still unblocks spills (#1032) |
|
||||
| 2026-10-12 | minor | GETPIVOTDATA added: 514 / 523 by name, 505 working |
|
||||
| 2026-10-12 | minor | USDOLLAR added as a Compatibility function (not on Microsoft's list, so the counts don't change); MIRR with no positive flow is -1, COUNTIF's bare `"<="` / `">="` skip empty strings, INDIRECT with `a1` = FALSE gives `#REF!` for A1-style text (#738) |
|
||||
| 2026-10-11 | minor | TEXT / number formats fixed against Excel-cached results: fraction literals and zero fractions, `0` denominators zero padded, `?` pads the thousands separator, booleans use the text section (226 mismatches → 0 in 352 TEXT cells) |
|
||||
| 2026-10-11 | minor | Iterative calculation: circular references iterate up to Maximum Iterations / Maximum Change when enabled |
|
||||
|
||||
+10
-9
@@ -1,6 +1,6 @@
|
||||
# Gaps
|
||||
|
||||
> **Last reviewed:** 2026-10-11 · **Last updated:** 2026-11-13 · **Change:** minor (§5: Arabic PDF output preserves cell direction, joined glyphs and RTL sheet geometry; earlier: §17: equations; earlier: §13: Solver Sensitivity report; earlier: §4: chart resizing is no longer a gap; earlier: §13: Analysis ToolPak has all 19 tools; earlier: §4: chart data tables implemented with XLSX round-trip and print/PDF; earlier: §13: Solver Options; earlier: §13: Solver Load/Save Model and Reset All) · **Target:** Microsoft Excel (Microsoft 365)
|
||||
> **Last reviewed:** 2026-10-11 · **Last updated:** 2026-11-02 · **Change:** minor (§17: equations; earlier: §13: Solver Sensitivity report; earlier: §4: chart resizing is no longer a gap; earlier: §13: Analysis ToolPak has all 19 tools; earlier: §4: chart data tables implemented with XLSX round-trip and print/PDF; earlier: §13: Solver Options; earlier: §13: Solver Load/Save Model and Reset All) · **Target:** Microsoft Excel (Microsoft 365)
|
||||
|
||||
Every known shortfall against Excel, one entry each, ranked by user impact (what blocks someone
|
||||
using GridCraft for real work first). This is the work list: pick from the top, check the open
|
||||
@@ -54,17 +54,17 @@ No alpha blockers: every core workflow passes the [alpha gate](roadmap.md#alpha-
|
||||
- **Estimate:** 25–35 h for beta (40–60 h full). [chart-parity.md](chart-parity.md)
|
||||
|
||||
### 5. Text in non-Latin scripts doesn't render or export (L)
|
||||
- **Missing:** cross-platform script coverage, Devanagari/Thai shaping verification, non-Latin PDF outside Arabic and Arabic UI layout.
|
||||
- **Missing:** cross-platform script coverage, Devanagari/Thai shaping verification, non-Latin PDF and Arabic UI layout.
|
||||
- **Evidence:** system-font fallback for CJK, Thai and Hebrew landed in #38 (closed #32); #142
|
||||
(Chinese text) awaits confirmation; #54 (symbols as boxes on Fedora). Arabic shared shaping/bidi,
|
||||
editing and cell Context/LTR/RTL now have focused regressions and full gates. Arabic font
|
||||
delivery and PDF output are separate PRs; other script shaping still needs verification.
|
||||
- **Missing:** CJK font fallback, complex shaping (Arabic, Devanagari, Thai), bidi, non-Latin PDF outside Arabic.
|
||||
- **Missing:** CJK font fallback, complex shaping (Arabic, Devanagari, Thai), bidi, non-Latin PDF.
|
||||
- **Evidence:** system-font fallback for CJK, Thai and Hebrew landed in #38 (closed #32), and for
|
||||
Arabic (system, fontconfig and craft-fonts faces); a UI font with Arabic of its own (DejaVu Sans
|
||||
in the Flatpak) still draws interface Arabic ahead of fontconfig's choice (#229); #142
|
||||
(Chinese text) awaits confirmation; #54 (symbols as boxes on Fedora); no shaping for Arabic or
|
||||
Devanagari in the UI. PDF now shapes Arabic with licensed glyph outlines, preserves cell reading direction, and mirrors RTL sheets.
|
||||
Devanagari; PDF writer uses 14 standard fonts only.
|
||||
- **Impact:** blocks most of the world's users even with an English UI.
|
||||
- **Estimate:** 12–20 h. [localization-parity.md](localization-parity.md)
|
||||
|
||||
@@ -91,8 +91,8 @@ No alpha blockers: every core workflow passes the [alpha gate](roadmap.md#alpha-
|
||||
|
||||
### 8. PivotTables: no slicers, calculated items, PivotCharts; unverified in Excel (F)
|
||||
- **Evidence:** `parity-checklist.md` missing `insert.slicer`, `insert.timeline`,
|
||||
`insert.pivotChart`, `table.insertSlicer`; calculated items and Generate GetPivotData missing (calculated fields,
|
||||
values on rows and GETPIVOTDATA done). Show Details (double-click a value, subtotal or grand total cell) lists
|
||||
`insert.pivotChart`, `table.insertSlicer`; calculated items and GETPIVOTDATA missing (calculated fields
|
||||
and values on rows done). Show Details (double-click a value, subtotal or grand total cell) lists
|
||||
its source records on a new sheet. The "Enable show details" option (`pivot.options`
|
||||
`enableShowDetails`, saved as `enableDrill`) turns it off; it has no PivotTable Options dialog
|
||||
yet (command only).
|
||||
@@ -142,7 +142,10 @@ No alpha blockers: every core workflow passes the [alpha gate](roadmap.md#alpha-
|
||||
Margins are dragged on the rulers (#792). Remaining: pictures in headers/footers, Different First Page / Odd & Even pages. Desktop now submits directly through craft-print with printer choice, copies, duplex and grayscale; browser printing stays available. Print ranges and driver tray/options UI remain. **Estimate:** 5–10 h.
|
||||
|
||||
### 15. Remaining functions and an oracle suite (F)
|
||||
- 9 missing, 9 stubs; no Excel-computed oracle corpus; #137, #138. **Estimate:** 15–25 h.
|
||||
- 18 missing, 9 stubs; no Excel-computed oracle corpus; #137, #138. **Estimate:** 16–26 h.
|
||||
- 20 missing, 9 stubs; no Excel-computed oracle corpus; #137, #138. **Estimate:** 17–29 h.
|
||||
- 21 missing, 9 stubs; no Excel-computed oracle corpus; #137, #138. **Estimate:** 18–30 h.
|
||||
- 18 missing, 9 stubs; no Excel-computed oracle corpus; #137, #138. **Estimate:** 18–30 h.
|
||||
[function-parity.md](function-parity.md)
|
||||
|
||||
### 16. Collaboration and review (F)
|
||||
@@ -197,7 +200,6 @@ No alpha blockers: every core workflow passes the [alpha gate](roadmap.md#alpha-
|
||||
| 2026-11-01 | minor | §4: chart data tables implemented for column, bar, line, area and compatible combo charts, with legend keys and border settings, live source values, XLSX round-trip and print/PDF; other chart gaps remain. |
|
||||
| 2026-10-31 | minor | §13: Solver Options (Max Evaluations, Integer Optimality and the Evolutionary options), saved with the model |
|
||||
| 2026-10-31 | minor | §13: Solver Load/Save Model (`data.solverSaveModel`, `data.solverLoadModel`) and Reset All (`data.solverReset`), with buttons in the Solver Parameters dialog |
|
||||
| 2026-10-26 | minor | §5: Arabic PDF output preserves cell direction, joined glyphs and RTL sheet geometry. Other script and UI gaps remain. |
|
||||
| 2026-10-26 | minor | Arabic shared bidi display/editing and persisted cell reading direction; other script and PDF work remain separate |
|
||||
| 2026-10-26 | minor | §5: Arabic text renders in cells and the interface: a system Arabic face (Tahoma, Arial or Segoe UI on Windows, Geeza Pro on macOS, Noto Sans or Naskh Arabic on Linux) joins the script fallbacks, fontconfig's Arabic choice, when it has Arabic letters, leads the Arabic fallbacks and draws Arabic wherever the UI or cell font has none, such as the default cell fonts (part of #229; a UI font with Arabic of its own, such as DejaVu Sans in the Flatpak, still draws interface Arabic, left for a follow-up), and craft-fonts' Noto Sans Arabic is a required face allowed on the web. Workbook fonts without Arabic keep every script fallback. Shaping and bidirectional layout remain separate work |
|
||||
| 2026-10-24 | minor | §8: PivotTable Enable show details: `pivot.options` `enableShowDetails` turns Show Details off for a PivotTable, read and written in XLSX as `enableDrill` |
|
||||
@@ -209,7 +211,6 @@ No alpha blockers: every core workflow passes the [alpha gate](roadmap.md#alpha-
|
||||
| 2026-10-15 | minor | §13: Solver prepares reports before committing the solution, model and report sheets together; report refusal preserves the workbook and Undo/Redo (#1050) |
|
||||
| 2026-10-13 | trivial | §4: multi-level category axes landed |
|
||||
| 2026-10-12 | minor | §9: next/previous sheet commands retain the current visible sheet and selection when there is no visible destination |
|
||||
| 2026-10-12 | minor | §8, §15: GETPIVOTDATA added (9 functions missing) |
|
||||
| 2026-10-12 | minor | rows auto-fit oversized fonts on open and whole-row/column formatting (#833) |
|
||||
| 2026-10-12 | minor | Page Layout view: dragging margins on the rulers (#792) removed from the §14 remainder |
|
||||
| 2026-10-12 | minor | §13: Forecast Sheet Forecast Start (hindcast) landed (#785) |
|
||||
|
||||
@@ -1,14 +1,12 @@
|
||||
# Localization parity
|
||||
|
||||
> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-13 · **Change:** minor (Arabic PDF export no longer fails when a character or the Arabic font is missing; Arabic PDF cells keep their reading direction and RTL pages mirror); previously minor (Ukrainian Chart is Діаграма); previously minor (Diagram and Decorative Text labels, Diagram distinct from Chart); previously minor (CJK fallback baseline alignment); previously minor (Arabic bidi display, editing and cell reading direction; missing translations are listed by `cargo xtask i18n-report` and never fail a check); previously minor (Arabic font fallback; missing translations are listed by `cargo xtask i18n-report` and never fail a check); previously minor (number formats honour the `B1`/`B2` calendar prefixes, checked against Excel; earlier: missing translations are listed by `cargo xtask i18n-report` and never fail a check; Arabic text sorts by its letters, not its vowel marks); previously minor (AutoFit estimates Arabic text width from measured glyph widths); previously minor (missing translations are listed by `cargo xtask i18n-report` and never fail a check; Arabic text sorts by its letters, not its vowel marks) · **Target:** Microsoft Excel (Microsoft 365), Excel for Mac 16.113.4
|
||||
> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-10 · **Change:** minor (Ukrainian Chart is Діаграма); previously minor (Diagram and Decorative Text labels, Diagram distinct from Chart); previously minor (CJK fallback baseline alignment); previously minor (Arabic bidi display, editing and cell reading direction; missing translations are listed by `cargo xtask i18n-report` and never fail a check); previously minor (Arabic font fallback; missing translations are listed by `cargo xtask i18n-report` and never fail a check); previously minor (number formats honour the `B1`/`B2` calendar prefixes, checked against Excel; earlier: missing translations are listed by `cargo xtask i18n-report` and never fail a check; Arabic text sorts by its letters, not its vowel marks); previously minor (AutoFit estimates Arabic text width from measured glyph widths); previously minor (missing translations are listed by `cargo xtask i18n-report` and never fail a check; Arabic text sorts by its letters, not its vowel marks) · **Target:** Microsoft Excel (Microsoft 365), Excel for Mac 16.113.4
|
||||
|
||||
Per-language status against Excel, which ships its UI in dozens of languages (Windows language
|
||||
packs cover 100+), with localized function names, argument separators, number and date formats,
|
||||
right-to-left sheets and full complex-script support. Part of
|
||||
[target-app-parity.md](target-app-parity.md). **Localization: ~10% ready, 100–165 h** (estimated).
|
||||
|
||||
Arabic PDF output uses harfrust shaping, Unicode bidi and licensed Noto Arabic glyph outlines with ToUnicode and logical ActualText. Cells, headers and chart labels support marks, digits, rotation and style. Bundled builds use the optional `CRAFT_FONTS_DIR` input; unbundled native builds look for Noto Sans Arabic. Characters the Arabic face lacks fall back to the standard and CID fonts, and without an Arabic face for the text's weight Arabic is set in the CID font, which has no Arabic glyphs, with a message. Cell Context/LTR/RTL direction is carried through measurement, wrapping and drawing. RTL sheet geometry mirrors while text stays readable. Latin-only RTL text uses bidi ordering without requiring an Arabic font.
|
||||
|
||||
Cell text now uses shared Unicode bidi layout while retaining logical source indexes for editing, copy and XLSX. Format Cells exposes Context, Left to right and Right to left reading direction, independent of sheet geometry. OOXML Context uses the first non-whitespace character. Optional direction preserves absent versus explicit Context in differential styles. The renderer is pinned to a reviewed egui 0.36.2 backport with real-font, editing, accessibility and WASM checks. Physical screen-reader behavior remains unverified.
|
||||
|
||||
## Where we are (measured from source on `main`, after the 2026-10-10 merges)
|
||||
@@ -76,15 +74,14 @@ Cell text now uses shared Unicode bidi layout while retaining logical source ind
|
||||
(`view.rightToLeft`, Page Layout › Sheet Options, XLSX `rightToLeft`, `.xls` WINDOW2 fRightToLeft) mirrors the grid (#146):
|
||||
column A and the row headers on the right, the vertical scrollbar on the left; hit-testing,
|
||||
arrow keys, editor, popups and floating objects follow; text follows its cell reading direction inside its box,
|
||||
and the sheet tabs and horizontal scrollbar are not mirrored yet; PDF export mirrors RTL sheets.
|
||||
and the sheet tabs, horizontal scrollbar and printing/PDF are not mirrored yet.
|
||||
Text boxes and shapes keep their paragraphs' right-to-left direction (`a:pPr rtl`) through XLSX
|
||||
save, though GridCraft still draws that text left to right. IME input goes
|
||||
through egui/winit and is unverified for Chinese, Japanese and Korean.
|
||||
- **Names in any script.** Defined names (Define Name, Create from Selection) are limited to
|
||||
255 characters, counted as characters rather than UTF-8 bytes, so a 255-letter Arabic name is
|
||||
accepted as in Excel. Sheet names already counted characters (31).
|
||||
- **PDF export** shapes Arabic with embedded Noto Arabic glyph outlines; CJK uses a predefined,
|
||||
non-embedded Adobe-GB1 CID font (#1912); Devanagari and Thai cannot export yet.
|
||||
- **PDF export** uses only the 14 standard PDF fonts: non-Latin text cannot export.
|
||||
|
||||
## Languages
|
||||
|
||||
@@ -98,7 +95,7 @@ separators, number/date formats, machine translation with agent review, and scri
|
||||
| Simplified Chinese (Mandarin) | zh-Hans | 266 (~12%) | no | CJK system-font fallback (#38); IME unverified; PDF can't export | no | menus only | 8–13 h |
|
||||
| Spanish | es | 0 (0%) | no | Latin: yes | no | none | 6–10 h |
|
||||
| Hindi | hi | 0 (0%) | no | Devanagari: **no shaping** | no | none | 12–18 h |
|
||||
| Arabic | ar | 0 (0%) | no | shared shaping/bidi; no Arabic UI catalog or mirrored shell; PDF export: shaped and joined, follows cell direction, mirrors RTL sheets; Sheet RTL mirrors the grid (#146) | no | none | 25–35 h |
|
||||
| Arabic | ar | 0 (0%) | no | shared shaping/bidi; no Arabic UI catalog or mirrored shell; Sheet RTL mirrors the grid (#146) | no | none | 25–35 h |
|
||||
| French | fr | 0 (0%) | no | Latin: yes | no | none | 6–10 h |
|
||||
| Portuguese | pt-BR | 943 (~43%) | dialogs and tooltips (dialogs take effect with #669) | Latin: yes | no | menus, File view, dialogs | 2–4 h |
|
||||
| Indonesian | id | 0 (0%) | no | Latin: yes | no | none | 5–8 h |
|
||||
@@ -138,14 +135,11 @@ language (none so far) and of localized function names.
|
||||
|---|---|---|
|
||||
| 2026-11-10 | minor | Ukrainian Chart is `Діаграма`, matching [craft-i18n#211](https://github.com/storytold/craft-i18n/pull/211) and distinct from Diagram (`Схема`) |
|
||||
| 2026-11-10 | minor | Diagram and Decorative Text labels in all 18 non-English catalogs; Diagram never repeats the catalog's chart word (German `Schema`, Ukrainian `Схема`, Romanian `Schemă`), see [feature-names.md](feature-names.md) |
|
||||
| 2026-11-09 | minor | Arabic PDF export no longer fails on a character the Arabic face lacks (it falls back like other text) or when no Arabic font is available (Arabic is set in the CID font, which has no Arabic glyphs, and a message says so) |
|
||||
| 2026-10-31 | minor | System and embedded CJK text fallbacks share the Latin baseline in cells, editors and window titles; other scripts, symbols and emoji keep their alignment |
|
||||
| 2026-10-26 | minor | Arabic PDF cells inherit explicit or contextual direction; wrapped lines retain paragraph direction, and RTL pages mirror cell and object geometry |
|
||||
| 2026-10-26 | minor | Shared bidi layout supports Arabic clusters, marks, visual cursor navigation and directional accessibility; cell Context/LTR/RTL is stored separately from sheet RTL and round-trips through XLSX |
|
||||
| 2026-10-26 | minor | Arabic text renders in cells and the interface: a system Arabic face (Tahoma, Arial or Segoe UI on Windows, Geeza Pro on macOS, Noto Sans or Naskh Arabic on Linux) joins the script fallbacks, fontconfig's Arabic choice, when it has Arabic letters, leads the Arabic fallbacks and draws Arabic wherever the UI or cell font has none, such as the default cell fonts (part of #229; a UI font with Arabic of its own, such as DejaVu Sans in the Flatpak, still draws interface Arabic, left for a follow-up), and craft-fonts' Noto Sans Arabic is a required face allowed on the web. Workbook fonts without Arabic keep every script fallback. Shaping and bidirectional layout remain separate work |
|
||||
| 2026-10-27 | minor | Number formats honour the `B1`/`B2` calendar prefixes: never shown; `B2` renders year, month, day and Arabic month and weekday names in the tabular Hijri calendar (1 Jan 2001 = 6 Shawwal 1421; leap years 2, 5, 7, 10, 13, 15, 18, 21, 24, 26 and 29 of the 30-year cycle, which is what Excel shows). Checked against Excel 16.0 (build 20527, en-US) on every serial and about 1,700 format/value pairs: a locale or currency tag before `B2` keeps the date Gregorian, a misplaced `B` and digit or a prefix before a number format is rejected, serial 60 has no Hijri date, serial 0 shows as serial 1, two-word month names use a no-break space. Not matched: Excel's weekday/month-name mix-ups in one `B2` section and its weekday-only quirks |
|
||||
| 2026-10-27 | minor | AutoFit column width, wrapped-row height and PivotTable column fit estimate Arabic letters at ~0.48 em (measured 0.36–0.53 em shaped, Noto Sans/Naskh Arabic and DejaVu Sans) instead of 1 em, Arabic-Indic digits as wide as ASCII digits, and give vowel marks and direction marks no width; vowelled Arabic no longer fits ~3.5× too wide |
|
||||
| 2026-10-26 | minor | Arabic PDF cells, headers and chart labels support joined letters, combining marks, digits, bold/italic, rotation and grapheme wrapping |
|
||||
| 2026-10-23 | minor | Missing translations are reported, never a failure: `cargo xtask i18n-report` prints, per language, the strings other catalogs translate and it lacks (plus Spanish function help rows keyed by English the function catalog no longer has) and always passes; `cargo xtask ci` runs it first. Coverage and per-language parity tests and tests of one language's exact wording are gone; UI tests take the expected text from the catalog. Duplicate-key, placeholder, context-prefix and line-shape checks stay |
|
||||
| 2026-10-21 | minor | Romanian interface (`ro`, Română): 970 labels covering every key of the other catalogs (`crates/ui-egui/src/i18n/ro.rs`), `ro-*` system locales, the View-tab switcher and `app.language.set`; context keys show no prefix (File › Options test). English formulas and formats; AI-assisted draft pending native-speaker review |
|
||||
| 2026-10-20 | minor | Japanese: furigana (`rPh` phonetic runs and `<phoneticPr>` in `xl/sharedStrings.xml`) is no longer deleted by an open + save; it is kept on the workbook and written back (a `<phoneticPr>` without runs is kept too, while duplicate texts with different readings keep only the first, reported on open). Display of the readings is still missing (`crates/xlsx/src/tests/phonetic_tests.rs`) |
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
# The sandbox for helper processes
|
||||
|
||||
> **Last updated:** 2026-11-12 · **Change:** minor (no signals to another process on Linux, not even indirectly: `fcntl`'s notification commands and the socket ioctls that do the same are refused; earlier: no file changes by any route on Linux: Landlock's truncation right is required, and seccomp refuses what Landlock has no right for; earlier: more is refused on Linux: other processes, System V and POSIX queues, the terminal; earlier: first version: the `sandbox` crate and `gridcraft-cli sandbox-check`)
|
||||
> **Last updated:** 2026-11-07 · **Change:** minor (no file changes by any route on Linux: Landlock's truncation right is required, and seccomp refuses what Landlock has no right for; earlier: more is refused on Linux: other processes, System V and POSIX queues, the terminal; earlier: first version: the `sandbox` crate and `gridcraft-cli sandbox-check`)
|
||||
|
||||
The sandbox is the layer GridCraft is to run code it doesn't trust in, such as a workbook's
|
||||
Python cells: a separate process that confines itself before the code starts. Here only
|
||||
@@ -24,7 +24,7 @@ other programs. The sandbox's job is that it can do none of these:
|
||||
- **Network:** no sockets, no connections and no listeners. The exception is a standard stream the
|
||||
parent made a socket (see below).
|
||||
- **Other processes and the system:** no debugging or reading another process, no System V shared
|
||||
memory, message queues or semaphores, no POSIX message queues, no signals to another process — on Linux not even indirectly, as the `fcntl` commands and socket ioctls that have the kernel send one are refused — no typing into a terminal it inherited, no mounts or namespaces, no kernel
|
||||
memory, message queues or semaphores, no POSIX message queues, no signals to another process, no typing into a terminal it inherited, no mounts or namespaces, no kernel
|
||||
modules, BPF, keyrings or performance counters. On Linux it also can't change another process's
|
||||
limits, priority or scheduling.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Target-app parity: GridCraft vs Microsoft Excel
|
||||
|
||||
> **Last reviewed:** 2026-10-11 · **Last updated:** 2026-11-15 · **Change:** minor (performance: formula entry and XLSX save win back time lost since 23829d8c (#2654), 465 → 420 ms and 540 → 488 ms on the 100k-row benchmark; Sandbox refuses fcntl's asynchronous notification and the socket ioctls that notify another process on Linux (#3846); CI provisions pinned fonts for coverage tests; no score change; earlier: form controls; catalog 281 / 296; earlier: insert objects: equations; earlier: what-if and analysis: Solver Sensitivity report; no score change; earlier: chart resizing no longer listed as missing; no score change; earlier: what-if and analysis: Analysis ToolPak has all 19 tools; earlier: page layout and print: Page Setup's page order; no score change; earlier: charts: data tables with XLSX round-trip and print/PDF; no score change; earlier: what-if and analysis: Solver Options; the Insert Function dialog is named as in Excel; no score change; earlier: Solver Load/Save Model and Reset All; automation: macro interface; catalog count 276 / 292, as `cargo xtask parity` measures; automation: typed macros in the engine; several windows: a native window per workbook window, New Window on the same workbook, Arrange All; no score change) · **Target:** Microsoft Excel (Microsoft 365)
|
||||
> **Last reviewed:** 2026-10-11 · **Last updated:** 2026-11-02 · **Change:** minor (form controls; catalog 281 / 296; earlier: insert objects: equations; earlier: what-if and analysis: Solver Sensitivity report; no score change; earlier: chart resizing no longer listed as missing; no score change; earlier: what-if and analysis: Analysis ToolPak has all 19 tools; earlier: page layout and print: Page Setup's page order; no score change; earlier: charts: data tables with XLSX round-trip and print/PDF; no score change; earlier: what-if and analysis: Solver Options; the Insert Function dialog is named as in Excel; no score change; earlier: Solver Load/Save Model and Reset All; automation: macro interface; catalog count 276 / 292, as `cargo xtask parity` measures; automation: typed macros in the engine; several windows: a native window per workbook window, New Window on the same workbook, Arrange All; no score change) · **Target:** Microsoft Excel (Microsoft 365)
|
||||
|
||||
This is the authoritative parity assessment. [`ROADMAP.md`](../ROADMAP.md) summarizes it,
|
||||
[`gaps.md`](gaps.md) lists every shortfall, and the area checklists hold the detail:
|
||||
@@ -14,8 +14,8 @@ generated ribbon checklist is [`parity-checklist.md`](parity-checklist.md).
|
||||
|---|---|---|
|
||||
| Feature breadth (weighted by use) | **~75%** | estimated from the area table below; anchored on two measurements |
|
||||
| Ribbon and menu catalog | **281 / 296 (94.9%)** | measured: `cargo xtask parity` (`crates/engine/src/catalog.rs` ∩ registered command ids) |
|
||||
| Worksheet functions, by name | **514 / 523 (98.3%)** | measured: registered functions vs Microsoft's published function list (method below) |
|
||||
| Worksheet functions that do real work | **505 / 523 (96.6%)** | measured: excludes 9 stubs (7 CUBE functions, WEBSERVICE, FILTERXML) |
|
||||
| Worksheet functions, by name | **513 / 523 (98.1%)** | measured: registered functions vs Microsoft's published function list (method below) |
|
||||
| Worksheet functions that do real work | **504 / 523 (96.4%)** | measured: excludes 9 stubs (7 CUBE functions, WEBSERVICE, FILTERXML) |
|
||||
| **Ready for real work** | **~50%** | estimated; written weights below (51.6 computed) |
|
||||
| **Mainstream practitioner** | **~50%** | estimated; [method](#mainstream-practitioner) (69.5 depth × 0.90 × 0.92 × 0.88 = 50.6) |
|
||||
| **Essentials user** | **~63%** | estimated; [method](#essentials-user) (80.2 depth × 0.92 × 0.95 × 0.90 = 63.1) |
|
||||
@@ -81,11 +81,11 @@ performance 8, stability 8, localization 4, hardware 2, platforms 2, ecosystem 2
|
||||
| Area | Weight | Breadth | Ready | Hours | Evidence |
|
||||
|---|---|---|---|---|---|
|
||||
| Formula language and calculation | 18 | ~92% | ~72% | 20–30 | A1/R1C1 parser, reference adjustment, dependency-graph recalc, dynamic arrays and `#SPILL!`, `A1#`, LET/LAMBDA and helpers, structured references, names, 3-D references. Open correctness bugs: 15-digit equality (#57), stale spills after structural edits and cleared blockers (#133, #139), 3-D span endpoint deletion (#140), sheet rename and qualified names (#134). Single-threaded |
|
||||
| Worksheet functions | 12 | 98.3% (measured) | ~82% | 15–25 | 514 / 523 names, 505 working. Missing: IMAGE plus cloud functions. No conformance suite against Excel-computed oracles; edge-case bugs keep surfacing (#137, #138). [function-parity.md](function-parity.md) |
|
||||
| Worksheet functions | 12 | 98.1% (measured) | ~82% | 16–26 | 513 / 523 names, 504 working. Missing: GETPIVOTDATA, IMAGE plus cloud functions. No conformance suite against Excel-computed oracles; edge-case bugs keep surfacing (#137, #138). [function-parity.md](function-parity.md) |
|
||||
| Editing, navigation, clipboard, fill | 12 | ~90% | ~70% | 15–25 | Point mode, F4, AutoComplete, Paste Special, AutoFill, Flash Fill, Find/Replace, Go To Special. Bugs: rectangular drag-select (#28), monthly fill (#132), cut across sheets (#128), Insert Copied Cells missing (#21), key tips only on part of the Home tab (#43; #33, #49). [ui-parity.md](ui-parity.md) |
|
||||
| Cell formatting, styles, conditional formatting | 10 | ~95% | ~80% | 8–14 | Full number-format language, borders, 47 cell styles, 60 table styles, all CF rule kinds including data bars, colour scales and icon sets. Gaps: font weights beyond regular/bold (#168), system fonts list (#4), themes |
|
||||
| Sort, filter, tables, validation, outline | 8 | ~82% | ~70% | 10–16 | Multi-level sort, AutoFilter, Advanced Filter, tables with totals, validation, outline, subtotals, consolidate. Advanced Filter copy-to preserves cells outside its result and rejects worksheet overflow (#1031). Bugs: subtotal header (#131), validation edits (#129), table style panic caught (#130); no slicers on tables |
|
||||
| PivotTables | 7 | ~65% | ~45% | 25–40 | Insert/Recommended, field list, three layouts, values on rows or columns, date grouping, show-values-as, refresh, calculated fields, GETPIVOTDATA, XLSX round-trip. Missing: slicers, timelines, calculated items, PivotCharts, value/label filters, number grouping, Generate GetPivotData, data-model pivots. Round-trip never checked in Excel |
|
||||
| PivotTables | 7 | ~65% | ~45% | 25–40 | Insert/Recommended, field list, three layouts, values on rows or columns, date grouping, show-values-as, refresh, calculated fields, XLSX round-trip. Missing: slicers, timelines, calculated items, PivotCharts, value/label filters, number grouping, GETPIVOTDATA, data-model pivots. Round-trip never checked in Excel |
|
||||
| Charts and sparklines | 8 | ~50% | ~30% | 40–60 | 25 chart kinds, all 2-D. Doughnut charts draw every series as a concentric ring (first series innermost), with editable hole size and first slice angle. The chart model holds title, legend position, a data-labels flag, gridlines flag, axis titles and chart data tables (legend keys, borders, XLSX round-trip and print/PDF); no axis scaling, error bars, per-point formatting, chart sheets, 3-D, surface, map, Pareto. Kinds survive XLSX round trip (#158, #161), except stock charts: only 3–4 series are a stock chart, and any other count is written and reimported as a line chart. [chart-parity.md](chart-parity.md) |
|
||||
| Page layout, print, PDF | 5 | ~80% | ~55% | 12–20 | Page setup, print titles, breaks, page order, Page Break Preview, headers/footers, PDF export and printing. Paper sizes match Japanese Excel: B4/B5/B6 are the JIS sizes, ISO B4/B5/B6 stay reachable by name, and Japanese Postcard (はがき), Japanese Double Postcard (往復はがき), the chou/kaku envelopes and A6 are available. No true Page Layout view; the PDF writer uses only the 14 standard fonts without embedding (no CJK or other non-Latin text in PDF); web print only exports (#141, #143) |
|
||||
| What-if and analysis | 4 | ~50% | ~40% | 22–35 | Goal Seek, Scenario Manager, data tables, Analysis ToolPak (all 19 tools, no charts), Solver (Simplex LP, a local nonlinear method and Evolutionary; Answer, Sensitivity and Limits reports; Load/Save Model, Reset All and Solver Options; no Population report), Forecast Sheet. Missing: Analyze Data |
|
||||
@@ -334,7 +334,6 @@ The inventory carried over from the 2026-10-07 ROADMAP.md, updated for what land
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-11-15 | minor | Performance: formula entry 465 → 420 ms and XLSX save 540 → 488 ms on the 100k-row benchmark (#2654); Sandbox refuses fcntl's asynchronous notification and notifying socket ioctls on Linux (#3846); CI provisions pinned fonts for coverage tests; no score change |
|
||||
| 2026-11-02 | minor | Form controls (buttons, scroll bars, spin buttons) in Insert objects and Automation; catalog 277 / 292 → 281 / 296 (Developer › Controls) |
|
||||
| 2026-11-02 | minor | Insert objects: equations; catalog count 277 / 292 (no score change) |
|
||||
| 2026-11-02 | minor | What-if and analysis: Solver Sensitivity report (no score change) |
|
||||
@@ -352,7 +351,6 @@ The inventory carried over from the 2026-10-07 ROADMAP.md, updated for what land
|
||||
| 2026-10-18 | trivial | Stale chart notes: all chart kinds survive XLSX round-trip (PRs #158, #161) and trendlines landed |
|
||||
| 2026-10-16 | minor | Advanced Filter copy-to clears only its actual output and rejects overflow without changing cells (#1031) |
|
||||
| 2026-10-15 | minor | Row auto-fit: line breaks count only in wrapping cells (Excel: wrap off shows one line, AutoFit gives one line); unwrapped multi-line cells from files no longer grow rows on open (no score change) |
|
||||
| 2026-10-12 | minor | Worksheet functions 514 / 523 (98.3%; 505 working): GETPIVOTDATA |
|
||||
| 2026-10-21 | minor | Automation: typed macros in the engine and `macro.*` commands, no interface yet (no score change); catalog 274 / 290 → 275 / 291 (View › Macros › Record Macro) |
|
||||
| 2026-10-12 | minor | Essentials AutoFit evidence: rows auto-fit oversized fonts on open and row formatting (#833) |
|
||||
| 2026-10-12 | minor | Sheet tabs: reveal the selected tab on navigation and resize while preserving manual scrolling (#681); no score change |
|
||||
|
||||
Reference in New Issue
Block a user