Compare commits

..
Author SHA1 Message Date
FredApps ab65ee8eb8 Release: GridCraft v0.20.0 (main f2044337c7) 2026-11-14 21:46:35 +01:00
FredApps 9b9c956068 Release: GridCraft v0.20.0 2026-11-14 21:46:32 +01:00
Dylan M. Taylor 476448d7d9 Merge tested main for Flatpak update patch release 2026-11-11 15:25:59 -05:00
Dylan M. Taylor 26f9783d11 Release 0.19.1: repair Flatpak update checks and self-updates (#3804)
* Release 0.19.1: fix Flatpak update permissions

* test: avoid unchecked option parsing in Flatpak regression
2026-11-11 14:27:27 -05:00
FredApps b7cb2c97dd Merge main into release for GridCraft v0.19.0 2026-11-11 17:35:47 +01:00
FredApps fd10b86cc2 Merge main into release for GridCraft v0.19.0 2026-11-11 16:38:57 +01:00
Dylan M. Taylor 17cb3c83d9 Release 0.18.0 2026-11-09 06:32:01 -05:00
162 changed files with 2724 additions and 12524 deletions
-29
View File
@@ -1,29 +0,0 @@
# This file is machine-generated by `gh actions-lock`.
# Do not edit by hand; run `gh actions-lock` to update.
# Docs: https://gh.io/actions-lockfile
version: 'v0.0.3'
workflows:
'.github/workflows/ci.yml': []
'.github/workflows/freebsd.yml': []
'.github/workflows/house-rules.yml': []
'.github/workflows/lockfile.yml':
- 'actions/checkout@v7.0.1'
- 'step-security/harden-runner@v2.22.4'
'.github/workflows/nix.yml': []
'.github/workflows/packaging-lint.yml':
- 'actions/checkout@v7.0.1'
- 'step-security/harden-runner@v2.22.4'
'.github/workflows/release.yml': []
'.github/workflows/sonarcloud.yml': []
'.github/workflows/windows-arm64.yml': []
dependencies:
'actions/checkout@v7.0.1':
ref: 'v7.0.1'
commit: 'sha1-3d3c42e5aac5ba805825da76410c181273ba90b1'
owner_id: 44036562
repo_id: 197814629
'step-security/harden-runner@v2.22.4':
ref: 'v2.22.4'
commit: 'sha1-1d88384fd173af6ecb012dfd0264a306b711241a'
owner_id: 88700172
repo_id: 422287306
-34
View File
@@ -1,34 +0,0 @@
name: Lockfile
# Fails when .github/workflows/actions.lock is out of sync with the workflows, or when a locked pin
# no longer verifies upstream, so a moved tag cannot slip a different commit into a run.
# Docs: https://gh.io/actions-lockfile
on:
pull_request:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
env:
GH_TOKEN: ${{ github.token }}
jobs:
lockfile:
name: Lockfile is in sync
runs-on: ubuntu-24.04
timeout-minutes: 10
steps:
- name: Harden runner
uses: step-security/harden-runner@v2.22.4
with:
egress-policy: audit
- uses: actions/checkout@v7.0.1
with:
persist-credentials: false
- name: Install gh-actions-lock
run: gh extension install github/gh-actions-lock --pin v0.4.1
- name: Verify the lockfile
run: gh actions-lock --verify
+2 -2
View File
@@ -28,10 +28,10 @@ jobs:
runs-on: windows-latest
steps:
- name: Harden runner
uses: step-security/harden-runner@v2.22.4
uses: step-security/harden-runner@1d88384fd173af6ecb012dfd0264a306b711241a # v2.22.4
with:
egress-policy: audit
- uses: actions/checkout@v7.0.1
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install the pinned packaging toolchain
-3
View File
@@ -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
-4
View File
@@ -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
View File
@@ -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
+28 -103
View File
@@ -922,42 +922,21 @@ dependencies = [
[[package]]
name = "craft-cfb"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
[[package]]
name = "craft-csv"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"thiserror 2.0.21",
]
[[package]]
name = "craft-drawingml"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
dependencies = [
"craft-xml",
"kurbo",
"log",
"serde",
]
[[package]]
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"
@@ -984,7 +963,7 @@ dependencies = [
[[package]]
name = "craft-offcrypto"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"aes",
"base64 0.23.1",
@@ -1001,7 +980,7 @@ dependencies = [
[[package]]
name = "craft-opc"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"craft-xml",
"craft-zip",
@@ -1009,11 +988,6 @@ dependencies = [
"thiserror 2.0.21",
]
[[package]]
name = "craft-pdf"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=ff142b3ad58aa7306676749428f4f2f9b277b5dd#ff142b3ad58aa7306676749428f4f2f9b277b5dd"
[[package]]
name = "craft-print"
version = "0.1.0"
@@ -1031,18 +1005,7 @@ dependencies = [
[[package]]
name = "craft-sheet"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
[[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",
]
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
[[package]]
name = "craft-ui"
@@ -1067,7 +1030,7 @@ dependencies = [
[[package]]
name = "craft-update"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"chrono",
"dunce",
@@ -1114,7 +1077,7 @@ dependencies = [
[[package]]
name = "craft-window"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"egui",
"objc2 0.6.5",
@@ -1133,7 +1096,7 @@ dependencies = [
[[package]]
name = "craft-xls"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"craft-cfb",
"craft-sheet",
@@ -1143,22 +1106,10 @@ dependencies = [
"thiserror 2.0.21",
]
[[package]]
name = "craft-xlsx"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
dependencies = [
"craft-drawingml",
"craft-opc",
"craft-sheet",
"craft-xml",
"thiserror 2.0.21",
]
[[package]]
name = "craft-xml"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"quick-xml 0.41.0",
"thiserror 2.0.21",
@@ -1167,7 +1118,7 @@ dependencies = [
[[package]]
name = "craft-zip"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=e98299546f5c5c3c22388d16507f8b5e61a5f280#e98299546f5c5c3c22388d16507f8b5e61a5f280"
source = "git+https://github.com/storytold/craft-libs?rev=bb57d422d0bc842cbde430955825553ab7b976f4#bb57d422d0bc842cbde430955825553ab7b976f4"
dependencies = [
"flate2",
"thiserror 2.0.21",
@@ -2175,7 +2126,7 @@ dependencies = [
[[package]]
name = "gridcraft"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"arboard",
"chrono",
@@ -2203,7 +2154,7 @@ dependencies = [
[[package]]
name = "gridcraft-calc"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"gridcraft-core",
"gridcraft-formula",
@@ -2215,7 +2166,7 @@ dependencies = [
[[package]]
name = "gridcraft-chart"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"gridcraft-calc",
"gridcraft-core",
@@ -2226,7 +2177,7 @@ dependencies = [
[[package]]
name = "gridcraft-cli"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"gridcraft-engine",
"gridcraft-mcp",
@@ -2239,7 +2190,7 @@ dependencies = [
[[package]]
name = "gridcraft-core"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"chrono",
"js-sys",
@@ -2250,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",
@@ -2269,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",
@@ -2285,7 +2234,7 @@ dependencies = [
[[package]]
name = "gridcraft-functions"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"gridcraft-core",
"regex",
@@ -2293,7 +2242,7 @@ dependencies = [
[[package]]
name = "gridcraft-math"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"ratex-font",
"ratex-layout",
@@ -2303,7 +2252,7 @@ dependencies = [
[[package]]
name = "gridcraft-mcp"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"gridcraft-engine",
"log",
@@ -2312,7 +2261,7 @@ dependencies = [
[[package]]
name = "gridcraft-model"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"gridcraft-core",
"gridcraft-formula",
@@ -2325,26 +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-pdf",
"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",
@@ -2355,7 +2296,7 @@ dependencies = [
[[package]]
name = "gridcraft-ui-egui"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"craft-ui",
"craft-update",
@@ -2382,7 +2323,7 @@ dependencies = [
[[package]]
name = "gridcraft-web"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"craft-web-api",
"craft-web-host",
@@ -2401,15 +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-xlsx",
"craft-xml",
"gridcraft-core",
"gridcraft-formula",
"gridcraft-functions",
@@ -2502,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"
@@ -6911,7 +6836,7 @@ checksum = "e450f9b2ed1dff33c94c12589a87338689467b9c4f5d8a5710bd09a847d2c8a7"
[[package]]
name = "xtask"
version = "0.19.1"
version = "0.20.0"
dependencies = [
"gridcraft-engine",
"serde_json",
+8 -16
View File
@@ -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"
@@ -30,25 +30,17 @@ gridcraft-math = { path = "crates/math" }
# ui-egui, craft-print in the app, craft-web-api and craft-web-host in the web app) comes from one
# 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 = "e98299546f5c5c3c22388d16507f8b5e61a5f280", version = "=0.1.0", features = ["egui"] }
# PDF RunLength encoding; this revision also fixes the vendored JBIG2 dependency for Git consumers.
craft-pdf = { git = "https://github.com/storytold/craft-libs", rev = "ff142b3ad58aa7306676749428f4f2f9b277b5dd", version = "0.1.0", default-features = false }
craft-stream-codecs = { git = "https://github.com/storytold/craft-libs", rev = "f7e0d7fd5577e102b4634bcbe062e649eb68165f", version = "0.1.0" }
craft-update = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "=0.1.0", features = ["egui"] }
# Compound files ([MS-CFB]) and password-encrypted OOXML packages ([MS-OFFCRYPTO]).
craft-cfb = { git = "https://github.com/storytold/craft-libs", rev = "e98299546f5c5c3c22388d16507f8b5e61a5f280", version = "0.1.0" }
craft-offcrypto = { git = "https://github.com/storytold/craft-libs", rev = "e98299546f5c5c3c22388d16507f8b5e61a5f280", version = "0.1.0" }
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" }
# OPC zip packages (parts, relationships, the zip writer) under `crates/xlsx/src/package.rs`.
craft-opc = { git = "https://github.com/storytold/craft-libs", rev = "e98299546f5c5c3c22388d16507f8b5e61a5f280", version = "0.1.0" }
craft-opc = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
# 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 = "e98299546f5c5c3c22388d16507f8b5e61a5f280", 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" }
craft-csv = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
# Excel 97-2003 (.xls, BIFF8) workbooks; `crates/xlsx/src/xls.rs` maps them onto the model.
# SpreadsheetML string encoding/decoding; workbook model mapping stays in gridcraft-xlsx.
craft-xlsx = { git = "https://github.com/storytold/craft-libs", rev = "e98299546f5c5c3c22388d16507f8b5e61a5f280", version = "0.1.0" }
craft-xml = { git = "https://github.com/storytold/craft-libs", rev = "e98299546f5c5c3c22388d16507f8b5e61a5f280", version = "0.1.0" }
craft-xls = { git = "https://github.com/storytold/craft-libs", rev = "e98299546f5c5c3c22388d16507f8b5e61a5f280", version = "0.1.0" }
craft-xls = { git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", version = "0.1.0" }
# foundation
thiserror = "2"
@@ -88,7 +80,7 @@ skrifa = { version = "0.44", default-features = false, features = ["std"] }
epaint_default_fonts = "0.37"
# One native window per workbook: the window list, Window menu titles and the immediate-viewport
# driver. Same craft-libs revision as craft-update above.
craft-window = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "e98299546f5c5c3c22388d16507f8b5e61a5f280", default-features = false, features = ["egui"] }
craft-window = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "bb57d422d0bc842cbde430955825553ab7b976f4", default-features = false, features = ["egui"] }
[workspace.lints.rust]
unsafe_code = "forbid"
+1 -1
View File
@@ -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 -12
View File
@@ -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 |
@@ -177,14 +174,13 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
| 2026-10-19 | Long flat operator chains (`=A1+A2+…`) up to Excel's 8,192-character limit (4,096 operands): entering, filling, inserting rows, undo, Evaluate Formula and XLSX save no longer overflow the stack; chains past 64 operands are saved as plain formulas, not dynamic arrays; Spanish formula entry accepts chains past 256 operands (#916) |
| 2026-10-19 | Linux: "Use system setting" for the theme keeps following the desktop when the XDG Desktop Portal stops answering: each read gives up after 2 s and the next poll reconnects, where one unanswered call stalled the watcher for the rest of the session |
| 2026-10-16 | Memory: undo steps share a sheet's picture bytes and the workbook's VBA project instead of copying them: 50 edits on a sheet with a 20 MB picture keep 22 MB instead of 992 MB |
| 2026-10-16 | Custom Sort dialog: header-named column dropdowns, smart Order labels, add/delete/copy/move levels, resizable window, selection follows the headers checkbox and returns on close; a selected block (such as a table's totals row) is sorted as selected |
| 2026-10-16 | Memory: floating pictures are decoded at about the size they are drawn, with limits, into a cache bounded by bytes and dropped with their workbook, instead of at full size into one that never let go; two open workbooks no longer show each other's picture. 12 large pictures scrolled through keep 40 MB of textures instead of 258 MB, and none once the workbook closes |
| 2026-10-16 | The web app keeps its preferences between visits (#1562): theme (dark mode), interface size, language, editing options and the rest of what the desktop app saves in `ui.json` and `prefs.json` are kept in the browser's `localStorage`, written as soon as they change |
| 2026-10-16 | Memory: the interface and script fallback fonts are read once per run and shared with egui instead of copied into it: an empty workbook settles at 158 MB instead of 258 MB on macOS |
| 2026-10-15 | Function help in Brazilian Portuguese: every description and argument name (479 and 283) |
| 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,10 +199,8 @@ Ranked; estimates in Opus 5.5 agent-hours. Detail and the full beta-gate list in
| 2026-10-13 | XLSX export writes a picture used on several sheets once, as one `xl/media` part every drawing points to (it wrote a copy per drawing: a 16-sheet workbook with one 112 KB logo grew from 0.4 to 1.9 MB) (#985) |
| 2026-10-13 | XLSX: `[Content_Types].xml`, `_rels/.rels`, the workbook rels and `xl/workbook.xml` are the first zip entries (document properties last), so libmagic and PHP `finfo` detect the file type even with large properties (#1090) |
| 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 | Spills: an array that grows into cells another array's spill already holds is `#SPILL!`, in automatic calculation and after Calculate Now, as in Excel; a workbook reopened from XLSX keeps the spill layout it was saved with (#964, found by the command-sequence fuzz) |
| 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) |
@@ -292,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 |
@@ -314,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 |
@@ -326,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) |
-2
View File
@@ -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,
+1 -107
View File
@@ -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`.
+26 -56
View File
@@ -12,10 +12,10 @@
//! - `gridcraft:open` (from the host): `{ name, bytes }`. It opens like a workbook picked with
//! File › Open or dropped on the window; a file over [`MAX_OPEN_BYTES`] is refused before it is
//! copied.
//! - `gridcraft:save` (to the host): `{ name, saveAs, bytes, export }` for every file GridCraft
//! would otherwise download. With `export: false`, the host stores the XLSX workbook; with
//! `export: true`, it stores a separate file (such as a PDF) without replacing the workbook.
//! `saveAs` remains `false`; it does not distinguish Save from Save As here.
//! - `gridcraft:save` (to the host): `{ name, saveAs, bytes }` for every file GridCraft would
//! otherwise download: Save and Save As (an .xlsx workbook) and Export as PDF. The host stores
//! it and reports failures itself. GridCraft doesn't tell the host which saves make a file the
//! document, so `saveAs` is always `false`.
//! - `gridcraft:dirty` whenever unsaved changes appear or go away, `gridcraft:failed` when the
//! app couldn't start.
//!
@@ -27,16 +27,16 @@ use std::cell::RefCell;
use std::rc::Rc;
use craft_web_host::web::{FileData, Host, Message};
use craft_web_host::{Mode, Outgoing, file_name, message_type};
use gridcraft_ui_egui::{Inbox, Services, SheetApp};
use wasm_bindgen::JsValue;
use crate::host_save::{SaveMessage, sync_saved};
use crate::hostmode::open_name;
/// The app id in the host messages (`gridcraft:ready`).
const APP: &str = "gridcraft";
/// Saved files that count as a workbook: the document is then clean under the name it was saved as.
const WORKBOOK_EXTS: &[&str] = &["xlsx"];
/// The largest workbook taken from the host page, refused before it is copied.
const MAX_OPEN_BYTES: u64 = 512 << 20;
@@ -46,7 +46,6 @@ const MAX_AUTHOR_CHARS: usize = 200;
#[derive(Clone)]
pub struct Bridge {
host: Rc<Host>,
save_target: Rc<SaveTarget>,
/// Names of the files handed to the host since the last frame.
saved: Rc<RefCell<Vec<String>>>,
}
@@ -56,19 +55,7 @@ impl Bridge {
/// `data-host="page"` on the canvas, an unframed `?host=parent` page (it stays the normal app
/// with downloads), or a parent on another origin.
pub fn detect(canvas: &web_sys::HtmlCanvasElement) -> Option<Self> {
let host = Host::connect(APP, canvas)?;
let save_target = match host.mode() {
Mode::Parent => {
// Host::connect already admitted only a same-origin parent. Keep that origin
// as the postMessage target so later navigation can't receive workbook bytes.
let window = web_sys::window()?;
let parent = window.parent().ok().flatten()?;
let origin = window.location().origin().ok()?;
SaveTarget::Parent { parent, origin }
}
Mode::Page => SaveTarget::Page(canvas.clone()),
};
Some(Self { host: Rc::new(host), save_target: Rc::new(save_target), saved: Rc::default() })
Some(Self { host: Rc::new(Host::connect(APP, canvas)?), saved: Rc::default() })
}
/// Send saved and exported files to the host instead of downloading them, and hear files
@@ -104,13 +91,20 @@ impl Bridge {
/// crate does not repeat a state it already reported).
pub fn sync(&self, app: &mut SheetApp) {
let saved = std::mem::take(&mut *self.saved.borrow_mut());
sync_saved(&saved, app);
if let Some(name) = saved.iter().rev().find(|name| is_workbook(name))
&& let Some(doc) = app.session.active_mut()
{
doc.saved = doc.wb.clone();
if doc.path.is_none() {
doc.title = name.clone();
}
}
self.host.post_dirty(app.session.documents().iter().any(|d| d.is_dirty()));
}
fn post_save(&self, path: &str, bytes: &[u8]) -> Result<(), String> {
let name = file_name(Some(path), "document");
self.save_target.post(SaveMessage::new(&name, bytes)).map_err(|e| e.as_string().unwrap_or_else(|| format!("{e:?}")))?;
let name = file_name(path);
self.host.post_save(&name, bytes, None, false)?;
self.saved.borrow_mut().push(name);
Ok(())
}
@@ -124,38 +118,6 @@ impl Bridge {
}
}
/// A save-only adapter: the pinned host crate's `post_save` cannot add app-specific fields.
/// All other messages and transport detection still go through `Host`.
enum SaveTarget {
Parent { parent: web_sys::Window, origin: String },
Page(web_sys::HtmlCanvasElement),
}
impl SaveTarget {
fn post(&self, save: SaveMessage<'_>) -> Result<(), JsValue> {
let buffer = js_sys::Uint8Array::from(save.bytes).buffer();
let kind = message_type(APP, Outgoing::Save.kind());
let payload = js_sys::Object::new();
let set = |key, value: JsValue| js_sys::Reflect::set(&payload, &JsValue::from_str(key), &value);
set("name", save.name.into())?;
set("bytes", buffer.clone().into())?;
set("saveAs", JsValue::FALSE)?;
set("export", JsValue::from_bool(save.export))?;
match self {
Self::Parent { parent, origin } => {
set("type", kind.as_str().into())?;
parent.post_message_with_transfer(&payload, origin, &js_sys::Array::of1(&buffer))
}
Self::Page(canvas) => {
let init = web_sys::CustomEventInit::new();
init.set_detail(&payload.into());
let event = web_sys::CustomEvent::new_with_event_init_dict(&kind, &init)?;
canvas.dispatch_event(&event).map(|_| ())
}
}
}
}
/// The file an open message carries, pushed onto the inbox for the next frame, like a dropped
/// file. A host's file is untrusted input: an oversized one is refused before it is copied into
/// the app's memory (the data's own length, not the host's claim).
@@ -171,3 +133,11 @@ fn deliver_open(inbox: &Inbox, ctx: &egui::Context, name: &str, data: &FileData)
inbox.lock().unwrap_or_else(|e| e.into_inner()).push((open_name(name), array.to_vec()));
ctx.request_repaint();
}
fn is_workbook(name: &str) -> bool {
name.rsplit_once('.').is_some_and(|(_, ext)| WORKBOOK_EXTS.iter().any(|e| ext.eq_ignore_ascii_case(e)))
}
fn file_name(path: &str) -> String {
std::path::Path::new(path).file_name().map(|n| n.to_string_lossy().to_string()).unwrap_or_else(|| path.to_string())
}
-104
View File
@@ -1,104 +0,0 @@
//! Host save payloads and workbook receipts, shared with native regression tests.
use gridcraft_ui_egui::SheetApp;
/// Only these outputs replace the editable workbook in the host.
const WORKBOOK_EXTS: &[&str] = &["xlsx"];
pub struct SaveMessage<'a> {
pub name: &'a str,
pub bytes: &'a [u8],
pub export: bool,
}
impl<'a> SaveMessage<'a> {
pub fn new(name: &'a str, bytes: &'a [u8]) -> Self {
// All other outputs are exports, not necessarily PDFs.
Self { name, bytes, export: !is_workbook(name) }
}
}
fn is_workbook(name: &str) -> bool {
name.rsplit_once('.').is_some_and(|(_, ext)| WORKBOOK_EXTS.iter().any(|e| ext.eq_ignore_ascii_case(e)))
}
/// Preserve the bridge's existing rule: only a workbook receipt marks the document saved.
pub fn sync_saved(saved: &[String], app: &mut SheetApp) {
if let Some(name) = saved.iter().rev().find(|name| is_workbook(name))
&& let Some(doc) = app.session.active_mut()
{
doc.saved = doc.wb.clone();
if doc.path.is_none() {
doc.title = name.clone();
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use gridcraft_engine::Session;
use serde_json::json;
use std::sync::Arc;
#[test]
fn save_payload_marks_exports_and_preserves_name_and_bytes() {
let bytes = [0, 1, 127, 128, 255];
for (name, export) in [("finance.xlsx", false), ("finance.XLSX", false), ("finance.pdf", true), ("finance.PDF", true)] {
let message = SaveMessage::new(name, &bytes);
assert_eq!(message.export, export, "{name}");
assert_eq!(message.name, name);
assert_eq!(message.bytes, bytes.as_slice());
assert_eq!(message.bytes.as_ptr(), bytes.as_ptr(), "the payload borrows the original bytes");
}
}
#[test]
fn other_outputs_are_exports_not_workbook_saves() {
for name in ["finance.csv", "finance.bin", "finance", "finance.xlsx.pdf", "finance.xlsx.bak"] {
assert!(SaveMessage::new(name, &[]).export, "{name}");
}
assert!(!SaveMessage::new("finance.pdf.xlsx", &[]).export);
}
fn edited_app() -> Result<SheetApp, String> {
let mut session = Session::new();
session.new_workbook();
session.execute("cell.set", json!({"cell": "A1", "input": "42"})).map_err(|e| e.to_string())?;
Ok(SheetApp::new(session, Default::default()))
}
#[test]
fn pdf_receipts_leave_the_workbook_dirty_and_its_title_unchanged() -> Result<(), String> {
for name in ["finance.pdf", "finance.PDF"] {
let mut app = edited_app()?;
let doc = app.session.active().ok_or("no active document")?;
assert!(doc.is_dirty());
let title = doc.title.clone();
let saved = doc.saved.clone();
sync_saved(&[name.to_string()], &mut app);
let doc = app.session.active().ok_or("no active document")?;
assert!(doc.is_dirty(), "{name}");
assert!(Arc::ptr_eq(&saved, &doc.saved), "an export must not replace the saved snapshot");
assert_eq!(doc.title, title);
}
Ok(())
}
#[test]
fn workbook_receipts_mark_saved_and_later_exports_do_not_replace_them() -> Result<(), String> {
for name in ["finance.xlsx", "finance.XLSX"] {
let mut app = edited_app()?;
assert!(app.session.active().ok_or("no active document")?.is_dirty());
sync_saved(&[name.to_string(), "finance.pdf".to_string()], &mut app);
let doc = app.session.active().ok_or("no active document")?;
assert!(!doc.is_dirty());
assert!(Arc::ptr_eq(&doc.saved, &doc.wb));
assert_eq!(doc.title, name);
app.session.execute("cell.set", json!({"cell": "A1", "input": "43"})).map_err(|e| e.to_string())?;
sync_saved(&["finance.PDF".to_string()], &mut app);
assert!(app.session.active().ok_or("no active document")?.is_dirty(), "a subsequent export leaves new edits unsaved");
}
Ok(())
}
}
-2
View File
@@ -26,8 +26,6 @@ mod api;
#[cfg(target_arch = "wasm32")]
mod host;
#[cfg(any(target_arch = "wasm32", test))]
mod host_save;
#[cfg(any(target_arch = "wasm32", test))]
mod hostmode;
#[cfg(any(target_arch = "wasm32", test))]
mod prefs;
+3
View File
@@ -25,6 +25,9 @@ chrono = { workspace = true }
# Icon + VERSIONINFO for gridcraft.exe; build.rs only uses it when the target is Windows.
winresource = "0.1"
[target.'cfg(all(unix, not(any(target_os = "macos", target_os = "linux"))))'.dependencies]
winit = { version = "0.30", default-features = false, features = ["x11"] }
[target.'cfg(target_os = "linux")'.dependencies]
# Retain X11 fallback; draw Wayland client-side controls without bundled title fonts.
winit = { version = "0.30", default-features = false, features = ["x11", "wayland-csd-adwaita-notitle"] }
+20 -11
View File
@@ -17,7 +17,6 @@ mod graphics;
mod logging;
#[cfg(target_os = "macos")]
mod native_menu;
mod opener;
mod print;
use std::cell::RefCell;
@@ -219,16 +218,16 @@ fn open_with_system(target: &str) {
log::warn!("refused to open {target:?}: only http, https and mailto links are opened");
return;
};
// By absolute path where the platform has one (#2176): a bare `explorer` would be looked up
// in the application's directory first.
let env = |key: &str| std::env::var(key).ok();
let (system_root, windir) = (env("SystemRoot"), env("windir"));
let Some((program, arg)) = opener::opener_command(opener::Os::current(), &target, system_root.as_deref(), windir.as_deref()) else {
log::warn!("refused to open {target:?}: it could be read as an option");
return;
let target = target.as_str();
let cmd = if cfg!(target_os = "macos") {
"open"
} else if cfg!(windows) {
"explorer"
} else {
"xdg-open"
};
if let Err(e) = std::process::Command::new(&program).arg(&arg).spawn() {
log::warn!("{} {arg}: {e}", program.display());
if let Err(e) = std::process::Command::new(cmd).arg(target).spawn() {
log::warn!("{cmd} {target}: {e}");
}
}
@@ -359,11 +358,21 @@ fn main() -> eframe::Result<()> {
}
let window_builder = viewport.clone();
let options = eframe::NativeOptions { viewport, ..Default::default() };
#[cfg(target_os = "macos")]
#[cfg(unix)]
let mut options = options;
// Intel Macs: Metal's compiler aborts on wgpu's indirect-validation shaders (see graphics.rs).
#[cfg(target_os = "macos")]
graphics::configure_indirect_validation(&mut options, graphics::skips_indirect_validation(true, cfg!(target_arch = "x86_64")));
// winit has no file drag-and-drop on Wayland (only on X11), so dropping files from the file
// manager showed a "no" cursor. Run through XWayland when it's there; GRIDCRAFT_WAYLAND=1
// keeps the native Wayland backend.
#[cfg(all(unix, not(target_os = "macos")))]
if std::env::var_os("DISPLAY").is_some_and(|d| !d.is_empty()) && std::env::var_os("GRIDCRAFT_WAYLAND").is_none() {
options.event_loop_builder = Some(Box::new(|b| {
use winit::platform::x11::EventLoopBuilderExtX11;
b.with_x11();
}));
}
// Before eframe creates the wgpu instance: Windows starts on DirectX 12, or OpenGL when
// DirectX 12 has no GPU driver, and never touches Vulkan unless asked (see graphics.rs).
#[cfg(target_os = "windows")]
-151
View File
@@ -1,151 +0,0 @@
//! How a link is handed to the operating system's opener (#2176).
//!
//! The opener is spawned by absolute path where the platform has a fixed one: a bare program name
//! on Windows is searched for in the application's own directory (and the current directory)
//! before System32 and the Windows directory, so an `explorer.exe` planted next to a portable
//! GridCraft would run with the user's session. The target never becomes an option of the opener,
//! and on Windows the characters Explorer's own command-line parser treats specially are
//! percent-encoded. Pure functions, so the tests run on every OS.
use std::path::PathBuf;
/// Whose opener to use.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Os {
Mac,
Windows,
/// Linux, the BSDs and other freedesktop systems: `xdg-open`.
Other,
}
impl Os {
pub fn current() -> Os {
if cfg!(target_os = "macos") {
Os::Mac
} else if cfg!(windows) {
Os::Windows
} else {
Os::Other
}
}
}
/// Used when neither `SystemRoot` nor `windir` holds a usable path.
const DEFAULT_WINDOWS_DIR: &str = "C:\\Windows";
/// The Windows directory: `SystemRoot`, else `windir`, else `C:\Windows`. A value is used only
/// when it is a local drive path (`X:\…`) without `..` segments; relative or network values
/// would bring back the search this exists to avoid.
pub fn windows_dir(system_root: Option<&str>, windir: Option<&str>) -> String {
[system_root, windir]
.into_iter()
.flatten()
.map(str::trim)
.find(|d| is_local_drive_path(d))
.map_or(DEFAULT_WINDOWS_DIR, |d| d.trim_end_matches(['\\', '/']))
.to_string()
}
/// `X:\…` or `X:/…` (not the drive-relative `X:` or `X:dir`), with no `..` segment and no quote.
fn is_local_drive_path(d: &str) -> bool {
let mut chars = d.chars();
let drive = chars.next().is_some_and(|c| c.is_ascii_alphabetic()) && chars.next() == Some(':');
let rest = chars.as_str();
let rooted = rest.starts_with(['\\', '/']);
drive && rooted && !d.contains('"') && !rest.split(['\\', '/']).any(|seg| seg == "..")
}
/// Percent-encodes the characters Explorer's command-line parser (comma-separated switches such
/// as `/select,`), the C runtime's quoting rules and `cmd` treat specially: space, `"`, `,` and
/// `^`. Space, `"` and `^` may not appear unencoded in a URL, so encoding them leaves the address
/// unchanged. A comma may, and RFC 3986 does not treat `%2C` as equivalent to it (a `mailto:`
/// recipient list is comma-separated); it is encoded anyway because Explorer's parser separates
/// switches at commas, and a handler that percent-decodes the address sees the comma again.
pub fn escape_for_explorer(target: &str) -> String {
let mut out = String::with_capacity(target.len());
for c in target.chars() {
match c {
' ' => out.push_str("%20"),
'"' => out.push_str("%22"),
',' => out.push_str("%2C"),
'^' => out.push_str("%5E"),
_ => out.push(c),
}
}
out
}
/// The program and its single argument that open `target` (already accepted by
/// `links::classify`) on `os`. `None` when the target could be read as an option: it starts with
/// `-` or `/`, or is empty. `xdg-open` takes no `--`, so refusing is the only safe answer.
pub fn opener_command(os: Os, target: &str, system_root: Option<&str>, windir: Option<&str>) -> Option<(PathBuf, String)> {
if target.is_empty() || target.starts_with(['-', '/']) {
return None;
}
Some(match os {
Os::Mac => (PathBuf::from("/usr/bin/open"), target.to_string()),
Os::Windows => {
let exe = format!("{}\\explorer.exe", windows_dir(system_root, windir));
(PathBuf::from(exe), escape_for_explorer(target))
}
// Found on PATH: its location differs between distributions and the BSDs.
Os::Other => (PathBuf::from("xdg-open"), target.to_string()),
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn windows_opener_is_explorer_in_the_windows_directory() {
let (exe, arg) = opener_command(Os::Windows, "https://a.example/x", Some("C:\\Windows"), None).unwrap_or_default();
assert_eq!(exe, PathBuf::from("C:\\Windows\\explorer.exe"));
assert_eq!(arg, "https://a.example/x");
// Never a bare name, whatever the environment says.
for (root, windir) in [(None, None), (Some(""), Some("")), (Some("Windows"), None), (Some(".\\"), Some("explorer"))] {
let (exe, _) = opener_command(Os::Windows, "https://a.example", root, windir).unwrap_or_default();
assert_eq!(exe, PathBuf::from("C:\\Windows\\explorer.exe"), "{root:?} {windir:?}");
}
}
#[test]
fn windows_dir_prefers_system_root_then_windir_then_default() {
assert_eq!(windows_dir(Some("D:\\WINNT\\"), Some("E:\\Win")), "D:\\WINNT");
assert_eq!(windows_dir(None, Some("E:\\Win")), "E:\\Win");
assert_eq!(windows_dir(Some("relative\\dir"), Some("e:/win/")), "e:/win");
assert_eq!(windows_dir(None, None), "C:\\Windows");
assert_eq!(windows_dir(Some("D:\\"), None), "D:");
for bad in ["\\\\host\\share", "//host/share", "C:", "C:Windows", "C:\\Windows\\..\\Users\\x", "C:\\\"x", "", " ", "1:\\x"] {
assert_eq!(windows_dir(Some(bad), None), "C:\\Windows", "{bad:?}");
}
}
#[test]
fn explorer_switch_characters_are_percent_encoded() {
let (_, arg) = opener_command(Os::Windows, "https://x/,/select,C:\\Windows\\a b\"^", None, None).unwrap_or_default();
assert_eq!(arg, "https://x/%2C/select%2CC:\\Windows\\a%20b%22%5E");
assert!(!arg.contains([' ', '"', ',', '^']));
assert_eq!(escape_for_explorer("mailto:a@b.example?subject=Hi there"), "mailto:a@b.example?subject=Hi%20there");
// Other platforms get the address as it is.
let (_, arg) = opener_command(Os::Other, "https://x/a,b", None, None).unwrap_or_default();
assert_eq!(arg, "https://x/a,b");
}
#[test]
fn mac_and_freedesktop_openers() {
let (exe, arg) = opener_command(Os::Mac, "https://a.example", None, None).unwrap_or_default();
assert_eq!((exe, arg.as_str()), (PathBuf::from("/usr/bin/open"), "https://a.example"));
let (exe, _) = opener_command(Os::Other, "mailto:a@b.example", None, None).unwrap_or_default();
assert_eq!(exe, PathBuf::from("xdg-open"));
}
#[test]
fn a_target_never_becomes_an_option() {
for os in [Os::Mac, Os::Windows, Os::Other] {
for bad in ["-a", "--help", "-e calc", "/select,C:\\x", "/root,C:\\", ""] {
assert_eq!(opener_command(os, bad, None, None), None, "{os:?} {bad:?}");
}
}
}
}
-5
View File
@@ -26,11 +26,6 @@ sync_github_name = false
[people.edurbs]
sync_github_name = true
[people.Cheejyg]
real_name = "Glenn Chee"
display_name = "Cheejyg"
sync_github_name = false
[people.arcanii]
real_name = "Bryan Mark"
display_name = "Arcanii"
-1
View File
@@ -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 {
-21
View File
@@ -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",
-1
View File
@@ -4,7 +4,6 @@
#![forbid(unsafe_code)]
pub mod eval;
mod pivotdata;
mod precision;
pub mod recalc;
mod spill_index;
-149
View File
@@ -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 -167
View File
@@ -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,64 +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, for
/// each cell both want:
///
/// 1. the anchor whose spill held that cell before this calculation keeps it, so an array that
/// grows into another's area is `#SPILL!` even when it held a spill of its own;
/// 2. otherwise an anchor that held a spill before this calculation outranks one that did not;
/// 3. otherwise the anchor first in reading order (row, then column) wins.
///
/// Rule 3 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, so it agrees with the incremental one; a workbook that is calculated for the first
/// time has no such layout (rule 3 only). The xlsx reader restores the area each dynamic array
/// was saved spilling over, so a workbook opened from a file keeps the layout it was saved with.
#[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>,
/// The area each anchor that held a spill filled before this calculation, for the anchors the
/// calculation lays out again (full: all of them; incremental: the formulas it recalculates).
/// Any other anchor still fills the area the sheet shows.
areas: HashMap<Key, RangeRef>,
}
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 and neither held them (rules 2, 3).
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),
}
}
/// Whether `k`'s spill held `cell` before this calculation; `now` is the area the sheet
/// shows for `k`.
fn held_cell(&self, k: Key, now: Option<RangeRef>, cell: CellRef) -> bool {
self.had_spill(k) && self.areas.get(&k).copied().or(now).is_some_and(|r| r.contains(cell))
}
/// Whether `a` takes `cell` from `b` when both want it (rule 1, then [`Self::outranks`]). Each
/// anchor comes with the area the sheet shows for it.
fn outranks_at(&self, (a, a_now): (Key, Option<RangeRef>), (b, b_now): (Key, Option<RangeRef>), cell: CellRef) -> bool {
match (self.held_cell(a, a_now, cell), self.held_cell(b, b_now, cell)) {
(true, false) => true,
(false, true) => false,
_ => self.outranks(a, b),
}
}
}
/// 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.
@@ -161,7 +101,6 @@ impl Default for Calc {
fixed_now: None,
circular: vec![],
last_recalc_cells: 0,
standing: Standing::default(),
spill_errors: SpillErrors::default(),
}
}
@@ -330,20 +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 areas: HashMap<Key, RangeRef> = HashMap::default();
for i in 0..wb.sheets.len() {
if let Some(sh) = wb.sheet(i) {
areas.extend(
sh.spill_ranges
.iter()
.filter(|(a, _)| sh.cell(**a).is_some_and(|c| c.formula.is_some() || c.py.is_some()))
.map(|(a, r)| ((i, *a), *r)),
);
}
}
let held = areas.keys().copied().collect();
// 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() {
@@ -355,9 +280,7 @@ impl Calc {
}
}
let all: Vec<Key> = self.graph.nodes.keys().copied().collect();
self.standing = Standing { held: true, keys: held, areas };
self.run(wb, all, true);
self.standing = Standing::default();
}
/// Updates the graph for cells whose content changed and recalculates what depends on them.
@@ -468,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));
@@ -556,29 +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) {
match wb.sheet(k.0).and_then(|s| s.spill_ranges.get(&k.1)) {
Some(r) => {
self.standing.areas.insert(k, *r);
}
None => {
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());
@@ -596,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);
@@ -695,45 +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 on every cell they share 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.intersection(&range).is_some_and(|shared| {
shared.iter().all(|cell| standing.outranks_at((*key, old), ((key.0, **o), Some(**r)), cell))
})
})
.map(|(o, r)| (*o, *r))
.collect()
} else {
Vec::new()
};
let blocked = spill_is_blocked(sheet, (*key, old), 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);
@@ -770,33 +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` (with the area the sheet showed for it) 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, now): (Key, Option<RangeRef>),
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_at((anchor, now), ((anchor.0, *o), Some(*r)), cell))
};
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) {
+3 -13
View File
@@ -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 on
/// a cell they share (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_at(((sheet, *o), Some(*r)), ((sheet, anchor), own.copied()), c)
*o != anchor && r.contains(c) && !host.exprs.contains_key(&(sheet, *o)) && !host.python.contains_key(&(sheet, *o))
})
};
end.row >= gridcraft_core::MAX_ROWS
-164
View File
@@ -368,24 +368,6 @@ fn iterative_calculation_of_text_and_errors() {
assert_eq!(t.get("B1"), Value::Error(CellError::Div0));
}
/// `&`, CONCAT and TEXTJOIN turn a number into at most 15 significant digits, decimal unless that
/// would need 16 integer digits or more than 21 characters below 1.
#[test]
fn text_joins_convert_numbers_to_15_significant_digits() {
let mut t = T::new();
for (formula, text) in [
("=(1E15-0.5)&\"\"", "1E+15"),
("=(999999999999999)&\"\"", "999999999999999"),
("=1234567890123456&\"\"", "1.23456789012346E+15"),
("=(9.99999999999999E-9)&\"\"", "9.99999999999999E-09"),
("=CONCAT(1/3*1E-5)", "3.33333333333333E-06"),
("=TEXTJOIN(\",\",TRUE,1/3*1E-4,0.1+0.2)", "0.0000333333333333333,0.3"),
] {
t.set("A1", formula);
assert_eq!(t.get("A1"), Value::from(text), "{formula}");
}
}
#[test]
fn circular_references_without_iterative_calculation() {
let mut t = T::new();
@@ -724,53 +706,6 @@ fn spill_into_the_old_area_of_a_blocked_neighbour() {
assert_eq!([t.num("C8"), t.num("D8"), t.num("C9"), t.num("D9")], [1.0, 2.0, 3.0, 4.0]);
}
#[test]
fn a_full_recalc_keeps_a_spill_from_an_array_that_grew_into_it() {
// Both arrays spill; in manual calculation F13 then grows over F14:G14, which C14's array
// fills. A full recalculation gives what an automatic one would: C14 keeps its cells and F13
// is #SPILL!, although F13 comes first in reading order.
let mut t = T::new();
t.set("J1", "1");
t.set("C14", "=SEQUENCE(1,7)");
t.set("F13", "=SEQUENCE(J1,2)");
assert_eq!([t.num("F13"), t.num("G13")], [1.0, 2.0]);
t.wb.calc.mode = gridcraft_model::CalcMode::Manual;
t.set("J1", "5");
t.calc.recalc_all(&mut t.wb);
assert_eq!(t.get("F13"), Value::Error(CellError::Spill));
assert_eq!([t.num("C14"), t.num("F14"), t.num("G14"), t.num("I14")], [1.0, 4.0, 5.0, 7.0]);
}
#[test]
fn a_full_recalc_lays_out_arrays_as_an_automatic_one_when_one_shrinks_for_another() {
// C1 grows into C3, which A3's array fills, and A3 grows into E3, which E1's array leaves.
// Automatic recalculation lays them out in reading order with each former area still filled:
// C1 is #SPILL! and A3 takes A3:E3. A full recalculation after the same edit in manual
// calculation gives the same sheet.
let build = |manual: bool| {
let mut t = T::new();
t.set("J1", "2");
t.set("C1", "=SEQUENCE(J1)");
t.set("A3", "=SEQUENCE(1,J1+1)");
t.set("E1", "=SEQUENCE(5-J1)");
assert_eq!([t.num("C2"), t.num("C3"), t.num("E3")], [2.0, 3.0, 3.0]);
if manual {
t.wb.calc.mode = gridcraft_model::CalcMode::Manual;
}
t.set("J1", "4");
if manual {
t.calc.recalc_all(&mut t.wb);
}
t
};
let (automatic, full) = (build(false), build(true));
assert_eq!(automatic.get("C1"), Value::Error(CellError::Spill));
assert_eq!([automatic.num("A3"), automatic.num("C3"), automatic.num("E3")], [1.0, 3.0, 5.0]);
for cell in ["A1", "C1", "C2", "C3", "C4", "E1", "E2", "A3", "B3", "C3", "D3", "E3"] {
assert_eq!(full.get(cell), automatic.get(cell), "{cell}");
}
}
#[test]
fn formulas_reading_an_array_that_loses_a_spill_conflict_read_spill_errors() {
// Two arrays of one recalculation want the same empty cell: the one laid out second is
@@ -3025,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.
+4 -51
View File
@@ -444,27 +444,14 @@ pub fn sort_compare(a: &Value, b: &Value) -> Ordering {
}
}
/// Number → text the way Excel converts in `&`, CONCAT and TEXTJOIN: at most 15 significant
/// digits, rounded first; scientific from 1E+15, below 1E-9, and wherever the decimal would be
/// longer than 21 characters, not counting the sign (`0.` plus 19 decimals). Excel-verified only
/// for positive 15-digit mantissas: `0.0000692361330972509` stays decimal and
/// `1.28233995888454E-06` does not, as Excel caches them. The limit for shorter mantissas from
/// 1E-6 to 1E-9 (e.g. `0.0000099999999999999` decimal) and for negatives (sign excluded) are
/// inferred.
/// Number → text the way Excel converts in `&` and `TEXT(x,"General")`-free contexts: up to 15
/// significant digits, scientific for very large or very small magnitudes.
pub fn number_to_text(n: f64) -> String {
if n == 0.0 || !n.is_finite() {
return "0".into();
}
// Round to 15 significant digits first, then pick decimal or scientific from the rounded
// magnitude, so 999999999999999.5 reads `1E+15`, never a 16-digit integer.
let a = n.abs();
let sci = format!("{:.14e}", n);
let (mant, exp) = sci.split_once('e').unwrap_or((&sci, "0"));
let mag: i32 = exp.parse().unwrap_or(0);
let sig = mant.bytes().filter(u8::is_ascii_digit).count() - mant.bytes().rev().take_while(|&b| b == b'0').count();
// Characters after `0.` for |n| < 1: the leading zeros, then the significant digits.
let decimals_below_one = -mag - 1 + sig as i32;
if !(-9..15).contains(&mag) || decimals_below_one > 19 {
if !(1e-9..1e15).contains(&a) && a.round() != a || a >= 1e15 {
return sci_text(n, 15);
}
// A value just below 1e15 can round up to 1e15 at 15 significant digits. Only that narrow
@@ -473,6 +460,7 @@ pub fn number_to_text(n: f64) -> String {
return sci_text(n, 15);
}
// 15 significant digits, trailing zeros trimmed.
let mag = a.log10().floor() as i32;
let decimals = (14 - mag).clamp(0, 30) as usize;
let s = format!("{:.*}", decimals, n);
trim_decimal(&s)
@@ -511,44 +499,9 @@ mod tests {
assert_eq!(number_to_text(1234567890123456.0), "1.23456789012346E+15");
assert_eq!(number_to_text(0.0001), "0.0001");
assert_eq!(number_to_text(1e-10), "1E-10");
assert_eq!(number_to_text(1e15 - 0.5), "1E+15");
assert_eq!(number_to_text(1e15 - 0.1), "1E+15");
assert_eq!(number_to_text(-(1e15 - 0.5)), "-1E+15");
assert_eq!(number_to_text(999999999999999.0), "999999999999999");
assert_eq!(number_to_text(9.999999999999999e-10), "0.000000001");
assert_eq!(number_to_text(-9.999999999999999e-10), "-0.000000001");
assert_eq!(number_to_text(1.0 / 3.0), "0.333333333333333");
}
/// Excel switches to scientific when the 15-digit decimal would be longer than 21 characters
/// (`0.` plus 19 decimals). Excel-verified: IMTAN, IMSECH, IMCSCH and IMEXP results cached by
/// Excel for Mac in the `formulas` project's test.xlsx (ENGINEERING!S53, R47, S37, V37, V39).
#[test]
fn number_text_small_magnitudes() {
assert_eq!(number_to_text(6.92361330972509e-5), "0.0000692361330972509");
assert_eq!(number_to_text(2.41377759972715e-4), "0.000241377759972715");
assert_eq!(number_to_text(1.28233995888454e-6), "1.28233995888454E-06");
assert_eq!(number_to_text(-4.48088972789593e-6), "-4.48088972789593E-06");
assert_eq!(number_to_text(5.98317105631764e-7), "5.98317105631764E-07");
assert_eq!(number_to_text(-2.99158552811404e-7), "-2.99158552811404E-07");
// Just below powers of ten: the 21-character limit, and the rounded magnitude.
assert_eq!(number_to_text(9.99999999999999e-5), "0.0000999999999999999");
assert_eq!(number_to_text(9.99999999999999e-6), "9.99999999999999E-06");
assert_eq!(number_to_text(9.9999999999999e-6), "0.0000099999999999999");
assert_eq!(number_to_text(9.99999999999999e-9), "9.99999999999999E-09");
assert_eq!(number_to_text(-9.99999999999999e-9), "-9.99999999999999E-09");
assert_eq!(number_to_text(9.99999999999999e-10), "9.99999999999999E-10");
assert_eq!(number_to_text(9.999999999999999e-6), "0.00001");
assert_eq!(number_to_text(0.00001), "0.00001");
assert_eq!(number_to_text(0.000001), "0.000001");
assert_eq!(number_to_text(1.5e-9), "0.0000000015");
// Large side: 15 significant digits, scientific from 1E+15.
assert_eq!(number_to_text(99999999999999.9), "99999999999999.9");
assert_eq!(number_to_text(999999999999999.4), "999999999999999");
assert_eq!(number_to_text(9999999999999998.0), "1E+16");
assert_eq!(number_to_text(9.99999999999999e15), "9.99999999999999E+15");
}
#[test]
fn number_text_rounds_up_to_scientific_boundary() {
assert_eq!(number_to_text(999999999999999.9), "1E+15");
-2
View File
@@ -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"] }
+2 -11
View File
@@ -4,9 +4,7 @@
use std::collections::{HashMap, HashSet};
use gridcraft_core::{CellRef, RangeRef, Value, compare};
use gridcraft_model::{
CfOperator, CfRule, CfValueKind, Color, CondFormat, PatternType, Sheet, Style, Table, Underline, Workbook, default_icon_thresholds,
};
use gridcraft_model::{CfOperator, CfRule, CfValueKind, Color, CondFormat, PatternType, Sheet, Style, Underline, Workbook, default_icon_thresholds};
/// The conditional look of one cell.
#[derive(Clone, Debug, Default, PartialEq)]
@@ -22,12 +20,10 @@ pub struct CfLook {
pub hide_value: bool,
}
/// Precomputed statistics per rule (min/max/percentiles/top-N thresholds/duplicates), and each
/// table's visible edges. The grid and print keep one per paint.
/// Precomputed statistics per rule (min/max/percentiles/top-N thresholds/duplicates).
#[derive(Default)]
pub struct CfCache {
stats: HashMap<usize, RuleStats>,
table_edges: HashMap<RangeRef, crate::tables::ShownEdges>,
}
#[derive(Default, Clone)]
@@ -279,11 +275,6 @@ impl CfCache {
Self::default()
}
/// [`crate::tables::shown_edges`] of `t`, found once per cache.
pub fn table_edges(&mut self, sh: &Sheet, t: &Table) -> crate::tables::ShownEdges {
*self.table_edges.entry(t.range).or_insert_with(|| crate::tables::shown_edges(sh, t))
}
/// Conditional look of `c`, or `None` when no rule applies.
pub fn look(&mut self, wb: &Workbook, sheet: usize, c: CellRef) -> Option<CfLook> {
let sh = wb.sheet(sheet)?;
+1 -2
View File
@@ -27,7 +27,6 @@ pub use filter::filter_values;
pub(crate) use filter::{apply_filter, grow_autofilter};
use filter::{clear_filter, filter_by, reapply, toggle_filter};
use grouping::{detail, group, outline_settings, show_levels, subtotal};
pub use sort::sort_context;
use sort::{quick_sort, sort};
#[cfg(test)]
use tools::split_delimited;
@@ -213,7 +212,7 @@ fn data_target(s: &Session, p: &Json, cmd: &str) -> Result<(usize, RangeRef)> {
/// Excel's header guess: the first row is text over a column of numbers, or is bold.
fn guess_header(wb: &Workbook, sh: &Sheet, r: RangeRef) -> bool {
if let Some(t) = sh.table_at(r.start) {
return t.header_row && r.start.row == t.range.start.row;
return t.header_row;
}
if r.height() < 2 {
return false;
-3
View File
@@ -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}))
}
+6 -37
View File
@@ -28,21 +28,6 @@ fn sort_target(s: &Session, p: &Json) -> Result<(usize, RangeRef)> {
Ok((sheet, data_range(s, p)?))
}
/// The worksheet (index), range and header guess the Custom Sort dialog works on: the sheet named by
/// `sheet` or a `Sheet!` prefix on `range`, else the active one.
pub fn sort_context(s: &Session, p: &Json) -> Result<(usize, RangeRef, bool)> {
let (sheet, explicit) = sort_target(s, p)?;
let d = s.doc()?;
let sh = d.wb.sheet(sheet).ok_or(EngineError::NoDocument)?;
let sel = d.selection.current();
// An explicit block wins over the table range, so a selected totals row can be sorted.
let r = match sh.used_range() {
Some(used) if p.get("range").is_none() && !sel.is_single() => sel.intersection(&used).unwrap_or(sel),
_ => explicit,
};
Ok((sheet, r, bool_param(p, "header").unwrap_or_else(|| guess_header(&d.wb, sh, r))))
}
pub(super) fn quick_sort(s: &mut Session, p: &Json, asc: bool) -> Result<Json> {
let (sheet, r) = sort_target(s, p)?;
let col = col_param(p.get("column"), r.start.col).unwrap_or(s.doc()?.selection.active.col).clamp(r.start.col, r.end.col);
@@ -83,9 +68,7 @@ pub(super) fn sort(s: &mut Session, p: &Json) -> Result<Json> {
});
}
if keys.is_empty() {
let (sheet, r, header) = sort_context(s, p)?;
let name = s.doc()?.wb.sheet(sheet).map(|sh| sh.name.clone()).ok_or(EngineError::NoDocument)?;
s.ui_requests.push(crate::UiRequest::Dialog("sort".into(), json!({"range": r.a1(), "header": header, "sheet": name})));
s.ui_requests.push(crate::UiRequest::Dialog("sort".into(), json!({"range": r.a1(), "header": header})));
return ok();
}
if keys.len() > 64 {
@@ -136,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 };
+2 -2
View File
@@ -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");
+1 -1
View File
@@ -35,7 +35,7 @@ use go_to::go_to_special;
#[cfg(test)]
use go_to::{GO_TO_MAX_AREAS, GO_TO_RECENT, reference_parts};
use paste_special::paste_special;
pub(crate) use paste_special::{rewrite_all_formulas_many, rewrite_cell_links, rewrite_python_refs};
pub(crate) use paste_special::{rewrite_all_formulas, rewrite_cell_links, rewrite_python_refs};
use selection::{select_all, select_col, select_region, select_row, selection_move, selection_next, selection_next_corner, selection_set};
pub fn specs() -> Vec<CommandSpec> {
+16 -47
View File
@@ -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) {
@@ -566,15 +553,10 @@ fn paste_validations(
/// Applies a reference adjustment to every cell formula and defined name in the workbook.
pub(crate) fn rewrite_all_formulas(wb: &mut gridcraft_model::Workbook, target: &str, e: &gridcraft_formula::adjust::Edit) -> Result<()> {
rewrite_all_formulas_many(wb, target, std::slice::from_ref(e))
}
/// [`rewrite_all_formulas`] for several edits applied in order, visiting each formula once.
pub(crate) fn rewrite_all_formulas_many(wb: &mut gridcraft_model::Workbook, target: &str, edits: &[gridcraft_formula::adjust::Edit]) -> Result<()> {
use gridcraft_formula::adjust::Edit;
// Rows and columns inserted or deleted on the target sheet move its legacy array ranges too
// (a cut moves its arrays itself).
let moves_arrays = |e: &Edit| matches!(e, Edit::Insert { .. } | Edit::Delete { .. } | Edit::InsertCells { .. } | Edit::DeleteCells { .. });
let moves_arrays = matches!(e, Edit::Insert { .. } | Edit::Delete { .. } | Edit::InsertCells { .. } | Edit::DeleteCells { .. });
for si in 0..wb.sheets.len() {
let host = wb.sheets.get(si).map(|s| s.name.clone()).unwrap_or_default();
let keys: Vec<(CellRef, std::sync::Arc<Formula>)> =
@@ -582,29 +564,16 @@ pub(crate) fn rewrite_all_formulas_many(wb: &mut gridcraft_model::Workbook, targ
if keys.is_empty() {
continue;
}
let on_target = host.eq_ignore_ascii_case(target);
let on_target = moves_arrays && host.eq_ignore_ascii_case(target);
let Some(sheet) = wb.sheet_mut(si) else { continue };
for (c, f) in keys {
// Borrows the tree and copies and prints only the formulas the edits change. A formula
// the edits leave alone keeps its stored text, even if that text is not canonical.
let Some(new) = f.with_expr(|x| {
let mut cur: Option<gridcraft_formula::Expr> = None;
for e in edits {
if let Some(n) = gridcraft_formula::adjust::adjust_if_changed(cur.as_ref().unwrap_or(x), &host, target, e) {
cur = Some(n);
}
}
cur
}) else {
continue;
// Borrows the tree and copies and prints only the formulas the edit changes. A formula
// the edit leaves alone keeps its stored text, even if that text is not canonical.
let Some(new) = f.with_expr(|x| gridcraft_formula::adjust::adjust_if_changed(x, &host, target, e)) else { continue };
let array = match f.array {
Some(a) if on_target => crate::cmd::sheet::map_range(a, e),
a => a,
};
let mut array = f.array;
for e in edits {
array = match array {
Some(a) if on_target && moves_arrays(e) => crate::cmd::sheet::map_range(a, e),
a => a,
};
}
let nf = match new {
Some(new) => Formula { array, dynamic: f.dynamic, ..Formula::from_expr(new) },
None if array != f.array => Formula { array, ..(*f).clone() },
@@ -618,12 +587,12 @@ pub(crate) fn rewrite_all_formulas_many(wb: &mut gridcraft_model::Workbook, targ
for n in wb.names.iter_mut() {
if let Ok(expr) = gridcraft_formula::parse_name(&n.formula) {
// Names are workbook-level: unqualified refs don't occur; qualified ones adjust.
let new = edits.iter().fold(expr, |expr, e| gridcraft_formula::adjust::adjust(expr, "\u{0}", target, e));
let new = gridcraft_formula::adjust::adjust(expr, "\u{0}", target, e);
n.formula = gridcraft_formula::print(&new);
}
}
rewrite_cell_links(wb, |host, expr| edits.iter().fold(expr, |expr, e| gridcraft_formula::adjust::adjust(expr, host, target, e)));
rewrite_python_refs(wb, &|host, expr| edits.iter().fold(expr, |expr, e| gridcraft_formula::adjust::adjust(expr, host, target, e)))
rewrite_cell_links(wb, |host, expr| gridcraft_formula::adjust::adjust(expr, host, target, e));
rewrite_python_refs(wb, &|host, expr| gridcraft_formula::adjust::adjust(expr, host, target, e))
}
/// Runs `f` over every reference a floating object holds (a chart's series values, categories,
-6
View File
@@ -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 {
File diff suppressed because it is too large Load Diff
+11 -70
View File
@@ -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| {
+2 -27
View File
@@ -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() {
+5 -17
View File
@@ -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}))
}
+43 -47
View File
@@ -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)}))
})
+2 -10
View File
@@ -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 {
-334
View File
@@ -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,
+11 -38
View File
@@ -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();
@@ -177,7 +166,7 @@ pub fn render_pdf(wb: &Workbook, layouts: &[SheetLayout], file: &str, path: &str
let mut pics = PicCache::default();
for lay in layouts {
let Some(sh) = wb.sheet(lay.sheet) else { continue };
let mut cf = crate::cf::CfCache::new();
let mut cf = if sh.cond_formats.is_empty() { None } else { Some(crate::cf::CfCache::new()) };
let k = lay.k();
let (aw, ah) = lay.avail();
for (pi, (ri, ci)) in lay.pages.iter().enumerate() {
@@ -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> {
+27 -47
View File
@@ -25,16 +25,13 @@ pub(super) struct Look {
pub(super) cf: Option<crate::cf::CfLook>,
}
fn cell_look(wb: &Workbook, si: usize, sh: &Sheet, c: CellRef, cf: &mut crate::cf::CfCache) -> Look {
fn cell_look(wb: &Workbook, si: usize, sh: &Sheet, c: CellRef, cf: &mut Option<crate::cf::CfCache>) -> Look {
let mut style = match sh.table_at(c) {
Some(t) => crate::tables::table_cell_shown_style(wb, si, t, cf.table_edges(sh, t), c),
Some(t) => crate::tables::table_cell_style(wb, si, t, c),
None => wb.styles.get(sh.style_id(c)).clone(),
};
let cfl = cf.look(wb, si, 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);
@@ -319,7 +305,7 @@ impl<'a> Covered<'a> {
}
/// Draws the cells of a block: fills, gridlines, data bars, borders and text.
pub(super) fn draw_block(pg: &mut Page, b: &Block, gridlines: bool, cf: &mut crate::cf::CfCache) {
pub(super) fn draw_block(pg: &mut Page, b: &Block, gridlines: bool, cf: &mut Option<crate::cf::CfCache>) {
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);
if bw <= 0.0 || bh <= 0.0 {
@@ -342,15 +328,15 @@ pub(super) fn draw_block(pg: &mut Page, b: &Block, gridlines: bool, cf: &mut cra
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 cra
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 cra
),
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 cra
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)]
+10 -22
View File
@@ -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;
}
}
+6 -266
View File
@@ -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(&ltr, "/MediaBox [", 4)[2];
let (l, r) = (numbers_after(&ltr, "/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(&ltr, "/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(&ltr);
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(&ltr, "RIGHT") + right - exported_text_x(&ltr, "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(&ltr, 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(&ltr, "FIRST") < exported_text_x(&ltr, "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(&para, 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(&para, Font::Helvetica, 10.0, 1.0e9), vec![para.clone()]);
}
#[test]
+68 -185
View File
@@ -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);
+20 -47
View File
@@ -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,51 +211,22 @@ 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);
}
}
/// Rewrites every formula reference (chart series included), sparkline source and PivotTable
/// source for a structural edit on `target`.
pub(super) fn rewrite(cx: &mut Ctx, target: &str, e: &Edit) -> Result<()> {
rewrite_many(cx, target, std::slice::from_ref(e))
}
/// [`rewrite`] for several edits applied in order, parsing each reference once.
fn rewrite_many(cx: &mut Ctx, target: &str, edits: &[Edit]) -> Result<()> {
cx.edits.extend(edits.iter().map(|e| (target.to_string(), e.clone())));
cx.edits.push((target.to_string(), e.clone()));
let wb = &mut cx.wb;
super::edit::rewrite_all_formulas_many(wb, target, edits)?;
super::edit::rewrite_all_formulas(wb, target, e)?;
for si in 0..wb.sheets.len() {
let host = wb.sheets.get(si).map(|s| s.name.clone()).unwrap_or_default();
let Some(sh) = wb.sheet_mut(si) else { continue };
let fix = |text: &str| -> String {
match gridcraft_formula::parse(text) {
Ok(expr) => gridcraft_formula::print(&edits.iter().fold(expr, |expr, e| gridcraft_formula::adjust::adjust(expr, &host, target, e))),
Ok(expr) => gridcraft_formula::print(&gridcraft_formula::adjust::adjust(expr, &host, target, e)),
Err(_) => text.to_string(),
}
};
@@ -268,7 +239,7 @@ fn rewrite_many(cx: &mut Ctx, target: &str, edits: &[Edit]) -> Result<()> {
let body = pt.source.trim().trim_start_matches('=');
if let Ok(expr) = gridcraft_formula::parse(body) {
let before = gridcraft_formula::print(&expr);
let after = gridcraft_formula::print(&edits.iter().fold(expr, |expr, e| gridcraft_formula::adjust::adjust(expr, &host, target, e)));
let after = gridcraft_formula::print(&gridcraft_formula::adjust::adjust(expr, &host, target, e));
if after != before {
pt.source = after;
}
@@ -383,21 +354,23 @@ fn delete_lines(s: &mut Session, p: &Json, axis: Axis) -> Result<Json> {
let out = edit(s, |cx| {
let name = cx.wb.sheet(sheet).map(|s| s.name.clone()).unwrap_or_default();
cx.protection_checked = true;
{
let sh = cx.sheet_mut(sheet)?;
// Cells move once, past every deleted area above or left of them.
let ascending: Vec<(u32, u32)> = areas.iter().rev().copied().collect();
match axis {
Axis::Rows => sh.cells.delete_rows(&ascending),
Axis::Cols => sh.cells.delete_cols(&ascending),
}
// Last area first, so the earlier ones keep their positions.
for &(at, count) in &areas {
// Last area first, so the earlier ones keep their positions.
for (at, count) in areas {
{
let sh = cx.sheet_mut(sheet)?;
let block = match axis {
Axis::Rows => RangeRef::rows(at, (at + count - 1).min(MAX_ROWS - 1)),
Axis::Cols => RangeRef::cols(at, (at + count - 1).min(MAX_COLS - 1)),
};
sh.take_cells(block);
match axis {
Axis::Rows => sh.cells.shift_rows(at + count, -(count as i64)),
Axis::Cols => sh.cells.shift_cols(at + count, -(count as i64)),
}
shift_sheet_features(sh, axis, at, count, false);
}
rewrite(cx, &name, &Edit::Delete { axis, at, count })?;
}
let edits: Vec<Edit> = areas.iter().map(|&(at, count)| Edit::Delete { axis, at, count }).collect();
rewrite_many(cx, &name, &edits)?;
cx.structural = true;
Ok(Json::Null)
})?;
+7 -23
View File
@@ -5,7 +5,7 @@ use std::sync::Mutex;
use gridcraft_core::{CellRef, RangeRef, Value};
use gridcraft_model::{Sheet, Workbook};
use gridcraft_numfmt::{Formatted, NumberFormat, format_value, format_value_full};
use gridcraft_numfmt::{Formatted, NumberFormat, format_value};
/// Parsed number formats are cached by code.
pub(crate) fn parsed(code: &str) -> NumberFormat {
@@ -116,8 +116,7 @@ pub fn formula_hidden(wb: &Workbook, sheet: &Sheet, c: CellRef) -> bool {
wb.styles.get(sheet.style_id(at)).protection.hidden
}
/// The text a cell shows (General up to the 11-character cell width; the grid narrows General
/// further to fit the column).
/// The text a cell shows (full precision General; the grid narrows General to fit the column).
pub fn cell_text(wb: &Workbook, sheet: &Sheet, c: CellRef) -> String {
if sheet.show_formulas
&& let Some(f) = sheet.cell(c).and_then(|x| x.formula.as_ref())
@@ -125,35 +124,20 @@ pub fn cell_text(wb: &Workbook, sheet: &Sheet, c: CellRef) -> String {
{
return format!("={}", f.text);
}
shown_text(wb, sheet, c)
value_text(wb, sheet, c)
}
/// A cell's value with its number format applied, independent of column width: no `#####`
/// and no General narrowing (Save As CSV/Text writes this). Formulas give their result. A number
/// shown as General (also through a coloured or sectioned General, or a Text format) is written
/// as [`format_value_full`] writes it, never with an exponent: `&`'s 15 significant digits below
/// 1E+15 (`124412140710`, not `1.24412E+11`), the shortest round-trip digits from 1E+15 (every
/// integer below 1e16 exactly). Excel writes the cell display.
/// and no General narrowing (Save As CSV/Text writes this). Formulas give their result.
pub fn value_text(wb: &Workbook, sheet: &Sheet, c: CellRef) -> String {
let style = wb.styles.get(sheet.style_id(c));
with_fill_space(format_value_full(&sheet.value(c), &parsed(style.num_fmt.as_str()), wb.date_system))
}
/// A cell's value through its number format, General at the 11-character cell width.
fn shown_text(wb: &Workbook, sheet: &Sheet, c: CellRef) -> String {
let style = wb.styles.get(sheet.style_id(c));
value_text_as(wb, &sheet.value(c), style.num_fmt.as_str())
}
/// A value through a format code given apart from a cell, as a cell shows it (General at the
/// 11-character cell width). Print takes the code from the cell's effective look, which a
/// conditional format can override.
/// [`value_text`] for a value and a format code given apart from a cell (print takes the code
/// from the cell's effective look, which a conditional format can override).
pub fn value_text_as(wb: &Workbook, v: &Value, code: &str) -> String {
with_fill_space(format(v, code, wb))
}
/// The formatted text with a single space where a `*x` repeat fill would expand.
fn with_fill_space(f: Formatted) -> String {
let f = format(v, code, wb);
match f.fill {
Some((_, pos)) => {
let mut t = f.text;
+17 -50
View File
@@ -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.
@@ -558,13 +558,20 @@ pub fn source_path(path: &str) -> Option<std::path::PathBuf> {
/// Save As CSV/Text writes "the text and values as they are displayed in cells" with "all
/// characters in each cell" (Microsoft Support, *Excel formatting and features that are not
/// transferred to other file formats*): number formats applied, never column-width `#####`.
/// One intentional difference: a number shown as General is not narrowed to the cell width and
/// never gets an exponent (`gridcraft_numfmt::format_value_full`). Below 1E+15 it is written as
/// `&` converts it (15 significant digits); from 1E+15 as the shortest digits that read back as
/// the same value (every integer below 1e16 exactly, so long identifiers survive); small numbers
/// that `&` writes in scientific notation as their 15 digits in full.
fn csv(wb: &Workbook, sh: &Sheet, delimiter: u8) -> Result<Vec<u8>> {
gridcraft_xlsx::write_csv(sh, delimiter, |c| crate::display::value_text(wb, sh, c)).map_err(|e| EngineError::Other(e.to_string()))
gridcraft_xlsx::write_csv(sh, delimiter, |c| {
// General's grid-width formatting rounds large identifiers to scientific notation.
// Delimited files have no column width, so preserve the whole numeric value instead.
if wb.styles.get(sh.style_id(c)).num_fmt.as_str().eq_ignore_ascii_case("General")
&& let gridcraft_core::Value::Number(number) = sh.value(c)
&& number.is_finite()
{
number.to_string()
} else {
crate::display::value_text(wb, sh, c)
}
})
.map_err(|e| EngineError::Other(e.to_string()))
}
/// The active sheet as CSV of raw cell values, for automation: numbers at full precision, dates and
@@ -1055,12 +1062,6 @@ pub fn write_file(path: &str, bytes: &[u8]) -> Result<()> {
use std::os::unix::fs::OpenOptionsExt;
opts.mode(0o600);
}
// A brand-new file gets the restrictive default: no group/other write, whatever the umask.
#[cfg(unix)]
if prior.is_none() {
use std::os::unix::fs::OpenOptionsExt;
opts.mode(0o644);
}
let mut f = opts.open(&tmp).map_err(|e| {
let _ = std::fs::remove_file(&tmp);
EngineError::Other(format!("{path}: {e}"))
@@ -1084,50 +1085,16 @@ pub fn write_file(path: &str, bytes: &[u8]) -> Result<()> {
if let Some(p) = &prior {
let _ = f.set_permissions(p.clone());
}
// `sync_all` before the rename: without it a power loss right after the rename can leave
// the new name pointing at an empty or truncated file while the old workbook is gone.
// A file system that cannot flush at all (some network mounts; on Apple targets std asks
// for F_FULLFSYNC, which they refuse) keeps the old behaviour: skip the flush, still rename.
let synced = |f: &std::fs::File| f.sync_all().or_else(|e| if full_sync_unsupported(&e) { Ok(()) } else { Err(e) });
f.write_all(bytes).and_then(|()| f.flush()).and_then(|()| synced(&f)).map_err(|e| {
f.write_all(bytes).and_then(|()| f.flush()).map_err(|e| {
let _ = std::fs::remove_file(&tmp);
EngineError::Other(format!("{path}: {e}"))
})?;
drop(f);
std::fs::rename(&tmp, path).map_err(|e| {
// A write or rename that fails (full disk, the workbook locked by another app) leaves
// no temporary file beside the user's workbook.
let _ = std::fs::remove_file(&tmp);
EngineError::Other(format!("{path}: {e}"))
})?;
// Make the rename itself durable. Best effort: the workbook is already in place, so a
// directory that can't be opened or synced (some file systems) is not a failed save.
#[cfg(unix)]
{
let dir = std::path::Path::new(path).parent().filter(|d| !d.as_os_str().is_empty()).unwrap_or_else(|| std::path::Path::new("."));
if let Ok(d) = std::fs::File::open(dir) {
let _ = d.sync_all();
}
}
Ok(())
}
/// True when a flush failed only because the file system cannot do it: on Unix ENOTTY (25, what
/// `fcntl(F_FULLFSYNC)` returns on such volumes; on Windows 25 is ERROR_SEEK, a real failure), on
/// Apple targets ENOTSUP (45, which std leaves uncategorized there), or an unsupported-operation
/// error (EOPNOTSUPP/ENOSYS, and ENOTSUP where it equals EOPNOTSUPP). Any other error is a real
/// failure.
#[cfg(not(target_arch = "wasm32"))]
fn full_sync_unsupported(e: &std::io::Error) -> bool {
flush_unsupported_on(e, cfg!(unix), cfg!(target_vendor = "apple"))
}
/// [`full_sync_unsupported`] for a given platform, so each platform's raw codes can be tested
/// on any host.
#[cfg(not(target_arch = "wasm32"))]
fn flush_unsupported_on(e: &std::io::Error, unix: bool, apple: bool) -> bool {
let raw = e.raw_os_error();
(unix && raw == Some(25)) || (apple && raw == Some(45)) || e.kind() == std::io::ErrorKind::Unsupported
})
}
/// The mode a saved file gets from the file it replaces (`old`): all of it when its group was
+1 -159
View File
@@ -78,34 +78,6 @@ fn restored_mode_drops_the_group_and_special_bits_when_the_group_is_lost() {
assert_eq!(super::restored_mode(0o104_755, false), 0o705, "setuid is dropped");
}
#[cfg(not(target_arch = "wasm32"))]
#[cfg(unix)]
#[test]
fn fresh_save_drops_group_and_other_write_under_a_permissive_umask() {
use std::os::unix::fs::PermissionsExt;
if std::env::var_os("GRIDCRAFT_UMASK_CHILD").is_none() {
// Re-run this test in a child shell whose umask is 0002.
let exe = std::env::current_exe().unwrap();
let status = std::process::Command::new("sh")
.arg("-c")
.arg("umask 0002 && exec \"$0\" --exact io::tests::fresh_save_drops_group_and_other_write_under_a_permissive_umask")
.arg(exe)
.env("GRIDCRAFT_UMASK_CHILD", "1")
.status()
.unwrap();
assert!(status.success());
return;
}
let dir = std::env::temp_dir().join(format!("gridcraft-fs-safety-umask-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::fs::create_dir_all(&dir).unwrap();
let fresh = dir.join("new.xlsx");
write_file(fresh.to_str().unwrap(), b"v").unwrap();
let mode = std::fs::metadata(&fresh).unwrap().permissions().mode() & 0o777;
let _ = std::fs::remove_dir_all(&dir);
assert!(mode & 0o022 == 0, "mode {mode:o}");
}
#[cfg(not(target_arch = "wasm32"))]
#[test]
fn open_refuses_directories_and_unknowable_lengths() {
@@ -372,65 +344,6 @@ fn failed_save_leaves_no_temporary_file() {
let _ = std::fs::remove_dir_all(&dir);
}
/// A save replaces an existing workbook with exactly the new bytes, and a save into a folder
/// that doesn't exist fails without creating anything. The flush to disk before the rename is
/// not covered: a power loss can't be simulated in a unit test.
#[cfg(not(target_arch = "wasm32"))]
#[test]
fn save_writes_exact_bytes_and_fails_cleanly_without_a_folder() {
let dir = std::env::temp_dir().join(format!("gridcraft-write-exact-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::fs::create_dir_all(&dir).unwrap();
let dest = dir.join("Book.xlsx");
std::fs::write(&dest, b"old workbook that is longer than the new one").unwrap();
let bytes: Vec<u8> = (0..=255u8).cycle().take(100_000).collect();
write_file(dest.to_str().unwrap(), &bytes).unwrap();
assert_eq!(std::fs::read(&dest).unwrap(), bytes);
assert!(!dir.join("Book.xlsx.sctmp").exists());
let missing = dir.join("no-such-folder").join("Book.xlsx");
assert!(write_file(missing.to_str().unwrap(), b"x").is_err());
assert!(!dir.join("no-such-folder").exists());
assert_eq!(std::fs::read(&dest).unwrap(), bytes, "the existing workbook is untouched");
let _ = std::fs::remove_dir_all(&dir);
}
/// Only "this file system cannot flush" errors are tolerated when syncing a saved file.
/// The fallback on a real network mount is not tested.
#[cfg(not(target_arch = "wasm32"))]
#[test]
fn full_sync_tolerates_only_unsupported_errors() {
use std::io::{Error, ErrorKind};
assert_eq!(full_sync_unsupported(&Error::from_raw_os_error(25)), cfg!(unix));
assert!(full_sync_unsupported(&Error::from(ErrorKind::Unsupported)));
assert!(!full_sync_unsupported(&Error::from(ErrorKind::PermissionDenied)));
assert!(!full_sync_unsupported(&Error::from(ErrorKind::StorageFull)));
assert!(!full_sync_unsupported(&Error::from_raw_os_error(28)), "ENOSPC on Linux");
assert!(!full_sync_unsupported(&Error::from_raw_os_error(5)), "EIO");
}
/// Apple's ENOTSUP is 45 (EOPNOTSUPP is 102), and std maps only the latter to
/// `ErrorKind::Unsupported`: F_FULLFSYNC refused with ENOTSUP must still save. Elsewhere 45 is
/// another error (EL2NSYNC on Linux) and stays a failed save.
#[cfg(not(target_arch = "wasm32"))]
#[test]
fn full_sync_tolerates_apple_enotsup() {
use std::io::Error;
let enotsup = Error::from_raw_os_error(45);
assert!(flush_unsupported_on(&enotsup, true, true), "ENOTSUP on Apple");
assert!(!flush_unsupported_on(&enotsup, true, false), "45 on other Unix");
assert!(!flush_unsupported_on(&enotsup, false, false), "45 on Windows");
assert!(flush_unsupported_on(&Error::from_raw_os_error(25), true, true), "ENOTTY on Apple");
assert!(!flush_unsupported_on(&Error::from_raw_os_error(5), true, true), "EIO on Apple");
assert!(!flush_unsupported_on(&Error::from_raw_os_error(28), true, true), "ENOSPC on Apple");
}
/// The real helper on an Apple host: a raw ENOTSUP from F_FULLFSYNC is tolerated.
#[cfg(target_vendor = "apple")]
#[test]
fn full_sync_tolerates_raw_enotsup_on_apple() {
assert!(full_sync_unsupported(&std::io::Error::from_raw_os_error(45)));
}
/// While a script runs (#2178), file reads and writes are refused whatever command or
/// parameter asked for them; nesting and dropping the sandbox restore access.
#[cfg(not(target_arch = "wasm32"))]
@@ -614,80 +527,9 @@ fn delimited_exports_preserve_general_precision_and_explicit_number_formats() {
sheet.set_cell(CellRef::new(0, 0), Cell { value: Value::Number(124412140710.0), ..Default::default() });
sheet.set_cell(CellRef::new(0, 1), Cell { value: Value::Number(1.23456789012345), ..Default::default() });
sheet.set_cell(CellRef::new(0, 2), Cell { value: Value::Number(124412140710.0), style: scientific, ..Default::default() });
// Every integer below 1e16 that f64 holds (also 2^53 and the even integers above it) keeps
// every digit; larger numbers keep the shortest digits that read back as the same value,
// and a number `&` would write with an exponent is written out in full, so reopening the
// file can't give it a scientific format that then rounds it on the next save.
let cells = [
(1234567890123456.0, "1234567890123456"),
(-9007199254740991.0, "-9007199254740991"),
(9007199254740992.0, "9007199254740992"),
(9007199254740994.0, "9007199254740994"),
(9123456789012346.0, "9123456789012346"),
(-9999999999999998.0, "-9999999999999998"),
(12345678901234567.0, "12345678901234568"),
(1e20, "100000000000000000000"),
(1e15 - 0.5, "999999999999999.5"),
(1.0 / 3.0 * 1e-6, "0.000000333333333333333"),
(1.23456789012346e-10, "0.000000000123456789012346"),
];
for (col, (n, _)) in cells.iter().enumerate() {
sheet.set_cell(CellRef::new(0, col as u32 + 3), Cell { value: Value::Number(*n), ..Default::default() });
}
for (path, separator) in [("data.csv", ","), ("data.tsv", "\t")] {
let output = String::from_utf8(save_bytes(&workbook, path).unwrap()).unwrap();
let tail: Vec<&str> = cells.iter().map(|(_, text)| *text).collect();
assert_eq!(output, format!("124412140710{s}1.23456789012345{s}1.24E+11{s}{}\r\n", tail.join(separator), s = separator));
// Reopening the file and saving it again changes nothing.
let (reopened, _) = open_bytes(path, output.as_bytes()).unwrap();
assert_eq!(String::from_utf8(save_bytes(&reopened, path).unwrap()).unwrap(), output);
}
}
/// A number shown as General is written as `&` converts it (15 significant digits), whatever
/// colour, sections or literals the format adds, and in a Text cell. Excel writes the cell
/// display (`1.24412E+11`, `0.333333333`); GridCraft keeps the digits so part codes survive
/// (integers below 1e16 keep all their digits, and nothing gets an exponent; see the test above).
#[test]
fn delimited_exports_write_general_numbers_as_text_converts_them() {
use gridcraft_core::Value;
use gridcraft_model::{Cell, NumFmt, StyleId};
let mut wb = Workbook::new();
let mut styled = |code: &str| wb.styles.derive(StyleId::DEFAULT, |s| s.num_fmt = NumFmt::new(code));
let (blue, signed, red, text, unit) =
(styled("[Blue]General"), styled("General;-General"), styled("General;[Red]-General"), styled("@"), styled("General\" mm\""));
let code = 124412140710.0;
let sh = wb.sheet_mut(0).unwrap();
let cells = [
(Value::Number(1.0 / 3.0), StyleId::DEFAULT),
(Value::Number(0.1 + 0.2), StyleId::DEFAULT),
(Value::Number(1e20), StyleId::DEFAULT),
(Value::Number(code), blue),
(Value::Number(9007199254740994.0), blue),
(Value::Number(-1.0 / 3.0), blue),
(Value::Number(-code), signed),
(Value::Number(-code), red),
(Value::Number(code), text),
(Value::Number(code), unit),
];
for (col, (value, style)) in cells.into_iter().enumerate() {
sh.set_cell(CellRef::new(0, col as u32), Cell { value, formula: None, py: None, style });
}
for (path, sep) in [("out.csv", ","), ("out.txt", "\t")] {
let output = String::from_utf8(save_bytes(&wb, path).unwrap()).unwrap();
let expected = [
"0.333333333333333",
"0.3",
"100000000000000000000",
"124412140710",
"9007199254740994",
"-0.333333333333333",
"-124412140710",
"-124412140710",
"124412140710",
"124412140710 mm",
];
assert_eq!(output, format!("{}\r\n", expected.join(sep)));
assert_eq!(output, format!("124412140710{separator}1.23456789012345{separator}1.24E+11\r\n"));
}
}
-1
View File
@@ -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)
+11 -1
View File
@@ -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.
+2 -38
View File
@@ -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 -3
View File
@@ -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 -29
View File
@@ -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 })
}
+2 -4
View File
@@ -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 {
+86 -252
View File
@@ -2,7 +2,7 @@
//! `TableStyleLight1…21 / Medium1…28 / Dark1…11` names so files round-trip).
use gridcraft_core::{CellRef, RangeRef};
use gridcraft_model::{BorderLine, BorderStyle, Borders, Cell, Color, Fill, Formula, PatternType, Sheet, Style, Table, Workbook};
use gridcraft_model::{BorderLine, BorderStyle, Cell, Color, Fill, Formula, PatternType, Style, Table, Workbook};
/// (family, number) from a style name, e.g. `TableStyleMedium2` → ("Medium", 2).
pub fn parse_style_name(name: &str) -> (&'static str, u32) {
@@ -22,279 +22,113 @@ fn accent_for(n: u32) -> Option<u8> {
if k == 0 { None } else { Some(3 + k as u8) }
}
/// Fills, text colours and thin lines of a table style, per part of the table (the recipes in
/// plan/excel/table-style-spec.json). Band 1 is the first data row; unbanded rows use band 2.
#[derive(Clone, Copy, Debug, PartialEq)]
/// Header/band/body colours for a table style.
pub struct TableLook {
pub header_fill: Option<Color>,
pub header_font: Color,
pub band1: Option<Color>,
pub band2: Option<Color>,
pub body_font: Color,
pub top: Option<Color>,
pub header_bottom: Option<Color>,
pub inner_h: Option<Color>,
pub inner_v: Option<Color>,
pub sides: Option<Color>,
pub bottom: Option<Color>,
/// The totals row's double top rule (the gallery doesn't show totals).
pub total_top: Color,
pub header_bold: bool,
pub band_fill: Option<Color>,
pub body_fill: Option<Color>,
pub line: Option<Color>,
pub total_top: Option<Color>,
}
pub fn look(style: &str) -> TableLook {
let (fam, n) = parse_style_name(style);
let acc = accent_for(n);
// An accent tint, or the neutral column's colour.
let a = |tint: i16, neutral: Color| acc.map_or(neutral, |a| Color::Theme(a, tint));
let (black, white) = (Color::Theme(1, 0), Color::Theme(0, 0));
let (grey, mid_grey) = (Color::Theme(0, -150), Color::Theme(0, -350));
let main = a(0, black);
let plain = TableLook {
header_fill: None,
header_font: black,
band1: None,
band2: None,
body_font: black,
top: None,
header_bottom: None,
inner_h: None,
inner_v: None,
sides: None,
bottom: None,
total_top: main,
let base = |tint: i16| match acc {
Some(a) => Color::Theme(a, tint),
None => Color::Theme(1, if tint == 0 { 0 } else { tint.clamp(-1000, 1000) }),
};
match (fam, n.saturating_sub(1) / 7) {
("Light", 0) => {
let text = a(-250, black);
let line = Some(main);
TableLook { header_font: text, body_font: text, band1: Some(a(800, grey)), top: line, header_bottom: line, bottom: line, ..plain }
}
("Light", 1) => {
let line = Some(main);
TableLook { header_fill: line, header_font: white, top: line, inner_h: line, sides: line, bottom: line, ..plain }
}
("Light", _) => {
let line = Some(main);
TableLook { band1: Some(a(800, grey)), top: line, header_bottom: line, inner_v: line, sides: line, bottom: line, ..plain }
}
("Medium", 0) => {
let line = Some(a(400, black));
TableLook { header_fill: Some(main), header_font: white, band1: Some(a(800, grey)), top: line, sides: line, bottom: line, ..plain }
}
("Medium", 1) => TableLook {
header_fill: Some(main),
header_font: white,
band1: Some(a(600, mid_grey)),
band2: Some(a(800, grey)),
header_bottom: Some(white),
inner_v: Some(white),
..plain
},
("Medium", 2) => {
// Accent header over neutral grey bands and black rules; the neutral style adds a grid.
let line = Some(black);
let grid = if acc.is_none() { line } else { None };
let header_fill = Some(main);
let neutral_light = |tint: i16| match acc {
Some(a) => Color::Theme(a, tint),
None => Color::Theme(0, -((1000 - tint).clamp(0, 1000) / 6)),
};
match fam {
"Light" => {
let group = (n - 1) / 7; // 0: lines only, 1: banded header line, 2: grid
TableLook {
header_fill,
header_font: white,
band1: Some(grey),
top: line,
header_bottom: line,
inner_v: grid,
sides: grid,
bottom: line,
total_top: black,
..plain
header_fill: None,
header_font: if group == 0 { base(-250) } else { Color::Auto },
header_bold: true,
band_fill: Some(neutral_light(800)),
body_fill: None,
line: Some(base(0)),
total_top: Some(base(0)),
}
}
("Medium", _) => {
let line = Some(a(400, black));
let pale = Some(a(800, grey));
TableLook { header_fill: pale, band1: Some(a(600, mid_grey)), band2: pale, top: line, inner_v: line, sides: line, bottom: line, ..plain }
}
("Dark", 0) => TableLook {
header_fill: Some(black),
header_font: white,
band1: Some(a(-250, Color::Theme(1, 250))),
band2: Some(a(0, Color::Theme(1, 450))),
body_font: white,
header_bottom: Some(white),
total_top: white,
..plain
"Dark" => TableLook {
header_fill: Some(Color::Theme(1, 0)),
header_font: Color::Theme(0, 0),
header_bold: true,
band_fill: Some(base(-250)),
body_fill: Some(base(0)),
line: None,
total_top: Some(Color::Theme(0, 0)),
},
_ => TableLook {
header_fill: Some(base(0)),
header_font: Color::Theme(0, 0),
header_bold: true,
band_fill: Some(neutral_light(800)),
body_fill: None,
line: if (n - 1) / 7 == 0 { None } else { Some(base(400)) },
total_top: Some(base(0)),
},
_ if n == 8 => TableLook { header_fill: Some(black), header_font: white, band1: Some(mid_grey), band2: Some(grey), ..plain },
_ => {
// Dark 9-11 pair accents 1+2, 3+4 and 5+6: the header takes the even one.
let k = n.clamp(9, 11) as u8 - 8;
let (head, body) = (Color::Theme(3 + 2 * k, 0), 2 + 2 * k);
let band1 = Some(Color::Theme(body, 600));
TableLook { header_fill: Some(head), header_font: white, band1, band2: Some(Color::Theme(body, 800)), total_top: head, ..plain }
}
}
}
/// Which parts of a table are on (the Table Style Options checkboxes).
#[derive(Clone, Copy, Debug)]
pub struct TableParts {
pub header_row: bool,
pub totals_row: bool,
pub banded_rows: bool,
pub banded_cols: bool,
pub first_col: bool,
pub last_col: bool,
}
impl TableParts {
pub fn of(t: &Table) -> TableParts {
TableParts {
header_row: t.header_row,
totals_row: t.totals_row,
banded_rows: t.banded_rows,
banded_cols: t.banded_cols,
first_col: t.first_col,
last_col: t.last_col,
}
}
}
/// What a table style paints on one cell of a `rows` x `cols` table (`row`, `col` from its
/// top-left). Each line has one owner: a horizontal line is a cell's bottom (top only on the
/// first row and the totals row), a vertical one a cell's right (left only on the first column).
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct CellLook {
pub fill: Option<Color>,
pub font: Color,
pub bold: bool,
pub borders: Borders,
}
pub fn cell_look(lk: &TableLook, p: TableParts, row: u32, col: u32, rows: u32, cols: u32) -> CellLook {
let last_row = rows.saturating_sub(1);
let last_col = cols.saturating_sub(1);
let is_header = p.header_row && row == 0;
let is_total = p.totals_row && row == last_row && !is_header;
let thin = |c: Option<Color>| c.map(|color| BorderLine { style: BorderStyle::Thin, color }).unwrap_or_default();
let mut b = Borders::default();
if row == 0 {
b.top = thin(lk.top);
}
b.bottom = thin(if row == last_row {
lk.bottom
} else if is_header {
lk.header_bottom
} else if p.totals_row && row.saturating_add(1) == last_row {
None // the totals row draws its own top rule
} else {
lk.inner_h
});
if col == 0 {
b.left = thin(lk.sides);
}
b.right = thin(if col == last_col { lk.sides } else { lk.inner_v });
let mut out = CellLook { borders: b, font: lk.body_font, ..Default::default() };
if is_header {
out.fill = lk.header_fill;
out.font = lk.header_font;
out.bold = true;
} else if is_total {
out.fill = lk.band2;
out.bold = true;
out.borders.top = BorderLine { style: BorderStyle::Double, color: lk.total_top };
} else {
let data_row = row.saturating_sub(p.header_row as u32);
let band1 = (p.banded_rows && data_row.is_multiple_of(2)) || (p.banded_cols && col.is_multiple_of(2));
out.fill = if band1 { lk.band1 } else { lk.band2 };
}
if (p.first_col && col == 0) || (p.last_col && col == last_col) {
out.bold = true;
}
out
}
/// The style a table gives a cell (merged over the cell's own style: explicit fills, fonts and
/// borders win).
/// The style a table gives a cell (merged over the cell's own style: explicit fills/fonts win).
pub fn table_cell_style(wb: &Workbook, sheet: usize, t: &Table, c: CellRef) -> Style {
let own = wb.sheet(sheet).map(|sh| wb.styles.get(sh.style_id(c)).clone()).unwrap_or_default();
let (start, end) = (t.range.start, t.range.end);
let rows = end.row.saturating_sub(start.row).saturating_add(1);
let cols = end.col.saturating_sub(start.col).saturating_add(1);
let lk = cell_look(&look(&t.style), TableParts::of(t), c.row.saturating_sub(start.row), c.col.saturating_sub(start.col), rows, cols);
let mut s = own.clone();
if let Some(f) = lk.fill
&& own.fill.pattern == PatternType::None
{
s.fill = Fill::solid(f);
}
if own.font.color == Color::Auto {
s.font.color = lk.font;
}
s.font.bold = s.font.bold || lk.bold;
for (side, line) in [
(&mut s.borders.top, lk.borders.top),
(&mut s.borders.bottom, lk.borders.bottom),
(&mut s.borders.left, lk.borders.left),
(&mut s.borders.right, lk.borders.right),
] {
if side.is_none() {
*side = line;
let lk = look(&t.style);
let is_header = t.header_row && c.row == t.range.start.row;
let is_total = t.totals_row && c.row == t.range.end.row;
let data_row = c.row.saturating_sub(t.range.start.row + t.header_row as u32);
let data_col = c.col - t.range.start.col;
let explicit_fill = own.fill.pattern != PatternType::None;
if is_header {
if let Some(f) = lk.header_fill
&& !explicit_fill
{
s.fill = Fill::solid(f);
}
if own.font.color == Color::Auto {
s.font.color = lk.header_font;
}
s.font.bold = s.font.bold || lk.header_bold;
if let Some(l) = lk.line {
s.borders.bottom = BorderLine { style: BorderStyle::Thin, color: l };
}
} else if is_total {
s.font.bold = true;
if let Some(l) = lk.total_top {
s.borders.top = BorderLine { style: BorderStyle::Double, color: l };
}
} else {
let band = (t.banded_rows && data_row.is_multiple_of(2)) || (t.banded_cols && data_col.is_multiple_of(2));
if !explicit_fill {
if band {
if let Some(f) = lk.band_fill {
s.fill = Fill::solid(f);
}
} else if let Some(f) = lk.body_fill {
s.fill = Fill::solid(f);
}
}
if let Some(l) = lk.line
&& t.style.contains("Light")
&& c.row == t.range.end.row
{
s.borders.bottom = BorderLine { style: BorderStyle::Thin, color: l };
}
}
s
}
/// A table's first and last visible row and column (hidden or filtered lines skipped).
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ShownEdges {
pub top: u32,
pub bottom: u32,
pub left: u32,
pub right: u32,
}
/// Finds [`ShownEdges`]. It scans the hidden lines at each edge, so the grid and print call it
/// once per table per paint (through [`crate::cf::CfCache::table_edges`]), not once per cell.
pub fn shown_edges(sh: &Sheet, t: &Table) -> ShownEdges {
let (start, end) = (t.range.start, t.range.end);
let row_shown = |r: &u32| sh.row_height(*r) > 0.0;
let col_shown = |k: &u32| sh.col_width(*k) > 0.0;
// With every row (or column) hidden, each cell takes both edges' lines; nothing is drawn.
ShownEdges {
top: (start.row..=end.row).find(row_shown).unwrap_or(end.row),
bottom: (start.row..=end.row).rev().find(row_shown).unwrap_or(start.row),
left: (start.col..=end.col).find(col_shown).unwrap_or(end.col),
right: (start.col..=end.col).rev().find(col_shown).unwrap_or(start.col),
if (t.first_col && c.col == t.range.start.col) || (t.last_col && c.col == t.range.end.col) {
s.font.bold = true;
}
}
/// The style the grid and print draw for a table cell. Like [`table_cell_style`], but the
/// table's outer frame follows hidden rows and columns: the last visible row takes the table's
/// bottom line, the last visible column its right side, and the first visible row and column its
/// top line and left side. (Each frame line is owned by the edge cell, which is never drawn while
/// it is hidden or filtered out.) Convert to Range uses [`table_cell_style`], the table as it is.
pub fn table_cell_shown_style(wb: &Workbook, sheet: usize, t: &Table, e: ShownEdges, c: CellRef) -> Style {
let mut s = table_cell_style(wb, sheet, t, c);
let Some(sh) = wb.sheet(sheet) else { return s };
let (start, end) = (t.range.start, t.range.end);
let below = c.row < end.row && c.row >= e.bottom;
let above = c.row > start.row && c.row <= e.top;
let right = c.col < end.col && c.col >= e.right;
let left = c.col > start.col && c.col <= e.left;
if !(below || above || right || left) {
return s;
}
let own = wb.styles.get(sh.style_id(c)).borders;
if below && own.bottom.is_none() {
s.borders.bottom = table_cell_style(wb, sheet, t, CellRef::new(end.row, c.col)).borders.bottom;
}
if above && own.top.is_none() {
s.borders.top = table_cell_style(wb, sheet, t, CellRef::new(start.row, c.col)).borders.top;
}
if right && own.right.is_none() {
s.borders.right = table_cell_style(wb, sheet, t, CellRef::new(c.row, end.col)).borders.right;
}
if left && own.left.is_none() {
s.borders.left = table_cell_style(wb, sheet, t, CellRef::new(c.row, start.col)).borders.left;
if t.style.starts_with("TableStyleDark") && !is_header && own.font.color == Color::Auto {
s.font.color = Color::Theme(0, 0);
}
s
}
+1 -343
View File
@@ -869,65 +869,6 @@ fn deleting_a_multi_area_row_selection_removes_every_area_and_undoes_once() {
assert_eq!((v(&s, "A1"), v(&s, "B1"), v(&s, "C1")), (Value::Number(2.0), Value::Number(4.0), Value::Empty));
}
#[test]
#[allow(clippy::disallowed_methods)] // native-only test: timing the two deletes
fn deleting_many_separate_rows_takes_about_as_long_as_one_block() {
// #2287: every 10th row of a 12,000-row sheet, as 1,200 single-row areas.
let (rows, step) = (12_000u32, 10u32);
let values: Vec<serde_json::Value> = (0..rows).map(|r| json!([r, r + 100_000, r + 200_000])).collect();
let deleted = |r: u32| r >= 1 && (r - 1).is_multiple_of(step);
let list = (0..rows).filter(|&r| deleted(r)).map(|r| format!("{0}:{0}", r + 1)).collect::<Vec<_>>().join(",");
let build = || {
let mut s = s();
s.execute("range.setValues", json!({"range": "A1", "values": values})).unwrap();
s.execute("cell.set", json!({"cell": "E1", "input": format!("=SUM(A1:A{rows})")})).unwrap();
s.execute("cell.set", json!({"cell": "E3", "input": "=B25"})).unwrap();
s
};
let mut block = build();
let t = std::time::Instant::now();
block.execute("home.deleteRows", json!({"rows": format!("2:{}", rows / step + 1)})).unwrap();
let block_time = t.elapsed();
let mut s = build();
let t = std::time::Instant::now();
s.execute("home.deleteRows", json!({"rows": list})).unwrap();
let separate_time = t.elapsed();
let kept: Vec<u32> = (0..rows).filter(|&r| !deleted(r)).collect();
let d = s.doc().unwrap();
let sh = d.wb.active().unwrap();
assert_eq!(sh.used_range().unwrap().end.row as usize, kept.len() - 1);
for (i, r) in kept.iter().enumerate() {
assert_eq!(sh.value(CellRef::new(i as u32, 0)), Value::Number(*r as f64));
assert_eq!(sh.value(CellRef::new(i as u32, 2)), Value::Number((*r + 200_000) as f64));
}
assert_eq!(s.execute("cell.get", json!({"cell": "E1"})).unwrap()["formula"], format!("=SUM(A1:A{})", kept.len()));
// B25 loses rows 2, 12 and 22 above it; the formula itself moves from E3 to E2.
assert_eq!(s.execute("cell.get", json!({"cell": "E2"})).unwrap()["formula"], "=B22");
assert!(
separate_time < block_time * 20 + std::time::Duration::from_millis(500),
"separate rows took {separate_time:?}, one block took {block_time:?}"
);
}
#[test]
fn deleting_many_separate_columns_matches_per_area_result() {
let mut s = s();
let values: Vec<serde_json::Value> = (0..50).map(|r| json!((0..40).map(|c| r * 100 + c).collect::<Vec<_>>())).collect();
s.execute("range.setValues", json!({"range": "A1", "values": values})).unwrap();
s.execute("cell.set", json!({"cell": "A60", "input": "=SUM(A1:AN1)+H2"})).unwrap();
// Columns B, E, H (refs) and F:G.
s.execute("home.deleteColumns", json!({"cols": "B:B,E:E,H:H,F:G"})).unwrap();
let kept: Vec<u32> = (0..40).filter(|c| ![1, 4, 5, 6, 7].contains(c)).collect();
for r in 0..50u32 {
for (i, c) in kept.iter().enumerate() {
assert_eq!(s.doc().unwrap().wb.active().unwrap().value(CellRef::new(r, i as u32)), Value::Number((r * 100 + c) as f64));
}
}
assert_eq!(s.execute("cell.get", json!({"cell": "A60"})).unwrap()["formula"], "=SUM(A1:AI1)+#REF!");
}
#[test]
fn move_columns_reorders_without_overwriting_and_undoes_once() {
let mut s = s();
@@ -1680,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();
@@ -1856,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());
@@ -1864,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();
@@ -2516,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
@@ -3084,128 +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, is
// #SPILL! because E10 holds those cells (as in Excel), shrinks back and spills 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: E10 holds F10, so it keeps it and F8 is blocked.
assert_eq!(v(&s, "F8"), Value::Error(Spill));
assert_eq!(v(&s, "F10"), Value::Number(20.0));
}
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, blocked again.
assert_eq!(v(&s, "F8"), Value::Error(Spill));
assert_eq!(v(&s, "F10"), Value::Number(20.0));
}
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
@@ -3415,21 +3149,6 @@ fn a_spill_that_goes_away_unblocks_another() {
assert_eq!((v(&s, "E10"), v(&s, "G10")), (Value::Number(1.0), Value::Number(3.0)));
}
#[test]
fn a_contested_spill_area_stays_with_its_array_after_reopening() {
// F13's array wants F14:G14, which C14's array already fills, so F13 is #SPILL!. The file
// can only cache #VALUE! for it; reopening (which recalculates) used to hand the area to F13
// for coming first in reading order.
let mut s = s();
s.execute("cell.set", json!({"cell": "C14", "input": "=SEQUENCE(1,7)"})).unwrap();
s.execute("cell.set", json!({"cell": "F13", "input": "=SEQUENCE(5,2)"})).unwrap();
assert_eq!(v(&s, "F13"), Value::Error(gridcraft_core::CellError::Spill));
let saved = s.execute("file.saveBytes", json!({"format": "xlsx"})).unwrap();
s.execute("file.open", json!({"name": "contested.xlsx", "base64": saved["base64"]})).unwrap();
assert_eq!(v(&s, "F13"), Value::Error(gridcraft_core::CellError::Spill));
assert_eq!((v(&s, "C14"), v(&s, "G14"), v(&s, "I14")), (Value::Number(1.0), Value::Number(5.0), Value::Number(7.0)));
}
#[test]
fn an_array_reading_another_arrays_spill_is_updated() {
// G5 is evaluated before D11 in the same pass, so it first reads D11's old spill.
@@ -3454,19 +3173,6 @@ fn indirect_reads_a_spill_laid_out_in_the_same_pass() {
assert_eq!(v(&s, "E5"), Value::Number(9.0));
}
#[test]
fn inserting_rows_lays_out_spills_where_the_formulas_moved() {
// D1's array grows with the inserted rows to D1:D10 and C10's array moves down to C12:E14:
// the area C10:E12 it filled before the insertion blocks neither of them.
let mut s = s();
s.execute("cell.set", json!({"cell": "D1", "input": "=SEQUENCE(ROWS(A2:A9))"})).unwrap();
s.execute("cell.set", json!({"cell": "C8", "input": "=1"})).unwrap();
s.execute("cell.set", json!({"cell": "C10", "input": "=SEQUENCE(3,3)"})).unwrap();
s.execute("home.insertRows", json!({"rows": "3:4"})).unwrap();
assert_eq!((v(&s, "D1"), v(&s, "D10")), (Value::Number(1.0), Value::Number(10.0)));
assert_eq!((v(&s, "C12"), v(&s, "D12"), v(&s, "E14")), (Value::Number(1.0), Value::Number(2.0), Value::Number(9.0)));
}
#[test]
fn every_command_survives_empty_params() {
let mut s = Session::new();
@@ -5924,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.
@@ -6714,7 +6373,6 @@ fn a_script_cannot_switch_windows() {
mod controls;
mod equation;
mod json_golden;
mod macros;
mod objects;
mod python_cells;
-80
View File
@@ -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());
}
-13
View File
@@ -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
View File
@@ -1 +0,0 @@
not a GridCraft JSON workbook: invalid type: integer `7`, expected a sequence at line 1 column 12
-440
View File
@@ -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": []
}
]
}
-448
View File
@@ -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
}
@@ -35,7 +35,7 @@ use std::sync::Arc;
use gridcraft_core::{CellError, CellRef, MAX_COLS, MAX_ROWS, RangeRef, Value, col_to_letters};
use gridcraft_engine::calc::Calc;
use gridcraft_engine::model::{CalcMode, Formula, Sheet, SheetViewMode, Workbook};
use gridcraft_engine::{EngineError, HistoryEntry, Session, command_specs, find_command, io};
use gridcraft_engine::{EngineError, Session, command_specs, find_command, io};
use serde_json::{Value as Json, json};
const SAMPLES: [&str; 3] = ["sales", "budget", "grades"];
@@ -219,24 +219,8 @@ fn shrink(sample: &str, steps: &[Step], kind: &str) -> Vec<Step> {
struct Harness {
s: Session,
/// What undoing everything gives back: the workbook at the start of the current episode or,
/// once the undo history has dropped its oldest steps (it is bounded by count and by the
/// memory its snapshots hold), the state before the oldest step it kept.
floor: Arc<Workbook>,
/// The workbook of the oldest undo step when the history was last looked at, to notice the
/// history dropping it.
oldest: Option<Arc<Workbook>>,
}
/// Where redoing the `n` steps just undone ends. The first of them went onto the redo history
/// with the final workbook `end`. The redo history is bounded like undo and drops its oldest
/// entries first, so when that entry is gone every older one is too, and redo stops after fewer
/// than `n` steps at the oldest entry it kept.
fn redo_target(end: &Arc<Workbook>, redo: &[HistoryEntry], n: usize) -> Arc<Workbook> {
if n == 0 || redo.iter().rev().take(n).any(|e| Arc::ptr_eq(&e.wb, end)) {
return end.clone();
}
redo.first().map_or_else(|| end.clone(), |e| e.wb.clone())
/// The workbook at the start of the current episode (what undoing everything gives back).
base: Arc<Workbook>,
}
fn fail(step: usize, kind: &'static str, what: impl Into<String>) -> Failure {
@@ -259,8 +243,8 @@ impl Harness {
fn new(sample: &str) -> Harness {
let mut s = Session::new();
s.execute("file.new", json!({"sample": sample})).expect("sample opens");
let floor = s.doc().expect("document").wb.clone();
Harness { s, floor, oldest: None }
let base = s.doc().expect("document").wb.clone();
Harness { s, base }
}
fn wb(&self) -> Arc<Workbook> {
@@ -278,7 +262,6 @@ impl Harness {
return Err(fail(i, "documents", format!("`{id}` changed the number of open documents; exclude it in EXCLUDED")));
}
let after = self.wb();
self.track_history();
let spec = find_command(id).expect("generated ids are registered");
if !spec.undoable
&& !matches!(id, "edit.undo" | "edit.redo")
@@ -310,7 +293,6 @@ impl Harness {
/// and reload; the next episode starts from here with an empty history.
fn end_episode(&mut self, i: usize) -> Result<(), Failure> {
let end = self.wb();
self.track_history();
let mut n = 0;
while !self.s.doc().expect("document").undo.is_empty() {
if let Err(EngineError::Internal(_, msg)) = self.s.execute("edit.undo", json!({})) {
@@ -322,7 +304,7 @@ impl Harness {
}
}
let undone = self.wb();
if let Some(diff) = workbook_diff(&self.floor, &undone) {
if let Some(diff) = workbook_diff(&self.base, &undone) {
return Err(fail(i, "undo", format!("undoing all {n} steps doesn't give back the starting workbook: {diff}")));
}
if watch_list(&end) != watch_list(&undone) {
@@ -330,39 +312,23 @@ impl Harness {
}
self.check_state(i)?;
// Only the steps undone here: an `edit.undo {steps}` in the sequence may have left more.
let target = redo_target(&end, &self.s.doc().expect("document").redo, n);
for _ in 0..n {
if let Err(EngineError::Internal(_, msg)) = self.s.execute("edit.redo", json!({})) {
return Err(fail(i, "panic", format!("`edit.redo` panicked while redoing everything: {msg}")));
}
}
if let Some(diff) = workbook_diff(&target, &self.wb()) {
let what = if Arc::ptr_eq(&target, &end) { "the final workbook" } else { "the newest step the redo history kept" };
return Err(fail(i, "redo", format!("redoing all {n} steps doesn't give back {what}: {diff}")));
if let Some(diff) = workbook_diff(&end, &self.wb()) {
return Err(fail(i, "redo", format!("redoing all {n} steps doesn't give back the final workbook: {diff}")));
}
self.check_state(i)?;
guarded(i, "xlsx roundtrip", || roundtrip_diff(&end))?;
let d = self.s.active_mut().expect("document");
d.undo.clear();
d.redo.clear();
self.floor = d.wb.clone();
self.oldest = None;
self.base = d.wb.clone();
Ok(())
}
/// Notices the undo history dropping its oldest step: its oldest entry changed without the
/// history emptying in between. From then on undoing everything stops at the new oldest entry,
/// including after an `edit.undo` in the sequence has already used up what is left.
fn track_history(&mut self) {
let oldest = self.s.doc().expect("document").undo.first().map(|e| e.wb.clone());
if let (Some(was), Some(now)) = (&self.oldest, &oldest)
&& !Arc::ptr_eq(was, now)
{
self.floor = now.clone();
}
self.oldest = oldest;
}
fn finish(&mut self, steps: usize) -> Result<(), Failure> {
self.end_episode(steps)
}
@@ -1169,42 +1135,3 @@ fn view_mode_switch_is_not_an_undo_difference() {
assert!(failure.is_none(), "`{id}`: {failure:?}");
}
}
/// Review of #2332: once the undo history has dropped its oldest steps, an `edit.undo` in the
/// sequence can use up everything it kept before the episode ends. Undoing everything then has
/// nothing left to do, and the workbook is the state before the oldest step kept, not the
/// episode's start.
#[test]
fn a_trimmed_history_undone_in_the_sequence_stops_at_its_oldest_step() {
let mut h = Harness::new("sales");
// Past the engine's 100-step undo limit, so it drops the oldest 5 steps.
for i in 0..105 {
h.s.execute("cell.set", json!({"cell": format!("Z{}", i + 1), "input": i.to_string()})).expect("cell.set");
h.track_history();
}
assert_eq!(h.s.doc().expect("document").undo.len(), 100, "the history dropped its oldest steps");
if let Err(f) = h.step(0, "edit.undo", &json!({"steps": 100})) {
panic!("{f:?}");
}
assert!(h.s.doc().expect("document").undo.is_empty());
if let Err(f) = h.end_episode(0) {
panic!("{f:?}");
}
}
/// Review of #2332: the redo history is bounded too, so undoing `n` steps may leave fewer than
/// `n` to redo, and redo then stops at the oldest entry it kept rather than at the final workbook.
#[test]
fn redo_stops_at_the_oldest_step_its_history_kept() {
let h = Harness::new("sales");
let selection = h.s.doc().expect("document").selection.clone();
let entry = |wb: &Arc<Workbook>| HistoryEntry { label: String::new(), wb: wb.clone(), selection: selection.clone(), retained_bytes: 0 };
let end = Arc::new((*h.wb()).clone());
let kept = Arc::new((*h.wb()).clone());
// Both steps kept: the first one undone went onto the redo history with the final workbook.
assert!(Arc::ptr_eq(&redo_target(&end, &[entry(&end), entry(&kept)], 2), &end));
// Its entry dropped: redo stops at the oldest entry left.
assert!(Arc::ptr_eq(&redo_target(&end, &[entry(&kept)], 2), &kept));
// Nothing undone, so nothing to redo, whatever an earlier `edit.undo` left there.
assert!(Arc::ptr_eq(&redo_target(&end, &[entry(&kept)], 0), &end));
}
-1
View File
@@ -32,7 +32,6 @@ mod sparse_clear_invalidation;
mod stored_list_shape;
mod structural_edit_rewrite;
mod table_resize_overlap;
mod table_style_looks;
mod table_total_row_last_row;
mod trace_error;
mod workbook_author;
-243
View File
@@ -1,243 +0,0 @@
//! Table styles look like the Format as Table gallery: every row of the gallery (Light 1-7, 8-14,
//! 15-21, Medium 1-7, …) has its own fills and lines, as recorded in plan/excel/table-style-spec.json.
use gridcraft_core::CellRef;
use gridcraft_engine::Session;
use gridcraft_engine::model::*;
use gridcraft_engine::tables::{ShownEdges, shown_edges, table_cell_shown_style, table_cell_style};
use serde_json::json;
const ROWS: u32 = 6; // header + 5 data rows
const COLS: u32 = 5;
fn session() -> Session {
let mut s = Session::new();
s.new_workbook();
s.execute("range.setValues", json!({"range": "A1", "values": [["a", "b", "c", "d", "e"]]})).unwrap();
s.execute("insert.table", json!({"range": "A1:E6", "header": true})).unwrap();
s
}
/// The look of every cell of a 6x5 table (header on, banded rows) in `style`, row by row.
fn grid_with(s: &Session, style: &str, edit: impl Fn(&mut Table)) -> Vec<Vec<Style>> {
let wb = &s.doc().unwrap().wb;
let mut t = wb.sheet(0).unwrap().tables[0].clone();
t.style = format!("TableStyle{style}");
edit(&mut t);
(0..ROWS).map(|r| (0..COLS).map(|c| table_cell_style(wb, 0, &t, CellRef::new(r, c))).collect()).collect()
}
fn grid(style: &str) -> Vec<Vec<Style>> {
grid_with(&session(), style, |_| {})
}
fn thin(color: Color) -> BorderLine {
BorderLine { style: BorderStyle::Thin, color }
}
const NONE: BorderLine = BorderLine { style: BorderStyle::None, color: Color::Auto };
const BLACK: Color = Color::Theme(1, 0);
const WHITE: Color = Color::Theme(0, 0);
#[test]
fn each_row_of_the_gallery_has_its_own_look() {
// Same accent (or neutral) across the gallery's rows, so only the row-group differs.
for set in [
&["Light1", "Light8", "Light15", "Medium1", "Medium8", "Medium15", "Medium22", "Dark1", "Dark8"][..],
&["Light2", "Light9", "Light16", "Medium2", "Medium9", "Medium16", "Medium23", "Dark2", "Dark9"][..],
] {
let looks: Vec<_> = set.iter().map(|s| grid(s)).collect();
for (i, a) in looks.iter().enumerate() {
for (j, b) in looks.iter().enumerate().skip(i + 1) {
assert_ne!(a, b, "{} and {} look the same", set[i], set[j]);
}
}
}
}
#[test]
fn neutral_bands_are_visibly_grey() {
let theme = Theme::default();
let fill = |style: &str, row: usize| grid(style)[row][0].fill.fg.resolve(&theme).unwrap();
// lt1 -150 (about #D9D9D9) and lt1 -350 (about #A6A6A6).
for ch in fill("Light1", 1) {
assert!((210..=225).contains(&ch), "Light1 band {:?}", fill("Light1", 1));
}
for ch in fill("Medium8", 1) {
assert!((160..=172).contains(&ch), "Medium8 band1 {:?}", fill("Medium8", 1));
}
}
#[test]
fn light15_has_a_vertical_grid_and_no_row_lines() {
let g = grid("Light15");
assert_eq!(g[0][0].borders.top, thin(BLACK));
assert_eq!(g[0][2].borders.bottom, thin(BLACK), "header bottom");
assert_eq!(g[2][1].borders.right, thin(BLACK), "inner vertical");
assert_eq!(g[0][1].borders.right, thin(BLACK), "inner vertical in the header");
assert_eq!(g[2][0].borders.left, thin(BLACK), "left side");
assert_eq!(g[2][4].borders.right, thin(BLACK), "right side");
assert_eq!(g[5][2].borders.bottom, thin(BLACK), "bottom");
assert_eq!(g[2][1].borders.bottom, NONE, "no inner horizontal");
assert_eq!(g[2][1].borders.top, NONE, "no inner horizontal");
assert_eq!(g[1][0].fill.fg, Color::Theme(0, -150));
}
#[test]
fn medium2_has_a_pale_accent_frame_and_no_row_lines() {
let g = grid("Medium2");
let line = thin(Color::Theme(4, 400));
assert_eq!(g[0][0].fill.fg, Color::Theme(4, 0));
assert_eq!(g[0][0].font.color, WHITE);
assert_eq!(g[0][2].borders.top, line);
assert_eq!(g[0][0].borders.left, line, "the sides run down the header too");
assert_eq!(g[3][0].borders.left, line);
assert_eq!(g[3][4].borders.right, line);
assert_eq!(g[5][2].borders.bottom, line);
assert_eq!(g[0][2].borders.bottom, NONE, "no header bottom");
assert_eq!(g[2][2].borders.bottom, NONE, "no inner horizontal");
assert_eq!(g[2][2].borders.right, NONE, "no inner vertical");
assert_eq!(g[1][2].fill.fg, Color::Theme(4, 800));
assert_eq!(g[2][2].fill.pattern, PatternType::None);
}
#[test]
fn medium9_has_white_verticals_and_header_bottom() {
let g = grid("Medium9");
assert_eq!(g[0][1].borders.bottom, thin(WHITE));
assert_eq!(g[0][1].borders.right, thin(WHITE));
assert_eq!(g[3][1].borders.right, thin(WHITE));
assert_eq!(g[3][1].borders.bottom, NONE);
assert_eq!(g[3][0].borders.left, NONE, "no frame");
assert_eq!(g[5][4].borders.bottom, NONE, "no frame");
assert_eq!(g[1][0].fill.fg, Color::Theme(4, 600));
assert_eq!(g[2][0].fill.fg, Color::Theme(4, 800));
}
#[test]
fn dark2_bands_in_shaded_and_full_accent_under_a_black_header() {
let g = grid("Dark2");
assert_eq!(g[0][0].fill.fg, BLACK);
assert_eq!(g[0][0].borders.bottom, thin(WHITE));
assert_eq!(g[1][0].fill.fg, Color::Theme(4, -250));
assert_eq!(g[2][0].fill.fg, Color::Theme(4, 0));
assert_eq!(g[2][0].font.color, WHITE);
assert_eq!(g[2][0].borders, Borders::default());
}
#[test]
fn dark9_pairs_two_accents() {
let g = grid("Dark9");
assert_eq!(g[0][0].fill.fg, Color::Theme(5, 0));
assert_eq!(g[0][0].font.color, WHITE);
assert_eq!(g[1][0].fill.fg, Color::Theme(4, 600));
assert_eq!(g[2][0].fill.fg, Color::Theme(4, 800));
assert_eq!(g[2][0].font.color, BLACK);
let g = grid("Dark11");
assert_eq!(g[0][0].fill.fg, Color::Theme(9, 0));
assert_eq!(g[1][0].fill.fg, Color::Theme(8, 600));
}
#[test]
fn table_options_change_the_look() {
let s = session();
// Banded rows off: every data row looks like the second band.
let g = grid_with(&s, "Medium9", |t| t.banded_rows = false);
assert_eq!(g[1][0].fill.fg, Color::Theme(4, 800));
assert_eq!(g[2][0].fill.fg, Color::Theme(4, 800));
// Banded columns alternate by column.
let g = grid_with(&s, "Medium9", |t| {
t.banded_rows = false;
t.banded_cols = true;
});
assert_eq!(g[2][0].fill.fg, Color::Theme(4, 600));
assert_eq!(g[2][1].fill.fg, Color::Theme(4, 800));
// Header off: the top line moves to the first data row, and nothing is drawn as a header.
let g = grid_with(&s, "Light15", |t| t.header_row = false);
assert_eq!(g[0][2].borders.top, thin(BLACK));
assert_eq!(g[0][2].borders.bottom, NONE);
assert!(!g[0][2].font.bold);
// Totals row: bold, double top rule, no banding.
let g = grid_with(&s, "Medium2", |t| t.totals_row = true);
assert!(g[5][1].font.bold);
assert_eq!(g[5][1].borders.top, BorderLine { style: BorderStyle::Double, color: Color::Theme(4, 0) });
assert_eq!(g[5][1].borders.bottom, thin(Color::Theme(4, 400)));
// First and last column bold.
let g = grid_with(&s, "Medium2", |t| {
t.first_col = true;
t.last_col = true;
});
assert!(g[2][0].font.bold && g[2][4].font.bold && !g[2][2].font.bold);
}
#[test]
fn explicit_formatting_wins() {
let mut s = session();
s.execute("home.fillColor", json!({"range": "B3", "color": "#FF0000"})).unwrap();
s.execute("home.fontColor", json!({"range": "B3", "color": "#00FF00"})).unwrap();
s.execute("home.borders", json!({"range": "B3", "preset": "bottom"})).unwrap();
let g = grid_with(&s, "Dark2", |_| {});
assert_eq!(g[2][1].fill, Fill::solid(Color::Rgb(0xFF0000)));
assert_eq!(g[2][1].font.color, Color::Rgb(0x00FF00));
assert_eq!(g[2][1].borders.bottom.style, BorderStyle::Thin);
assert_eq!(g[2][1].borders.bottom.color, Color::Auto);
}
#[test]
fn every_style_name_is_safe() {
for name in ["Light0", "Light99", "Medium0", "Medium4000000000", "Dark0", "Dark12", "Dark99", "Bogus"] {
let _ = grid(name);
}
}
/// What the grid and print draw: like `grid_with`, but through the hidden-row/column aware
/// `table_cell_shown_style`.
fn shown_with(s: &Session, style: &str, edit: impl Fn(&mut Table)) -> Vec<Vec<Style>> {
let wb = &s.doc().unwrap().wb;
let mut t = wb.sheet(0).unwrap().tables[0].clone();
t.style = format!("TableStyle{style}");
edit(&mut t);
let e = shown_edges(wb.sheet(0).unwrap(), &t);
(0..ROWS).map(|r| (0..COLS).map(|c| table_cell_shown_style(wb, 0, &t, e, CellRef::new(r, c))).collect()).collect()
}
#[test]
fn frame_follows_the_last_visible_row_and_column() {
let frame = thin(Color::Theme(4, 400));
// Nothing hidden: the shown look is the table look.
let s = session();
assert_eq!(shown_with(&s, "Medium2", |_| {}), grid_with(&s, "Medium2", |_| {}));
// Last data row (and the one before it) and last column hidden: the frame moves in.
let mut s = session();
s.execute("home.hideRows", json!({"rows": "5:6"})).unwrap();
s.execute("home.hideColumns", json!({"cols": "E:E"})).unwrap();
let t = &s.doc().unwrap().wb.sheet(0).unwrap().tables[0];
assert_eq!(shown_edges(s.doc().unwrap().wb.sheet(0).unwrap(), t), ShownEdges { top: 0, bottom: 3, left: 0, right: 3 });
let g = shown_with(&s, "Medium2", |_| {});
for (c, cell) in g[3].iter().take(4).enumerate() {
assert_eq!(cell.borders.bottom, frame, "bottom frame on row 4, col {c}");
}
for (r, row) in g.iter().take(4).enumerate() {
assert_eq!(row[3].borders.right, frame, "right frame on col D, row {r}");
}
// Rows above the last visible one keep their inner look (Medium 2 has no row lines).
assert_eq!(g[2][1].borders.bottom, NONE);
// Convert to Range and friends still see the table as it is.
assert_eq!(grid_with(&s, "Medium2", |_| {})[3][1].borders.bottom, NONE);
// Header off and the first data row filtered out: the top line moves down.
let mut s = session();
s.execute("home.hideRows", json!({"rows": "1:1"})).unwrap();
s.execute("home.hideColumns", json!({"cols": "A:A"})).unwrap();
let g = shown_with(&s, "Light15", |t| t.header_row = false);
assert_eq!(g[1][2].borders.top, thin(BLACK));
assert_eq!(g[2][1].borders.left, thin(BLACK));
// Explicit borders still win.
let mut s = session();
s.execute("home.borders", json!({"range": "B5", "preset": "none"})).unwrap();
s.execute("home.fillColor", json!({"range": "B5", "color": "#FF0000"})).unwrap();
s.execute("home.borders", json!({"range": "C5", "preset": "bottom"})).unwrap();
s.execute("home.hideRows", json!({"rows": "6:6"})).unwrap();
let g = shown_with(&s, "Medium2", |_| {});
assert_eq!(g[4][1].borders.bottom, frame);
assert_eq!(g[4][2].borders.bottom.color, Color::Auto);
}
-5
View File
@@ -617,11 +617,6 @@ mod tests {
cx(ev("IMCSC", vec![t("4+3i")]), -0.075_489_832_915_863_7, 0.064_877_471_370_635_5);
is_text(ev("IMSECH", vec![t("0")]), "1");
is_err(ev("IMCSCH", vec![t("0")]), CellError::Num);
// Excel-cached results (Excel for Mac, `formulas` project test.xlsx, ENGINEERING sheet): a
// part needing more than 21 characters as a decimal is written in scientific notation.
is_text(ev("IMCSCH", vec![t("13+5j")]), "1.28233995888454E-06+4.33496947416312E-06j");
is_text(ev("IMEXP", vec![t("-13+25j")]), "2.24044486393732E-06-2.99158552811404E-07j");
is_text(ev("IMSECH", vec![t("7+25j")]), "0.00180771853884451+0.000241377759972715j");
// sech z · cosh z = 1
let Value::Text(c) = ev("IMCOSH", vec![t("4+3i")]) else { panic!() };
let Value::Text(sc) = ev("IMSECH", vec![t("4+3i")]) else { panic!() };
+1 -4
View File
@@ -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
-201
View File
@@ -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");
}
}
-19
View File
@@ -53,11 +53,6 @@ pub struct PrintSettings {
/// sheet is more than one page wide and tall.
#[serde(default)]
pub page_order: PageOrder,
/// Page Setup › Page › First page number: the number the sheet's first printed page takes,
/// or `None` for Automatic (XLSX `pageSetup firstPageNumber` with `useFirstPageNumber`). Left
/// out of a JSON workbook when Automatic, so files without it are written as before.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub first_page_number: Option<u32>,
}
fn yes() -> bool {
@@ -192,7 +187,6 @@ impl Default for PrintSettings {
hf_scale_with_doc: true,
hf_align_with_margins: true,
page_order: PageOrder::DownThenOver,
first_page_number: None,
}
}
}
@@ -287,17 +281,4 @@ mod tests {
p = serde_json::from_value(saved).unwrap();
assert_eq!(p, PrintSettings::default());
}
#[test]
fn first_page_number_is_saved_only_when_set() {
// Automatic writes nothing, so a JSON workbook without a first page number is unchanged and
// one saved before the field existed loads as Automatic.
let saved = serde_json::to_value(PrintSettings::default()).unwrap();
assert!(saved.get("first_page_number").is_none(), "{saved}");
assert_eq!(serde_json::from_value::<PrintSettings>(saved).unwrap().first_page_number, None);
let p = PrintSettings { first_page_number: Some(7), ..Default::default() };
let saved = serde_json::to_value(&p).unwrap();
assert_eq!(saved["first_page_number"], 7);
assert_eq!(serde_json::from_value::<PrintSettings>(saved).unwrap(), p);
}
}
-38
View File
@@ -290,44 +290,6 @@ impl CellStore {
let moved = self.take_rows(0..=u32::MAX, from..=u32::MAX);
self.put_rows(moved.into_iter().map(|(row, cols)| (row, shift_keys(cols, delta))));
}
/// Deletes the rows in `spans` (`(first, count)`, ascending and disjoint) and closes the gaps
/// in one pass: each later cell moves up once by the number of deleted rows above it.
pub fn delete_rows(&mut self, spans: &[(u32, u32)]) {
self.delete_lines(spans, true);
}
/// Column form of [`CellStore::delete_rows`].
pub fn delete_cols(&mut self, spans: &[(u32, u32)]) {
self.delete_lines(spans, false);
}
fn delete_lines(&mut self, spans: &[(u32, u32)], rows: bool) {
let Some(&(first, _)) = spans.first() else { return };
// Lines deleted before the end of each span, for mapping a kept line to its new place.
let mut before = Vec::with_capacity(spans.len());
let mut total = 0u32;
for &(_, count) in spans {
total = total.saturating_add(count);
before.push(total);
}
let map = |v: u32| -> Option<u32> {
let i = spans.partition_point(|&(at, _)| at <= v);
let Some(i) = i.checked_sub(1) else { return Some(v) };
let (at, count) = spans.get(i).copied().unwrap_or_default();
if v - at < count { None } else { Some(v - before.get(i).copied().unwrap_or_default()) }
};
let keys: Vec<CellRef> = if rows {
let r = RangeRef::new(CellRef::new(first, 0), CellRef::new(gridcraft_core::MAX_ROWS - 1, gridcraft_core::MAX_COLS - 1));
self.iter_range(r).map(|(c, _)| c).collect()
} else {
self.iter().filter(|(c, _)| c.col >= first).map(|(c, _)| c).collect()
};
let moved: Vec<(CellRef, Cell)> = keys.into_iter().filter_map(|c| self.remove(c).map(|cell| (c, cell))).collect();
for (c, cell) in moved {
let to = if rows { map(c.row).map(|r| CellRef::new(r, c.col)) } else { map(c.col).map(|x| CellRef::new(c.row, x)) };
if let Some(to) = to {
self.set(to, cell);
}
}
}
/// Shifts cells within rows `r0..=r1` and columns `>= from` horizontally (Insert/Delete Cells
/// with shift right/left).
pub fn shift_cols_in_rows(&mut self, r0: u32, r1: u32, from: u32, delta: i64) {
+12 -40
View File
@@ -293,22 +293,23 @@ impl NumberFormat {
}
/// Formats a number. The flag is true when the value cannot be shown (date out of range).
/// With `full`, General is not narrowed to the cell width but written by [`general_full`].
fn format_number(&self, n: f64, sys: DateSystem, full: bool) -> (Formatted, bool) {
let general_text = |n: f64, width: usize| if full { Some(general_full(n)) } else { format_general_fit(n, width) };
let general =
|n: f64| Formatted { text: general_text(n, GENERAL_WIDTH).unwrap_or_else(|| OVERFLOW.into()), color: None, fill: None, numeric: true };
fn format_number(&self, n: f64, sys: DateSystem) -> (Formatted, bool) {
let general = |n: f64| Formatted {
text: format_general_fit(n, GENERAL_WIDTH).unwrap_or_else(|| OVERFLOW.into()),
color: None,
fill: None,
numeric: true,
};
if self.is_general() {
return (general(n), false);
}
let Some((sec, drop_sign)) = self.select(n) else { return (general(n), false) };
let minus = n < 0.0 && !drop_sign;
let out: Option<Out> = match sec.kind {
SecKind::Text => Some(render::render_text(sec, &general_text(n, GENERAL_WIDTH).unwrap_or_default())),
SecKind::Text => Some(render::render_text(sec, &format_general_fit(n, GENERAL_WIDTH).unwrap_or_default())),
SecKind::General => {
let width = if minus { GENERAL_WIDTH - 1 } else { GENERAL_WIDTH };
let text = general_text(n.abs(), width).unwrap_or_else(|| "#".repeat(width.clamp(1, 11)));
Some(render::render_general(sec, &text))
Some(render::render_general(sec, n.abs(), width))
}
SecKind::Date => {
if minus {
@@ -404,45 +405,16 @@ impl NumberFormat {
/// Formats a cell value for display.
pub fn format_value(v: &Value, fmt: &NumberFormat, sys: DateSystem) -> Formatted {
format_value_with(v, fmt, sys, false)
}
/// Formats a cell value as Save As CSV/Text writes it: like [`format_value`], except that a number
/// shown as General (a General or Text section, with or without colour and literals) is not
/// narrowed to the cell width but written by `general_full`: `124412140710`, not `1.24412E+11`.
/// Excel writes the cell display here; GridCraft keeps the digits.
pub fn format_value_full(v: &Value, fmt: &NumberFormat, sys: DateSystem) -> Formatted {
format_value_with(v, fmt, sys, true)
}
/// General for Save As CSV/Text: the text `&` gives (15 significant digits), but never with an
/// exponent, because reopening the file would give the cell a scientific format that rounds it
/// on the next save. Where `&` writes an exponent, a number of 1 or more is written as the
/// shortest digits that read back as the same value (every integer f64 holds below 1e16 exactly,
/// so 16-digit card numbers survive), and a smaller one as its 15 significant digits in full.
fn general_full(n: f64) -> String {
let text = gridcraft_core::number_to_text(n);
if !text.contains('E') {
text
} else if n.abs() >= 1.0 {
format!("{n}")
} else {
let mag: i32 = format!("{n:.14e}").split_once('e').and_then(|(_, e)| e.parse().ok()).unwrap_or(0);
gridcraft_core::value::trim_decimal(&format!("{:.*}", (14 - mag).max(0) as usize, n))
}
}
fn format_value_with(v: &Value, fmt: &NumberFormat, sys: DateSystem, full: bool) -> Formatted {
match v {
Value::Empty => Formatted::default(),
Value::Number(n) if !n.is_finite() => Formatted { text: CellError::Num.as_str().into(), ..Formatted::default() },
Value::Number(n) => fmt.format_number(*n, sys, full).0,
Value::Number(n) => fmt.format_number(*n, sys).0,
Value::Text(t) => fmt.format_text(t),
Value::Bool(b) => Formatted { text: if *b { "TRUE" } else { "FALSE" }.into(), ..Formatted::default() },
Value::Error(e) => Formatted { text: e.as_str().into(), ..Formatted::default() },
Value::Array(a) => match a.data.first() {
Some(Value::Array(_)) | None => Formatted::default(),
Some(first) => format_value_with(first, fmt, sys, full),
Some(first) => format_value(first, fmt, sys),
},
}
}
@@ -553,7 +525,7 @@ pub fn text_function(v: &Value, code: &str, sys: DateSystem) -> Result<String, C
if !n.is_finite() {
return Err(CellError::Num);
}
let (f, overflow) = fmt.format_number(n, sys, false);
let (f, overflow) = fmt.format_number(n, sys);
if overflow { Err(CellError::Value) } else { Ok(f.text) }
}
+4 -5
View File
@@ -6,7 +6,7 @@ use gridcraft_core::DateSystem;
use gridcraft_core::date::{datetime_from_serial, max_serial};
use crate::calendar::Calendar;
use crate::decimal::{decimal_digits, fixed, fixed_from_digits};
use crate::decimal::{decimal_digits, fixed, fixed_from_digits, format_general_fit};
use crate::parse::{DatePart, Section, Tok};
/// Text being built plus the first repeat-fill position.
@@ -81,13 +81,12 @@ pub(crate) fn render_text_within(sec: &Section, text: &str, max_units: usize) ->
Some(out)
}
/// Renders a number through a General section: `general` (the number already written as General)
/// with the section's literals around it.
pub(crate) fn render_general(sec: &Section, general: &str) -> Out {
/// Renders a number through a General section (literals around the General keyword).
pub(crate) fn render_general(sec: &Section, v: f64, width: usize) -> Out {
let mut out = Out::default();
for t in &sec.toks {
match t {
Tok::General => out.push(general),
Tok::General => out.push(&format_general_fit(v, width).unwrap_or_else(|| "#".repeat(width.clamp(1, 11)))),
Tok::Fill(c) => out.fill(*c),
other => out.push_tok(other),
}
+1 -1
View File
@@ -668,7 +668,7 @@ fn text_uncached(v: &Value, code: &str, sys: DateSystem) -> Result<String, CellE
if !n.is_finite() {
return Err(CellError::Num);
}
let (f, overflow) = fmt.format_number(n, sys, false);
let (f, overflow) = fmt.format_number(n, sys);
if overflow { Err(CellError::Value) } else { Ok(f.text) }
}
+1 -10
View File
@@ -3,19 +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-pdf.workspace = true
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 -1
View File
@@ -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
-88
View File
@@ -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)
}
-666
View File
@@ -1,666 +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, n, needs_cid, pdf_string, pdf_utf16_string};
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 { &REGULAR };
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 craft_pdf::classic::Writer) -> Result<String, Error> {
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);
out.stream(*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");
out.stream(cmap_id, "", cmap.as_bytes())?;
out.object(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);
}
Ok(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)));
}
}
+150 -216
View File
@@ -1,74 +1,24 @@
//! PDF 1.7 drawing for GridCraft print/export, with shared object and xref framing.
//! A tiny, self-contained PDF 1.7 writer for GridCraft's print and PDF export.
//!
//! - The 14 standard fonts (no embedding) with WinAnsiEncoding, plus approximate width tables
//! ([`text_width`]) so callers can measure, align and wrap text. Characters outside
//! 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 or serialize its object envelope.
#[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 {}
impl From<craft_pdf::classic::Error> for Error {
fn from(error: craft_pdf::classic::Error) -> Self {
Self(error.to_string())
}
}
use std::collections::HashMap;
use std::collections::hash_map::DefaultHasher;
use std::fmt::Write as _;
@@ -90,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 {
@@ -259,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
}
@@ -522,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
@@ -785,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
@@ -985,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.
@@ -1007,6 +892,49 @@ fn pdf_text_string(text: &str) -> String {
s
}
/// Starts object `id` at the current end of `out` and records its offset for the xref table.
fn begin_obj(out: &mut Vec<u8>, offsets: &mut Vec<usize>, id: u32) {
let i = id as usize;
if offsets.len() <= i {
offsets.resize(i + 1, 0);
}
if let Some(slot) = offsets.get_mut(i) {
*slot = out.len();
}
let _ = writeln!(Utf8(out), "{id} 0 obj");
}
/// Writes `id 0 obj <body> endobj`.
fn dict_obj(out: &mut Vec<u8>, offsets: &mut Vec<usize>, id: u32, body: &str) {
begin_obj(out, offsets, id);
out.extend_from_slice(body.as_bytes());
out.extend_from_slice(b"\nendobj\n");
}
/// Writes a stream object: `dict` (the dictionary entries without `<<`, `>>` and `/Length`, may be
/// empty) and `data` as the stream body.
fn stream_obj(out: &mut Vec<u8>, offsets: &mut Vec<usize>, id: u32, dict: &str, data: &[u8]) {
begin_obj(out, offsets, id);
out.extend_from_slice(b"<<");
if !dict.is_empty() {
out.push(b' ');
out.extend_from_slice(dict.as_bytes());
}
let _ = write!(Utf8(out), " /Length {} >>\nstream\n", data.len());
out.extend_from_slice(data);
out.extend_from_slice(b"\nendstream\nendobj\n");
}
/// Lets `write!` append text to a byte buffer.
struct Utf8<'a>(&'a mut Vec<u8>);
impl std::fmt::Write for Utf8<'_> {
fn write_str(&mut self, s: &str) -> std::fmt::Result {
self.0.extend_from_slice(s.as_bytes());
Ok(())
}
}
impl PdfDoc {
pub fn new() -> PdfDoc {
PdfDoc::default()
@@ -1029,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]
@@ -1046,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
@@ -1059,13 +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, text exceeds a size limit, or the
/// shared envelope writer refuses object counts, offsets or an allocation.
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);
}
@@ -1095,7 +1008,9 @@ impl PdfDoc {
let contents: Vec<String> = self.pages.iter_mut().map(|p| std::mem::take(&mut p.content)).collect();
let page_links: Vec<Vec<LinkAnnotation>> = self.pages.iter_mut().map(|p| std::mem::take(&mut p.links)).collect();
let reserve = contents.iter().fold(4096usize, |acc, c| acc.saturating_add(c.len()).saturating_add(1024));
let mut out = craft_pdf::classic::Writer::with_capacity(reserve)?;
let mut out: Vec<u8> = Vec::with_capacity(reserve);
out.extend_from_slice(b"%PDF-1.7\n%\xE2\xE3\xCF\xD3\n");
let mut offsets: Vec<usize> = vec![0; 4];
let mut kids = Vec::new();
let mut annotations = Vec::new();
let page_count = self.pages.len();
@@ -1105,35 +1020,41 @@ impl PdfDoc {
let _ = write!(font_dict, "/F{} {} 0 R ", i + 1, id);
if i == CID_FONT {
let (cid_id, desc_id) = (id + 1, id + 2);
out.object(
dict_obj(
&mut out,
&mut offsets,
*id,
&format!(
"<< /Type /Font /Subtype /Type0 /BaseFont /{CID_BASE_FONT} /Encoding /UniGB-UTF16-H /DescendantFonts [{cid_id} 0 R] >>"
),
)?;
out.object(cid_id,
);
dict_obj(
&mut out,
&mut offsets,
cid_id,
&format!(
"<< /Type /Font /Subtype /CIDFontType0 /BaseFont /{CID_BASE_FONT} /CIDSystemInfo << /Registry (Adobe) /Ordering (GB1) /Supplement 4 >> /FontDescriptor {desc_id} 0 R /DW {CID_WIDTH} >>"
),
)?;
out.object(desc_id,
);
dict_obj(
&mut out,
&mut offsets,
desc_id,
&format!(
"<< /Type /FontDescriptor /FontName /{CID_BASE_FONT} /Flags 6 /FontBBox [-25 -254 1000 880] /ItalicAngle 0 /Ascent 880 /Descent -120 /CapHeight 880 /StemV 93 >>"
),
)?;
);
continue;
}
let name = Font::ALL.get(i).copied().unwrap_or_default().base_name();
let enc = if name.starts_with("Symbol") { "" } else { " /Encoding /WinAnsiEncoding" };
out.object(*id, &format!("<< /Type /Font /Subtype /Type1 /BaseFont /{name}{enc} >>"))?;
dict_obj(&mut out, &mut offsets, *id, &format!("<< /Type /Font /Subtype /Type1 /BaseFont /{name}{enc} >>"));
}
}
// Images already written, by content hash: (page, image, object id). A hash match is
// 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)?;
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| {
@@ -1158,13 +1079,13 @@ impl PdfDoc {
let _ = write!(dict, " /SMask {id} 0 R");
}
dict.push_str(" /Filter /RunLengthDecode");
out.stream(img_id, &dict, &run_length(&img.rgb))?;
stream_obj(&mut out, &mut offsets, img_id, &dict, &run_length(&img.rgb));
if let (Some(id), Some(a)) = (smask_id, &img.alpha) {
let dict = format!(
"/Type /XObject /Subtype /Image /Width {} /Height {} /ColorSpace /DeviceGray /BitsPerComponent 8 /Filter /RunLengthDecode",
img.width, img.height
);
out.stream(id, &dict, &run_length(a))?;
stream_obj(&mut out, &mut offsets, id, &dict, &run_length(a));
}
written.entry(img.hash).or_default().push((pi, k, img_id));
img_id
@@ -1175,7 +1096,7 @@ impl PdfDoc {
let content_id = next;
let page_id = next + 1;
next += 2;
out.stream(content_id, "", content.as_bytes())?;
stream_obj(&mut out, &mut offsets, content_id, "", content.as_bytes());
drop(content);
let xo = if xobjects.is_empty() { String::new() } else { format!(" /XObject << {xobjects}>>") };
let mut link_refs = String::new();
@@ -1189,18 +1110,20 @@ impl PdfDoc {
annotations.push((id, link));
}
let annots = if link_refs.is_empty() { String::new() } else { format!(" /Annots [{link_refs}]") };
out.object(
dict_obj(
&mut out,
&mut offsets,
page_id,
&format!(
"<< /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
),
)?;
);
kids.push(page_id);
}
for (id, link) in annotations {
@@ -1213,11 +1136,16 @@ impl PdfDoc {
format!("/Dest [{page_id} 0 R /XYZ {} {} null]", n(x), n(height - y))
}
};
out.object(id, &format!("<< /Type /Annot /Subtype /Link /Rect [{} {} {} {}] /Border [0 0 0] {action} >>", n(x0), n(y0), n(x1), n(y1)))?;
dict_obj(
&mut out,
&mut offsets,
id,
&format!("<< /Type /Annot /Subtype /Link /Rect [{} {} {} {}] /Border [0 0 0] {action} >>", n(x0), n(y0), n(x1), n(y1)),
);
}
out.object(1, "<< /Type /Catalog /Pages 2 0 R >>")?;
dict_obj(&mut out, &mut offsets, 1, "<< /Type /Catalog /Pages 2 0 R >>");
let kids_s: Vec<String> = kids.iter().map(|k| format!("{k} 0 R")).collect();
out.object(2, &format!("<< /Type /Pages /Kids [{}] /Count {} >>", kids_s.join(" "), kids.len()))?;
dict_obj(&mut out, &mut offsets, 2, &format!("<< /Type /Pages /Kids [{}] /Count {} >>", kids_s.join(" "), kids.len()));
let creator = if self.info.creator.is_empty() { "GridCraft" } else { &self.info.creator };
let mut info = format!("<< /Producer {} /Creator {}", pdf_text_string("GridCraft PDF"), pdf_text_string(creator));
if !self.info.title.is_empty() {
@@ -1227,9 +1155,15 @@ impl PdfDoc {
let _ = write!(info, " /Author {}", pdf_text_string(&self.info.author));
}
info.push_str(" >>");
out.object(3, &info)?;
dict_obj(&mut out, &mut offsets, 3, &info);
out.finish(1, Some(3)).map_err(Error::from)
let xref = out.len();
let _ = write!(Utf8(&mut out), "xref\n0 {}\n0000000000 65535 f \n", next);
for off in offsets.iter().skip(1) {
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);
out
}
}
+25 -363
View File
@@ -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,287 +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);
let mut objects = craft_pdf::classic::Writer::with_capacity(0).unwrap();
let mut next = 4;
assert!(page.arabic.write_objects(&mut next, &mut objects).unwrap().is_empty());
assert_eq!(next, 4, "Latin-only RTL text must not allocate Arabic font objects");
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");
@@ -1211,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]);
}
+1 -44
View File
@@ -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]
-25
View File
@@ -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();
-3
View File
@@ -26,9 +26,6 @@ impl SheetApp {
if matches!(id, "file.save" | "file.saveAs" | "file.saveBytes") {
self.store_view_state();
}
if let Some(refused) = dialogs::refuse_sheet_change(self, id) {
return Err(refused);
}
if matches!(
id,
"sheet.activate"
+1 -23
View File
@@ -455,7 +455,7 @@ pub fn open_format(app: &SheetApp, params: &Json) -> Option<Dialog> {
"print": c.print,
"locked": c.locked,
});
let title = if text_only { "Edit Text".to_string() } else { app.ui.language.tr_fill("Format Control: {name}", &[("name", &c.display_name())]) };
let title = if text_only { "Edit Text".to_string() } else { format!("Format Control: {}", c.display_name()) };
Some(Dialog::custom("formatControl", &title, v))
}
@@ -567,25 +567,3 @@ pub fn format_dialog(app: &mut SheetApp, ui: &mut Ui, d: &mut Dialog, open: &mut
}
}
}
#[cfg(test)]
mod format_title_tests {
use super::*;
use crate::i18n::Language;
use gridcraft_engine::Session;
#[test]
fn the_format_control_title_follows_the_interface_language() {
let mut session = Session::new();
session.new_workbook();
let mut app = SheetApp::new(session, Default::default());
let v = app.run("insert.button", json!({"at": "B2", "text": "Go"})).unwrap();
let id = v["control"].as_u64().unwrap();
let name = control(&app, id as u32).unwrap().display_name();
assert_eq!(open_format(&app, &json!({"id": id})).unwrap().title, format!("Format Control: {name}"));
app.ui.language = Language::It;
let want = Language::It.tr("Format Control: {name}").replace("{name}", &name);
assert_eq!(open_format(&app, &json!({"id": id})).unwrap().title, want);
assert!(!want.starts_with("Format Control"));
}
}
+7 -57
View File
@@ -26,7 +26,6 @@ mod names;
mod paste;
mod ref_edit;
mod show;
mod sort_dialog;
mod spelling;
mod zoom;
@@ -39,7 +38,6 @@ use names::pasteable_names;
pub(crate) use ref_edit::SHEET_DELETED;
pub(crate) use show::build_params;
pub use show::show;
pub(crate) use sort_dialog::{grid_sense, refuse_sheet_change};
use zoom::zoom_preset;
/// A form field. `Ref` is a range reference that can also be picked by selecting on the grid
@@ -66,8 +64,6 @@ pub struct Dialog {
pub tab: String,
pub search: String,
pub list_index: usize,
/// Custom Sort's own state: the selection to restore and the column choices.
sort: sort_dialog::State,
pub result: Option<Json>,
/// "Show password" is ticked: password fields show their text.
pub show_password: bool,
@@ -237,7 +233,6 @@ impl Dialog {
tab: String::new(),
search: String::new(),
list_index: 0,
sort: Default::default(),
result: None,
show_password: false,
focus_first_field: true,
@@ -263,7 +258,6 @@ impl Dialog {
tab: String::new(),
search: String::new(),
list_index: 0,
sort: Default::default(),
result: None,
show_password: false,
focus_first_field: false,
@@ -365,7 +359,7 @@ impl Dialog {
vec![
Number { key: "to", label: "Before sheet (position, 0 = first):" },
Check { key: "copy", label: "Create a copy" },
Note(app.ui.language.tr_fill("Sheets: {sheets}", &[("sheets", &sheets.join(", "))])),
Note(format!("Sheets: {}", sheets.join(", "))),
],
json!({"to": 0, "copy": false}),
);
@@ -482,10 +476,7 @@ impl Dialog {
"unhideSheet",
"Unhide",
"sheet.unhide",
vec![
Text { key: "sheet", label: "Unhide sheet:" },
Note(app.ui.language.tr_fill("Hidden: {sheets}", &[("sheets", &opts.join(", "))])),
],
vec![Text { key: "sheet", label: "Unhide sheet:" }, Note(format!("Hidden: {}", opts.join(", ")))],
json!({"sheet": first}),
);
d.values.insert("sheet".into(), json!(first));
@@ -995,7 +986,11 @@ impl Dialog {
}],
json!({"kind": "blanks"}),
),
"sort" => sort_dialog::open(app, &params)?,
"sort" => {
// Seed "Sort by" from the column the user is actually in (#1906).
let col = app.session.active().map(|d| gridcraft_engine::core::col_to_letters(d.selection.active.col)).unwrap_or_else(|| "A".into());
Dialog::custom("sort", "Sort", json!({"header": true, "levels": [{"column": col, "order": "asc"}]}))
}
"nameManager" => Dialog::custom("nameManager", "Name Manager", json!({})),
"pasteName" => {
// F3 opens it only when the workbook has names to paste, as in Excel.
@@ -1145,51 +1140,6 @@ impl Dialog {
mod tests {
use super::*;
/// The text of the dialog's note.
fn note(d: &Dialog) -> String {
d.fields.iter().find_map(|f| if let Field::Note(text) = f { Some(text.clone()) } else { None }).unwrap_or_default()
}
#[test]
fn sheet_notes_follow_the_interface_language() {
use crate::i18n::Language;
let mut session = gridcraft_engine::Session::default();
session.new_workbook();
let mut app = SheetApp::new(session, Default::default());
app.run("home.insertSheet", json!({})).unwrap();
let unhide = json!({"sheets": ["Sheet2"]});
assert_eq!(note(&Dialog::open(&mut app, "moveSheet", json!({})).unwrap()), "Sheets: Sheet1, Sheet2");
assert_eq!(note(&Dialog::open(&mut app, "unhideSheet", unhide.clone()).unwrap()), "Hidden: Sheet2");
let it = Language::It;
app.ui.language = it;
let moved = note(&Dialog::open(&mut app, "moveSheet", json!({})).unwrap());
assert_eq!(moved, it.tr("Sheets: {sheets}").replace("{sheets}", "Sheet1, Sheet2"));
assert!(!moved.starts_with("Sheets"));
let hidden = note(&Dialog::open(&mut app, "unhideSheet", unhide).unwrap());
assert_eq!(hidden, it.tr("Hidden: {sheets}").replace("{sheets}", "Sheet2"));
assert!(!hidden.starts_with("Hidden"));
}
#[test]
fn goal_seek_success_toast_follows_the_interface_language() {
use crate::i18n::Language;
let mut session = gridcraft_engine::Session::default();
session.new_workbook();
let mut app = SheetApp::new(session, Default::default());
app.run("cell.set", json!({"cell": "B1", "input": "=A1*2"})).unwrap();
let it = Language::It;
app.ui.language = it;
let mut d = Dialog::custom("goalSeek", "Goal Seek", json!({"set": "B1", "to": "10", "changing": "A1"}));
let ctx = egui::Context::default();
let mut out = ctx.run_ui(egui::RawInput::default(), |ui| analysis::goal_seek(&mut app, ui, &mut d, &mut true, &mut true));
out.textures_delta.clear();
assert_eq!(app.message, None);
// The value is shown as before (the JSON number the command returns).
let want = it.tr("Goal Seeking found a solution: {value}").replace("{value}", "5.0");
assert_eq!(app.toast.map(|t| t.0), Some(want.clone()));
assert!(!want.starts_with("Goal Seeking"));
}
#[test]
fn remove_duplicates_prefills_the_selection_and_submits_the_edited_range() {
let mut session = gridcraft_engine::Session::default();
+1 -4
View File
@@ -34,10 +34,7 @@ pub(super) fn goal_seek(app: &mut SheetApp, ui: &mut egui::Ui, d: &mut Dialog, c
}
if *confirm {
match app.run("data.goalSeek", json!({"set": set, "to": to.parse::<f64>().unwrap_or(0.0), "changing": changing})) {
Ok(r) => {
let text = app.ui.language.tr_fill("Goal Seeking found a solution: {value}", &[("value", &r["value"].to_string())]);
app.toast = Some((text, crate::now_ms()));
}
Ok(r) => app.toast = Some((format!("Goal Seeking found a solution: {}", r["value"]), crate::now_ms())),
Err(e) => app.message = Some(("Goal Seek".into(), crate::clean_error(&e))),
}
}
+104 -3
View File
@@ -1,7 +1,7 @@
#[cfg(test)]
use super::show::build_params;
use super::show::{form_fields, ok_cancel};
use super::{Dialog, Field, Json, SheetApp, json, vec2};
use super::{Dialog, Field, Icon, Json, SheetApp, json, vec2};
/// Initial values of the Data Validation form: the rule stored on the active cell, so OK without
/// edits keeps it; a plain list rule when the cell has none.
@@ -180,8 +180,109 @@ pub(super) fn advanced_filter_form(app: &SheetApp, ui: &mut egui::Ui, d: &mut Di
ui.allocate_ui(vec2(ui.available_width(), ui.spacing().interact_size.y + 8.0), |ui| ok_cancel(ui, confirm, open));
}
// Custom Sort lives in its own module; `show` reaches it from here.
pub(super) use super::sort_dialog::sort;
/// Draws the sort-level editor: header toggle, column/by/order controls, add/remove level, and `data.sort` on confirmation.
pub(super) fn sort(app: &mut SheetApp, ui: &mut egui::Ui, d: &mut Dialog, confirm: &mut bool) {
let lang = app.ui.language;
let mut header = d.values.get("header").and_then(Json::as_bool).unwrap_or(true);
ui.checkbox(&mut header, "My list has headers");
d.values.insert("header".into(), json!(header));
let mut levels: Vec<Json> = d.values.get("levels").and_then(Json::as_array).cloned().unwrap_or_default();
// Columns of the region around the active cell, labelled with their header (or first value).
let columns: Vec<(String, String)> = app
.session
.active()
.and_then(|d| {
let sh = d.wb.active()?;
let region = gridcraft_engine::selection::current_region(sh, d.selection.active);
Some(
(region.start.col..=region.end.col)
.map(|c| {
let letter = gridcraft_engine::core::col_to_letters(c);
// The region starts at the header row when one is present, so the
// label always comes from start.row: header text with headers on,
// first data value with them off.
let label_row = region.start.row;
let text = gridcraft_engine::display::cell_text(&d.wb, sh, gridcraft_engine::core::CellRef::new(label_row, c));
let text: String = text.chars().take(24).collect();
(letter.clone(), if text.is_empty() { letter } else { format!("{letter}: {text}") })
})
.collect(),
)
})
.unwrap_or_default();
let mut remove = None;
for (i, lv) in levels.iter_mut().enumerate() {
ui.horizontal(|ui| {
let label = ui.label(lang.tr(if i == 0 { "Sort by" } else { "Then by" }));
let mut col = lv["column"].as_str().unwrap_or("A").to_string();
if columns.is_empty() {
ui.add(egui::TextEdit::singleline(&mut col).desired_width(50.0)).labelled_by(label.id);
} else {
// The closed box shows the same "B: Revenue" label as the list, not the bare letter (#3446).
let shown =
columns.iter().find(|(letter, _)| letter.eq_ignore_ascii_case(&col)).map_or_else(|| col.clone(), |(_, label)| label.clone());
craft_ui::ComboBox::from_id_salt(("sort_col", i))
.selected_text(shown)
.show_ui(ui, |ui| {
for (letter, label) in &columns {
ui.selectable_value(&mut col, letter.clone(), label.as_str());
}
})
.response
.labelled_by(label.id);
}
lv["column"] = json!(col.to_ascii_uppercase());
let mut by = lv["by"].as_str().unwrap_or("values").to_string();
craft_ui::ComboBox::from_id_salt(("by", i))
.selected_text(match by.as_str() {
"cellColor" => "Cell Color",
"fontColor" => "Font Color",
_ => "Cell Values",
})
.show_ui(ui, |ui| {
ui.selectable_value(&mut by, "values".into(), "Cell Values");
ui.selectable_value(&mut by, "cellColor".into(), "Cell Color");
ui.selectable_value(&mut by, "fontColor".into(), "Font Color");
})
.response
.accessible_name(lang.tr("Sort On"));
lv["by"] = json!(by);
let mut desc = lv["order"].as_str() == Some("desc");
ui.radio_value(&mut desc, false, "A to Z");
ui.radio_value(&mut desc, true, "Z to A");
lv["order"] = json!(if desc { "desc" } else { "asc" });
if crate::widgets::icon_button(ui, Icon::Close, crate::theme::Tokens::get(ui.ctx()).text_dim, "Remove level", vec2(18.0, 18.0)).clicked()
{
remove = Some(i);
}
});
}
if let Some(i) = remove
&& levels.len() > 1
{
levels.remove(i);
}
if ui.button("+ Add Level").clicked() {
let used: Vec<String> = levels.iter().filter_map(|l| l.get("column").and_then(Json::as_str).map(str::to_string)).collect();
let next = columns
.iter()
.map(|(l, _)| l)
.find(|l| !used.contains(l))
.cloned()
.or_else(|| columns.last().map(|(l, _)| l.clone()))
.unwrap_or_else(|| "B".into());
levels.push(json!({"column": next, "order": "asc"}));
}
d.values.insert("levels".into(), Json::Array(levels.clone()));
let mut open = true;
ok_cancel(ui, confirm, &mut open);
if *confirm {
app.run_or_alert("data.sort", json!({"header": header, "keys": levels}));
}
if !open {
*confirm = true;
}
}
#[cfg(test)]
mod data_validation_tests {
-2
View File
@@ -326,8 +326,6 @@ fn active_sheet_name(app: &SheetApp) -> String {
/// dialog about to run its command must not, since references without a sheet name would be
/// read against the sheet still shown.
pub(super) fn end_pick(app: &mut SheetApp, d: &mut Dialog) -> Result<(), String> {
// Custom Sort puts back the selection it changed whenever it lets go of the grid.
super::sort_dialog::restore_selection(app, d);
d.refs.target = None;
d.refs.collapsed = None;
let Some(home) = d.refs.home.as_mut() else { return Ok(()) };
-1
View File
@@ -174,7 +174,6 @@ pub fn show(app: &mut SheetApp, ctx: &egui::Context) {
"advancedFilter" => window.default_height(0.0),
_ => window,
};
let window = super::sort_dialog::window(window, &d.name, ctx, app.ui.language);
let (window, collapsed) = place_window(app, ctx, &mut d, window, window_id);
let shown = window.show(ctx, |ui| {
if let Some(key) = &collapsed {
-416
View File
@@ -1,416 +0,0 @@
//! Custom Sort (Data › Sort): sort levels with column, sort-on and order pickers.
//!
//! The dialog restores the grid selection it changed when it lets go of the grid (see
//! [`restore_selection`], called from `ref_edit::end_pick`) and keeps the worksheet it opened on.
use gridcraft_engine::Selection;
use gridcraft_engine::core::{CellRef, RangeRef, Value, col_to_letters};
use super::show::ok_cancel;
use super::{Dialog, Json, Sense, SheetApp, json, vec2};
use crate::i18n::Language;
use crate::icons::Icon;
use crate::theme::Tokens;
/// Commands that change which worksheet is shown or which worksheets exist: refused while Sort is
/// open, so Sort always acts on the worksheet it opened on.
const SHEET_COMMANDS: [&str; 8] =
["sheet.activate", "sheet.next", "sheet.previous", "sheet.move", "sheet.hide", "sheet.unhide", "home.insertSheet", "home.deleteSheet"];
/// What the dialog keeps besides its field values.
#[derive(Clone, Debug, Default)]
pub(super) struct State {
/// The exact selection to restore when Sort closes, including ranges and the shift anchor.
restore: Option<Selection>,
/// The workbook and worksheet Sort opened on, by identity: the only one it may sort. A sheet's
/// position changes when sheets are inserted, deleted, moved or undone, its [`SheetUid`] does not.
home: Option<(u64, u64)>,
choices: Option<ChoicesCache>,
}
/// The column choices for one sheet revision, range, header setting and language.
#[derive(Clone, Debug)]
struct ChoicesCache {
language: Language,
doc_uid: Option<u64>,
sheet_index: Option<usize>,
revision: Option<u64>,
range: Option<String>,
header: bool,
choices: Vec<Choice>,
}
/// A column of the sorted range: its letters, its label and whether its values are numbers.
type Choice = (String, String, bool);
/// Opens Custom Sort on the range, worksheet and header guess of `data.sort`, seeding "Sort by" from the
/// active column (#1906). A request that can't be resolved is reported and opens nothing.
pub(super) fn open(app: &mut SheetApp, params: &Json) -> Option<Dialog> {
let (sheet, range, header) = match gridcraft_engine::cmd::data::sort_context(&app.session, params) {
Ok(context) => context,
Err(e) => {
app.message = Some(("Sort".into(), crate::clean_error(&e.to_string())));
return None;
}
};
// Sort works on the worksheet shown, so a request for another one shows it first.
if app.session.active().is_some_and(|doc| doc.wb.active_sheet() != sheet)
&& let Err(e) = app.run("sheet.activate", json!({"sheet": sheet}))
{
app.message = Some(("Sort".into(), crate::clean_error(&e)));
return None;
}
// An open filter menu would take the Enter that confirms Sort (and apply its filter).
app.grid.filter_menu = None;
let restore = app.session.active().map(|doc| doc.selection.clone());
let home = sheet_key(app);
let active_col = app.session.active().map(|doc| doc.selection.active.col);
let first = col_to_letters(active_col.filter(|c| (range.start.col..=range.end.col).contains(c)).unwrap_or(range.start.col));
if header && range.height() > 1 {
let _ = app.run("selection.set", json!({"range": body_of(range).a1()}));
}
let mut d = Dialog::custom("sort", "Sort", json!({"header": header, "range": range.a1(), "levels": [{"column": first, "order": "asc"}]}));
d.sort.restore = restore;
d.sort.home = home;
Some(d)
}
/// `r` without its header row.
fn body_of(r: RangeRef) -> RangeRef {
RangeRef::new(CellRef::new(r.start.row.saturating_add(1), r.start.col), r.end)
}
/// The active workbook and worksheet by identity (document uid, [`SheetUid`]).
///
/// [`SheetUid`]: gridcraft_engine::model::SheetUid
fn sheet_key(app: &SheetApp) -> Option<(u64, u64)> {
let doc = app.session.active()?;
Some((doc.uid, doc.wb.active()?.uid.get()))
}
/// Puts back the selection from before Sort opened (once) on the worksheet it opened on: the
/// selection shown while that sheet is active, else the one the sheet keeps for when it is shown
/// again. Nothing is restored once that sheet is gone. Runs whenever a dialog lets go of the grid.
pub(super) fn restore_selection(app: &mut SheetApp, d: &mut Dialog) {
let Some((doc_uid, sheet_uid)) = d.sort.home.filter(|_| d.name == "sort") else { return };
let Some(doc) = app.session.active_mut().filter(|doc| doc.uid == doc_uid) else { return };
let Some(index) = doc.wb.sheets.iter().position(|s| s.uid.get() == sheet_uid) else { return };
let Some(selection) = d.sort.restore.take() else { return };
if index == doc.wb.active_sheet() {
doc.selection = selection;
} else {
if doc.sheet_selections.len() < doc.wb.sheets.len() {
doc.sheet_selections.resize(doc.wb.sheets.len(), Selection::default());
}
if let Some(slot) = doc.sheet_selections.get_mut(index) {
*slot = selection;
}
}
}
/// The reason `id` is refused while Sort is open, if it is.
pub(crate) fn refuse_sheet_change(app: &SheetApp, id: &str) -> Option<String> {
(app.dialog.as_ref().is_some_and(|d| d.name == "sort") && SHEET_COMMANDS.contains(&id))
.then(|| "Close the Sort dialog before switching or changing worksheets.".into())
}
/// The grid ignores the mouse while Sort is open, so the selection cannot change under the dialog.
pub(crate) fn grid_sense(app: &SheetApp) -> Sense {
if app.dialog.as_ref().is_some_and(|d| d.name == "sort") { Sense::hover() } else { Sense::click_and_drag() }
}
/// Sort moves and resizes. Its minimum width fits the whole toolbar row (the level buttons and the
/// headers checkbox) in the interface language, so a longer translation widens the window instead
/// of overlapping or wrapping the row.
pub(super) fn window<'a>(window: egui::Window<'a>, name: &str, ctx: &egui::Context, lang: Language) -> egui::Window<'a> {
if name != "sort" {
return window;
}
let width = toolbar_width(ctx, lang).max(480.0);
window.resizable(true).min_width(width).min_height(260.0).default_width(width.max(500.0)).default_height(320.0)
}
/// The width of the toolbar row of [`sort`] with its labels on one line, plus the window frame.
fn toolbar_width(ctx: &egui::Context, lang: Language) -> f32 {
let style = ctx.global_style();
let painter = ctx.layer_painter(egui::LayerId::background());
let text = |font: egui::FontId, key: &str| painter.layout_no_wrap(lang.tr(key).to_string(), font, egui::Color32::PLACEHOLDER).size().x;
let button_font = crate::theme::ui_font(12.5);
// Mirrors `small_button_accent`: a 24px icon cell and the label plus 6px.
let buttons: f32 = ["Add Level", "Delete Level", "Copy Level"].iter().map(|key| 24.0 + text(button_font.clone(), key) + 6.0).sum();
let arrows = 2.0 * 24.0;
let spacing = &style.spacing;
let checkbox = spacing.icon_width + spacing.icon_spacing + text(egui::TextStyle::Body.resolve(&style), "My list has headers");
// Five buttons and the checkbox, with the gaps between them, and the window's inner margin.
(buttons + arrows + checkbox + 6.0 * spacing.item_spacing.x + 2.0 * style.spacing.window_margin.left as f32 + 16.0).ceil()
}
/// The label of a column that has no header text: `Column A`, in the interface language.
fn column_label(lang: Language, letters: &str) -> String {
lang.tr("Column {letters}").replace("{letters}", letters)
}
/// The columns of `range` with their labels: header text, or `Column A`, `Column B`… without headers.
fn column_choices(app: &SheetApp, range: Option<RangeRef>, header: bool) -> Vec<Choice> {
let Some(r) = range else { return Vec::new() };
let lang = app.ui.language;
let sh = app.session.active().and_then(|doc| doc.wb.active());
let body_start = r.start.row.saturating_add(u32::from(header));
let cols = r.end.col.saturating_sub(r.start.col).saturating_add(1).max(1) as usize;
// Total sampled cells are bounded across all columns, not per column.
let rows_per_col = (200_000 / cols).max(1);
(r.start.col..=r.end.col)
.map(|c| {
let letters = col_to_letters(c);
let text = match (header, sh) {
(true, Some(sh)) => sh.value(CellRef::new(r.start.row, c)).display().trim().to_string(),
_ => String::new(),
};
let label = if text.is_empty() { column_label(lang, &letters) } else { text };
let numeric =
sh.is_some_and(|sh| values_are_numeric((body_start..=r.end.row).take(rows_per_col).map(|row| sh.value(CellRef::new(row, c)))));
(letters, label, numeric)
})
.collect()
}
/// The column choices, recomputed only when the sheet, range, header setting or language changed.
fn cached_choices(app: &SheetApp, d: &mut Dialog, range: Option<RangeRef>, header: bool) -> Vec<Choice> {
let language = app.ui.language;
let (doc_uid, sheet_index, revision) =
app.session.active().map(|doc| (Some(doc.uid), Some(doc.wb.active_sheet()), Some(doc.revision))).unwrap_or_default();
let range_key = range.map(|r| r.a1());
if let Some(cache) = &d.sort.choices
&& cache.language == language
&& cache.doc_uid == doc_uid
&& cache.sheet_index == sheet_index
&& cache.revision == revision
&& cache.range == range_key
&& cache.header == header
{
return cache.choices.clone();
}
let choices = column_choices(app, range, header);
d.sort.choices = Some(ChoicesCache { language, doc_uid, sheet_index, revision, range: range_key, header, choices: choices.clone() });
choices
}
/// The column a new level starts on: the first column no level uses, and once every column is used
/// the selected level's column (as Copy Level would give), so more levels can always be added.
fn next_level_column(choices: &[Choice], levels: &[Json], selected: usize) -> Option<String> {
let used: Vec<&str> = levels.iter().filter_map(|l| l["column"].as_str()).collect();
choices
.iter()
.map(|(l, _, _)| l.as_str())
.find(|l| !used.contains(l))
.or_else(|| levels.get(selected).and_then(|l| l["column"].as_str()))
.or_else(|| choices.first().map(|(l, _, _)| l.as_str()))
.map(str::to_string)
}
/// Draws the sort-level editor: header toggle, level actions, the level rows and OK/Cancel; OK runs `data.sort`.
pub(super) fn sort(app: &mut SheetApp, ui: &mut egui::Ui, d: &mut Dialog, confirm: &mut bool) {
let mut header = d.values.get("header").and_then(Json::as_bool).unwrap_or(true);
let was_header = header;
let range = d.values.get("range").and_then(Json::as_str).and_then(RangeRef::parse);
let lang = app.ui.language;
let choices = cached_choices(app, d, range, header);
let mut levels: Vec<Json> = d.values.get("levels").and_then(Json::as_array).cloned().unwrap_or_default();
let mut selected = d.list_index.min(levels.len().saturating_sub(1));
let t = Tokens::get(ui.ctx());
ui.horizontal_wrapped(|ui| {
// Levels are not limited by the columns, allow the same column twice (up to 64 levels).
let next_column = next_level_column(&choices, &levels, selected);
if text_icon_button(ui, Icon::Plus, t.accent, "Add Level", levels.len() < 64 && next_column.is_some()).clicked()
&& let Some(next) = next_column
{
levels.push(json!({"column": next, "order": "asc"}));
selected = levels.len() - 1;
}
if text_icon_button(ui, Icon::Close, t.danger, "Delete Level", !levels.is_empty()).clicked() && selected < levels.len() {
levels.remove(selected);
selected = selected.saturating_sub(1);
}
if text_icon_button(ui, Icon::Copy, t.text, "Copy Level", !levels.is_empty() && levels.len() < 64).clicked()
&& let Some(lv) = levels.get(selected).cloned()
{
levels.insert(selected + 1, lv);
selected += 1;
}
if icon_button(ui, Icon::ChevronUp, t.text, "Move Up", selected > 0).clicked() {
levels.swap(selected, selected - 1);
selected -= 1;
}
if icon_button(ui, Icon::Chevron, t.text, "Move Down", selected + 1 < levels.len()).clicked() {
levels.swap(selected, selected + 1);
selected += 1;
}
ui.with_layout(egui::Layout::right_to_left(egui::Align::Center), |ui| {
ui.checkbox(&mut header, lang.tr("My list has headers"));
});
});
d.values.insert("header".into(), json!(header));
if header != was_header
&& let Some(r) = range
{
let shown = if header && r.height() > 1 { body_of(r) } else { r };
let _ = app.run("selection.set", json!({"range": shown.a1()}));
}
ui.add_space(4.0);
let table_height = (ui.available_height() - 48.0).max(60.0);
egui::ScrollArea::vertical().max_height(table_height).min_scrolled_height(table_height).auto_shrink([false, false]).show(ui, |ui| {
levels_table(ui, &mut levels, &mut selected, &choices, lang);
});
d.list_index = selected;
d.values.insert("levels".into(), Json::Array(levels.clone()));
let mut open = true;
ok_cancel(ui, confirm, &mut open);
if *confirm && !levels.is_empty() {
let mut p = json!({"header": header, "keys": levels});
if let Some(r) = d.values.get("range").and_then(Json::as_str) {
p["range"] = json!(r);
}
// The range has no sheet name, so it must not be read against another worksheet.
let failure = if sheet_key(app) != d.sort.home {
Some("Return to the original worksheet to sort, or cancel.".to_string())
} else {
app.run("data.sort", p).err().map(|e| crate::clean_error(&e))
};
if let Some(message) = failure {
app.message = Some((d.title.clone(), message));
*confirm = false;
}
}
if !open {
*confirm = true;
}
}
/// The selectable level rows: "Sort by"/"Then by" with the column, sort-on and order pickers.
fn levels_table(ui: &mut egui::Ui, levels: &mut [Json], selected: &mut usize, choices: &[Choice], lang: Language) {
let gap = ui.spacing().item_spacing.x;
// The row label column grows with the translated words, so a longer one is never wrapped or cut.
let font = egui::TextStyle::Body.resolve(ui.style());
let label_w = ["Sort by", "Then by"]
.iter()
.map(|key| ui.painter().layout_no_wrap(lang.tr(key).to_string(), font.clone(), egui::Color32::PLACEHOLDER).size().x.ceil() + 4.0)
.fold(64.0, f32::max);
let row_h = 26.0;
let rest = (ui.available_width() - 16.0 - label_w - 3.0 * gap).max(300.0);
let w = rest / 3.0;
let cell = |ui: &mut egui::Ui, w: f32, h: f32, add: &mut dyn FnMut(&mut egui::Ui)| {
ui.allocate_ui_with_layout(vec2(w, h), egui::Layout::left_to_right(egui::Align::Center), |ui| {
ui.set_min_size(vec2(w, h));
add(ui);
});
};
ui.horizontal(|ui| {
cell(ui, label_w + gap + w, 18.0, &mut |ui| {
ui.strong(lang.tr("Sort|Column"));
});
cell(ui, w, 18.0, &mut |ui| {
ui.strong(lang.tr("Sort On"));
});
cell(ui, w, 18.0, &mut |ui| {
ui.strong(lang.tr("Order"));
});
});
let accent = Tokens::get(ui.ctx()).accent;
for (i, lv) in levels.iter_mut().enumerate() {
let row_rect = egui::Rect::from_min_size(ui.cursor().min, vec2(ui.available_width(), row_h));
let row = ui.interact(row_rect, ui.scope_id().with(("sortRow", i)), Sense::click());
if i == *selected {
ui.painter().rect_filled(row_rect, 3.0, accent.gamma_multiply(0.18));
} else if row.hovered() {
ui.painter().rect_filled(row_rect, 3.0, accent.gamma_multiply(0.07));
}
if row.clicked() {
*selected = i;
}
ui.allocate_ui_with_layout(row_rect.size(), egui::Layout::left_to_right(egui::Align::Center), |ui| {
cell(ui, label_w, row_h, &mut |ui| {
ui.add(egui::Label::new(lang.tr(if i == 0 { "Sort by" } else { "Then by" })).selectable(false));
});
let mut col = lv["column"].as_str().unwrap_or("A").to_string();
// The closed box names the column as its open list does (#3446), whatever the case of the stored letter.
let shown = choices
.iter()
.find(|(l, _, _)| l.eq_ignore_ascii_case(&col))
.map_or_else(|| column_label(lang, &col.to_ascii_uppercase()), |(_, t, _)| t.clone());
let r = craft_ui::ComboBox::from_id_salt(("col", i)).selected_text(shown).width(w).show_ui(ui, |ui| {
for (letters, label, _) in choices {
ui.selectable_value(&mut col, letters.clone(), label);
}
});
r.response.widget_info(|| egui::WidgetInfo::labeled(egui::Role::ComboBox, true, lang.tr("Sort|Column")));
if r.response.clicked() {
*selected = i;
}
lv["column"] = json!(col.to_ascii_uppercase());
let mut by = lv["by"].as_str().unwrap_or("values").to_string();
let by_label = lang.tr(match by.as_str() {
"cellColor" => "Cell Color",
"fontColor" => "Font Color",
_ => "Cell Values",
});
let r = craft_ui::ComboBox::from_id_salt(("by", i)).selected_text(by_label).width(w).show_ui(ui, |ui| {
ui.selectable_value(&mut by, "values".into(), lang.tr("Cell Values"));
ui.selectable_value(&mut by, "cellColor".into(), lang.tr("Cell Color"));
ui.selectable_value(&mut by, "fontColor".into(), lang.tr("Font Color"));
});
r.response.widget_info(|| egui::WidgetInfo::labeled(egui::Role::ComboBox, true, lang.tr("Sort On")));
if r.response.clicked() {
*selected = i;
}
lv["by"] = json!(by);
let numeric = choices.iter().find(|(l, _, _)| lv["column"].as_str() == Some(l.as_str())).is_some_and(|(_, _, n)| *n);
let (asc_label, desc_label) = if numeric { ("Smallest to Largest", "Largest to Smallest") } else { ("A to Z", "Z to A") };
let (asc_label, desc_label) = (lang.tr(asc_label), lang.tr(desc_label));
let mut desc = lv["order"].as_str() == Some("desc");
let order_label = if desc { desc_label } else { asc_label };
let r = craft_ui::ComboBox::from_id_salt(("order", i)).selected_text(order_label).width(w).show_ui(ui, |ui| {
ui.selectable_value(&mut desc, false, asc_label);
ui.selectable_value(&mut desc, true, desc_label);
});
r.response.widget_info(|| egui::WidgetInfo::labeled(egui::Role::ComboBox, true, lang.tr("Order")));
if r.response.clicked() {
*selected = i;
}
lv["order"] = json!(if desc { "desc" } else { "asc" });
});
}
}
/// A bordered icon-only button with a tooltip, greyed out when disabled.
fn icon_button(ui: &mut egui::Ui, icon: Icon, color: egui::Color32, tip: &str, enabled: bool) -> egui::Response {
let color = if enabled { color } else { Tokens::get(ui.ctx()).text_disabled };
let response = ui.add_enabled_ui(enabled, |ui| crate::widgets::icon_button(ui, icon, color, tip, vec2(24.0, 24.0))).inner;
button_border(ui, response.rect);
response
}
/// A bordered button with a coloured icon and a text label, greyed out when disabled.
fn text_icon_button(ui: &mut egui::Ui, icon: Icon, color: egui::Color32, label: &str, enabled: bool) -> egui::Response {
let response = ui.add_enabled_ui(enabled, |ui| crate::widgets::small_button_accent(ui, icon, Some(color), label, label, false)).inner;
button_border(ui, response.rect);
response
}
/// Draws the visible border around a button's `rect`.
fn button_border(ui: &egui::Ui, rect: egui::Rect) {
let t = Tokens::get(ui.ctx());
ui.painter().rect_stroke(rect, 4.0, egui::Stroke::new(1.0, t.separator), egui::StrokeKind::Inside);
}
/// Whether the values are numbers (blanks aside), which picks "Smallest to Largest" over "A to Z".
fn values_are_numeric(values: impl IntoIterator<Item = Value>) -> bool {
let mut has_number = false;
for value in values {
match value {
Value::Empty => {}
Value::Number(_) => has_number = true,
_ => return false,
}
}
has_number
}
+4 -261
View File
@@ -129,70 +129,6 @@ fn insert_snippet(ctx: &egui::Context, id: egui::Id, text: &mut String, snippet:
ctx.data_mut(|m| m.insert_temp(id.with("refocus"), true));
}
/// The RaTeX parser messages that carry a piece of the source (a command, a token, a count).
/// RaTeX reports an error only as finished English text, so a message is matched against these
/// shapes (from `ratex-parser` 0.1.14) and the catalog's template is filled with the same pieces;
/// RaTeX's fixed messages are plain catalog keys. A shape comes before a shorter one that also
/// matches its messages, and a message of any other shape stays as RaTeX wrote it.
const RATEX_TEMPLATES: &[&str] = &[
"Undefined control sequence: {name}",
"Expected '{expected}', got '{got}'",
"Expected group after '{symbol}'",
"Expected delimiter as argument to '{function}'",
"Expected group as argument to '{function}'",
"Got function '{function}' with no arguments as superscript",
"Got function '{function}' with no arguments as subscript",
"Got function '{function}' with no arguments as argument to '{parent}'",
"Got function '{function}' with no arguments as \\tag",
"Can't use function '{function}' in text mode",
"Can't use function '{function}' in math mode",
"Invalid color: '{color}'",
"Invalid size: '{size}'",
"Invalid unit: '{unit}'",
"Invalid delimiter '{delimiter}' after '{function}'",
"Invalid delimiter type '{type}' after '{function}'",
"Invalid delimiter type '{type}'",
"No such environment: {name}",
"Expected argument to \\begin{{name}}",
"Mismatch: \\begin{{begin}} matched by \\end{{end}}",
"{command} valid only within array environment",
"Mismatched {command}",
"Expected & or \\\\ or \\cr or \\end, got '{got}'",
"Unknown column alignment: {alignment}",
"Too many math in a row: expected {expected}, but got {got}",
"Unknown CD directive: @{directive}",
"Expected argument for {command}",
"{command} needs {count} premise(s), but only {available} available",
"{command} valid only as a supported bussproofs command within prooftree",
"prooftree ended with {count} proof stack item(s), expected 1",
"\\@char has non-numeric argument {argument}",
"\\@char with invalid code point {code}",
"Invalid environment name character: {character}",
];
/// A parse error message in the interface language: GridCraft's own checks and RaTeX's fixed
/// messages by their catalog key, RaTeX's messages with a piece of the source by their template.
fn parse_error_message(lang: crate::i18n::Language, message: &str) -> String {
let translated = lang.tr_error(message);
if translated != message {
return translated;
}
RATEX_TEMPLATES
.iter()
.find_map(|template| crate::i18n::unfill(template, message).map(|values| lang.tr_fill(template, &values)))
.unwrap_or(translated)
}
/// The line under the equation source for a parse error: where it is (the 1-based character),
/// then the message, both in the interface language.
fn parse_error_text(lang: crate::i18n::Language, position: Option<usize>, message: &str) -> String {
let message = parse_error_message(lang, message);
match position {
Some(p) => lang.tr_fill("Error at character {position}: {message}", &[("position", &p.to_string()), ("message", &message)]),
None => message,
}
}
/// The editor's body: quick-insert buttons, the LaTeX source with its error underlined, a live
/// preview on a sheet-coloured card, and OK/Cancel.
pub fn editor(app: &mut SheetApp, ui: &mut egui::Ui, d: &mut Dialog, confirm: &mut bool, open: &mut bool) {
@@ -228,7 +164,10 @@ pub fn editor(app: &mut SheetApp, ui: &mut egui::Ui, d: &mut Dialog, confirm: &m
ui.add_space(4.0);
match &pv.result {
Err(e) if !text.trim().is_empty() => {
let msg = parse_error_text(app.ui.language, e.char_pos(&text), &e.message);
let msg = match e.char_pos(&text) {
Some(p) => format!("Error at character {p}: {}", e.message),
None => e.message.clone(),
};
ui.colored_label(t.danger, msg);
}
_ => {
@@ -561,202 +500,6 @@ fn triangulate(pts: &[Pos2]) -> Vec<[usize; 3]> {
mod tests {
use super::*;
#[test]
fn parse_errors_follow_the_interface_language() {
use crate::i18n::Language;
assert_eq!(parse_error_text(Language::En, Some(3), "Missing }"), "Error at character 3: Missing }");
assert_eq!(parse_error_text(Language::En, None, "Empty {group}"), "Empty {group}");
let it = Language::It;
// The message is filled in once: its own `{message}` stays as it is.
let want = it.tr("Error at character {position}: {message}").replace("{position}", "3").replace("{message}", "Bad {message}");
assert_eq!(parse_error_text(it, Some(3), "Bad {message}"), want);
assert!(!want.starts_with("Error at character"));
}
/// RaTeX's fixed parser messages that an equation can reach; each is a catalog key.
const RATEX_MESSAGES: &[&str] = &[
"Double superscript",
"Double subscript",
"Extra }",
"Unexpected end of input in a macro argument",
"Expected \\right after \\left",
"\\middle must be within \\left and \\right",
"Invalid environment name",
"Expected \\end after environment body",
"Expected URL",
"\\tag requires an argument",
"only one infix operator per group",
"Expected color token",
"Expected size for \\raisebox",
"Expected size for \\rule width",
"Expected size for \\rule height",
"Cannot use both \\tag and \\nonumber in the same row",
"Multiple \\tag in a row",
"\\tag must appear at the end of the row after the equation body",
"Multiple \\nonumber in a row",
"\\nonumber must appear at the end of the row",
"Too many tab characters: &",
"Invalid column alignment for array",
"Expected column alignment character",
"Expected l or c or r",
"Expected ]",
"Unexpected end of CD row after @",
"Invalid column alignment for subarray",
"{subarray} can contain only one column",
"prooftree has a \\LeftLabel or \\RightLabel without a following inference command",
"Recursion limit exceeded",
"Too many expansions: infinite loop or need to increase maxExpand setting",
"Expected raw style for \\htmlStyle",
"\\verb assertion failed",
];
/// RaTeX's messages, as `layout` reports them for real sources, follow the interface language:
/// a fixed message by its catalog key, a message with a piece of the source by its template
/// with the same pieces filled in. The English is checked first, so a reworded RaTeX message
/// fails here instead of silently staying English.
#[test]
fn ratex_parse_errors_follow_the_interface_language() {
use crate::i18n::Language;
use gridcraft_engine::math::layout;
/// Source, RaTeX's English message, its catalog key or template, and the template's pieces.
type Case = (&'static str, &'static str, &'static str, &'static [(&'static str, &'static str)]);
#[rustfmt::skip]
let cases: &[Case] = &[
("x^1^2", "Double superscript", "Double superscript", &[]),
("x_1_2", "Double subscript", "Double subscript", &[]),
("x^\\frac", "Unexpected end of input in a macro argument", "Unexpected end of input in a macro argument", &[]),
("\\middle|", "\\middle must be within \\left and \\right", "\\middle must be within \\left and \\right", &[]),
("a \\over b \\over c", "only one infix operator per group", "only one infix operator per group", &[]),
("\\begin{array}{l}a&b\\end{array}", "Too many tab characters: &", "Too many tab characters: &", &[]),
("\\begin{subarray}{lc}x\\end{subarray}", "{subarray} can contain only one column", "{subarray} can contain only one column", &[]),
("\\begin{aligned}a\\tag1\\tag2\\end{aligned}", "Multiple \\tag in a row", "Multiple \\tag in a row", &[]),
("\\begin{CD}A @", "Unexpected end of CD row after @", "Unexpected end of CD row after @", &[]),
("\\verb", "\\verb assertion failed", "\\verb assertion failed", &[]),
("\\foo", "Undefined control sequence: \\foo", "Undefined control sequence: {name}", &[("name", "\\foo")]),
("x^{2", "Expected '}', got 'EOF'", "Expected '{expected}', got '{got}'", &[("expected", "}"), ("got", "EOF")]),
("x^", "Expected group after '^'", "Expected group after '{symbol}'", &[("symbol", "^")]),
("\\left\\frac x\\right)", "Expected delimiter as argument to '\\left'", "Expected delimiter as argument to '{function}'", &[("function", "\\left")]),
("\\text{\\frac12}", "Can't use function '\\frac' in text mode", "Can't use function '{function}' in text mode", &[("function", "\\frac")]),
("\\)", "Can't use function '\\)' in math mode", "Can't use function '{function}' in math mode", &[("function", "\\)")]),
("\\color{zz!}{x}", "Invalid color: 'zz!'", "Invalid color: '{color}'", &[("color", "zz!")]),
("\\rule{abc}{1em}", "Invalid size: 'abc'", "Invalid size: '{size}'", &[("size", "abc")]),
("\\rule{1xx}{1em}", "Invalid unit: 'xx'", "Invalid unit: '{unit}'", &[("unit", "xx")]),
("\\bigl x", "Invalid delimiter 'x' after '\\bigl'", "Invalid delimiter '{delimiter}' after '{function}'", &[("delimiter", "x"), ("function", "\\bigl")]),
("\\bigl{x}", "Invalid delimiter type 'ordgroup' after '\\bigl'", "Invalid delimiter type '{type}' after '{function}'", &[("type", "ordgroup"), ("function", "\\bigl")]),
("\\begin{foo}x\\end{foo}", "No such environment: foo", "No such environment: {name}", &[("name", "foo")]),
("\\begin{matrix}x\\end{pmatrix}", "Mismatch: \\begin{matrix} matched by \\end{pmatrix}", "Mismatch: \\begin{{begin}} matched by \\end{{end}}", &[("begin", "matrix"), ("end", "pmatrix")]),
("\\hline", "\\hline valid only within array environment", "{command} valid only within array environment", &[("command", "\\hline")]),
("\\begin{matrix}a", "Expected & or \\\\ or \\cr or \\end, got 'EOF'", "Expected & or \\\\ or \\cr or \\end, got '{got}'", &[("got", "EOF")]),
("\\begin{array}{q}x\\end{array}", "Unknown column alignment: q", "Unknown column alignment: {alignment}", &[("alignment", "q")]),
("\\begin{alignedat}{1}a&b&c&d\\end{alignedat}", "Too many math in a row: expected 1, but got 2", "Too many math in a row: expected {expected}, but got {got}", &[("expected", "1"), ("got", "2")]),
("\\begin{CD}A @Q B\\end{CD}", "Unknown CD directive: @Q", "Unknown CD directive: @{directive}", &[("directive", "Q")]),
("\\begin{prooftree}\\BinaryInfC{x}\\end{prooftree}", "\\BinaryInfC needs 2 premise(s), but only 0 available", "{command} needs {count} premise(s), but only {available} available", &[("command", "\\BinaryInfC"), ("count", "2"), ("available", "0")]),
("\\begin{prooftree}\\frac\\end{prooftree}", "\\frac valid only as a supported bussproofs command within prooftree", "{command} valid only as a supported bussproofs command within prooftree", &[("command", "\\frac")]),
("\\begin{prooftree}\\AxiomC{x}\\AxiomC{y}\\end{prooftree}", "prooftree ended with 2 proof stack item(s), expected 1", "prooftree ended with {count} proof stack item(s), expected 1", &[("count", "2")]),
("\\char\"FFFFFFF", "\\@char with invalid code point 268435455", "\\@char with invalid code point {code}", &[("code", "268435455")]),
];
let it = Language::It;
for (src, english, template, values) in cases {
let message = layout(src).err().unwrap_or_else(|| panic!("{src:?} lays out")).message;
assert_eq!(&message, english, "{src:?}");
assert_eq!(parse_error_message(Language::En, &message), message, "English stays as RaTeX wrote it");
let want = values.iter().fold(it.tr(template).to_string(), |text, (name, value)| text.replace(&format!("{{{name}}}"), value));
assert_eq!(parse_error_message(it, &message), want, "{src:?}");
assert_ne!(want, message, "{src:?} stays English in Italian");
}
let want = it.tr("Error at character {position}: {message}").replace("{position}", "2").replace("{message}", it.tr("Double superscript"));
assert_eq!(parse_error_text(it, Some(2), "Double superscript"), want);
}
/// Every RaTeX shape is read by its own template (not by a shorter one listed earlier), and
/// every catalog translates it with the same placeholders; every fixed message is translated in
/// every catalog.
#[test]
fn ratex_messages_are_translated_in_every_catalog() {
use crate::i18n::{Language, fill, unfill};
let placeholders = |s: &str| {
let mut names = s.split('{').skip(1).filter_map(|rest| rest.split_once('}').map(|(name, _)| name.to_string())).collect::<Vec<_>>();
names.sort();
names
};
for template in RATEX_TEMPLATES {
// A sample piece per placeholder: `\a1`, `\a2`, …
let names = unfill(template, template).unwrap_or_else(|| panic!("{template:?} does not read itself"));
let samples = (1..=names.len()).map(|i| format!("\\a{i}")).collect::<Vec<_>>();
let values = names.iter().zip(&samples).map(|((name, _), sample)| (*name, sample.as_str())).collect::<Vec<_>>();
let message = fill(template, &values);
let first = RATEX_TEMPLATES.iter().find(|t| unfill(t, &message).is_some());
assert_eq!(first, Some(template), "{message:?}");
assert_eq!(parse_error_message(Language::En, &message), message);
for language in Language::ALL.into_iter().filter(|l| *l != Language::En) {
let text = language.tr(template);
assert_eq!(placeholders(text), placeholders(template), "{}: {template:?} => {text:?}", language.code());
assert!(!text.contains('\n'), "{}: {template:?} => {text:?}", language.code());
assert_eq!(parse_error_message(language, &message), fill(text, &values), "{}", language.code());
assert_ne!(parse_error_message(language, &message), message, "{} leaves {template:?} in English", language.code());
}
}
for message in RATEX_MESSAGES {
for language in Language::ALL.into_iter().filter(|l| *l != Language::En) {
let shown = parse_error_message(language, message);
assert_ne!(&shown, message, "{} leaves {message:?} in English", language.code());
assert_eq!(placeholders(&shown), placeholders(message), "{}: {message:?} => {shown:?}", language.code());
}
}
}
/// A message of no known shape, such as RaTeX's internal ones or the chemistry parser's, stays
/// as RaTeX wrote it in every language.
#[test]
fn unknown_parser_messages_stay_as_ratex_wrote_them() {
use crate::i18n::Language;
for message in ["Null argument, please report this as a bug", "\\ce: unexpected token", "Expected group as atom", ""] {
for language in Language::ALL {
assert_eq!(parse_error_message(language, message), message, "{}", language.code());
}
}
}
/// The equation checks' own messages are translated in every catalog. Each comes from the real check, and the expected English is
/// built from the limits, so a changed limit fails here instead of silently falling back to
/// English (the catalogs key the message with the number in it).
#[test]
fn equation_check_messages_are_translated_in_every_catalog() {
use crate::i18n::Language;
use gridcraft_engine::math::{MAX_CELLS, MAX_DEPTH, MAX_SOURCE_BYTES, layout};
let cases = [
("\\def\\x{1} x".to_string(), "Macro definitions are not supported in equations.".to_string()),
("50% \\href{https://example.com}{x}".to_string(), "A % can't be combined with a link in an equation.".to_string()),
(format!("{}x{}", "{".repeat(MAX_DEPTH + 1), "}".repeat(MAX_DEPTH + 1)), format!("Equations can nest at most {MAX_DEPTH} levels deep.")),
("x".repeat(MAX_SOURCE_BYTES + 1), format!("An equation can be at most {MAX_SOURCE_BYTES} bytes long.")),
(
"\\begin{alignedat}{99999999}a\\end{alignedat}".to_string(),
format!("An equation can have at most {MAX_CELLS} matrix cells (rows times the widest row)."),
),
("\\rule{99999999em}{1em}".to_string(), "This equation is too large to draw.".to_string()),
];
let mut messages = Vec::new();
for (src, want) in cases {
let got = layout(&src).err().unwrap_or_else(|| panic!("{src:?} lays out")).message;
assert_eq!(got, want, "{src:?} hits another check");
messages.push(got);
}
// Only a panic inside the layout reaches this one.
messages.push("This equation could not be laid out.".to_string());
for message in &messages {
for language in Language::ALL {
let shown = parse_error_text(language, None, message);
assert!(!shown.contains('\n'), "{}: {message:?} => {shown:?}", language.code());
if language != Language::En {
assert_ne!(&shown, message, "{} leaves {message:?} in English", language.code());
}
}
}
let it = Language::It;
let want = it.tr("Error at character {position}: {message}").replace("{position}", "1").replace("{message}", it.tr(&messages[0]));
assert_eq!(parse_error_text(it, Some(1), &messages[0]), want);
}
#[test]
fn ear_clipping_covers_a_concave_polygon() {
// An L shape: area 3 unit squares.
+1 -27
View File
@@ -280,8 +280,7 @@ fn active_input(app: &SheetApp) -> String {
let Some(sh) = d.wb.active() else { return String::new() };
let a = sh.merge_at(d.selection.active).map(|m| m.start).unwrap_or(d.selection.active);
if let Some(picture) = sh.cell_pictures.get(&a) {
let lang = app.ui.language;
return if picture.alt.is_empty() { lang.tr("Picture in cell").into() } else { lang.tr_fill("Picture: {alt}", &[("alt", &picture.alt)]) };
return if picture.alt.is_empty() { "Picture in cell".into() } else { format!("Picture: {}", picture.alt) };
}
// Python code is shown as it is: it isn't a formula to translate or a value to format. Like
// a formula, it stays out of view in a Hidden cell on a protected sheet.
@@ -943,31 +942,6 @@ mod spill_tests {
SheetApp::new(s, Default::default())
}
#[test]
fn a_picture_in_a_cell_is_named_in_the_interface_language() {
use crate::i18n::Language;
use gridcraft_engine::core::CellRef;
use gridcraft_engine::model::CellPicture;
let mut app = app();
let put = |app: &mut SheetApp, cell: &str, alt: &str| {
let at = CellRef::parse(cell).unwrap();
let picture = std::sync::Arc::new(CellPicture { data: vec![], mime: "image/png".into(), alt: alt.into() });
std::sync::Arc::make_mut(&mut app.session.active_mut().unwrap().wb).sheet_mut(0).unwrap().set_picture(at, picture);
};
put(&mut app, "A1", "");
put(&mut app, "A2", "Logo {alt}");
select(&mut app, "A1");
assert_eq!(active_input(&app), "Picture in cell");
select(&mut app, "A2");
assert_eq!(active_input(&app), "Picture: Logo {alt}");
app.ui.language = Language::It;
select(&mut app, "A1");
assert_eq!(active_input(&app), Language::It.tr("Picture in cell"));
assert_ne!(active_input(&app), "Picture in cell");
select(&mut app, "A2");
assert_eq!(active_input(&app), Language::It.tr("Picture: {alt}").replace("{alt}", "Logo {alt}"));
}
fn set(app: &mut SheetApp, cell: &str, input: &str) {
app.run("cell.set", json!({"cell": cell, "input": input})).unwrap();
}
-5
View File
@@ -160,11 +160,6 @@ mod tests {
assert_eq!(sig("IF", En, Language::Es), "IF(prueba_lógica, [valor_si_verdadero], [valor_si_falso])");
assert_eq!(sig("SUM", En, Language::Es), "SUM(número1, [número2], ...)");
assert_eq!(description("IF", En, Language::Es).as_deref(), Some("Devuelve un valor según una condición."));
// Portuguese help, including brackets that open and close on different arguments.
assert_eq!(sig("IF", En, Language::PtBr), "IF(teste_lógico, [valor_se_verdadeiro], [valor_se_falso])");
assert_eq!(description("IF", En, Language::PtBr).as_deref(), Some("Retorna um valor quando uma condição é TRUE e outro quando é FALSE."));
assert_eq!(sig("SWITCH", En, Language::PtBr), "SWITCH(expressão, valor1, resultado1, [padrão_ou_valor2, resultado2], ...)");
assert_eq!(sig("LAMBDA", En, Language::PtBr), "LAMBDA([parâmetro1, ...], cálculo)");
// Spanish names and separators, from a localized name.
assert_eq!(sig("suma", Es, Language::Es), "SUMA(número1; [número2]; ...)");
assert_eq!(description("SUMA", Es, Language::Es).as_deref(), Some("Suma los números."));
+1 -1
View File
@@ -31,7 +31,7 @@ pub(super) fn center_across_end(start: u32, limit: u32, continues: impl Fn(u32)
pub(super) fn look(wb: &Workbook, si: usize, sh: &Sheet, c: CellRef, cf: &mut CfCache) -> (Look, Option<CfLook>) {
let mut style = wb.styles.get(sh.style_id(c)).clone();
if let Some(t) = sh.table_at(c) {
style = gridcraft_engine::tables::table_cell_shown_style(wb, si, t, cf.table_edges(sh, t), c);
style = gridcraft_engine::tables::table_cell_style(wb, si, t, c);
}
let cfl = cf.look(wb, si, c);
if let Some(l) = &cfl
+3 -27
View File
@@ -711,7 +711,8 @@ fn handle_dragging(app: &mut SheetApp, input: &InteractionInput<'_>) {
}
Drag::ResizeCol { col, start, orig, to } => {
let w = nan_safe_size(orig + (p.x - start) / geo.z);
app.toast = Some((column_width_tip(app.ui.language, w), crate::now_ms()));
app.toast =
Some((format!("Width: {:.2} ({} pixels)", gridcraft_engine::cmd::format::points_to_chars(w as f64), w.round()), crate::now_ms()));
// Preview on the dragged column only; the release applies it to the selection. A
// rejected size leaves the last shown preview (and `to`) as it was.
let ok = app.session.run("home.columnWidth", json!({"cols": RangeRef::cols(col, col).a1(), "width": w.round()})).is_ok();
@@ -720,7 +721,7 @@ fn handle_dragging(app: &mut SheetApp, input: &InteractionInput<'_>) {
}
Drag::ResizeRow { row, start, orig, to } => {
let h = nan_safe_size(orig + (p.y - start) / geo.z);
app.toast = Some((row_height_tip(app.ui.language, h), crate::now_ms()));
app.toast = Some((format!("Height: {:.2} ({} pixels)", h * 0.75, h.round()), crate::now_ms()));
let ok = app.session.run("home.rowHeight", json!({"rows": format!("{}:{}", row + 1, row + 1), "height": h.round()})).is_ok();
coalesce_resize_undo(app);
app.grid.drag = Drag::ResizeRow { row, start, orig, to: if ok { Some(h) } else { to } };
@@ -1030,20 +1031,6 @@ fn scroll_by(app: &mut SheetApp, d: egui::Vec2) {
}
}
/// The tip while a column border is dragged to `width` pixels: the width in characters, then in
/// pixels (`Width: 8.43 (64 pixels)`).
pub(crate) fn column_width_tip(lang: crate::i18n::Language, width: f32) -> String {
let chars = format!("{:.2}", gridcraft_engine::cmd::format::points_to_chars(f64::from(width)));
lang.tr_fill("Width: {chars} ({pixels} pixels)", &[("chars", &chars), ("pixels", &width.round().to_string())])
}
/// The tip while a row border is dragged to `height` pixels: the height in points, then in pixels
/// (`Height: 15.00 (20 pixels)`).
pub(crate) fn row_height_tip(lang: crate::i18n::Language, height: f32) -> String {
let points = format!("{:.2}", height * 0.75);
lang.tr_fill("Height: {points} ({pixels} pixels)", &[("points", &points), ("pixels", &height.round().to_string())])
}
fn fill_target(src: RangeRef, pc: CellRef) -> RangeRef {
let below = pc.row as i64 - src.end.row as i64;
let above = src.start.row as i64 - pc.row as i64;
@@ -1275,17 +1262,6 @@ mod resize_tests {
mod tests {
use super::*;
#[test]
fn resize_tips_follow_the_interface_language() {
use crate::i18n::Language;
assert_eq!(column_width_tip(Language::En, 64.0), "Width: 8.43 (64 pixels)");
assert_eq!(row_height_tip(Language::En, 20.0), "Height: 15.00 (20 pixels)");
let de = Language::De;
assert_eq!(column_width_tip(de, 64.0), de.tr("Width: {chars} ({pixels} pixels)").replace("{chars}", "8.43").replace("{pixels}", "64"));
assert_eq!(row_height_tip(de, 20.0), de.tr("Height: {points} ({pixels} pixels)").replace("{points}", "15.00").replace("{pixels}", "20"));
assert!(!column_width_tip(de, 64.0).starts_with("Width"));
}
#[test]
fn the_pen_preview_is_the_ink_the_stroke_commits() {
// #1786: the preview was always blue at 2 pt, whatever the pen.
+9 -97
View File
@@ -2,10 +2,8 @@ use super::geo::Geo;
use super::menus::is_checkbox;
use super::{CellRef, Drag, Sheet, SheetApp, json};
/// Whether something other than the grid owns the keyboard this frame: an editor, a dialog, a
/// message, a menu or another focused widget. Kept out of [`keyboard`] to hold its complexity
/// within the workspace limit.
fn keyboard_elsewhere(app: &SheetApp, ctx: &egui::Context, resp: &egui::Response) -> bool {
/// Grid keyboard handling when no text field has focus.
pub(super) fn keyboard(app: &mut SheetApp, ctx: &egui::Context, resp: &egui::Response, geo: &Geo, sh: &Sheet) {
// Focus left on an editor that no longer exists goes back to the grid.
let stale = [egui::Id::unique("gridcraft.cell_editor"), egui::Id::unique("gridcraft.formula_bar"), crate::text_box::editor_id()];
let editing = app.editor.is_some() || app.text_box_editor.is_some();
@@ -16,7 +14,7 @@ fn keyboard_elsewhere(app: &SheetApp, ctx: &egui::Context, resp: &egui::Response
// An open filter menu owns the keyboard even when a click inside it left focus on nothing (#1516).
// So do the fill menu (its Esc closes it, not the copy) and the right-drag that opens it (an
// arrow key would move the selection the menu fills from), and a macro's question.
editing
if editing
|| app.dialog.is_some()
|| other_focus
|| app.message.is_some()
@@ -24,11 +22,7 @@ fn keyboard_elsewhere(app: &SheetApp, ctx: &egui::Context, resp: &egui::Response
|| app.grid.fill_menu.is_some()
|| matches!(app.grid.drag, Drag::Fill { menu: true, .. })
|| app.macros.question.is_some()
}
/// Grid keyboard handling when no text field has focus.
pub(super) fn keyboard(app: &mut SheetApp, ctx: &egui::Context, resp: &egui::Response, geo: &Geo, sh: &Sheet) {
if keyboard_elsewhere(app, ctx, resp) {
{
return;
}
if ctx.memory(|m| m.focused()).is_none() {
@@ -38,7 +32,6 @@ pub(super) fn keyboard(app: &mut SheetApp, ctx: &egui::Context, resp: &egui::Res
ctx.memory_mut(|m| {
m.set_focus_lock_filter(resp.id, egui::EventFilter { tab: true, horizontal_arrows: true, vertical_arrows: true, escape: true })
});
request_grid_ime(app, ctx, resp, geo, sh);
let events = grid_events(app, ctx, sh);
// A shortcut key that also types a character (Shift+Space sends Text(" ")) must not start an edit.
let shortcut_pressed = events.iter().any(|e| {
@@ -50,11 +43,6 @@ pub(super) fn keyboard(app: &mut SheetApp, ctx: &egui::Context, resp: &egui::Res
// a shortcut ran, that text must not start an edit over what it just did.
let mut shortcut_ran = false;
for ev in events {
// IME events are handled outside the match to keep this loop's complexity down. Any
// non-commit IME event (preedit, delete-surrounding) falls through to `_ => {}` below.
if handle_ime_commit(app, &ev, shortcut_pressed, shortcut_ran) {
return;
}
match ev {
egui::Event::Copy => {
app.copy_to_clipboard(ctx, "edit.copy");
@@ -70,13 +58,11 @@ pub(super) fn keyboard(app: &mut SheetApp, ctx: &egui::Context, resp: &egui::Res
// insert text at, so a middle click on a cell is deliberately not a paste.
egui::Event::MiddleClickPaste { .. } => {}
egui::Event::Text(_) if shortcut_pressed || shortcut_ran => {}
// A space on a checkbox cell toggles it (the `Key::Space` arm below). The same key
// press also arrives as text, and typing text starts editing the cell -- so the cell
// toggled *and* opened an editor holding a space, which Enter then committed over the
// checkbox (#1951).
egui::Event::Text(text) if text == " " && is_checkbox(sh, app) => {}
egui::Event::Text(text) if text.chars().all(|c| !c.is_control()) && !text.is_empty() => {
seed_editor(app, text);
app.begin_edit(Some(text), false);
if let Some(ed) = app.editor.as_mut() {
ed.caret = ed.text.chars().count();
}
return;
}
egui::Event::Key { key, physical_key, pressed: true, modifiers: m, .. } => {
@@ -160,9 +146,7 @@ pub(super) fn keyboard(app: &mut SheetApp, ctx: &egui::Context, resp: &egui::Res
// Ctrl+Shift+letter (⌘⇧letter) runs the macro with that shortcut, unless GridCraft uses it.
_ if cmd && shift && !m.alt && crate::macro_ui::run_shortcut(app, key) => {}
_ if cmd && !crate::keymap::altgr_text(ctx, m, ctx.os() == egui::os::OperatingSystem::Mac) => {
// The same key the English table reads: Ctrl+Shift+, typing `;` is Ctrl+;.
let (key, shift) = crate::keymap::us_key(key, physical_key, shift).unwrap_or((key, shift));
crate::ribbon::shortcut(app, key, egui::Modifiers { shift, ..m });
crate::ribbon::shortcut(app, key, m)
}
_ => {}
}
@@ -172,78 +156,6 @@ pub(super) fn keyboard(app: &mut SheetApp, ctx: &egui::Context, resp: &egui::Res
}
}
/// Open the in-cell editor with typed or committed text and put the caret after it.
fn seed_editor(app: &mut SheetApp, text: String) {
app.begin_edit(Some(text), false);
if let Some(ed) = app.editor.as_mut() {
ed.caret = ed.text.chars().count();
}
}
/// Seed the editor from a finished composition, if `ev` is one.
///
/// Only `ImeEvent::Commit` is finished text; a preedit is the input method's in-progress
/// spelling and must not seed the editor. `Event::Ime` and `Event::Text` are mutually
/// exclusive for one keystroke, so accepting a commit cannot double-insert a character.
/// Returns whether the caller should stop handling this frame's events.
fn handle_ime_commit(app: &mut SheetApp, ev: &egui::Event, shortcut_pressed: bool, shortcut_ran: bool) -> bool {
let egui::Event::Ime(egui::ImeEvent::Commit(text)) = ev else { return false };
if shortcut_pressed || shortcut_ran || text.is_empty() {
return false;
}
seed_editor(app, text.clone());
true
}
/// Ask the OS to route keystrokes through the input method while the grid owns keyboard input.
///
/// egui enables IME only for a widget that publishes `PlatformOutput::ime` in that frame. The
/// in-cell `TextEdit` opens *after* the grid has consumed the first keystroke, so without this
/// the first key of a CJK composition is delivered as raw `Event::Text` and lands in the cell
/// (Wubi `xta` writes `x` and the input method only ever sees `ta`). The request must be
/// published on every focused frame, not in response to a key: winit applies it at the end of
/// the frame, so a key arriving while IME is still off cannot be recovered.
///
/// `PlatformOutput` is rebuilt every frame, so returning early (an editor, a dialog or another
/// widget taking focus) simply leaves `ime` as `None` and the input method turns off.
fn request_grid_ime(app: &SheetApp, ctx: &egui::Context, resp: &egui::Response, geo: &Geo, sh: &Sheet) {
if !ctx.memory(|m| m.owns_ime_events(resp.id)) {
return;
}
let Some(d) = app.session.active() else { return };
let active = d.selection.active;
let merged = sh.merge_at(active);
// `begin_edit` refuses a locked cell on a protected sheet. Publishing an IME request for
// one would let the user compose text that is then discarded, so skip it up front, using
// the same merged-cell anchor and protection check as `SheetApp::begin_edit`.
let anchor = merged.map(|m| m.start).unwrap_or(active);
if app.session.locked_cell_message(d.wb.active_sheet(), anchor).is_some() {
return;
}
// `cell_rect`/`range_rect` are logical coordinates, but `IMEOutput` needs screen ones.
// On a right-to-left sheet the grid is mirrored, so publishing the logical rect puts the
// candidate window on the opposite side. After mirroring, `rect.min` is the screen-side
// start of the cell in both layouts, which is where the caret belongs.
let rect = match merged {
Some(m) => geo.mirror_rect(geo.range_rect(sh, m)),
None => geo.mirror_rect(geo.cell_rect(sh, active)),
};
let cursor_rect = egui::Rect::from_min_size(rect.min, egui::vec2(1.0, rect.height()));
// egui 0.37 identifies an IME context by (owner, generation). The generation must change
// when this owner gains focus and stay stable for ordinary text and selection updates.
let gained_focus = resp.gained_focus();
let generation = ctx.data_mut(|data| {
let g: &mut u64 = data.get_temp_mut_or_default(egui::Id::unique("gridcraft.grid_ime_generation"));
if gained_focus || *g == 0 {
*g = g.wrapping_add(1);
}
*g
});
ctx.output_mut(|o| {
o.ime = Some(egui::output::IMEOutput::new(resp.id, generation, egui::IMEPurpose::Normal, rect, cursor_rect));
});
}
/// This frame's input events, without those the focused form control took.
fn grid_events(app: &mut SheetApp, ctx: &egui::Context, sh: &Sheet) -> Vec<egui::Event> {
let events = ctx.input(|i| i.events.clone());
+1 -1
View File
@@ -53,7 +53,7 @@ pub fn show(app: &mut SheetApp, ui: &mut egui::Ui) {
} else {
Rect::from_min_max(available.min, pos2(available.right() - bar, available.bottom()))
};
let resp = ui.allocate_rect(rect, crate::dialogs::grid_sense(app));
let resp = ui.allocate_rect(rect, Sense::click_and_drag());
app.grid.rect = Some(rect);
let Some(d) = app.session.active() else { return };
let wb: Arc<Workbook> = d.wb.clone();

Some files were not shown because too many files have changed in this diff Show More