Merge main into feat/palette-use-counts

This commit is contained in:
dotCooCoo committed 2026-11-19 11:03:41 -08:00
commit 993b3fd2ae
236 files changed
+19679 -1166

No files matched your search

+1
View File
@@ -115,6 +115,7 @@ Generated-in-code art is original and has no file to list. This covers the defau
| `assets/icons/dc-anchor-smooth.svg` | VectorCraft contributors | Original work, drawn for VectorCraft | MIT OR Apache-2.0 | |
| `assets/icons/dc-appearance.svg` | VectorCraft contributors | Original work, drawn for VectorCraft | MIT OR Apache-2.0 | |
| `assets/icons/dc-arc.svg` | VectorCraft contributors | Original work, drawn for VectorCraft | MIT OR Apache-2.0 | |
| `assets/icons/dc-arc-three-point.svg` | VectorCraft contributors | Original work, drawn for VectorCraft | MIT OR Apache-2.0 | The Three-Point Arc tool: an arc through its two ends and a third point |
| `assets/icons/dc-arrow-down.svg` | VectorCraft contributors | Original work, drawn for VectorCraft | MIT OR Apache-2.0 | |
| `assets/icons/dc-arrow-extend.svg` | VectorCraft contributors | Original work, drawn for VectorCraft | MIT OR Apache-2.0 | |
| `assets/icons/dc-arrow-fill.svg` | VectorCraft contributors | Original work, drawn for VectorCraft | MIT OR Apache-2.0 | The Selection and Direct Selection arrows' fill, painted black or white under their outline |
Generated
+44 -40
View File
@@ -1001,7 +1001,7 @@ dependencies = [
[[package]]
name = "craft-affinity"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"crc32fast",
"flate2",
@@ -1012,12 +1012,12 @@ dependencies = [
[[package]]
name = "craft-codepage"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
[[package]]
name = "craft-dds"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"rayon",
]
@@ -1025,12 +1025,12 @@ dependencies = [
[[package]]
name = "craft-docpath"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
[[package]]
name = "craft-dxf"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"craft-codepage",
"encoding_rs",
@@ -1042,12 +1042,12 @@ dependencies = [
[[package]]
name = "craft-eps"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
[[package]]
name = "craft-font-catalog"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=23acc704933a9a5619a5cd1cddc9bb1fb5a9b2d3#23acc704933a9a5619a5cd1cddc9bb1fb5a9b2d3"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"harfrust 0.13.3",
"kurbo 0.13.1",
@@ -1061,12 +1061,12 @@ dependencies = [
[[package]]
name = "craft-fonts-build"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
[[package]]
name = "craft-gif"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"gif",
]
@@ -1074,7 +1074,7 @@ dependencies = [
[[package]]
name = "craft-gzip"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"flate2",
]
@@ -1082,7 +1082,7 @@ dependencies = [
[[package]]
name = "craft-i18n"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"fixed_decimal",
"icu_decimal",
@@ -1105,7 +1105,7 @@ dependencies = [
[[package]]
name = "craft-image-codecs"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"craft-dds",
"craft-jpeg",
@@ -1132,7 +1132,7 @@ dependencies = [
[[package]]
name = "craft-jpeg"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"thiserror 2.0.21",
]
@@ -1140,8 +1140,9 @@ dependencies = [
[[package]]
name = "craft-jxl"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"brotli-decompressor 5.0.3",
"jixel",
"jxl-oxide",
"thiserror 2.0.21",
@@ -1150,7 +1151,7 @@ dependencies = [
[[package]]
name = "craft-keymap"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"egui",
"serde",
@@ -1160,7 +1161,7 @@ dependencies = [
[[package]]
name = "craft-metadata"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"brotli-decompressor 6.3.2",
"chrono",
@@ -1172,7 +1173,7 @@ dependencies = [
[[package]]
name = "craft-metafile"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"encoding_rs",
"image",
@@ -1183,7 +1184,7 @@ dependencies = [
[[package]]
name = "craft-mime"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"chrono",
"craft-codepage",
@@ -1193,7 +1194,7 @@ dependencies = [
[[package]]
name = "craft-pdf"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"hayro-interpret",
"hayro-syntax",
@@ -1204,15 +1205,16 @@ dependencies = [
[[package]]
name = "craft-plotter"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=a7fb55eaf9a15c21e8ce0b13cf605dc54fd15f57#a7fb55eaf9a15c21e8ce0b13cf605dc54fd15f57"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"kurbo 0.13.1",
"thiserror 2.0.21",
]
[[package]]
name = "craft-print"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"craft-winprint-gdi",
"log",
@@ -1226,7 +1228,7 @@ dependencies = [
[[package]]
name = "craft-proof"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"log",
"miniz_oxide 0.9.1",
@@ -1237,7 +1239,7 @@ dependencies = [
[[package]]
name = "craft-ps"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"flate2",
"kurbo 0.13.1",
@@ -1246,7 +1248,7 @@ dependencies = [
[[package]]
name = "craft-psd"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"encoding_rs",
"flate2",
@@ -1257,7 +1259,7 @@ dependencies = [
[[package]]
name = "craft-stream-codecs"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"fax",
"hayro-ccitt",
@@ -1268,12 +1270,14 @@ dependencies = [
[[package]]
name = "craft-svg"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"craft-image-codecs",
"craft-xml",
"data-url",
"flate2",
"gif",
"image-webp",
"kurbo 0.13.1",
"quick-xml 0.41.0",
"resvg 0.48.1",
@@ -1287,7 +1291,7 @@ dependencies = [
[[package]]
name = "craft-tiff"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"serde",
"thiserror 2.0.21",
@@ -1296,7 +1300,7 @@ dependencies = [
[[package]]
name = "craft-ui"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"craft-fonts-build",
"craft-i18n",
@@ -1317,7 +1321,7 @@ dependencies = [
[[package]]
name = "craft-update"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"chrono",
"dunce",
@@ -1344,7 +1348,7 @@ dependencies = [
[[package]]
name = "craft-vectorcraft-format"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"flate2",
"serde",
@@ -1355,7 +1359,7 @@ dependencies = [
[[package]]
name = "craft-web-api"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"js-sys",
"serde_json",
@@ -1366,7 +1370,7 @@ dependencies = [
[[package]]
name = "craft-window"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"egui",
"objc2 0.6.5",
@@ -1385,7 +1389,7 @@ dependencies = [
[[package]]
name = "craft-xml"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"quick-xml 0.41.0",
"serde",
@@ -2492,7 +2496,7 @@ checksum = "9f4d0e94ddd48749f06bbe4e5389fb9799a0c45bcaf00495042076ef05e3241a"
[[package]]
name = "hayro-cmap"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"brotli",
"hayro-postscript",
@@ -2501,7 +2505,7 @@ dependencies = [
[[package]]
name = "hayro-interpret"
version = "0.7.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"bitflags 2.13.2",
"hayro-cmap",
@@ -2519,7 +2523,7 @@ dependencies = [
[[package]]
name = "hayro-jbig2"
version = "0.3.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"fearless_simd",
"hayro-ccitt",
@@ -2537,12 +2541,12 @@ dependencies = [
[[package]]
name = "hayro-postscript"
version = "0.1.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
[[package]]
name = "hayro-syntax"
version = "0.7.2"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"flate2",
"hayro-ccitt",
@@ -3342,7 +3346,7 @@ dependencies = [
[[package]]
name = "krilla"
version = "0.8.2"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"base64 0.22.1",
"bumpalo",
@@ -3451,7 +3455,7 @@ checksum = "d4a5ff6bcca6c4867b1c4fd4ef63e4db7436ef363e0ad7531d1558856bae64f4"
[[package]]
name = "linesweeper"
version = "0.5.0"
source = "git+https://github.com/storytold/craft-libs?rev=64b181977a0488e4d1e167bc5cc8cfededc2ed4b#64b181977a0488e4d1e167bc5cc8cfededc2ed4b"
source = "git+https://github.com/storytold/craft-libs?rev=50b0ee7bf811e363b5f238382b5c77318cf33e46#50b0ee7bf811e363b5f238382b5c77318cf33e46"
dependencies = [
"arrayvec",
"kurbo 0.13.1",
+32 -32
View File
@@ -11,40 +11,40 @@ rust-version = "1.95"
repository = "https://github.com/storytold/vectorcraft"
[workspace.dependencies]
craft-pdf = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b", default-features = false, features = ["interpret", "write"] }
craft-print = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-ui = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b", features = ["serde"] }
craft-keymap = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-proof = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-pdf = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46", default-features = false, features = ["interpret", "write"] }
craft-print = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-ui = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46", features = ["serde"] }
craft-keymap = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-proof = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
# Decides who draws the window frame (desktop vs. app) so the suite shares one native titlebar per
# desktop. The `egui` feature adds `craft_window::decorate`. (craft-libs#217.)
craft-window = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b", features = ["egui"] }
craft-window = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46", features = ["egui"] }
# The `.vectorcraft` envelope: its members, version, embedded images and the data after the JSON.
craft-vectorcraft-format = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-gzip = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-vectorcraft-format = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-gzip = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
# craft-update: app-specific pretend versions apply to startup and manual checks.
# Native Affinity documents (craft-libs#914).
craft-affinity = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-affinity = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
# SVG parsing, limits, SVGZ and writer (craft-libs#778).
craft-svg = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b", features = ["tree"] }
craft-mime = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-svg = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46", features = ["tree"] }
craft-mime = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
# EPS container, previews, ASCII85 and DSC comments (craft-libs#778).
craft-eps = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-eps = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
# DXF tags, reader and writer (craft-libs#778, #926, #927).
craft-plotter = { git = "https://github.com/storytold/craft-libs", rev = "a7fb55eaf9a15c21e8ce0b13cf605dc54fd15f57" }
craft-dxf = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-plotter = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-dxf = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
# WMF, EMF and EMF+ reader (craft-libs#778).
craft-metafile = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-xml = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-image-codecs = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-gif = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-tiff = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-ps = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b", default-features = false, features = ["write"] }
craft-psd = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-stream-codecs = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-jxl = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b", features = ["egui"] }
craft-metafile = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-xml = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-image-codecs = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-gif = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-tiff = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-ps = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46", default-features = false, features = ["write"] }
craft-psd = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-stream-codecs = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-jxl = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46", features = ["egui"] }
# internal
vectorcraft-geom = { path = "crates/geom" }
vectorcraft-color = { path = "crates/color" }
@@ -185,13 +185,13 @@ lto = "thin"
codegen-units = 1
[patch.crates-io]
hayro-syntax = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
hayro-interpret = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
hayro-jbig2 = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
hayro-cmap = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
hayro-postscript = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
krilla = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
linesweeper = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b" }
hayro-syntax = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
hayro-interpret = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
hayro-jbig2 = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
hayro-cmap = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
hayro-postscript = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
krilla = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
linesweeper = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46" }
ecolor = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" }
emath = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" }
epaint = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" }
+2
View File
@@ -128,6 +128,7 @@ Ranked; detail in [docs/roadmap.md](docs/roadmap.md) and [docs/gaps.md](docs/gap
- 2026-11-14: Built-in symbol library Weather Icons: adds a sixth procedural symbol library (Window › Symbol Libraries, the Symbols panel's Symbol Libraries Menu) containing six original vector symbols (Sun, Moon, Cloud, Rain, Thunder, Snow) generated in code without default 9-slice guides (part of Gap 5). Headline numbers unchanged.
- 2026-11-14: Built-in Tech Circuit brush library: Circuit Trace (chamfered art with 45-degree elbows and terminal pads), Bus Lines (parallel conductor pattern) and Terminal Nodes (repeating solder pads, test points and leads), all original geometry generated in code. Ten built-in brush libraries; G5 remaining estimate 3–13 h (estimated), headline numbers unchanged.
- 2026-11-18: Built-in Paint brush library: Flat Sweep, Dry Drag, Loaded Stroke and Fan Sweep, original art brushes generated in code that take the stroke color as tints. Thirteen built-in brush libraries; headline numbers unchanged.
- 2026-11-05: Window › Toolbars › Keep Tools Beside the Canvas, off by default, docks the Tools panel between left-side panels and the canvas instead of at the window's left edge, and the canvas's left edge then also docks a floating Tools panel (`window.toolsBesideCanvas`, #5395). Workspaces keep the setting; workspaces saved without it keep Tools at the window's edge. An optional VectorCraft layout choice; headline numbers unchanged.
- 2026-11-17: The canvas's left edge docks a floating Tools panel whichever way Keep Tools Beside the Canvas is set: a drop there, right of panels docked on the left, turns the setting on, and a drop on the window's left edge turns it off (#7837). Headline numbers unchanged.
@@ -162,6 +163,7 @@ Ranked; detail in [docs/roadmap.md](docs/roadmap.md) and [docs/gaps.md](docs/gap
- 2026-11-17: Tangent Circle Tool joins the Path Precision Tools add-on (Object › Plug-ins › Path Precision Tools, and the All Tools drawer): click a path segment, then another, to draw the circle tangent to the first where it was clicked that touches the second; Shift uses the tool's radius and a drag from the second segment sets the radius (Shift in round steps, Cmd/Ctrl slowly), the circle then touching the first segment anywhere along it. The circle shows with its center and radii before the click, one undo step (`tangentCircle`). A VectorCraft addition: headline numbers unchanged.
- 2026-11-18: Common Tangents also takes a point (a path of one anchor) and a convex closed path: the lines from the point that touch the path, and the line from the point to the path's center if asked; a point on the outline gets the one tangent there, and a point inside gets none, with a message (#7846). A VectorCraft addition: headline numbers unchanged.
- 2026-11-15: With Smart Guides and Snap to Tangent on, a Line Segment drag pressed on one convex curved path and dragged near another lands on a common tangent of the two: both ends move to where the line touches the paths, each labeled "tangent" (#7845). A VectorCraft addition: headline numbers unchanged.
- 2026-11-17: Three-Point Arc tool, in the Line Segment tool's group after the Arc tool: two ends placed by a drag or two clicks, then a third point the open circular arc passes through, or with Third Point Sets Direction (Tool Options, or `]` while drawing) the direction the arc leaves an end in; it previews the arc, its center and, with Measurement Labels on, its radius, and draws it in one undo step (`shape.threePointArc`). Points with no arc are refused with a message. A VectorCraft addition: headline numbers unchanged.
- 2026-11-15: Smooth Bridge joins the Path Precision Tools add-on (Object › Plug-ins › Path Precision Tools): two selected circles become one closed outline joined by two concave arcs that touch both circles, so every anchor is smooth; the arcs' radius is a percentage of the smaller circle's radius (1 to 1000%, 100% by default), and Keep Originals adds the outline above the circles instead of replacing them. A dialog with Preview, one undo step (`addon.pathtools.bridge`). A VectorCraft addition: headline numbers unchanged.
- 2026-11-18: Smooth Bridge also joins three or more circles: every two whose outlines are within Reach (10 pt by default) are joined, the bridges that connect become one shape each, and a circle bridged to no other stays as it is (at most 2000 circles); with Constant Gap the arcs' radius is the smaller circle's radius plus a gap (#8030). A VectorCraft addition: headline numbers unchanged.
- 2026-11-03: Text Tweaker, the first tool of the Type Tools add-on (Object › Plug-ins › Type Tools): one character attribute (size, baseline shift, rotation, horizontal or vertical scale, tracking, leading or stroke weight) goes letter by letter from a start value to an end value along a straight ramp, an ease, a bow, a spike or at random with a seed, set as the Character panel sets it, while the text stays live; a dialog with Preview, one undo step (`addon.type.textTweaker`, #4924). A VectorCraft addition: headline numbers unchanged.
+1
View File
@@ -246,6 +246,7 @@ fn with_stores(mut h: Headless) -> Headless {
prefs_dir::attach_script_data(&mut h.session);
prefs_dir::attach_metadata_templates_dir(&mut h.session);
prefs_dir::attach_new_doc_profiles(&mut h.session);
prefs_dir::attach_proof_setups(&mut h.session);
prefs_dir::attach_profile_store(&mut h.session);
prefs_dir::attach_color_settings(&mut h.session);
prefs_dir::attach_plugin_store(&mut h.session);
+1 -1
View File
@@ -17,7 +17,7 @@ path = "src/main.rs"
vectorcraft-engine = { workspace = true, features = ["bundled-fonts", "heif"] }
vectorcraft-ui-egui = { workspace = true }
# The page command API (storytold/craft-libs#413): the request plumbing behind window.vectorcraft.
craft-web-api = { git = "https://github.com/storytold/craft-libs", rev = "64b181977a0488e4d1e167bc5cc8cfededc2ed4b", version = "0.1.0" }
craft-web-api = { git = "https://github.com/storytold/craft-libs", rev = "50b0ee7bf811e363b5f238382b5c77318cf33e46", version = "0.1.0" }
vectorcraft-format = { workspace = true }
vectorcraft-text = { workspace = true }
egui = { workspace = true }
+1
View File
@@ -554,6 +554,7 @@ fn main() -> std::process::ExitCode {
// File Info's metadata templates live in their own folder next to the preferences.
prefs_dir::attach_metadata_templates_dir(&mut session);
prefs_dir::attach_new_doc_profiles(&mut session);
prefs_dir::attach_proof_setups(&mut session);
prefs_dir::attach_script_data(&mut session);
let mut app = VectorcraftApp::new(session, services(cc.winit_window().cloned(), cc.egui_ctx.clone()));
app.set_startup_update_check(true);
+8
View File
@@ -81,6 +81,14 @@ pub fn attach_new_doc_profiles(session: &mut vectorcraft_engine::Session) {
}
}
/// Have View › Proof Setup list the proof setups saved in the `Proof Setups` folder, which
/// `view.proofSetup.save` makes when it saves a setup by name.
pub fn attach_proof_setups(session: &mut vectorcraft_engine::Session) {
if let Some(dir) = store_dir("Proof Setups") {
session.attach_proof_setups(dir);
}
}
/// Keep each script's `Folder.userData` in the `Script Data` folder, and the file access people
/// allow scripts with Always in `Script Grants.json` beside it. Both are made when a script first
/// needs them.
+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M4 18 A8.67 8.67 0 1 1 20 18"/><circle cx="4" cy="18" r="1.6"/><circle cx="12" cy="6" r="1.6"/><circle cx="20" cy="18" r="1.6"/></svg>

After

Width:  |  Height:  |  Size: 327 B

+5 -41
View File
@@ -534,47 +534,13 @@ fn plain(by_pen: &[Vec<Vec<(i64, i64)>>]) -> Vec<u8> {
/// HP-GL/2: `IN;`, the palette, each pen's paths as one `PE`, `PU;SP0;`.
fn encoded(by_pen: &[Vec<Vec<(i64, i64)>>], pens: &[[u8; 3]]) -> Vec<u8> {
let mut out = b"IN;".to_vec();
if !pens.is_empty() {
// Pens 1 to n on a plotter, and on a raster device (whose pens are 0 to NP − 1) too.
let np = (pens.len() + 1).next_power_of_two().max(2);
out.extend(format!("NP{np};").bytes());
for (i, [r, g, b]) in pens.iter().enumerate() {
out.extend(format!("PC{},{r},{g},{b};", i + 1).bytes());
}
}
let mut at: Option<(i64, i64)> = None;
for (i, paths) in by_pen.iter().enumerate().filter(|(_, p)| !p.is_empty()) {
out.extend(format!("PU;SP{};PE", i + 1).bytes());
for path in paths {
for (k, &p) in path.iter().enumerate() {
if k == 0 {
out.push(b'<');
}
// The first move of the plot is absolute, and so is one longer than the range a
// device takes for each number; every other is relative.
match at.map(|a| (p.0 - a.0, p.1 - a.1)).filter(|d| d.0.abs() <= MAX_COORD && d.1.abs() <= MAX_COORD) {
None => {
out.push(b'=');
pe_number(&mut out, p.0);
pe_number(&mut out, p.1);
}
Some((dx, dy)) => {
pe_number(&mut out, dx);
pe_number(&mut out, dy);
}
}
at = Some(p);
}
}
out.push(b';');
}
out.extend(b"PU;SP0;");
out
let pens: Vec<_> = pens.iter().enumerate().map(|(index, &rgb)| craft_plotter::hpgl::write::Pen { number: index + 1, rgb }).collect();
craft_plotter::hpgl::write::write_hpgl2(&pens, by_pen)
}
/// `v` as a base-64 PE number: the sign in the low bit, the low digits from 63 up and the last
/// digit from 191 up.
#[cfg(test)]
fn pe_number(out: &mut Vec<u8>, v: i64) {
let mut n = (v.unsigned_abs() << 1) | u64::from(v < 0);
while n >= 64 {
@@ -973,10 +939,8 @@ impl<'a> Walk<'a> {
end(&mut cur, &mut out, false);
cur.push(p);
}
PathEl::LineTo(p) => {
if cur.last() != Some(&p) {
cur.push(p);
}
PathEl::LineTo(p) if cur.last() != Some(&p) => {
cur.push(p);
}
PathEl::ClosePath => {
let s = cur.first().copied();
+19
View File
@@ -1179,6 +1179,25 @@ fn encoded_numbers_follow_the_reference_guide() {
assert_eq!(out, [194, 191]);
}
/// The app adapter must preserve raw bytes and position across the one-based pen table.
#[test]
fn hpgl2_shared_writer_preserves_raw_bytes_and_pen_indices() {
let paths = vec![vec![vec![(32, -32)]], vec![], vec![vec![(33, -31)], vec![(34, -30)]]];
let pens = [[1, 2, 3], [4, 5, 6], [7, 8, 9]];
assert_eq!(encoded(&paths, &pens), b"IN;NP4;PC1,1,2,3;PC2,4,5,6;PC3,7,8,9;PU;SP1;PE<=?\xc0@\xc0;PU;SP3;PE<\xc1\xc1<\xc1\xc1;PU;SP0;");
}
#[test]
fn hpgl2_shared_writer_preserves_empty_and_last_admitted_pen() {
assert_eq!(encoded(&[], &[]), b"IN;PU;SP0;");
let pens = vec![[0, 0, 0]; MAX_PENS];
let mut paths = vec![vec![]; MAX_PENS];
paths[MAX_PENS - 1] = vec![vec![(0, 0)]];
let bytes = encoded(&paths, &pens);
assert!(bytes.starts_with(b"IN;NP256;PC1,0,0,0;"));
assert!(bytes.ends_with(b"PC255,0,0,0;PU;SP255;PE<=\xbf\xbf;PU;SP0;"));
}
#[test]
fn hpgl2_writes_the_palette_and_encoded_polylines() {
let out = plot(&three(), &HpglOptions { version: Version::Hpgl2, ..opts(&three()) });
+109 -6
View File
@@ -458,6 +458,15 @@ impl Cms {
CmykSpace::Generic(g) => g.to_srgb(cmyk, absolute, bpc),
CmykSpace::Device => naive_cmyk_to_rgb(cmyk),
CmykSpace::Icc(p) => {
// With black-point compensation the profile's black maps onto sRGB black, as
// `cmyk_to_srgb` shows the working space.
if bpc
&& !absolute
&& let Some(srgb) = builtin_rgb_cache(SRGB)
&& let Some(v) = p.to_rgb_of(&srgb, &cmyk, Intent::RelativeColorimetric, true)
{
return v;
}
let i = if absolute { Intent::AbsoluteColorimetric } else { Intent::RelativeColorimetric };
p.to_srgb(&cmyk, i).unwrap_or_else(|| naive_cmyk_to_rgb(cmyk))
}
@@ -676,32 +685,108 @@ impl Cms {
ProofTarget::Tritanopia => TRITANOPIA.simulate(srgb),
ProofTarget::WorkingCmyk => {
let working = self.working_cms();
let cmyk = working.srgb_to_cmyk(srgb, proof.intent);
working.cmyk_to_srgb(cmyk, proof.simulate_paper)
let cmyk = if proof.preserve_numbers { self.preserved_cmyk(srgb) } else { working.srgb_to_cmyk(srgb, proof.intent) };
self.proof_cmyk_to_srgb(cmyk, proof)
}
ProofTarget::Cmyk(name) => match cmyk_space(name) {
Ok(sp) => {
let cmyk = Self::srgb_to_cmyk_in(&sp, srgb, proof.intent, self.settings.bpc);
Self::cmyk_to_srgb_in(&sp, cmyk, proof.simulate_paper, self.settings.bpc)
let cmyk = if proof.preserve_numbers {
self.preserved_cmyk(srgb)
} else {
Self::srgb_to_cmyk_in(&sp, srgb, proof.intent, self.settings.bpc)
};
self.proof_cmyk_to_srgb(cmyk, proof)
}
Err(_) => srgb,
},
ProofTarget::Rgb(name) => match rgb_space(canonical_name(name)) {
Ok(RgbSpace::Srgb) if !proof.preserve_numbers => srgb,
Ok(RgbSpace::Srgb) => self.srgb_to_rgb(srgb).map(|v| v.clamp(0.0, 1.0)),
Ok(RgbSpace::Icc(p)) => {
// The device's own numbers for the color: the document's RGB numbers unchanged,
// or the color converted into the device's space with the proof's intent.
let numbers = if proof.preserve_numbers {
self.srgb_to_rgb(srgb)
} else {
p.from_srgb(srgb, proof.intent).and_then(|v| Some([*v.first()?, *v.get(1)?, *v.get(2)?])).unwrap_or(srgb)
};
p.to_srgb(&numbers, Intent::RelativeColorimetric).unwrap_or(srgb)
}
Err(_) => srgb,
},
}
}
/// Display sRGB of color `c` proofed with Preserve Numbers on a CMYK or RGB device: its own
/// numbers go to the device unchanged. A CMYK device takes a CMYK color's inks as they are, a
/// gray as K only and another color's inks in this context's CMYK space (relative
/// colorimetric); an RGB device takes an RGB color's numbers as they are and another color's
/// numbers in this context's RGB space. Other targets proof the color's display sRGB
/// ([`Self::proof_srgb`]).
pub fn proof_color(&self, c: &Color, proof: &ProofSetup) -> [f32; 3] {
if !proof.preserve_numbers {
return self.proof_srgb(self.display_rgb(c), proof);
}
match &proof.target {
// A device whose profile is not loaded leaves the color as it is, as for a pixel.
ProofTarget::Cmyk(name) if cmyk_space(name).is_err() => self.display_rgb(c),
ProofTarget::WorkingCmyk | ProofTarget::Cmyk(_) => self.proof_cmyk_to_srgb(self.to_cmyk(c, Intent::RelativeColorimetric), proof),
ProofTarget::Rgb(name) => {
// A CMYK color converts straight into the RGB space, so a wide space keeps it.
let numbers = match self.convert(c, Model::Rgb, Intent::RelativeColorimetric) {
Color::Rgb { r, g, b } => [r, g, b],
other => self.srgb_to_rgb(self.display_rgb(&other)),
}
.map(|v| v.clamp(0.0, 1.0));
match rgb_space(canonical_name(name)) {
Ok(RgbSpace::Srgb) => numbers,
Ok(RgbSpace::Icc(p)) => p.to_srgb(&numbers, Intent::RelativeColorimetric).unwrap_or(numbers),
Err(_) => self.display_rgb(c),
}
}
_ => self.proof_srgb(self.display_rgb(c), proof),
}
}
/// The CMYK numbers display sRGB `srgb` has in this context's CMYK space (relative
/// colorimetric), which Preserve CMYK Numbers sends to the simulated device unchanged: for
/// pixels whose own numbers are not known (an RGB image's pixels, art drawn over other art).
/// A color whose numbers are known proofs through [`Self::proof_color`].
fn preserved_cmyk(&self, srgb: [f32; 3]) -> [f32; 4] {
self.srgb_to_cmyk(srgb, Intent::RelativeColorimetric)
}
/// Display sRGB of CMYK inks in the proof's CMYK space (this context's CMYK space for RGB
/// targets).
/// targets). Simulate Paper Color shows the paper's color and the press black (absolute
/// colorimetric); else Simulate Black Ink shows the press black as the dark gray it prints
/// (media-relative, without black-point compensation).
pub fn proof_cmyk_to_srgb(&self, cmyk: [f32; 4], proof: &ProofSetup) -> [f32; 3] {
let black = proof.simulate_black && !proof.simulate_paper;
match &proof.target {
ProofTarget::Cmyk(name) => match cmyk_space(name) {
Ok(sp) if black => Self::black_ink_srgb(&sp, cmyk),
Ok(sp) => Self::cmyk_to_srgb_in(&sp, cmyk, proof.simulate_paper, self.settings.bpc),
Err(_) => self.cmyk_to_srgb(cmyk, proof.simulate_paper),
},
ProofTarget::WorkingCmyk if black => Self::black_ink_srgb(&self.working_cms().cmyk, cmyk),
ProofTarget::WorkingCmyk => self.working_cms().cmyk_to_srgb(cmyk, proof.simulate_paper),
_ => self.cmyk_to_srgb(cmyk, proof.simulate_paper),
}
}
/// Display sRGB of `cmyk` in `space`, media-relative and without black-point compensation, so
/// the darkest ink the space prints shows as the gray it is rather than as black.
fn black_ink_srgb(space: &CmykSpace, cmyk: [f32; 4]) -> [f32; 3] {
let cmyk = cmyk.map(|v| v.clamp(0.0, 1.0));
if let CmykSpace::Icc(p) = space
&& let Some(srgb) = builtin_rgb_cache(SRGB)
&& let Some(v) = p.to_rgb_of(&srgb, &cmyk, Intent::RelativeColorimetric, false)
{
return v;
}
Self::cmyk_to_srgb_in(space, cmyk, false, false)
}
/// The context of the working settings: the one [`use_document_profiles`] put a document's
/// profiles in place of, else this one.
fn working_cms(&self) -> &Cms {
@@ -711,7 +796,10 @@ impl Cms {
/// A cached 3-D lookup table implementing [`Cms::proof_srgb`] for 8-bit pixels.
pub fn proof_lut(&self, proof: &ProofSetup) -> Arc<ProofLut> {
let working = self.working.as_ref().map(|w| &w.settings);
let key = format!("{:?}|{working:?}|{:?}|{:?}|{}", self.settings, proof.target, proof.intent, proof.simulate_paper);
let key = format!(
"{:?}|{working:?}|{:?}|{:?}|{}|{}|{}",
self.settings, proof.target, proof.intent, proof.simulate_paper, proof.preserve_numbers, proof.simulate_black
);
let mut cache = PROOF_CACHE.lock().unwrap_or_else(|e| e.into_inner());
if let Some((_, l)) = cache.iter().find(|(k, _)| *k == key) {
return l.clone();
@@ -860,6 +948,8 @@ pub enum ProofTarget {
WorkingCmyk,
/// A specific CMYK profile (Customize…).
Cmyk(String),
/// A specific RGB profile (Customize…): the color as that RGB device shows it.
Rgb(String),
/// Legacy Macintosh RGB (Gamma 1.8).
LegacyMacRgb,
/// Internet Standard RGB (sRGB).
@@ -879,6 +969,9 @@ impl ProofTarget {
if let Some(p) = s.strip_prefix("cmyk:") {
return Some(ProofTarget::Cmyk(p.to_string()));
}
if let Some(p) = s.strip_prefix("rgb:") {
return Some(ProofTarget::Rgb(p.to_string()));
}
Some(match s {
"workingCmyk" | "cmyk" => ProofTarget::WorkingCmyk,
"legacyMacRgb" | "macRgb" => ProofTarget::LegacyMacRgb,
@@ -894,6 +987,7 @@ impl ProofTarget {
match self {
ProofTarget::WorkingCmyk => "workingCmyk".into(),
ProofTarget::Cmyk(p) => format!("cmyk:{p}"),
ProofTarget::Rgb(p) => format!("rgb:{p}"),
ProofTarget::LegacyMacRgb => "legacyMacRgb".into(),
ProofTarget::Srgb => "srgb".into(),
ProofTarget::MonitorRgb => "monitorRgb".into(),
@@ -917,6 +1011,15 @@ pub struct ProofSetup {
/// Simulate Paper Color (absolute colorimetric display of the press).
#[serde(default)]
pub simulate_paper: bool,
/// Preserve CMYK Numbers (a CMYK device) or Preserve RGB Numbers (an RGB device): the colors'
/// numbers go to the device unchanged instead of being converted into its space with
/// `intent`.
#[serde(default)]
pub preserve_numbers: bool,
/// Simulate Black Ink: the press black shows as the dark gray it prints (a CMYK device; implied
/// by `simulate_paper`).
#[serde(default)]
pub simulate_black: bool,
/// Separations Preview: names of the visible plates ("Cyan", "Magenta", "Yellow", "Black",
/// spot swatch names). `None` = normal composite proof.
#[serde(default, skip_serializing_if = "Option::is_none")]
+94
View File
@@ -194,6 +194,100 @@ fn colour_blindness_proofs() {
assert_eq!(ProofTarget::parse(&ProofTarget::Cmyk("X".into()).id()), Some(ProofTarget::Cmyk("X".into())));
}
/// Proof Setup › Customize: Simulate Black Ink shows the press black of a CMYK device as the dark
/// gray it prints, where the proof otherwise shows it as black; Simulate Paper Color shows it so
/// as well, on the paper's color.
#[test]
fn simulate_black_ink_shows_the_press_black_as_gray() {
let c = cms();
let device = ProofSetup { target: ProofTarget::Cmyk(GENERIC_CMYK.into()), ..Default::default() };
let black = ProofSetup { simulate_black: true, ..device.clone() };
let paper = ProofSetup { simulate_paper: true, ..device.clone() };
let plain = c.proof_srgb([0.0; 3], &device);
let gray = c.proof_srgb([0.0; 3], &black);
assert!(plain.iter().all(|v| *v < 0.02), "black stays black: {plain:?}");
assert!(gray.iter().all(|v| *v > 0.05), "the press black shows as a gray: {gray:?}");
assert_eq!(c.proof_srgb([1.0; 3], &black), [1.0; 3], "the paper stays white");
assert!(c.proof_srgb([0.0; 3], &paper).iter().all(|v| *v > 0.05));
// The working CMYK target, and the inks Separations Preview shows, follow it too.
let working = ProofSetup { target: ProofTarget::WorkingCmyk, simulate_black: true, ..Default::default() };
assert_eq!(c.proof_srgb([0.0; 3], &working), gray);
assert!(c.proof_cmyk_to_srgb([0.0, 0.0, 0.0, 1.0], &black)[0] > c.proof_cmyk_to_srgb([0.0, 0.0, 0.0, 1.0], &device)[0] + 0.05);
// The table the canvas draws through is made for each setting.
assert!(de(c.proof_lut(&black).apply([0.0; 3]), gray) < 2.5);
assert!(de(c.proof_lut(&device).apply([0.0; 3]), plain) < 2.5);
}
/// Preserve CMYK Numbers sends the color's CMYK numbers in the document's space to the simulated
/// device unchanged: with Device CMYK as the working space, K50 shows as the simulated press
/// prints K50 (darker, with its dot gain). Without it the color is converted into the device's
/// space with the intent, and the gray looks as it does on screen.
#[test]
fn preserve_cmyk_numbers_sends_the_numbers_unchanged() {
let dev = Cms::new(&ColorSettings { cmyk: DEVICE_CMYK.into(), ..Default::default() }).unwrap();
let press = Cms::new(&ColorSettings::default()).unwrap();
let k50 = [0.0, 0.0, 0.0, 0.5];
let gray = dev.cmyk_to_srgb(k50, false);
let device = ProofSetup { target: ProofTarget::Cmyk(GENERIC_CMYK.into()), ..Default::default() };
let preserved = dev.proof_srgb(gray, &ProofSetup { preserve_numbers: true, ..device.clone() });
let want = press.cmyk_to_srgb(k50, false);
assert!(de(preserved, want) < 0.5, "{preserved:?} vs {want:?}");
let converted = dev.proof_srgb(gray, &device);
assert!(de(converted, gray) < 1.5, "{converted:?} vs {gray:?}");
assert!(de(converted, preserved) > 3.0, "{converted:?} vs {preserved:?}");
// With the numbers preserved the intent is not used.
let perceptual = ProofSetup { intent: Intent::Perceptual, preserve_numbers: true, ..device };
assert_eq!(dev.proof_srgb(gray, &perceptual), preserved);
}
/// An RGB profile as the device to simulate: with Preserve RGB Numbers the document's RGB numbers
/// show as that device shows them (sRGB numbers on a Display P3 device look more saturated);
/// without it a color the device can show looks the same, and one it can't show is clipped.
#[test]
fn rgb_device_proofs_show_the_device_numbers() {
let c = cms();
let p3 = ProofSetup { target: ProofTarget::Rgb(DISPLAY_P3.into()), ..Default::default() };
assert_eq!(ProofTarget::parse(&p3.target.id()), Some(p3.target.clone()));
assert_eq!(p3.target.id(), format!("rgb:{DISPLAY_P3}"));
assert!(!p3.target.is_cmyk());
let red = [0.7, 0.3, 0.25];
let converted = c.proof_srgb(red, &p3);
assert!(de(converted, red) < 1.0, "{converted:?}");
let preserved = c.proof_srgb(red, &ProofSetup { preserve_numbers: true, ..p3.clone() });
assert!(preserved[0] > red[0] + 0.02 && preserved[1] < red[1] - 0.02, "{preserved:?}");
// An RGB color's own numbers give the same proof.
let own = c.proof_color(&Color::rgb(red[0], red[1], red[2]), &ProofSetup { preserve_numbers: true, ..p3.clone() });
assert!(de(own, preserved) < 0.01, "{own:?} vs {preserved:?}");
// sRGB numbers on an sRGB device: as they are either way.
let srgb = ProofSetup { target: ProofTarget::Rgb(SRGB.into()), preserve_numbers: true, ..Default::default() };
assert!(de(c.proof_srgb(red, &srgb), red) < 0.01);
// A wider working space's numbers on an sRGB device: its green clips to sRGB green.
let wide = Cms::new(&ColorSettings { rgb: WIDE_GAMUT_RGB.into(), ..Default::default() }).unwrap();
let green = wide.rgb_to_srgb([0.2, 0.8, 0.2]);
let shown = wide.proof_srgb(green, &srgb);
assert!(de(shown, green) > 3.0, "the wide space's numbers show as sRGB numbers: {shown:?}");
// A profile that is gone leaves the colors as they are.
let gone = ProofSetup { target: ProofTarget::Rgb("Nope".into()), ..Default::default() };
assert_eq!(c.proof_srgb(red, &gone), red);
}
/// A CMYK device whose profile is not loaded leaves a color as the screen shows it, with Preserve
/// CMYK Numbers on as well as off, the same as for a pixel of that color.
#[test]
fn missing_cmyk_device_leaves_colors_as_they_are() {
let c = cms();
let gone = ProofSetup { target: ProofTarget::Cmyk("Nope".into()), preserve_numbers: true, ..Default::default() };
let blue = Color::rgb(0.0, 0.0, 1.0);
let shown = c.display_rgb(&blue);
assert_eq!(c.proof_color(&blue, &gone), shown);
assert_eq!(c.proof_srgb(shown, &gone), shown);
let off = ProofSetup { preserve_numbers: false, ..gone.clone() };
assert_eq!(c.proof_color(&blue, &off), shown);
// A CMYK color keeps its inks' display color.
let ink = Color::Cmyk { c: 0.2, m: 0.7, y: 0.1, k: 0.05 };
assert!(de(c.proof_color(&ink, &gone), c.display_rgb(&ink)) < 0.01);
}
/// The expected colors were computed separately with NumPy from the same published inputs (linear
/// sRGB to XYZ from IEC 61966-2-1, Smith & Pokorny's XYZ to LMS, Judd-Vos XYZ at 485 nm and 660 nm),
/// following Brettel, Viénot & Mollon (1997) with the display's white as the neutral axis.
+19
View File
@@ -187,6 +187,25 @@ fn black_point_compensation_maps_the_darkest_ink_to_rgb_black() {
assert_eq!(abs(true), abs(false));
}
/// A loaded ICC CMYK profile as Proof Setup's device shows its darkest ink with the settings'
/// black-point compensation, as the working CMYK proof of the same profile does, and Simulate
/// Black Ink shows it as the lighter gray the press prints.
#[test]
fn simulate_black_ink_shows_a_loaded_cmyk_profiles_black_as_gray() {
let c = icc_cmyk(true);
let k100 = [0.0, 0.0, 0.0, 1.0];
let device = ProofSetup { target: ProofTarget::Cmyk(c.settings().cmyk.clone()), ..Default::default() };
let plain = c.proof_cmyk_to_srgb(k100, &device);
let working = c.proof_cmyk_to_srgb(k100, &ProofSetup { target: ProofTarget::WorkingCmyk, ..Default::default() });
assert!(plain.iter().zip(working).all(|(a, b)| (a - b).abs() < 0.01), "device {plain:?}, working {working:?}");
let black = c.proof_cmyk_to_srgb(k100, &ProofSetup { simulate_black: true, ..device.clone() });
assert!(plain.iter().zip(black).all(|(a, b)| b > a + 0.03), "black ink {black:?}, without {plain:?}");
// Without black-point compensation the device shows the darkest ink as the press prints it.
let off = icc_cmyk(false);
let plain_off = off.proof_cmyk_to_srgb(k100, &ProofSetup { target: ProofTarget::Cmyk(off.settings().cmyk.clone()), ..Default::default() });
assert!(plain_off.iter().zip(black).all(|(a, b)| (a - b).abs() < 0.02), "without compensation {plain_off:?}, black ink {black:?}");
}
/// #1584: every built-in profile (RGB, CMYK and gray) has each tag on a 4-byte boundary and a size
/// that is a multiple of 4 (ICC.1 §7.1.2), and still reads back as the same space.
#[test]
+6 -3
View File
@@ -621,7 +621,8 @@ impl Gradient {
}
/// Stops expanded so that midpoints are represented as explicit stops (for renderers without
/// midpoints), and a Perceptual gradient's segments as stops on its curve (for renderers that
/// mix linearly; within [`PERCEPTUAL_TOLERANCE`] of it).
/// mix linearly; within [`PERCEPTUAL_TOLERANCE`] of it). A stop between two stops of the same
/// color is that color, as it is, so paper white or a tint stays exact.
pub fn expanded_stops(&self) -> Vec<(f32, Color, f32)> {
self.expanded().map(|(t, c, o, _)| (t, c, o)).collect()
}
@@ -638,6 +639,9 @@ impl Gradient {
// Otherwise (repeated or unsorted offsets) each midpoint is looked up as `sample` would
// find it, but by binary search: a scan of all the stops per midpoint cost their square.
let reach = if increasing || !self.method.is_classic() { None } else { Some(StopReach::new(&self.stops)) };
// Two stops of the same color mix to that color, as it is: a mix through display RGB or
// OKLab would change its model or round its numbers.
let mix = move |a: &Color, b: &Color, v| if a == b { *a } else { self.method.mix(a, b, v) };
self.stops.iter().enumerate().flat_map(move |(i, s)| {
let next = self.stops.get(i + 1);
let off_centre = (s.midpoint - 0.5).abs() > 1e-3;
@@ -646,7 +650,6 @@ impl Gradient {
let t = s.offset + (n.offset - s.offset) * s.midpoint;
// Mixed from the two stops it lies between, as `sample` would: searching all the
// stops again for each midpoint made many stops cost their square.
let mix = |a: &Color, b: &Color, v| self.method.mix(a, b, v);
let (c, o) = match &reach {
Some(reach) => reach.sample_with(&self.stops, t, &mix),
None => between(s, n, t, &mix),
@@ -661,7 +664,7 @@ impl Gradient {
let mid = v == 0.5;
let t = curve_offset(s, n, v);
let o = s.opacity + (n.opacity - s.opacity) * v;
(t, self.method.mix(&s.color, &n.color, v), o, (mid && off_centre).then_some(s.midpoint), None)
(t, mix(&s.color, &n.color, v), o, (mid && off_centre).then_some(s.midpoint), None)
})
});
std::iter::once((s.offset, s.color, s.opacity, None, Some(i))).chain(classic).chain(perceptual.into_iter().flatten())
+97
View File
@@ -10,6 +10,7 @@ pub mod freeform;
pub mod gradient;
pub mod harmony;
pub mod libraries;
pub mod oklab;
pub mod palette_io;
pub mod recolor;
pub mod swatch;
@@ -340,6 +341,49 @@ pub fn hsb_to_rgb([h, s, v]: [f32; 3]) -> [f32; 3] {
[r + m, g + m, b + m]
}
/// HSL (hue in degrees 0..360, saturation and lightness 0..1) of RGB numbers 0..1, with no color
/// conversion, as CSS Color 4 converts sRGB to HSL
/// (<https://www.w3.org/TR/css-color-4/#rgb-to-hsl>). The hue is 0 while the saturation is
/// powerless, and a color outside 0..1 that gives a negative saturation turns its hue by 180°. As in
/// the specification's conversion, a lightness of 0.00001 or less, a lightness less than 0.00001
/// below 1, or a saturation of 0.00001 or less reads as a gray.
pub fn rgb_to_hsl([r, g, b]: [f32; 3]) -> [f32; 3] {
const EPSILON: f32 = 1e-5;
let max = r.max(g).max(b);
let min = r.min(g).min(b);
let d = max - min;
let l = (max + min) / 2.0;
if d <= 0.0 {
return [0.0, 0.0, l];
}
let mut s = if l.abs() <= EPSILON || (1.0 - l).abs() < EPSILON { 0.0 } else { (max - l) / l.min(1.0 - l) };
let mut h = rgb_to_hsb([r, g, b])[0];
if s < 0.0 {
h += 180.0;
s = -s;
}
if s <= EPSILON {
return [0.0, 0.0, l];
}
let h = h.rem_euclid(360.0);
[if h >= 360.0 { 0.0 } else { h }, s, l]
}
/// RGB numbers 0..1 of HSL `[h, s, l]` (hue in degrees, saturation and lightness 0..1), as CSS
/// Color 4 converts HSL to sRGB (<https://www.w3.org/TR/css-color-4/#hsl-to-rgb>): the inverse of
/// [`rgb_to_hsl`]. A hue outside 0..360 wraps into that range before the conversion, so -120°
/// gives the color of 240° and a hue of 10,000,000,000° the color of 280°. The specification's
/// sample code uses JavaScript's remainder operator and gives a different color for a negative hue.
pub fn hsl_to_rgb([h, s, l]: [f32; 3]) -> [f32; 3] {
let h = h.rem_euclid(360.0);
let a = s * l.min(1.0 - l);
let f = |n: f32| {
let k = (n + h / 30.0).rem_euclid(12.0);
l - a * (k - 3.0).min(9.0 - k).clamp(-1.0, 1.0)
};
[f(0.0), f(8.0), f(4.0)]
}
/// `new` expressed in the colour model of `orig` ([`Color::in_model`]): results of colour operations
/// (harmonies, blends, inversions, recolouring) keep the model of the colour they came from.
pub fn keep_model(orig: Color, new: Color) -> Color {
@@ -499,6 +543,59 @@ mod tests {
}
}
/// The HSL examples of CSS Color 4, section 7 (<https://www.w3.org/TR/css-color-4/#the-hsl-notation>),
/// the first six rows, and two hues outside 0..360 that wrap into that range.
#[test]
fn hsl_follows_css_color_4() {
for (hsl, hex) in [
([0.0, 1.0, 0.5], "#ff0000"),
([120.0, 1.0, 0.5], "#00ff00"),
([120.0, 1.0, 0.25], "#008000"),
([120.0, 1.0, 0.75], "#80ff80"),
([240.0, 1.0, 0.5], "#0000ff"),
([60.0, 1.0, 0.5], "#ffff00"),
([360.0, 1.0, 0.5], "#ff0000"),
([-120.0, 1.0, 0.5], "#0000ff"),
] {
let [r, g, b] = hsl_to_rgb(hsl);
assert_eq!(Color::rgb(r, g, b).to_hex(), hex, "{hsl:?}");
}
let [h, s, l] = rgb_to_hsl([1.0, 0.5, 0.0]);
assert!((h - 30.0).abs() < 1e-4 && (s - 1.0).abs() < 1e-6 && (l - 0.5).abs() < 1e-6, "{h} {s} {l}");
let [h, s, l] = rgb_to_hsl(Color::rgb8(255, 128, 0).to_rgb_uncalibrated());
assert!((h - 30.0).abs() < 0.2 && (s - 1.0).abs() < 1e-6 && (l - 0.5).abs() < 1e-3, "{h} {s} {l}");
// A gray has no hue: the hue is 0 and the saturation 0, at any lightness.
for v in [0.0, 0.25, 0.5, 1.0] {
assert_eq!(rgb_to_hsl([v, v, v]), [0.0, 0.0, v]);
}
// Black and white keep any hue and saturation they are given.
assert_eq!(hsl_to_rgb([200.0, 0.7, 0.0]), [0.0, 0.0, 0.0]);
assert_eq!(hsl_to_rgb([200.0, 0.7, 1.0]), [1.0, 1.0, 1.0]);
// A color past the gamut that gives a negative saturation turns its hue by 180°.
let [h, s, _] = rgb_to_hsl([1.2, 1.5, 1.4]);
assert!(s > 0.0 && (h - (160.0 + 180.0)).abs() < 1e-3, "{h} {s}");
// A huge hue wraps before the channels are worked out: 10,000,000,000° is 280°.
let (huge, wrapped) = (hsl_to_rgb([10_000_000_000.0, 1.0, 0.5]), hsl_to_rgb([280.0, 1.0, 0.5]));
assert!((0..3).all(|i| (huge[i] - wrapped[i]).abs() < 1e-6), "{huge:?} {wrapped:?}");
}
/// The 216 web colors go to HSL and back to the same 8-bit color.
#[test]
fn hsl_roundtrip() {
let steps = [0x00, 0x33, 0x66, 0x99, 0xcc, 0xff];
for r in steps {
for g in steps {
for b in steps {
let c = Color::rgb8(r, g, b);
let [h, s, l] = rgb_to_hsl(c.to_rgb_uncalibrated());
assert!((0.0..360.0).contains(&h) && (0.0..=1.0).contains(&s) && (0.0..=1.0).contains(&l), "{}", c.to_hex());
let back = hsl_to_rgb([h, s, l]).map(|v| (v * 255.0).round() as u8);
assert_eq!(back, [r, g, b], "{}", c.to_hex());
}
}
}
}
#[test]
fn cmyk_conversions() {
assert_eq!(Color::cmyk(0.0, 0.0, 0.0, 1.0).to_rgb_uncalibrated(), [0.0, 0.0, 0.0]);
+14 -6
View File
@@ -99,18 +99,24 @@ pub fn builtin_library(id: &str) -> Option<Arc<SwatchLibrary>> {
// ---------- colour construction ----------
/// sRGB (0..=1, gamma encoded) of OKLab `(l, a, b)`, unclamped.
/// sRGB (0..=1, gamma encoded) of OKLab `(l, a, b)`, unclamped. A linear channel below
/// −0.0031308 is encoded with the curve's sign turned, as CSS Color 4's extended sRGB does
/// (<https://www.w3.org/TR/css-color-4/#color-conversion-code>).
pub(crate) fn oklab_to_srgb(l: f64, a: f64, b: f64) -> [f64; 3] {
oklab_to_linear_srgb(l, a, b).map(|v| if v.abs() <= 0.003_130_8 { 12.92 * v } else { v.signum() * (1.055 * v.abs().powf(1.0 / 2.4) - 0.055) })
}
/// Linear sRGB of OKLab `(l, a, b)`, unclamped.
pub(crate) fn oklab_to_linear_srgb(l: f64, a: f64, b: f64) -> [f64; 3] {
let l_ = l + 0.396_337_777_4 * a + 0.215_803_757_3 * b;
let m_ = l - 0.105_561_345_8 * a - 0.063_854_172_8 * b;
let s_ = l - 0.089_484_177_5 * a - 1.291_485_548_0 * b;
let (l3, m3, s3) = (l_ * l_ * l_, m_ * m_ * m_, s_ * s_ * s_);
let lin = [
[
4.076_741_662_1 * l3 - 3.307_711_591_3 * m3 + 0.230_969_929_2 * s3,
-1.268_438_004_6 * l3 + 2.609_757_401_1 * m3 - 0.341_319_396_5 * s3,
-0.004_196_086_3 * l3 - 0.703_418_614_7 * m3 + 1.707_614_701_0 * s3,
];
lin.map(|v| if v <= 0.003_130_8 { 12.92 * v } else { 1.055 * v.powf(1.0 / 2.4) - 0.055 })
]
}
/// OKLab `[l, a, b]` of a colour's display RGB.
@@ -118,11 +124,13 @@ pub fn to_oklab(c: &Color) -> [f64; 3] {
srgb_to_oklab(c.to_rgb_uncalibrated())
}
/// OKLab `[l, a, b]` of sRGB `rgb` (0..=1, gamma encoded).
/// OKLab `[l, a, b]` of sRGB `rgb` (0..=1, gamma encoded). A channel below −0.04045 is decoded
/// with the curve's sign turned, as CSS Color 4's extended sRGB does
/// (<https://www.w3.org/TR/css-color-4/#color-conversion-code>).
pub(crate) fn srgb_to_oklab(rgb: [f32; 3]) -> [f64; 3] {
let [r, g, b] = rgb.map(|v| {
let v = f64::from(v);
if v <= 0.040_45 { v / 12.92 } else { ((v + 0.055) / 1.055).powf(2.4) }
if v.abs() <= 0.040_45 { v / 12.92 } else { v.signum() * ((v.abs() + 0.055) / 1.055).powf(2.4) }
});
let l = (0.412_221_470_8 * r + 0.536_332_536_3 * g + 0.051_445_992_9 * b).cbrt();
let m = (0.211_903_498_2 * r + 0.680_699_545_1 * g + 0.107_396_956_6 * b).cbrt();
+266
View File
@@ -0,0 +1,266 @@
//! OKLCH, the polar form of Oklab, as CSS Color 4 defines it
//! (<https://www.w3.org/TR/css-color-4/#specifying-oklab-oklch>): lightness L from 0 to 1, chroma
//! C (CSS reads 100% as 0.4) and hue H in degrees from the positive `a` axis. The conversions take
//! and give gamma-encoded sRGB through the Oklab matrices of [`crate::libraries`].
use crate::libraries::{oklab_to_linear_srgb, oklab_to_srgb, srgb_to_oklab};
/// The chroma CSS reads as 100%.
pub const CHROMA_FULL: f64 = 0.4;
/// Chroma at or below which the hue is powerless (CSS Color 4's ε); [`to_oklch`] gives hue 0 there.
pub const POWERLESS_CHROMA: f64 = 0.000_004;
/// How far outside 0..=1 an sRGB component may be and still count as inside the gamut.
const GAMUT_SLACK: f64 = 1e-4;
/// OKLCH `[l, c, h°]` of sRGB `rgb` (gamma encoded). Values outside 0..=1 are converted as they
/// are. The hue is in 0..360, and 0 while the chroma is powerless.
pub fn to_oklch(rgb: [f32; 3]) -> [f64; 3] {
let [l, a, b] = srgb_to_oklab(rgb);
let c = a.hypot(b);
if c <= POWERLESS_CHROMA {
return [l, 0.0, 0.0];
}
[l, c, b.atan2(a).to_degrees().rem_euclid(360.0)]
}
/// sRGB (gamma encoded) of OKLCH `(l, c, h°)`, unclamped.
pub fn oklch_to_srgb(l: f64, c: f64, h: f64) -> [f64; 3] {
let (sin, cos) = h.to_radians().sin_cos();
oklab_to_srgb(l, c * cos, c * sin)
}
/// Whether sRGB `rgb` lies inside the sRGB gamut.
pub fn in_srgb(rgb: [f64; 3]) -> bool {
rgb.iter().all(|v| (-GAMUT_SLACK..=1.0 + GAMUT_SLACK).contains(v))
}
/// The largest chroma sRGB holds at lightness `l` and hue `h°`: 0 at or outside black and white.
pub fn max_chroma(l: f64, h: f64) -> f64 {
largest_fitting_chroma(l, h, f64::INFINITY)
}
/// The largest chroma no more than `limit` that sRGB holds at lightness `l` and hue `h°`: 0 at or
/// outside black and white.
///
/// The chromas sRGB holds along the ray can come in several stretches: at the lightness and hue of
/// blue the ray leaves sRGB at a chroma of about 0.266 and comes back at blue itself, about 0.313,
/// and near black the gamut slack opens stretches of its own. Each linear sRGB channel is a cubic
/// in the chroma, so every stretch ends where a channel's cubic meets a bound of the gamut. The
/// search finds each such chroma between the cubic's turning points and takes the largest one that
/// fits.
fn largest_fitting_chroma(l: f64, h: f64, limit: f64) -> f64 {
if !(l > 0.0 && l < 1.0) || !h.is_finite() {
return 0.0;
}
let top = limit.min(0.5);
if top <= 0.0 {
return 0.0;
}
let fits = |c: f64| in_srgb(oklch_to_srgb(l, c, h));
if fits(top) {
return top;
}
let (sin, cos) = h.to_radians().sin_cos();
let lin = |c: f64| oklab_to_linear_srgb(l, c * cos, c * sin);
// The linear channels at chromas 0, s, 2s and 3s give each cubic's coefficients in t = c / s.
let s = top / 3.0;
let y = [lin(0.0), lin(s), lin(2.0 * s), lin(3.0 * s)];
let bounds = [-GAMUT_SLACK / 12.92, ((1.0 + GAMUT_SLACK + 0.055) / 1.055).powf(2.4)];
let mut ends = vec![0.0];
for ch in 0..3 {
let [y0, y1, y2, y3] = [y[0][ch], y[1][ch], y[2][ch], y[3][ch]];
let (d1, d2, d3) = (y1 - y0, y2 - 2.0 * y1 + y0, y3 - 3.0 * y2 + 3.0 * y1 - y0);
let k = [y0, d1 - d2 / 2.0 + d3 / 3.0, d2 / 2.0 - d3 / 2.0, d3 / 6.0];
let p = |t: f64| ((k[3] * t + k[2]) * t + k[1]) * t + k[0];
// The cubic rises or falls on each stretch between its turning points.
let mut cuts = vec![0.0, 3.0];
cuts.extend(turning_points(3.0 * k[3], 2.0 * k[2], k[1]).into_iter().filter(|t| *t > 0.0 && *t < 3.0));
cuts.sort_by(f64::total_cmp);
ends.extend(cuts.iter().map(|t| t * s));
for w in cuts.windows(2) {
for bound in bounds {
let (mut a, mut b) = (w[0], w[1]);
let fa = p(a) - bound;
if fa * (p(b) - bound) > 0.0 {
continue;
}
for _ in 0..60 {
let mid = (a + b) / 2.0;
if (p(mid) - bound) * fa > 0.0 { a = mid } else { b = mid }
}
ends.extend([a * s, b * s]);
}
}
}
ends.sort_by(|a, b| b.total_cmp(a));
ends.into_iter().flat_map(|c| [c, c - 1e-9]).find(|c| (0.0..=top).contains(c) && fits(*c)).unwrap_or(0.0)
}
/// The real roots of `a t² + b t + c`.
fn turning_points(a: f64, b: f64, c: f64) -> Vec<f64> {
if a.abs() < 1e-15 {
return if b.abs() < 1e-15 { Vec::new() } else { vec![-c / b] };
}
let disc = b * b - 4.0 * a * c;
if disc < 0.0 {
return Vec::new();
}
let r = disc.sqrt();
vec![(-b - r) / (2.0 * a), (-b + r) / (2.0 * a)]
}
/// The sRGB color (gamma encoded, 0..=1) of OKLCH `(l, c, h°)`, and whether its chroma was lowered:
/// a color outside sRGB keeps its lightness and hue and takes the largest chroma below it that
/// fits. Lightness is clamped to 0..=1 and chroma to 0 or more.
pub fn from_oklch(l: f64, c: f64, h: f64) -> ([f32; 3], bool) {
let l = if l.is_nan() { 0.0 } else { l.clamp(0.0, 1.0) };
let c = if c.is_nan() { 0.0 } else { c.max(0.0) };
let h = if h.is_finite() { h } else { 0.0 };
let exact = oklch_to_srgb(l, c, h);
let (rgb, lowered) = if in_srgb(exact) { (exact, false) } else { (oklch_to_srgb(l, largest_fitting_chroma(l, h, c), h), true) };
(rgb.map(|v| v.clamp(0.0, 1.0) as f32), lowered)
}
#[cfg(test)]
mod tests {
use super::*;
fn eight(rgb: [f32; 3]) -> [u8; 3] {
rgb.map(|v| (v * 255.0).round() as u8)
}
#[test]
fn red_has_the_oklch_of_the_oklab_matrices_and_converts_back() {
let [l, c, h] = to_oklch([1.0, 0.0, 0.0]);
assert!((l - 0.6280).abs() < 5e-5 && (c - 0.2577).abs() < 5e-5 && (h - 29.23).abs() < 5e-3, "{l} {c} {h}");
let (rgb, lowered) = from_oklch(l, c, h);
assert_eq!((eight(rgb), lowered), ([255, 0, 0], false));
}
/// CSS Color 4's examples convert to the hue its oklab() and oklch() forms give.
#[test]
fn the_polar_form_matches_the_css_examples() {
for ([l, a, b], [cl, cc, ch]) in
[([0.40101, 0.1147, 0.0453], [0.40101, 0.12332, 21.555]), ([0.65125, -0.0320, 0.1274], [0.65125, 0.13138, 104.097])]
{
let rgb = oklab_to_srgb(l, a, b).map(|v| v as f32);
let [ol, oc, oh] = to_oklch(rgb);
assert!((ol - cl).abs() < 1e-4 && (oc - cc).abs() < 1e-4 && (oh - ch).abs() < 0.05, "{ol} {oc} {oh}");
}
}
#[test]
fn the_216_web_colors_round_trip() {
let steps = [0u8, 0x33, 0x66, 0x99, 0xcc, 0xff];
for r in steps {
for g in steps {
for b in steps {
let rgb = [r, g, b].map(|v| f32::from(v) / 255.0);
let [l, c, h] = to_oklch(rgb);
assert_eq!(eight(from_oklch(l, c, h).0), [r, g, b], "{l} {c} {h}");
}
}
}
}
#[test]
fn grays_have_no_chroma_and_hue_zero() {
for v in [0.0, 0.5, 1.0] {
let [_, c, h] = to_oklch([v, v, v]);
assert!(c <= POWERLESS_CHROMA && h == 0.0, "{c} {h}");
}
}
/// A chroma past the gamut gives a color inside it with the same lightness and hue, and says so.
#[test]
fn a_chroma_past_the_gamut_is_lowered_keeping_lightness_and_hue() {
let (l, h) = (0.7, 150.0);
let max = max_chroma(l, h);
assert!(max > 0.05 && max < CHROMA_FULL, "{max}");
assert!(in_srgb(oklch_to_srgb(l, max, h)) && !in_srgb(oklch_to_srgb(l, max + 1e-3, h)));
let (rgb, lowered) = from_oklch(l, CHROMA_FULL, h);
assert!(lowered);
let [ol, oc, oh] = to_oklch(rgb);
assert!((ol - l).abs() < 2e-3 && (oh - h).abs() < 1.0 && (oc - max).abs() < 2e-3, "{ol} {oc} {oh}");
assert!(!from_oklch(l, max * 0.5, h).1);
}
/// At the lightness and hue of blue the ray leaves sRGB and comes back at blue itself, so the
/// largest chroma is blue's, and a chroma past it gives blue.
#[test]
fn the_largest_chroma_at_blues_hue_is_blues() {
let [l, c, h] = to_oklch([0.0, 0.0, 1.0]);
let max = max_chroma(l, h);
assert!((max - c).abs() < 1e-4 && in_srgb(oklch_to_srgb(l, max, h)), "{max} {c}");
let (rgb, lowered) = from_oklch(l, CHROMA_FULL, h);
assert_eq!((eight(rgb), lowered), ([0, 0, 255], true));
// A chroma between the two stretches takes the end of the first one, inside sRGB.
let (rgb, lowered) = from_oklch(l, 0.29, h);
let [_, gc, _] = to_oklch(rgb);
assert!(lowered && gc < 0.27 && in_srgb(oklch_to_srgb(l, gc, h)), "{gc}");
// A hue just past blue's: a narrow second stretch ends just below the line from black to blue.
let (l, h) = (0.44, 264.06);
let max = max_chroma(l, h);
assert!(max > 0.304 && max < 0.305 && in_srgb(oklch_to_srgb(l, max, h)), "{max}");
let [_, got, _] = to_oklch(from_oklch(l, 0.35, h).0);
assert!(got > 0.303, "{got}");
// A darker blue on the line from black to blue.
let [l, c, h] = to_oklch([0.0, 0.0, 0.25]);
assert!((max_chroma(l, h) - c).abs() < 1e-4, "{} {c}", max_chroma(l, h));
}
/// Just below blue's lightness the line from black to blue passes a chroma of 0.3125, where a
/// search from 0 to 0.5 lands first. A chroma asked for below that line still gives a color
/// inside sRGB with the lightness and hue asked for.
#[test]
fn a_chroma_below_the_line_from_black_to_blue_stays_inside_srgb() {
let [bl, bc, h] = to_oklch([0.0, 0.0, 1.0]);
let l = bl * 0.3125 / bc;
let (rgb, lowered) = from_oklch(l, 0.29, h);
let [gl, gc, gh] = to_oklch(rgb);
assert!(lowered && gc < 0.29 && in_srgb(oklch_to_srgb(l, gc, h)), "{gc}");
assert!((gl - l).abs() < 2e-3 && (gh - h).abs() < 1.0, "{gl} {gh}");
}
/// sRGB channels below 0 go through the transfer curve with its sign turned, as CSS Color 4's
/// extended sRGB does, in both directions.
#[test]
fn negative_channels_use_the_signed_transfer_curve() {
let linear = -((0.5_f64 + 0.055) / 1.055).powf(2.4);
let [l, c, _] = to_oklch([-0.5; 3]);
assert!((l - linear.cbrt()).abs() < 1e-4 && c <= POWERLESS_CHROMA, "{l} {c}");
for v in oklch_to_srgb(linear.cbrt(), 0.0, 0.0) {
assert!((v + 0.5).abs() < 1e-4, "{v}");
}
// Small values near 0 keep the straight part of the curve.
let [l, _, _] = to_oklch([-0.01; 3]);
assert!((l - (-0.01_f64 / 12.92).cbrt()).abs() < 1e-4, "{l}");
}
/// The largest chroma fits and is at least the largest one a scan in steps of 0.0005 finds, at
/// every hue and at lightnesses near black too, where the ray can come back into sRGB away from
/// any primary color's hue (L 0.02 and H 242° fit up to about 0.022 after leaving near 0.012).
#[test]
fn the_largest_chroma_is_never_below_a_scan_of_the_ray() {
let scan = |l: f64, h: f64| (0..=1000).map(|i| f64::from(i) * 0.0005).filter(|c| in_srgb(oklch_to_srgb(l, *c, h))).fold(0.0, f64::max);
assert!(max_chroma(0.02, 242.0) > 0.02, "{}", max_chroma(0.02, 242.0));
for l in [0.005, 0.02, 0.05, 0.1, 0.3, 0.44, 0.6, 0.8, 0.95, 0.99] {
for h in (0..72).map(|i| f64::from(i) * 5.0 + 2.0) {
let max = max_chroma(l, h);
assert!(in_srgb(oklch_to_srgb(l, max, h)) && max >= scan(l, h), "L {l} H {h}: {max} < {}", scan(l, h));
}
}
}
#[test]
fn black_white_and_bad_numbers_hold_no_chroma() {
assert_eq!(max_chroma(0.0, 30.0), 0.0);
assert_eq!(max_chroma(1.0, 30.0), 0.0);
assert_eq!(max_chroma(f64::NAN, 30.0), 0.0);
assert_eq!(max_chroma(0.5, f64::INFINITY), 0.0);
assert_eq!(eight(from_oklch(f64::NAN, f64::NAN, f64::NAN).0), [0, 0, 0]);
assert_eq!(eight(from_oklch(2.0, -1.0, 0.0).0), [255, 255, 255]);
}
}
+4 -2
View File
@@ -195,12 +195,14 @@ impl StrokeLayer {
wheel: None,
}
}
/// The least weight an arrowhead is drawn at, in points ([`Self::arrow_weight`]).
pub const LEAST_ARROW_WEIGHT: f64 = 0.25;
/// Weight of the start (`end == false`) or end arrowhead: stroke weight × its scale, at least
/// a quarter point. A head of weight `hw` fits a box about `4·hw` long and wide (see
/// [`Self::LEAST_ARROW_WEIGHT`]. A head of weight `hw` fits a box about `4·hw` long and wide (see
/// [`Arrowhead::reach`] and [`Arrowhead::half_width`]).
pub fn arrow_weight(&self, end: bool) -> f64 {
let pct = if end { self.arrow_scale.1 } else { self.arrow_scale.0 };
(self.width * pct / 100.0).max(0.25)
(self.width * pct / 100.0).max(Self::LEAST_ARROW_WEIGHT)
}
/// How far the start (`end == false`) or end arrowhead can reach from its end point (0
/// without one): the head's diagonal, or with [`ArrowAlign::Extend`] its length, plus the cap.
+25 -5
View File
@@ -68,6 +68,10 @@ pub struct CustomArrowhead {
/// across it, positive to the right of the direction the head points. A head is 4 units wide,
/// as the built-in heads are, and a unit is the head's weight.
pub path: PathData,
/// Where the stroke ends under the head, in head units back from the tip, when the head says
/// so ([`Self::with_stop`]); `None`: halfway along its length ([`Self::stop`]).
#[serde(default, skip_serializing_if = "Option::is_none")]
pub stop: Option<f64>,
}
#[derive(Deserialize)]
@@ -75,11 +79,17 @@ struct CustomArrowheadData {
name: String,
#[serde(default)]
path: PathData,
#[serde(default)]
stop: Option<f64>,
}
impl From<CustomArrowheadData> for CustomArrowhead {
fn from(d: CustomArrowheadData) -> Self {
CustomArrowhead::new(d.name, d.path)
let head = CustomArrowhead::new(d.name, d.path);
match d.stop {
Some(stop) => head.with_stop(stop),
None => head,
}
}
}
@@ -94,7 +104,17 @@ impl CustomArrowhead {
/// than [`Self::MAX_UNITS`] from the tip is dropped: the head then draws nothing.
pub fn new(name: String, path: PathData) -> Self {
let path = if Self::fits(&path) { path } else { PathData::default() };
CustomArrowhead { name, path }
CustomArrowhead { name, path, stop: None }
}
/// The head with the stroke ending `stop` head units back from its tip (an arrowhead an
/// Illustrator file defines draws its line to a point of its own). A stop that is not finite,
/// is negative or is farther than [`Self::MAX_UNITS`] is left out: the stroke then ends
/// halfway along the head.
/// A head whose outline was dropped ([`Self::new`]) draws nothing and keeps no stop.
pub fn with_stop(mut self, stop: f64) -> Self {
let fits = !self.path.subpaths.is_empty() && stop.is_finite() && (0.0..=Self::MAX_UNITS).contains(&stop);
self.stop = fits.then_some(stop);
self
}
/// Whether outline `path` has at most [`Self::MAX_ANCHORS`] anchors and as many subpaths, with
/// finite points within [`Self::MAX_UNITS`] only.
@@ -116,10 +136,10 @@ impl CustomArrowhead {
pub fn half_width(&self) -> f64 {
self.bounds().map_or(0.0, |b| b.y0.abs().max(b.y1.abs()))
}
/// Where the stroke ends under the head, in head units back from the tip: halfway along the
/// head's length.
/// Where the stroke ends under the head, in head units back from the tip: its own stop
/// ([`Self::with_stop`]), else halfway along the head's length.
pub fn stop(&self) -> f64 {
self.bounds().map_or(0.0, |b| b.x1.max(0.0) / 2.0)
self.stop.unwrap_or_else(|| self.bounds().map_or(0.0, |b| b.x1.max(0.0) / 2.0))
}
}
+11 -2
View File
@@ -383,6 +383,15 @@ fn custom_arrowheads_carry_their_art_and_measure_it() {
assert_eq!(head.half_width(), 2.0);
let Arrowhead::Custom(c) = &head else { panic!("custom") };
assert_eq!(c.stop(), 1.5, "the line stops halfway along the head");
// A head with a stop of its own (an Illustrator file's arrowhead) keeps it, saved and read back.
let stopped = (**c).clone().with_stop(0.5);
assert_eq!(stopped.stop(), 0.5);
let back: CustomArrowhead = serde_json::from_value(serde_json::to_value(&stopped).unwrap()).unwrap();
assert_eq!(back, stopped);
assert!(!serde_json::to_string(&**c).unwrap().contains("stop"), "a head without one writes none");
for odd in [f64::NAN, -0.5, CustomArrowhead::MAX_UNITS + 1.0] {
assert_eq!((**c).clone().with_stop(odd).stop(), 1.5, "{odd} is left out");
}
// Saved with the stroke, art and all, beside the built-in heads' names.
let mut st = StrokeLayer::new(Paint::solid(Color::BLACK), 2.0);
(st.start_arrow, st.end_arrow) = (Some(Arrowhead::Triangle), Some(head.clone()));
@@ -404,7 +413,7 @@ fn custom_arrowheads_out_of_bounds_draw_nothing() {
let mut path = c.path.clone();
path.subpaths[0].anchors[1] = vectorcraft_geom::Anchor::corner(vectorcraft_geom::Point::new(1e9, 0.0));
// A file can hold what `new` drops: reading it drops it too.
let json = serde_json::to_value(CustomArrowhead { name: "Wedge".into(), path }).unwrap();
let json = serde_json::to_value(CustomArrowhead { name: "Wedge".into(), path, stop: None }).unwrap();
let far: CustomArrowhead = serde_json::from_value(json).unwrap();
assert_eq!((far.name.as_str(), far.path.subpaths.len()), ("Wedge", 0));
assert_eq!((far.reach(), far.half_width(), far.stop()), (0.0, 0.0, 0.0));
@@ -415,7 +424,7 @@ fn custom_arrowheads_out_of_bounds_draw_nothing() {
let mut hollow = c.path.clone();
hollow.subpaths.extend(std::iter::repeat_n(vectorcraft_geom::SubPath::new(vec![], false), CustomArrowhead::MAX_ANCHORS));
assert!(!CustomArrowhead::fits(&hollow), "too many subpaths");
let json = serde_json::to_value(CustomArrowhead { name: "Hollow".into(), path: hollow }).unwrap();
let json = serde_json::to_value(CustomArrowhead { name: "Hollow".into(), path: hollow, stop: None }).unwrap();
let hollow: CustomArrowhead = serde_json::from_value(json).unwrap();
assert!(hollow.path.subpaths.is_empty(), "too many subpaths, read back");
}
+65 -1
View File
@@ -124,6 +124,54 @@ impl ArrowStyle {
}
}
/// `arrowHead`: null, or a built-in stroke arrowhead by its name (`Barbed`, as `stroke.set` takes
/// it). A custom arrowhead and an unknown name are refused.
mod arrow_head {
use crate::Arrowhead;
use serde::de::{Error, IntoDeserializer, Visitor};
use serde::{Deserialize, Deserializer};
pub fn deserialize<'de, D: Deserializer<'de>>(deserializer: D) -> Result<Option<Arrowhead>, D::Error> {
deserializer.deserialize_option(Name)
}
/// Reads the name where it is, without a copy of its own.
struct Name;
impl<'de> Visitor<'de> for Name {
type Value = Option<Arrowhead>;
fn expecting(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
f.write_str("a built-in stroke arrowhead name or null")
}
fn visit_none<E: Error>(self) -> Result<Self::Value, E> {
Ok(None)
}
fn visit_unit<E: Error>(self) -> Result<Self::Value, E> {
Ok(None)
}
fn visit_some<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
deserializer.deserialize_str(self)
}
fn visit_str<E: Error>(self, name: &str) -> Result<Self::Value, E> {
// No built-in name is this long, so a longer one is refused without parsing it.
let parsed: Result<Arrowhead, serde::de::value::Error> =
if name.len() > 64 { Err(serde::de::value::Error::custom("too long")) } else { Arrowhead::deserialize(name.into_deserializer()) };
match parsed {
Ok(head) if !matches!(head, Arrowhead::Custom(_)) => Ok(Some(head)),
_ => {
let shown: String = name.chars().take(64).collect();
Err(E::custom(format!("Unknown arrowhead {shown}: a built-in stroke arrowhead name or null")))
}
}
}
}
}
/// Where the label sits across the dimension line.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
@@ -157,6 +205,12 @@ pub struct DimensionOptions {
pub line_type: LineType,
pub line_color: [u8; 3],
pub arrow_style: ArrowStyle,
/// A built-in stroke arrowhead drawn at both ends in place of `arrow_style`'s head. Versions
/// that have the stroke arrowhead but do not read this keep the saved arrows until they draw
/// the dimension again, and then draw `arrow_style`. Versions without the stroke arrowhead do
/// not open the file.
#[serde(deserialize_with = "arrow_head::deserialize", skip_serializing_if = "Option::is_none")]
pub arrow_head: Option<crate::Arrowhead>,
pub arrow_scale: f64,
pub extension_weight: f64,
pub extension_type: LineType,
@@ -186,6 +240,7 @@ impl Default for DimensionOptions {
line_type: LineType::Solid,
line_color: [0, 0, 0],
arrow_style: ArrowStyle::Filled,
arrow_head: None,
arrow_scale: 100.0,
extension_weight: 0.5,
extension_type: LineType::Solid,
@@ -209,7 +264,8 @@ impl DimensionOptions {
/// tolerantly so a newer version's options don't stop a document opening.
pub fn from_params(v: serde_json::Value) -> Result<Self, String> {
if let (Some(given), Ok(serde_json::Value::Object(known))) = (v.as_object(), serde_json::to_value(Self::default()))
&& let Some(k) = given.keys().find(|k| !known.contains_key(*k))
// `arrowHead` is left out of the saved options when it is null.
&& let Some(k) = given.keys().find(|k| !known.contains_key(*k) && k.as_str() != "arrowHead")
{
return Err(format!("Unknown dimension option {k}"));
}
@@ -228,8 +284,16 @@ impl DimensionOptions {
}
Ok(f)
}
/// The stroke arrowhead drawn at each end of the dimension line: `arrow_head`, or else the
/// arrow style's head.
pub fn arrowhead(&self) -> Option<crate::Arrowhead> {
self.arrow_head.clone().or_else(|| self.arrow_style.arrowhead())
}
pub fn validate(&self) -> Result<(), String> {
self.factor()?;
if matches!(self.arrow_head, Some(crate::Arrowhead::Custom(_))) {
return Err("A dimension's arrowhead is a built-in stroke arrowhead".into());
}
if self.precision > 6 {
return Err("Choose a precision from 0 to 6".into());
}
+62
View File
@@ -500,11 +500,73 @@ impl Document {
self.patterns.iter_mut().find(|p| p.name == name)
}
/// The [`Self::unknown`] key that holds each symbol set's Symbol Set Density, `{set id: density}`.
/// [`Self::reid`] gives a copy of a set in this document the density recorded for its source, and
/// [`Self::carry_set_densities`] gives a pasted set the density recorded for it at Copy.
pub const SYMBOL_SET_DENSITY_KEY: &'static str = "symbolSetDensity";
/// The Symbol Set Densities recorded for `nodes` and their descendants, by id.
pub fn set_densities_of(&self, nodes: &[Node]) -> std::collections::BTreeMap<NodeId, serde_json::Value> {
let Some(serde_json::Value::Object(record)) = self.unknown.get(Self::SYMBOL_SET_DENSITY_KEY) else { return Default::default() };
let mut out = std::collections::BTreeMap::new();
let mut stack: Vec<&Node> = nodes.iter().collect();
while let Some(n) = stack.pop() {
if let Some(v) = record.get(&n.id.0.to_string()) {
out.insert(n.id, v.clone());
}
stack.extend(n.children().into_iter().flatten().map(|c| &**c));
}
out
}
/// Record for `copy`, a [`Self::reid`] copy of `source`, and its descendants the Symbol Set
/// Densities that `densities` holds for `source` and its descendants, and none for those it
/// holds none for (whatever [`Self::reid`] recorded).
pub fn carry_set_densities(&mut self, source: &Node, copy: &Node, densities: &std::collections::BTreeMap<NodeId, serde_json::Value>) {
if densities.is_empty() && !self.unknown.contains_key(Self::SYMBOL_SET_DENSITY_KEY) {
return;
}
let mut pairs = vec![(source, copy)];
while let Some((s, c)) = pairs.pop() {
match densities.get(&s.id) {
Some(v) => {
if let serde_json::Value::Object(m) =
self.unknown.entry(Self::SYMBOL_SET_DENSITY_KEY).or_insert_with(|| serde_json::Value::Object(Default::default()))
{
m.insert(c.id.0.to_string(), v.clone());
}
}
None => {
if let Some(serde_json::Value::Object(m)) = self.unknown.get_mut(Self::SYMBOL_SET_DENSITY_KEY) {
m.remove(&c.id.0.to_string());
}
}
}
if let (Some(sc), Some(cc)) = (s.children(), c.children()) {
pairs.extend(sc.iter().zip(cc.iter()).map(|(a, b)| (&**a, &**b)));
}
}
}
/// Deep-clone `node` with fresh ids for it and all descendants, its images' own pixels taken
/// in ([`Self::adopt_pixels`]).
pub fn reid(&mut self, node: &Node) -> Node {
let mut n = node.clone();
n.id = self.alloc_id();
// A copy of a symbol set keeps the Symbol Set Density recorded for its source, when the source
// is this document's node with that id; a node from another document may share the id of an
// unrelated set here.
let density = self
.unknown
.get(Self::SYMBOL_SET_DENSITY_KEY)
.and_then(|m| m.get(node.id.0.to_string()))
.filter(|_| self.node(node.id) == Some(node))
.cloned();
if let Some(v) = density
&& let Some(serde_json::Value::Object(m)) = self.unknown.get_mut(Self::SYMBOL_SET_DENSITY_KEY)
{
m.insert(n.id.0.to_string(), v);
}
if let NodeKind::Image(im) = &mut n.kind {
self.adopt_image_pixels(im);
}
+29 -7
View File
@@ -144,10 +144,36 @@ impl LiveShape {
/// from straight up (the Rotate field's sense). None for other shapes.
pub fn polygon_angle(&self) -> Option<f64> {
let LiveShape::Polygon { .. } = self else { return None };
// No −0° or 360° from rounding: a polygon drawn upright reads 0°.
self.shape_angle()
}
/// A rectangle's, ellipse's or polygon's angle (Rectangle, Ellipse and Polygon Angle): the
/// counterclockwise degrees in [0, 360) it is turned by (the Rotate field's sense). A rectangle or
/// ellipse drawn level reads 0°, as does a polygon drawn with its first vertex straight up. None for
/// other shapes.
pub fn shape_angle(&self) -> Option<f64> {
let (LiveShape::Rectangle { .. } | LiveShape::Ellipse { .. } | LiveShape::Polygon { .. }) = self else { return None };
// No −0° or 360° from rounding: a shape drawn level reads 0°.
let a = (-self.angle_deg()).rem_euclid(360.0);
Some(if a > 360.0 - 1e-9 { 0.0 } else { a + 0.0 })
}
/// Turn a rectangle, ellipse or polygon about its center to `angle` (degrees, as
/// [`LiveShape::shape_angle`]), keeping its size, corners and pie. Nothing changes for other
/// shapes or an angle that isn't finite.
pub fn set_shape_angle(&mut self, angle: f64) {
let Some(now) = self.shape_angle() else { return };
if !angle.is_finite() {
return;
}
// Brought into [0, 360) first: `now - angle` loses `now` for a very large angle.
let angle = angle.rem_euclid(360.0);
let (xf, local) = match self {
LiveShape::Rectangle { w, h, xf, .. } | LiveShape::Ellipse { w, h, xf, .. } => (xf, Point::new(*w / 2.0, *h / 2.0)),
LiveShape::Polygon { xf, .. } => (xf, Point::ZERO),
LiveShape::Line { .. } | LiveShape::Path { .. } => return,
};
let center = *xf * local;
*xf = Affine::rotate_about((now - angle).to_radians(), center) * *xf;
}
/// Whether a polygon's sides are all as long: `xf` scales it evenly and doesn't shear it. True
/// for other shapes.
pub fn polygon_sides_equal(&self) -> bool {
@@ -171,12 +197,8 @@ impl LiveShape {
}
/// Turn a polygon about its centre to `angle` (degrees, as [`LiveShape::polygon_angle`]).
pub fn set_polygon_angle(&mut self, angle: f64) {
let Some(now) = self.polygon_angle() else { return };
if let LiveShape::Polygon { xf, .. } = self
&& angle.is_finite()
{
let centre = *xf * Point::ZERO;
*xf = Affine::rotate_about((now - angle).to_radians(), centre) * *xf;
if let LiveShape::Polygon { .. } = self {
self.set_shape_angle(angle);
}
}
/// A line's length in the document, from its first end to its second. None for other shapes.
+14
View File
@@ -184,6 +184,20 @@ fn a_polygon_reports_and_takes_its_radius_angle_and_equal_sides() {
assert_eq!((e.polygon_radius(), e.polygon_angle()), (None, None));
}
/// A very large angle turns a rectangle to that angle modulo 360, whatever angle it had before.
#[test]
fn a_shape_takes_a_very_large_angle() {
let close = |a: f64, b: f64| (a - b).abs() < 1e-6;
let want = 1e20f64.rem_euclid(360.0);
for turned in [0.0, 90.0] {
let xf = Affine::translate((50.0, 50.0)) * Affine::rotate(-f64::to_radians(turned));
let mut r = LiveShape::Rectangle { w: 100.0, h: 50.0, radii: [0.0; 4], kinds: Default::default(), radii_relative: false, xf };
assert!(close(r.shape_angle().unwrap(), turned), "{:?}", r.shape_angle());
r.set_shape_angle(1e20);
assert!(close(r.shape_angle().unwrap(), want), "from {turned}°: {:?}, not {want}", r.shape_angle());
}
}
/// A node holding a live rectangle (`w` × `h`, all radii `r`, placed by `xf`) and its path.
fn live_rect(w: f64, h: f64, r: f64, xf: Affine) -> Node {
let live = LiveShape::Rectangle { w, h, radii: [r; 4], kinds: Default::default(), radii_relative: false, xf };
+37
View File
@@ -686,6 +686,43 @@ fn reid_gives_fresh_ids() {
assert!(!ids.contains(&a) && !ids.contains(&b));
}
/// A copy of a node in the document takes the Symbol Set Density recorded for it; a node from
/// another document with the same id does not.
#[test]
fn reid_copies_the_set_density_of_the_documents_own_node() {
let (mut d, a, _) = doc_with_rects();
d.unknown.insert(Document::SYMBOL_SET_DENSITY_KEY.into(), serde_json::json!({ a.0.to_string(): 2.0 }));
let density = |d: &Document, id: NodeId| d.unknown[Document::SYMBOL_SET_DENSITY_KEY].get(id.0.to_string()).cloned();
let own = d.node(a).cloned().unwrap();
let copy = d.reid(&own);
assert_eq!(density(&d, copy.id), Some(serde_json::json!(2.0)));
let foreign = Node::group(a, vec![]);
let copy = d.reid(&foreign);
assert_eq!(density(&d, copy.id), None);
}
/// A pasted copy and its descendants take the densities recorded at Copy, and none where Copy
/// recorded none, whatever [`Document::reid`] found for an identical node in the document.
#[test]
fn carry_set_densities_gives_the_densities_recorded_at_copy() {
let (mut d, a, b) = doc_with_rects();
d.unknown.insert(Document::SYMBOL_SET_DENSITY_KEY.into(), serde_json::json!({ a.0.to_string(): 2.0 }));
let density = |d: &Document, id: NodeId| d.unknown[Document::SYMBOL_SET_DENSITY_KEY].get(id.0.to_string()).cloned();
let (na, nb) = (d.node(a).cloned().unwrap(), d.node(b).cloned().unwrap());
// Copy recorded nothing for `a`: the copy reid gave a density loses it.
let copy = d.reid(&na);
assert_eq!(density(&d, copy.id), Some(serde_json::json!(2.0)));
d.carry_set_densities(&na, &copy, &Default::default());
assert_eq!(density(&d, copy.id), None);
// Copy recorded 7 for `b` inside a group: the group's copy has none, and `b`'s copy has 7.
let g = d.alloc_id();
let group = Node::group(g, vec![Arc::new(nb)]);
let copy = d.reid(&group);
d.carry_set_densities(&group, &copy, &[(b, serde_json::json!(7.0))].into_iter().collect());
let inner = copy.children().unwrap()[0].id;
assert_eq!((density(&d, copy.id), density(&d, inner)), (None, Some(serde_json::json!(7.0))));
}
#[test]
fn setup_round_trips_and_old_files_load() {
let (mut d, _, _) = doc_with_rects();
+13
View File
@@ -451,12 +451,25 @@ impl TextObject {
/// fractions of the path. False, changing nothing, for other type, when the anchor doesn't
/// exist, a degenerate `xf` or a path that would not be finite.
pub fn set_path_handle(&mut self, (si, ai): (usize, usize), out: bool, pos: Point, independent: bool) -> bool {
self.set_path_handle_with_symmetry((si, ai), out, pos, independent, false)
}
/// [`Self::set_path_handle`] with an optional mirror of the opposite handle about the anchor
/// in document space, preserving the anchor kind. `independent` takes precedence, and at an
/// open end of the path, where no segment leaves the anchor on that side, the handle moves as
/// it would without `symmetric`. Both handles are edited in one reshape, using the same validated
/// document-to-text map.
pub fn set_path_handle_with_symmetry(&mut self, (si, ai): (usize, usize), out: bool, pos: Point, independent: bool, symmetric: bool) -> bool {
let xf = self.xf;
matches!(self.kind, TextKind::OnPath { .. })
&& self.reshape_local(|path, to_text| {
let mirror = symmetric && !independent && path.subpaths.get(si).is_some_and(|sp| sp.has_segment(ai, !out));
let Some(a) = path.anchor_mut(si, ai) else { return false };
let mut drawn = a.transform(xf);
drawn.set_handle(out, pos, independent);
if mirror {
let opposite = drawn.p - (pos - drawn.p);
if out { drawn.h_in = opposite } else { drawn.h_out = opposite }
}
*a = drawn.transform(to_text);
true
})
+2 -1
View File
@@ -5,7 +5,8 @@
//! corner. With [`ArrowAlign::Tip`] the tip sits on the end point and the stroke is shortened by
//! the inset; with [`ArrowAlign::Extend`] the path keeps its length and the tip sits the inset
//! past the end point. Heads added after the first ten are drawn in local units ([`local`]), as are
//! custom heads, whose stroke ends halfway along their length.
//! custom heads, whose stroke ends at their own stop or else halfway along their length
//! ([`vectorcraft_doc::CustomArrowhead::stop`]).
use std::borrow::Cow;
+1 -1
View File
@@ -907,7 +907,7 @@ pub use gradpresets::{GradientPreset, GradientPresetEntry};
pub use buildcmds::{TracePreset, TracePresetChange};
/// An Image Trace made off the UI thread, and what it traced (#3098).
pub use buildcmds::{TraceRun, Traced};
pub use buildcmds::{TraceRun, Traced, image_trace_target};
/// The saved Image Trace presets' revision and latest changes ([`crate::Session`] keeps them).
pub(crate) use buildcmds::TracePresetChanges;
+128 -3
View File
@@ -175,6 +175,7 @@ pub const BUILTIN: &[BuiltinBrushLibrary] = &[
BuiltinBrushLibrary { id: "calligraphic-nibs", name: "Calligraphic Nibs", make: calligraphic_nibs },
BuiltinBrushLibrary { id: "pressure-sensitive", name: "Pressure Sensitive", make: pressure_sensitive },
BuiltinBrushLibrary { id: "bristle-brushes", name: "Bristle Brushes", make: bristle_brushes },
BuiltinBrushLibrary { id: "paint", name: "Paint", make: paint },
BuiltinBrushLibrary { id: "pattern-borders", name: "Pattern Borders", make: pattern_borders },
BuiltinBrushLibrary { id: "scatter-shapes", name: "Scatter Shapes", make: scatter_shapes },
BuiltinBrushLibrary { id: "stipple", name: "Stipple", make: stipple },
@@ -182,8 +183,10 @@ pub const BUILTIN: &[BuiltinBrushLibrary] = &[
BuiltinBrushLibrary { id: "energy-beams", name: "Energy Beams", make: energy_beams },
BuiltinBrushLibrary { id: "dry-media", name: "Dry Media", make: dry_media },
BuiltinBrushLibrary { id: "tech-circuit", name: "Tech Circuit", make: tech_circuit },
BuiltinBrushLibrary { id: "engraving", name: "Engraving", make: engraving },
BuiltinBrushLibrary { id: "arrows", name: "Arrows", make: arrows },
BuiltinBrushLibrary { id: "image-brush", name: "Image Brush", make: image_brush },
BuiltinBrushLibrary { id: "artistic", name: "Artistic Brushes", make: artistic },
];
/// Built-in library `id`, made once.
@@ -237,6 +240,85 @@ fn art(name: &str, art: Node, colorization: Colorization) -> Brush {
Brush { name: name.into(), kind: BrushKind::Art(ArtBrush { art, colorization, ..Default::default() }) }
}
/// Artistic: four original vector compositions that stretch along a path and take its color.
fn artistic() -> BrushLibrary {
let orbit = group(vec![
black(band(100.0, 1.4, 64, |x| 3.0 * (x * std::f64::consts::TAU / 40.0).sin())),
black(band(100.0, 1.4, 64, |x| -3.0 * (x * std::f64::consts::TAU / 40.0).sin())),
]);
let mut petals = vec![black(band(100.0, 0.8, 4, |_| 0.0))];
for i in 0..6 {
let x = 9.0 + 16.0 * i as f64;
let side = if i % 2 == 0 { 1.0 } else { -1.0 };
petals.push(black(polygon(&[(x - 6.0, 0.0), (x - 2.0, 5.0 * side), (x + 5.0, 7.0 * side), (x + 2.0, 2.0 * side)])));
}
let mut lattice = vec![black(band(100.0, 0.9, 4, |_| 0.0))];
for i in 0..5 {
let x = 20.0 * i as f64;
lattice.push(black(polygon(&[(x, -4.0), (x + 1.0, -4.0), (x + 20.0, 4.0), (x + 19.0, 4.0)])));
lattice.push(black(polygon(&[(x, 4.0), (x + 1.0, 4.0), (x + 20.0, -4.0), (x + 19.0, -4.0)])));
}
let mut facets = Vec::new();
for i in 0..8 {
let x = 12.5 * i as f64;
let high = if i % 2 == 0 { 6.0 } else { 3.5 };
facets.push(black(polygon(&[(x, -high), (x + 11.0, -high / 2.0), (x + 12.5, 0.0), (x + 11.0, high / 2.0), (x, high)])));
}
built(
"Artistic Brushes",
Document::new(100.0, 100.0),
vec![
art("Orbit Lines", orbit, Colorization::Tints),
art("Petal Garland", group(petals), Colorization::Tints),
art("Lattice Braid", group(lattice), Colorization::Tints),
art("Facet Sweep", group(facets), Colorization::Tints),
],
)
}
/// Original fine-line art for an engraving-style brush library.
fn engraving() -> BrushLibrary {
let lines = |count: usize, width: f64, spacing: f64| {
group(
(0..count)
.map(|i| {
let y = (i as f64 - (count - 1) as f64 / 2.0) * spacing;
black(shapes::rectangle(Rect::new(0.0, y - width / 2.0, 100.0, y + width / 2.0)))
})
.collect(),
)
};
let taper = group(
(0..5)
.map(|i| {
let y = (i as f64 - 2.0) * 2.2;
black(polygon(&[(0.0, y - 0.35), (80.0, y - 0.35), (100.0, y), (80.0, y + 0.35), (0.0, y + 0.35)]))
})
.collect(),
);
let broken = group(
(0..5)
.flat_map(|row| {
(0..4).map(move |segment| {
let x = segment as f64 * 25.0 + if row % 2 == 0 { 0.0 } else { 8.0 };
let y = (row as f64 - 2.0) * 2.2;
black(shapes::rectangle(Rect::new(x, y - 0.3, (x + 16.0).min(100.0), y + 0.3)))
})
})
.collect(),
);
built(
"Engraving",
Document::new(100.0, 100.0),
vec![
art("Fine Hatching", lines(5, 0.65, 2.2), Colorization::Tints),
art("Dense Hatching", lines(9, 0.42, 1.2), Colorization::Tints),
art("Tapered Hatching", taper, Colorization::Tints),
art("Broken Hatching", broken, Colorization::Tints),
],
)
}
/// An Arrows brush whose art stretches only between `start` and `end` (fractions of its length).
fn arrow_art(name: &str, art: Node, start: f64, end: f64) -> Brush {
Brush {
@@ -550,6 +632,45 @@ fn spacer(r: Rect) -> Node {
Node::path(NodeId(0), shapes::rectangle(r), Appearance::default())
}
/// Paint: original filled vector art with broad, broken, loaded, and fanned marks. Each is one
/// stroke stretched along the path, with an intentionally different edge and paint distribution.
fn paint() -> BrushLibrary {
let flat_sweep = group(vec![
black(band(100.0, 5.0, 64, |x| 0.8 * (x / 100.0 * std::f64::consts::TAU).sin())),
black(polygon(&[(0.0, -2.5), (7.0, -3.8), (18.0, -2.5)])),
black(polygon(&[(78.0, 2.5), (94.0, 4.0), (100.0, 2.5)])),
]);
let mut dry_drag = vec![];
for (y, shift) in [(-5.0, 0.0), (-3.2, 4.0), (-1.3, 1.0), (0.8, 6.0), (2.8, 3.0), (4.8, 8.0)] {
dry_drag.push(black(shapes::rectangle(Rect::new(2.0 + shift, y, 35.0 + shift, y + 0.8))));
dry_drag.push(black(shapes::rectangle(Rect::new(40.0 + shift, y, 75.0 - shift / 2.0, y + 0.8))));
dry_drag.push(black(shapes::rectangle(Rect::new(80.0 - shift / 2.0, y, 98.0, y + 0.8))));
}
let mut loaded_stroke = vec![black(band(100.0, 6.0, 64, |x| 1.2 * (x / 100.0 * 2.0 * std::f64::consts::TAU).sin()))];
for (x, r) in [(12.0, 4.2), (39.0, 3.6), (64.0, 4.8), (88.0, 3.9)] {
loaded_stroke.push(black(shapes::ellipse(Rect::new(x - r, -r - 1.5, x + r, r + 1.5))));
}
let mut fan_sweep = vec![];
for i in -2..=2 {
let offset = i as f64;
fan_sweep.push(black(band(100.0, 1.2, 48, |x| offset * (1.4 + x * 0.045) + 0.3 * (x / 100.0 * std::f64::consts::TAU).sin())));
}
let paint_art = |name: &str, art: Node| Brush {
name: name.into(),
kind: BrushKind::Art(ArtBrush { art, width: 150.0, colorization: Colorization::Tints, ..Default::default() }),
};
built(
"Paint",
Document::new(100.0, 100.0),
vec![
paint_art("Flat Sweep", flat_sweep),
paint_art("Dry Drag", group(dry_drag)),
paint_art("Loaded Stroke", group(loaded_stroke)),
paint_art("Fan Sweep", group(fan_sweep)),
],
)
}
/// Pattern Borders: pattern brushes of tiles drawn here; Beads has corner tiles.
fn pattern_borders() -> BrushLibrary {
let zigzag = black(polygon(&[(0.0, 1.4), (5.0, -2.6), (10.0, 1.4), (10.0, 2.6), (5.0, -1.4), (0.0, 2.6)]));
@@ -992,10 +1113,14 @@ pub fn library(s: &Session, key: &str) -> Option<(LibraryInfo, Arc<BrushLibrary>
return Some(found);
}
if let Some(b) = BUILTIN.iter().find(|b| b.id == key) {
return Some((builtin_info(b), builtin_library(key)?));
return Some((builtin_info(b), builtin_library(b.id)?));
}
let id = libraries(s).into_iter().find(|l| l.name.eq_ignore_ascii_case(key))?.id;
library(s, &id)
if let Some(id) = libraries(s).into_iter().find(|l| l.name.eq_ignore_ascii_case(key)).map(|l| l.id) {
return library(s, &id);
}
// Keep the short built-in alias, but let a user or loaded library own its display name.
let b = key.eq_ignore_ascii_case("Artistic").then(|| BUILTIN.iter().find(|b| b.id == "artistic")).flatten()?;
Some((builtin_info(b), builtin_library(b.id)?))
}
fn library_param(s: &Session, p: &Value, cmd: &str) -> Result<(LibraryInfo, Arc<BrushLibrary>)> {
+2 -2
View File
@@ -362,7 +362,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Symbol Sprayer",
[],
None,
"{points: [[x,y]…] (a third number is not used; one that isn't a number is an error), name?, radius?: 40, density?: 1..10 (5), scale?: 1, alt?: bool (remove instances), attributes?: {scrunch?, size?, spin?, screen?, stain?, style?: average|userDefined (average)}, color? (#rrggbbaa and #rgba are refused), keepModel?: bool (as paint.setFill), style?: name} spray instances into a symbol set → {id, count}. Each of `attributes` says what a new instance takes: average, the mean of the selected set's instances within `radius` of the stroke point (their spacing along the stroke, size, rotation, opacity, and the stain or style of the nearest one that has one at the mean amount), and with none there the symbol's size, no rotation, full opacity and no stain or style; or userDefined: spacing from the symbol's size and `density`, the symbol's size times `scale`, turned the way the stroke runs there (not turned for one point), full opacity, stained in full with `color` (default: the fill color), and the fill of graphic style `style` (default: the first style after the default one) in full; a `style` the document does not have is then an error. The stain and the style are both the instance's fill, and the style replaces the stain. Another key or value in `attributes` is an error",
"{points: [[x,y]…] (a third value is a number or null and is not used), name?, radius?: 40, density?: 1..10 (5; a number outside 1..10 is taken as the nearer end), scale?: 1, alt?: bool (remove instances), attributes?: {scrunch?, size?, spin?, screen?, stain?, style?: average|userDefined (average)}, color? (#rrggbbaa and #rgba are refused), keepModel?: bool (as paint.setFill), style?: name} spray instances into a symbol set → {id, count}. Each of `attributes` says what a new instance takes: average, the mean of the selected set's instances within `radius` of the stroke point (their spacing along the stroke, size, rotation, opacity, and the stain or style of the nearest one that has one with an amount above 0, at the mean amount), and with none there the symbol's size, no rotation, full opacity and no stain or style; or userDefined: spacing from the symbol's size and `density`, the symbol's size times `scale`, turned the way the stroke runs there (not turned for one point), full opacity, stained in full with `color` (default: the fill color), and the fill of graphic style `style` (default: the first style after the default one) in full; a `style` the document does not have is then an error. The stain and the style are both the instance's fill, and the style replaces the stain. Another key or value in `attributes` is an error",
has_doc,
symbol_spray
),
@@ -380,7 +380,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Symbolism Tool",
[],
None,
"{tool: shift|scrunch|size|spin|stain|screen|style, points: [[x,y,pressure?]…] (pen pressure 0..1, default 1), radius?: 40, intensity?: 1..10 (5), usePressure?: bool (each point's pressure is the intensity there, in place of `intensity`), method?: userDefined|average|random (userDefined; not used by shift), proportional?: bool (size; true), affectsDensity?: bool (size; false), alt?: bool, color? (#rrggbbaa and #rgba are refused), keepModel?: bool (as paint.setFill), style?: name} adjust instances near the points (selection, else all) → {count}. `method` userDefined changes each instance by the tool's amount at its distance from the point; random gives each instance its own share of that amount for the whole stroke, from none to twice it (spin: a turn either way); average moves each instance's value toward the mean of the instances within `radius` of the point (scrunch: its distance from their middle toward their mean distance; size: the geometric mean of their sizes; spin: their mean direction; stain and style: their mean amount; screen: their mean opacity), and `alt` does not reverse it; average leaves an instance without a size (a scale of 0) as it is. With `proportional` false a drag resizes along its own direction (a level drag the width, an upright one the height; the first point takes the direction to the second) and one point resizes both; average resizes both whatever `proportional` is. With `affectsDensity` an instance also moves away from the point as it grows and toward it as it shrinks. An instance counts only when it changes, and no undo step is added when none does (none under the brush, average with each already at the mean, or each already at the tool's limit). A `method` that is none of the three, or a pressure that isn't a number, is an error",
"{tool: shift|scrunch|size|spin|stain|screen|style, points: [[x,y,pressure?]…] (pen pressure 0..1, default 1), radius?: 40, intensity?: 1..10 (5), usePressure?: bool (each point's pressure is the intensity there, in place of `intensity`), method?: userDefined|average|random (userDefined; not used by shift), proportional?: bool (size; true), affectsDensity?: bool (size; false), alt?: bool, shift?: bool (shift, size, stain and style; false), color? (#rrggbbaa and #rgba are refused), keepModel?: bool (as paint.setFill), style?: name (a graphic style's; left out, or naming no style in the document, the first style after the default one)} adjust instances near the points (selection, else all) → {count}. `method` userDefined changes each instance by the tool's amount at its distance from the point; random gives each instance its own share of that amount for the whole stroke, from none to twice it (spin: a turn either way; style without `shift`: from none to the userDefined amount); average moves each instance's value toward the mean of the instances within `radius` of the point (scrunch: its distance from their middle toward their mean distance; size: the geometric mean of their sizes; spin: their mean direction; stain and style: their mean amount; screen: their mean opacity), and `alt` does not reverse it; average leaves an instance without a size as it is. With `proportional` false a drag resizes along its own direction, the width by the drag's horizontal share and the height by its vertical share (a level drag the width, an upright one the height, a 45° drag both alike; the first point takes the direction to the second) and one point resizes both; average resizes both whatever `proportional` is. With `affectsDensity` an instance also moves away from the point as it grows and toward it as it shrinks. The style goes on by the brush's strength at each sample, and a stroke's samples add up. With `alt` and without `shift`, userDefined and random style remove all of an instance's appearance items under the brush at once, whatever the brush's strength. `shift` is the tool's Shift form: shift brings the instances within `radius` of any point one place forward among their siblings (with `alt`, one place backward), once for the stroke, and does not move them; size keeps the instances where they are, `affectsDensity` included; stain and style keep each instance's amount and move its paint toward `color` or the style (stain by the tool's amount at its distance from the point, style by the brush's strength there), whatever `method` is, and leave an instance without a stain or style as it is, and `alt` has no effect. An instance counts only when it changes, and no undo step is added when none does (none under the brush, average with each already at the mean, each already at the tool's limit, or shift with nothing to move or change). A `method` that is none of the three, or a pressure that isn't a number, is an error",
has_doc,
symbol_adjust
),
+7 -3
View File
@@ -86,8 +86,9 @@ pub(super) fn spacing(density: f64) -> f64 {
}
/// The document key that holds each symbol set's Symbol Set Density: `{set id: density}`, written
/// when the Symbol Sprayer creates a set and when `symbol.setDensity` spaces it.
const SET_DENSITY_KEY: &str = "symbolSetDensity";
/// when the Symbol Sprayer creates a set and when `symbol.setDensity` spaces it, and copied to a
/// copy of a set by [`Document::reid`].
const SET_DENSITY_KEY: &str = Document::SYMBOL_SET_DENSITY_KEY;
/// The Symbol Set Density symbol set `set` was created at or last given (None when not recorded).
fn set_density_of(d: &Document, set: NodeId) -> Option<f64> {
@@ -261,7 +262,10 @@ pub(super) fn mean(looks: &[&Look], at: Point, with_gap: bool) -> Option<Mean> {
cos += l.angle.cos();
opacity += l.opacity;
middle += l.center.to_vec2();
if let Some((p, o)) = &l.fill {
// A fill at no opacity shows nothing: it is no stain or style, and its paint is not taken.
if let Some((p, o)) = &l.fill
&& *o > 0.0
{
amount += o;
let far = l.center.distance(at);
if paint.is_none_or(|(_, nearest)| far < nearest) {
+174 -32
View File
@@ -118,6 +118,20 @@ fn instances_of(d: &Document, name: Option<&str>) -> Vec<NodeId> {
v
}
/// The symbol instances in `nodes` and inside them, each once, in the order a walk of each node in
/// turn first reaches them.
fn instances_in<'a>(nodes: impl IntoIterator<Item = &'a Node>) -> Vec<NodeId> {
let (mut v, mut seen) = (vec![], std::collections::HashSet::new());
for n in nodes {
n.walk(&mut |c| {
if matches!(c.kind, NodeKind::SymbolInstance { .. }) && seen.insert(c.id) {
v.push(c.id);
}
});
}
v
}
/// The symbols an instance in `n` (its opacity masks included) places, pushed onto `out`.
fn art_symbols(n: &Node, out: &mut Vec<String>) {
vectorcraft_doc::swatches::walk_with_masks(n, &mut |m| {
@@ -917,11 +931,12 @@ fn samples(p: &Value, cmd: &str) -> Result<Vec<(Point, f64)>> {
let a = p.get("points").and_then(Value::as_array).ok_or_else(|| bad(cmd, "missing points [[x,y]…]"))?;
let mut v = Vec::with_capacity(a.len());
for q in a {
let (Some(x), Some(y)) = (q.get(0).and_then(Value::as_f64), q.get(1).and_then(Value::as_f64)) else { continue };
// The pressure is checked first: a point skipped for its coordinates still has a bad one refused.
let pressure = match q.get(2) {
None | Some(Value::Null) => 1.0,
Some(f) => f.as_f64().filter(|f| f.is_finite()).ok_or_else(|| bad(cmd, format!("a point's pressure must be a number, not {f}")))?,
};
let (Some(x), Some(y)) = (q.get(0).and_then(Value::as_f64), q.get(1).and_then(Value::as_f64)) else { continue };
v.push((Point::new(x, y), pressure.clamp(0.0, 1.0)));
}
if v.is_empty() || v.iter().any(|(q, _)| !q.x.is_finite() || !q.y.is_finite()) {
@@ -930,13 +945,15 @@ fn samples(p: &Value, cmd: &str) -> Result<Vec<(Point, f64)>> {
Ok(v)
}
/// The fill of the graphic style `p` names with `style`, else of the document's first style after
/// the default one.
/// The fill of the graphic style `p` names with `style`, else (no name, or one the document has no
/// style for, such as the Symbol Styler's style from another document) of the document's first
/// style after the default one.
fn style_paint(d: &Document, p: &Value) -> Option<Paint> {
match str_param(p, "style") {
Some(n) => d.graphic_styles.iter().find(|g| g.name == n).map(|g| g.appearance.fill_paint()),
None => d.graphic_styles.get(1).or(d.graphic_styles.first()).map(|g| g.appearance.fill_paint()),
}
str_param(p, "style")
.and_then(|n| d.graphic_styles.iter().find(|g| g.name == n))
.or(d.graphic_styles.get(1))
.or(d.graphic_styles.first())
.map(|g| g.appearance.fill_paint())
}
/// Deterministic per-point jitter in [-1, 1]² (so previews re-applied on the snapshot agree).
@@ -976,7 +993,7 @@ pub(super) fn symbol_spray(s: &mut Session, p: &Value) -> Result<Value> {
}
let style = style_paint(&st.doc, p);
// Style: User Defined uses the style `style` names, so one the document does not have is an error.
if let Some(n) = str_param(p, "style").filter(|_| !modes.style && style.is_none()) {
if let Some(n) = str_param(p, "style").filter(|n| !modes.style && !st.doc.graphic_styles.iter().any(|g| g.name == *n)) {
return Err(bad(C, format!("unknown graphic style `{n}`")));
}
let size = natural_size(&st.doc, &name);
@@ -1129,6 +1146,7 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
let use_pressure = switch_or(p, "usePressure", false, C)?;
let proportional = switch_or(p, "proportional", true, C)?;
let affects_density = switch_or(p, "affectsDensity", false, C)?;
let shift = switch_or(p, "shift", false, C)?;
// The Symbol Shifter has no Method.
let method = if tool == "shift" { method_param(p, C).map(|_| Method::UserDefined)? } else { method_param(p, C)? };
// Refused while an object of a dynamic instance's art is selected: the instance stays as it is.
@@ -1141,20 +1159,8 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
let style_paint = style_paint(&st.doc, p);
let candidates: Vec<NodeId> = {
let d = &st.doc;
let mut v = vec![];
if st.selection.is_empty() {
v = instances_of(d, None);
} else {
for id in &st.selection.objects {
if let Some(n) = d.node(*id) {
n.walk(&mut |c| {
if matches!(c.kind, NodeKind::SymbolInstance { .. }) && !v.contains(&c.id) {
v.push(c.id);
}
});
}
}
}
let mut v =
if st.selection.is_empty() { instances_of(d, None) } else { instances_in(st.selection.objects.iter().filter_map(|id| d.node(*id))) };
let editable = d.editable();
v.retain(|id| editable(*id));
v
@@ -1172,12 +1178,39 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
// for the whole stroke (and for every preview of it).
let first = pts.first().map_or(Point::ZERO, |(q, _)| *q);
let share = |id: NodeId| if method == Method::Random { jitter(id.0 as usize, first).0 + 1.0 } else { 1.0 };
// Shift with the Symbol Shifter: the instances under the brush come one place forward among
// their siblings (with `alt`, go one place backward), once for the whole stroke.
if tool == "shift" && shift {
let count = crate::cmd::colorcmds::edit_if_changed(s, label, |_, d| {
let under: std::collections::HashSet<NodeId> = candidates
.iter()
.copied()
.filter(|id| {
d.node(*id).and_then(instance_center).is_some_and(|c| {
pts.iter().any(|(q, pressure)| (if use_pressure { *pressure } else { intensity }) > 0.0 && c.distance(*q) < radius)
})
})
.collect();
let moved = restack(d, &under, alt)?;
Ok((moved, moved > 0))
})?;
return Ok(json!({ "count": count }));
}
// Shift with the Symbol Stainer or the Symbol Styler: the paint an instance's stain or style
// moves toward, and the share of the brush's strength it moves by. Shift with the Symbol Sizer
// keeps the instances where they are, Resizing Affects Density included.
let recolor = match tool.as_str() {
"stain" if shift => Some((Paint::solid(color), 0.15)),
"style" if shift => Some((style_paint.clone().unwrap_or(Paint::solid(color)), 1.0)),
_ => None,
};
let spread = affects_density && !shift;
// No undo step when no instance changes (none under the brush, or Average with each at the mean).
let count = crate::cmd::colorcmds::edit_if_changed(s, label, |orig, d| {
let mut touched = std::collections::BTreeSet::new();
let mut sides = Sides::new();
for (j, (q, pressure)) in pts.iter().enumerate() {
let delta = if j > 0 { *q - pts[j - 1].0 } else { Vec2::ZERO };
let delta = j.checked_sub(1).and_then(|i| pts.get(i)).map_or(Vec2::ZERO, |(prev, _)| *q - *prev);
// Use Pressure Pen: the pen's pressure at the point is the intensity there.
let strength = if use_pressure { *pressure } else { intensity };
// Average: the mean of the instances under the brush, as they are at this point.
@@ -1198,6 +1231,14 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
if w <= 0.0 {
continue;
}
// Shift with the Symbol Stainer or the Symbol Styler: the instance keeps the amount
// of its stain or style, and its paint moves toward the color or the style. An
// instance without one, or without a size, is left as it is.
if let Some((to, step)) = &recolor {
let fill = d.node(*id).and_then(|n| look(d, n, &mut sides)).and_then(|l| l.fill);
touched.extend(recolor_keeping_amount(d, *id, fill, to, step * w).then_some(*id));
continue;
}
// Average needs the instance's own values, so it leaves an instance without a size
// as it is; the other methods change it as before.
// The instance's own values are read for Average only.
@@ -1261,8 +1302,9 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
};
n.transform(about(Affine::scale_non_uniform(kx, ky)), false);
// Resizing Affects Density: instances move away from the brush's center as
// they grow and toward it as they shrink.
if affects_density {
// they grow and toward it as they shrink. Shift keeps the instances where
// they are, so the set's density stays as it was.
if spread {
n.transform(Affine::translate((c - *q) * ((kx * ky).sqrt() - 1.0)), false);
}
}
@@ -1280,9 +1322,10 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
"stain" | "style" => {
let paint = if tool == "style" { style_paint.clone().unwrap_or(Paint::solid(color)) } else { Paint::solid(color) };
let (paint, o) = match &avg {
// Toward the mean amount, keeping the stain or style the instance has.
// Toward the mean amount, keeping the stain or style the instance has
// (one at no opacity is none).
Some((t, look)) => {
let (own, cur) = look.fill.clone().map_or((None, 0.0), |(p, o)| (Some(p), o));
let (own, cur) = look.fill.clone().filter(|(_, o)| *o > 0.0).map_or((None, 0.0), |(p, o)| (Some(p), o));
(own.or(t.paint.clone()).unwrap_or(paint), (cur + (t.amount - cur) * w.min(1.0)) as f32)
}
// Alt with the Symbol Styler removes the instance's appearance.
@@ -1292,11 +1335,11 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
}
None => {
let cur = n.appearance.fill().filter(|f| f.paint == paint).map(|f| f.opacity).unwrap_or(0.0);
// The style goes on gradually, by the brush's strength there: in
// full at the center at full intensity or pressure.
let step = match (tool.as_str(), method) {
// Random: the instance's share of the style, scaled by the
// brush strength there.
("style", Method::Random) => (share / 2.0 * w.min(1.0)) as f32,
("style", _) => 1.0,
("style", Method::Random) => (w * share / 2.0) as f32,
("style", _) => w as f32,
_ => (0.15 * w * share) as f32,
};
(paint, if alt { cur - step } else { cur + step })
@@ -1324,9 +1367,108 @@ pub(super) fn symbol_adjust(s: &mut Session, p: &Value) -> Result<Value> {
}
}
}
// An instance the stroke moved away and back again is not counted.
// An instance the stroke moved away and back again, or reached but left as it was (at a
// limit already), is not counted.
touched.retain(|id| d.node(*id) != orig.node(*id));
Ok((touched.len(), !touched.is_empty()))
})?;
Ok(json!({ "count": count }))
}
/// Move the paint of instance `id`'s stain or style (`fill`, its topmost fill with the amount)
/// toward `to` by `t`. The fill keeps its amount and everything else it has, and the instance's
/// other appearance items stay as they are. A paint with no form between it and `to` (a solid
/// color and a pattern, say) takes `to` at once, so repeated strokes below half strength still
/// reach it. An instance without a stain or style, or one whose paint does not change, is left as
/// it is. Returns whether it changed.
fn recolor_keeping_amount(d: &mut Document, id: NodeId, fill: Option<(Paint, f64)>, to: &Paint, t: f64) -> bool {
use vectorcraft_doc::blend::lerp_paint;
let Some((own, _)) = fill.filter(|(_, o)| *o > 0.0) else { return false };
let t = t.clamp(0.0, 1.0) as f32;
let mut paint = lerp_paint(&own, to, t);
// `lerp_paint` switches such a pair halfway, so just below half it still gives `own`.
if paint == own && t > 0.0 && lerp_paint(&own, to, 0.49) == own {
paint = to.clone();
}
if paint == own {
return false;
}
let Some(f) = d.node_mut(id).and_then(|n| n.appearance.fill_mut()) else { return false };
f.paint = paint;
true
}
/// Bring each of `ids` one place forward among its siblings past a sibling that is not one of them
/// (`back`: one place backward). Ones already in front of (behind) every other sibling stay, and
/// so do the clipping path of a clip group and the ruler guides above a layer's art. Returns how
/// many moved.
fn restack(d: &mut Document, ids: &std::collections::HashSet<NodeId>, back: bool) -> Result<usize> {
let parents: std::collections::BTreeSet<Option<NodeId>> = ids.iter().map(|id| d.parent_of(*id)).collect();
let mut moved = 0;
for par in parents {
let floor = usize::from(par.and_then(|p| d.node(p)).is_some_and(Node::clips));
let ch = d.children_mut(par)?;
let len = Node::guide_run_start(ch);
if len <= floor + 1 {
continue;
}
let picked = |n: &Arc<Node>| ids.contains(&n.id);
if back {
for i in floor + 1..len {
if picked(&ch[i]) && !picked(&ch[i - 1]) {
ch.swap(i - 1, i);
moved += 1;
}
}
} else {
for i in (floor..len - 1).rev() {
if picked(&ch[i]) && !picked(&ch[i + 1]) {
ch.swap(i, i + 1);
moved += 1;
}
}
}
}
Ok(moved)
}
#[cfg(test)]
mod tests {
use super::*;
fn instance(id: u64) -> Arc<Node> {
Arc::new(Node::new(NodeId(id), NodeKind::SymbolInstance { symbol: "Dot".into(), xf: Affine::IDENTITY }))
}
/// The instances come out in the order a search of the list built so far gives: nested
/// groups, a group listed twice, a member listed after its group and one listed before it.
#[test]
fn instances_in_matches_searching_the_list_so_far() {
let groups: Vec<Node> = (0..40u64)
.map(|g| {
let base = g * 100;
let mut children: Vec<Arc<Node>> = (0..40).map(|i| instance(base + i)).collect();
let inner = (40..50).map(|i| instance(base + i)).collect();
children.insert(20, Arc::new(Node::group(NodeId(base + 90), inner)));
children.push(Arc::new(Node::group(NodeId(base + 91), vec![])));
Node::group(NodeId(base + 99), children)
})
.collect();
let early = Node::new(NodeId(1_245), NodeKind::SymbolInstance { symbol: "Dot".into(), xf: Affine::IDENTITY });
let late = Node::new(NodeId(305), NodeKind::SymbolInstance { symbol: "Dot".into(), xf: Affine::IDENTITY });
let nodes: Vec<&Node> = std::iter::once(&early).chain(&groups).chain([&groups[0], &late, &groups[7]]).collect();
let mut searched = vec![];
for n in &nodes {
n.walk(&mut |c| {
if matches!(c.kind, NodeKind::SymbolInstance { .. }) && !searched.contains(&c.id) {
searched.push(c.id);
}
});
}
let found = instances_in(nodes.iter().copied());
assert_eq!(found, searched);
assert_eq!(found.len(), 2_000);
assert_eq!(found[0], NodeId(1_245));
assert!(instances_in([]).is_empty());
}
}
+1 -1
View File
@@ -42,7 +42,7 @@ pub(crate) use live_paint::{LivePaintMove, check_part_name, clear_part_name, iso
use live_paint::{lp_expand, lp_fill, lp_gap_options, lp_info, lp_make, lp_merge, lp_release, lp_stroke_edge};
use shape_builder::{sb_merge, sb_regions};
pub(crate) use trace::TracePresetChanges;
pub use trace::{TracePreset, TracePresetChange, TraceRun, Traced};
pub use trace::{TracePreset, TracePresetChange, TraceRun, Traced, image_trace_target};
use trace::{trace_expand, trace_make, trace_presets_delete, trace_presets_save, trace_release, trace_set_view};
/// Name of an Image Trace group.
+28 -21
View File
@@ -58,9 +58,10 @@ fn view_param(cmd: &str, p: &Value) -> Result<Option<TraceView>> {
v.as_str().and_then(TraceView::from_id).map(Some).ok_or_else(|| bad(cmd, format!("view must be one of {}", ids())))
}
/// The `split` param (the Split view's divider, 0 to 1), if given.
/// The `split` param (the Split view's divider, 0 to 1), if given. A null divider is an error, as
/// any other value that is not such a number is; only an omitted one keeps the divider.
fn split_param(cmd: &str, p: &Value) -> Result<Option<f64>> {
let Some(v) = p.get("split").filter(|v| !v.is_null()) else { return Ok(None) };
let Some(v) = p.get("split") else { return Ok(None) };
v.as_f64().filter(|f| (0.0..=1.0).contains(f)).map(Some).ok_or_else(|| bad(cmd, "split must be a number from 0 to 1"))
}
@@ -606,6 +607,30 @@ struct Prepared {
library: Vec<([u8; 3], Paint)>,
}
/// The object `imageTrace.make` would trace, without preparing settings or reading image bytes.
pub fn image_trace_target(s: &Session, p: &Value) -> Result<NodeId> {
target_image(s, "imageTrace.make", p).map(|(target, _)| target)
}
fn target_image(s: &Session, c: &str, p: &Value) -> Result<(NodeId, Box<ImageObject>)> {
let roots = root_ids(s, p)?;
let d = &s.doc()?.doc;
roots
.iter()
.find_map(|r| {
let n = d.node(*r)?;
match &n.kind {
NodeKind::Image(i) => Some((*r, i.clone())),
_ if is_trace_group(n) => match &n.children()?.first()?.kind {
NodeKind::Image(i) => Some((*r, i.clone())),
_ => None,
},
_ => None,
}
})
.ok_or_else(|| bad(c, "select an image (or an Image Trace group)"))
}
/// What command `c` with params `p` traces, and how, from the session: everything but the trace.
fn prepare(s: &Session, c: &str, p: &Value) -> Result<Prepared> {
let mut params = trace_params(s, c, p)?;
@@ -625,25 +650,7 @@ fn prepare(s: &Session, c: &str, p: &Value) -> Result<Prepared> {
None if is(tr::preset(named)) || is(tr::enhanced_preset(named)) => named.to_string(),
None => "Custom".to_string(),
};
let roots = root_ids(s, p)?;
// The image (inside a trace group, or selected directly).
let (target, image) = {
let d = &s.doc()?.doc;
roots
.iter()
.find_map(|r| {
let n = d.node(*r)?;
match &n.kind {
NodeKind::Image(i) => Some((*r, i.clone())),
_ if is_trace_group(n) => match &n.children()?.first()?.kind {
NodeKind::Image(i) => Some((*r, i.clone())),
_ => None,
},
_ => None,
}
})
.ok_or_else(|| bad(c, "select an image (or an Image Trace group)"))?
};
let (target, image) = target_image(s, c, p)?;
if by_color && s.doc()?.doc.node(target).is_some_and(vectorcraft_render::effects::has_pathfinder) {
return Err(bad(c, LIVE_PATHFINDER_BY_COLOR));
}
+4
View File
@@ -109,6 +109,9 @@ pub struct Clipboard {
/// The selected ruler guides copied with (or without) the objects (#3226), as canvas guides on
/// no layer: pasting puts them on the layer new art goes to, moved as the objects are.
pub guides: Vec<vectorcraft_doc::Guide>,
/// The Symbol Set Density recorded at Copy for each copied symbol set, by its id in
/// [`Self::nodes`]: a pasted set packs from it.
pub set_densities: BTreeMap<NodeId, Value>,
/// The RGB and CMYK profiles the objects' colors showed through in the document they were
/// copied from (its assigned profiles, else the working spaces then), by name; none for objects
/// from outside an open document. Paste compares them with the destination's
@@ -484,6 +487,7 @@ impl Clipboard {
})
.collect(),
guides: self.guides.clone(),
set_densities: self.set_densities.clone(),
source_profiles: self.source_profiles.clone(),
colors_converted: self.colors_converted,
}
@@ -1161,6 +1161,7 @@ impl Clipboard {
char_styles: pick(Res::CharStyle, &src.char_styles),
para_styles: pick(Res::ParaStyle, &src.para_styles),
brushes,
set_densities: src.set_densities_of(&nodes),
nodes,
..Default::default()
}
+84 -24
View File
@@ -26,6 +26,8 @@ use vectorcraft_render::proof;
use super::EngineError;
use super::{CommandSpec, Result, Session, always, bad, cmd, color_value, has_doc, switch_or, targets, text_param};
pub mod proof_file;
/// `Document.unknown` key under which files before format v3 kept the assigned profiles (migrated
/// to `Document::color_profiles` on load).
pub const PROFILES_KEY: &str = vectorcraft_doc::profiles::LEGACY_PROFILES_KEY;
@@ -82,7 +84,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Convert Color",
[],
None,
"{color (#rrggbbaa and #rgba are refused), to: \"rgb\"|\"cmyk\"|\"gray\"|\"lab\", intent?} → {model, values, hex, lab: [L,a,b], outOfGamut, deltaE}",
"{color (#rrggbbaa and #rgba are refused), to: \"rgb\"|\"cmyk\"|\"gray\"|\"lab\"|\"oklch\", intent?} → {model, values, hex, lab: [L,a,b], outOfGamut, deltaE}; oklch values are [L (0..100 %), C, H (0..360°)] of the color's display sRGB (CSS Color 4 OKLCH: https://www.w3.org/TR/css-color-4/#specifying-oklab-oklch), with H 0 for a gray; a color outside sRGB (a Lab color, a CMYK color or an RGB color in a wider working RGB space) is clipped to sRGB first",
always,
convert_color
),
@@ -100,10 +102,46 @@ pub fn specs() -> Vec<CommandSpec> {
"Proof Setup",
["View", "Proof Setup"],
None,
"{target?: \"workingCmyk\"|\"cmyk:<profile>\"|\"legacyMacRgb\"|\"srgb\"|\"monitorRgb\"|\"protanopia\"|\"deuteranopia\"|\"tritanopia\", intent?, simulatePaper?, proof?: bool (also turn Proof Colors on)} → proof state",
"{target?: \"workingCmyk\"|\"cmyk:<profile>\"|\"rgb:<profile>\"|\"legacyMacRgb\"|\"srgb\"|\"monitorRgb\"|\"protanopia\"|\"deuteranopia\"|\"tritanopia\" (cmyk: and rgb: name a CMYK or RGB profile of color.loadProfile or the built-in ones: the device to simulate), intent? (used while preserveNumbers is off), simulatePaper?: bool, preserveNumbers?: bool (Preserve CMYK or RGB Numbers: the colors' numbers in the document's space go to the device unchanged), simulateBlack?: bool (Simulate Black Ink: the device's black shows as the dark gray it prints; simulatePaper does this too; CMYK devices only, as simulatePaper), proof?: bool (also turn Proof Colors on)} → proof state",
always,
proof_setup
),
cmd!(
query "view.proofSetup.save",
"Save Proof Setup…",
[],
None,
"{path?: file | name?: a setup in the Proof Setups folder next to the preferences (at most 100 characters and no path characters; exactly one of the two), target?, intent?, simulatePaper?, preserveNumbers?, simulateBlack? (as view.proofSetup; default: the current proof setup's)} write a custom proof setup to a VectorCraft proof setup file (.vcproof, JSON) without changing the proof view. The target must be a device: workingCmyk, cmyk:<profile> or rgb:<profile> → {path, target, intent, simulatePaper, preserveNumbers, simulateBlack}",
always,
proof_file::save
),
cmd!(
query "view.proofSetup.load",
"Load Proof Setup…",
[],
None,
"{path?: file | name?: a setup in the Proof Setups folder (exactly one of the two)} read a proof setup file of at most 64 KiB that view.proofSetup.save wrote, make it the proof setup and turn Proof Colors on → {path} and the proof state. A file whose device names a profile that is not loaded is refused and nothing changes",
always,
proof_file::load
),
cmd!(
query "view.proofSetup.read",
"Read Proof Setup",
[],
None,
"{path?: file | name?: a setup in the Proof Setups folder (exactly one of the two)} the settings of a proof setup file, read as view.proofSetup.load reads it, without changing the proof view → {path, target, intent, simulatePaper, preserveNumbers, simulateBlack}",
always,
proof_file::read
),
cmd!(
query "view.proofSetup.list",
"Saved Proof Setups",
[],
None,
"{} the proof setup files in the Proof Setups folder next to the preferences, by name, at most 100 → {folder (null without the folder), setups: [{name, path}], truncated}",
always,
proof_file::list
),
cmd!(query "view.proofColors", "Proof Colors", ["View"], None, "{on?: bool (default: toggle)} → proof state", always, |s, p| {
toggle_view(s, p, "view.proofColors", |v, on| v.proof_colors = on.unwrap_or(!v.proof_colors))
}),
@@ -261,7 +299,7 @@ fn load_profile(s: &mut Session, p: &Value) -> Result<Value> {
use_front_profiles(s);
touch_all(s);
} else if proof_targets(&info.name) {
// A new file of the CMYK profile View → Proof Setup targets: redraw.
// A new file of the profile View → Proof Setup targets: redraw.
touch_all(s);
} else {
// Documents behind the front one draw through their own profiles: those assigned it redraw.
@@ -292,7 +330,7 @@ fn remove_profile(s: &mut Session, p: &Value) -> Result<Value> {
if active.rgb == name || active.cmyk == name {
use_front_profiles(s);
}
// The CMYK profile View → Proof Setup targets: redraw.
// The profile View → Proof Setup targets: redraw.
if proof_targets(&info.name) {
touch_all(s);
}
@@ -311,9 +349,9 @@ fn touch_assigned(s: &mut Session, name: &str) {
}
}
/// Whether View → Proof Setup targets the CMYK profile `name`.
/// Whether View → Proof Setup targets the CMYK or RGB profile `name`.
fn proof_targets(name: &str) -> bool {
matches!(proof::view().setup.target, ProofTarget::Cmyk(t) if t == name)
matches!(proof::view().setup.target, ProofTarget::Cmyk(t) | ProofTarget::Rgb(t) if t == name)
}
#[cfg(target_arch = "wasm32")]
@@ -1003,7 +1041,7 @@ impl PasteProfile {
if o.keys().any(|k| k != "rgb" && k != "cmyk") {
return Err(refuse());
}
let model = |m: &str| o.get(m).map(&one).transpose();
let model = |m: &str| o.get(m).map(one).transpose();
Ok(Some(PasteChoice { rgb: model("rgb")?, cmyk: model("cmyk")? }))
}
Some(v) => {
@@ -1324,10 +1362,15 @@ fn convert_color(_: &mut Session, p: &Value) -> Result<Value> {
let intent = intent_param(p, C)?.unwrap_or(c.settings().intent);
let lab = c.lab(&col);
let (model, vals) = match text_param(p, "to", C)?.unwrap_or("rgb") {
"rgb" => ("rgb", values(&c.convert(&col, Model::Rgb, intent))),
"cmyk" => ("cmyk", values(&c.convert(&col, Model::Cmyk, intent))),
"gray" | "grayscale" => ("gray", values(&c.convert(&col, Model::Gray, intent))),
"lab" => ("lab", vec![lab.l, lab.a, lab.b]),
"rgb" => ("rgb", json!(values(&c.convert(&col, Model::Rgb, intent)))),
"cmyk" => ("cmyk", json!(values(&c.convert(&col, Model::Cmyk, intent)))),
"gray" | "grayscale" => ("gray", json!(values(&c.convert(&col, Model::Gray, intent)))),
"lab" => ("lab", json!([lab.l, lab.a, lab.b])),
"oklch" => {
// RGB numbers past 0..1 ([2, 2, 2]) display clipped, as `hex` reports them.
let [l, ch, h] = vectorcraft_color::oklab::to_oklch(c.display_rgb(&col).map(|v| v.clamp(0.0, 1.0)));
("oklch", json!([l * 100.0, ch, h]))
}
other => return Err(bad(C, format!("unknown model `{other}`"))),
};
let de = c.gamut_error(&col);
@@ -1392,6 +1435,8 @@ fn view_json(v: &proof::ProofView) -> Value {
"target": v.setup.target.id(),
"intent": v.setup.intent.id(),
"simulatePaper": v.setup.simulate_paper,
"preserveNumbers": v.setup.preserve_numbers,
"simulateBlack": v.setup.simulate_black,
"proofColors": v.proof_colors,
"overprintPreview": v.overprint,
"separations": v.separations,
@@ -1401,19 +1446,7 @@ fn view_json(v: &proof::ProofView) -> Value {
fn proof_setup(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "view.proofSetup";
let mut v = proof::view();
if let Some(t) = text_param(p, "target", C)? {
let t = ProofTarget::parse(t).ok_or_else(|| bad(C, format!("unknown proof target `{t}`")))?;
if let ProofTarget::Cmyk(name) = &t
&& !cms::profile(name).is_some_and(|k| k.kind == cms::ProfileKind::Cmyk)
{
return Err(bad(C, format!("unknown CMYK profile `{name}`")));
}
v.setup.target = t;
}
if let Some(i) = intent_param(p, C)? {
v.setup.intent = i;
}
v.setup.simulate_paper = switch_or(p, "simulatePaper", v.setup.simulate_paper, C)?;
setup_params(p, &mut v.setup, C)?;
if let Some(on) = on_param(p, "proof", C)? {
v.proof_colors = on;
}
@@ -1421,6 +1454,33 @@ fn proof_setup(s: &mut Session, p: &Value) -> Result<Value> {
Ok(view_json(&v))
}
/// Take the proof setup settings `p` gives (`target`, `intent`, `simulatePaper`, `preserveNumbers`
/// and `simulateBlack`, as `view.proofSetup` reads them) into `setup`. A `cmyk:` or `rgb:` target
/// must name a CMYK or RGB profile that is loaded.
fn setup_params(p: &Value, setup: &mut cms::ProofSetup, cmd: &str) -> Result<()> {
if let Some(t) = text_param(p, "target", cmd)? {
let t = ProofTarget::parse(t).ok_or_else(|| bad(cmd, format!("unknown proof target `{t}`")))?;
if let ProofTarget::Cmyk(name) = &t
&& !cms::profile(name).is_some_and(|k| k.kind == cms::ProfileKind::Cmyk)
{
return Err(bad(cmd, format!("unknown CMYK profile `{name}`")));
}
if let ProofTarget::Rgb(name) = &t
&& !cms::profile(name).is_some_and(|k| k.kind == cms::ProfileKind::Rgb)
{
return Err(bad(cmd, format!("unknown RGB profile `{name}`")));
}
setup.target = t;
}
if let Some(i) = intent_param(p, cmd)? {
setup.intent = i;
}
setup.simulate_paper = switch_or(p, "simulatePaper", setup.simulate_paper, cmd)?;
setup.preserve_numbers = switch_or(p, "preserveNumbers", setup.preserve_numbers, cmd)?;
setup.simulate_black = switch_or(p, "simulateBlack", setup.simulate_black, cmd)?;
Ok(())
}
/// Make `v` the proof view and redraw every document. When `v` equals the current view, the view
/// and the revisions stay as they are; Separations Preview's visible plates are compared as a set.
fn store_view(s: &mut Session, v: proof::ProofView) {
@@ -0,0 +1,288 @@
//! View → Proof Setup → Customize…'s Save… and Load…: a custom proof setup (the device to simulate,
//! Preserve Numbers, the rendering intent, Simulate Paper Color and Simulate Black Ink) in a file,
//! and the setups saved in the `Proof Setups` folder next to the preferences, which View → Proof
//! Setup lists ([`Session::attach_proof_setups`]). `view.proofSetup.read` reads a file without
//! applying it, which is how Load… fills the dialog.
//!
//! The file format is VectorCraft's own: JSON with `format` [`FORMAT`], `version` 1, `target`,
//! `intent`, `simulatePaper`, `preserveNumbers` and `simulateBlack`, as `view.proofSetup` names
//! them, at most [`MAX_FILE`] bytes.
use serde_json::{Value, json};
use vectorcraft_color::cms::{self, Intent, ProofSetup, ProofTarget};
use vectorcraft_render::proof;
use super::super::{EngineError, fileio};
use super::{Result, Session, bad, setup_params, store_view, text_param, view_json};
/// The extension of a proof setup file.
pub const EXT: &str = "vcproof";
/// The `format` a proof setup file names.
pub const FORMAT: &str = "vectorcraft-proof-setup";
/// The format version this build writes and reads.
const VERSION: u64 = 1;
/// The largest proof setup file `view.proofSetup.load` reads, bytes (VectorCraft's own limit).
pub const MAX_FILE: usize = 64 << 10;
/// The most setups `view.proofSetup.list` lists.
pub const MAX_LISTED: usize = 100;
/// The most folder entries `view.proofSetup.list` looks at, setup files or not.
const MAX_SCANNED: usize = 100_000;
/// The longest `name`, in characters.
const MAX_NAME: usize = 100;
impl Session {
/// Keep the proof setups that `view.proofSetup.save` saves by name in the folder `dir` (`Proof
/// Setups` next to the preferences), which `view.proofSetup.list` lists. The folder is made
/// when a setup is first saved there.
pub fn attach_proof_setups(&mut self, dir: std::path::PathBuf) {
self.proof_setup_dir = Some(dir);
}
/// The saved proof setups' folder ([`Session::attach_proof_setups`]); none on the web.
pub fn proof_setup_dir(&self) -> Option<&std::path::Path> {
self.proof_setup_dir.as_deref().filter(|_| !cfg!(target_arch = "wasm32"))
}
/// How many proof setup files `view.proofSetup.save` wrote in this session; the menus list the
/// Proof Setups folder again when it changes.
pub fn proof_setup_saves(&self) -> u64 {
self.proof_setup_saves
}
}
/// The file `p` names for `cmd`: its `path`, or the setup `name` in the Proof Setups folder.
fn file_path(s: &Session, p: &Value, cmd: &str) -> Result<(String, bool)> {
match (text_param(p, "path", cmd)?, text_param(p, "name", cmd)?) {
(Some(path), None) if path.trim().is_empty() => Err(bad(cmd, "`path` is empty")),
(Some(path), None) => Ok((path.to_string(), false)),
(None, Some(name)) => {
let name = setup_name(name, cmd)?;
let dir = s.proof_setup_dir().ok_or_else(|| bad(cmd, "saved proof setups need the preferences folder, which this run doesn't have"))?;
let path = dir.join(format!("{name}.{EXT}"));
let path = path.to_str().ok_or_else(|| bad(cmd, format!("{}: the folder's path is not valid Unicode", dir.display())))?;
Ok((path.to_string(), true))
}
(Some(_), Some(_)) => Err(bad(cmd, "give `path` or `name`, not both")),
(None, None) => Err(bad(cmd, "missing `path` or `name`")),
}
}
/// `name` trimmed, when it can name a file in the Proof Setups folder: not empty, at most
/// [`MAX_NAME`] characters, no path or control characters, and not starting with a dot.
fn setup_name<'a>(name: &'a str, cmd: &str) -> Result<&'a str> {
let name = name.trim();
if name.is_empty() {
return Err(bad(cmd, "`name` is empty"));
}
if name.chars().count() > MAX_NAME {
return Err(bad(cmd, format!("`name` is longer than {MAX_NAME} characters")));
}
if name.starts_with('.') || name.chars().any(|c| c.is_control() || matches!(c, '/' | '\\' | ':' | '*' | '?' | '"' | '<' | '>' | '|')) {
return Err(bad(cmd, format!("`name` can't hold path characters: `{name}`")));
}
Ok(name)
}
/// `Ok` when `t` is a device a custom proof setup can simulate and its profile is loaded.
fn check_device(t: &ProofTarget) -> std::result::Result<(), String> {
let loaded = |name: &str, kind| cms::profile(name).is_some_and(|k| k.kind == kind);
match t {
ProofTarget::WorkingCmyk => Ok(()),
ProofTarget::Cmyk(name) if loaded(name, cms::ProfileKind::Cmyk) => Ok(()),
ProofTarget::Rgb(name) if loaded(name, cms::ProfileKind::Rgb) => Ok(()),
ProofTarget::Cmyk(name) => Err(format!("the device to simulate is the CMYK profile `{name}`, which is not loaded")),
ProofTarget::Rgb(name) => Err(format!("the device to simulate is the RGB profile `{name}`, which is not loaded")),
t => Err(format!("`{}` is not a device to simulate: a custom proof setup simulates workingCmyk, cmyk:<profile> or rgb:<profile>", t.id())),
}
}
/// The settings of `setup`, as `view.proofSetup` names them.
fn setup_json(setup: &ProofSetup) -> serde_json::Map<String, Value> {
let v = json!({
"target": setup.target.id(),
"intent": setup.intent.id(),
"simulatePaper": setup.simulate_paper,
"preserveNumbers": setup.preserve_numbers,
"simulateBlack": setup.simulate_black,
});
match v {
Value::Object(m) => m,
_ => serde_json::Map::new(),
}
}
/// The proof setup in a file's `bytes`, or why it can't be read.
pub fn parse(bytes: &[u8]) -> std::result::Result<ProofSetup, String> {
let v: Value = serde_json::from_slice(bytes).map_err(|e| format!("not a proof setup file: {e}"))?;
if v.get("format").and_then(Value::as_str) != Some(FORMAT) {
return Err("not a VectorCraft proof setup file".into());
}
match v.get("version").and_then(Value::as_u64) {
Some(VERSION) => {}
Some(n) if n > VERSION => return Err(format!("the file is version {n}, made by a newer VectorCraft")),
_ => return Err("the file has no version VectorCraft reads".into()),
}
let text = |key: &str| v.get(key).and_then(Value::as_str);
let target = text("target").ok_or("the file names no device to simulate")?;
let target = ProofTarget::parse(target).ok_or_else(|| format!("unknown proof target `{target}`"))?;
let intent = text("intent").ok_or("the file names no rendering intent")?;
let intent = Intent::parse(intent).ok_or_else(|| format!("unknown intent `{intent}`"))?;
let on = |key: &str| match v.get(key) {
None | Some(Value::Null) => Ok(false),
Some(Value::Bool(b)) => Ok(*b),
Some(_) => Err(format!("`{key}` must be true or false")),
};
Ok(ProofSetup {
target,
intent,
simulate_paper: on("simulatePaper")?,
preserve_numbers: on("preserveNumbers")?,
simulate_black: on("simulateBlack")?,
separations: None,
})
}
/// A proof setup file holding `setup`.
pub fn encode(setup: &ProofSetup) -> Vec<u8> {
let mut m = serde_json::Map::new();
m.insert("format".into(), json!(FORMAT));
m.insert("version".into(), json!(VERSION));
m.extend(setup_json(setup));
let mut bytes = serde_json::to_vec_pretty(&Value::Object(m)).unwrap_or_default();
bytes.push(b'\n');
bytes
}
pub(super) fn save(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "view.proofSetup.save";
let (path, named) = file_path(s, p, C)?;
let mut setup = proof::view().setup;
setup_params(p, &mut setup, C)?;
check_device(&setup.target).map_err(|e| bad(C, e))?;
// A file `view.proofSetup.load` would refuse is not written (a device with a very long name).
let bytes = encode(&setup);
if bytes.len() > MAX_FILE {
return Err(bad(C, format!("{path}: larger than {MAX_FILE} bytes")));
}
if named
&& let Some(dir) = std::path::Path::new(&path).parent()
&& !dir.is_dir()
{
crate::file_access::check_write(&path).map_err(EngineError::Other)?;
std::fs::create_dir_all(dir).map_err(|e| bad(C, format!("{}: {e}", dir.display())))?;
}
fileio::write_file(&path, &bytes)?;
s.proof_setup_saves += 1;
let mut r = setup_json(&setup);
r.insert("path".into(), json!(path));
Ok(Value::Object(r))
}
/// The file `p` names for `cmd` and the usable proof setup in it.
fn read_setup(s: &Session, p: &Value, cmd: &str) -> Result<(String, ProofSetup)> {
let (path, _) = file_path(s, p, cmd)?;
// One byte past the limit shows a file over it, which is not read further.
let bytes = fileio::read_file_head(&path, MAX_FILE + 1)?;
if bytes.len() > MAX_FILE {
return Err(bad(cmd, format!("{path}: larger than {MAX_FILE} bytes")));
}
let setup = parse(&bytes).map_err(|e| bad(cmd, format!("{path}: {e}")))?;
check_device(&setup.target).map_err(|e| bad(cmd, format!("{path}: {e}")))?;
Ok((path, setup))
}
pub(super) fn read(s: &mut Session, p: &Value) -> Result<Value> {
let (path, setup) = read_setup(s, p, "view.proofSetup.read")?;
let mut r = setup_json(&setup);
r.insert("path".into(), json!(path));
Ok(Value::Object(r))
}
pub(super) fn load(s: &mut Session, p: &Value) -> Result<Value> {
let (path, setup) = read_setup(s, p, "view.proofSetup.load")?;
let mut v = proof::view();
// Separations Preview's plates are not part of a proof setup file.
v.setup = ProofSetup { separations: v.setup.separations.take(), ..setup };
v.proof_colors = true;
store_view(s, v.clone());
let mut r = view_json(&v);
r["path"] = json!(path);
Ok(r)
}
pub(super) fn list(s: &mut Session, _: &Value) -> Result<Value> {
let none = json!({"folder": null, "setups": [], "truncated": false});
let Some(dir) = s.proof_setup_dir() else { return Ok(none) };
listed(dir).map(|l| l.unwrap_or(none))
}
/// The web keeps no saved setups ([`Session::proof_setup_dir`]).
#[cfg(target_arch = "wasm32")]
pub fn listed(_: &std::path::Path) -> Result<Option<Value>> {
Ok(None)
}
/// The listing of the Proof Setups folder `dir`, as `view.proofSetup.list` gives it; `None` for a
/// request that may not read it. The app calls it on another thread, without a session.
#[cfg(not(target_arch = "wasm32"))]
pub fn listed(dir: &std::path::Path) -> Result<Option<Value>> {
const C: &str = "view.proofSetup.list";
let folder = dir.to_string_lossy().into_owned();
// A request that may not read the folder learns nothing of it, nor where it is.
if crate::file_access::check_read(&folder).is_err() {
return Ok(None);
}
// The listed paths are text: a folder whose path is not valid Unicode can't be named in them.
if dir.to_str().is_none() {
return Err(bad(C, format!("{folder}: the folder's path is not valid Unicode")));
}
let entries = match std::fs::read_dir(dir) {
Ok(entries) => entries,
// No folder yet: nothing has been saved.
Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(Some(json!({"folder": folder, "setups": [], "truncated": false}))),
Err(e) => return Err(bad(C, format!("{folder}: {e}"))),
};
// The setups' names, the first MAX_LISTED by name; other entries are passed over before the
// limit applies. A link is not followed. A file is listed only when it is named
// `<name>.vcproof` and `name` takes that name unchanged, so each listed name loads its own
// file. An entry that can't be read, or whose file name is not valid Unicode, leaves the
// listing incomplete.
let (mut names, mut truncated) = (Vec::<String>::new(), false);
for (i, e) in entries.enumerate() {
if i == MAX_SCANNED {
truncated = true;
break;
}
let Ok(e) = e else {
truncated = true;
continue;
};
let Ok(file) = e.file_name().into_string() else {
truncated = true;
continue;
};
let Some(name) = file.strip_suffix(EXT).and_then(|s| s.strip_suffix('.')) else { continue };
if setup_name(name, C).ok() != Some(name) {
continue;
}
match e.file_type() {
Ok(t) if t.is_file() => {}
Ok(_) => continue,
Err(_) => {
truncated = true;
continue;
}
}
names.push(name.to_string());
if names.len() > 2 * MAX_LISTED {
names.sort();
names.truncate(MAX_LISTED);
truncated = true;
}
}
names.sort();
truncated |= names.len() > MAX_LISTED;
names.truncate(MAX_LISTED);
let setups: Vec<Value> = names.iter().map(|name| json!({"name": name, "path": dir.join(format!("{name}.{EXT}")).to_string_lossy()})).collect();
Ok(Some(json!({"folder": folder, "setups": setups, "truncated": truncated})))
}
+53
View File
@@ -105,6 +105,15 @@ pub fn specs() -> Vec<CommandSpec> {
has_doc,
arc
),
cmd!(
"shape.threePointArc",
"Three-Point Arc",
[],
None,
"{start: [x, y], end: [x, y], through?: [x, y], toward?: [x, y], at?: \"start\"|\"end\" (default \"start\"; only with `toward`)} → {id, cx, cy, radius, sweep}: an open circular arc from `start` to `end` in the current stroke (black when it is none) with no fill, its ends exactly at the two points (not pixel-aligned). With `through`, the arc passes through that point, an anchor of the path; with `toward`, it leaves the end `at` names heading toward that point (its tangent there). Give exactly one of `through` and `toward`; `at` with `through` is an error. `sweep` is the arc's turn in degrees, positive clockwise on the page. Two points that are the same, three on one line, or an arc reaching past the canvas are an error, and nothing is drawn",
has_doc,
three_point_arc
),
cmd!(
"shape.rectangularGrid",
"Rectangular Grid",
@@ -680,6 +689,50 @@ fn arc(s: &mut Session, p: &Value) -> Result<Value> {
insert_look_turned(s, "Arc", path_kind(path, None), look, None, true, bbox_angle, true)
}
/// An open circular arc from `start` to `end` ([`shapes::CircularArc`]): through `through`, or
/// leaving the end `at` names toward `toward`. One undo step, named as an Arc tool drag is.
fn three_point_arc(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "shape.threePointArc";
let point = |key: &str| finite_numbers::<2>(&p[key]).map(|[x, y]| Point::new(x, y)).ok_or_else(|| bad(C, format!("`{key}` must be [x, y]")));
let (start, end) = (point("start")?, point("end")?);
let from_end = match p.get("at") {
None => false,
Some(Value::String(v)) if v == "start" || v == "end" => v == "end",
Some(_) => return Err(bad(C, "`at` must be \"start\" or \"end\"")),
};
// The arc, and the point it passes through (an anchor of the path, so the path meets it exactly).
let (arc, via) = match (p.get("through"), p.get("toward")) {
(Some(_), None) if p.get("at").is_some() => return Err(bad(C, "give `at` only with `toward`")),
(Some(_), None) => {
let through = point("through")?;
(shapes::CircularArc::through(start, end, through), Some(through))
}
(None, Some(_)) if from_end => {
let toward = point("toward")?;
(shapes::CircularArc::arriving(start, end, end - toward), None)
}
(None, Some(_)) => {
let toward = point("toward")?;
(shapes::CircularArc::leaving(start, toward - start, end), None)
}
_ => return Err(bad(C, "give exactly one of `through` and `toward`")),
};
let arc = arc.ok_or_else(|| bad(C, "no arc fits these points: two are the same or all three lie on one line"))?;
let path = via.map_or_else(|| arc.to_path(), |v| arc.to_path_via(v));
let look = s.new_art_look(
vectorcraft_color::Paint::None,
if s.paint.stroke.is_none() { vectorcraft_color::Paint::solid(vectorcraft_color::Color::BLACK) } else { s.paint.stroke.clone() },
s.paint.stroke_width.max(0.1),
);
// Not pixel-aligned: the ends stay on the given points.
let mut out = insert_look_turned(s, "Arc", path_kind(path, None), look, None, true, 0.0, false)?;
out["cx"] = json!(arc.center.x);
out["cy"] = json!(arc.center.y);
out["radius"] = json!(arc.radius);
out["sweep"] = json!(arc.sweep.to_degrees());
Ok(out)
}
/// The grid `paths` (bottom first) as one selected group in the new-art stroke, filled with the
/// current fill when `fill`; a path of several subpaths becomes a compound path of them. The group
/// and its members get the bounding-box angle `bbox_angle` (a grid drawn along a Constrain Angle).
+2 -2
View File
@@ -14,7 +14,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Create Dimension",
[],
None,
"{mode?: linear|angular|radius|diameter, a?: [x,y], b?: [x,y], vertex?: [x,y], source?: {kind: segment, edge: {node,subpath,segment}}|{kind: angle, first: edge, second: edge}|{kind: circle, node}|{kind: arc, edge}|{kind: points, a?, b?, vertex?: {node,subpath,anchor}, freeA?, freeB?: a point that is not an anchor, {kind: onSegment, edge: {node,subpath,segment}, t: 0..1 (curve parameter)}|{kind: anchors, node, anchors: [{subpath,anchor,part?: point|in|out (the anchor, default, or its in or out handle),weight}] (2 or 3 points of one path whose weights add up to 1), across?: (2 anchors only: times the first-to-second anchor vector (x,y) turned to (-y,x), which points down when the vector points right)} (an end is an anchor or a free point, not both)}, orientation?: aligned|horizontal|vertical (linear only: the distance between the points, or only its horizontal or vertical part; default aligned), offset?: pt (the line's distance from the first point: along the left normal of a → b when aligned, downward when horizontal, leftward when vertical; negative goes the other way), options?: {units: in|mm|pt|pc|px|cm|m|ft|yd, precision: 0-6, scale: drawing:real, hideUnits, lineWeight, lineType: solid|dashed|dotted, lineColor: [r,g,b], arrowStyle: filled|open|tick|none, arrowScale: %, extensionWeight, extensionType, extensionColor, extensionOffset, extensionLength, hideExtensions, fontFamily, fontStyle, fontSize, textColor, textPosition: away|between, textAlignment: left|center|right, textOffset}} → {id,label}; linked measurements follow source edits",
"{mode?: linear|angular|radius|diameter, a?: [x,y], b?: [x,y], vertex?: [x,y], source?: {kind: segment, edge: {node,subpath,segment}}|{kind: angle, first: edge, second: edge}|{kind: circle, node}|{kind: arc, edge}|{kind: points, a?, b?, vertex?: {node,subpath,anchor}, freeA?, freeB?: a point that is not an anchor, {kind: onSegment, edge: {node,subpath,segment}, t: 0..1 (curve parameter)}|{kind: anchors, node, anchors: [{subpath,anchor,part?: point|in|out (the anchor, default, or its in or out handle),weight}] (2 or 3 points of one path whose weights add up to 1), across?: (2 anchors only: times the first-to-second anchor vector (x,y) turned to (-y,x), which points down when the vector points right)} (an end is an anchor or a free point, not both)}, orientation?: aligned|horizontal|vertical (linear only: the distance between the points, or only its horizontal or vertical part; default aligned), offset?: pt (the line's distance from the first point: along the left normal of a → b when aligned, downward when horizontal, leftward when vertical; negative goes the other way), options?: {units: in|mm|pt|pc|px|cm|m|ft|yd, precision: 0-6, scale: drawing:real, hideUnits, lineWeight, lineType: solid|dashed|dotted, lineColor: [r,g,b], arrowStyle: filled|open|tick|none, arrowHead: null|a built-in stroke.set arrowhead name (Barbed, LineArrow…; drawn at both ends in place of arrowStyle's head; versions that have the stroke arrowhead but do not read arrowHead draw arrowStyle when they draw the dimension again; custom arrowheads are refused), arrowScale: %, extensionWeight, extensionType, extensionColor, extensionOffset, extensionLength, hideExtensions, fontFamily, fontStyle, fontSize, textColor, textPosition: away|between, textAlignment: left|center|right, textOffset}} → {id,label}; linked measurements follow source edits",
has_doc,
create
),
@@ -565,7 +565,7 @@ fn appearance(o: &DimensionOptions, mode: ColorMode, ext: bool, arrows: bool) ->
LineType::Solid => None,
};
if arrows {
let head = o.arrow_style.arrowhead();
let head = o.arrowhead();
st.start_arrow = head.clone();
st.end_arrow = head;
st.arrow_scale = (o.arrow_scale, o.arrow_scale);
+2
View File
@@ -1568,6 +1568,8 @@ fn paste_clip(s: &mut Session, p: &Value, mode: PasteMode, clip: &Clipboard, cho
for xf in placements {
for (k, n) in clip.nodes.iter().enumerate() {
let mut c = d.reid(n);
// A pasted symbol set packs from the density recorded for it at Copy.
d.carry_set_densities(n, &c, &clip.set_densities);
imported.apply(&mut c);
let sc = vectorcraft_doc::Scaling { patterns: mode == PasteMode::Drag, ..Default::default() };
if xf != Affine::IDENTITY {
+610 -96
View File
@@ -24,20 +24,28 @@
//! Light, Pin Light, Hard Mix, Subtract, Divide, Darker Color, Lighter Color) is merged with the
//! layers below it in its group. A Dissolve layer's partly transparent pixels are merged as opaque
//! or transparent, opaque at the share of its pixels their transparency gives, in a fixed pattern
//! that differs from layer to layer. When a merge's canvases would need more memory than allowed,
//! the layer comes in alone: in the Normal mode, or unclipped.
//! Hidden layers are left out unless `hidden` asks for them. A hidden layer that would need a merge
//! (one in a mode VectorCraft lacks, one that layers are clipped to, one clipped to another, or
//! one below a merged layer) is always left out, with the layers clipped to it. Adjustment layers,
//! fill layers that store no pixels and whose fill isn't read or whose shape is a vector mask,
//! layer effects that are switched on, knockouts and vector masks aren't applied; the warnings
//! count them and the hidden layers left out.
//! that differs from layer to layer. A layer or group in a group whose Knockout setting is 1 (read
//! as a shallow knockout) is merged with the layers below it in its group too, as the import option
//! describes: where it has pixels, they are cleared to transparency and it is drawn there at its fill
//! opacity, and its opacity fades that back toward them. In a pass-through group this is done only
//! when it and the visible layers below it are in the Normal mode. When a merge's canvases would need more
//! memory than allowed, the layer comes in alone: in the Normal mode, unclipped, or without its
//! knockout. Hidden layers are left out unless `hidden` asks for them. A hidden layer that would need
//! a merge (one in a mode VectorCraft lacks, one with a knockout in a group that changes the layers
//! below it, one that layers are clipped to, one clipped to another, or one below a merged layer) is
//! always left out, with the layers clipped to it. Adjustment layers, fill layers that store no
//! pixels and whose fill isn't read or whose shape is a vector mask, layer effects that are switched
//! on, vector masks, and the knockouts of top-level layers, of clipped layers, of layers that others
//! are clipped to and of layers in a pass-through group with a layer in another mode, and other
//! Knockout values, aren't applied; the warnings count them and the hidden layers left out.
//!
//! The file is untrusted: every count, length and size is checked before anything is allocated,
//! groups nest at most [`MAX_DEPTH`] deep (layers deeper than a document may nest merge into the
//! group around them, with a warning), each layer's pixels, like the canvases one step of a
//! merge holds together, must fit the memory allowed, and all the pixels decoded and the canvases
//! the merges make must fit [`TOTAL_DECODED`] times that.
//! the merges make must fit [`TOTAL_DECODED`] times that. A merge being tried may take that much
//! past what was read before it. What the merges that aren't made, or that a hidden layer would
//! need, decoded and made is counted apart, against the same limit.
use std::cell::Cell;
use std::sync::Arc;
@@ -66,6 +74,13 @@ const MAX_CHANNELS: usize = 56;
const MIN_RECORD: usize = 34;
const DAMAGED: &str = "the PSD file's layer records are damaged";
#[cfg(test)]
thread_local! {
/// The layer lists imports on this thread have walked, and the most a test lets them walk
/// before the import stops with an error.
pub(super) static WALKS: Cell<(usize, usize)> = const { Cell::new((0, usize::MAX)) };
}
/// The keys of the tagged blocks that make a layer an adjustment layer.
const ADJUSTMENTS: [&[u8; 4]; 18] = [
b"levl", b"curv", b"brit", b"blnc", b"hue ", b"hue2", b"selc", b"mixr", b"grdm", b"phfl", b"expA", b"vibA", b"thrs", b"nvrt", b"post", b"clrL",
@@ -227,7 +242,9 @@ struct Record<'a> {
content: Content,
effects: bool,
vector_mask: bool,
knockout: bool,
/// The Knockout setting's byte (`knko`): 0 none, 1 a shallow knockout. Any other value isn't
/// applied.
knockout: u8,
}
/// The layer records of `info` (the layer count, the records, then their channels' data).
@@ -285,7 +302,7 @@ fn record<'a>(r: &mut Reader<'a>, psb: bool) -> Result<(Record<'a>, Vec<(i16, us
content: Content::Pixels,
effects: false,
vector_mask: false,
knockout: false,
knockout: 0,
};
rec.read_extra(extra, psb)?;
Ok((rec, lengths))
@@ -345,8 +362,7 @@ impl Record<'_> {
b"lfx2" | b"lmfx" => effects = Some(effects == Some(true) || effects_on(data)),
b"lrFX" => old_effects = true,
b"vmsk" | b"vsms" => self.vector_mask = true,
// Shallow or deep knockout.
b"knko" => self.knockout = data.first().is_some_and(|&k| k != 0),
b"knko" => self.knockout = data.first().copied().unwrap_or(0),
k if ADJUSTMENTS.contains(&k) => self.content = Content::Adjustment,
_ => {}
}
@@ -612,6 +628,8 @@ struct Unit<'i> {
body: Body<'i>,
/// While layers are clipped to it: how its merged canvas is shaped.
clip: Option<Clip>,
/// Layers are clipped to it, merged into it or not.
base: bool,
}
impl Unit<'_> {
@@ -640,13 +658,36 @@ enum Clip {
enum Body<'i> {
/// A layer record's pixels.
Layer(usize),
/// A group's layers.
Group(&'i [Item]),
/// A group's record and its layers.
Group(usize, &'i [Item]),
/// Layers merged into one image.
Merged(Canvas),
}
/// Where a layer list is.
#[derive(Clone, Copy, PartialEq)]
enum Level {
/// The file's top level.
Top,
/// An isolated group, or a group drawn on its own.
Group,
/// A pass-through group whose layers blend with what is below it.
Pass,
}
/// What a knockout's merge with the layers below it gives.
enum Knocked {
/// The merged canvas.
Merged(Canvas),
/// Nothing below it draws, it draws nothing, it is at 0 fill and cuts no painted pixel below
/// it, or what is below it and the merge are both transparent: it comes in as a layer of its own.
Nothing,
/// The canvases would need more memory than allowed.
TooLarge,
}
/// A unit's body drawn alone.
#[derive(Clone)]
enum Drawn {
/// It draws nothing.
Nothing,
@@ -663,6 +704,7 @@ struct Notes {
fills: usize,
effects: usize,
vector_masks: usize,
/// Layers whose knockout wasn't applied.
knockouts: usize,
/// Hidden layers left out, and layers clipped to them.
hidden: usize,
@@ -677,11 +719,17 @@ struct Notes {
/// The counts a merge that can't be made gives back.
#[derive(Clone, Copy)]
struct Counts {
/// The bytes spent so far (see [`Builder::spent`]).
spent: u64,
skipped: usize,
/// The knockouts counted as not applied.
unknocked: usize,
merged: usize,
unmerged: usize,
unclipped: usize,
clipped_out: usize,
/// The groups found to read no pixels.
blank: usize,
}
/// Adds the warning for `n` things to `out`: `one` when `n` is 1, `many` with the count in place
@@ -745,8 +793,17 @@ impl Notes {
out
}
fn counts(&self, skipped: usize) -> Counts {
Counts { skipped, merged: self.merged.len(), unmerged: self.unmerged, unclipped: self.unclipped, clipped_out: self.clipped_out }
fn counts(&self, spent: u64, skipped: usize, unknocked: usize, blank: usize) -> Counts {
Counts {
spent,
skipped,
unknocked,
merged: self.merged.len(),
unmerged: self.unmerged,
unclipped: self.unclipped,
clipped_out: self.clipped_out,
blank,
}
}
}
@@ -767,12 +824,47 @@ struct Builder<'a, F> {
notes: Notes,
/// The records [`Notes`] counted.
noted: Vec<bool>,
/// Those records, in the order they were counted.
noted_log: Vec<usize>,
/// The records counted as hidden layers left out.
skipped: Vec<bool>,
/// Those records, in the order they were counted.
skip_log: Vec<usize>,
/// The records counted as knockouts not applied.
unknocked: Vec<bool>,
/// Those records, in the order they were counted.
unknock_log: Vec<usize>,
/// The records counted as layers clipped to a fill that isn't drawn.
clipped_out: Vec<bool>,
/// Those records, in the order they were counted.
clipped_out_log: Vec<usize>,
/// The records counted as clipped layers left unclipped.
unclipped: Vec<bool>,
/// Those records, in the order they were counted.
unclip_log: Vec<usize>,
/// The records that came in as layers of the document (hidden ones too, with `hidden`): not left
/// out, though a drawing for a merge that wasn't made counted them.
kept: Vec<bool>,
/// Bytes of layer and mask pixels decoded, and of canvases the merges made, so far.
spent: Cell<u64>,
/// Those bytes that merges not made, and merges a hidden layer would need, took: given back to
/// `spent` and counted here instead, against the same limit.
wasted: Cell<u64>,
/// `spent` when the innermost merge being tried began: until it is made or given up, it may
/// spend the whole allowance past that (see [`Self::spend`]).
trial: Cell<u64>,
/// The layers whose pixels were read so far (each time they were).
painted: Cell<usize>,
/// What each group gave when drawn alone without reading any layer's pixels (nothing, or a
/// canvas without pixels, whatever the memory left): drawing it again gives that without
/// walking its layers.
blank: Vec<Option<Drawn>>,
/// The pass-through groups that laid nothing onto nothing (see [`Self::laid_nothing`]).
laid_blank: Vec<bool>,
/// The groups of both, in the order they were found.
blank_log: Vec<usize>,
/// How many times a merge was counted as not made because it needed more memory than allowed.
squeezed: usize,
}
impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
@@ -786,10 +878,38 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
}
/// Count `bytes` of decoded pixels, or of a canvas a merge makes, against the whole import's
/// allowance, [`TOTAL_DECODED`] times the memory allowed for one image.
/// allowance, [`TOTAL_DECODED`] times the memory allowed for one image. While a merge is tried
/// (see [`Self::try_from_here`]), only what it spent counts against the allowance.
fn spend(&self, bytes: u64) -> Result<(), String> {
let total = self.spent.get().saturating_add(bytes);
self.spent.set(total);
if total.saturating_sub(self.trial.get()) > self.max_alloc.saturating_mul(TOTAL_DECODED) {
return Err("the PSD file's layers take more memory to read than allowed".into());
}
Ok(())
}
/// Start trying a merge that may not be made: what it spends counts against the whole
/// allowance, however much was spent before it. Gives what [`Self::tried`] takes back.
fn try_from_here(&self) -> u64 {
self.trial.replace(self.spent.get())
}
/// End the merge tried since [`Self::try_from_here`] gave `outer`. A merge that is `made` keeps
/// what it spent, which must then fit the allowance with what was spent before it.
fn tried(&self, outer: u64, made: bool) -> Result<(), String> {
self.trial.set(outer);
if made { self.spend(0) } else { Ok(()) }
}
/// Move the bytes spent since `spent` was the count to [`Self::wasted`], which has an allowance
/// of its own as large: what a merge that isn't made decoded doesn't take the room for reading
/// the layers apart.
fn refund(&self, spent: u64) -> Result<(), String> {
let since = self.spent.get().saturating_sub(spent);
self.spent.set(self.spent.get().min(spent));
let total = self.wasted.get().saturating_add(since);
self.wasted.set(total);
if total > self.max_alloc.saturating_mul(TOTAL_DECODED) {
return Err("the PSD file's layers take more memory to read than allowed".into());
}
@@ -814,6 +934,7 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
Paint::Cmyk(ink) => (self.cmyk)(ink),
};
let px = image::Rgba([byte(rgb[0]), byte(rgb[1]), byte(rgb[2]), 255]);
self.painted.set(self.painted.get() + 1);
return Ok(Some((0, 0, RgbaImage::from_pixel(h.width, h.height, px))));
}
Content::Pixels | Content::Type | Content::Solid(_) | Content::Fill => rec.bounds.size(),
@@ -845,6 +966,7 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
let rgb = to_rgb(h, |c| planes.get(c).map_or(0.0, |p| at(p, linear, 0.0)), &self.cmyk);
image::Rgba([byte(rgb[0]), byte(rgb[1]), byte(rgb[2]), byte(at(&alpha, false, 1.0))])
});
self.painted.set(self.painted.get() + 1);
Ok(Some((i64::from(rec.bounds.left), i64::from(rec.bounds.top), img)))
}
@@ -897,7 +1019,7 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
for item in items {
let (i, body) = match item {
Item::Layer(i) => (*i, Body::Layer(*i)),
Item::Group(i, children) => (*i, Body::Group(children)),
Item::Group(i, children) => (*i, Body::Group(*i, children)),
};
let rec = self.record(i)?;
let (name, hidden, clipped, blend) = (rec.name.clone(), rec.hidden, rec.clipped, rec.blend);
@@ -920,14 +1042,26 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
Some(b) => {
// Counted even when it draws nothing (an adjustment layer).
self.note(i)?;
if !unclipped && self.clip(&mut out, b, &body, i, &name, blend, opacity)? {
// A clipped layer's knockout isn't applied.
if self.record(i)?.knockout != 0 {
self.unknock(i);
}
if let Some(u) = out.get_mut(b) {
u.base = true;
}
let spent = self.spent.get();
let outer = self.try_from_here();
let made = !unclipped && self.clip(&mut out, b, &body, i, &name, blend, opacity)?;
self.tried(outer, made)?;
if made {
continue;
}
self.refund(spent)?;
// The merge doesn't fit: this layer and the next ones clipped to the same
// base come in as layers of their own.
unclipped = true;
self.notes.unclipped += 1;
out.push(Unit { name, visible: true, opacity, blend, mask_of: Some(i), record: i, body, clip: None });
self.unclip(i);
out.push(Unit { name, visible: true, opacity, blend, mask_of: Some(i), record: i, body, clip: None, base: false });
}
}
continue;
@@ -939,7 +1073,7 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
continue;
}
self.note(i)?;
out.push(Unit { name, visible: !hidden, opacity, blend, mask_of: Some(i), record: i, body, clip: None });
out.push(Unit { name, visible: !hidden, opacity, blend, mask_of: Some(i), record: i, body, clip: None, base: false });
base = Some(Some(out.len() - 1));
}
for u in &mut out {
@@ -962,7 +1096,7 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
};
// A fill whose shape is a vector mask isn't drawn, and nothing clipped to it is either.
if undrawn && u.clip.is_none() {
self.notes.clipped_out += 1;
self.clip_out(i);
return Ok(true);
}
let layer = match self.draw_body(body, Some(i))? {
@@ -1045,12 +1179,15 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
// Once, though a merge may draw it again.
match self.noted.get_mut(i) {
Some(true) => return Ok(()),
Some(n) => *n = true,
Some(n) => {
*n = true;
self.noted_log.push(i);
}
None => {}
}
let (content, empty, effects, vector_mask, knockout) = {
let (content, empty, effects, vector_mask) = {
let rec = self.record(i)?;
(rec.content, rec.stores_nothing(), rec.effects, rec.vector_mask, rec.knockout)
(rec.content, rec.stores_nothing(), rec.effects, rec.vector_mask)
};
match content {
Content::Type => self.notes.types += 1,
@@ -1062,10 +1199,59 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
}
self.notes.effects += usize::from(effects);
self.notes.vector_masks += usize::from(vector_mask);
self.notes.knockouts += usize::from(knockout);
Ok(())
}
/// What [`Self::note`] has counted so far: the length of its log, and the counts.
fn noted_so_far(&self) -> (usize, [usize; 5]) {
let n = &self.notes;
(self.noted_log.len(), [n.types, n.adjustments, n.fills, n.effects, n.vector_masks])
}
/// Forget what [`Self::note`] counted since `so_far`, for layers that are left out.
fn unnote(&mut self, (logged, counts): (usize, [usize; 5])) {
for i in self.noted_log.split_off(logged) {
if let Some(n) = self.noted.get_mut(i) {
*n = false;
}
}
let n = &mut self.notes;
[n.types, n.adjustments, n.fills, n.effects, n.vector_masks] = counts;
}
/// Count record `i` as a layer whose knockout isn't applied (once).
fn unknock(&mut self, i: usize) {
if let Some(s) = self.unknocked.get_mut(i)
&& !*s
{
*s = true;
self.notes.knockouts += 1;
self.unknock_log.push(i);
}
}
/// Does unit `u`, at `level` above the units `below` it, take a shallow knockout this import
/// applies? Only a layer or group in a group, neither clipped nor a base of clipped layers, does;
/// in a pass-through group, only when it and the visible units below it are in the Normal mode, so
/// that none of them blends with what is below the group. Any other knockout is counted as not
/// applied. One at 0 opacity, or with no visible unit below it, changes nothing below it: it needs
/// no merge, and a hidden one isn't left out for it.
fn knocks(&mut self, u: &Unit<'_>, below: &[Unit<'_>], level: Level) -> Result<bool, String> {
let rec = self.record(u.record)?;
if rec.knockout == 0 {
return Ok(false);
}
let normal = |u: &Unit<'_>| u.blend == Blend::Mode(BlendMode::Normal);
let blends_out = level == Level::Pass && !(normal(u) && below.iter().filter(|b| b.visible).all(normal));
let applies = rec.knockout == 1 && level != Level::Top && !blends_out && !rec.clipped && !u.base && !matches!(u.body, Body::Merged(_));
// Its fill opacity isn't checked: at 0 fill it still clears what is below it.
let changes = rec.opacity > 0.0 && below.iter().any(|b| b.visible);
if !applies {
self.unknock(u.record);
}
Ok(applies && changes)
}
/// Count record `i` as a hidden layer left out (once).
fn skip(&mut self, i: usize) {
if let Some(s) = self.skipped.get_mut(i)
@@ -1077,21 +1263,100 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
}
}
/// `items`' units with the layers in blend modes VectorCraft lacks merged with those below.
fn merged<'i>(&mut self, items: &'i [Item], keep_hidden: bool) -> Result<Vec<Unit<'i>>, String> {
/// Count record `i` as a layer clipped to a fill that isn't drawn (once).
fn clip_out(&mut self, i: usize) {
if let Some(s) = self.clipped_out.get_mut(i)
&& !*s
{
*s = true;
self.notes.clipped_out += 1;
self.clipped_out_log.push(i);
}
}
/// Count record `i` as a clipped layer left unclipped (once).
fn unclip(&mut self, i: usize) {
self.squeezed += 1;
if let Some(s) = self.unclipped.get_mut(i)
&& !*s
{
*s = true;
self.notes.unclipped += 1;
self.unclip_log.push(i);
}
}
/// `items`' units, at `level`, with the layers in blend modes VectorCraft lacks, and in a group
/// the layers with a shallow knockout, merged with those below.
fn merged<'i>(&mut self, items: &'i [Item], keep_hidden: bool, level: Level) -> Result<Vec<Unit<'i>>, String> {
#[cfg(test)]
{
let (walked, most) = WALKS.get();
if walked >= most {
return Err("the import walked more layer lists than the test allows".into());
}
WALKS.set((walked + 1, most));
}
let mut out: Vec<Unit<'i>> = vec![];
for mut u in self.units(items, keep_hidden)? {
// A hidden layer in a mode VectorCraft lacks would need the merge for its mode: it is left
// out without being drawn.
if !u.visible && matches!(u.blend, Blend::Other(_)) {
self.skip(u.record);
continue;
}
if self.knocks(&u, &out, level)? {
let saved = self.saved();
let noted = self.noted_so_far();
let squeezed = self.squeezed;
let outer = self.try_from_here();
let knocked = self.knock(&out, &u)?;
self.tried(outer, u.visible && matches!(knocked, Knocked::Merged(_)))?;
match knocked {
// A hidden layer that would need the merge is left out, and nothing its drawing
// counted is counted.
Knocked::Merged(_) | Knocked::TooLarge if !u.visible => {
self.restore(saved)?;
self.unnote(noted);
self.skip(u.record);
continue;
}
Knocked::Merged(canvas) => {
self.take_merge(&mut out, &u, canvas);
if let Blend::Other(other) = u.blend
&& !self.notes.merged.contains(&other.label())
{
self.notes.merged.push(other.label());
}
continue;
}
// Nothing below it, or nothing of its own, to knock out: it comes in as a layer,
// with the hidden layers its drawing left out (see `kept`). What its drawing
// read is read again when it comes in. A hidden one may still be left out by a
// later merge: what its drawing counted is counted when it comes in instead.
Knocked::Nothing if !u.visible => {
self.restore(saved)?;
self.unnote(noted);
}
// A merge below it that its held canvas left without the memory it needed may
// be made when they come in without it: what drawing them counted is given back
// and counted again then.
Knocked::Nothing if self.squeezed != squeezed => self.restore(saved)?,
Knocked::Nothing => self.refund(saved.spent)?,
Knocked::TooLarge => {
self.restore(saved)?;
self.squeezed += 1;
self.unknock(u.record);
}
}
}
let Blend::Other(other) = u.blend else {
out.push(u);
continue;
};
// A hidden layer that would need the merge is left out.
if !u.visible {
self.skip(u.record);
continue;
}
// A merge that can't be made counts nothing its groups would have counted.
let saved = self.notes.counts(self.skip_log.len());
let saved = self.saved();
let outer = self.try_from_here();
let made = match out.as_mut_slice() {
// Onto the previous merge alone: composited onto its canvas, in place.
[prev] if prev.is_merge() => {
@@ -1113,45 +1378,20 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
}
_ => match self.merge(&out, &u)? {
Some(canvas) => {
let mut name = String::new();
for (k, b) in out.iter_mut().filter(|b| b.visible).enumerate() {
if k == 0 {
name = std::mem::take(&mut b.name);
} else {
name.push_str(" + ");
name.push_str(&b.name);
}
}
if out.iter().any(|b| b.visible) {
name.push_str(" + ");
}
name.push_str(&u.name);
// Hidden layers below are left out with the rest.
for b in out.iter().filter(|b| !b.visible).map(|b| b.record).collect::<Vec<_>>() {
self.skip(b);
}
out.clear();
out.push(Unit {
name,
visible: true,
opacity: 1.0,
blend: Blend::Mode(BlendMode::Normal),
mask_of: None,
record: u.record,
body: Body::Merged(canvas),
clip: None,
});
self.take_merge(&mut out, &u, canvas);
true
}
None => false,
},
};
self.tried(outer, made)?;
if made {
if !self.notes.merged.contains(&other.label()) {
self.notes.merged.push(other.label());
}
} else {
self.restore(saved);
self.restore(saved)?;
self.squeezed += 1;
self.notes.unmerged += 1;
u.blend = Blend::Mode(BlendMode::Normal);
out.push(u);
@@ -1160,18 +1400,51 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
Ok(out)
}
/// The counts as they were before a merge that couldn't be made.
fn restore(&mut self, c: Counts) {
/// The counts as they are, for [`Self::restore`].
fn saved(&self) -> Counts {
self.notes.counts(self.spent.get(), self.skip_log.len(), self.unknock_log.len(), self.blank_log.len())
}
/// The counts as they were before a merge that couldn't be made, the bytes it spent counted as
/// wasted (see [`Self::refund`]).
fn restore(&mut self, c: Counts) -> Result<(), String> {
self.refund(c.spent)?;
for i in self.skip_log.split_off(c.skipped) {
if let Some(s) = self.skipped.get_mut(i) {
*s = false;
self.notes.hidden = self.notes.hidden.saturating_sub(1);
}
}
for i in self.unknock_log.split_off(c.unknocked) {
if let Some(s) = self.unknocked.get_mut(i) {
*s = false;
self.notes.knockouts = self.notes.knockouts.saturating_sub(1);
}
}
// The groups found since: what their drawing counted is given back, so they are drawn again.
for g in self.blank_log.split_off(c.blank) {
if let Some(b) = self.blank.get_mut(g) {
*b = None;
}
if let Some(b) = self.laid_blank.get_mut(g) {
*b = false;
}
}
for i in self.unclip_log.split_off(c.unclipped) {
if let Some(s) = self.unclipped.get_mut(i) {
*s = false;
self.notes.unclipped = self.notes.unclipped.saturating_sub(1);
}
}
for i in self.clipped_out_log.split_off(c.clipped_out) {
if let Some(s) = self.clipped_out.get_mut(i) {
*s = false;
self.notes.clipped_out = self.notes.clipped_out.saturating_sub(1);
}
}
self.notes.merged.truncate(c.merged);
self.notes.unmerged = c.unmerged;
self.notes.unclipped = c.unclipped;
self.notes.clipped_out = c.clipped_out;
Ok(())
}
/// The visible units `below` with `top` composited over them; `None` when the canvas would need
@@ -1186,24 +1459,169 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
Ok(Some(acc.unwrap_or_default()))
}
/// `out` replaced by one layer: `canvas`, the merge of its visible units with `top`, named after
/// them, bottom first. Its hidden units are left out.
fn take_merge<'i>(&mut self, out: &mut Vec<Unit<'i>>, top: &Unit<'_>, canvas: Canvas) {
let mut name = String::new();
for (k, b) in out.iter_mut().filter(|b| b.visible).enumerate() {
if k == 0 {
name = std::mem::take(&mut b.name);
} else {
name.push_str(" + ");
name.push_str(&b.name);
}
}
if out.iter().any(|b| b.visible) {
name.push_str(" + ");
}
name.push_str(&top.name);
// Hidden layers below are left out with the rest.
for b in out.iter().filter(|b| !b.visible).map(|b| b.record).collect::<Vec<_>>() {
self.skip(b);
}
out.clear();
out.push(Unit {
name,
visible: true,
opacity: 1.0,
blend: Blend::Mode(BlendMode::Normal),
mask_of: None,
record: top.record,
body: Body::Merged(canvas),
clip: None,
base: false,
});
}
/// The visible units `below` with `top`, a layer with a shallow knockout, knocking them out: where
/// `top` has pixels, what is below it in its group is cleared to transparency (the group's own
/// backdrop) and `top` is drawn there at its fill opacity; its opacity then fades all of that
/// back toward the units below as they were. Its layer mask shapes the cut.
fn knock(&mut self, below: &[Unit<'_>], top: &Unit<'_>) -> Result<Knocked, String> {
let (fill, opacity) = {
let rec = self.record(top.record)?;
(rec.fill, rec.opacity)
};
let k = match self.draw_body(&top.body, top.mask_of)? {
Drawn::Nothing => return Ok(Knocked::Nothing),
Drawn::TooLarge => return Ok(Knocked::TooLarge),
Drawn::Canvas(c) if c.px.iter().all(|p| p[3] <= 0.0) => return Ok(Knocked::Nothing),
Drawn::Canvas(c) => c,
};
// At 0 fill, beside every layer below it, it cuts nothing: no canvas for them is needed.
if fill <= 0.0 && self.beside(below, &k)? {
return Ok(Knocked::Nothing);
}
// The layer's canvas is held while the units below are drawn.
let bytes = 16 * k.px.len() as u64;
self.held = self.held.saturating_add(bytes);
let mut acc: Option<Canvas> = None;
let mut drawn = Ok(true);
for u in below.iter().filter(|u| u.visible) {
drawn = self.composite(&mut acc, u);
if !matches!(drawn, Ok(true)) {
break;
}
}
self.held = self.held.saturating_sub(bytes);
if !drawn? {
return Ok(Knocked::TooLarge);
}
// Nothing below draws.
let Some(below) = acc.as_ref() else { return Ok(Knocked::Nothing) };
// At 0 fill it draws nothing of its own: where it cuts no painted pixel below, no canvas for
// the merge is needed.
if fill <= 0.0 && !cuts_paint(below, &k, top.blend, opacity, top.record) {
return Ok(Knocked::Nothing);
}
let clear = |c: &Canvas| c.px.iter().all(|p| p[3] <= 0.0);
let below_clear = clear(below);
if !knock_onto(&mut acc, &k, top.blend, fill, opacity, top.record, self.room(), &|n| self.spend(n))? {
return Ok(Knocked::TooLarge);
}
// Nothing below to cut, and nothing of its own drawn at its fill opacity.
if below_clear && acc.as_ref().is_none_or(clear) {
return Ok(Knocked::Nothing);
}
Ok(acc.map_or(Knocked::Nothing, Knocked::Merged))
}
/// Do the pixels `knock` paints lie outside the bounds of every visible unit `below`? Only the
/// bounds of layers and of merged canvases are known without drawing them: with a group below,
/// `false`.
fn beside(&self, below: &[Unit<'_>], knock: &Canvas) -> Result<bool, String> {
let width = knock.width.max(1);
let mut painted: Option<[i64; 4]> = None;
for (k, _) in knock.px.iter().enumerate().filter(|(_, p)| p[3] > 0.0) {
let (x, y) = (knock.left + (k % width) as i64, knock.top + (k / width) as i64);
painted = Some(painted.map_or([x, y, x + 1, y + 1], |[l, t, r, b]| [l.min(x), t.min(y), r.max(x + 1), b.max(y + 1)]));
}
let Some([left, top, right, bottom]) = painted else { return Ok(true) };
for u in below.iter().filter(|u| u.visible) {
let [l, t, r, b] = match &u.body {
Body::Merged(c) => [c.left, c.top, c.left + c.width as i64, c.top + c.height as i64],
Body::Layer(i) => {
let rec = self.record(*i)?;
match rec.content {
Content::Adjustment => continue,
Content::Solid(Some(_)) if rec.color_over_canvas() => [0, 0, i64::from(self.h.width), i64::from(self.h.height)],
_ => {
let (w, h) = rec.bounds.size();
let (l, t) = (i64::from(rec.bounds.left), i64::from(rec.bounds.top));
[l, t, l + w as i64, t + h as i64]
}
}
}
Body::Group(..) => return Ok(false),
};
if l < right && left < r && t < bottom && top < b {
return Ok(false);
}
}
Ok(true)
}
/// The bytes a merge step may still take: the memory allowed, less the copies of what is below
/// the pass-through groups being merged.
fn room(&self) -> u64 {
self.max_alloc.saturating_sub(self.held)
}
/// Note pass-through group `g` as laying nothing onto nothing when `acc`, nothing before, still
/// is and no layer's pixels were read since `painted`: laying its layers onto nothing again
/// gives nothing, with the same notes.
fn laid_nothing(&mut self, g: usize, acc: &Option<Canvas>, painted: usize) {
if acc.is_none()
&& self.painted.get() == painted
&& let Some(b) = self.laid_blank.get_mut(g)
&& !*b
{
*b = true;
self.blank_log.push(g);
}
}
/// Unit `u` composited onto `acc`. A pass-through group lays its layers onto `acc` one by one,
/// so that they blend with what is below it; at less than full opacity or with a layer mask, the
/// result is then faded back toward `acc` as it was by the opacity and the mask. Anything else
/// is drawn alone first. `false` when the canvas would need more memory than allowed.
fn composite(&mut self, acc: &mut Option<Canvas>, u: &Unit<'_>) -> Result<bool, String> {
if let (Body::Group(items), Blend::Pass) = (&u.body, u.blend) {
if let (Body::Group(g, items), Blend::Pass) = (&u.body, u.blend) {
let mask = match u.mask_of {
Some(i) if self.has_mask(Some(i))? => self.mask(i, false)?,
_ => None,
};
// Onto nothing, a group that laid nothing onto nothing before lays nothing again.
let (fresh, painted) = (acc.is_none(), self.painted.get());
if fresh && self.laid_blank.get(*g) == Some(&true) {
return Ok(true);
}
if u.opacity >= 1.0 && mask.is_none() {
return self.lay(acc, items);
let laid = self.lay(acc, items, Level::Pass)?;
if laid && fresh {
self.laid_nothing(*g, acc, painted);
}
return Ok(laid);
}
let bytes = acc.as_ref().map_or(0, |c| 16 * c.px.len() as u64);
if bytes > self.room() {
@@ -1212,11 +1630,14 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
self.spend(bytes)?;
let below = acc.clone();
self.held = self.held.saturating_add(bytes);
let laid = self.lay(acc, items);
let laid = self.lay(acc, items, Level::Pass);
self.held = self.held.saturating_sub(bytes);
if !laid? {
return Ok(false);
}
if fresh {
self.laid_nothing(*g, acc, painted);
}
if let Some(after) = acc.as_mut() {
fade(after, below.as_ref(), u.opacity, mask.as_ref());
}
@@ -1230,10 +1651,10 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
blend_onto(acc, &c, u.blend, u.opacity, u.record, self.room(), &|n| self.spend(n))
}
/// `items`' layers composited onto `acc` one by one; `false` when a canvas would need more
/// memory than allowed.
fn lay(&mut self, acc: &mut Option<Canvas>, items: &[Item]) -> Result<bool, String> {
for c in self.merged(items, false)? {
/// `items`' layers, the layers of a group at `level`, composited onto `acc` one by one; `false`
/// when a canvas would need more memory than allowed.
fn lay(&mut self, acc: &mut Option<Canvas>, items: &[Item], level: Level) -> Result<bool, String> {
for c in self.merged(items, false, level)? {
if !self.composite(acc, &c)? {
return Ok(false);
}
@@ -1271,13 +1692,29 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
}
None => return Ok(Drawn::Nothing),
},
Body::Group(items) => {
let mut acc: Option<Canvas> = None;
if !self.lay(&mut acc, items)? {
return Ok(Drawn::TooLarge);
Body::Group(g, items) => {
let drawn = match self.blank.get(*g).cloned().flatten() {
Some(d) => d,
None => {
let painted = self.painted.get();
let mut acc: Option<Canvas> = None;
if !self.lay(&mut acc, items, Level::Group)? {
return Ok(Drawn::TooLarge);
}
let d = acc.map_or(Drawn::Nothing, Drawn::Canvas);
if self.painted.get() == painted
&& let Some(b) = self.blank.get_mut(*g)
{
*b = Some(d.clone());
self.blank_log.push(*g);
}
d
}
};
match drawn {
Drawn::Canvas(c) => c,
other => return Ok(other),
}
let Some(acc) = acc else { return Ok(Drawn::Nothing) };
acc
}
};
if let Some(i) = mask_of {
@@ -1306,10 +1743,10 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
Ok(n)
}
/// Layers of the document for `items`, bottom first.
fn list(&mut self, items: &[Item]) -> Result<Vec<Arc<Node>>, String> {
/// Layers of the document for `items`, the layers at `level`, bottom first.
fn list(&mut self, items: &[Item], level: Level) -> Result<Vec<Arc<Node>>, String> {
let mut out = vec![];
for u in self.merged(items, self.hidden)? {
for u in self.merged(items, self.hidden, level)? {
if let Some(n) = self.node(u)? {
out.push(Arc::new(n));
}
@@ -1320,6 +1757,9 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
/// The layer of the document unit `u` becomes; `None` for a layer that draws nothing (an
/// adjustment layer, or one without pixels).
fn node(&mut self, u: Unit<'_>) -> Result<Option<Node>, String> {
if let Some(k) = self.kept.get_mut(u.record) {
*k = true;
}
let children = match &u.body {
Body::Layer(i) => match self.image(*i)? {
Some((left, top, img)) => vec![Arc::new(self.image_node(&u.name, left, top, img)?)],
@@ -1329,13 +1769,13 @@ impl<F: Fn([f32; 4]) -> [f32; 3]> Builder<'_, F> {
Some((left, top, img)) => vec![Arc::new(self.image_node(&u.name, left, top, img)?)],
None => return Ok(None),
},
Body::Group(items) => self.list(items)?,
Body::Group(_, items) => self.list(items, if u.blend == Blend::Pass { Level::Pass } else { Level::Group })?,
};
let mut layer = self.layer(&u.name);
layer.visible = u.visible;
layer.opacity = u.opacity.clamp(0.0, 1.0);
(layer.blend, layer.isolate) = match u.blend {
Blend::Mode(m) => (m, matches!(u.body, Body::Group(_))),
Blend::Mode(m) => (m, matches!(u.body, Body::Group(..))),
Blend::Pass | Blend::Other(_) => (BlendMode::Normal, false),
};
if let Some(c) = layer.children_mut() {
@@ -1443,6 +1883,71 @@ fn blend_onto(
max_alloc: u64,
spend: &dyn Fn(u64) -> Result<(), String>,
) -> Result<bool, String> {
if !cover(acc, src, max_alloc, spend)? {
return Ok(false);
}
let Some(out) = acc.as_mut() else { return Ok(false) };
// Only the source's rows and columns change.
let (sw, x0, y0) = (src.width.max(1), (src.left - out.left) as usize, (src.top - out.top) as usize);
for (k, s) in src.px.iter().enumerate() {
let Some(p) = out.px.get_mut((y0 + k / sw) * out.width + x0 + k % sw) else { continue };
let a = coverage(blend, s[3] * opacity, src.left + (k % sw) as i64, src.top + (k / sw) as i64, record);
*p = over(blend, *p, [s[0], s[1], s[2], a]);
}
Ok(true)
}
/// `knock` (of record `record`, in `blend`, with its `fill` and `opacity`), a layer with a shallow
/// knockout, knocking out `acc`, on a canvas covering both, as [`blend_onto`] makes it. Where
/// `knock` has pixels, its transparency is the share of `acc` cleared and replaced by its color at
/// `fill`; `opacity` then fades that back toward `acc` (in Dissolve, each pixel is cleared fully
/// or not at all, at the share its transparency times `opacity` gives). `false`, with `acc` as it
/// was, when the canvases would take more than `max_alloc` bytes.
#[allow(clippy::too_many_arguments)]
fn knock_onto(
acc: &mut Option<Canvas>,
knock: &Canvas,
blend: Blend,
fill: f32,
opacity: f32,
record: usize,
max_alloc: u64,
spend: &dyn Fn(u64) -> Result<(), String>,
) -> Result<bool, String> {
if !cover(acc, knock, max_alloc, spend)? {
return Ok(false);
}
let Some(out) = acc.as_mut() else { return Ok(false) };
let (fill, opacity) = (fill.clamp(0.0, 1.0), opacity.clamp(0.0, 1.0));
let (kw, x0, y0) = (knock.width.max(1), (knock.left - out.left) as usize, (knock.top - out.top) as usize);
for (k, s) in knock.px.iter().enumerate() {
let Some(p) = out.px.get_mut((y0 + k / kw) * out.width + x0 + k % kw) else { continue };
let t = coverage(blend, s[3].clamp(0.0, 1.0) * opacity, knock.left + (k % kw) as i64, knock.top + (k / kw) as i64, record);
let below = p[3].clamp(0.0, 1.0);
let alpha = (1.0 - t) * below + t * fill;
if alpha <= 0.0 {
*p = [0.0; 4];
continue;
}
let mix = |i: usize| ((1.0 - t) * below * p[i] + t * fill * s[i]) / alpha;
*p = [mix(0), mix(1), mix(2), alpha];
}
Ok(true)
}
/// Does `knock`, as [`knock_onto`] takes it, clear any of a pixel of `below` that has paint?
fn cuts_paint(below: &Canvas, knock: &Canvas, blend: Blend, opacity: f32, record: usize) -> bool {
let (kw, opacity) = (knock.width.max(1), opacity.clamp(0.0, 1.0));
knock.px.iter().enumerate().any(|(k, s)| {
let (x, y) = (knock.left + (k % kw) as i64, knock.top + (k / kw) as i64);
below.get(x, y).is_some_and(|b| b[3] > 0.0) && coverage(blend, s[3].clamp(0.0, 1.0) * opacity, x, y, record) > 0.0
})
}
/// `acc` grown, when it doesn't already, to a canvas covering itself and `src` (a new one counted
/// with `spend`). `false`, with `acc` as it was, when the canvases held, `acc` and `src` and a
/// larger canvas when one is needed, would take more than `max_alloc` bytes.
fn cover(acc: &mut Option<Canvas>, src: &Canvas, max_alloc: u64, spend: &dyn Fn(u64) -> Result<(), String>) -> Result<bool, String> {
let (mut left, mut top, mut right, mut bottom) = (src.left, src.top, src.left + src.width as i64, src.top + src.height as i64);
if let Some(a) = acc.as_ref() {
left = left.min(a.left);
@@ -1475,14 +1980,6 @@ fn blend_onto(
}
*acc = Some(out);
}
let Some(out) = acc.as_mut() else { return Ok(false) };
// Only the source's rows and columns change.
let (sw, x0, y0) = (src.width.max(1), (src.left - left) as usize, (src.top - top) as usize);
for (k, s) in src.px.iter().enumerate() {
let Some(p) = out.px.get_mut((y0 + k / sw) * width + x0 + k % sw) else { continue };
let a = coverage(blend, s[3] * opacity, src.left + (k % sw) as i64, src.top + (k / sw) as i64, record);
*p = over(blend, *p, [s[0], s[1], s[2], a]);
}
Ok(true)
}
@@ -1521,11 +2018,28 @@ pub(super) fn import(
layers: 0,
notes: Notes::default(),
noted: vec![false; records.len()],
noted_log: vec![],
skipped: vec![false; records.len()],
skip_log: vec![],
unknocked: vec![false; records.len()],
unknock_log: vec![],
clipped_out: vec![false; records.len()],
clipped_out_log: vec![],
unclipped: vec![false; records.len()],
unclip_log: vec![],
kept: vec![false; records.len()],
spent: Cell::new(0),
wasted: Cell::new(0),
trial: Cell::new(0),
painted: Cell::new(0),
blank: vec![None; records.len()],
laid_blank: vec![false; records.len()],
blank_log: vec![],
squeezed: 0,
};
let layers = b.list(&items)?;
let layers = b.list(&items, Level::Top)?;
// A drawing for a knockout or a clip leaves hidden layers out; those that came in anyway aren't.
b.notes.hidden = b.skipped.iter().zip(&b.kept).filter(|&(s, k)| *s && !*k).count();
let Builder { mut doc, notes, .. } = b;
if !layers.is_empty() {
doc.layers = layers;
@@ -646,6 +646,453 @@ fn dissolve_layers_merge_as_opaque_or_transparent_pixels() {
assert!((32..=96).contains(&red), "{red} of 256 pixels show the lower layer: {r}");
}
/// A layer with a Knockout value of `knko` and a fill opacity of `fill`.
fn knockout(l: L, knko: u8, fill: u8) -> L {
let mut l = l;
l.blocks.push((*b"knko", vec![knko, 0, 0, 0]));
l.blocks.push((*b"iOpa", vec![fill]));
l
}
/// A green layer under a group of `group_blend` holding a red layer and `cut` above it.
fn knockout_stack(group_blend: &'static [u8; 4], cut: L) -> Vec<L> {
vec![
layer("Outside", [0, 0, 4, 4], [0, 255, 0, 255]),
group_end(),
layer("Lower", [0, 0, 4, 4], [255, 0, 0, 255]),
cut,
group("Group", group_blend),
]
}
/// The names of the document's layers, and of the layers in its second one.
fn knockout_names(s: &Session) -> (Vec<String>, Vec<String>) {
let d = &s.doc().unwrap().doc;
let names = |ls: &[std::sync::Arc<Node>]| ls.iter().map(|l| name(l).to_string()).collect::<Vec<_>>();
(names(&d.layers), d.layers.get(1).and_then(|g| g.children()).map_or(vec![], |c| names(c)))
}
/// A layer with a shallow knockout in a group merges with the layers below it in the group: its
/// shape clears them to transparency, it draws there at its fill opacity, and its opacity fades
/// that. What is outside the group stays a layer of its own and shows through.
#[test]
fn knockout_layers_merge_with_the_layers_below_them_in_their_group() {
let cut = |fill: u8, opacity: u8| knockout(L { opacity, ..layer("Cut", [0, 0, 2, 2], [0, 0, 255, 255]) }, 1, fill);
for (fill, opacity, at_cut) in [(0, 255, [0, 0, 0, 0]), (128, 255, [0, 0, 255, 128]), (0, 128, [255, 0, 0, 127]), (255, 255, [0, 0, 255, 255])] {
for group_blend in [b"norm", b"pass"] {
let (s, r) = open(&file(4, 4, &knockout_stack(group_blend, cut(fill, opacity)), 8, false, false), json!({}));
assert_eq!(r["warnings"], json!([]), "{r}");
let (top, inner) = knockout_names(&s);
assert_eq!((top, inner), (vec!["Outside".to_string(), "Group".into()], vec!["Lower + Cut".to_string()]), "{fill} {opacity}");
let d = &s.doc().unwrap().doc;
assert_eq!(d.layers[1].isolate, group_blend == b"norm");
let ((x, y), px) = image_of(&s, &d.layers[1].children().unwrap()[0]);
assert_eq!(((x, y), px.dimensions()), ((0.0, 0.0), (4, 4)));
assert_eq!((px.get_pixel(1, 1).0, px.get_pixel(3, 3).0), (at_cut, [255, 0, 0, 255]), "{fill} {opacity}");
}
}
// A layer mask shapes the cut: where it hides the layer, nothing below is cleared.
let mut masked = cut(0, 255);
masked.mask = Some(([0, 0, 1, 1], 255, 0, vec![0]));
let (s, r) = open(&file(4, 4, &knockout_stack(b"norm", masked), 8, false, false), json!({}));
let px = image_of(&s, &s.doc().unwrap().doc.layers[1].children().unwrap()[0]).1;
assert_eq!((px.get_pixel(0, 0).0, px.get_pixel(1, 1).0), ([255, 0, 0, 255], [0, 0, 0, 0]), "{r}");
// Without a knockout (0), the layers stay apart.
let (s, r) =
open(&file(4, 4, &knockout_stack(b"norm", knockout(layer("Cut", [0, 0, 2, 2], [0, 0, 255, 255]), 0, 0)), 8, false, false), json!({}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (vec!["Lower".to_string(), "Cut".into()], &json!([])), "{r}");
}
/// The knockouts this import doesn't apply come in as layers, counted in a warning: at the top level,
/// on a clipped layer, and with a Knockout value other than 1. Hidden ones that would need the merge
/// are left out; one that draws nothing, or nothing below it, merges nothing.
#[test]
fn knockouts_that_arent_applied_are_said() {
const UNAPPLIED: &str = "the knockout of 1 layer wasn't applied";
let cut = |l: L, knko: u8| knockout(l, knko, 0);
let blue = || layer("Cut", [0, 0, 2, 2], [0, 0, 255, 255]);
// At the top level.
let layers = [layer("Lower", [0, 0, 4, 4], [255, 0, 0, 255]), cut(blue(), 1)];
let (s, r) = open(&file(4, 4, &layers, 8, false, false), json!({}));
assert_eq!((knockout_names(&s).0, &r["warnings"]), (vec!["Lower".to_string(), "Cut".into()], &json!([UNAPPLIED])), "{r}");
// Another Knockout value, and a clipped layer, in a group.
let (s, r) = open(&file(4, 4, &knockout_stack(b"norm", cut(blue(), 2)), 8, false, false), json!({}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (vec!["Lower".to_string(), "Cut".into()], &json!([UNAPPLIED])), "{r}");
let (s, r) = open(&file(4, 4, &knockout_stack(b"norm", cut(L { clipped: true, ..blue() }, 1)), 8, false, false), json!({}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (vec!["Lower + Cut".to_string()], &json!([UNAPPLIED])), "{r}");
// In a pass-through group, a layer below it, or the knockout itself, in another mode blends with
// what is outside the group: the layers stay apart, and the lower one still multiplies the green
// outside. In an isolated group they merge.
let mut multiply = knockout_stack(b"pass", cut(blue(), 1));
multiply[2].blend = b"mul ";
let (s, r) = open(&file(4, 4, &multiply, 8, false, false), json!({}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (vec!["Lower".to_string(), "Cut".into()], &json!([UNAPPLIED])), "{r}");
assert_eq!(s.doc().unwrap().doc.layers[1].children().unwrap()[0].blend, BlendMode::Multiply);
let (s, r) = open(&file(4, 4, &knockout_stack(b"pass", cut(L { blend: b"mul ", ..blue() }, 1)), 8, false, false), json!({}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (vec!["Lower".to_string(), "Cut".into()], &json!([UNAPPLIED])), "{r}");
multiply[4] = group("Group", b"norm");
let (s, r) = open(&file(4, 4, &multiply, 8, false, false), json!({}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (vec!["Lower + Cut".to_string()], &json!([])), "{r}");
// A hidden knockout would need the merge: left out, hidden layers asked for or not.
for hidden in [false, true] {
let (s, r) =
open(&file(4, 4, &knockout_stack(b"norm", cut(L { hidden: true, ..blue() }, 1)), 8, false, false), json!({"hiddenLayers": hidden}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (vec!["Lower".to_string()], &json!([HIDDEN_1])), "{hidden}: {r}");
}
// One that stores no pixels or only transparent ones cuts nothing, and merges nothing.
for (l, inner) in [(L { bare: true, ..blue() }, vec!["Lower"]), (layer("Cut", [0, 0, 2, 2], [0, 0, 255, 0]), vec!["Lower", "Cut"])] {
let (s, r) = open(&file(4, 4, &knockout_stack(b"norm", cut(l, 1)), 8, false, false), json!({}));
assert_eq!((knockout_names(&s).1, &r["warnings"]), (inner.iter().map(|n| n.to_string()).collect(), &json!([])), "{r}");
}
// Nothing below it in its group: it comes in as a layer.
let layers = [group_end(), cut(blue(), 1), group("Group", b"norm"), layer("Over", [0, 0, 1, 1], [9, 9, 9, 255])];
let (s, r) = open(&file(4, 4, &layers, 8, false, false), json!({}));
let d = &s.doc().unwrap().doc;
assert_eq!(d.layers[0].children().unwrap().iter().map(|c| name(c)).collect::<Vec<_>>(), ["Cut"], "{r}");
assert_eq!(r["warnings"], json!([]), "{r}");
}
/// A knockout that changes nothing below it leaves the layers apart, hidden ones included: one at 0
/// opacity, one at 0 fill over layers that are transparent or beside their painted pixels, and one
/// whose layer mask hides all of it. At 0 fill over painted layers, and
/// at a fill over transparent ones, it still merges. A knockout at 0 fill over a transparent layer
/// stays apart without a warning when their merge would need more memory than allowed.
#[test]
fn knockouts_that_change_nothing_keep_the_layers_apart() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let layers = [
group_end(),
layer("Lower", [0, 0, 2, 2], [255, 0, 0, 0]),
knockout(layer("Cut", [2, 2, 4, 4], [0, 0, 255, 255]), 1, 0),
group("Group", b"norm"),
];
// The two 2 × 2 layers drawn together fit 256 bytes, but not the 4 × 4 canvas covering both.
let (doc, warnings) = psdlayers::import(&file(4, 4, &layers, 8, false, false), false, 256, cms).unwrap().unwrap();
assert_eq!(doc.layers[0].children().unwrap().iter().map(|c| name(c)).collect::<Vec<_>>(), ["Lower", "Cut"]);
assert!(warnings.is_empty(), "{warnings:?}");
let lower = |alpha: u8| layer("Lower", [0, 0, 4, 4], [255, 0, 0, alpha]);
let hidden = L { hidden: true, ..layer("Hidden", [0, 0, 4, 4], [0, 255, 0, 255]) };
let cut = |fill: u8, opacity: u8| knockout(L { opacity, ..layer("Cut", [0, 0, 2, 2], [0, 0, 255, 255]) }, 1, fill);
let inner = |s: &Session| s.doc().unwrap().doc.layers[0].children().map_or(vec![], |c| c.iter().map(|l| name(l).to_string()).collect::<Vec<_>>());
for (alpha, fill, opacity, apart) in [(255, 0, 0, true), (0, 0, 255, true), (255, 0, 255, false), (0, 128, 255, false)] {
let layers = [group_end(), lower(alpha), hidden.clone(), cut(fill, opacity), group("Group", b"norm")];
let (s, r) = open(&file(4, 4, &layers, 8, false, false), json!({"hiddenLayers": true}));
let (names, warnings) = if apart { (vec!["Lower", "Hidden", "Cut"], json!([])) } else { (vec!["Lower + Cut"], json!([HIDDEN_1])) };
assert_eq!((inner(&s), &r["warnings"]), (names.iter().map(|n| n.to_string()).collect(), &warnings), "{alpha} {fill} {opacity}: {r}");
}
// A hidden knockout that needs no merge comes in with hidden layers: at 0 opacity, with nothing
// below it in its group, at 0 fill beside the painted pixels below it, and with a layer mask that
// hides all of it.
let hidden_cut = |opacity: u8| L { hidden: true, ..cut(0, opacity) };
let beside = L { hidden: true, ..knockout(layer("Cut", [0, 0, 2, 2], [0, 0, 255, 255]), 1, 0) };
let masked = L { hidden: true, mask: Some(([0, 0, 2, 2], 0, 0, vec![0; 4])), ..cut(255, 255) };
for (layers, names) in [
(vec![group_end(), lower(255), hidden_cut(0), group("Group", b"norm")], vec!["Lower", "Cut"]),
(vec![group_end(), hidden_cut(255), group("Group", b"norm")], vec!["Cut"]),
(vec![group_end(), layer("Lower", [2, 2, 4, 4], [255, 0, 0, 255]), beside, group("Group", b"norm")], vec!["Lower", "Cut"]),
(vec![group_end(), lower(255), masked.clone(), group("Group", b"norm")], vec!["Lower", "Cut"]),
] {
let (s, r) = open(&file(4, 4, &layers, 8, false, false), json!({"hiddenLayers": true}));
assert_eq!((inner(&s), &r["warnings"]), (names.iter().map(|n| n.to_string()).collect(), &json!([])), "{r}");
}
// With the mask switched off it would need the merge, and is left out.
let unmasked = L { mask: Some(([0, 0, 2, 2], 0, 2, vec![0; 4])), ..masked };
let (s, r) = open(&file(4, 4, &[group_end(), lower(255), unmasked, group("Group", b"norm")], 8, false, false), json!({"hiddenLayers": true}));
assert_eq!((inner(&s), &r["warnings"]), (vec!["Lower".to_string()], &json!([HIDDEN_1])), "{r}");
// A hidden knockout group that would need the merge is counted once, as a hidden layer left out:
// its type layer and its own hidden layer aren't counted.
let mut words = layer("Words", [0, 0, 2, 2], [0, 0, 0, 255]);
words.blocks.push((*b"TySh", vec![0; 4]));
let layers = [
group_end(),
lower(255),
group_end(),
words.clone(),
L { hidden: true, ..layer("Inner", [0, 0, 2, 2], [0, 0, 255, 255]) },
L { hidden: true, ..knockout(group("Cut", b"norm"), 1, 255) },
group("Group", b"norm"),
];
let (s, r) = open(&file(4, 4, &layers, 8, false, false), json!({"hiddenLayers": true}));
assert_eq!((inner(&s), &r["warnings"]), (vec!["Lower".to_string()], &json!([HIDDEN_1])), "{r}");
// One whose layer mask hides all of it needs no merge, but a knockout above it merges the layers
// and leaves it out: it is counted once, without its type layer.
let layers = [
group_end(),
lower(255),
group_end(),
words,
L { hidden: true, mask: Some(([0, 0, 2, 2], 0, 0, vec![0; 4])), ..knockout(group("Masked", b"norm"), 1, 255) },
cut(0, 255),
group("Group", b"norm"),
];
let (s, r) = open(&file(4, 4, &layers, 8, false, false), json!({"hiddenLayers": true}));
assert_eq!((inner(&s), &r["warnings"]), (vec!["Lower + Cut".to_string()], &json!([HIDDEN_1])), "{r}");
}
/// With hidden layers asked for, the hidden layers of a group drawn for a knockout or a clip that
/// isn't made come in, and aren't counted as left out: a knockout group over a layer that stores no
/// pixels, and a clipped group whose merge needs more memory than allowed.
#[test]
fn hidden_layers_of_a_group_drawn_for_a_merge_not_made_come_in() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let children = |l: &Node| l.children().map_or(vec![], |c| c.iter().map(|l| (name(l).to_string(), l.visible)).collect::<Vec<_>>());
let shown_and_hidden =
|| [group_end(), layer("Shown", [0, 0, 2, 2], [0, 0, 255, 255]), L { hidden: true, ..layer("Hidden", [2, 2, 4, 4], [0, 255, 0, 255]) }];
let both = vec![("Shown".to_string(), true), ("Hidden".to_string(), false)];
// A knockout group over a layer that stores no pixels.
let mut layers = vec![group_end(), L { bare: true, ..layer("Lower", [0, 0, 2, 2], [0; 4]) }];
layers.extend(shown_and_hidden());
layers.extend([knockout(group("Cut", b"norm"), 1, 255), group("Group", b"norm")]);
let (s, r) = open(&file(4, 4, &layers, 8, false, false), json!({"hiddenLayers": true}));
let d = &s.doc().unwrap().doc;
let cut = &d.layers[0].children().unwrap()[0];
assert_eq!((name(cut), children(cut), &r["warnings"]), ("Cut", both.clone(), &json!([])), "{r}");
// A clipped group whose merge with its base doesn't fit 320 bytes.
let mut layers = vec![layer("Base", [0, 0, 2, 2], [255, 0, 0, 255])];
layers.extend(shown_and_hidden());
layers[2].rect = [0, 0, 4, 4];
layers.push(L { clipped: true, ..group("Clipped", b"norm") });
let (doc, warnings) = psdlayers::import(&file(4, 4, &layers, 8, false, false), true, 320, cms).unwrap().unwrap();
let clipped = &doc.layers[1];
assert_eq!((name(clipped), children(clipped)), ("Clipped", both), "{warnings:?}");
assert_eq!(warnings, ["1 layer clipped to the layer below came in unclipped: the merge needs more memory than allowed"]);
}
/// A knockout's merge whose canvases would need more memory than allowed leaves the layers apart,
/// with a warning. One at 0 fill beside the painted pixels below it cuts nothing, and stays apart
/// whatever the memory.
#[test]
fn a_knockout_merge_past_the_memory_allowed_leaves_the_layers_apart() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let stack = |cut: [i32; 4]| {
let layers = [
group_end(),
layer("Lower", [0, 0, 2, 2], [255, 0, 0, 255]),
knockout(layer("Cut", cut, [0, 0, 255, 255]), 1, 0),
group("Group", b"norm"),
];
file(4, 4, &layers, 8, false, false)
};
let names = |doc: &vectorcraft_doc::Document| doc.layers[0].children().unwrap().iter().map(|c| name(c).to_string()).collect::<Vec<_>>();
let f = stack([1, 1, 3, 3]);
// Each 2 × 2 layer fits 128 bytes (16 a pixel), but not the canvas of the layer below with the
// knockout's canvas held beside it.
let (doc, warnings) = psdlayers::import(&f, false, 128, cms).unwrap().unwrap();
assert_eq!(names(&doc), ["Lower", "Cut"]);
assert_eq!(warnings, ["the knockout of 1 layer wasn't applied"]);
let (doc, warnings) = psdlayers::import(&f, false, 1 << 20, cms).unwrap().unwrap();
assert_eq!(names(&doc), ["Lower + Cut"]);
assert!(warnings.is_empty(), "{warnings:?}");
for max_alloc in [128, 1 << 20] {
let (doc, warnings) = psdlayers::import(&stack([2, 2, 4, 4]), false, max_alloc, cms).unwrap().unwrap();
assert_eq!(names(&doc), ["Lower", "Cut"], "{max_alloc}");
assert!(warnings.is_empty(), "{max_alloc}: {warnings:?}");
}
}
/// A knockout that cuts nothing gives back what drawing the layers below it counted: here a
/// knockout at 0 fill beside a group, whose own knockout doesn't fit 192 bytes while the outer
/// knockout's canvas is held, but merges when the group comes in.
#[test]
fn a_knockout_that_cuts_nothing_doesnt_keep_what_drawing_below_it_counted() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let layers = [
group_end(),
group_end(),
layer("Opaque", [0, 0, 2, 2], [255, 0, 0, 255]),
knockout(layer("Inner cut", [0, 0, 1, 2], [0, 0, 255, 255]), 1, 0),
group("Inner", b"norm"),
knockout(layer("Outer cut", [2, 2, 4, 4], [0, 0, 255, 255]), 1, 0),
group("Outer", b"norm"),
];
let (doc, warnings) = psdlayers::import(&file(4, 4, &layers, 8, false, false), false, 192, cms).unwrap().unwrap();
let outer = doc.layers[0].children().unwrap();
assert_eq!(outer.iter().map(|c| name(c)).collect::<Vec<_>>(), ["Inner", "Outer cut"], "{warnings:?}");
assert_eq!(outer[0].children().unwrap().iter().map(|c| name(c)).collect::<Vec<_>>(), ["Opaque + Inner cut"], "{warnings:?}");
assert!(warnings.is_empty(), "{warnings:?}");
}
/// A knockout merge that can't be made leaves the import the whole allowance for reading the layers
/// apart: here the merge decodes 22 layers over one another before the layer beside them makes its
/// canvas too large, which used up nearly all of eight times 64 KiB. The merge has that allowance
/// also after five layers below the group were read, and a knockout at 0 fill over 22 transparent
/// layers, which cuts no paint after they are drawn, leaves the same room.
#[test]
fn a_knockout_merge_not_made_leaves_room_to_read_the_layers() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let mut layers = vec![group_end()];
layers.extend((0..22).map(|_| layer("Lower", [0, 0, 32, 32], [255, 0, 0, 255])));
layers.push(layer("Beside", [0, 64, 32, 96], [0, 255, 0, 255]));
layers.extend([knockout(layer("Cut", [0, 0, 32, 32], [0, 0, 255, 255]), 1, 0), group("Group", b"norm")]);
let (doc, warnings) = psdlayers::import(&file(96, 32, &layers, 8, false, false), false, 64 << 10, cms).unwrap().unwrap();
assert_eq!(doc.layers[0].children().unwrap().len(), 24, "{warnings:?}");
assert_eq!(warnings, ["the knockout of 1 layer wasn't applied"]);
let mut after_five = vec![layer("Outside", [0, 0, 32, 32], [0, 0, 0, 255]); 5];
after_five.extend(layers);
let (doc, warnings) = psdlayers::import(&file(96, 32, &after_five, 8, false, false), false, 64 << 10, cms).unwrap().unwrap();
assert_eq!((doc.layers.len(), doc.layers[5].children().unwrap().len()), (6, 24), "{warnings:?}");
assert_eq!(warnings, ["the knockout of 1 layer wasn't applied"]);
let mut layers = vec![group_end()];
layers.extend((0..22).map(|_| layer("Lower", [0, 0, 32, 32], [255, 0, 0, 0])));
layers.extend([knockout(layer("Cut", [0, 0, 32, 32], [0, 0, 255, 255]), 1, 0), group("Group", b"norm")]);
let (doc, warnings) = psdlayers::import(&file(32, 32, &layers, 8, false, false), false, 64 << 10, cms).unwrap().unwrap();
assert_eq!(doc.layers[0].children().unwrap().len(), 23, "{warnings:?}");
assert!(warnings.is_empty(), "{warnings:?}");
}
/// A hidden knockout in a mode VectorCraft lacks is left out without being drawn, hidden layers
/// asked for: here its pixels are larger than the memory allowed for one image.
#[test]
fn a_hidden_knockout_in_a_mode_vectorcraft_lacks_is_left_out_unread() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let layers = [
group_end(),
layer("Lower", [0, 0, 2, 2], [255, 0, 0, 255]),
L { hidden: true, blend: b"diss", ..knockout(layer("Cut", [0, 0, 8, 8], [0, 0, 255, 255]), 1, 255) },
group("Group", b"norm"),
];
let (doc, warnings) = psdlayers::import(&file(8, 8, &layers, 8, false, false), true, 128, cms).unwrap().unwrap();
assert_eq!(doc.layers[0].children().unwrap().iter().map(|c| name(c)).collect::<Vec<_>>(), ["Lower"]);
assert_eq!(warnings, [HIDDEN_1]);
}
/// A Dissolve knockout at part opacity clears each pixel below it fully or not at all, at the share
/// its opacity gives, as a Dissolve layer merges.
#[test]
fn a_dissolve_knockout_at_part_opacity_clears_whole_pixels() {
let cut = knockout(L { blend: b"diss", opacity: 128, ..layer("Cut", [0, 0, 16, 16], [0, 0, 255, 255]) }, 1, 0);
let layers = [group_end(), layer("Lower", [0, 0, 16, 16], [255, 0, 0, 255]), cut, group("Group", b"norm")];
let (s, r) = open(&file(16, 16, &layers, 8, false, false), json!({}));
let d = &s.doc().unwrap().doc;
let (_, px) = image_of(&s, &d.layers[0].children().unwrap()[0]);
assert!(px.pixels().all(|p| p.0 == [255, 0, 0, 255] || p.0[3] == 0), "{r}");
let red = px.pixels().filter(|p| p.0 == [255, 0, 0, 255]).count();
assert!((32..=224).contains(&red), "{red} of 256 pixels keep the lower layer: {r}");
}
/// The knockout of a layer that another is clipped to isn't applied, also when the clipped layer's
/// merge with it needs more memory than allowed and the two come in apart.
#[test]
fn a_clipping_base_knockout_isnt_applied_when_its_clip_doesnt_fit() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
// The 4 × 4 clipped layer and its 2 × 2 base don't fit 320 bytes together for the clip; the
// base's knockout merge with the 2 × 2 layer below would.
let layers = [
group_end(),
layer("Lower", [0, 0, 2, 2], [255, 0, 0, 255]),
knockout(layer("Base", [0, 0, 2, 2], [0, 0, 255, 255]), 1, 0),
L { clipped: true, ..layer("Clipped", [0, 0, 4, 4], [0, 255, 0, 255]) },
group("Group", b"norm"),
];
let (doc, warnings) = psdlayers::import(&file(4, 4, &layers, 8, false, false), false, 320, cms).unwrap().unwrap();
assert_eq!(doc.layers[0].children().unwrap().iter().map(|c| name(c)).collect::<Vec<_>>(), ["Lower", "Base", "Clipped"], "{warnings:?}");
assert_eq!(
warnings,
["the knockout of 1 layer wasn't applied", "1 layer clipped to the layer below came in unclipped: the merge needs more memory than allowed"]
);
}
/// A knockout group that comes in as a layer counts each layer clipped in it once in the warnings,
/// though its layers are also drawn for the knockout: one clipped to a fill that isn't drawn, and
/// one that a merge past the memory allowed leaves unclipped.
#[test]
fn a_knockout_group_that_comes_in_as_a_layer_counts_its_clipped_layers_once() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let empty = L { bare: true, ..layer("Empty", [0, 0, 2, 2], [0, 0, 0, 0]) };
// A fill whose shape is a vector mask, with a layer clipped to it: neither is drawn.
let mut soco = vec![0; 8];
for (key, v) in [(b"Rd doub", 255.0f64), (b"Grn doub", 0.0), (b"Bl doub", 51.0)] {
soco.extend(key);
soco.extend(v.to_be_bytes());
}
let mut outline = layer("Outline", [0, 0, 0, 0], [0; 4]);
outline.blocks.push((*b"SoCo", soco));
outline.blocks.push((*b"vsms", vec![0; 8]));
let on_outline = L { clipped: true, ..layer("On outline", [0, 0, 2, 2], [1, 1, 1, 255]) };
// Each 2 × 2 layer fits 128 bytes, and so do the two drawn together, but not the merge of the
// clipped one with the one below.
let base = layer("Base", [0, 0, 2, 2], [255, 0, 0, 255]);
let clipped = L { clipped: true, ..layer("Clipped", [0, 0, 2, 2], [0, 0, 255, 255]) };
for (inner, said) in [
(vec![outline, on_outline], "1 layer clipped to a fill layer that wasn't drawn was left out"),
(vec![base, clipped], "1 layer clipped to the layer below came in unclipped: the merge needs more memory than allowed"),
] {
let mut layers = vec![layer("Outside", [0, 0, 4, 4], [0, 255, 0, 255]), group_end(), empty.clone(), group_end()];
layers.extend(inner);
layers.extend([knockout(group("Cut", b"norm"), 1, 255), group("Group", b"norm")]);
let (doc, warnings) = psdlayers::import(&file(4, 4, &layers, 8, false, false), false, 128, cms).unwrap().unwrap();
assert_eq!(doc.layers.iter().map(|l| name(l)).collect::<Vec<_>>(), ["Outside", "Group"]);
assert!(warnings.iter().any(|w| w == said), "{said}: {warnings:?}");
}
}
/// A pass-through group that draws nothing still counts what its layers count in it, also when it
/// is drawn again inside a group that merges: a knockout above a Multiply layer isn't applied in a
/// pass-through group, though drawn alone it would be.
#[test]
fn a_pass_through_group_that_draws_nothing_still_counts_its_unapplied_knockouts() {
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let empty = |name: &'static str, blend: &'static [u8; 4]| L { bare: true, blend, ..layer(name, [0, 0, 2, 2], [0, 0, 0, 0]) };
let layers = [
layer("Lower", [0, 0, 4, 4], [255, 0, 0, 255]),
group_end(),
empty("Empty", b"norm"),
group_end(),
empty("Multiplied", b"mul "),
knockout(empty("Cut", b"norm"), 1, 255),
knockout(group("Through", b"pass"), 1, 255),
group("Dissolved", b"diss"),
];
let (doc, warnings) = psdlayers::import(&file(4, 4, &layers, 8, false, false), false, 1 << 20, cms).unwrap().unwrap();
assert_eq!(doc.layers.iter().map(|l| name(l)).collect::<Vec<_>>(), ["Lower + Dissolved"], "{warnings:?}");
assert_eq!(warnings, ["the knockout of 1 layer wasn't applied".to_string(), psdlayers::MERGED_WARNING.replace("{modes}", "Dissolve")]);
}
/// A group that draws nothing is drawn once, however deep the groups like it nest: here each holds
/// a layer that stores no pixels and, above it, the next group, with a knockout. The import walks
/// at most as many layer lists as the file has records, with isolated groups, with groups that
/// alternate with pass-through ones, with pass-through groups inside the outermost one (whose
/// knockouts aren't applied), and with a layer in a mode VectorCraft lacks in each (a merge of
/// nothing, a canvas without pixels).
#[test]
fn groups_that_draw_nothing_are_drawn_once_however_deep_they_nest() {
const LEVELS: usize = 48;
let cms = |c: [f32; 4]| [c[0], c[1], c[2]];
let empty = |name: &'static str, blend: &'static [u8; 4]| L { bare: true, blend, ..layer(name, [0, 0, 2, 2], [0, 0, 0, 0]) };
// Which levels are pass-through groups.
let none: fn(usize) -> bool = |_| false;
let odd: fn(usize) -> bool = |k| k % 2 == 1;
let all: fn(usize) -> bool = |k| k > 0;
for (case, pass, dissolve, warned) in [
("isolated", none, false, vec![]),
("alternating", odd, false, vec![]),
("pass-through", all, false, vec![format!("the knockout of {} layers wasn't applied", LEVELS - 1)]),
("dissolved", none, true, vec![psdlayers::MERGED_WARNING.replace("{modes}", "Dissolve")]),
] {
let mut layers = vec![layer("Outside", [0, 0, 4, 4], [0, 255, 0, 255])];
for _ in 0..=LEVELS {
layers.push(group_end());
if dissolve {
layers.push(empty("Dissolved", b"diss"));
}
layers.push(empty("Empty", b"norm"));
}
for k in (0..=LEVELS).rev() {
let g = group("Group", if pass(k) { b"pass" } else { b"norm" });
layers.push(if k == 0 { g } else { knockout(g, 1, 255) });
}
psdlayers::WALKS.set((0, layers.len()));
let imported = psdlayers::import(&file(4, 4, &layers, 8, false, false), false, 1 << 20, cms);
let (walked, _) = psdlayers::WALKS.replace((0, usize::MAX));
let (doc, warnings) = imported.unwrap().unwrap();
assert!(walked <= layers.len(), "{case}: {walked} walks for {} records", layers.len());
assert_eq!(doc.layers.iter().map(|l| name(l)).collect::<Vec<_>>(), ["Outside", "Group"], "{case}");
let mut expected = warned;
expected.push(vectorcraft_doc::depth::merged_note());
assert_eq!(warnings, expected, "{case}");
}
}
#[test]
fn what_doesnt_come_in_is_said() {
let mut text = layer("Words", [0, 0, 2, 2], [0, 0, 0, 255]);
+18 -1
View File
@@ -24,7 +24,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Gradient",
["Window", "Gradient"],
None,
"{stroke?: bool (default: the targeted item's kind, else the active proxy), kind?: linear|radial|conic|diamond|freeform (conic, also accepted as angle or conical, sweeps the stops once around the center, clockwise from the vector, with a seam where the last stop meets the first; diamond runs the stops from the center out to a square with a corner at the end of the vector; freeform places points on each object, coloured along the stops), mode?: points|lines (freeform: how the Gradient tool adds points), method?: classic|perceptual|hue-clockwise|hue-counterclockwise (how the colours between the stops mix: in display RGB, perceptually (OKLab) so the steps look even, or around the hue wheel: hue, saturation and brightness each change evenly from one stop to the next, the hue angle falling with hue-clockwise (red, magenta, blue, cyan, green, yellow) and rising with hue-counterclockwise; two stops whose hues are less than half a color level apart keep that hue; a stop whose RGB numbers are less than half a color level apart is gray and takes the hue of the stop it mixes with, and black that stop's saturation too; these two methods are VectorCraft's own, and SVG and PDF exports draw their gradients as RGB images, CMYK and spot color stops included; SVG exports draw a Perceptual gradient as an image, and PDF exports do too unless it is linear, radial, conic or diamond, has spot color stops, every other stop is paper white or written in CMYK or gray (an export that converts colors to a CMYK destination profile writes RGB and Lab stops in CMYK, and so does a CMYK document unless the export converts colors to an RGB destination profile), it is not a dithered fill and its curve does not have too many stops: then PDF writes tints of one spot ink as a Separation shading in that ink, and spot inks mixed with other spot, CMYK or gray inks as a DeviceN shading; freeform gradients mix their own way), spread?: pad|repeat|reflect (linear, radial, conic and diamond: what the gradient paints past the ends of its stops: pad carries the end colors on; repeat and reflect run the stops `repeats` times along the vector (around the circle, for a conic) and on past both ends, reflect mirroring every other run; an error on a freeform gradient), repeats?: 1..100 (a whole number: how many times repeat and reflect run the stops along the vector; VectorCraft's own limit; pad keeps it unused), stops?: [{offset 0..1, color? (needed without swatch; #rrggbbaa and #rgba are refused), opacity? 0..1 (or 0..100), midpoint? 0.13..0.87, swatch?: colour swatch name (a global or spot colour or tint swatch links the stop, so swatch edits recolour it and a spot stop prints on its plate; a process colour just gives its colour), tint?: 0..100 (% of the linked swatch; default 100, or a tint swatch's own)}] (at least 2; a freeform gradient's points are recoloured along them), keepModel?: bool (as paint.setFill; a stop color the gradient already has keeps its model), angle?: deg counter-clockwise (0: the gradient runs left to right; radial, conic and diamond: the vector turns about the center), aspect?: % (radial, conic and diamond; a negative one mirrors a conic's sweep and is an error for the other kinds), reverse?: bool (the same ramp the other way round: the stops in reverse order, and a hue method turned the other way unless `method` is given too), dither?: bool (fills only: a linear, radial, conic or diamond gradient fill is drawn with fine noise that hides banding, and as pixels in SVG and PDF exports), item?: fill/stroke item index|null (omitted: the Appearance panel's active item when it is of the edited kind), aligned?: bool (as paint.setFill; without stroke, the kind of the row edited), ids?|id?, strokeMode?: within|along|across (strokes only: the gradient lies on the page and shows through the stroke, runs from the start of each subpath to its end, or runs from the stroke's left edge to its right all along it; with nothing selected, for the next object drawn; type characters' own strokes always paint within), target?: \"object\"|\"contents\"} edit the gradient in place (keeps its placement); solid/none paints become the default gradient. Without `item`, a Live Paint group's faces take a fill edit and its edges take a stroke edit. On a path directly in a graph series, the graph also stores the gradient when it is on the topmost visible fill or stroke (docs/mcp.md); on a graph label's row, or on a graph's axis line, tick mark or radar ring, the graph stores that object's topmost visible fill and stroke rows for every label or line of its kind (a line's gradient without its placement), and on its characters their gradient without its placement, fitted to each label. While the Live Paint Bucket is the active tool and no ids, id or item are given (a null ids or id counts as none), only the default changes (the paint the bucket paints with)",
"{stroke?: bool (default: the targeted item's kind, else the active proxy), kind?: linear|radial|conic|diamond|freeform (conic, also accepted as angle or conical, sweeps the stops once around the center, clockwise from the vector, with a seam where the last stop meets the first; diamond runs the stops from the center out to a square with a corner at the end of the vector; freeform places points on each object, coloured along the stops), mode?: points|lines (freeform: how the Gradient tool adds points), method?: classic|perceptual|hue-clockwise|hue-counterclockwise (how the colours between the stops mix: in display RGB, perceptually (OKLab) so the steps look even, or around the hue wheel: hue, saturation and brightness each change evenly from one stop to the next, the hue angle falling with hue-clockwise (red, magenta, blue, cyan, green, yellow) and rising with hue-counterclockwise; two stops whose hues are less than half a color level apart keep that hue; a stop whose RGB numbers are less than half a color level apart is gray and takes the hue of the stop it mixes with, and black that stop's saturation too; these two methods are VectorCraft's own, and SVG and PDF exports draw their gradients as RGB images, CMYK and spot color stops included; SVG exports draw a Perceptual gradient as an image, and PDF exports do too unless it is linear, radial, conic or diamond, has spot color stops, every other stop is paper white or written in CMYK or gray (an export that converts colors to a CMYK destination profile writes RGB and Lab stops in CMYK, and so does a CMYK document unless the export converts colors to an RGB destination profile), it is not a dithered fill and its curve does not have too many stops: then PDF writes tints of one spot ink as a Separation shading in that ink, and spot inks mixed with other spot, CMYK or gray inks as a DeviceN shading; freeform gradients mix their own way), spread?: pad|repeat|reflect (linear, radial, conic and diamond: what the gradient paints past the ends of its stops: pad carries the end colors on; repeat and reflect run the stops `repeats` times along the vector (around the circle, for a conic) and on past both ends, reflect mirroring every other run; an error on a freeform gradient), repeats?: 1..100 (a whole number: how many times repeat and reflect run the stops along the vector; VectorCraft's own limit; pad keeps it unused), stops?: [{offset 0..1, color? (needed without swatch; #rrggbbaa and #rgba are refused), opacity? 0..1 (or 0..100), midpoint? 0.13..0.87, swatch?: colour swatch name (a global or spot colour or tint swatch links the stop, so swatch edits recolour it and a spot stop prints on its plate; a process colour just gives its colour), tint?: 0..100 (% of the linked swatch; default 100, or a tint swatch's own)}] (at least 2; a freeform gradient's points are recoloured along them), keepModel?: bool (as paint.setFill; a stop color the gradient already has keeps its model), angle?: deg counter-clockwise (0: the gradient runs left to right; radial, conic and diamond: the vector turns about the center), aspect?: % (radial, conic and diamond; a negative one mirrors a conic's sweep and is an error for the other kinds; an error when no object is edited, as with nothing selected, the Live Paint Bucket's gradient, or a fill edit of a Live Paint group without faces: the default gradient fits each new object and keeps no aspect), reverse?: bool (the same ramp the other way round: the stops in reverse order, and a hue method turned the other way unless `method` is given too), dither?: bool (fills only: a linear, radial, conic or diamond gradient fill is drawn with fine noise that hides banding, and as pixels in SVG and PDF exports), item?: fill/stroke item index|null (omitted: the Appearance panel's active item when it is of the edited kind), aligned?: bool (as paint.setFill; without stroke, the kind of the row edited), ids?|id?, strokeMode?: within|along|across (strokes only: the gradient lies on the page and shows through the stroke, runs from the start of each subpath to its end, or runs from the stroke's left edge to its right all along it; with nothing selected, for the next object drawn; type characters' own strokes always paint within), target?: \"object\"|\"contents\"} edit the gradient in place (keeps its placement); solid/none paints become the default gradient. Without `item`, a Live Paint group's faces take a fill edit and its edges take a stroke edit. On a path directly in a graph series, the graph also stores the gradient when it is on the topmost visible fill or stroke (docs/mcp.md); on a graph label's row, or on a graph's axis line, tick mark or radar ring, the graph stores that object's topmost visible fill and stroke rows for every label or line of its kind (a line's gradient without its placement), and on its characters their gradient without its placement, fitted to each label. While the Live Paint Bucket is the active tool and no ids, id or i Line truncated
has_doc,
edit_gradient
),
@@ -117,6 +117,17 @@ impl StopOwner {
}
impl Session {
/// Does `paint.editGradient` without `ids` edit objects on the fill (or the stroke, `stroke`)? It does not
/// while the Live Paint Bucket is active or when nothing it can paint is selected (a Live Paint group stands
/// only for its faces in a fill edit and its edges in a stroke edit): it then edits no object and takes no
/// `aspect`.
pub fn gradient_edit_has_objects(&self, stroke: bool) -> bool {
let p = json!({ "stroke": stroke });
!super::paint::for_bucket(self, &p)
&& item_target(self, &p, "paint.editGradient")
.is_ok_and(|item| item.of_kind(self, !stroke).targets_for(self, &p, !stroke).is_ok_and(|ids| !ids.is_empty()))
}
/// The selected gradient stop (`gradient.selectStop`), while the gradient it was selected on
/// is still the one behind the active proxy. Callers check it against the stop count (an undo
/// can remove stops).
@@ -547,6 +558,12 @@ fn edit_gradient(s: &mut Session, p: &Value) -> Result<Value> {
// Objects were given or selected, even when all of them are graph design art left out below, or Live Paint group parts
// of the other kind left out above: the stroke mode is then not one for new art.
let selected = !ids.is_empty() || skipped;
// The default gradient for new art (and the bucket's) is fitted to each object, so it has no aspect of its own. A
// Live Paint group with no part of the edited kind gives no object either. Graph design art is left out below
// without an error, as for every other param.
if ids.is_empty() && p.get("aspect").is_some() {
return Err(bad(C, "`aspect` needs objects to place the gradient on: give ids or select objects"));
}
let ids = super::appearance::drop_design_art_rows(s, ids, item, !stroke, C)?;
// How the gradient lies on a stroke (the panel's Stroke buttons).
let mode = match str_param(p, "strokeMode") {
+16
View File
@@ -244,12 +244,22 @@ pub(super) fn spine_move_anchor(s: &mut Session, p: &Value) -> Result<Value> {
Some(_) => return Err(bad(C, "handle must be in or out")),
};
let independent = switch_or(p, "independent", false, C)?;
let symmetric = switch_or(p, "symmetric", false, C)?;
let link = switch_or(p, "link", false, C)?;
let with = spine_points_param(p, C)?;
// Any `with`, even an empty list, asks to move points, which a handle drag doesn't.
if handle.is_some() && p.get("with").is_some_and(|v| !v.is_null()) {
return Err(bad(C, "`with` moves points, not a handle"));
}
if symmetric && independent {
return Err(bad(C, "`independent` and `symmetric` cannot both be true"));
}
if symmetric && handle.is_none() {
return Err(bad(C, "`symmetric` places a handle: give `handle`"));
}
if link && symmetric {
return Err(bad(C, "`link` and `symmetric` cannot both be true"));
}
if link && independent {
return Err(bad(C, "`link` and `independent` cannot both be true"));
}
@@ -264,6 +274,8 @@ pub(super) fn spine_move_anchor(s: &mut Session, p: &Value) -> Result<Value> {
}
edit_spine(s, p, C, "Reshape Spine", |sp, anchors, keys| {
let pull_out = handle.is_some_and(|out| sp.has_segment(index, !out));
// At an open end of the spine the handle moves as it would without `symmetric`.
let symmetric = symmetric && pull_out;
let a = sp.anchors.get_mut(index).ok_or_else(|| bad(C, "no such spine point"))?;
if let Some(out) = handle {
if link {
@@ -271,6 +283,10 @@ pub(super) fn spine_move_anchor(s: &mut Session, p: &Value) -> Result<Value> {
} else {
a.set_handle(out, q, independent);
}
if symmetric {
let opposite = a.p - (q - a.p);
if out { a.h_in = opposite } else { a.h_out = opposite }
}
return Ok(());
}
let delta = q - a.p;
+1 -1
View File
@@ -99,7 +99,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Move Spine Point",
[],
None,
"{id? (default: the selected blend), anchor: index, x, y, with?: [index…], handle?: in|out, independent?: bool, link?: bool} move a point of the blend's spine (its handles along), and the points `with` names by as much, or with `handle` place that handle's end at (x, y) (a smooth point keeps the other handle in line unless `independent`; `link` makes the point smooth with the other handle in line at its own length, a retracted one pulled out to the moved handle's length where a segment leaves the point on its side; `link` needs `handle` and cannot go with `independent`). A key object sitting on a moved point moves with it. The first edit turns the straight spine into a path",
"{id? (default: the selected blend), anchor: index, x, y, with?: [index…], handle?: in|out, independent?: bool, symmetric?: bool, link?: bool} move a point of the blend's spine (its handles along), and the points `with` names by as much, or with `handle` place that handle's end at (x, y) (a smooth point keeps the other handle in line unless `independent`; `symmetric` mirrors the opposite handle about the anchor without changing its kind, except at an open end of the spine; `link` makes the point smooth with the other handle in line at its own length, a retracted one pulled out to the moved handle's length where a segment leaves the point on its side; `symmetric` and `link` need `handle`, `symmetric` cannot go with `independent`, and `link` cannot go with `independent` or `symmetric`; all default false). A key object sitting on a moved point moves with it. The first edit turns the straight spine into a path",
has_doc,
spine_move_anchor
),
+1 -1
View File
@@ -305,7 +305,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Live Shape Properties",
[],
None,
"{id?, ids?, radius?: pt (or % of each corner's maximum when `relativeRadii` is true), kind?: \"round\"|\"invertedRound\"|\"chamfer\", relativeRadii?: bool (Relative rounding, as in the reference app: store radii as fractions of each corner's maximum so they scale with the shape), corners?: [i…], items?: [{id, corners?: [i…]}] (several objects, each with its own corners, in place of ids and corners: the canvas's corner widgets across a selection), sides?: n, polygonAngle?: degrees (counter-clockwise from its first vertex straight up), polygonRadius?: pt (centre to vertex), sideLength?: pt (sets the radius), makeSidesEqual?: true (a polygon scaled unevenly: drops the uneven scale and shear, keeping its centre, angle and mean radius), pieStart?, pieEnd?: degrees (an ellipse's pie, counter-clockwise from 3 o'clock; 0 to 360 is the whole ellipse), invertPie?: true (swaps them: the other part of the ellipse), constrainPie?: bool (Constrain Pie Angle: with one of pieStart and pieEnd, not both and not with invertPie, the other angle moves by as much, so each ellipse keeps its span), lineLength?: pt (a live line's length, above 0; its first end stays), lineAngle?: degrees (a live line's angle, counter-clockwise from 3 o'clock, from its first end to its second; it turns about its midpoint)} (Live Corners on any path: radius and kind set its corners (anchors that aren't smooth, where two sides, straight or curved (#1144), meet at an angle): `corners` (anchor indices of the path with its corners uncut, counting every subpath's anchors in order: a rectangle's 0 top-left, 1 top-right, 2 bottom-right, 3 bottom-left; a polygon's from the first vertex clockwise), else the corners with a Direct-Selected anchor, else every corner; each radius is drawn no larger than half the corner's shorter side allows; a path that isn't a live shape keeps its uncut outline so its corners stay editable, and is plain again once none is cut; sides: a polygon's, which keep the radius they shared; the polygon params apply in that order: sides, makeSidesEqual, polygonAngle, then sideLength or else polygonRadius; a line's lineLength applies before its lineAngle)",
"{id?, ids?, radius?: pt (or % of each corner's maximum when `relativeRadii` is true), kind?: \"round\"|\"invertedRound\"|\"chamfer\", relativeRadii?: bool (Relative rounding, as in the reference app: store radii as fractions of each corner's maximum so they scale with the shape), corners?: [i…], items?: [{id, corners?: [i…]}] (several objects, each with its own corners, in place of ids and corners: the canvas's corner widgets across a selection), sides?: n, polygonAngle?: degrees (counter-clockwise from its first vertex straight up), polygonRadius?: pt (centre to vertex), sideLength?: pt (sets the radius), makeSidesEqual?: true (a polygon scaled unevenly: drops the uneven scale and shear, keeping its centre, angle and mean radius), pieStart?, pieEnd?: degrees (an ellipse's pie, counter-clockwise from 3 o'clock; 0 to 360 is the whole ellipse), invertPie?: true (swaps them: the other part of the ellipse), constrainPie?: bool (Constrain Pie Angle: with one of pieStart and pieEnd, not both and not with invertPie, the other angle moves by as much, so each ellipse keeps its span), lineLength?: pt (a live line's length, above 0; its first end stays), lineAngle?: degrees (a live line's angle, counter-clockwise from 3 o'clock, from its first end to its second; it turns about its midpoint), rectangleAngle?: degrees (a live rectangle's, counterclockwise from level), ellipseAngle?: degrees (a live ellipse's, counterclockwise from level; its pie turns with it)} (rectangleAngle, ellipseAngle and polygonAngle turn each shape of that kind about its own center and leave other objects as they are; a pixel-aligned shape then goes back on the pixel grid, as after other edits, which can move its center or change its size; an angle that is not a number is an error, and `null` counts as an omitted key; a shape that a turn would take past the coordinate limit (±4,000,000 pt) is an error that changes nothing; Live Corners on any path: radius and kind set its corners (anchors that aren't smooth, where two sides, straight or curved (#1144), meet at an angle): `corners` (anchor indices of the path with its corners uncut, counting every subpath's anchors in order: a rectangle's 0 top-left, 1 top-right, 2 bottom-right, 3 bottom-left; a polygon's from the first vertex clockwise), else the corners with a Direct-Selected anchor, else every corner; each radius is drawn no larger than half the corner's shorter side allows; a path that isn't a live shape keeps its uncut outline so its corners stay editable, and is plain again once none is cut; sides: a polygon's, which keep the radius they shared; the polygon params apply in that order: sides, makeSidesEqual, polygonAngle, then sideLength or else polygonRadius; a line's lineLength applies before its lineAngle)",
has_selection,
set_live_shape
),
+31 -4
View File
@@ -202,6 +202,16 @@ pub(super) fn set_live_shape(s: &mut Session, p: &Value) -> Result<Value> {
// A polygon's Polygon Properties: its angle, radius or side length, Make Sides Equal.
let (polygon_angle, polygon_radius, side) = (angle("polygonAngle")?, length("polygonRadius")?, length("sideLength")?);
let equal = p.get("makeSidesEqual").and_then(Value::as_bool) == Some(true);
// A rectangle's Rectangle Angle and an ellipse's Ellipse Angle, as `polygonAngle` turns a polygon.
let (rectangle_angle, ellipse_angle) = (angle("rectangleAngle")?, angle("ellipseAngle")?);
// Whether a shape at `now` already stands at `a`: a turn the rounding of an earlier one left
// (89.999999999°, or 359.9999999999° against 0°) counts as no change.
let at_angle = |now: Option<f64>, a: f64| {
now.is_some_and(|n| {
let d = (n - a).rem_euclid(360.0);
d.min(360.0 - d) < 1e-9
})
};
// A line's Line Properties: its length (its first end stays) and its angle (about its midpoint).
// A line's length can reach across the whole canvas, past `MAX_COORD`: its ends are checked below.
let line_length = number("lineLength", |x| x > 0.0, "a length in points above 0")?;
@@ -249,12 +259,15 @@ pub(super) fn set_live_shape(s: &mut Session, p: &Value) -> Result<Value> {
Some(l @ LiveShape::Polygon { sides: now, .. })
if !(sides.is_none_or(|n| n.clamp(3, 1000) == u64::from(*now))
&& (!equal || l.polygon_sides_equal())
&& polygon_angle.is_none_or(|a| l.polygon_angle() == Some(a))
&& polygon_angle.is_none_or(|a| at_angle(l.polygon_angle(), a))
&& side.and_then(|len| l.polygon_radius_for_side(len)).or(polygon_radius).is_none_or(|r| l.polygon_radius() == Some(r))) =>
{
return false;
}
Some(LiveShape::Ellipse { pie, .. }) if pie_of(*pie) != *pie => return false,
Some(l @ LiveShape::Ellipse { pie, .. }) if pie_of(*pie) != *pie || ellipse_angle.is_some_and(|a| !at_angle(l.shape_angle(), a)) => {
return false;
}
Some(l @ LiveShape::Rectangle { .. }) if rectangle_angle.is_some_and(|a| !at_angle(l.shape_angle(), a)) => return false,
_ => {}
}
if relative_radii.is_some_and(|on| live.as_deref().map(|l| l.radii_relative()) != Some(on)) {
@@ -298,9 +311,18 @@ pub(super) fn set_live_shape(s: &mut Session, p: &Value) -> Result<Value> {
}
*path = l.to_path();
}
if let Some(l @ LiveShape::Ellipse { .. }) = live.as_deref_mut()
&& (pie_start.is_some() || pie_end.is_some() || invert)
if let Some(a) = rectangle_angle
&& let Some(l @ LiveShape::Rectangle { .. }) = live.as_deref_mut()
{
l.set_shape_angle(a);
*path = l.to_path();
}
if let Some(l @ LiveShape::Ellipse { .. }) = live.as_deref_mut()
&& (pie_start.is_some() || pie_end.is_some() || invert || ellipse_angle.is_some())
{
if let Some(a) = ellipse_angle {
l.set_shape_angle(a);
}
if let LiveShape::Ellipse { pie, .. } = l {
*pie = pie_of(*pie);
}
@@ -339,6 +361,11 @@ pub(super) fn set_live_shape(s: &mut Session, p: &Value) -> Result<Value> {
for id in &ids {
super::pixelgrid::resnap(d, *id);
}
// A shape named in `ids` and not selected is not checked after the edit: one that a turn or
// a new radius would take past the coordinate limit is an error here, and nothing changes.
if !crate::sanity::objects_in_range(d, &ids) {
return Err(bad("object.setLiveShape", format!("coordinate out of range (limit ±{MAX_COORD} pt)")));
}
Ok(())
})?;
ok()
+26 -1
View File
@@ -50,7 +50,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Move Direction Handle",
[],
None,
"{id, subpath?, anchor, which: \"in\"|\"out\", x, y, independent?: bool, link?: bool, at?: [x,y]} move a direction handle; independent moves only that side and makes the anchor a corner; link makes the anchor smooth with the other handle in line at its own length (a retracted one is pulled out to the moved handle's length where a segment leaves the anchor on its side); link and independent cannot both be true; both default false; with link false, at moves the anchor and both handles before placing the chosen handle",
"{id, subpath?, anchor, which: \"in\"|\"out\", x, y, independent?: bool, symmetric?: bool, link?: bool, at?: [x,y]} move a direction handle; independent moves only that side and makes the anchor a corner; symmetric mirrors the other handle about the anchor without changing its kind (not at an open end, where no segment leaves the anchor on that side); link makes the anchor smooth with the other handle in line at its own length (a retracted one is pulled out to the moved handle's length where a segment leaves the anchor on its side); independent and symmetric cannot both be true, and link cannot go with either; all default false; with link false, at moves the anchor and both handles before placing the chosen handle",
has_doc,
set_handle
),
@@ -461,6 +461,13 @@ fn set_handle(s: &mut Session, p: &Value) -> Result<Value> {
return link_handle(s, p, id, si, ai, out, pos);
}
let independent = switch_or(p, "independent", false, "path.setHandle")?;
let symmetric = switch_or(p, "symmetric", false, "path.setHandle")?;
if symmetric && independent {
return Err(bad("path.setHandle", "`independent` and `symmetric` cannot both be true"));
}
// The other handle is mirrored only where a segment leaves the anchor on its side: at an open
// end the handle moves as it would without `symmetric`.
let symmetric = symmetric && has_segment(s, id, si, ai, !out)?;
let at = match p.get("at").filter(|v| !v.is_null()) {
None => None,
Some(v) => Some(finite_numbers(v).map(|[x, y]| Point::new(x, y)).ok_or_else(|| bad("path.setHandle", "`at` must be [x, y]"))?),
@@ -472,6 +479,7 @@ fn set_handle(s: &mut Session, p: &Value) -> Result<Value> {
&& at.is_none_or(|to| to == a.p)
&& (if out { a.h_out } else { a.h_in }) == pos
&& !(independent && a.kind != AnchorKind::Corner)
&& (!symmetric || (if out { a.h_in } else { a.h_out }) == a.p - (pos - a.p))
{
return ok();
}
@@ -504,6 +512,10 @@ fn set_handle(s: &mut Session, p: &Value) -> Result<Value> {
} else {
a.set_handle(out, pos, independent);
}
if symmetric {
let opposite = a.p - (pos - a.p);
if out { a.h_in = opposite } else { a.h_out = opposite }
}
Ok(())
})?;
ok()
@@ -519,6 +531,9 @@ fn link_handle(s: &mut Session, p: &Value, id: NodeId, si: usize, ai: usize, out
if switch_or(p, "independent", false, C)? {
return Err(bad(C, "`link` and `independent` cannot both be true"));
}
if switch_or(p, "symmetric", false, C)? {
return Err(bad(C, "`link` and `symmetric` cannot both be true"));
}
if !(pos.x.abs() < 1e9 && pos.y.abs() < 1e9) {
return Err(bad(C, "x and y must be finite"));
}
@@ -655,6 +670,16 @@ fn anchor_of(s: &Session, id: NodeId, si: usize, ai: usize) -> Result<Option<Anc
Ok(d.node(id).and_then(|n| n.path_data()).and_then(|path| path.subpaths.get(si)).and_then(|sp| sp.anchors.get(ai)).copied())
}
/// Whether anchor `ai` of subpath `si` of path `id` has a segment on its outgoing (`out`) or
/// incoming side; false when the path, subpath or anchor is not there.
fn has_segment(s: &Session, id: NodeId, si: usize, ai: usize, out: bool) -> Result<bool> {
if s.script_running() {
return Err(EngineError::Busy);
}
let d = &s.doc()?.doc;
Ok(d.node(id).and_then(|n| n.path_data()).and_then(|path| path.subpaths.get(si)).is_some_and(|sp| sp.has_segment(ai, out)))
}
fn set_anchors(s: &mut Session, p: &Value) -> Result<Value> {
let id = object_param(p, "id", "path.setAnchors")?.ok_or_else(|| bad("path.setAnchors", "missing id"))?;
let subs = p.get("subpaths").and_then(Value::as_array).ok_or_else(|| bad("path.setAnchors", "missing subpaths"))?;
+114 -1
View File
@@ -9,12 +9,13 @@
//! **Repeat** objects are live nodes (`NodeKind::Repeat`) holding the source art and the
//! arrangement; `vectorcraft_doc::pattern` evaluates the instances.
use std::collections::HashSet;
use std::sync::Arc;
use serde_json::{Value, json};
use vectorcraft_color::Paint;
use vectorcraft_doc::pattern::{self, Overlap, PATTERN_EDIT_LAYER, PatternDef, PatternEdit, RepeatKind, RepeatSpec, TileType, pattern_paint};
use vectorcraft_doc::swatches::PaintFn;
use vectorcraft_doc::swatches::{PaintFn, graph_paints, node_paints, override_paints, walk_with_masks};
use vectorcraft_doc::{Document, Node, NodeId, NodeKind, Selection};
use vectorcraft_geom::{Point, Rect};
@@ -37,6 +38,15 @@ pub fn specs() -> Vec<CommandSpec> {
can_make_pattern,
pattern_make
),
cmd!(
"object.pattern.replaceArt",
"Replace Pattern Art",
[],
None,
"{name, ids?} make copies of the selected art the tile art of pattern `name`, as Alt-dragging (Option-dragging on macOS) art onto its swatch in the Swatches panel does; the pattern keeps its name, swatch, tile and options (with Size Tile to Art on, the tile fits the new art), every fill and stroke painted with it draws the new tile, and the art stays on the canvas, selected; one undo step, none when the art matches the tile art already; refused while a pattern is edited, with nothing selected, and for art painted with the pattern itself → {name}",
can_replace_pattern_art,
pattern_replace_art
),
cmd!(
"object.pattern.edit",
"Edit Pattern",
@@ -198,6 +208,12 @@ fn has_selection_or_ids(s: &Session) -> std::result::Result<(), String> {
has_doc(s)
}
/// Replace Pattern Art: a document, and no pattern is being edited.
fn can_replace_pattern_art(s: &Session) -> std::result::Result<(), String> {
has_doc(s)?;
if editing(s).is_some() { Err("finish editing the pattern first".into()) } else { Ok(()) }
}
/// The repeats of the selection: selected ones, and those around a selected object. None while
/// an object of a dynamic symbol instance's art is selected.
fn selected_repeats(s: &Session) -> Vec<NodeId> {
@@ -412,6 +428,103 @@ pub(crate) fn finish_edit(d: &mut Document, sel: &mut Selection) -> Result<Strin
Ok(pe.pattern)
}
/// Give pattern `name` fresh-id copies of the selected art (or of `ids`) as its tile art, as one
/// undo step (`object.pattern.replaceArt`). The pattern keeps its name, swatch, tile and options,
/// and its tile fits the new art when its Size Tile to Art is on; paints refer to a pattern by
/// name, so every fill and stroke of it draws the new tile. The art stays where it is, selected as
/// before. Art that matches the tile art already records nothing.
fn pattern_replace_art(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "object.pattern.replaceArt";
let name = text_param(p, "name", C)?.ok_or_else(|| bad(C, "missing name"))?.to_string();
let roots = roots(s, p, C)?;
let d = &s.doc()?.doc;
let old = d.pattern(&name).map(|def| def.art.clone()).ok_or_else(|| bad(C, format!("no pattern `{name}`")))?;
if roots.is_empty() {
return Err(bad(C, "select the art for the pattern tile"));
}
let src: Vec<Arc<Node>> = roots.iter().filter_map(|id| d.node(*id).cloned()).map(Arc::new).collect();
if paints_pattern(d, &src, &name) {
return Err(bad(C, format!("art painted with `{name}` can't be its tile")));
}
// Copies made from the same next id are equal when the art matches the tile art.
let fresh = |art: &[Arc<Node>]| copies(&mut Document::clone(d), art);
if fresh(&old) == fresh(&src) {
return Ok(json!({ "name": name }));
}
s.edit("Replace Pattern Art", |d, _| {
let art: Vec<Arc<Node>> = copies(d, &src).into_iter().map(Arc::new).collect();
if let Some(def) = d.pattern_mut(&name) {
def.art = art;
if def.size_tile_to_art {
def.fit_tile_to_art();
}
}
Ok(())
})?;
Ok(json!({ "name": name }))
}
/// What a piece of art uses by name, for [`paints_pattern`].
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
enum Uses<'a> {
Symbol(&'a str),
Pattern(&'a str),
GraphDesign(&'a str),
Brush(&'a str),
}
/// Does `art` paint pattern `name`, itself or through the symbols (of its instances and of the
/// inline graphics in its type), patterns, graph designs and brushes it uses? A graph's stored
/// series and label paints count, since its marks and labels take them each time it is drawn again.
fn paints_pattern(d: &Document, art: &[Arc<Node>], name: &str) -> bool {
let brushes = vectorcraft_brush::library(d);
// What was already looked into, and the art left to look at.
let mut seen: HashSet<Uses> = HashSet::new();
let mut left: Vec<&Node> = art.iter().map(|a| &**a).collect();
while let Some(n) = left.pop() {
let mut used = vec![];
walk_with_masks(n, &mut |c| {
match &c.kind {
NodeKind::SymbolInstance { symbol, .. } => used.push(Uses::Symbol(symbol.as_str())),
// The symbol of every inline graphic in type counts, overset or not.
NodeKind::Text(t) => used.extend(t.runs.iter().filter_map(|r| r.inline.as_ref()).map(|a| Uses::Symbol(a.symbol.as_str()))),
_ => {}
}
for it in &c.appearance.items {
if let vectorcraft_doc::AppearanceItem::Stroke(sk) = it
&& let Some(b) = &sk.brush
{
used.push(Uses::Brush(b.as_str()));
}
}
for p in node_paints(c).chain(override_paints(c)).chain(graph_paints(c)) {
if let Paint::Pattern { pattern, .. } = p {
used.push(Uses::Pattern(pattern.as_str()));
}
}
if let Some(g) = c.extras().graph.as_deref() {
used.extend(g.series_markers.iter().flatten().map(|m| Uses::GraphDesign(m.as_str())));
used.extend(g.series_columns.iter().flatten().map(|c| Uses::GraphDesign(c.design.as_str())));
}
});
for u in used {
if u == Uses::Pattern(name) {
return true;
}
if !seen.insert(u) {
continue;
}
match u {
Uses::Symbol(symbol) => left.extend(d.symbols.iter().find(|x| x.name == symbol).map(|x| &*x.art)),
Uses::Pattern(pattern) => left.extend(d.pattern(pattern).into_iter().flat_map(|x| x.art.iter().map(|a| &**a))),
Uses::GraphDesign(design) => left.extend(d.graph_designs.iter().find(|x| x.name == design).map(|x| &*x.art)),
Uses::Brush(brush) => left.extend(brushes.iter().filter(|x| x.name == brush).flat_map(|x| x.art())),
}
}
}
false
}
/// Leave pattern editing mode, discarding the changes (`object.pattern.cancel`). An existing
/// pattern gets its definition back, its name included when Pattern Options renamed it while it was
/// edited and no other pattern, swatch or color group has taken that name since. A new pattern is
@@ -363,6 +363,7 @@ pub(super) const ALLOWED: &[&str] = &[
"object.pattern.done",
"object.pattern.edit",
"object.pattern.make",
"object.pattern.replaceArt",
"object.puppetWarp",
"object.puppetWarp.pins",
"object.rasterize",
@@ -571,6 +572,7 @@ pub(super) const ALLOWED: &[&str] = &[
"shape.rectangularGrid",
"shape.spiral",
"shape.star",
"shape.threePointArc",
"shapeBuilder.merge",
"shapeBuilder.regions",
"shaper.expand",
+7
View File
@@ -752,6 +752,13 @@ impl Session {
t.set_option("cornerRadius", &r);
}
}
// A press of the tool that is dropped keeps the new radius, also when the tool lent a
// selection tool for the press.
if self.press_taken_by("roundedRectangle")
&& let Some((_, saved)) = self.press_options.as_mut()
{
saved.insert("cornerRadius".into(), r);
}
}
if fonts_folder_changed {
let folder = self.prefs.fonts_folder.trim();
+1 -1
View File
@@ -32,7 +32,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Run Script",
[],
None,
"{path?: a .js or .jsx file | source?: the script's text (exactly one of the two), installed?: true or false (default false; true with a path that script.listInstalled gave: the file is read once, checked as File › Scripts checks it, and that text runs, its #include lines and $.evalFile reading in the folder that read found; a file that is no longer a listed script ends with \"the script is no longer in the Scripts folder\" and nothing runs), name?: the name errors and the report use (default: the script's #script line, else the path's file name, or \"script\"), args?: {…} (at most 1 MiB as JSON; vc.args in the script), answers?: [{kind: alert|confirm|prompt, value: \"ok\" (alert) | true or false (confirm) | text or null (prompt)}] (for a run with nobody to ask: the answers to its dialogs, in order; at most 10000 and 1 MiB as JSON; refused in the app, where the person answers; an empty object is an empty list), maxFuel?: whole number from 1 to 100000000000 (instructions in all; default 1000000000)} run a JavaScript file against the open documents, through the vc object: vc.run(id, params) runs a command and returns its result, a failed command throws an error the script can catch and puts back the documents and the session state it changed, while any file it wrote stays written and is named; vc.document is a snapshot of the active document or null; vc.commands lists the commands a script may run; vc.log(value) adds to the report and the Script Console (script.console); $.write(...values) writes the values to the Script Console as String(value) gives them, and $.writeln(...values) does the same and ends the line; $.evalFile(path, timeout?) runs a file with the same globals and returns its last value (timeout, in milliseconds from 0, is taken and not waited on), $.fileName is the file of the code that reads it (the file being run for code that eval or Function compiled; empty for code compiled from a script given as text), $.includePath the #includepath list and $.engineName the engine's name (VectorCraft without #targetengine); alert(message[, title, errorIcon]), confirm(message[, noAsDflt, title]) and prompt(message, preset[, title]) open a dialog with a Stop button (default title \"Script Alert\"; message and preset as String(value) gives them; errorIcon and noAsDflt as Boolean(value) gives them; No is the default with noAsDflt): alert returns undefined, confirm true for Yes and false for No, prompt the field's text for OK and null for Cancel; in the app the run waits at the call for the person's answer and Stop ends it as script.stop does, a dialog cannot open inside a callback of a built-in, a getter, a conversion or a file $.evalFile runs and throws there (an #include file's code is the script's own and can), and a run with nobody to ask takes the next of answers, and ends when none is left or the next is for another kind of dialog, or when the script ends with answers unused; vc.args is args. Before anything runs, the script's preprocessor lines (# or //@ at the start of a line, outside strings and comments) are read: #include \"file\" and //@include put that file's text in place of the line, looked for beside the file that includes it, then in each #includepath folder in turn (separated by ;, relative to that file's folder; a later #includepath replaces the list), then in each JSINCLUDE folder; #script names the run; #target takes any value and changes nothing; #strict on makes an assignment to a read-only or getter-only property, or a new property on an object that is not extensible (preventExtensions, seal, freeze, vc, $), throw a TypeError, without the rest of ES5 strict mode, and #strict off turns that off (the last #strict line of the script and its includes sets the run; off without one; a $.evalFile file's own line holds for its code); #targetengine name runs the script in the named engine, whose globals and functions stay for the next run that names it until script.engine.drop drops it or the session ends (script.engines lists them; a name of letters, digits and _ not starting with a digit, or a quoted one of 1 to 64 bytes without control characters, matched as written; only in the script itself, once, before its code and #include lines; main, and a script without the line, get a new engine each run; a session keeps 8 named engines, a ninth name is refused, each has 64 MiB of heap, and an uncaught error, a limit or script.stop keeps the globals the run set while the documents go back; host functions kept in a global act for the run that calls them; an error in code an earlier run compiled is at that run's file, line and column, within 8 MiB of source maps kept for each engine, the oldest going first; not on the web); #engine is refused as unsupported, any other #name as unknown, and another //@name is a comment. A script run from a file reads its includes and $.evalFile's files only in that file's folder and the folders below it, refusing a path with a .. name or a link that l Line truncated
"{path?: a .js or .jsx file | source?: the script's text (exactly one of the two), installed?: true or false (default false; true with a path that script.listInstalled gave: the file is read once, checked as File › Scripts checks it, and that text runs, its #include lines and $.evalFile reading in the folder that read found; a file that is no longer a listed script ends with \"the script is no longer in the Scripts folder\" and nothing runs), name?: the name errors and the report use (default: the script's #script line, else the path's file name, or \"script\"), args?: {…} (at most 1 MiB as JSON; vc.args in the script), answers?: [{kind: alert|confirm|prompt, value: \"ok\" (alert) | true or false (confirm) | text or null (prompt)}] (for a run with nobody to ask: the answers to its dialogs, in order; at most 10000 and 1 MiB as JSON; refused in the app, where the person answers; an empty object is an empty list), maxFuel?: whole number from 1 to 100000000000 (instructions in all; default 1000000000)} run a JavaScript file against the open documents, through the vc object: vc.run(id, params) runs a command and returns its result, a failed command throws an error the script can catch and puts back the documents and the session state it changed, while any file it wrote stays written and is named; vc.document is a snapshot of the active document or null; vc.commands lists the commands a script may run; vc.log(value) adds to the report and the Script Console (script.console); $.write(...values) writes the values to the Script Console as String(value) gives them, and $.writeln(...values) does the same and ends the line; $.evalFile(path, timeout?) runs a file with the same globals and returns its last value (timeout, in milliseconds from 0, is taken and not waited on), $.fileName is the file of the code that reads it (the file being run for code that eval or Function compiled; empty for code compiled from a script given as text), $.includePath the #includepath list and $.engineName the engine's name (VectorCraft without #targetengine); alert(message[, title, errorIcon]), confirm(message[, noAsDflt, title]) and prompt(message, preset[, title]) open a dialog with a Stop button (default title \"Script Alert\"; message and preset as String(value) gives them; errorIcon and noAsDflt as Boolean(value) gives them; No is the default with noAsDflt): alert returns undefined, confirm true for Yes and false for No, prompt the field's text for OK and null for Cancel; in the app the run waits at the call for the person's answer and Stop ends it as script.stop does, a dialog cannot open inside a callback of a built-in, a getter, a conversion or a file $.evalFile runs and throws there (an #include file's code is the script's own and can), and a run with nobody to ask takes the next of answers, and ends when none is left or the next is for another kind of dialog, or when the script ends with answers unused; vc.args is args. Before anything runs, the script's preprocessor lines (# or //@ at the start of a line, outside strings and comments) are read: #include \"file\" and //@include put that file's text in place of the line, looked for beside the file that includes it, then in each #includepath folder in turn (separated by ;, relative to that file's folder; a later #includepath replaces the list), then in each JSINCLUDE folder; #script names the run; #target takes any value and changes nothing; #strict on makes an assignment to a read-only or getter-only property, or a new property on an object that is not extensible (preventExtensions, seal, freeze, vc, $), throw a TypeError, without the rest of ES5 strict mode, and #strict off turns that off (the last #strict line of the script and its includes sets the run; off without one; a $.evalFile file's own line holds for its code); #targetengine name runs the script in the named engine, whose globals and functions stay for the next run that names it until script.engine.drop drops it or the session ends (script.engines lists them; a name of letters, digits and _ not starting with a digit, or a quoted one of 1 to 64 bytes without control characters, matched as written; only in the script itself, once, before its code and #include lines; main, and a script without the line, get a new engine each run; a session keeps 8 named engines, a ninth name is refused, each has 64 MiB of heap, and an uncaught error, a limit or script.stop keeps the globals the run set while the documents go back; host functions kept in a global act for the run that calls them; an error in code an earlier run compiled is at that run's file, line and column, within 8 MiB of source maps kept for each engine, the oldest going first; not on the web); #engine is refused as unsupported, any other #name as unknown, and another //@name is a comment. A script run from a file reads its includes and $.evalFile's files only in that file's folder and the folders below it, refusing a path with a .. name or a link that l Line truncated
always,
run
),
+1 -1
View File
@@ -23,7 +23,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Stroke Options",
["Window", "Stroke"],
None,
"{weight?: pt, cap?: butt|round|square, join?: miter|round|bevel, miterLimit?, align?: center|inside|outside, dash?: [d,g,…]|null (a 0 dash with a round or projecting cap draws dots or squares; a new pattern keeps the current offset and alignment), dashOffset? (exact dashes only), alignDashes?: bool (true: dashes fitted to corners and path ends, every run between them holding whole periods with a dash centred on each corner and end; false, the default for a new pattern: exact lengths), startArrow?, endArrow?: Arrow|ArrowOpen|LineArrow|Barbed|Concave|DoubleArrow|HalfArrowLeft|HalfArrowRight|Chevron|Feather|Swallowtail|Triangle|TriangleOpen|TriangleReverse|TriangleBar|Kite|Leaf|Drop|Circle|CircleOpen|HalfCircle|Oval|Target|Square|SquareOpen|Tag|TagOpen|Diamond|DiamondOpen|Hexagon|HexagonOpen|Star|Cross|Plus|Bar|DoubleBar|DotOnBar|Slash|DoubleSlash|Bracket|Fork|null|{custom: name} (a custom arrowhead of the arrowheads file, stroke.arrowheads.list)|{Custom: {name, path}} (a custom head with its art, as document.inspect reports one; refused when the path fills no area, parts thinner than a millionth of a head unit counting as none, or has more than 4096 anchors, more than 4096 subpaths or a point more than 64 head units from the tip) (HalfArrowLeft/Right: one barb, left or right of the direction the head points), arrowAlign?: \"extend\" (tip past the end point, default)|\"tip\" (tip on the end point; the stroke is shortened), profile?: \"uniform\"|\"lens\"|\"taperStart\"|\"taperEnd\"|\"pinch\"|\"teardrop\"|\"wave\"|a saved profile's name (stroke.widthProfile.list), widthPoints?, gradientMode? (as document.inspect reports them in strokeOptions, so those read back unchanged; ignored here: a custom profile is set with the Width tool, gradientMode with paint.editGradient), item?: stroke item index|null (omitted: the Appearance panel's active item if it is a stroke, else the top stroke, created when missing), ids?|id?, target?: \"object\"|\"contents\", aligned?: bool (index and item are rows of the first target's stack: each other target edits its equal one, as the Appearance panel does for a mixed selection; with the art of a graph design in a series given first, rows of the art's stack: docs/mcp.md)} Without a stroke item, type takes weight, cap, join, miterLimit, align (around its glyph outlines; the type stays live) and the dash options as its characters' stroke (every run; text.setRangeStyle `strokeOptions` styles a range), and images and symbol instances (also in groups) are left alone; a Live Paint group takes them on its edges only. With nothing selected (and no ids) they set up the next object drawn (appearance.newArt; weight always does). On a path directly in a graph series, the graph also stores a weight it changes on the topmost visible stroke (docs/mcp.md); on a graph label's stroke row, the graph stores the label's topmost visible fill and stroke rows for every label of its kind, and on its characters the stroke options they take; on a graph's axis line, tick mark or radar ring, the graph stores the paint, weight, opacity and blend mode of its topmost visible fill and stroke rows that the edit changes, and the weight it writes to the topmost visible stroke, for every line of its kind, and not its caps, joins, dashes, alignment or arrowheads. While the Live Paint Bucket is the active tool and no ids, id or item are given (a null ids or id counts as none), only the stroke for new art changes (the bucket paints edges with its color and weight) → {objects: how many objects took the stroke options}",
"{weight?: pt, cap?: butt|round|square, join?: miter|round|bevel, miterLimit?, align?: center|inside|outside, dash?: [d,g,…]|null (a 0 dash with a round or projecting cap draws dots or squares; a new pattern keeps the current offset and alignment), dashOffset? (exact dashes only), alignDashes?: bool (true: dashes fitted to corners and path ends, every run between them holding whole periods with a dash centred on each corner and end; false, the default for a new pattern: exact lengths), startArrow?, endArrow?: Arrow|ArrowOpen|LineArrow|Barbed|Concave|DoubleArrow|HalfArrowLeft|HalfArrowRight|Chevron|Feather|Swallowtail|Triangle|TriangleOpen|TriangleReverse|TriangleBar|Kite|Leaf|Drop|Circle|CircleOpen|HalfCircle|Oval|Target|Square|SquareOpen|Tag|TagOpen|Diamond|DiamondOpen|Hexagon|HexagonOpen|Star|Cross|Plus|Bar|DoubleBar|DotOnBar|Slash|DoubleSlash|Bracket|Fork|null|{custom: name} (a custom arrowhead of the arrowheads file, stroke.arrowheads.list)|{Custom: {name, path, stop?}} (a custom head with its art, as document.inspect reports one; stop: where the stroke ends under the head, in head units back from the tip, 0..64 (otherwise, or without one, halfway along the head); refused when the path fills no area, parts thinner than a millionth of a head unit counting as none, or has more than 4096 anchors, more than 4096 subpaths or a point more than 64 head units from the tip) (HalfArrowLeft/Right: one barb, left or right of the direction the head points), arrowAlign?: \"extend\" (tip past the end point, default)|\"tip\" (tip on the end point; the stroke is shortened), profile?: \"uniform\"|\"lens\"|\"taperStart\"|\"taperEnd\"|\"pinch\"|\"teardrop\"|\"wave\"|a saved profile's name (stroke.widthProfile.list), widthPoints?, gradientMode? (as document.inspect reports them in strokeOptions, so those read back unchanged; ignored here: a custom profile is set with the Width tool, gradientMode with paint.editGradient), item?: stroke item index|null (omitted: the Appearance panel's active item if it is a stroke, else the top stroke, created when missing), ids?|id?, target?: \"object\"|\"contents\", aligned?: bool (index and item are rows of the first target's stack: each other target edits its equal one, as the Appearance panel does for a mixed selection; with the art of a graph design in a series given first, rows of the art's stack: docs/mcp.md)} Without a stroke item, type takes weight, cap, join, miterLimit, align (around its glyph outlines; the type stays live) and the dash options as its characters' stroke (every run; text.setRangeStyle `strokeOptions` styles a range), and images and symbol instances (also in groups) are left alone; a Live Paint group takes them on its edges only. With nothing selected (and no ids) they set up the next object drawn (appearance.newArt; weight always does). On a path directly in a graph series, the graph also stores a weight it changes on the topmost visible stroke (docs/mcp.md); on a graph label's stroke row, the graph stores the label's topmost visible fill and stroke rows for every label of its kind, and on its characters the stroke options they take; on a graph's axis line, tick mark or radar ring, the graph stores the paint, weight, opacity and blend mode of its topmost visible fill and stroke rows that the edit changes, and the weight it writes to the topmost visible stroke, for every line of its kind, and not its caps, joins, dashes, alignment or arrowheads. While the Live Paint Bucket is the active tool and no ids, id or item are given (a null ids or id counts as none), only the stroke for new art changes (the bucket paints edges with its color and weight) → {objects: how many objects took the stroke options}",
has_doc,
stroke_set
),
+32 -9
View File
@@ -6,7 +6,7 @@ use serde_json::{Value, json};
use vectorcraft_color::{Color, Gradient, GradientKind, GradientMethod, GradientStop, Paint, Swatch, SwatchGroup, tint_percent};
use vectorcraft_doc::pattern::pattern_paint;
use vectorcraft_doc::swatches::{LinkFn, PaintFn, color_name, map_node_paints, map_node_solid_paints, node_colors};
use vectorcraft_doc::{Document, NodeId};
use vectorcraft_doc::{Document, NodeId, Selection};
use super::paint::paint_from;
use super::{
@@ -77,7 +77,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Add Used Colors",
["Window", "Swatches"],
None,
"{selection?: false (only the selected art's colours; default: all the art's), global?: false (the new swatches are global and the matching unlinked colours in that art link to them)} add a swatch for each colour used (fills, strokes, text, gradient stops, mesh points) that no solid swatch has yet, as one undo step → {added: [names], linked}",
"{selection?: false (only the selected art's colours; default: all the art's), global?: false (the new swatches are global and the matching unlinked colours in that art link to them)} add a swatch for each colour used (fills, strokes, text, gradient stops, mesh points) that no solid swatch has yet, as one undo step (none when there is no new color; the Swatches panel menu's Add Selected Colors sends selection and global; with Global Edit on, the other members keep their colors) → {added: [names], linked}",
has_doc,
swatch_add_used
),
@@ -1037,20 +1037,41 @@ fn swatch_sort(s: &mut Session, _: &Value) -> Result<Value> {
ok()
}
/// The colors of the art `ids` that no swatch links them to and no solid swatch has, each once, in
/// paint order: the swatches Add Used Colors makes.
fn new_used_colors(d: &Document, ids: &[NodeId]) -> Vec<Color> {
let (mut linked_to, mut colors) = (vec![], vec![]);
artwork_colors(d, ids, false, &mut linked_to, &mut colors);
// Colors a solid swatch already has are skipped.
let have: HashSet<ColorKey> = d.swatches_iter().filter_map(|w| w.paint.color()).filter_map(|c| color_key(&c)).collect();
colors.retain(|c| color_key(c).is_none_or(|k| !have.contains(&k)));
colors
}
fn swatch_add_used(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "swatch.addUsedColors";
let global = switch_or(p, "global", false, C)?;
let only_selection = switch_or(p, "selection", false, C)?;
let (added, linked) = s.edit("Add Used Colors", |d, sel| {
let used_ids = |d: &Document, sel: &Selection| -> Result<Vec<NodeId>> {
let ids: Vec<NodeId> = if only_selection { sel.objects.clone() } else { d.layers.iter().map(|l| l.id).collect() };
if only_selection && ids.is_empty() {
return Err(bad(C, "select artwork to add its colours"));
}
let (mut linked_to, mut colors) = (vec![], vec![]);
artwork_colors(d, &ids, false, &mut linked_to, &mut colors);
// Colours a solid swatch already has are skipped.
let have: HashSet<ColorKey> = d.swatches_iter().filter_map(|w| w.paint.color()).filter_map(|c| color_key(&c)).collect();
colors.retain(|c| color_key(c).is_none_or(|k| !have.contains(&k)));
Ok(ids)
};
// Typing in progress is its own undo step and is in the document the colors are read from.
super::variablecmds::settle_typing(s)?;
// With no new color there is nothing to add or link, so no edit and no undo step.
let st = s.doc()?;
if new_used_colors(&st.doc, &used_ids(&st.doc, &st.selection)?).is_empty() {
return Ok(json!({"added": [], "linked": 0}));
}
// Linking a paint to its new swatch keeps its color, so Global Edit gives the link to no other
// member: a member whose color differs keeps it.
let global_edit = s.doc_mut()?.global_edit.take();
let edited = s.edit("Add Used Colors", |d, sel| {
let ids = used_ids(&*d, &*sel)?;
let colors = new_used_colors(d, &ids);
let mut free = d.free_swatch_names();
let mut links = vec![];
for c in colors {
@@ -1060,7 +1081,9 @@ fn swatch_add_used(s: &mut Session, p: &Value) -> Result<Value> {
}
let linked = if global { link_colors(d, &ids, &links) } else { 0 };
Ok((links.into_iter().map(|(_, n)| n).collect::<Vec<_>>(), linked))
})?;
});
s.doc_mut()?.global_edit = global_edit;
let (added, linked) = edited?;
Ok(json!({"added": added, "linked": linked}))
}
+6 -2
View File
@@ -122,7 +122,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Move Type Path Handle",
[],
None,
"{id, subpath?, anchor, which: \"in\"|\"out\", x, y, independent?: bool} move a direction handle of an anchor of type on a path's path to (x, y), as path.setHandle moves a path's (independent: that side only, the anchor becomes a corner); the start and end brackets keep their fractions of the path and the text reflows along it (what Direct Selection does dragging a handle of the path); no undo step when the handle is already there and the path does not change",
"{id, subpath?, anchor, which: \"in\"|\"out\", x, y, independent?: bool, symmetric?: bool} move a direction handle of an anchor of type on a path's path to (x, y), as path.setHandle moves a path's (independent: that side only, the anchor becomes a corner; symmetric: mirror the other handle about the anchor without changing its kind, except at an open end of the path; independent and symmetric cannot both be true; both default false); the start and end brackets keep their fractions of the path and the text reflows along it (what Direct Selection does dragging a handle of the path); no undo step when the handle is already there and the path does not change",
has_doc,
set_path_handle
),
@@ -1449,6 +1449,10 @@ fn set_path_handle(s: &mut Session, p: &Value) -> Result<Value> {
let out = super::object::choice(p, C, "which", &["in", "out"])? != Some("in");
let pos = vectorcraft_geom::Point::new(f64_req(p, "x", C)?, f64_req(p, "y", C)?);
let independent = switch_or(p, "independent", false, C)?;
let symmetric = switch_or(p, "symmetric", false, C)?;
if symmetric && independent {
return Err(bad(C, "`independent` and `symmetric` cannot both be true"));
}
let node = s.doc()?.doc.node(id);
let on_path = matches!(node.map(|n| &n.kind), Some(NodeKind::Text(t)) if matches!(t.kind, vectorcraft_doc::TextKind::OnPath { .. }));
if !on_path || node.is_some_and(|n| n.extras().perspective.is_some()) {
@@ -1461,7 +1465,7 @@ fn set_path_handle(s: &mut Session, p: &Value) -> Result<Value> {
let within = |t: &TextObject| {
t.type_path().and_then(|p| p.bounds()).is_some_and(|b| [b.x0, b.y0, b.x1, b.y1].iter().all(|v| v.abs() <= crate::MAX_COORD))
};
if !(t.set_path_handle((si, ai), out, pos, independent) && within(t)) {
if !(t.set_path_handle_with_symmetry((si, ai), out, pos, independent, symmetric) && within(t)) {
t.kind = before;
return Err(bad(C, "no such path anchor, or the path would reach past the canvas"));
}
+1
View File
@@ -105,6 +105,7 @@ const WAIT_FOR_TOOL_EDIT: &[&str] = &[
"symbol.selectInstances",
"view.guides.lock",
"view.proofSetup",
"view.proofSetup.load",
"view.proofColors",
"view.overprintPreview",
"view.separationsPreview",
+8
View File
@@ -189,6 +189,11 @@ pub struct Session {
/// The folder of the New Document profiles `file.new` starts documents from; `None`: none,
/// every document starts with the defaults ([`Session::attach_new_doc_profiles`]).
new_doc_profile_dir: Option<std::path::PathBuf>,
/// The folder of the proof setups `view.proofSetup.save` saves by name and View → Proof Setup
/// lists; `None`: no folder ([`Session::attach_proof_setups`]).
proof_setup_dir: Option<std::path::PathBuf>,
/// How many proof setup files `view.proofSetup.save` wrote ([`Session::proof_setup_saves`]).
proof_setup_saves: u64,
/// The folder of each script's data folder (`Folder.userData`), beside which the grants file
/// keeps the file access people allowed scripts; `None`: no folder
/// ([`Session::attach_script_data`]).
@@ -324,6 +329,9 @@ pub struct Session {
/// The id and persistent options of the tool when the press under way began, which a dropped
/// press puts back ([`Session::drop_tool_press`]).
pub(crate) press_options: Option<(String, serde_json::Map<String, serde_json::Value>)>,
/// An option of the active tool was set during the press under way, which stored all of its
/// options, so a dropped press stores the options it puts back.
pub(crate) press_options_stored: bool,
/// The engine saves the selection and active layer before a Type press and restores them if it drops.
pub(crate) press_type_selection: Option<(Selection, Option<NodeId>)>,
/// The freeform gradient point selected once the tool took the press under way, which a
+2
View File
@@ -168,6 +168,8 @@ pub fn refused_to_scripts(id: &str) -> bool {
"color.removeProfile",
"file.print",
"view.proofSetup",
"view.proofSetup.save",
"view.proofSetup.load",
"view.proofColors",
"view.overprintPreview",
"view.separationsPreview",
+3
View File
@@ -99,6 +99,8 @@ impl Session {
scripts_dir: None,
metadata_templates_dir: None,
new_doc_profile_dir: None,
proof_setup_dir: None,
proof_setup_saves: 0,
script_data_dir: None,
plugin_output: None,
plugin_install_approval: None,
@@ -135,6 +137,7 @@ impl Session {
plane_widget_press: false,
pointer_held: false,
press_options: None,
press_options_stored: false,
press_type_selection: None,
press_point: None,
ruler_guide: None,
+2
View File
@@ -202,12 +202,14 @@ mod symbol_nine_slice;
mod symbolbounds;
mod symboledit;
mod symbolism_options;
mod symbolism_shift;
mod symbollib;
mod tangent_line;
mod targeting;
mod textcombos;
mod textedit;
pub(super) mod textimport;
mod three_point_arc;
mod tileedge;
mod tints;
mod toolsettings;
+121 -1
View File
@@ -112,6 +112,7 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
"calligraphic-nibs",
"pressure-sensitive",
"bristle-brushes",
"paint",
"pattern-borders",
"scatter-shapes",
"stipple",
@@ -119,8 +120,10 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
"energy-beams",
"dry-media",
"tech-circuit",
"engraving",
"arrows",
"image-brush"
"image-brush",
"artistic"
]
);
assert!(libs.iter().all(|l| l["category"] == "builtIn"));
@@ -169,6 +172,7 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
("calligraphic-nibs", "calligraphic"),
("pressure-sensitive", "art"),
("bristle-brushes", "bristle"),
("paint", "art"),
("pattern-borders", "pattern"),
("scatter-shapes", "scatter"),
("stipple", "scatter"),
@@ -177,6 +181,7 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
("dry-media", "art"),
("arrows", "art"),
("image-brush", "scatter"),
("artistic", "art"),
] {
let (_, lib) = cmd::brushlib::library(&s, id).unwrap();
assert!(lib.len() >= 4, "{id}");
@@ -207,6 +212,46 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
assert!(s.execute("brush.library", &json!({"library": "nope"})).is_err());
}
#[test]
fn artistic_library_strokes_are_editable_and_reopen_from_a_saved_library() {
let mut s = session();
let (_, lib) = cmd::brushlib::library(&s, "artistic").unwrap();
let (_, alias) = cmd::brushlib::library(&s, "Artistic").unwrap();
assert_eq!(alias.brushes, lib.brushes);
assert_eq!(run(&mut s, "brush.library", json!({"library": "Artistic"}))["id"], "artistic");
let names = ["Orbit Lines", "Petal Garland", "Lattice Braid", "Facet Sweep"];
assert_eq!(lib.brushes.iter().map(|b| b.name.as_str()).collect::<Vec<_>>(), names);
let line = run(&mut s, "shape.line", json!({"x1": 10, "y1": 50, "x2": 190, "y2": 50}))["id"].as_u64().unwrap();
let red = vectorcraft_doc::StrokeLayer::new(vectorcraft_color::Paint::solid(vectorcraft_color::Color::rgb(1.0, 0.0, 0.0)), 1.0);
for b in &lib.brushes {
let BrushKind::Art(a) = &b.kind else { panic!("{} is not an art brush", b.name) };
assert!(art_paths(&a.art).len() >= 2, "{} has no editable vector art", b.name);
for path in [line_to(180.0), line_to(1.0)] {
assert!(!vectorcraft_brush::stroke_pieces(&lib.doc, b, &path, &black_stroke()).is_empty(), "{} draws nothing", b.name);
}
// The art is black, so with Tints every path takes the stroke color itself.
let mut fills = vec![];
for piece in vectorcraft_brush::stroke_pieces(&lib.doc, b, &line_to(180.0), &red) {
piece.walk(&mut |n| {
if n.path_data().is_some() {
fills.push(n.appearance.fill_paint().color().map(|c| c.to_rgb()));
}
});
}
let is_red = |c: &Option<[f32; 3]>| c.is_some_and(|[r, g, b]| (r - 1.0).abs() < 1e-5 && g.abs() < 1e-5 && b.abs() < 1e-5);
assert!(!fills.is_empty() && fills.iter().all(is_red), "{} does not take the stroke color: {fills:?}", b.name);
let before = undo_len(&s);
let added = run(&mut s, "brush.addFromLibrary", json!({"library": "artistic", "name": b.name, "apply": true, "ids": [line]}));
assert_eq!(strs(&added["added"]), [b.name.as_str()]);
assert_eq!(added["applied"], json!([line]));
assert_eq!(undo_len(&s), before + 1);
}
let saved = run(&mut s, "brush.saveLibrary", json!({"names": names}));
let bytes = vectorcraft_format::base64_decode(saved["dataBase64"].as_str().unwrap()).unwrap();
let reopened = vectorcraft_format::load(&bytes).unwrap();
assert_eq!(vectorcraft_brush::library(&reopened), lib.brushes);
}
#[test]
fn image_brush_stamps_draw_and_carry_their_pixels_when_added_and_saved() {
let mut s = session();
@@ -244,6 +289,26 @@ fn image_brush_stamps_draw_and_carry_their_pixels_when_added_and_saved() {
assert_eq!(reopened.images, lib.doc.images);
}
#[test]
fn a_loaded_library_named_artistic_keeps_its_name_ahead_of_the_builtin_alias() {
let mut file = vectorcraft_doc::Document::new(100.0, 100.0);
vectorcraft_brush::store(&mut file, &[vectorcraft_brush::defaults()[0].clone()]);
let b64 = vectorcraft_format::base64_encode(&vectorcraft_format::save_file(&file));
let mut s = session();
let loaded = run(&mut s, "brush.loadLibrary", json!({"dataBase64": b64, "name": "Artistic.vectorcraft"}));
assert_eq!(loaded["name"], "Artistic");
let id = loaded["library"].as_str().unwrap();
assert_eq!(run(&mut s, "brush.library", json!({"library": "Artistic"}))["id"], id);
assert_eq!(run(&mut s, "brush.library", json!({"library": "ARTISTIC"}))["id"], id);
assert_eq!(run(&mut s, "brush.library", json!({"library": "artistic"}))["id"], "artistic", "exact built-in id still works");
// A name a built-in library has selects the built-in, as for every built-in; the loaded one keeps its id.
let full = run(&mut s, "brush.loadLibrary", json!({"dataBase64": b64, "name": "Artistic Brushes.vectorcraft"}));
assert_eq!(full["name"], "Artistic Brushes");
let full_id = full["library"].as_str().unwrap();
assert_eq!(run(&mut s, "brush.library", json!({"library": "Artistic Brushes"}))["id"], "artistic");
assert_eq!(run(&mut s, "brush.library", json!({"library": full_id}))["id"], full_id);
}
/// Every path of brush art `n`: (anchors, opacity).
fn art_paths(n: &vectorcraft_doc::Node) -> Vec<(usize, f32)> {
let mut out = vec![];
@@ -272,6 +337,30 @@ fn black_stroke() -> vectorcraft_doc::StrokeLayer {
vectorcraft_doc::StrokeLayer::new(vectorcraft_color::Paint::solid(vectorcraft_color::Color::BLACK), 1.0)
}
#[test]
fn engraving_library_draws_fine_parallel_strokes_and_survives_save() {
let mut s = session();
let listed = run(&mut s, "brush.libraries", json!({}));
let entry = listed["libraries"].as_array().unwrap().iter().find(|l| l["id"] == "engraving").unwrap();
assert_eq!((entry["name"].as_str(), entry["category"].as_str(), entry["count"].as_u64()), (Some("Engraving"), Some("builtIn"), Some(4)));
let (_, lib) = cmd::brushlib::library(&s, "Engraving").unwrap();
for b in &lib.brushes {
for length in [2.0, 200.0] {
let pieces = vectorcraft_brush::stroke_pieces(&lib.doc, b, &line_to(length), &black_stroke());
let pts = anchors(&pieces.iter().collect::<Vec<_>>());
assert!(!pts.is_empty() && pts.iter().all(|p| p.x.is_finite() && p.y.is_finite()), "{} at {length} pt", b.name);
}
}
let path = run(&mut s, "shape.line", json!({"x1": 10, "y1": 20, "x2": 210, "y2": 20}))["id"].as_u64().unwrap();
let added = run(&mut s, "brush.addFromLibrary", json!({"library": "engraving", "name": "Fine Hatching", "apply": true, "ids": [path]}));
assert_eq!(strs(&added["added"]), ["Fine Hatching"]);
assert_eq!(added["applied"], json!([path]));
let saved = run(&mut s, "brush.saveLibrary", json!({"names": ["Fine Hatching"]}));
let bytes = vectorcraft_format::base64_decode(saved["dataBase64"].as_str().unwrap()).unwrap();
let reopened = vectorcraft_format::load(&bytes).unwrap();
assert_eq!(vectorcraft_brush::find(&reopened, "Fine Hatching").unwrap(), lib.brushes[0]);
}
#[test]
fn stipple_library_draws_dot_textures_and_survives_save() {
let mut s = session();
@@ -519,6 +608,37 @@ fn pressure_sensitive_brushes_widen_with_pen_pressure_and_survive_a_saved_librar
assert_eq!(vectorcraft_brush::library(&reopened), lib.brushes);
}
#[test]
fn paint_brushes_draw_distinct_marks_and_survive_a_saved_library() {
let mut s = session();
let (_, lib) = cmd::brushlib::library(&s, "Paint").unwrap();
let names = ["Flat Sweep", "Dry Drag", "Loaded Stroke", "Fan Sweep"];
assert_eq!(lib.brushes.iter().map(|b| b.name.as_str()).collect::<Vec<_>>(), names);
let path = run(&mut s, "shape.line", json!({"x1": 10, "y1": 40, "x2": 190, "y2": 40}))["id"].as_u64().unwrap();
let mut curve = line_to(20.0);
curve.curve_to((60.0, -25.0), (140.0, 25.0), (180.0, 0.0));
for b in &lib.brushes {
let BrushKind::Art(art) = &b.kind else { panic!("{} is not an art brush", b.name) };
assert_eq!(art.colorization, vectorcraft_brush::Colorization::Tints);
assert_eq!(art.width, 150.0);
for line in [line_to(2.0), line_to(180.0), curve.clone()] {
let pieces = vectorcraft_brush::stroke_pieces(&lib.doc, b, &line, &black_stroke());
let points = anchors(&pieces.iter().collect::<Vec<_>>());
assert!(!points.is_empty() && points.iter().all(|p| p.x.is_finite() && p.y.is_finite()), "{}", b.name);
}
let before = undo_len(&s);
let added = run(&mut s, "brush.addFromLibrary", json!({"library": "paint", "name": b.name, "apply": true, "ids": [path]}));
assert_eq!(strs(&added["added"]), [b.name.as_str()]);
assert_eq!(added["applied"], json!([path]));
assert_eq!(undo_len(&s), before + 1);
assert_eq!(doc(&s).node(NodeId(path)).unwrap().appearance.stroke().unwrap().brush.as_deref(), Some(b.name.as_str()));
}
let saved = run(&mut s, "brush.saveLibrary", json!({"names": names}));
let bytes = vectorcraft_format::base64_decode(saved["dataBase64"].as_str().unwrap()).unwrap();
let reopened = vectorcraft_format::load(&bytes).unwrap();
assert_eq!(vectorcraft_brush::library(&reopened), lib.brushes);
}
/// Ink and Wash: a tapered ink art brush, a brush pen whose size follows the pen pressure and two
/// translucent washes, with names of their own and a few paths of art each.
#[test]
+66 -1
View File
@@ -3331,6 +3331,68 @@ fn live_paint_bucket_paint_and_stroke_commands_leave_the_selection_unpainted() {
assert!(failed.is_empty(), "{failed:#?}");
}
/// `paint.editGradient` with an `aspect` and no object to edit (the Live Paint Bucket's gradient,
/// nothing selected, or a fill edit of a Live Paint group without faces) is an error that leaves the default gradient as it was, since a gradient
/// fitted to each object has no aspect of its own. Named objects still take the aspect.
#[test]
fn edit_gradient_aspect_without_objects_is_an_error() {
let aspect = |n: &Node| match n.appearance.fill_paint() {
Paint::Gradient(g) => g.geom.map(|x| x.aspect),
_ => None,
};
let mut s = session();
let g = live(&mut s);
let rect = rect(&mut s, 300.0, 300.0, 40.0, 40.0);
s.execute("select.set", &json!({"ids": [g.0, rect.0]})).unwrap();
s.select_tool("livePaintBucket", ViewInfo::default()).unwrap();
s.execute("gradient.presets.apply", &json!({"name": "vignette"})).unwrap();
let (group, art, fill) = (node(&s, g), node(&s, rect), s.paint.fill.clone());
let steps = s.doc().unwrap().history.undo.len();
assert!(!s.gradient_edit_has_objects(false), "the bucket edits its own gradient");
for params in [json!({"stroke": false, "aspect": 50}), json!({"stroke": false, "aspect": 50, "reverse": true})] {
assert!(s.execute("paint.editGradient", &params).is_err(), "{params}");
assert_eq!(s.paint.fill, fill, "{params}: the bucket's gradient stays");
}
assert_eq!((node(&s, g), node(&s, rect)), (group, art), "the selection keeps its paint");
assert_eq!(s.doc().unwrap().history.undo.len(), steps, "no undo step");
// Named objects take it.
s.execute("paint.editGradient", &json!({"stroke": false, "kind": "radial", "aspect": 50, "ids": [rect.0]})).unwrap();
assert_eq!(aspect(&node(&s, rect)), Some(0.5));
// Without the bucket and with nothing selected, the default gradient has no aspect either.
s.select_tool("selection", ViewInfo::default()).unwrap();
s.execute("select.set", &json!({"ids": []})).unwrap();
let fill = s.paint.fill.clone();
assert!(!s.gradient_edit_has_objects(false));
assert!(s.execute("paint.editGradient", &json!({"stroke": false, "aspect": 50})).is_err());
assert_eq!(s.paint.fill, fill, "the default gradient stays");
// An empty group has nothing to paint.
let empty = s
.edit("Group", |d, _| {
let id = d.alloc_id();
d.insert(d.default_layer(), 0, Node::group(id, vec![]))?;
Ok(id)
})
.unwrap();
s.execute("select.set", &json!({"ids": [empty.0]})).unwrap();
assert!(!s.gradient_edit_has_objects(false), "an empty group");
assert!(s.execute("paint.editGradient", &json!({"stroke": false, "aspect": 50})).is_err());
// A fill edit of a Live Paint group with edges and no faces edits no object; a stroke edit edits its edges.
let line = NodeId(s.execute("shape.line", &json!({"x1": 0, "y1": 0, "x2": 100, "y2": 0})).unwrap()["id"].as_u64().unwrap());
let edges_only = NodeId(s.execute("livePaint.make", &json!({"ids": [line.0]})).unwrap()["id"].as_u64().unwrap());
s.execute("select.set", &json!({"ids": [edges_only.0]})).unwrap();
let (fill, group, steps) = (s.paint.fill.clone(), node(&s, edges_only), s.doc().unwrap().history.undo.len());
assert!(!s.gradient_edit_has_objects(false), "a Live Paint group without faces");
assert!(s.gradient_edit_has_objects(true), "its edges take a stroke edit");
assert!(s.execute("paint.editGradient", &json!({"stroke": false, "aspect": 50})).is_err());
assert_eq!((&s.paint.fill, node(&s, edges_only)), (&fill, group), "the default and the group stay");
assert_eq!(s.doc().unwrap().history.undo.len(), steps, "no undo step");
// A selected object takes it.
s.execute("select.set", &json!({"ids": [rect.0]})).unwrap();
assert!(s.gradient_edit_has_objects(false) && s.gradient_edit_has_objects(true));
s.execute("paint.editGradient", &json!({"stroke": false, "aspect": 25})).unwrap();
assert_eq!(aspect(&node(&s, rect)), Some(0.25));
}
/// With the Live Paint Bucket active, objects named with `ids` still take a stroke, and a brush
/// still goes to the selection.
#[test]
@@ -9429,9 +9491,12 @@ fn image_trace_split_view_keeps_and_validates_its_divider() {
assert_eq!((back.node(g).unwrap().trace_view(), back.node(g).unwrap().trace_split()), (vectorcraft_doc::TraceView::Split, 0.25));
// Bad dividers are refused and change nothing.
let steps = s.doc().unwrap().history.undo.len();
for bad in [json!(-0.1), json!(1.01), json!("0.5"), json!(true), json!([0.5])] {
for bad in [json!(-0.1), json!(1.01), json!("0.5"), json!(true), json!([0.5]), json!(null)] {
assert!(s.execute("imageTrace.setView", &json!({"view": "split", "split": bad})).is_err(), "{bad}");
}
// A null divider with another view is refused too, and the view stays.
assert!(s.execute("imageTrace.setView", &json!({"view": "outlines", "split": null})).is_err());
assert_eq!(node(&s, g).trace_view(), vectorcraft_doc::TraceView::Split);
assert_eq!((s.doc().unwrap().history.undo.len(), node(&s, g).trace_split()), (steps, 0.25));
for edge in [0.0, 1.0] {
s.execute("imageTrace.setView", &json!({"view": "split", "split": edge})).unwrap();
+306
View File
@@ -318,6 +318,45 @@ fn convert_query_and_intents() {
assert!(s.execute("color.convert", &json!({"color": "#808080", "intent": "vivid"})).is_err());
}
/// `to: "oklch"` answers the OKLCH of the color's display sRGB, which converts back to the color;
/// a CMYK color's display color, not its naive separation, sets them.
#[test]
fn convert_to_oklch_answers_lightness_chroma_and_hue() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let mut s = session();
let r = s.execute("color.convert", &json!({"color": "#ff0000", "to": "oklch"})).unwrap();
assert_eq!(r["model"], "oklch");
let v: Vec<f64> = r["values"].as_array().unwrap().iter().map(|v| v.as_f64().unwrap()).collect();
assert!((v[0] - 62.80).abs() < 0.005 && (v[1] - 0.2577).abs() < 5e-5 && (v[2] - 29.23).abs() < 0.005, "{r}");
let (rgb, lowered) = vectorcraft_color::oklab::from_oklch(v[0] / 100.0, v[1], v[2]);
assert!(!lowered);
assert_eq!(Color::rgb(rgb[0], rgb[1], rgb[2]).to_hex(), "#ff0000");
assert_eq!(r["hex"], "#ff0000");
let gray = s.execute("color.convert", &json!({"color": "#808080", "to": "oklch"})).unwrap();
assert_eq!(gray["values"][2], 0.0, "{gray}");
let ink = json!({"c": 1.0, "m": 0.0, "y": 0.0, "k": 0.0});
let cyan = s.execute("color.convert", &json!({"color": ink, "to": "oklch"})).unwrap();
let shown = vectorcraft_color::oklab::to_oklch(cms::active().display_rgb(&Color::cmyk(1.0, 0.0, 0.0, 0.0)));
let naive = vectorcraft_color::oklab::to_oklch([0.0, 1.0, 1.0]);
let c: Vec<f64> = cyan["values"].as_array().unwrap().iter().map(|v| v.as_f64().unwrap()).collect();
let got = [c[0] / 100.0, c[1], c[2]];
assert!((0..3).all(|i| (got[i] - shown[i]).abs() < 1e-9) && shown[1] > 0.05, "{cyan} {shown:?}");
assert!((got[0] - naive[0]).abs() > 0.02, "{cyan} {naive:?}");
// A Lab color outside sRGB answers the OKLCH of its color clipped to sRGB.
let vivid = s.execute("color.convert", &json!({"color": {"l": 50.0, "a": 100.0, "b": 0.0}, "to": "oklch"})).unwrap();
let w: Vec<f64> = vivid["values"].as_array().unwrap().iter().map(|v| v.as_f64().unwrap()).collect();
let shown = cms::active().display_rgb(&Color::lab(50.0, 100.0, 0.0)).map(|v| v.clamp(0.0, 1.0));
let clipped = vectorcraft_color::oklab::to_oklch(shown);
assert!((w[0] / 100.0 - clipped[0]).abs() < 1e-9 && (w[1] - clipped[1]).abs() < 1e-9, "{vivid} {clipped:?}");
assert!((w[2] - clipped[2]).abs() < 1e-9 && (0.0..360.0).contains(&w[2]), "{vivid} {clipped:?}");
assert!(vectorcraft_color::oklab::in_srgb(vectorcraft_color::oklab::oklch_to_srgb(w[0] / 100.0, w[1], w[2])), "{vivid}");
// RGB numbers past 0..1 answer the OKLCH of the clipped color `hex` reports: white.
let past = s.execute("color.convert", &json!({"color": [2.0, 2.0, 2.0], "to": "oklch"})).unwrap();
assert_eq!(past["hex"], "#ffffff");
let l = past["values"][0].as_f64().unwrap();
assert!((l - 100.0).abs() < 0.01 && past["values"][1].as_f64().unwrap() < 1e-3, "{past}");
}
#[test]
fn assign_profile_is_stored_and_undoable() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
@@ -682,6 +721,273 @@ fn proof_setup_simulates_tritanopia() {
s.execute("view.proofSetup", &json!({"target": "workingCmyk", "proof": false})).unwrap();
}
/// View › Proof Setup › Customize's settings: an RGB profile as the device, Preserve Numbers and
/// Simulate Black Ink, kept in the proof view, read back and drawn; bad values are refused and
/// leave the view as it was.
#[test]
fn proof_setup_takes_the_custom_proof_settings() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let _v = DefaultView::new();
let mut s = session();
rect(&mut s, 0.0, 0.0, 100.0, 100.0, json!("#000000"));
let r = s.execute("view.proofSetup", &json!({})).unwrap();
assert_eq!((r["preserveNumbers"].as_bool(), r["simulateBlack"].as_bool()), (Some(false), Some(false)));
let device = format!("cmyk:{}", cms::GENERIC_CMYK);
let r = s.execute("view.proofSetup", &json!({"target": device, "simulateBlack": true, "proof": true})).unwrap();
assert_eq!((r["target"].as_str(), r["simulateBlack"].as_bool(), r["proofColors"].as_bool()), (Some(device.as_str()), Some(true), Some(true)));
let setup = vectorcraft_render::proof::active_proof().unwrap();
assert!(setup.simulate_black && !setup.preserve_numbers);
let doc = s.doc().unwrap().doc.clone();
let gray = render(&doc, RenderOptions { proof: Some(setup.clone()), ..Default::default() }).pixel(50, 50);
let black = render(&doc, RenderOptions { proof: Some(ProofSetup { simulate_black: false, ..setup }), ..Default::default() }).pixel(50, 50);
assert!(gray[0] > black[0] + 10, "the press black shows as a gray: {gray:?} vs {black:?}");
let rgb = format!("rgb:{}", cms::DISPLAY_P3);
let r = s.execute("view.proofSetup", &json!({"target": rgb, "preserveNumbers": true})).unwrap();
assert_eq!((r["target"].as_str(), r["preserveNumbers"].as_bool()), (Some(rgb.as_str()), Some(true)));
assert_eq!(vectorcraft_render::proof::view().setup.target, ProofTarget::Rgb(cms::DISPLAY_P3.into()));
// Unchanged settings leave the revision alone.
let rev = s.doc().unwrap().revision;
s.execute("view.proofSetup", &json!({"target": rgb, "preserveNumbers": true, "simulateBlack": true})).unwrap();
assert_eq!(s.doc().unwrap().revision, rev);
let view = vectorcraft_render::proof::view();
refused(&mut s, "view.proofSetup", json!({"target": "rgb:Nope"}), "unknown RGB profile `Nope`");
refused(&mut s, "view.proofSetup", json!({"target": format!("rgb:{}", cms::GENERIC_CMYK)}), "unknown RGB profile");
refused(&mut s, "view.proofSetup", json!({"target": "rgb:"}), "unknown RGB profile");
refused(&mut s, "view.proofSetup", json!({"target": "workingCmyk", "preserveNumbers": "yes"}), "`preserveNumbers` must be true or false");
refused(&mut s, "view.proofSetup", json!({"simulateBlack": 1}), "`simulateBlack` must be true or false");
assert_eq!(vectorcraft_render::proof::view(), view, "the proof view is unchanged");
assert_eq!(s.doc().unwrap().revision, rev, "nothing redraws");
}
/// A custom proof setup saved to a file loads back as the same setup with Proof Colors on; saving
/// leaves the proof view as it is, and `view.proofSetup.read` only reads the file.
#[test]
fn a_saved_proof_setup_loads_back() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let _v = DefaultView::new();
let dir = vectorcraft_testkit::TempDir::new("proof-setup-file");
let path = dir.join("press.vcproof").to_string_lossy().to_string();
let mut s = session();
let device = format!("cmyk:{}", cms::GENERIC_CMYK);
let r = s
.execute(
"view.proofSetup.save",
&json!({"path": path, "target": device, "intent": "perceptual", "preserveNumbers": true, "simulateBlack": true}),
)
.unwrap();
assert_eq!((r["path"].as_str(), r["target"].as_str(), r["intent"].as_str()), (Some(path.as_str()), Some(device.as_str()), Some("perceptual")));
assert_eq!(vectorcraft_render::proof::view(), Default::default(), "saving leaves the proof view alone");
let text = std::fs::read_to_string(&path).unwrap();
assert!(text.contains("\"format\": \"vectorcraft-proof-setup\"") && text.contains("\"version\": 1"), "{text}");
let r = s.execute("view.proofSetup.read", &json!({"path": path})).unwrap();
assert_eq!((r["target"].as_str(), r["preserveNumbers"].as_bool(), r["simulateBlack"].as_bool()), (Some(device.as_str()), Some(true), Some(true)));
assert_eq!(vectorcraft_render::proof::view(), Default::default(), "reading changes nothing");
assert!(!crate::waits_for_tool_edit("view.proofSetup.read"), "reading does not finish a tool's edit");
let rev = s.doc().unwrap().revision;
let r = s.execute("view.proofSetup.load", &json!({"path": path})).unwrap();
assert_eq!((r["proofColors"].as_bool(), r["path"].as_str()), (Some(true), Some(path.as_str())));
let v = vectorcraft_render::proof::view();
assert!(v.proof_colors);
let want = ProofSetup {
target: ProofTarget::Cmyk(cms::GENERIC_CMYK.into()),
intent: Intent::Perceptual,
simulate_paper: false,
preserve_numbers: true,
simulate_black: true,
..Default::default()
};
assert_eq!(v.setup, want);
assert!(s.doc().unwrap().revision > rev, "the canvas redraws");
// Saved from the current setup, the file holds that setup: the round trip keeps every field.
let again = dir.join("again.vcproof").to_string_lossy().to_string();
s.execute("view.proofSetup.save", &json!({"path": again, "simulatePaper": true})).unwrap();
s.execute("view.proofSetup", &json!({"target": "workingCmyk"})).unwrap();
s.execute("view.proofSetup.load", &json!({"path": again})).unwrap();
assert_eq!(vectorcraft_render::proof::view().setup, ProofSetup { simulate_paper: true, ..want });
}
/// Saving refuses a target that is not a device, bad params, a bad name and a file larger than
/// loading reads; loading refuses a file
/// that is too large, not a proof setup, newer, or whose device is a profile that is not loaded,
/// and the proof view stays as it was.
#[test]
fn proof_setup_files_refuse_what_they_cannot_use() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let _v = DefaultView::new();
let dir = vectorcraft_testkit::TempDir::new("proof-setup-refused");
let file = |n: &str| dir.join(n).to_string_lossy().to_string();
let mut s = session();
let path = file("a.vcproof");
refused(&mut s, "view.proofSetup.save", json!({"path": path, "target": "protanopia"}), "`protanopia` is not a device to simulate");
refused(&mut s, "view.proofSetup.save", json!({"path": path, "target": "rgb:Nope"}), "unknown RGB profile `Nope`");
refused(&mut s, "view.proofSetup.save", json!({"path": path, "simulateBlack": "yes"}), "`simulateBlack` must be true or false");
refused(&mut s, "view.proofSetup.save", json!({}), "missing `path` or `name`");
refused(&mut s, "view.proofSetup.save", json!({"path": path, "name": "x"}), "not both");
refused(&mut s, "view.proofSetup.save", json!({"path": " "}), "`path` is empty");
refused(&mut s, "view.proofSetup.save", json!({"name": "x"}), "need the preferences folder");
assert!(!std::path::Path::new(&path).exists(), "nothing is written");
s.attach_proof_setups(dir.join("Proof Setups"));
for bad_name in ["", " ", "../up", "a/b", "a\\b", ".hidden", "c:d"] {
refused(&mut s, "view.proofSetup.save", json!({"name": bad_name}), "`name`");
}
refused(&mut s, "view.proofSetup.save", json!({"name": "x".repeat(101)}), "longer than 100 characters");
// A device whose name makes the file larger than load reads is refused, and nothing is written.
let long = "Long Profile Name ".repeat(4000);
cms::register_icc(&cms::icc_bytes(cms::DISPLAY_P3).unwrap(), Some(long.clone())).unwrap();
let refusal = s.execute("view.proofSetup.save", &json!({"path": path, "target": format!("rgb:{long}")}));
cms::unregister_icc(&long);
assert!(refusal.unwrap_err().to_string().contains("larger than 65536 bytes"), "a setup load can't read is refused");
assert!(!std::path::Path::new(&path).exists(), "nothing is written");
let before = vectorcraft_render::proof::view();
let write = |n: &str, text: &str| {
let p = file(n);
std::fs::write(&p, text).unwrap();
p
};
let ok = r#"{"format": "vectorcraft-proof-setup", "version": 1, "target": "workingCmyk", "intent": "relative"}"#;
let cases = [
(write("big.vcproof", &format!("{ok}{}", " ".repeat(64 << 10))), "larger than 65536 bytes"),
(write("junk.vcproof", "not json"), "not a proof setup file"),
(write("other.vcproof", r#"{"format": "other", "version": 1}"#), "not a VectorCraft proof setup file"),
(write("newer.vcproof", &ok.replace("\"version\": 1", "\"version\": 2")), "made by a newer VectorCraft"),
(write("missing.vcproof", &ok.replace("workingCmyk", "cmyk:Not Loaded")), "the CMYK profile `Not Loaded`, which is not loaded"),
(write("blind.vcproof", &ok.replace("workingCmyk", "deuteranopia")), "not a device to simulate"),
(write("intent.vcproof", &ok.replace("relative", "vivid")), "unknown intent `vivid`"),
(write("flag.vcproof", &ok.replace("}", r#", "simulatePaper": 1}"#)), "`simulatePaper` must be true or false"),
];
for (p, msg) in cases {
for cmd in ["view.proofSetup.load", "view.proofSetup.read"] {
refused(&mut s, cmd, json!({"path": p}), msg);
}
}
refused(&mut s, "view.proofSetup.load", json!({"path": file("gone.vcproof")}), "gone.vcproof");
assert_eq!(vectorcraft_render::proof::view(), before, "the proof view is unchanged");
// A file of the limit's size is read.
let padded = format!("{ok}{}", " ".repeat((64 << 10) - ok.len()));
s.execute("view.proofSetup.load", &json!({"path": write("limit.vcproof", &padded)})).unwrap();
}
/// Setups saved by name go in the Proof Setups folder, made on the first save, and are listed by
/// name; other files there are left out, and a run without the folder lists none.
#[test]
fn proof_setups_saved_by_name_are_listed() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let _v = DefaultView::new();
let mut s = session();
assert_eq!(s.execute("view.proofSetup.list", &json!({})).unwrap(), json!({"folder": null, "setups": [], "truncated": false}));
let dir = vectorcraft_testkit::TempDir::new("proof-setup-list");
let folder = dir.join("Proof Setups");
s.attach_proof_setups(folder.clone());
let r = s.execute("view.proofSetup.list", &json!({})).unwrap();
assert_eq!(r["setups"], json!([]), "no folder yet: none saved");
let r = s.execute("view.proofSetup.save", &json!({"name": " Coated Press ", "target": format!("rgb:{}", cms::DISPLAY_P3)})).unwrap();
let saved = folder.join("Coated Press.vcproof");
assert_eq!(r["path"].as_str(), Some(saved.to_string_lossy().as_ref()));
s.execute("view.proofSetup.save", &json!({"name": "Bright"})).unwrap();
std::fs::write(folder.join("notes.txt"), "x").unwrap();
std::fs::create_dir(folder.join("Sub.vcproof")).unwrap();
let r = s.execute("view.proofSetup.list", &json!({})).unwrap();
let names: Vec<&str> = r["setups"].as_array().unwrap().iter().filter_map(|e| e["name"].as_str()).collect();
assert_eq!(names, ["Bright", "Coated Press"]);
assert_eq!(r["truncated"], false);
s.execute("view.proofSetup.load", &json!({"name": "Coated Press"})).unwrap();
assert_eq!(vectorcraft_render::proof::view().setup.target, ProofTarget::Rgb(cms::DISPLAY_P3.into()));
for i in 0..101 {
std::fs::write(folder.join(format!("z{i:03}.vcproof")), "x").unwrap();
}
let r = s.execute("view.proofSetup.list", &json!({})).unwrap();
assert_eq!((r["setups"].as_array().unwrap().len(), r["truncated"].as_bool()), (100, Some(true)));
assert_eq!((r["setups"][0]["name"].as_str(), r["setups"][99]["name"].as_str()), (Some("Bright"), Some("z097")), "the first 100 by name");
}
/// Other files in the Proof Setups folder, however many, do not keep its setups from the listing.
#[test]
fn proof_setups_are_listed_among_many_other_files() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let _v = DefaultView::new();
let mut s = session();
let dir = vectorcraft_testkit::TempDir::new("proof-setup-list-crowded");
let folder = dir.join("Proof Setups");
std::fs::create_dir_all(&folder).unwrap();
for i in 0..5000 {
std::fs::write(folder.join(format!("a{i:04}.txt")), "").unwrap();
}
s.attach_proof_setups(folder.clone());
s.execute("view.proofSetup.save", &json!({"name": "Press"})).unwrap();
let r = s.execute("view.proofSetup.list", &json!({})).unwrap();
assert_eq!((r["setups"].as_array().unwrap().len(), r["truncated"].as_bool()), (1, Some(false)));
assert_eq!(r["setups"][0]["name"], "Press");
}
/// The listing names only files that `name` loads (`<name>.vcproof`, a name `save` can give), in
/// the order of those names, and the limit keeps the first by name; a folder that can't be read is
/// an error, not an empty listing.
#[test]
fn proof_setups_are_listed_by_names_that_load_them() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let _v = DefaultView::new();
let mut s = session();
let dir = vectorcraft_testkit::TempDir::new("proof-setup-list-names");
let folder = dir.join("Proof Setups");
std::fs::create_dir_all(&folder).unwrap();
s.attach_proof_setups(folder.clone());
let ok = r#"{"format": "vectorcraft-proof-setup", "version": 1, "target": "workingCmyk", "intent": "relative"}"#;
for file in ["Press.vcproof", "Press Matte.vcproof", "Loud.VCPROOF", " Lead.vcproof"] {
std::fs::write(folder.join(file), ok).unwrap();
}
let names = |r: &Value| r["setups"].as_array().unwrap().iter().filter_map(|e| e["name"].as_str().map(str::to_string)).collect::<Vec<_>>();
let r = s.execute("view.proofSetup.list", &json!({})).unwrap();
assert_eq!((names(&r), r["truncated"].as_bool()), (vec!["Press".to_string(), "Press Matte".to_string()], Some(false)));
for name in names(&r) {
s.execute("view.proofSetup.read", &json!({ "name": name })).unwrap();
}
// `Press` and `Press Matte` compete for the last place: the first by name keeps it.
for i in 0..99 {
std::fs::write(folder.join(format!("A{i:02}.vcproof")), "x").unwrap();
}
let r = s.execute("view.proofSetup.list", &json!({})).unwrap();
let listed = names(&r);
assert_eq!((listed.len(), listed.last().map(String::as_str), r["truncated"].as_bool()), (100, Some("Press"), Some(true)));
// A folder that is not one can't be listed.
let file = dir.join("not a folder");
std::fs::write(&file, "x").unwrap();
s.attach_proof_setups(file);
refused(&mut s, "view.proofSetup.list", json!({}), "not a folder");
}
/// A file name that is not valid Unicode is left out of the listing, which then says it is
/// incomplete: a path made from a lossy copy of the name would name another file.
#[test]
fn proof_setup_names_that_are_not_unicode_are_left_out() {
let _g = GLOBAL.lock().unwrap_or_else(|e| e.into_inner());
let _v = DefaultView::new();
let mut s = session();
let dir = vectorcraft_testkit::TempDir::new("proof-setup-list-bytes");
let folder = dir.join("Proof Setups");
std::fs::create_dir_all(&folder).unwrap();
#[cfg(unix)]
let odd = {
use std::os::unix::ffi::OsStringExt;
std::ffi::OsString::from_vec(b"Odd\xff.vcproof".to_vec())
};
#[cfg(windows)]
let odd = {
use std::os::windows::ffi::OsStringExt;
std::ffi::OsString::from_wide(&"Odd?.vcproof".encode_utf16().map(|u| if u == u16::from(b'?') { 0xD800 } else { u }).collect::<Vec<_>>())
};
// A file system that refuses such a name has nothing to leave out.
if std::fs::write(folder.join(odd), "x").is_err() {
return;
}
std::fs::write(folder.join("Press.vcproof"), "x").unwrap();
s.attach_proof_setups(folder);
let r = s.execute("view.proofSetup.list", &json!({})).unwrap();
assert_eq!(
(r["setups"].as_array().map(Vec::len), r["setups"][0]["name"].as_str(), r["truncated"].as_bool()),
(Some(1), Some("Press"), Some(true))
);
}
/// Whether the content has a DeviceCMYK fill/stroke operator (`c m y k k` / `K`).
fn has_cmyk_op(pdf: &str) -> bool {
let toks: Vec<&str> = pdf.split_ascii_whitespace().collect();
+100
View File
@@ -585,6 +585,106 @@ fn a_polygon_takes_its_angle_radius_side_length_and_equal_sides() {
}
}
/// Rectangle Angle and Ellipse Angle: `rectangleAngle` and `ellipseAngle` turn each selected live
/// rectangle or ellipse about its own center, keeping its size, corners and pie, as one undo step.
/// The angle it already has records no step, each key leaves the other kind as it is, and a value
/// that is not a number is an error.
#[test]
fn a_rectangle_and_an_ellipse_take_their_angle() {
let (mut s, rect) = session();
run(&mut s, json!({"radius": 8}));
let ellipse = NodeId(s.execute("shape.ellipse", &json!({"x": 200, "y": 200, "width": 120, "height": 80})).unwrap()["id"].as_u64().unwrap());
run(&mut s, json!({"pieStart": 30, "pieEnd": 120}));
let live = |s: &Session, id: NodeId| {
let n = s.doc().unwrap().doc.node(id).unwrap();
(n.live_shape().unwrap().clone(), n.geometric_bounds().unwrap())
};
let steps = |s: &Session| s.doc().unwrap().history.undo.len();
let close = |a: f64, b: f64| (a - b).abs() < 1e-6;
let angle = |s: &Session, id: NodeId| live(s, id).0.shape_angle().unwrap();
// The ellipse's center: the middle of its untransformed box, wherever its pie leaves the path.
let ellipse_center = |s: &Session| match live(s, ellipse).0 {
LiveShape::Ellipse { w, h, xf, .. } => xf * vectorcraft_geom::Point::new(w / 2.0, h / 2.0),
l => panic!("{l:?}"),
};
let center = ellipse_center(&s);
s.execute("select.set", &json!({"ids": [rect.0]})).unwrap();
let n = steps(&s);
run(&mut s, json!({"rectangleAngle": 90}));
let (l, b) = live(&s, rect);
assert!(close(angle(&s, rect), 90.0), "{l:?}");
// 100 × 60 at (10, 10) turned about (60, 40): 60 wide, 100 tall, same center.
assert!(close(b.width(), 60.0) && close(b.height(), 100.0) && close(b.center().x, 60.0) && close(b.center().y, 40.0), "{b:?}");
let LiveShape::Rectangle { w, h, radii, .. } = &l else { panic!("{l:?}") };
assert!(close(*w, 100.0) && close(*h, 60.0) && *radii == [8.0; 4], "{w} {h} {radii:?}");
assert_eq!(steps(&s), n + 1, "one undo step");
for same in [json!({"rectangleAngle": 90}), json!({"rectangleAngle": 450}), json!({"rectangleAngle": -270}), json!({"ellipseAngle": 10})] {
run(&mut s, same.clone());
assert_eq!(steps(&s), n + 1, "{same} records no undo step");
}
// A turn the field gives back rounded is the angle the shape has: typing it again records no step.
run(&mut s, json!({"rectangleAngle": 33.3}));
let now = angle(&s, rect);
run(&mut s, json!({"rectangleAngle": now}));
run(&mut s, json!({"rectangleAngle": 33.3}));
assert_eq!(steps(&s), n + 2);
for bad in [json!({"rectangleAngle": "left"}), json!({"ellipseAngle": "up"}), json!({"rectangleAngle": true})] {
assert!(s.execute("object.setLiveShape", &bad).is_err(), "{bad}");
assert_eq!(steps(&s), n + 2, "{bad} changes nothing");
}
// The ellipse turns about its center and keeps its pie.
s.execute("select.set", &json!({"ids": [ellipse.0]})).unwrap();
run(&mut s, json!({"ellipseAngle": 90}));
let (l, b) = live(&s, ellipse);
assert!(close(angle(&s, ellipse), 90.0), "{l:?}");
let LiveShape::Ellipse { pie, .. } = &l else { panic!("{l:?}") };
assert_eq!(*pie, (30.0, 120.0));
let now = ellipse_center(&s);
assert!(close(now.x, center.x) && close(now.y, center.y), "{center:?} → {now:?}");
assert!(b.width() < b.height(), "120 × 80 turned a quarter turn: {b:?}");
// Both selected: each key turns its own kind only, each about its own center.
s.execute("select.set", &json!({"ids": [rect.0, ellipse.0]})).unwrap();
run(&mut s, json!({"rectangleAngle": 45}));
assert!(close(angle(&s, rect), 45.0) && close(angle(&s, ellipse), 90.0));
let b = live(&s, rect).1;
assert!(close(b.center().x, 60.0) && close(b.center().y, 40.0), "{b:?}");
s.execute("edit.undo", &json!({})).unwrap();
assert!(close(angle(&s, rect), 33.3));
// A reflected rectangle takes the angle too, about its center.
s.execute("select.set", &json!({"ids": [rect.0]})).unwrap();
s.execute("object.reflect", &json!({"axis": "vertical"})).unwrap();
let before = live(&s, rect).1.center();
run(&mut s, json!({"rectangleAngle": 20}));
let after = live(&s, rect).1.center();
assert!(close(angle(&s, rect), 20.0) && close(before.x, after.x) && close(before.y, after.y), "{before:?} → {after:?}");
}
/// A shape named in `ids` that a turn would take past the coordinate limit (±4,000,000 pt) is an
/// error that changes nothing, whether or not it is selected.
#[test]
fn a_turn_past_the_coordinate_limit_is_an_error() {
let mut s = Session::new();
s.execute("file.new", &json!({"width": 400, "height": 400})).unwrap();
let mut add = |cmd: &str, p: Value| s.execute(cmd, &p).unwrap()["id"].as_u64().unwrap();
// Each reaches within 10 pt of the limit and past it when turned.
let rect = add("shape.rectangle", json!({"x": 3_999_890, "y": 100, "width": 100, "height": 100}));
let ellipse = add("shape.ellipse", json!({"x": 3_999_950, "y": 100, "width": 40, "height": 100}));
let polygon = add("shape.polygon", json!({"cx": 3_999_955, "cy": 200, "radius": 50, "sides": 6}));
for (id, key, angle) in [(rect, "rectangleAngle", 45), (ellipse, "ellipseAngle", 90), (polygon, "polygonAngle", 90)] {
for selected in [false, true] {
s.execute("select.set", &json!({"ids": if selected { vec![id] } else { vec![] }})).unwrap();
let (doc, steps) = (s.doc().unwrap().doc.clone(), s.doc().unwrap().history.undo.len());
let e = s.execute("object.setLiveShape", &json!({"ids": [id], key: angle})).unwrap_err();
assert!(e.to_string().contains("out of range"), "{key}, selected {selected}: {e}");
assert!(*s.doc().unwrap().doc == *doc && s.doc().unwrap().history.undo.len() == steps, "{key}, selected {selected}: changed");
}
}
}
/// A live line's Line Properties: Line Length keeps its first end in place, Line Angle (degrees
/// counterclockwise, any finite value brought into 0 to 360) turns it about its midpoint, the
/// length applies before the angle, every selected line takes them in one undo step, and a value
+147
View File
@@ -212,6 +212,153 @@ fn cancel_new_pattern_removes_it() {
assert_eq!(doc(&s).layers.len(), 1);
}
/// A 30×40 blue rectangle at (100, 100) with no stroke, selected.
fn blue_rect(s: &mut Session) -> NodeId {
let b = rect(s, 100.0, 100.0, 30.0, 40.0);
s.execute("paint.setFill", &json!({"ids": [b.0], "color": "#0000ff"})).unwrap();
s.execute("paint.setStroke", &json!({"ids": [b.0], "none": true})).unwrap();
sel(s, &[b]);
b
}
/// Replace Pattern Art gives the pattern copies of the selected art as its tile art in one undo
/// step: the pattern keeps its name, swatch, place, tile and options, art painted with it keeps the
/// paint, and the selected art stays on the canvas, selected. Undo and Redo swap the two tiles.
#[test]
fn replace_art_gives_a_pattern_new_tile_art() {
let mut s = session();
let red = make_dots(&mut s);
let filled = rect(&mut s, 200.0, 200.0, 100.0, 100.0);
s.execute("paint.setFill", &json!({"ids": [filled.0], "swatch": "Dots"})).unwrap();
s.execute("pattern.options", &json!({"name": "Dots", "tileType": "hexByRow"})).unwrap();
let blue = blue_rect(&mut s);
let old = doc(&s).pattern("Dots").unwrap().clone();
let place = |s: &Session| doc(s).swatches_iter().position(|w| w.name == "Dots");
let (at, swatches, steps) = (place(&s), doc(&s).swatches_iter().count(), s.doc().unwrap().history.undo.len());
let v = s.execute("object.pattern.replaceArt", &json!({"name": "Dots"})).unwrap();
assert_eq!(v["name"], "Dots");
let d = doc(&s);
let def = d.pattern("Dots").unwrap();
assert_eq!(def.art.len(), 1);
assert_eq!(def.art[0].kind, node(&s, blue).kind, "the tile art is the blue rectangle");
assert_eq!(def.art[0].appearance, node(&s, blue).appearance);
assert_ne!(def.art[0].id, blue, "a copy with an id of its own");
assert_eq!((def.tile, def.tile_type, &def.name), (old.tile, old.tile_type, &old.name), "the tile and options stay");
assert_eq!((d.patterns.len(), place(&s), d.swatches_iter().count()), (1, at, swatches), "no new pattern or swatch");
assert!(is_pattern(&node(&s, filled).appearance.fill_paint(), "Dots"), "the filled art keeps the pattern");
assert!(d.node(blue).is_some() && d.node(red).is_some(), "the art stays");
assert_eq!(s.doc().unwrap().selection.objects.to_vec(), vec![blue], "the art stays selected");
let st = s.doc().unwrap();
assert_eq!((st.history.undo.len(), st.history.undo.last().map(|e| e.label.as_str())), (steps + 1, Some("Replace Pattern Art")));
let new = def.art.clone();
s.execute("edit.undo", &json!({})).unwrap();
assert_eq!(doc(&s).pattern("Dots").unwrap(), &old, "Undo gives the old tile art back");
s.execute("edit.redo", &json!({})).unwrap();
assert_eq!(doc(&s).pattern("Dots").unwrap().art, new, "Redo gives the new tile art");
}
/// With Size Tile to Art on, the tile fits the new art (and its spacing); `ids` names the art.
#[test]
fn replace_art_fits_the_tile_when_size_tile_to_art_is_on() {
let mut s = session();
make_dots(&mut s);
s.execute("pattern.options", &json!({"name": "Dots", "sizeTileToArt": true, "hSpacing": 4, "vSpacing": 6})).unwrap();
let blue = blue_rect(&mut s);
s.execute("select.set", &json!({"ids": []})).unwrap();
s.execute("object.pattern.replaceArt", &json!({"name": "Dots", "ids": [blue.0]})).unwrap();
assert_eq!(doc(&s).pattern("Dots").unwrap().tile, Rect::new(98.0, 97.0, 132.0, 143.0));
}
/// Art that matches the tile art already, its own ids aside, records no undo step.
#[test]
fn replace_art_that_matches_the_tile_art_records_nothing() {
let mut s = session();
make_dots(&mut s);
blue_rect(&mut s);
s.execute("object.pattern.replaceArt", &json!({"name": "Dots"})).unwrap();
let (before, steps) = (doc(&s).clone(), s.doc().unwrap().history.undo.len());
s.execute("object.pattern.replaceArt", &json!({"name": "Dots"})).unwrap();
assert_eq!(s.doc().unwrap().history.undo.len(), steps);
assert_eq!(doc(&s), &before);
}
/// Replace Pattern Art is refused, changing nothing, for a missing name or pattern, with no art,
/// while a pattern is edited, and for art painted with the pattern itself, directly, through
/// another pattern, through a symbol, through the paints a graph stores, through a graph design a
/// graph draws its columns with, through the art of a brush on a stroke and through the symbol of an
/// inline graphic in type.
#[test]
fn replace_art_is_refused_without_changing_anything() {
let mut s = session();
make_dots(&mut s);
// "Holds dots": a pattern whose tile is painted with Dots.
let other = rect(&mut s, 100.0, 100.0, 10.0, 10.0);
s.execute("paint.setFill", &json!({"ids": [other.0], "swatch": "Dots"})).unwrap();
sel(&mut s, &[other]);
s.execute("object.pattern.make", &json!({"name": "Holds dots", "edit": false})).unwrap();
let via = rect(&mut s, 150.0, 150.0, 10.0, 10.0);
s.execute("paint.setFill", &json!({"ids": [via.0], "swatch": "Holds dots"})).unwrap();
let stroked = rect(&mut s, 200.0, 200.0, 10.0, 10.0);
s.execute("paint.setStroke", &json!({"ids": [stroked.0], "swatch": "Dots"})).unwrap();
sel(&mut s, &[stroked]);
let instance = id_of(&s.execute("symbol.new", &json!({"name": "Dotted"})).unwrap());
let graph = graph_painted_with(&mut s, "Dots");
// A graph whose stored columns name design "Dotted columns", drawn with Dots, before it is drawn
// again.
let design = rect(&mut s, 300.0, 300.0, 10.0, 10.0);
s.execute("paint.setFill", &json!({"ids": [design.0], "swatch": "Dots"})).unwrap();
s.execute("graph.design", &json!({"new": "Dotted columns", "ids": [design.0]})).unwrap();
let v = s.execute("graph.create", &json!({"type": "column", "x": 300, "y": 200, "width": 60, "height": 40, "csv": ",2024\nQ1,3"}));
let designed = id_of(&v.unwrap());
let mut extras = doc_mut(&mut s).node_mut(designed).unwrap().extras_mut();
extras.graph.as_mut().unwrap().series_columns =
vec![Some(vectorcraft_doc::ColumnDesign { design: "Dotted columns".into(), ..Default::default() })];
drop(extras);
// A path stroked with an art brush whose art is filled with Dots.
let brush_art = rect(&mut s, 300.0, 350.0, 20.0, 5.0);
s.execute("paint.setFill", &json!({"ids": [brush_art.0], "swatch": "Dots"})).unwrap();
s.execute("brush.new", &json!({"type": "art", "name": "Dotted brush", "ids": [brush_art.0]})).unwrap();
let brushed = rect(&mut s, 300.0, 380.0, 40.0, 10.0);
s.execute("paint.setFill", &json!({"ids": [brushed.0], "none": true})).unwrap();
s.execute("paint.setStroke", &json!({"ids": [brushed.0], "color": "#000000"})).unwrap();
s.execute("brush.apply", &json!({"name": "Dotted brush", "ids": [brushed.0]})).unwrap();
// Type that shows symbol "Dotted" as an inline graphic.
let typed = id_of(&s.execute("text.create", &json!({"x": 20, "y": 420, "text": "Hi"})).unwrap());
s.execute("text.insertInline", &json!({"id": typed.0, "at": 0, "symbol": "Dotted"})).unwrap();
let plain = blue_rect(&mut s);
let unchanged = |s: &Session, before: &vectorcraft_doc::Document, steps: usize, case: &str| {
assert_eq!(doc(s), before, "{case}: the document stays");
assert_eq!(s.doc().unwrap().history.undo.len(), steps, "{case}: no undo step");
};
let (before, steps) = (doc(&s).clone(), s.doc().unwrap().history.undo.len());
for (case, p, why) in [
("no name", json!({}), "missing name".to_string()),
("no pattern", json!({"name": "Stripes"}), "no pattern `Stripes`".into()),
("no art", json!({"name": "Dots", "ids": [9999]}), "select the art for the pattern tile".into()),
("painted with it", json!({"name": "Dots", "ids": [other.0]}), "art painted with `Dots` can't be its tile".into()),
("through a pattern", json!({"name": "Dots", "ids": [via.0]}), "art painted with `Dots` can't be its tile".into()),
("through a symbol", json!({"name": "Dots", "ids": [instance.0]}), "art painted with `Dots` can't be its tile".into()),
("through a graph's paints", json!({"name": "Dots", "ids": [graph.0]}), "art painted with `Dots` can't be its tile".into()),
("through a graph design", json!({"name": "Dots", "ids": [designed.0]}), "art painted with `Dots` can't be its tile".into()),
("through a brush", json!({"name": "Dots", "ids": [brushed.0]}), "art painted with `Dots` can't be its tile".into()),
("through an inline graphic", json!({"name": "Dots", "ids": [typed.0]}), "art painted with `Dots` can't be its tile".into()),
] {
let err = s.execute("object.pattern.replaceArt", &p).unwrap_err();
assert!(err.to_string().contains(&why), "{case}: {err}");
unchanged(&s, &before, steps, case);
}
s.execute("select.set", &json!({"ids": []})).unwrap();
let (before, steps) = (doc(&s).clone(), s.doc().unwrap().history.undo.len());
let err = s.execute("object.pattern.replaceArt", &json!({"name": "Dots"})).unwrap_err();
assert!(err.to_string().contains("select the art for the pattern tile"), "nothing selected: {err}");
unchanged(&s, &before, steps, "nothing selected");
s.execute("object.pattern.edit", &json!({"name": "Holds dots"})).unwrap();
let (before, steps) = (doc(&s).clone(), s.doc().unwrap().history.undo.len());
let err = s.execute("object.pattern.replaceArt", &json!({"name": "Dots", "ids": [plain.0]})).unwrap_err();
assert!(matches!(&err, EngineError::Disabled(_, w) if w == "finish editing the pattern first"), "while editing: {err}");
unchanged(&s, &before, steps, "while editing");
}
fn doc_mut(s: &mut Session) -> &mut vectorcraft_doc::Document {
Arc::make_mut(&mut s.doc_mut().unwrap().doc)
}
+15
View File
@@ -836,6 +836,21 @@ fn a_null_in_group_colors_removes_that_swatch_and_the_ones_after_it_keep_their_p
assert_eq!(link(&s, green), ("#00ff00".into(), Some(names[2].clone())), "art linked to a swatch that stays keeps its link");
}
/// "keep" in `groupColors` leaves the group's swatch at its place as it is, without Global Adjust,
/// and past the group's swatches it adds none.
#[test]
fn keep_in_group_colors_leaves_that_swatch_as_it_is() {
let mut s = session();
run(&mut s, "swatch.newGroup", json!({"name": "Brand", "colors": ["#2878f0", "#ff0000"]}));
let p = json!({"map": [], "group": "Brand", "groupColors": ["keep", "#00ff00", "keep"], "globalAdjust": {"brightness": -50}});
run(&mut s, "recolor.apply", p);
let g = &s.doc().unwrap().doc.swatch_groups.iter().find(|g| g.name == "Brand").unwrap().swatches;
let g: Vec<String> = g.iter().map(|w| w.paint.color().unwrap().to_hex()).collect();
assert_eq!(g.len(), 2, "{g:?}");
assert_eq!(g[0], "#2878f0", "the kept swatch takes no Global Adjust");
assert_ne!(g[1], "#00ff00", "the other new color takes it");
}
/// A gradient or pattern swatch of the group keeps its place and its paint when `recolor.apply`
/// rewrites the group: the group's colors, from the rows or from `groupColors`, go to its color
/// swatches in order.
+4 -2
View File
@@ -12,12 +12,14 @@ use crate::*;
const DENIED: &str = "Script file access denied";
/// A fresh folder for test `name`, with a `main` folder inside it for the script.
/// A fresh folder for test `name`, with a `main` folder inside it for the script, by its real
/// path: kept grants hold real paths, and a path named through a link (macOS's `/var` is
/// `/private/var`) is refused by its names alone.
fn folder(name: &str) -> PathBuf {
let base = std::env::temp_dir().join(format!("vc-script-io-{name}-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&base);
std::fs::create_dir_all(base.join("main")).unwrap();
base
std::fs::canonicalize(&base).unwrap()
}
fn write(path: &Path, bytes: &[u8]) {
+63
View File
@@ -125,6 +125,69 @@ fn add_used_colors_skips_colours_that_have_swatches() {
assert!(doc(&s).swatch("R=171 G=205 B=239").unwrap().global);
}
/// A run that finds no new color, over all the art or the selection, records no undo step.
#[test]
fn add_used_colors_with_no_new_color_records_no_undo_step() {
let mut s = session();
let a = rect_filled(&mut s, json!({"color": "#123456"}));
run(&mut s, "swatch.addUsedColors", json!({}));
run(&mut s, "select.set", json!({"ids": [a.0]}));
let before = doc(&s).clone();
let undo = undo_len(&s);
for p in [json!({}), json!({"selection": true, "global": true})] {
assert_eq!(run(&mut s, "swatch.addUsedColors", p), json!({"added": [], "linked": 0}));
assert_eq!(undo_len(&s), undo);
assert_eq!(*doc(&s), before);
}
// An empty selection is still an error, with nothing changed.
run(&mut s, "select.set", json!({"ids": []}));
let undo = undo_len(&s);
assert!(s.execute("swatch.addUsedColors", &json!({"selection": true})).is_err());
assert_eq!(undo_len(&s), undo);
}
/// A run that finds no new color, while the Type tool is typing, still ends the typing session: the
/// typing is its own undo step.
#[test]
fn add_used_colors_with_no_new_color_ends_the_typing() {
use vectorcraft_tools::{PointerEvent, PointerKind};
let mut s = session();
let v = ViewInfo::default();
let t = NodeId(run(&mut s, "text.create", json!({"x": 10, "y": 10, "text": "Hello"}))["id"].as_u64().unwrap());
run(&mut s, "swatch.addUsedColors", json!({}));
s.select_tool("type", v).unwrap();
let b = doc(&s).bounds_of(&[t], false).unwrap();
for kind in [PointerKind::Down, PointerKind::Up] {
s.pointer(&PointerEvent::new(kind, b.x1 - 1.0, b.center().y), v).unwrap();
}
s.tool_text("!", v).unwrap();
assert!(crate::cmd::typing_in_progress(&s));
let steps = undo_len(&s);
assert_eq!(run(&mut s, "swatch.addUsedColors", json!({})), json!({"added": [], "linked": 0}));
assert!(!crate::cmd::typing_in_progress(&s));
let labels: Vec<String> = s.doc().unwrap().history.undo.iter().map(|e| e.label.clone()).collect();
assert_eq!((labels.len(), labels.last().map(String::as_str)), (steps + 1, Some("Typing")));
}
/// Add Selected Colors while Global Edit is on links only the selected art: a member of the same
/// shape with another color keeps its color and stays unlinked, and Global Edit stays on.
#[test]
fn add_selected_colors_in_global_edit_keeps_the_other_members_colors() {
let mut s = session();
let a = rect_filled(&mut s, json!({"color": "#123456"}));
let b = rect_filled(&mut s, json!({"color": "#654321"}));
run(&mut s, "select.set", json!({"ids": [a.0]}));
let r = run(&mut s, "select.globalEdit", json!({}));
assert_eq!((r["active"].clone(), r["ids"].clone()), (json!(true), json!([a.0, b.0])), "the other rectangle is a member");
let other = fill(&s, b);
let undo = undo_len(&s);
run(&mut s, "swatch.addUsedColors", json!({"selection": true, "global": true}));
assert!(matches!(fill(&s, a), Paint::Solid { swatch: Some(_), .. }), "{:?}", fill(&s, a));
assert_eq!(fill(&s, b), other, "the unselected member keeps its color");
assert_eq!(undo_len(&s), undo + 1);
assert!(s.doc().unwrap().global_edit.is_some(), "Global Edit stays on");
}
/// Give `id` the fill `p` exactly as written (a command would round or convert some colors).
fn set_fill(s: &mut Session, id: NodeId, p: Paint) {
std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc).node_mut(id).unwrap().appearance.set_fill(p);
+31
View File
@@ -160,6 +160,37 @@ fn save_and_load_round_trip_keeps_cmyk_spot_and_groups() {
assert!(s.execute("swatch.library.save", &json!({"user": true})).is_err(), "no user folder in a headless session");
}
/// A library color group that holds a gradient comes into the document whole, the gradient at its
/// place in the group, as a `.ai` library's pattern swatch comes in its color group.
#[test]
fn add_brings_a_library_color_group_holding_a_gradient_whole() {
let mut s = session();
run(&mut s, "swatch.newGroup", json!({"name": "Brand", "colors": ["#123456", "#abcdef"]}));
let r = run(&mut s, "swatch.library.save", json!({"names": ["Brand", "Sunset"], "name": "Mixed"}));
// Move the Sunset gradient into the library's Brand group, as a hand-edited file can.
let mut lib: Value = serde_json::from_str(r["data"].as_str().unwrap()).unwrap();
let swatches = lib["swatches"].as_array_mut().unwrap();
let at = swatches.iter().position(|w| w["name"] == "Sunset").unwrap();
let sunset = swatches.remove(at);
lib["groups"][0]["swatches"].as_array_mut().unwrap().insert(1, sunset);
let r = run(&mut s, "swatch.library.load", json!({"data": lib.to_string(), "name": "mixed.vcswatches"}));
let id = r["library"].as_str().unwrap().to_string();
let (_, loaded) = cmd::swatchlib::library(&s, &id).unwrap();
assert!(matches!(loaded.groups[0].swatches[1].paint, Paint::Gradient(_)), "the reader keeps the gradient in the group");
run(&mut s, "swatch.delete", json!({"names": ["Brand", "Sunset"]}));
for p in [json!({"library": id}), json!({"library": id, "names": ["Brand"]})] {
let undo = undo_len(&s);
let r = run(&mut s, "swatch.library.add", p.clone());
assert!(r["added"].as_array().unwrap().iter().any(|n| n == "Sunset"), "{p}: {r}");
let brand = doc(&s).swatch_groups.iter().find(|g| g.name == "Brand").map(|g| g.swatches.clone()).unwrap_or_default();
let kinds: Vec<(&str, bool)> = brand.iter().map(|w| (w.name.as_str(), matches!(w.paint, Paint::Gradient(_)))).collect();
assert_eq!(kinds.len(), 3, "{p}: {kinds:?}");
assert_eq!(kinds[1], ("Sunset", true), "{p}: the gradient keeps its place in the group");
assert_eq!(undo_len(&s), undo + 1, "{p}: one undo step");
run(&mut s, "edit.undo", json!({}));
}
}
/// The swatch library commands, and the graphic style library save and load that share their file
/// handling, refuse a parameter of the wrong form, such as `user: "true"` or `names: "Grays"`, with
/// an error that names it; the document keeps its swatches and no undo step is recorded. A null
@@ -180,6 +180,48 @@ fn average_at_the_mean_adds_no_undo_step() {
assert!(state(&s) == before);
}
/// An instance the brush reaches but leaves as it is (the Symbol Screener with Alt on an opaque
/// instance, or without Alt on one at the lowest opacity it gives) is not counted, and a stroke
/// that changes no instance adds no undo step.
#[test]
fn an_instance_left_as_it_is_is_not_counted() {
let mut s = session();
let (opaque, faint) = (dot(&mut s, 100.0, 150.0), dot(&mut s, 300.0, 150.0));
s.execute("transparency.set", &json!({"ids": [faint.0], "opacity": 5})).unwrap();
let before = state(&s);
let r = adjust(&mut s, json!({"tool": "screen", "points": [[100, 150]], "radius": 30, "intensity": 10, "alt": true}));
assert_eq!(r["count"], 0, "Alt on an opaque instance");
let r = adjust(&mut s, json!({"tool": "screen", "points": [[300, 150]], "radius": 30, "intensity": 10}));
assert_eq!(r["count"], 0, "an instance at 5%");
assert!(state(&s) == before, "a stroke that changes nothing changed the document or its history");
// A stroke over both counts only the instance it changes.
let r = adjust(&mut s, json!({"tool": "screen", "points": [[200, 150]], "radius": 150, "intensity": 10}));
assert_eq!(r["count"], 1);
assert!(node(&s, opaque).opacity < 1.0 && node(&s, faint).opacity == 0.05);
}
/// Average gives an opacity below 5% when that is the mean: the Symbol Sprayer's new instance and
/// the Symbol Screener's instances take the mean of the instances under the brush.
#[test]
fn average_keeps_a_mean_opacity_below_five_percent() {
let mut s = session();
let set = NodeId(s.execute("symbol.spray", &json!({"name": "Dot", "points": [[200, 150]], "radius": 4})).unwrap()["id"].as_u64().unwrap());
let first = members(&s, set)[0];
s.execute("transparency.set", &json!({"ids": [first.0], "opacity": 2})).unwrap();
s.select(|_, sel| sel.set([set])).unwrap();
s.execute("symbol.spray", &json!({"name": "Dot", "points": [[215, 150]], "radius": 30})).unwrap();
let sprayed = *members(&s, set).last().unwrap();
assert!((node(&s, sprayed).opacity - 0.02).abs() < 1e-6, "{}", node(&s, sprayed).opacity);
// Two instances at 0% and 4%: Average brings both toward 2%, and neither goes past it.
let mut s = session();
let (a, b) = (dot(&mut s, 200.0, 150.0), dot(&mut s, 220.0, 150.0));
s.execute("transparency.set", &json!({"ids": [a.0], "opacity": 0})).unwrap();
s.execute("transparency.set", &json!({"ids": [b.0], "opacity": 4})).unwrap();
adjust(&mut s, json!({"tool": "screen", "points": [[210, 150]], "radius": 40, "intensity": 10, "method": "average"}));
let (pa, pb) = (node(&s, a).opacity, node(&s, b).opacity);
assert!(pa > 0.0 && pa <= 0.02 + 1e-6 && (0.02 - 1e-6..0.04).contains(&pb), "{pa} {pb}");
}
/// Average evens out the Symbol Stainer's amount and the Symbol Scruncher's spacing.
#[test]
fn average_evens_out_the_stain_and_the_spacing() {
@@ -279,6 +321,38 @@ fn an_unknown_method_is_refused() {
assert_eq!(center(&s, a), Point::new(200.0, 150.0));
}
/// `tool.setOption` refuses a Symbolism Tools Options value of the wrong kind or name, and the
/// tool's options stay as they were.
#[test]
fn tool_set_option_refuses_bad_symbolism_options() {
let mut s = session();
let before = s.tool_options_of("symbolSizer");
for (key, bad, want) in [
("method", json!("smooth"), "`method` must be one of userDefined, average, random"),
("sprayStain", json!("random"), "`sprayStain` must be one of average, userDefined"),
("usePressure", json!("yes"), "`usePressure` must be true or false"),
("diameter", json!("big"), "`diameter` must be a number from 2 to 2000"),
("style", json!(3), "`style` must be a string or null"),
("diameter", json!(1), "`diameter` must be a number from 2 to 2000"),
] {
let r = s.set_tool_option_cmd(&json!({"tool": "symbolSizer", "values": {key: bad}}));
assert_eq!(r, Err(want.to_string()), "{key}");
assert_eq!(s.tool_options_of("symbolSizer"), before, "{key}");
}
let r = s.set_tool_option_cmd(&json!({"tool": "symbolSizer", "values": {"method": "random", "sprayStain": "userDefined"}})).unwrap();
assert_eq!((r["method"].as_str(), r["sprayStain"].as_str()), (Some("random"), Some("userDefined")));
// Every option the options dialog sends is taken, together.
let all = json!({
"diameter": 100.0, "intensity": 6.0, "density": 4.0, "usePressure": true, "method": "average", "showBrush": false,
"sprayScrunch": "userDefined", "spraySize": "userDefined", "spraySpin": "userDefined", "sprayScreen": "userDefined",
"sprayStain": "average", "sprayStyle": "userDefined", "proportional": false, "affectsDensity": true,
});
let r = s.set_tool_option_cmd(&json!({"tool": "symbolSizer", "values": all})).unwrap();
for (key, v) in all.as_object().unwrap() {
assert_eq!(&r[key], v, "{key}");
}
}
/// With `usePressure` each point's pen pressure is the intensity there; without it the pressure is
/// not used. A pressure that isn't a number is an error.
#[test]
@@ -316,6 +390,13 @@ fn pen_pressure_is_the_intensity_with_use_pressure() {
json!({"tool": tool, "points": [[200, 150, "hard"]], "usePressure": true}),
"a point's pressure must be a number, not \"hard\"",
);
// Also on a point without coordinates, beside one that has them.
refused(
&mut s,
"symbol.adjust",
json!({"tool": tool, "points": [[200, 150], [null, 0, "bad"]], "usePressure": true}),
"a point's pressure must be a number, not \"bad\"",
);
}
for key in ["usePressure", "proportional", "affectsDensity"] {
let mut p = json!({"tool": "size", "points": [[200, 150]]});
@@ -644,6 +725,45 @@ fn set_density_starts_from_the_density_a_set_was_sprayed_at() {
assert!((center(&s, a).x - (150.0 - 50.0 * 0.25 / 0.65)).abs() < 1e-9, "{:?}", center(&s, a));
}
/// A set duplicated packs from the density recorded for its source, and a pasted set from the
/// density its source had at Copy: after Cut, after the source is given another density, and in
/// another document.
#[test]
fn a_copied_set_packs_from_the_density_of_its_source() {
for copy in ["duplicate", "paste", "cut", "changed after copy", "other document"] {
let mut s = session();
let row: Vec<Value> = (0..4).map(|i| json!([60.0 + 60.0 * f64::from(i), 150.0])).collect();
let set =
NodeId(s.execute("symbol.spray", &json!({"name": "Dot", "points": row, "radius": 4, "density": 2})).unwrap()["id"].as_u64().unwrap());
s.select(|_, sel| sel.set([set])).unwrap();
let first = match copy {
"duplicate" => "edit.duplicate",
"cut" => "edit.cut",
_ => "edit.copy",
};
s.execute(first, &json!({})).unwrap();
if copy == "changed after copy" {
s.execute("symbol.setDensity", &json!({"from": 5, "to": 9, "ids": [set.0]})).unwrap();
}
if copy == "other document" {
s.execute("file.new", &json!({"width": 400, "height": 300})).unwrap();
}
if copy != "duplicate" {
s.execute("edit.paste", &json!({})).unwrap();
}
let copied = s.doc().unwrap().selection.objects.clone();
assert!(copied.len() == 1 && (copy == "other document" || copied[0] != set), "{copy}: {copied:?}");
let ids = members(&s, copied[0]);
let xs = |s: &Session| ids.iter().map(|id| center(s, *id).x).collect::<Vec<_>>();
let was = xs(&s);
let middle = was.iter().sum::<f64>() / 4.0;
s.execute("symbol.setDensity", &json!({"from": 5, "to": 9, "ids": [copied[0].0]})).unwrap();
for (before, after) in was.iter().zip(xs(&s)) {
assert!((after - (middle + (before - middle) * 0.25 / 0.95)).abs() < 1e-9, "{copy}: {before} -> {after}");
}
}
}
/// A set of one instance takes the new density without moving, as one undo step, so a later change
/// packs it from that density; setting the density it already has adds no undo step.
#[test]
@@ -719,6 +839,102 @@ fn set_density_refuses_bad_densities_and_objects_without_a_set() {
assert!(state(&s) == before);
}
/// The Symbol Styler applies the style gradually, by the brush's strength at the instance: the pen
/// pressure with Use Pressure Pen, else the intensity, less toward the brush's edge. Random gives
/// each instance a share of that amount.
#[test]
fn the_styler_applies_the_style_by_the_brushs_strength() {
let styled = |extra: Value, x: f64| {
let mut s = session();
let a = dot(&mut s, 100.0, 150.0);
let id = s.execute("shape.rectangle", &json!({"x": 300, "y": 250, "width": 10, "height": 10})).unwrap()["id"].as_u64().unwrap();
s.execute("paint.setFill", &json!({"color": "#0000ff"})).unwrap();
s.execute("graphicStyle.new", &json!({"name": "Blue", "id": id})).unwrap();
s.select(|_, sel| sel.clear()).unwrap();
let mut p = json!({"tool": "style", "points": [[x, 150]], "radius": 10, "style": "Blue"});
p.as_object_mut().unwrap().extend(extra.as_object().unwrap().clone());
adjust(&mut s, p);
node(&s, a).appearance.fill().map_or(0.0, |f| f.opacity)
};
let near = |a: f32, b: f32| (a - b).abs() < 1e-6;
assert!(near(styled(json!({"intensity": 10}), 100.0), 1.0), "full strength at the center");
assert!(near(styled(json!({"intensity": 5}), 100.0), 0.5));
assert!(near(styled(json!({"intensity": 10}), 105.0), 0.5), "half way to the edge");
assert!(near(styled(json!({"usePressure": true, "points": [[100, 150, 0.25]]}), 100.0), 0.25));
assert!(near(styled(json!({"usePressure": true, "points": [[100, 150, 1.0]]}), 100.0), 1.0));
assert_eq!(styled(json!({"usePressure": true, "points": [[100, 150, 0.0]]}), 100.0), 0.0, "no pressure, no style");
// Random: instances the same distance from the point take different amounts, each from none to
// the User Defined amount there (0.25: pressure 0.5, half way to the brush's edge).
let mut s = session();
let ring: Vec<NodeId> = (0..6)
.map(|i| {
let a = f64::from(i) * std::f64::consts::TAU / 6.0;
dot(&mut s, 100.0 + 5.0 * a.cos(), 150.0 + 5.0 * a.sin())
})
.collect();
let id = s.execute("shape.rectangle", &json!({"x": 300, "y": 250, "width": 10, "height": 10})).unwrap()["id"].as_u64().unwrap();
s.execute("paint.setFill", &json!({"color": "#0000ff"})).unwrap();
s.execute("graphicStyle.new", &json!({"name": "Blue", "id": id})).unwrap();
s.select(|_, sel| sel.clear()).unwrap();
adjust(&mut s, json!({"tool": "style", "points": [[100, 150, 0.5]], "radius": 10, "usePressure": true, "method": "random", "style": "Blue"}));
let amounts: Vec<f32> = ring.iter().map(|a| node(&s, *a).appearance.fill().map_or(0.0, |f| f.opacity)).collect();
assert!(amounts.iter().all(|a| *a <= 0.25 + 1e-6), "{amounts:?}");
assert!(amounts.iter().any(|a| *a > 0.0), "{amounts:?}");
assert!(amounts.iter().any(|a| (a - amounts[0]).abs() > 1e-6), "{amounts:?}");
}
/// A sprayed instance's Average stain is the stain of the nearest instance whose stain shows: one
/// at no opacity is passed over and counts as no stain in the mean amount.
#[test]
fn average_spray_passes_over_a_stain_at_no_opacity() {
use vectorcraft_color::{Color, Paint};
let mut s = session();
let set =
NodeId(s.execute("symbol.spray", &json!({"name": "Dot", "points": [[100, 150], [130, 150]], "radius": 4})).unwrap()["id"].as_u64().unwrap());
let ids = members(&s, set);
assert_eq!(ids.len(), 2);
s.edit("Stains", |d, _| {
for (id, color, amount) in [(ids[0], Color::rgb(1.0, 0.0, 0.0), 0.0), (ids[1], Color::rgb(0.0, 0.0, 1.0), 1.0)] {
let n = d.node_mut(id).unwrap();
n.appearance.items.retain(|i| !matches!(i, vectorcraft_doc::AppearanceItem::Fill(_)));
let mut f = vectorcraft_doc::FillLayer::new(Paint::solid(color));
f.opacity = amount;
n.appearance.items.insert(0, vectorcraft_doc::AppearanceItem::Fill(f));
}
Ok(())
})
.unwrap();
s.execute("symbol.spray", &json!({"name": "Dot", "points": [[100, 150]], "radius": 40})).unwrap();
let new: Vec<NodeId> = members(&s, set).into_iter().filter(|id| !ids.contains(id)).collect();
assert_eq!(new.len(), 1);
let f = node(&s, new[0]).appearance.fill().cloned().unwrap();
assert_eq!(f.paint, Paint::solid(Color::rgb(0.0, 0.0, 1.0)));
assert!((f.opacity - 0.5).abs() < 1e-6, "{}", f.opacity);
}
/// The Symbol Shifter moves an instance whose transform flattens it (it has no size), as it moves
/// any other, and counts it.
#[test]
fn the_shifter_moves_an_instance_without_a_size() {
let mut s = session();
let a = dot(&mut s, 200.0, 150.0);
s.edit("Flatten", |d, _| {
if let Some(NodeKind::SymbolInstance { xf, .. }) = d.node_mut(a).map(|n| &mut n.kind) {
*xf = Affine::new([0.0, 0.0, 0.0, 0.0, 200.0, 150.0]);
}
Ok(())
})
.unwrap();
let r = adjust(&mut s, json!({"tool": "shift", "points": [[200, 150], [210, 150]], "radius": 40, "intensity": 10}));
assert_eq!(r["count"], 1);
assert!(center(&s, a).x > 200.0, "{:?}", center(&s, a));
// Average has no mean of such instances to move toward: it leaves them as they are.
let (before, x) = (state(&s), center(&s, a).x);
let r = adjust(&mut s, json!({"tool": "screen", "method": "average", "points": [[x, 150]], "radius": 40, "intensity": 10}));
assert_eq!(r["count"], 0);
assert!(state(&s) == before);
}
/// An instance with no size is shifted and screened as before; only Average, which needs its size,
/// leaves it as it is.
#[test]
@@ -759,6 +975,29 @@ fn an_instance_without_a_size_is_changed_by_every_method_but_average() {
assert!(state(&s) == before);
}
/// Average Stainer: an instance whose stain is at no opacity has no stain of its own, so it takes
/// the stain the mean picks, not its hidden paint.
#[test]
fn average_stain_replaces_a_stain_at_no_opacity() {
use vectorcraft_color::{Color, Paint};
let mut s = session();
let (a, b) = (dot(&mut s, 100.0, 150.0), dot(&mut s, 120.0, 150.0));
s.edit("Stains", |d, _| {
for (id, color, amount) in [(a, Color::rgb(1.0, 0.0, 0.0), 0.0), (b, Color::rgb(0.0, 0.0, 1.0), 1.0)] {
let n = d.node_mut(id).unwrap();
let mut f = vectorcraft_doc::FillLayer::new(Paint::solid(color));
f.opacity = amount;
n.appearance.items.insert(0, vectorcraft_doc::AppearanceItem::Fill(f));
}
Ok(())
})
.unwrap();
adjust(&mut s, json!({"tool": "stain", "method": "average", "points": [[100, 150]], "radius": 40, "intensity": 10}));
let f = node(&s, a).appearance.fill().cloned().unwrap();
assert_eq!(f.paint, Paint::solid(Color::rgb(0.0, 0.0, 1.0)));
assert!(f.opacity > 0.0, "{}", f.opacity);
}
/// A stroke that leaves every instance under the brush as it is (each already at full stain, or
/// at the least opacity) counts none and adds no undo step.
#[test]
+272
View File
@@ -0,0 +1,272 @@
//! The symbolism tools' Shift forms in `symbol.adjust {shift}`: the Symbol Shifter's stacking
//! order, the Symbol Sizer keeping the set's density, and the Symbol Stainer and Symbol Styler
//! keeping their amount while the color or style changes.
use serde_json::{Value, json};
use vectorcraft_doc::{Document, Node, NodeKind};
use vectorcraft_geom::Point;
use crate::*;
/// A document with the 20 pt square symbol "Dot" and nothing selected.
fn session() -> Session {
let mut s = Session::new();
s.execute("file.new", &json!({"width": 400, "height": 300})).unwrap();
s.execute("shape.rectangle", &json!({"x": 0, "y": 0, "width": 20, "height": 20})).unwrap();
s.execute("symbol.new", &json!({"name": "Dot"})).unwrap();
s.select(|_, sel| sel.clear()).unwrap();
s
}
/// An instance of Dot centered on (`x`, `y`), not selected.
fn dot(s: &mut Session, x: f64, y: f64) -> NodeId {
let id = NodeId(s.execute("symbol.place", &json!({"name": "Dot", "x": x, "y": y})).unwrap()["id"].as_u64().unwrap());
s.select(|_, sel| sel.clear()).unwrap();
id
}
fn node(s: &Session, id: NodeId) -> Node {
s.doc().unwrap().doc.node(id).cloned().unwrap()
}
fn center(s: &Session, id: NodeId) -> Point {
match node(s, id).kind {
NodeKind::SymbolInstance { xf, .. } => xf * Point::ZERO,
other => panic!("not an instance: {other:?}"),
}
}
fn width(s: &Session, id: NodeId) -> f64 {
node(s, id).geometric_bounds().unwrap().width()
}
fn undo_len(s: &Session) -> usize {
s.doc().unwrap().history.undo.len()
}
fn state(s: &Session) -> (Document, usize) {
((*s.doc().unwrap().doc).clone(), undo_len(s))
}
fn adjust(s: &mut Session, p: Value) -> Value {
s.execute("symbol.adjust", &p).unwrap()
}
/// The children of symbol set `set`, in stacking order (the first is at the back).
fn members(s: &Session, set: NodeId) -> Vec<NodeId> {
node(s, set).children().unwrap().iter().map(|c| c.id).collect()
}
/// The instance's fill: its color as RGB and its amount.
fn fill(s: &Session, id: NodeId) -> Option<([f32; 3], f32)> {
node(s, id).appearance.fill().map(|f| (f.paint.color().map_or([0.0; 3], |c| c.to_rgb()), f.opacity))
}
/// A symbol set of four instances in a row at x = 40, 120, 200 and 280, selected.
fn row(s: &mut Session) -> (NodeId, Vec<NodeId>) {
let pts: Vec<Value> = (0..4).map(|i| json!([40.0 + 80.0 * f64::from(i), 150.0])).collect();
let set = NodeId(s.execute("symbol.spray", &json!({"name": "Dot", "points": pts, "radius": 4})).unwrap()["id"].as_u64().unwrap());
let ids = members(s, set);
assert_eq!(ids.len(), 4);
(set, ids)
}
/// Shift-click with the Symbol Shifter brings the instances under the brush one place forward in
/// the set, and Alt+Shift-click sends them one place backward, without moving them on the canvas.
#[test]
fn shift_click_with_the_shifter_changes_the_stacking_order() {
let mut s = session();
let (set, ids) = row(&mut s);
let centers: Vec<Point> = ids.iter().map(|id| center(&s, *id)).collect();
let click = |s: &mut Session, x: f64, alt: bool| {
adjust(s, json!({"tool": "shift", "points": [[x, 150]], "radius": 10, "intensity": 10, "shift": true, "alt": alt}))["count"].clone()
};
let steps = undo_len(&s);
assert_eq!(click(&mut s, 120.0, false), 1);
assert_eq!(members(&s, set), [ids[0], ids[2], ids[1], ids[3]]);
assert_eq!(undo_len(&s), steps + 1, "one undo step");
assert_eq!(ids.iter().map(|id| center(&s, *id)).collect::<Vec<_>>(), centers, "nothing moves on the canvas");
assert_eq!(click(&mut s, 120.0, false), 1);
assert_eq!(members(&s, set), [ids[0], ids[2], ids[3], ids[1]]);
// Already in front of the others: nothing changes and no undo step is added.
let before = state(&s);
assert_eq!(click(&mut s, 120.0, false), 0);
assert!(state(&s) == before);
// Alt sends it back one place at a time; at the back it stays.
assert_eq!(click(&mut s, 120.0, true), 1);
assert_eq!(members(&s, set), [ids[0], ids[2], ids[1], ids[3]]);
click(&mut s, 120.0, true);
click(&mut s, 120.0, true);
assert_eq!(members(&s, set), [ids[1], ids[0], ids[2], ids[3]]);
assert_eq!(click(&mut s, 120.0, true), 0);
// Two instances under the brush move together past the next one.
s.execute("edit.undo", &json!({})).unwrap();
let both = adjust(&mut s, json!({"tool": "shift", "points": [[40, 150], [120, 150]], "radius": 10, "intensity": 10, "shift": true}));
assert_eq!(both["count"], 2);
assert_eq!(members(&s, set), [ids[2], ids[0], ids[1], ids[3]]);
// Without Shift a drag moves the instances, as before.
adjust(&mut s, json!({"tool": "shift", "points": [[280, 150], [290, 150]], "radius": 30, "intensity": 10}));
assert!(center(&s, ids[3]).x > centers[3].x);
}
/// Shift with the Symbol Sizer resizes the instances and keeps their centers where they are, even
/// with Resizing Affects Density.
#[test]
fn shift_with_the_sizer_keeps_the_density() {
let at = |affects: bool, shift: bool| {
let mut s = session();
let a = dot(&mut s, 220.0, 150.0);
adjust(
&mut s,
json!({"tool": "size", "points": [[200, 150], [200, 150]], "radius": 60, "intensity": 10, "affectsDensity": affects, "shift": shift}),
);
(center(&s, a), width(&s, a))
};
let (moved, _) = at(true, false);
assert!(moved.x > 220.5, "{moved:?}");
let (kept, grown) = at(true, true);
assert!((kept.x - 220.0).abs() < 1e-9 && (kept.y - 150.0).abs() < 1e-9 && grown > 20.5, "{kept:?} {grown}");
// It resizes as the Sizer does with Resizing Affects Density off.
assert_eq!(at(false, false), (kept, grown));
assert_eq!(at(false, true), (kept, grown));
}
/// Shift with the Symbol Stainer keeps the stain's amount and moves its color toward the fill
/// color; an instance without a stain is left as it is.
#[test]
fn shift_with_the_stainer_keeps_the_amount_and_changes_the_color() {
let mut s = session();
let (a, b) = (dot(&mut s, 100.0, 150.0), dot(&mut s, 300.0, 150.0));
adjust(&mut s, json!({"tool": "stain", "points": [[100, 150], [100, 150]], "radius": 5, "intensity": 10, "color": "#ff0000"}));
let (red, amount) = fill(&s, a).unwrap();
assert!(amount > 0.2 && red[0] > 0.99 && red[2] < 0.01, "{red:?} {amount}");
// A second fill below the stain, which Shift leaves as it is.
s.edit("Add fill", |d, _| {
let n = d.node_mut(a).unwrap();
let lower = n.appearance.fill().unwrap().clone();
n.appearance.items.insert(0, vectorcraft_doc::AppearanceItem::Fill(vectorcraft_doc::FillLayer { opacity: 0.5, ..lower }));
Ok(())
})
.unwrap();
let lower = node(&s, a).appearance.items[0].clone();
let stain = |s: &mut Session, x: f64| {
adjust(s, json!({"tool": "stain", "points": [[x, 150], [x, 150]], "radius": 5, "intensity": 10, "color": "#0000ff", "shift": true}))
};
assert_eq!(stain(&mut s, 100.0)["count"], 1);
let (color, kept) = fill(&s, a).unwrap();
assert_eq!(kept, amount, "the amount stays");
assert!(color[0] < red[0] && color[2] > 0.01, "toward blue: {color:?}");
assert_eq!((node(&s, a).appearance.items.len(), &node(&s, a).appearance.items[0]), (2, &lower), "the other fill stays");
// More strokes go on toward blue, with the amount still the same.
for _ in 0..30 {
stain(&mut s, 100.0);
}
let (bluer, kept) = fill(&s, a).unwrap();
assert_eq!(kept, amount);
assert!(bluer[2] > 0.9 && bluer[0] < 0.1, "{bluer:?}");
// Alt has no effect with Shift.
let green = json!({"tool": "stain", "points": [[100, 150]], "radius": 5, "intensity": 10, "color": "#00ff00", "shift": true});
adjust(&mut s, green.clone());
let plain = fill(&s, a);
s.execute("edit.undo", &json!({})).unwrap();
let mut with_alt = green;
with_alt["alt"] = json!(true);
adjust(&mut s, with_alt);
assert_eq!(fill(&s, a), plain);
// No stain on b: nothing changes and no undo step is added.
let before = state(&s);
assert_eq!(stain(&mut s, 300.0)["count"], 0);
assert!(state(&s) == before && fill(&s, b).is_none());
}
/// Shift with the Symbol Styler keeps the amount of the instance's stain or style and moves its
/// fill toward the selected style's fill.
#[test]
fn shift_with_the_styler_keeps_the_amount_and_changes_the_style() {
let mut s = session();
let a = dot(&mut s, 100.0, 150.0);
let id = s.execute("shape.rectangle", &json!({"x": 300, "y": 250, "width": 10, "height": 10})).unwrap()["id"].as_u64().unwrap();
s.execute("paint.setFill", &json!({"color": "#0000ff"})).unwrap();
s.execute("graphicStyle.new", &json!({"name": "Blue", "id": id})).unwrap();
s.select(|_, sel| sel.clear()).unwrap();
// A red stain at part strength.
adjust(&mut s, json!({"tool": "stain", "points": [[100, 150]], "radius": 5, "intensity": 10, "color": "#ff0000"}));
let (red, amount) = fill(&s, a).unwrap();
assert!(red[0] > 0.99 && amount > 0.0 && amount < 0.5, "{red:?} {amount}");
// Half the brush's strength at a point 2.5 pt from the instance: half way to blue.
adjust(&mut s, json!({"tool": "style", "points": [[102.5, 150]], "radius": 5, "intensity": 10, "style": "Blue", "shift": true}));
let (mixed, kept) = fill(&s, a).unwrap();
assert_eq!(kept, amount);
assert!(mixed[0] < 0.99 && mixed[2] > 0.01, "{mixed:?}");
// At the brush's center with full intensity it takes the style's fill.
adjust(&mut s, json!({"tool": "style", "points": [[100, 150]], "radius": 5, "intensity": 10, "style": "Blue", "shift": true}));
let (blue, kept) = fill(&s, a).unwrap();
assert_eq!(kept, amount);
assert!(blue[2] > 0.99 && blue[0] < 0.01, "{blue:?}");
}
/// A stain or style with no form between it and the new paint (a pattern and a solid color) takes
/// the new paint at once, at any strength, and keeps its amount.
#[test]
fn shift_changes_a_paint_that_has_no_form_in_between() {
use vectorcraft_color::Paint;
let mut s = session();
let a = dot(&mut s, 100.0, 150.0);
s.edit("Pattern fill", |d, _| {
let mut f = vectorcraft_doc::FillLayer::new(Paint::Pattern { pattern: "Tile".into(), xf: Default::default() });
f.opacity = 0.4;
d.node_mut(a).unwrap().appearance.items.insert(0, vectorcraft_doc::AppearanceItem::Fill(f));
Ok(())
})
.unwrap();
// Low intensity, near the brush's edge: far below half strength.
let r = adjust(&mut s, json!({"tool": "stain", "points": [[104, 150]], "radius": 5, "intensity": 1, "color": "#ff0000", "shift": true}));
assert_eq!(r["count"], 1);
let f = node(&s, a).appearance.fill().cloned().unwrap();
assert_eq!(f.opacity, 0.4, "the amount stays");
assert!(f.paint.color().is_some_and(|c| c.to_rgb()[0] > 0.99), "{:?}", f.paint);
}
/// A style name the document has no style for (the Styler's style from another document, or one
/// since renamed or deleted) moves the fill toward the document's first style after the default
/// one, as no name does, and the stain's amount stays.
#[test]
fn the_styler_takes_the_first_style_for_a_name_the_document_lacks() {
use vectorcraft_color::{Color, Paint};
let styled = |style: Option<&str>| {
let mut s = session();
let a = dot(&mut s, 100.0, 150.0);
s.execute("paint.setFill", &json!({"color": "#00ff00"})).unwrap();
s.select(|_, sel| sel.clear()).unwrap();
adjust(&mut s, json!({"tool": "stain", "points": [[100, 150]], "radius": 5, "intensity": 10, "color": "#ff0000"}));
let mut p = json!({"tool": "style", "points": [[100, 150]], "radius": 5, "intensity": 10, "shift": true});
if let Some(n) = style {
p["style"] = json!(n);
}
let stained = node(&s, a).appearance.fill().map(|f| f.opacity);
adjust(&mut s, p);
let f = node(&s, a).appearance.fill().cloned().unwrap();
assert_eq!(Some(f.opacity), stained, "the amount stays");
let first = s.doc().unwrap().doc.graphic_styles[1].appearance.fill_paint();
(f.paint, first)
};
let (missing, first) = styled(Some("No Such Style"));
let (none, _) = styled(None);
assert_eq!(missing, none);
// The paint is the first style's, not the active fill color.
assert_eq!(none, first);
assert_ne!(none, Paint::solid(Color::rgb(0.0, 1.0, 0.0)));
}
/// A `shift` that is not true, false or null is refused and changes nothing.
#[test]
fn a_bad_shift_is_refused() {
let mut s = session();
dot(&mut s, 100.0, 150.0);
for tool in ["shift", "size", "stain", "style"] {
let before = state(&s);
let r = s.execute("symbol.adjust", &json!({"tool": tool, "points": [[100, 150]], "shift": "yes"}));
assert!(matches!(&r, Err(EngineError::BadParams { msg, .. }) if msg == "`shift` must be true or false"), "{tool}: {r:?}");
assert!(state(&s) == before);
}
}
+220
View File
@@ -0,0 +1,220 @@
//! `shape.threePointArc`: an open circular arc between two ends, through a third point or
//! leaving an end toward it, and the Three-Point Arc tool's clicks that run it.
use serde_json::{Value, json};
use vectorcraft_doc::{Node, NodeKind};
use vectorcraft_geom::Point;
use vectorcraft_tools::{Mods, PointerEvent, PointerKind, ToolKey};
use crate::*;
const C: &str = "shape.threePointArc";
fn session() -> Session {
let mut s = Session::new();
s.execute("file.new", &json!({"width": 400, "height": 400})).unwrap();
s
}
fn node(s: &Session, id: NodeId) -> Node {
s.doc().unwrap().doc.node(id).unwrap().clone()
}
fn undo_len(s: &Session) -> usize {
s.doc().unwrap().history.undo.len()
}
fn object_count(s: &Session) -> usize {
let mut n = 0;
s.doc().unwrap().doc.walk(|_| n += 1);
n
}
fn id_of(v: &Value) -> NodeId {
NodeId(v["id"].as_u64().unwrap())
}
/// The largest distance of `points` from the path of `id`.
fn farthest_from_path(s: &Session, id: NodeId, points: &[Point]) -> f64 {
let n = node(s, id);
let path = n.path_data().unwrap();
points.iter().map(|p| path.nearest(*p).unwrap().4).fold(0.0, f64::max)
}
/// The arc from (0, 0) to (80, 0) through (40, -40) is the upper half of the circle about
/// (40, 0) with radius 40: an open path from one end to the other, through the third point, with
/// no fill and a stroke, selected, and one undo step.
#[test]
fn the_arc_through_a_third_point_is_an_open_path_and_one_undo_step() {
let mut s = session();
let undo = undo_len(&s);
let out = s.execute(C, &json!({"start": [0, 0], "end": [80, 0], "through": [40, -40]})).unwrap();
assert_eq!((out["cx"].as_f64(), out["cy"].as_f64(), out["radius"].as_f64()), (Some(40.0), Some(0.0), Some(40.0)), "{out}");
// From (0, 0) over the top to (80, 0): clockwise on the page.
assert!((out["sweep"].as_f64().unwrap() - 180.0).abs() < 1e-9, "{out}");
let id = id_of(&out);
let n = node(&s, id);
let NodeKind::Path { path, live: None, .. } = &n.kind else { panic!("not a plain path: {:?}", n.kind) };
let sp = &path.subpaths[0];
assert!(!sp.closed && path.subpaths.len() == 1);
assert_eq!((sp.anchors.first().map(|a| a.p), sp.anchors.last().map(|a| a.p)), (Some(Point::ORIGIN), Some(Point::new(80.0, 0.0))));
assert!(farthest_from_path(&s, id, &[Point::new(40.0, -40.0)]) < 1e-9);
assert!(n.appearance.fill_paint().is_none(), "no fill");
assert!(!n.appearance.stroke_paint().is_none(), "a stroke");
assert_eq!(s.doc().unwrap().selection.objects, [id]);
assert_eq!(undo_len(&s), undo + 1);
s.execute("edit.undo", &json!({})).unwrap();
assert!(s.doc().unwrap().doc.node(id).is_none());
// A third point between the quarter turns is an anchor too, so the path meets it exactly.
let via = Point::new(1000.0 * 20f64.to_radians().cos(), 1000.0 * 20f64.to_radians().sin());
let out = s.execute(C, &json!({"start": [1000, 0], "end": [0, 1000], "through": [via.x, via.y]})).unwrap();
let id = id_of(&out);
assert!(node(&s, id).path_data().unwrap().subpaths[0].anchors.iter().any(|a| a.p == via));
assert!(farthest_from_path(&s, id, &[via]) < 1e-9);
}
/// With `toward`, the arc leaves `start` heading at the point (its first handle points there),
/// or with `at: "end"` arrives at `end` along the line from the point to `end` (run backward, the
/// arc leaves `end` heading at the point).
#[test]
fn the_arc_toward_a_point_has_that_tangent_at_its_end() {
let mut s = session();
let out = s.execute(C, &json!({"start": [0, 0], "end": [80, 0], "toward": [30, -30]})).unwrap();
let n = node(&s, id_of(&out));
let first = n.path_data().unwrap().subpaths[0].anchors[0];
let d = (first.h_out - first.p).normalize();
assert!((d.dot(vectorcraft_geom::Vec2::new(1.0, -1.0).normalize()) - 1.0).abs() < 1e-12, "{d:?}");
// A quarter turn's tangent: the center is at (40, 40) and the radius √3200.
assert!((out["radius"].as_f64().unwrap() - 3200f64.sqrt()).abs() < 1e-9, "{out}");
let out = s.execute(C, &json!({"start": [0, 0], "end": [80, 0], "toward": [50, -30], "at": "end"})).unwrap();
let n = node(&s, id_of(&out));
let last = *n.path_data().unwrap().subpaths[0].anchors.last().unwrap();
let d = (last.p - last.h_in).normalize();
assert!((d.dot(vectorcraft_geom::Vec2::new(1.0, 1.0).normalize()) - 1.0).abs() < 1e-12, "{d:?}");
// The direction from the start and from the end mirror each other.
assert!((out["cx"].as_f64().unwrap() - 40.0).abs() < 1e-9 && (out["cy"].as_f64().unwrap() - 40.0).abs() < 1e-9, "{out}");
}
/// Points that are the same, a third point on the line through the ends, and an arc reaching past
/// the canvas are refused with a message; nothing is drawn and no undo step is added.
#[test]
fn points_with_no_arc_are_refused() {
let mut s = session();
let (undo, count) = (undo_len(&s), object_count(&s));
for p in [
json!({"start": [0, 0], "end": [0, 0], "through": [10, 10]}),
json!({"start": [0, 0], "end": [80, 0], "through": [40, 0]}),
json!({"start": [0, 0], "end": [80, 0], "through": [120, 0]}),
json!({"start": [0, 0], "end": [80, 0], "through": [80, 0]}),
json!({"start": [0, 0], "end": [80, 0], "toward": [0, 0]}),
json!({"start": [0, 0], "end": [80, 0], "toward": [-50, 0]}),
json!({"start": [0, 0], "end": [80, 0], "toward": [40, 0], "at": "end"}),
json!({"start": [0, 0], "end": [0, 0], "toward": [10, 10]}),
] {
let e = s.execute(C, &p).unwrap_err().to_string();
assert!(e.contains("no arc fits these points"), "{p}: {e}");
}
// Nearly in line beyond the end: the circle's center is about 1.2·10⁷ pt down the page, and the
// arc goes round the far side of it.
let far = json!({"start": [0, 0], "end": [80, 0], "through": [200, 0.001]});
let e = s.execute(C, &far).unwrap_err().to_string();
assert!(e.contains("result would exceed the canvas"), "{e}");
assert_eq!((undo_len(&s), object_count(&s)), (undo, count));
}
/// Missing or malformed points, both or neither of `through` and `toward`, an `at` that is not
/// "start" or "end", and an `at` with `through` are errors; nothing is drawn.
#[test]
fn malformed_params_are_refused() {
let mut s = session();
let count = object_count(&s);
for (p, want) in [
(json!({"end": [80, 0], "through": [40, 40]}), "`start` must be [x, y]"),
(json!({"start": [0, 0], "end": [80], "through": [40, 40]}), "`end` must be [x, y]"),
(json!({"start": [0, 0], "end": [80, 0], "through": [40, "a"]}), "`through` must be [x, y]"),
(json!({"start": [0, 0], "end": [80, 0], "through": null}), "`through` must be [x, y]"),
(json!({"start": [0, 0], "end": [80, 0], "toward": [10, 0, 0]}), "`toward` must be [x, y]"),
(json!({"start": [0, 0], "end": [80, 0]}), "give exactly one of `through` and `toward`"),
(json!({"start": [0, 0], "end": [80, 0], "through": [40, 40], "toward": [0, 40]}), "give exactly one of `through` and `toward`"),
(json!({"start": [0, 0], "end": [80, 0], "toward": [0, 40], "at": "middle"}), "`at` must be \"start\" or \"end\""),
(json!({"start": [0, 0], "end": [80, 0], "toward": [0, 40], "at": null}), "`at` must be \"start\" or \"end\""),
(json!({"start": [0, 0], "end": [80, 0], "through": [40, 40], "at": "end"}), "give `at` only with `toward`"),
(json!({"start": [0, 0], "end": [80, 0], "through": [40, 40], "at": "start"}), "give `at` only with `toward`"),
] {
let e = s.execute(C, &p).unwrap_err().to_string();
assert!(e.contains(want), "{p}: {e}");
}
assert_eq!(object_count(&s), count);
}
/// With Align New Objects to Pixel Grid on, the ends stay on the given points.
#[test]
fn the_arc_is_not_moved_onto_the_pixel_grid() {
let mut s = session();
s.execute("document.setup", &json!({"alignNewObjectsToPixelGrid": true})).unwrap();
let id = id_of(&s.execute(C, &json!({"start": [0.3, 0.2], "end": [80.6, 0.1], "through": [40.4, -39.7]})).unwrap());
let n = node(&s, id);
let sp = &n.path_data().unwrap().subpaths[0];
assert_eq!(sp.anchors.first().map(|a| a.p), Some(Point::new(0.3, 0.2)));
assert_eq!(sp.anchors.last().map(|a| a.p), Some(Point::new(80.6, 0.1)));
assert!(!n.extras().pixel_aligned);
}
fn view() -> ViewInfo {
ViewInfo { smart_guides: false, ..ViewInfo::default() }
}
fn click(s: &mut Session, x: f64, y: f64) {
for k in [PointerKind::Down, PointerKind::Up] {
s.pointer(&PointerEvent::new(k, x, y).with_mods(Mods::default()), view()).unwrap();
}
}
/// With the Three-Point Arc tool, three clicks draw the arc in one undo step; `]` before the third
/// click makes the third point give the direction instead. Escape drops the ends.
#[test]
fn three_clicks_with_the_tool_draw_the_arc() {
let mut s = session();
s.select_tool("threePointArc", view()).unwrap();
let (undo, count) = (undo_len(&s), object_count(&s));
click(&mut s, 100.0, 200.0);
click(&mut s, 180.0, 200.0);
assert_eq!((undo_len(&s), object_count(&s)), (undo, count), "two ends draw nothing yet");
click(&mut s, 140.0, 160.0);
assert_eq!(undo_len(&s), undo + 1);
let id = *s.doc().unwrap().selection.objects.first().unwrap();
assert!(farthest_from_path(&s, id, &[Point::new(100.0, 200.0), Point::new(140.0, 160.0), Point::new(180.0, 200.0)]) < 1e-9);
// Escape after the ends: the next clicks start afresh.
click(&mut s, 0.0, 0.0);
click(&mut s, 10.0, 300.0);
s.tool_key(ToolKey::Escape, Mods::default(), view()).unwrap();
click(&mut s, 100.0, 300.0);
click(&mut s, 180.0, 300.0);
s.tool_key(ToolKey::BracketRight, Mods::default(), view()).unwrap();
let undo = undo_len(&s);
// Straight up from the first end: the upper half circle about (140, 300).
click(&mut s, 100.0, 250.0);
assert_eq!(undo_len(&s), undo + 1);
let id = *s.doc().unwrap().selection.objects.first().unwrap();
assert!(farthest_from_path(&s, id, &[Point::new(140.0, 260.0)]) < 1e-9);
}
/// `tool.setOption` (the Tool Options dialog's Save) sets the tool's `direction` option, and
/// refuses a value that is not true or false, or an option the tool doesn't have.
#[test]
fn set_option_sets_the_direction_and_refuses_bad_values() {
let mut s = session();
for on in [true, false] {
let set = s.set_tool_option_cmd(&json!({"tool": "threePointArc", "values": {"direction": on}})).unwrap();
assert_eq!(set["direction"], json!(on));
assert_eq!(s.tool_options_of("threePointArc")["direction"], json!(on));
}
let cases = [
(json!({"tool": "threePointArc", "key": "direction", "value": "yes"}), "tool `threePointArc`: `direction` must be true or false"),
(json!({"tool": "threePointArc", "key": "bogus", "value": true}), "tool `threePointArc`: unknown option `bogus`"),
];
for (p, want) in cases {
assert_eq!(s.set_tool_option_cmd(&p).unwrap_err(), want, "{p}");
}
assert_eq!(s.tool_options_of("threePointArc")["direction"], json!(false));
}
+80
View File
@@ -138,6 +138,86 @@ fn a_dropped_press_does_not_keep_what_its_drag_changed() {
assert_eq!(s.prefs.tool_settings["polygon"]["sides"], json!(7), "and stores its sides");
}
/// An option set with `tool.setOption` while a press is held survives the dropped press, in the
/// tool and in the stored options, while what the drag itself changed is put back in both.
#[test]
fn an_option_set_during_a_dropped_press_is_kept() {
let mut s = session();
select(&mut s, "rectangularGrid");
let v = ViewInfo { smart_guides: false, ..Default::default() };
s.pointer(&PointerEvent::new(PointerKind::Down, 100.0, 100.0), v).unwrap();
s.pointer(&PointerEvent::new(PointerKind::Drag, 200.0, 180.0), v).unwrap();
s.tool_key(ToolKey::Up, Mods::default(), v).unwrap();
s.tool_key(ToolKey::Right, Mods::default(), v).unwrap();
assert_eq!((s.tool_options()["rows"].clone(), s.tool_options()["columns"].clone()), (json!(6), json!(6)));
s.set_tool_option_cmd(&json!({"key": "columns", "value": 9})).unwrap();
s.drop_tool_press(v).unwrap();
let o = s.tool_options();
assert_eq!((o["rows"].clone(), o["columns"].clone()), (json!(5), json!(9)), "the drag's rows go back; the set columns stay");
let saved = &s.prefs.tool_settings["rectangularGrid"];
assert_eq!((saved["rows"].clone(), saved["columns"].clone()), (json!(5), json!(9)), "the drag's rows are not stored; the set columns are");
select(&mut s, "selection");
select(&mut s, "rectangularGrid");
let o = s.tool_options();
assert_eq!((o["rows"].clone(), o["columns"].clone()), (json!(5), json!(9)), "a tool switch keeps the set columns");
// The same through the desktop app's setter.
s.pointer(&PointerEvent::new(PointerKind::Down, 100.0, 100.0), v).unwrap();
s.pointer(&PointerEvent::new(PointerKind::Drag, 200.0, 180.0), v).unwrap();
s.tool_key(ToolKey::Up, Mods::default(), v).unwrap();
s.set_tool_option("columns", &json!(3));
s.drop_tool_press(v).unwrap();
let o = s.tool_options();
assert_eq!((o["rows"].clone(), o["columns"].clone()), (json!(5), json!(3)));
let saved = &s.prefs.tool_settings["rectangularGrid"];
assert_eq!((saved["rows"].clone(), saved["columns"].clone()), (json!(5), json!(3)));
}
/// A Corner Radius preference set while a Rounded Rectangle press is held survives the dropped
/// press, in the tool and in the preference.
#[test]
fn a_corner_radius_set_during_a_dropped_press_is_kept() {
let mut s = session();
select(&mut s, "roundedRectangle");
let v = ViewInfo { smart_guides: false, ..Default::default() };
s.pointer(&PointerEvent::new(PointerKind::Down, 100.0, 100.0), v).unwrap();
s.pointer(&PointerEvent::new(PointerKind::Drag, 200.0, 180.0), v).unwrap();
let mut p = s.prefs.clone();
p.corner_radius = 30.0;
s.apply_prefs(p);
s.drop_tool_press(v).unwrap();
assert_eq!(s.tool_options()["cornerRadius"].as_f64(), Some(30.0), "the tool keeps the new radius");
assert_eq!(s.prefs.corner_radius, 30.0, "the preference keeps it");
}
/// An option set with `tool.setOption` on a tool that lent a selection tool for a Cmd-drag
/// survives the dropped press, in the tool and in the stored options. So does a Corner Radius
/// preference set while the Rounded Rectangle lends one.
#[test]
fn an_option_set_on_a_lending_tool_during_a_dropped_press_is_kept() {
let mut s = session();
select(&mut s, "rectangularGrid");
let v = ViewInfo { smart_guides: false, ..Default::default() };
let cmd = Mods { cmd: true, ..Default::default() };
s.pointer(&PointerEvent::new(PointerKind::Down, 100.0, 100.0).with_mods(cmd), v).unwrap();
s.pointer(&PointerEvent::new(PointerKind::Drag, 200.0, 180.0).with_mods(cmd), v).unwrap();
assert_eq!(s.lender.as_ref().map(|t| t.id()), Some("rectangularGrid"), "the press lent a selection tool");
s.set_tool_option_cmd(&json!({"tool": "rectangularGrid", "key": "columns", "value": 9})).unwrap();
s.drop_tool_press(v).unwrap();
assert_eq!(s.tool_id(), "rectangularGrid", "the lending tool is back");
assert_eq!(s.tool_options()["columns"], json!(9), "the tool keeps the set columns");
assert_eq!(s.prefs.tool_settings["rectangularGrid"]["columns"], json!(9), "and stores them");
select(&mut s, "roundedRectangle");
s.pointer(&PointerEvent::new(PointerKind::Down, 100.0, 100.0).with_mods(cmd), v).unwrap();
s.pointer(&PointerEvent::new(PointerKind::Drag, 200.0, 180.0).with_mods(cmd), v).unwrap();
assert_eq!(s.lender.as_ref().map(|t| t.id()), Some("roundedRectangle"), "the press lent a selection tool");
let mut p = s.prefs.clone();
p.corner_radius = 30.0;
s.apply_prefs(p);
s.drop_tool_press(v).unwrap();
assert_eq!(s.tool_options()["cornerRadius"].as_f64(), Some(30.0), "the tool keeps the new radius");
assert_eq!(s.prefs.corner_radius, 30.0, "the preference keeps it");
}
/// A dropped Pen press drops only the anchor it was placing: the path being drawn goes on with
/// the next click.
#[test]
+66 -7
View File
@@ -298,6 +298,10 @@ impl Session {
let points = self.tool.options().get("meshPoints").cloned().unwrap_or_else(|| Value::Array(vec![]));
lent.set_option("meshPoints", &points);
}
// The Cmd/Ctrl held for the loan is not the Cmd/Ctrl that mirrors a dragged handle (#7842).
if id == "directSelection" {
lent.set_option("lentByCmd", &Value::Bool(true));
}
self.selection_at_lend = self.active().map(|d| (d.uid, d.selection.clone()));
self.lender = Some(std::mem::replace(&mut self.tool, lent));
Ok((PointerEvent { mods: Mods { cmd: false, ..ev.mods }, ..*ev }, settled))
@@ -611,13 +615,18 @@ impl Session {
/// Escape, as during a drag, for most tools), and a release returns the tool to rest. Of what
/// the tool asks for along the way, only a cancel and a notify run, so a marquee selects
/// nothing and a click opens no size dialog. The tool gets back the persistent options it had
/// when the press began, and none of the press's changes to them are stored. A dropped Type
/// press restores the prior selection. The freeform gradient point selected once the tool
/// took the press is selected again. A press held while the tool computes an edit on another
/// thread has not reached the tool: it is removed from the held input with the pointer events
/// and tool keys held after it, and the tool is left as it is. A perspective plane key held
/// after it stays held, since the plane it picks outlasts a dropped press. Pointer events held
/// after the last held release belong to the press the tool has, and are removed with it.
/// when the press began, and none of the press's changes to them are stored. An option set
/// during the press with [`Self::set_tool_option`] or [`Self::set_tool_options`], or a General ›
/// Corner Radius change during a Rounded Rectangle press, keeps its new value, also when the
/// tool lent a selection tool for the press (a Cmd-drag). Setting an option stores all of the
/// tool's options, the press's changes included, so the dropped press then stores the options
/// it puts back. A dropped Type press restores the prior selection. The freeform gradient
/// point selected once the tool took the press is selected again. A press held while the tool
/// computes an edit on another thread has not reached the tool: it is removed from the held
/// input with the pointer events and tool keys held after it, and the tool is left as it is.
/// A perspective plane key held after it stays held, since the plane it picks outlasts a
/// dropped press. Pointer events held after the last held release belong to the press the tool
/// has, and are removed with it.
pub fn drop_tool_press(&mut self, view: ViewInfo) -> Result<()> {
let (from, held) = self.held_press();
let keep: Vec<bool> = (self.held_input.iter().enumerate())
@@ -635,6 +644,7 @@ impl Session {
// Nothing to roll back without a document; the tool still drops the press and gets the release.
let _ = self.cancel_interaction();
let before = self.press_options.take();
let stored = std::mem::take(&mut self.press_options_stored);
let type_selection = self.press_type_selection.take();
let point = self.press_point.take();
let mut acts = self.with_tool_cx(view, |t, cx| t.drop_press(cx));
@@ -669,6 +679,11 @@ impl Session {
self.tool.set_option(k, v);
}
}
// An option set during the press stored every option the tool had then, the press's
// changes included: those stored values are put back too.
if stored {
self.keep_tool_settings();
}
}
r.map(drop)
}
@@ -706,6 +721,7 @@ impl Session {
match ev.kind {
PointerKind::Down => {
self.press_options = Some((self.tool.id().to_string(), Self::persistent_options(self.tool.as_ref())));
self.press_options_stored = false;
self.press_type_selection =
if matches!(self.tool.id(), "type" | "areaType" | "typeOnPath" | "verticalType" | "verticalAreaType" | "verticalTypeOnPath") {
self.active().map(|st| (st.selection.clone(), st.active_layer))
@@ -715,6 +731,7 @@ impl Session {
}
PointerKind::Up => {
self.press_options = None;
self.press_options_stored = false;
self.press_type_selection = None;
}
_ => {}
@@ -1309,9 +1326,12 @@ impl Session {
if key == "queue" && self.tool.id() == "place" {
self.note_place_queue_roots();
}
let before_press = self.options_before_press_set();
let sets_pressed = self.press_taken_by(self.tool.id());
self.tool.set_option(key, v);
self.tool_set_since_reset = true;
self.keep_tool_settings();
self.keep_press_set(before_press, |k| sets_pressed && k == key, sets_pressed);
}
/// Keep the automation roots in force now as those the place cursor's queue, being loaded,
@@ -1356,6 +1376,8 @@ impl Session {
self.note_place_queue_roots();
}
let active = id.is_none_or(|id| id == self.tool.id());
let before_press = self.options_before_press_set();
let sets_pressed = self.press_taken_by(id.unwrap_or(self.tool.id()));
// The tool that lent a selection tool for a Cmd-drag is the tool chosen, and active again
// when the drag ends.
let lender = id.is_some_and(|id| self.lender.as_deref().is_some_and(|l| l.id() == id));
@@ -1393,9 +1415,46 @@ impl Session {
let set = other.id();
Self::restore_stores(&self.prefs, self.tool.as_mut(), |store| settings::stores(set).any(|(s, _)| s == store));
}
self.keep_press_set(before_press, |k| sets_pressed && values.contains_key(k), sets_pressed);
out
}
/// The tool that took the press under way: the active tool, or the tool that lent a selection
/// tool for it (a Cmd-drag), which the dropped press gives its options back to.
fn pressed_tool(&self) -> Option<&dyn Tool> {
let (pressed, _) = self.press_options.as_ref()?;
std::iter::once(&self.tool).chain(self.lender.as_ref()).map(|t| t.as_ref()).find(|t| t.id() == pressed)
}
/// Tool `id` took the press under way ([`Self::pressed_tool`]).
pub(crate) fn press_taken_by(&self, id: &str) -> bool {
self.pressed_tool().is_some_and(|t| t.id() == id)
}
/// The persistent options of the tool that took the press under way ([`Self::pressed_tool`])
/// before an option is set: a dropped press puts back the options it began with, except those
/// the set changes ([`Self::keep_press_set`]).
fn options_before_press_set(&self) -> Option<Map<String, Value>> {
self.pressed_tool().map(Self::persistent_options)
}
/// After an option is set during a held press, the press's saved options take the options of
/// the tool that took the press that the set changed from `before` or named (`named`), so a
/// dropped press keeps them. `stored`: the set stored that tool's options, the press's changes
/// included, so a dropped press stores the options it puts back.
fn keep_press_set(&mut self, before: Option<Map<String, Value>>, named: impl Fn(&str) -> bool, stored: bool) {
let Some(before) = before else { return };
let Some(now) = self.pressed_tool().map(Self::persistent_options) else { return };
self.press_options_stored |= stored;
if let Some((_, saved)) = self.press_options.as_mut() {
for (k, v) in now {
if before.get(&k) != Some(&v) || named(&k) {
saved.insert(k, v);
}
}
}
}
/// `tool.setOption {tool?, key?, value?, values?}` (a command of the desktop app and of the
/// headless host): set one option (`key`, `value`) or several (`values`) of `tool` (default:
/// the tool active when the call arrives, named before the edit in progress is finished) → its
+125 -1
View File
@@ -6,7 +6,7 @@
use std::sync::{Mutex, MutexGuard};
use serde_json::json;
use vectorcraft_color::cms;
use vectorcraft_color::{Color, cms};
use vectorcraft_engine::Session;
use vectorcraft_engine::cmd::colormgmt::{PROFILES_KEY, ProfileChoice, ProfileIssue, doc_profiles};
use vectorcraft_engine::store::MAX_PRESET_FILE;
@@ -20,6 +20,22 @@ fn settings() -> MutexGuard<'static, ()> {
SETTINGS.lock().unwrap_or_else(|e| e.into_inner())
}
/// The working Color Settings as a test found them, put back when it ends (a failing one too)
/// before the next test takes its turn.
struct Restored(cms::ColorSettings, #[allow(dead_code)] MutexGuard<'static, ()>);
impl Drop for Restored {
fn drop(&mut self) {
let _ = cms::set_active(&self.0);
}
}
/// [`settings`], with the working Color Settings put back afterwards.
fn restored_settings() -> Restored {
let g = settings();
Restored(cms::working_settings(), g)
}
#[test]
fn color_settings_lists_profiles_and_validates() {
let _g = settings();
@@ -923,6 +939,114 @@ fn saved_color_settings_that_cannot_be_used_leave_the_defaults() {
}
}
/// View › Proof Setup › Customize's Preserve CMYK Numbers proofs each color from its own inks:
/// with Device CMYK as the working space, C50 M50 Y50 and K50 show as the same gray, and on
/// VectorCraft Generic CMYK they print, and so proof, as different grays; a pattern's tile art
/// proofs the same way. Without it the proof starts from the drawn pixels, which are the same.
#[test]
fn preserve_cmyk_numbers_proofs_each_color_from_its_inks() {
let _g = restored_settings();
let mut s = session();
s.execute("edit.colorSettings", &json!({"cmyk": cms::DEVICE_CMYK})).unwrap();
let k50 = json!({"c": 0, "m": 0, "y": 0, "k": 50});
let cmy = rect(&mut s, 0.0, 0.0, 100.0, 100.0);
exec(&mut s, "paint.setFill", json!({"ids": [cmy.0], "color": {"c": 50, "m": 50, "y": 50, "k": 0}}));
let k = rect(&mut s, 100.0, 0.0, 100.0, 100.0);
exec(&mut s, "paint.setFill", json!({"ids": [k.0], "color": k50}));
// A pattern whose tile is all K50, filling a band below the squares.
let tile = rect(&mut s, 300.0, 0.0, 10.0, 10.0);
exec(&mut s, "paint.setFill", json!({"ids": [tile.0], "color": k50}));
exec(&mut s, "object.pattern.make", json!({"ids": [tile.0], "name": "K50 Tile", "edit": false}));
let band = rect(&mut s, 0.0, 130.0, 200.0, 40.0);
exec(&mut s, "paint.setFill", json!({"ids": [band.0], "swatch": "K50 Tile"}));
let proof = |preserve_numbers| vectorcraft_render::proof::ProofSetup {
target: vectorcraft_render::proof::ProofTarget::Cmyk(cms::GENERIC_CMYK.into()),
preserve_numbers,
..Default::default()
};
let doc = s.doc().unwrap().doc.clone();
let pixel = |px: &[u8], x: usize, y: usize| [px[(y * 200 + x) * 4], px[(y * 200 + x) * 4 + 1], px[(y * 200 + x) * 4 + 2]];
// The pixels at the centers of the two squares and in the patterned band.
let shown = |proof: Option<vectorcraft_render::proof::ProofSetup>| {
let opts = RenderOptions { proof, background: Some([255, 255, 255, 255]), ..Default::default() };
let px = Renderer::new().render(&doc, 200, 200, Affine::IDENTITY, &opts).pixels;
(pixel(&px, 50, 50), pixel(&px, 150, 50), pixel(&px, 55, 155))
};
let (a, b, _) = shown(None);
let (pa, pb, _) = shown(Some(proof(false)));
let (ca, cb, cp) = shown(Some(proof(true)));
let want = |c: Color| cms::active().proof_color(&c, &proof(true)).map(|v| (v * 255.0).round() as i32);
let cmy_want = want(Color::cmyk(0.5, 0.5, 0.5, 0.0));
let k_want = want(Color::cmyk(0.0, 0.0, 0.0, 0.5));
// With Simulate Paper Color the art sits on the device's paper, not on white.
let paper = vectorcraft_render::proof::ProofSetup { simulate_paper: true, ..proof(true) };
let tint = cms::active().proof_srgb([1.0; 3], &paper).map(|v| (v * 255.0).round() as i32);
let opts = RenderOptions { proof: Some(paper), background: Some([255, 255, 255, 255]), ..Default::default() };
let bare = pixel(&Renderer::new().render(&doc, 200, 200, Affine::IDENTITY, &opts).pixels, 50, 115);
assert_eq!(a, b, "the two builds show as one gray in Device CMYK");
assert_eq!(pa, pb, "proofed from the pixels, they stay one gray");
assert!(ca != cb, "proofed from their inks, they print differently: {ca:?} vs {cb:?}");
let near = |got: [u8; 3], want: [i32; 3]| got.iter().zip(want).all(|(g, w)| (i32::from(*g) - w).abs() <= 2);
assert!(near(ca, cmy_want) && near(cb, k_want), "{ca:?} {cmy_want:?}, {cb:?} {k_want:?}");
assert!(near(cp, k_want), "the pattern's tile proofs from its inks: {cp:?} vs {k_want:?}");
assert!(tint != [255; 3] && near(bare, tint), "the bare page shows the paper: {bare:?} vs {tint:?}");
}
/// With Preserve CMYK Numbers, an image in an opacity mask keeps its pixels as they are, so the
/// mask covers the same in a pattern's tile as outside one.
#[test]
fn preserve_cmyk_numbers_leaves_mask_images_in_pattern_tiles_as_they_are() {
let _g = restored_settings();
let mut s = session();
// A K100 square masked by a blue image, the same at (0, 0) and as a pattern's tile.
let masked = |s: &mut Session, x: f64| {
let obj = rect(s, x, 0.0, 20.0, 20.0);
exec(s, "paint.setFill", json!({"ids": [obj.0], "color": {"c": 0, "m": 0, "y": 0, "k": 100}}));
let blue = rect(s, x, 0.0, 20.0, 20.0);
exec(s, "paint.setFill", json!({"ids": [blue.0], "color": "#0000ff"}));
select(s, &[blue]);
exec(s, "object.rasterize", json!({"ppi": 72}));
let image = s.doc().unwrap().selection.objects[0];
select(s, &[obj, image]);
exec(s, "transparency.makeOpacityMask", json!({"clip": true}));
obj
};
masked(&mut s, 0.0);
let tile = masked(&mut s, 300.0);
exec(&mut s, "object.pattern.make", json!({"ids": [tile.0], "name": "Masked Tile", "edit": false}));
let band = rect(&mut s, 0.0, 100.0, 200.0, 40.0);
exec(&mut s, "paint.setFill", json!({"ids": [band.0], "swatch": "Masked Tile"}));
// An unmasked K100 square, for the color the masked one covers the page with.
let solid = rect(&mut s, 100.0, 0.0, 20.0, 20.0);
exec(&mut s, "paint.setFill", json!({"ids": [solid.0], "color": {"c": 0, "m": 0, "y": 0, "k": 100}}));
let proof = vectorcraft_render::proof::ProofSetup {
target: vectorcraft_render::proof::ProofTarget::Cmyk(cms::GENERIC_CMYK.into()),
preserve_numbers: true,
..Default::default()
};
let doc = s.doc().unwrap().doc.clone();
let pixel = |px: &[u8], x: usize, y: usize| [px[(y * 200 + x) * 4], px[(y * 200 + x) * 4 + 1], px[(y * 200 + x) * 4 + 2]];
// The masked square, the middle of a tile (the tiles start at the art's left and top edges,
// every 20 points), the unmasked square and the bare page.
let shown = |proof: Option<vectorcraft_render::proof::ProofSetup>| {
let opts = RenderOptions { proof, background: Some([255, 255, 255, 255]), ..Default::default() };
let px = Renderer::new().render(&doc, 200, 200, Affine::IDENTITY, &opts).pixels;
(pixel(&px, 10, 10), pixel(&px, 50, 130), pixel(&px, 110, 10), pixel(&px, 190, 60))
};
let (plain, plain_tile, plain_k, plain_page) = shown(None);
let (proofed, proofed_tile, proofed_k, proofed_page) = shown(Some(proof));
let near = |a: [u8; 3], b: [u8; 3]| a.iter().zip(b).all(|(a, b)| (i32::from(*a) - i32::from(b)).abs() <= 2);
assert!(plain != [255; 3] && near(plain, plain_tile), "the tile shows the masked square: {plain:?} vs {plain_tile:?}");
assert!(near(proofed, proofed_tile), "the tile's mask covers as the square's does: {proofed:?} vs {proofed_tile:?}");
// The proof changes the ink's color but not how much of the page the mask lets it cover.
let channel = |v: [u8; 3], i: usize| f32::from(v[i]);
let cover = (0..3).map(|i| (channel(plain_page, i) - channel(plain, i)) / (channel(plain_page, i) - channel(plain_k, i))).sum::<f32>() / 3.0;
assert!(cover > 0.02 && cover < 0.98, "the mask covers part of the square: {cover}");
let want: [u8; 3] =
std::array::from_fn(|i| (channel(proofed_page, i) + cover * (channel(proofed_k, i) - channel(proofed_page, i))).round() as u8);
assert!(near(proofed, want), "the proofed square keeps the mask's coverage: {proofed:?} vs {want:?}");
}
/// Edit › Color Settings' color management policies decide what opening a document tagged with
/// profiles other than the working spaces does with them: Preserve Embedded Profiles keeps them,
/// Off and Preserve Numbers take them off and keep the color numbers, and Convert to Working Space
+33
View File
@@ -1278,6 +1278,39 @@ fn polygon_properties_junk() {
assert!(failures.is_empty(), "{} failures:\n{}", failures.len(), failures.join("\n"));
}
/// A live rectangle's and ellipse's Rectangle and Ellipse Angle with junk values, drawn plain,
/// scaled unevenly, flattened to nothing and sheared: never a panic, and the document stays sound.
#[test]
fn rectangle_and_ellipse_angle_junk() {
let mut failures = vec![];
for (shape, key) in [("shape.rectangle", "rectangleAngle"), ("shape.ellipse", "ellipseAngle")] {
for xf in [
None,
Some(("object.scale", json!({"sx": 300, "sy": 20}))),
Some(("object.scale", json!({"sx": 1e-300, "sy": 100}))),
Some(("object.shear", json!({"angle": 40}))),
] {
for v in junk_values() {
let p = json!({ key: v });
let mut s = Fixture::Multi.session();
let Ok(_) = no_panic(s.execute(shape, &json!({"x": 60, "y": 60, "width": 80, "height": 50}))) else { continue };
if let Some((cmd, q)) = &xf {
let _ = no_panic(s.execute(cmd, q));
}
match catch_quiet(|| no_panic(s.execute("object.setLiveShape", &p))) {
Err(m) => failures.push(format!("PANIC object.setLiveShape {p} [{xf:?}]: {m}")),
Ok(_) => {
if let Err(e) = catch_quiet(|| check_all(&mut s)).unwrap_or_else(|m| Err(format!("panic in checks: {m}"))) {
failures.push(format!("object.setLiveShape {p} [{xf:?}]: {e}"));
}
}
}
}
}
}
assert!(failures.is_empty(), "{} failures:\n{}", failures.len(), failures.join("\n"));
}
/// A live line's Line Properties with junk values (the fixtures have no line), on a line, a line
/// whose ends meet and one at the coordinate limit: never a panic, and the document stays sound.
#[test]
+630
View File
@@ -0,0 +1,630 @@
//! Temporary Cmd/Control symmetry while Direct Selection drags an existing handle.
#![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]
use serde_json::{Value, json};
use vectorcraft_doc::{Node, NodeId};
use vectorcraft_engine::{Session, ViewInfo};
use vectorcraft_geom::{Anchor, AnchorKind, Point};
use vectorcraft_tools::{Mods, PointerEvent, PointerKind};
fn run(s: &mut Session, command: &str, params: Value) -> Value {
s.execute(command, &params).unwrap()
}
fn view() -> ViewInfo {
ViewInfo {
smart_guides: false,
guides: false,
snap_to_point: false,
snap_to_grid: false,
snap_to_pixel: false,
snap_to_glyph: false,
corner_widgets: false,
show_bbox: false,
..ViewInfo::default()
}
}
fn session() -> Session {
let mut s = Session::new();
run(&mut s, "file.new", json!({"width": 900, "height": 700}));
for (key, value) in [("constrainAngle", json!(0)), ("showHandlesMultipleAnchors", json!(true)), ("realTimeDrawing", json!(true))] {
run(&mut s, "prefs.set", json!({"key": key, "value": value}));
}
s
}
fn node(s: &Session, id: NodeId) -> Node {
s.doc().unwrap().doc.node(id).unwrap().clone()
}
fn curve(s: &mut Session, incoming: Point) -> NodeId {
let id = run(
s,
"path.create",
json!({"anchors": [
{"x": 20, "y": 220},
{"x": 100, "y": 100, "in": [incoming.x, incoming.y], "out": [180, 100]},
{"x": 320, "y": 220}
]}),
);
let id = NodeId(id["id"].as_u64().unwrap());
s.select_tool("directSelection", view()).unwrap();
id
}
fn anchor(s: &Session, id: NodeId) -> Anchor {
node(s, id).path_data().unwrap().subpaths[0].anchors[1]
}
fn pointer(s: &mut Session, kind: PointerKind, at: Point, mods: Mods) {
s.pointer(&PointerEvent::new(kind, at.x, at.y).with_mods(mods), view()).unwrap();
}
fn press_handle(s: &mut Session, at: Point) {
pointer(s, PointerKind::Down, at, Mods::default());
assert_eq!(s.tool_id(), "directSelection");
assert!(s.in_interaction(), "the visible handle press begins Reshape");
}
fn near(actual: Point, expected: Point) {
assert!(actual.distance(expected) < 1e-6, "point {actual:?}, expected {expected:?}");
}
fn handles(a: Anchor, incoming: Point, outgoing: Point, kind: AnchorKind) {
near(a.h_in, incoming);
near(a.h_out, outgoing);
assert_eq!(a.kind, kind);
}
fn assert_other_geometry(s: &Session, id: NodeId, before: &Node) {
let after = node(s, id);
let (old, new) = (before.path_data().unwrap(), after.path_data().unwrap());
assert_eq!(new.subpaths.len(), old.subpaths.len());
assert_eq!(new.subpaths[0].closed, old.subpaths[0].closed);
assert_eq!(new.subpaths[0].anchors.len(), 3);
assert_eq!(new.subpaths[0].anchors[0], old.subpaths[0].anchors[0]);
assert_eq!(new.subpaths[0].anchors[2], old.subpaths[0].anchors[2]);
assert_eq!(new.subpaths[0].anchors[1].p, old.subpaths[0].anchors[1].p);
assert_eq!(after.appearance, before.appearance);
}
#[test]
fn direct_handle_baseline_ordinary_smooth_keeps_the_opposite_length() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let before = node(&s, id);
assert_eq!(anchor(&s, id).kind, AnchorKind::Smooth);
let selection = json!(s.doc().unwrap().selection);
let undo = s.doc().unwrap().history.undo.len();
press_handle(&mut s, Point::new(180.0, 100.0));
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, Mods::default());
handles(anchor(&s, id), Point::new(60.0, 70.0), q, AnchorKind::Smooth);
assert_other_geometry(&s, id, &before);
pointer(&mut s, PointerKind::Up, q, Mods::default());
assert_eq!(s.doc().unwrap().history.undo.len(), undo + 1);
assert_eq!(json!(s.doc().unwrap().selection), selection);
}
#[test]
fn direct_handle_baseline_cmd_added_mid_drag_mirrors_the_opposite() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let before = node(&s, id);
press_handle(&mut s, Point::new(180.0, 100.0));
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, Mods::default());
handles(anchor(&s, id), Point::new(60.0, 70.0), q, AnchorKind::Smooth);
pointer(&mut s, PointerKind::Drag, q, Mods { cmd: true, ..Mods::default() });
handles(anchor(&s, id), Point::new(20.0, 40.0), q, AnchorKind::Smooth);
assert_other_geometry(&s, id, &before);
pointer(&mut s, PointerKind::Up, q, Mods { cmd: true, ..Mods::default() });
}
#[test]
fn direct_handle_cmd_mirror_holds_through_a_space_translation() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
press_handle(&mut s, Point::new(180.0, 100.0));
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, cmd());
handles(anchor(&s, id), Point::new(20.0, 40.0), q, AnchorKind::Smooth);
// Space moves the anchor and both handles; the opposite handle stays mirrored.
let moved = Point::new(200.0, 190.0);
pointer(&mut s, PointerKind::Drag, moved, Mods { space: true, ..cmd() });
let a = anchor(&s, id);
near(a.p, Point::new(120.0, 130.0));
handles(a, Point::new(40.0, 70.0), Point::new(200.0, 190.0), AnchorKind::Smooth);
// Releasing Space without moving keeps the translated, mirrored handles.
pointer(&mut s, PointerKind::Drag, moved, cmd());
handles(anchor(&s, id), Point::new(40.0, 70.0), Point::new(200.0, 190.0), AnchorKind::Smooth);
let next = Point::new(220.0, 190.0);
pointer(&mut s, PointerKind::Drag, next, cmd());
assert_mirrored(anchor(&s, id), next, AnchorKind::Smooth);
pointer(&mut s, PointerKind::Up, next, cmd());
}
#[test]
fn direct_handle_modifiers_changed_during_a_space_translation_apply_at_once() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
press_handle(&mut s, Point::new(180.0, 100.0));
pointer(&mut s, PointerKind::Drag, Point::new(180.0, 160.0), cmd());
let moved = Point::new(200.0, 190.0);
pointer(&mut s, PointerKind::Drag, moved, Mods { space: true, ..cmd() });
handles(anchor(&s, id), Point::new(40.0, 70.0), moved, AnchorKind::Smooth);
// Releasing Cmd while Space is held gives the opposite handle its own length again.
pointer(&mut s, PointerKind::Drag, moved, Mods { space: true, ..Mods::default() });
let a = anchor(&s, id);
near(a.p, Point::new(120.0, 130.0));
handles(a, Point::new(80.0, 100.0), moved, AnchorKind::Smooth);
// Alt while Space is held leaves the opposite handle where the translation put it.
pointer(&mut s, PointerKind::Drag, moved, Mods { space: true, alt: true, ..cmd() });
handles(anchor(&s, id), Point::new(70.0, 130.0), moved, AnchorKind::Corner);
pointer(&mut s, PointerKind::Up, moved, Mods { alt: true, ..cmd() });
}
#[derive(Debug, PartialEq)]
struct Snapshot {
document: Value,
selection: Value,
undo: usize,
redo: usize,
}
fn snapshot(s: &Session) -> Snapshot {
let st = s.doc().unwrap();
Snapshot { document: json!(st.doc), selection: json!(st.selection), undo: st.history.undo.len(), redo: st.history.redo.len() }
}
fn assert_content(s: &Session, expected: &Snapshot) {
let got = snapshot(s);
assert_eq!(got.document, expected.document);
assert_eq!(got.selection, expected.selection);
}
fn cmd() -> Mods {
Mods { cmd: true, ..Mods::default() }
}
fn reflected(a: Point, q: Point) -> Point {
a - (q - a)
}
fn constrained(a: Point, q: Point) -> Point {
a + vectorcraft_geom::constrain_angle_from(q - a, 45.0, 0.0)
}
fn assert_mirrored(a: Anchor, q: Point, kind: AnchorKind) {
handles(a, reflected(a.p, q), q, kind);
}
#[test]
fn direct_handle_stationary_cmd_release_repress_commit_and_next_gesture() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let before = snapshot(&s);
press_handle(&mut s, Point::new(180.0, 100.0));
let q = Point::new(180.0, 160.0);
for (mods, opposite) in [(cmd(), Point::new(20.0, 40.0)), (Mods::default(), Point::new(60.0, 70.0)), (cmd(), Point::new(20.0, 40.0))] {
pointer(&mut s, PointerKind::Drag, q, mods);
handles(anchor(&s, id), opposite, q, AnchorKind::Smooth);
assert_eq!(s.doc().unwrap().history.undo.len(), before.undo, "previews are not separate edits");
}
pointer(&mut s, PointerKind::Up, q, cmd());
let committed = snapshot(&s);
assert_eq!(committed.undo, before.undo + 1);
assert_eq!(committed.selection, before.selection);
run(&mut s, "edit.undo", json!({}));
assert_content(&s, &before);
run(&mut s, "edit.redo", json!({}));
assert_content(&s, &committed);
// Cmd did not install a persistent coupling mode: a later ordinary Smooth drag keeps
// the opposite handle's committed length, rather than matching the newly dragged length.
press_handle(&mut s, q);
let next = Point::new(180.0, 200.0);
pointer(&mut s, PointerKind::Drag, next, Mods::default());
let a = anchor(&s, id);
near(a.h_out, next);
assert_eq!(a.kind, AnchorKind::Smooth);
assert!((a.h_in.distance(a.p) - 100.0).abs() < 1e-6);
assert!((a.h_in.distance(a.p) - a.h_out.distance(a.p)).abs() > 20.0);
assert!(((a.h_in - a.p).cross(a.h_out - a.p)).abs() < 1e-6);
pointer(&mut s, PointerKind::Up, next, Mods::default());
assert_eq!(s.doc().unwrap().history.undo.len(), before.undo + 2);
}
#[test]
fn direct_handle_shift_constrains_before_mirroring_and_alt_takes_priority() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let p = anchor(&s, id).p;
press_handle(&mut s, Point::new(180.0, 100.0));
let raw = Point::new(180.0, 150.0);
let q = constrained(p, raw);
let shifted = Mods { shift: true, ..cmd() };
pointer(&mut s, PointerKind::Drag, raw, shifted);
assert_mirrored(anchor(&s, id), q, AnchorKind::Smooth);
pointer(&mut s, PointerKind::Drag, raw, Mods { alt: true, ..shifted });
handles(anchor(&s, id), Point::new(50.0, 100.0), q, AnchorKind::Corner);
// Removing Alt rebuilds from the original Smooth anchor, not the Corner preview.
pointer(&mut s, PointerKind::Drag, raw, shifted);
assert_mirrored(anchor(&s, id), q, AnchorKind::Smooth);
pointer(&mut s, PointerKind::Drag, raw, Mods { alt: true, ..cmd() });
handles(anchor(&s, id), Point::new(50.0, 100.0), raw, AnchorKind::Corner);
pointer(&mut s, PointerKind::Up, raw, Mods { alt: true, ..cmd() });
}
#[test]
fn direct_handle_corner_with_collapsed_partner_is_reversible_without_changing_kind() {
let mut s = session();
let id = curve(&mut s, Point::new(100.0, 100.0));
let before = snapshot(&s);
assert_eq!(anchor(&s, id).kind, AnchorKind::Corner);
press_handle(&mut s, Point::new(180.0, 100.0));
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, cmd());
assert_mirrored(anchor(&s, id), q, AnchorKind::Corner);
pointer(&mut s, PointerKind::Drag, q, Mods::default());
handles(anchor(&s, id), Point::new(100.0, 100.0), q, AnchorKind::Corner);
pointer(&mut s, PointerKind::Drag, q, cmd());
assert_mirrored(anchor(&s, id), q, AnchorKind::Corner);
s.tool_key(vectorcraft_tools::ToolKey::Escape, Mods::default(), view()).unwrap();
assert_eq!(snapshot(&s), before);
}
#[test]
fn direct_handle_stationary_drag_still_mirrors_unequal_partner_but_equal_is_noop() {
for (incoming, changes) in [(Point::new(50.0, 100.0), true), (Point::new(20.0, 100.0), false)] {
let mut s = session();
let id = curve(&mut s, incoming);
let before = snapshot(&s);
let q = Point::new(180.0, 100.0);
press_handle(&mut s, q);
pointer(&mut s, PointerKind::Drag, q, cmd());
assert_mirrored(anchor(&s, id), q, AnchorKind::Smooth);
pointer(&mut s, PointerKind::Up, q, cmd());
if changes {
assert_eq!(s.doc().unwrap().history.undo.len(), before.undo + 1);
run(&mut s, "edit.undo", json!({}));
assert_content(&s, &before);
} else {
assert_eq!(snapshot(&s), before, "an already reflected pair records no edit");
}
}
}
#[test]
fn direct_handle_escape_restores_document_selection_and_existing_redo() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
run(&mut s, "shape.rectangle", json!({"x": 500, "y": 400, "width": 25, "height": 30}));
let redo_document = snapshot(&s).document;
run(&mut s, "edit.undo", json!({}));
run(&mut s, "select.set", json!({"ids": [id.0]}));
let before = snapshot(&s);
assert_eq!(before.redo, 1, "a real existing Redo is the cancellation control");
press_handle(&mut s, Point::new(180.0, 100.0));
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, cmd());
assert_mirrored(anchor(&s, id), q, AnchorKind::Smooth);
s.tool_key(vectorcraft_tools::ToolKey::Escape, Mods::default(), view()).unwrap();
assert!(!s.in_interaction());
assert_eq!(snapshot(&s), before);
pointer(&mut s, PointerKind::Up, q, Mods::default());
assert_eq!(snapshot(&s), before, "a later release does not commit the canceled preview");
run(&mut s, "edit.redo", json!({}));
assert_eq!(snapshot(&s).document, redo_document, "the prior Redo still restores its actual content");
}
#[test]
fn direct_handle_cmd_before_press_still_lends_selection_and_returns_direct() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let before = snapshot(&s);
let a = anchor(&s, id);
pointer(&mut s, PointerKind::Down, a.p, cmd());
assert_eq!(s.tool_id(), "selection", "Cmd before Down keeps the existing Selection loan");
pointer(&mut s, PointerKind::Up, a.p, cmd());
assert_eq!(s.tool_id(), "directSelection");
assert_eq!(anchor(&s, id), a);
assert_eq!(snapshot(&s).document, before.document);
assert_eq!(s.doc().unwrap().history.undo.len(), before.undo);
}
#[test]
fn direct_handle_cmd_that_lends_direct_selection_from_the_pen_does_not_mirror() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
s.select_tool("pen", view()).unwrap();
let before = node(&s, id);
let undo = s.doc().unwrap().history.undo.len();
pointer(&mut s, PointerKind::Down, Point::new(180.0, 100.0), cmd());
assert_eq!(s.tool_id(), "directSelection", "Cmd lends the Pen the last selection tool");
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, cmd());
handles(anchor(&s, id), Point::new(60.0, 70.0), q, AnchorKind::Smooth);
// Cmd let go and pressed again during the drag mirrors, as it does in Direct Selection itself.
pointer(&mut s, PointerKind::Drag, q, Mods::default());
handles(anchor(&s, id), Point::new(60.0, 70.0), q, AnchorKind::Smooth);
pointer(&mut s, PointerKind::Drag, q, cmd());
handles(anchor(&s, id), Point::new(20.0, 40.0), q, AnchorKind::Smooth);
assert_other_geometry(&s, id, &before);
pointer(&mut s, PointerKind::Up, q, cmd());
assert_eq!(s.tool_id(), "pen");
assert_eq!(s.doc().unwrap().history.undo.len(), undo + 1);
}
#[test]
fn direct_handle_cmd_held_through_a_pen_lent_drag_leaves_the_opposite_length() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
s.select_tool("pen", view()).unwrap();
pointer(&mut s, PointerKind::Down, Point::new(180.0, 100.0), cmd());
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, cmd());
pointer(&mut s, PointerKind::Up, q, cmd());
assert_eq!(s.tool_id(), "pen");
handles(anchor(&s, id), Point::new(60.0, 70.0), q, AnchorKind::Smooth);
}
fn text_anchor(s: &Session, id: NodeId) -> Anchor {
let n = node(s, id);
let vectorcraft_doc::NodeKind::Text(t) = n.kind else { panic!("text on a path") };
t.type_path().unwrap().subpaths[0].anchors[1]
}
fn text_properties(s: &Session, id: NodeId) -> Value {
let n = node(s, id);
let vectorcraft_doc::NodeKind::Text(t) = n.kind else { panic!("text on a path") };
let vectorcraft_doc::TextKind::OnPath { start, end, .. } = &t.kind else { panic!("path text") };
json!({"runs": t.runs, "para": t.para, "paras": t.paras, "xf": t.xf, "start": start, "end": end,
"effect": t.path_effect, "align": t.path_align, "spacing": t.path_spacing, "appearance": n.appearance})
}
fn path_text(s: &mut Session) -> NodeId {
let path = curve(s, Point::new(50.0, 100.0));
let made = run(
s,
"text.createInPath",
json!({"path": path.0, "mode": "onPath", "text": "Along the original curve", "font": "Source Sans 3", "size": 12}),
);
let id = NodeId(made["id"].as_u64().unwrap());
run(s, "type.pathOptions", json!({"id": id.0, "start": 0.15, "end": 0.85}));
run(s, "object.transform", json!({"ids": [id.0], "matrix": [1.5, 0.4, 0.25, 0.9, 250, 80]}));
s.select_tool("directSelection", view()).unwrap();
id
}
#[test]
fn direct_handle_affine_path_text_mirrors_in_drawn_space_and_keeps_brackets() {
let mut s = session();
let id = path_text(&mut s);
let before = snapshot(&s);
let properties = text_properties(&s, id);
assert_eq!(properties["start"], json!(0.15));
assert_eq!(properties["end"], json!(0.85));
let a = text_anchor(&s, id);
assert_eq!(a.kind, AnchorKind::Smooth);
near(a.p, Point::new(425.0, 210.0));
near(a.h_out, Point::new(545.0, 242.0));
assert!((a.h_in.distance(a.p) - a.h_out.distance(a.p)).abs() > 40.0);
press_handle(&mut s, a.h_out);
let raw = a.p + vectorcraft_geom::Vec2::new(80.0, 60.0);
pointer(&mut s, PointerKind::Drag, raw, cmd());
assert_mirrored(text_anchor(&s, id), raw, AnchorKind::Smooth);
assert_eq!(text_properties(&s, id), properties);
let shifted = Mods { shift: true, ..cmd() };
pointer(&mut s, PointerKind::Drag, raw, shifted);
assert_mirrored(text_anchor(&s, id), constrained(a.p, raw), AnchorKind::Smooth);
assert_eq!(text_properties(&s, id), properties);
pointer(&mut s, PointerKind::Up, raw, shifted);
let after = snapshot(&s);
assert_eq!(after.undo, before.undo + 1);
run(&mut s, "edit.undo", json!({}));
assert_content(&s, &before);
run(&mut s, "edit.redo", json!({}));
assert_content(&s, &after);
}
fn blend_state(s: &Session, id: NodeId) -> (Anchor, Value, Vec<u32>) {
let n = node(s, id);
let vectorcraft_doc::NodeKind::Blend { children, spec } = n.kind else { panic!("blend") };
assert!(spec.spine.is_some(), "the fixture uses an already pinned spine");
let path = vectorcraft_doc::live::blend_spine(&children, &spec).unwrap().0;
(path.subpaths[0].anchors[1], json!(children), spec.key_anchors.clone())
}
fn blend(s: &mut Session) -> NodeId {
let a = run(s, "shape.rectangle", json!({"x": 15, "y": 95, "width": 10, "height": 10}))["id"].as_u64().unwrap();
let b = run(s, "shape.rectangle", json!({"x": 295, "y": 95, "width": 10, "height": 10}))["id"].as_u64().unwrap();
let made = run(s, "object.blend.make", json!({"ids": [a, b], "steps": 2}));
let id = NodeId(made["id"].as_u64().unwrap());
let added = run(s, "object.blend.spine.addAnchor", json!({"id": id.0, "x": 100, "y": 100}));
assert_eq!(added["anchor"], json!(1));
run(s, "object.blend.spine.convertAnchor", json!({"id": id.0, "anchor": 1, "to": "smooth", "x": 180, "y": 100}));
run(s, "object.blend.spine.moveAnchor", json!({"id": id.0, "anchor": 1, "handle": "in", "x": 50, "y": 100}));
run(s, "select.set", json!({"ids": [id.0]}));
s.select_tool("directSelection", view()).unwrap();
let (middle, _, keys) = blend_state(s, id);
near(middle.p, Point::new(100.0, 100.0));
handles(middle, Point::new(50.0, 100.0), Point::new(180.0, 100.0), AnchorKind::Smooth);
assert_eq!(keys, [0, 2]);
// An actual spine-point click makes its handles visible to Direct Selection.
pointer(s, PointerKind::Down, middle.p, Mods::default());
pointer(s, PointerKind::Up, middle.p, Mods::default());
assert!(!s.in_interaction());
id
}
#[test]
fn direct_handle_pinned_blend_spine_cmd_shift_preserves_keys_and_mapping() {
let mut s = session();
let id = blend(&mut s);
let before = snapshot(&s);
let (a, keys, mapping) = blend_state(&s, id);
press_handle(&mut s, a.h_out);
let q = Point::new(180.0, 160.0);
pointer(&mut s, PointerKind::Drag, q, cmd());
assert_mirrored(blend_state(&s, id).0, q, AnchorKind::Smooth);
let raw = Point::new(180.0, 150.0);
let shifted = Mods { shift: true, ..cmd() };
pointer(&mut s, PointerKind::Drag, raw, shifted);
assert_mirrored(blend_state(&s, id).0, constrained(a.p, raw), AnchorKind::Smooth);
// The existing spine Shift-only path is deliberately unconstrained; Cmd's new rule
// must not leak into that old branch after the modifier is released.
pointer(&mut s, PointerKind::Drag, raw, Mods { shift: true, ..Mods::default() });
near(blend_state(&s, id).0.h_out, raw);
pointer(&mut s, PointerKind::Drag, raw, shifted);
let (after_anchor, after_keys, after_mapping) = blend_state(&s, id);
assert_mirrored(after_anchor, constrained(a.p, raw), AnchorKind::Smooth);
assert_eq!(after_keys, keys, "handle edits leave the actual key art unchanged");
assert_eq!(after_mapping, mapping);
pointer(&mut s, PointerKind::Up, raw, shifted);
let after = snapshot(&s);
assert_eq!(after.undo, before.undo + 1);
assert_eq!(after.selection, before.selection);
run(&mut s, "edit.undo", json!({}));
assert_content(&s, &before);
run(&mut s, "edit.redo", json!({}));
assert_content(&s, &after);
}
#[test]
fn direct_handle_incoming_drag_mirrors_outgoing_and_release_restores_ordinary_length() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let before = snapshot(&s);
let original = node(&s, id);
press_handle(&mut s, Point::new(50.0, 100.0));
let q = Point::new(40.0, 20.0);
pointer(&mut s, PointerKind::Drag, q, Mods::default());
handles(anchor(&s, id), q, Point::new(148.0, 164.0), AnchorKind::Smooth);
pointer(&mut s, PointerKind::Drag, q, cmd());
handles(anchor(&s, id), q, Point::new(160.0, 180.0), AnchorKind::Smooth);
pointer(&mut s, PointerKind::Drag, q, Mods::default());
handles(anchor(&s, id), q, Point::new(148.0, 164.0), AnchorKind::Smooth);
pointer(&mut s, PointerKind::Drag, q, cmd());
assert_other_geometry(&s, id, &original);
pointer(&mut s, PointerKind::Up, q, cmd());
handles(anchor(&s, id), q, Point::new(160.0, 180.0), AnchorKind::Smooth);
assert_eq!(s.doc().unwrap().history.undo.len(), before.undo + 1);
assert_eq!(snapshot(&s).selection, before.selection);
run(&mut s, "edit.undo", json!({}));
assert_content(&s, &before);
}
/// `command` with `params` is refused with an error containing `message`, and the document,
/// selection and undo history stay as they were.
fn refused(s: &mut Session, command: &str, params: Value, message: &str) {
let before = snapshot(s);
let err = s.execute(command, &params).unwrap_err().to_string();
assert!(err.contains(message), "{command} {params}: {err}");
assert_eq!(snapshot(s), before);
}
#[test]
fn path_set_handle_symmetric_mirrors_refuses_bad_values_and_records_no_step_when_in_place() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let at = |x: f64, y: f64| json!({"id": id.0, "anchor": 1, "which": "out", "x": x, "y": y});
for bad in [json!("yes"), json!(1)] {
let mut p = at(180.0, 160.0);
p["symmetric"] = bad;
refused(&mut s, "path.setHandle", p, "`symmetric` must be true or false");
}
let mut both = at(180.0, 160.0);
both["symmetric"] = json!(true);
both["independent"] = json!(true);
refused(&mut s, "path.setHandle", both, "`independent` and `symmetric` cannot both be true");
let undo = s.doc().unwrap().history.undo.len();
let mut mirror = at(180.0, 160.0);
mirror["symmetric"] = json!(true);
run(&mut s, "path.setHandle", mirror.clone());
handles(anchor(&s, id), Point::new(20.0, 40.0), Point::new(180.0, 160.0), AnchorKind::Smooth);
assert_eq!(s.doc().unwrap().history.undo.len(), undo + 1);
let placed = snapshot(&s);
run(&mut s, "path.setHandle", mirror);
assert_eq!(snapshot(&s), placed, "both handles already in place record no undo step");
}
#[test]
fn symmetric_leaves_the_other_handle_retracted_at_an_open_end() {
let mut s = session();
let id = curve(&mut s, Point::new(50.0, 100.0));
let first = |s: &Session| node(s, id).path_data().unwrap().subpaths[0].anchors[0];
let p = first(&s).p;
run(&mut s, "path.setHandle", json!({"id": id.0, "anchor": 0, "which": "out", "x": 60, "y": 180, "symmetric": true}));
handles(first(&s), p, Point::new(60.0, 180.0), AnchorKind::Corner);
let mut s = session();
let blend_id = blend(&mut s);
let end = |s: &Session| {
let n = node(s, blend_id);
let vectorcraft_doc::NodeKind::Blend { children, spec } = n.kind else { panic!("blend") };
vectorcraft_doc::live::blend_spine(&children, &spec).unwrap().0.subpaths[0].anchors[0]
};
let start = end(&s);
run(&mut s, "object.blend.spine.moveAnchor", json!({"id": blend_id.0, "anchor": 0, "handle": "out", "x": 60, "y": 60, "symmetric": true}));
near(end(&s).h_out, Point::new(60.0, 60.0));
near(end(&s).h_in, start.h_in);
near(end(&s).h_in, start.p);
}
#[test]
fn spine_and_type_path_handles_refuse_bad_symmetric_values() {
let mut s = session();
let id = blend(&mut s);
let spine = |extra: Value| {
let mut p = json!({"id": id.0, "anchor": 1, "handle": "out", "x": 180, "y": 160});
p.as_object_mut().unwrap().extend(extra.as_object().unwrap().clone());
p
};
refused(&mut s, "object.blend.spine.moveAnchor", spine(json!({"symmetric": "yes"})), "`symmetric` must be true or false");
refused(
&mut s,
"object.blend.spine.moveAnchor",
spine(json!({"symmetric": true, "independent": true})),
"`independent` and `symmetric` cannot both be true",
);
refused(
&mut s,
"object.blend.spine.moveAnchor",
json!({"id": id.0, "anchor": 1, "x": 180, "y": 160, "symmetric": true}),
"`symmetric` places a handle",
);
let text = path_text(&mut s);
let a = text_anchor(&s, text);
let at = json!({"id": text.0, "anchor": 1, "which": "out", "x": a.h_out.x, "y": a.h_out.y + 20.0});
let mut bad = at.clone();
bad["symmetric"] = json!(0);
refused(&mut s, "text.setPathHandle", bad, "`symmetric` must be true or false");
let mut both = at;
both["symmetric"] = json!(true);
both["independent"] = json!(true);
refused(&mut s, "text.setPathHandle", both, "`independent` and `symmetric` cannot both be true");
}
#[test]
fn direct_handle_cmd_that_lends_direct_selection_from_the_pen_does_not_mirror_type_on_a_path() {
let mut s = session();
let id = path_text(&mut s);
let a = text_anchor(&s, id);
let length = a.h_in.distance(a.p);
s.select_tool("pen", view()).unwrap();
pointer(&mut s, PointerKind::Down, a.h_out, cmd());
assert_eq!(s.tool_id(), "directSelection");
let q = a.p + vectorcraft_geom::Vec2::new(80.0, 60.0);
pointer(&mut s, PointerKind::Drag, q, cmd());
let held = text_anchor(&s, id);
near(held.h_out, q);
assert!((held.h_in.distance(held.p) - length).abs() < 1e-6, "the other handle keeps its length");
pointer(&mut s, PointerKind::Drag, q, Mods::default());
pointer(&mut s, PointerKind::Drag, q, cmd());
assert_mirrored(text_anchor(&s, id), q, AnchorKind::Smooth);
pointer(&mut s, PointerKind::Up, q, cmd());
assert_eq!(s.tool_id(), "pen");
}
+48
View File
@@ -8465,3 +8465,51 @@ proptest! {
prop_assert_eq!(paths, 2, "{:?}", notes);
}
}
proptest! {
#![proptest_config(config())]
/// A stroke's arrowheads (#8188): its arrowhead entries with any scale of any kind, naming a
/// symbol the file defines, one it doesn't or one named in Chinese, the symbol's art any run of
/// paths (frames, samples of the line, heads, open and closed, filled, stroked or neither), at
/// any weight, the style section cut anywhere, the line drawn as any look. Read as a `.ai` and
/// as an EPS, then rendered.
#[test]
fn ai_arrowhead_strokes_never_panic(
scale in prop_oneof![arb_num(), Just("50".to_string())],
kind in prop::sample::select(vec!["Real", "Int", "Bool"]),
named in prop::sample::select(vec!["W", "Missing", "\u{6954}"]),
both in any::<bool>(),
art in prop::collection::vec(prop::sample::select(vec![
"-10 5 m\n10 5 L\n10 -5 L\n-10 -5 L\nn\n",
"0 G\n1 w\n-9 0 m\n4 0 l\nS\n",
"0 G\n0.5 w\n-9 0 m\n4 0 l\nS\n",
"0 g\n2 3 m\n8 0 l\n2 -3 l\nf\n",
"0 G\n1 w\n2 3 m\n8 0 l\n2 -3 l\nS\n",
"0 g\n1e300 0 m\n-1e300 1 l\nf\n",
"0 g\n0 0 m\n0 0 l\nf\n",
]), 0..6),
width in arb_num(),
cut in 0usize..2000,
look in prop::sample::select(vec!["0 G\n2 w\n0 50 m\n96 50 l\nS\n0 g\n94 53 m\n100 50 l\n94 47 l\nf\n", "0 G\n2 w\n0 50 m\n100 50 l\nS\n", ""]),
) {
use vectorcraft_testkit::ai;
let symbol = format!("%AI5_Begin_NonPrinting\n%AI14_BeginSymbol\n(W)\n0 A\n0 Xw\n0 Ae\nu\n{}U\n%AI10_EndSymbol\n%AI5_End_NonPrinting--\n", art.concat());
let start = if both { format!("{scale} /{kind} (BSArrowBeginScale) ,\n/GObjRef : ({named}) /SymbolArt ; (BSArrowBeginSymbol) ,\n") } else { String::new() };
let styles = format!(
"%AI9_BeginArtStyles\n/KnownStyle :\n(Arrowed) /Name ,\n/ActiveStyle :\n/CompoundFilter :\n(Chain Style Filter) 0 0 /Filter ,\n1 /Visible ,\n\
/CompoundFilter :\n(Stack Style Filter) 0 0 /Filter ,\n1 /Visible ,\n\
/BasicFilter :\n(Stroke Style Filter) 0 0 /Filter ,\n1 /Visible ,\n/Dictionary : /NotRecorded ,\n/Dictionary : /NotRecorded ,\n\
{start}{scale} /{kind} (BSArrowEndScale) ,\n/GObjRef : ({named}) /SymbolArt ; (BSArrowEndSymbol) ,\n; (kAIBeautifulStrokesParamsDictKey) ,\n\
/StrokeStyle : 0 R\n0 0 0 1 0 0 0 XA\n0 J 0 j {width} w 10 M []0 d\n0 XR\n1 0 Xd\n/Def ;\n (StrokeStyle) ,\n; /Dict ;\n /Part ,\n\
/BasicFilter :\n(Conduit Filter) 0 0 /Filter ,\n1 /Visible ,\n;\n /Part ,\n;\n /Part ,\n;\n%AI9_EndArtStyles\n\
%AI9_BeginArtStyleList\n(Arrowed)\n%AI9_EndArtStyleList\n"
);
let styles: String = styles.chars().take(cut).collect();
let line = format!("0 Ae\nu\n{look}U\n%_0 50 m\n%_100 50 L\n%_N\n1 (Arrowed) XW\n");
let data = ai::editing_data(200.0, 100.0, &format!("{symbol}{styles}{}", ai::layer("L", &line)));
survive("arrowhead strokes", || Some(vectorcraft_eps::layered_ai(data.as_bytes(), Document::new(200.0, 100.0), vec![], false, false, 1.0).0))?;
let eps = ai::eps(data.as_bytes(), ai::page_ps());
survive("arrowhead strokes in an EPS", || vectorcraft_engine::cmd::fileio::load("x.eps", &eps).ok().map(|l| l.doc))?;
}
}
+62
View File
@@ -118,6 +118,68 @@ fn each_arrow_style_draws_its_stroke_arrowhead_at_both_ends() {
}
}
/// `arrowHead` draws any built-in stroke arrowhead at both ends of the dimension line, and the
/// native file keeps it. The saved `arrowStyle` stays one of the four values versions without
/// `arrowHead` read, and a dimension saved without `arrowHead` draws its arrow style. Options
/// without a stroke head are saved without `arrowHead`. A custom arrowhead, an unknown name and an
/// overlong name are refused.
#[test]
fn every_stroke_arrowhead_draws_as_a_dimension_arrowhead() {
use vectorcraft_doc::{Arrowhead, dimension::ArrowStyle};
let ends = |s: &Session, id: u64| -> Vec<_> {
let n = s.doc().unwrap().doc.node(NodeId(id)).unwrap();
let children = n.children().unwrap();
let strokes = children.iter().filter_map(|n| n.appearance.stroke().map(|s| (s.start_arrow.clone(), s.end_arrow.clone())));
strokes.filter(|(a, b)| a.is_some() || b.is_some()).collect()
};
let mut s = session();
let mut made = vec![];
for head in Arrowhead::ALL {
let name = serde_json::to_value(&head).unwrap();
let id = run(&mut s, "dimension.create", json!({"a":[0,0],"b":[72,0],"options":{"arrowHead":name}}))["id"].as_u64().unwrap();
let drawn = ends(&s, id);
assert!(!drawn.is_empty() && drawn.iter().all(|h| *h == (Some(head.clone()), Some(head.clone()))), "{name}: {drawn:?}");
let saved = serde_json::to_value(&recipe(&s, id).options).unwrap();
assert_eq!((&saved["arrowStyle"], &saved["arrowHead"]), (&json!("filled"), &name));
made.push((id, head));
}
let bytes = vectorcraft_format::save(&s.doc().unwrap().doc, false);
let mut reopened = Session::new();
reopened.add_document(vectorcraft_format::load(&bytes).unwrap(), None);
for (id, head) in made {
assert_eq!(recipe(&reopened, id).options.arrowhead(), Some(head));
}
// A dimension saved before `arrowHead` existed.
let id = run(&mut s, "dimension.create", json!({"a":[0,0],"b":[72,0],"options":{"arrowStyle":"open"}}))["id"].as_u64().unwrap();
let mut file: Value = serde_json::from_slice(&vectorcraft_format::save(&s.doc().unwrap().doc, false)).unwrap();
fn drop_head(v: &mut Value) {
match v {
Value::Object(m) => {
m.remove("arrowHead");
m.values_mut().for_each(drop_head);
}
Value::Array(a) => a.iter_mut().for_each(drop_head),
_ => {}
}
}
drop_head(&mut file);
let mut older = Session::new();
older.add_document(vectorcraft_format::load(&serde_json::to_vec(&file).unwrap()).unwrap(), None);
let o = recipe(&older, id).options;
assert_eq!((o.arrow_style, o.arrow_head.clone(), o.arrowhead()), (ArrowStyle::Open, None, Some(Arrowhead::TriangleOpen)));
// Without a stroke head, the saved and recorded options carry no `arrowHead`, and a null one
// is still taken.
let saved = serde_json::to_value(&recipe(&s, id).options).unwrap();
assert!(saved.get("arrowHead").is_none(), "{saved}");
assert!(s.execute("dimension.create", &json!({"a":[0,0],"b":[72,0],"options":{"arrowHead":null}})).is_ok());
let custom = json!({"Custom":{"name":"Dot","path":{"subpaths":[]}}});
for bad in [json!("Custom"), json!("Arrowhead"), json!("barbed"), json!(3), json!("Barbed".repeat(20)), custom] {
let p = json!({"a":[0,0],"b":[72,0],"options":{"arrowHead":bad}});
assert!(s.execute("dimension.create", &p).is_err(), "{bad}");
}
assert!(s.execute("dimension.create", &json!({"a":[0,0],"b":[72,0],"options":{"arrowStyle":"Barbed"}})).is_err());
}
#[test]
fn dimension_angles_circles_arcs_and_curves() {
let mut s = session();
+8 -2
View File
@@ -118,7 +118,12 @@
//! `%AI24_EndSymbolList`); each instance as `/SymbolInstance :`, `(name) /SymbolRef ,`, the
//! matrix taking the art to art space as `a b c d tx ty /RTransformMatrix`, `;`, then its name
//! and opacity mask and a state block as a group's with its opacity and blending mode (an
//! instance with isolation, knockout or knockout shape of its own is written as its art). The
//! instance with isolation, knockout or knockout shape of its own is written as its art). A
//! dynamic symbol's art dictionary also holds `VectorCraftDynamicSymbol` (`/Int`, 1), and the
//! dictionary of an instance with changes of its own (`symbol_overrides`) holds
//! `VectorCraftSymbolOverrides`, a `/String` of the changes as hex-coded JSON: the format's own
//! entries, as other apps' editing data is not documented, read back by this reader and left out by
//! others. The
//! definitions are at most the reader's 4,096. In a symbol's art, an instance's matrix and
//! a gradient's take the art to the canvas's space turned y up about art space's origin there,
//! and a gradient mesh's corners are in that space; an envelope's contents in its dictionary are
@@ -191,7 +196,7 @@
//! and instances of
//! symbols past 4,096 as their art (symbol art past [`vectorcraft_doc::MAX_SYMBOL_NODES`] objects
//! in all left out), instances of symbols the document doesn't have as empty groups, symbols' 9-slice
//! guides, export types and dynamic type left out, gradient meshes the reader wouldn't read back as
//! guides, export types left out, gradient meshes the reader wouldn't read back as
//! they are, folded meshes, meshes in pattern tiles and in art cut to a clipping object and every mesh
//! on a large canvas as their drawn look, blends the reader wouldn't read back live as
//! their steps, other live objects (placed documents included) as their art,
@@ -220,6 +225,7 @@ use vectorcraft_pdf::PrivateData;
use crate::ps;
mod writer;
pub(crate) use writer::{DYNAMIC_KEY, OVERRIDES_KEY, hex_decode};
use writer::Writer;
+56 -2
View File
@@ -6394,7 +6394,8 @@ fn instances_the_data_cant_hold_are_written_as_their_art() {
let layer = doc.layers[0].id;
doc.insert(Some(layer), usize::MAX, changed).unwrap();
doc.insert(Some(layer), usize::MAX, plain).unwrap();
assert_eq!(export_ai_editing(&doc, &opts()).unwrap().warnings, [writer::SYMBOL_ART, writer::SYMBOL_OPTIONS]);
doc.symbols[0].dynamic = false;
assert_eq!(export_ai_editing(&doc, &opts()).unwrap().warnings, [writer::SYMBOL_ART]);
let back = read_back(&doc);
assert_eq!(kinds(&back), ["art", "instance"]);
let green = back.layers[0].children().unwrap()[0].clone();
@@ -6890,7 +6891,7 @@ fn symbol_options_and_linked_images_in_symbols_are_reported() {
let layer = doc.layers[0].id;
doc.insert(Some(layer), usize::MAX, one).unwrap();
let out = export_ai_editing(&doc, &opts()).unwrap();
assert_eq!(out.warnings, [writer::SYMBOL_OPTIONS, writer::LINKS_EMBEDDED]);
assert_eq!(out.warnings, [writer::LINKS_EMBEDDED]);
let p = program_shown(&doc);
assert!(p.contains("%AI5_BeginRaster") && !p.contains("%AI5_BeginPlace"), "{p}");
let back = read_back(&doc);
@@ -15982,3 +15983,56 @@ fn a_mesh_eight_levels_down_is_written_as_a_mesh() {
assert_eq!(back.len(), 1, "{back:#?}");
assert_mesh_exact(mesh_of(&back[0]), &want, "eight levels down");
}
fn dynamic_doc() -> Document {
let mut doc = Document::new(200.0, 100.0);
let art = square(&mut doc, Rect::new(0.0, 0.0, 10.0, 10.0), LEAF);
doc.symbols.push(Symbol { dynamic: true, name: "Leaf".into(), art: Arc::new(art) });
let layer = doc.layers[0].id;
for (x, c) in [(10.0, Color::rgb(1.0, 0.0, 0.0)), (50.0, Color::rgb(0.0, 0.0, 1.0))] {
let mut i = instance(&mut doc, "Leaf", Affine::translate((x, 10.0)));
i.extras_mut().symbol_overrides = vec![vectorcraft_doc::SymbolOverride { fill: Some(solid(c)), opacity: Some(0.5), ..Default::default() }];
doc.insert(Some(layer), usize::MAX, i).unwrap();
}
let plain = instance(&mut doc, "Leaf", Affine::translate((90.0, 10.0)));
doc.insert(Some(layer), usize::MAX, plain).unwrap();
doc
}
#[test]
fn dynamic_symbols_and_their_instance_changes_survive_a_round_trip() {
let doc = dynamic_doc();
let out = export_ai_editing(&doc, &opts()).unwrap();
assert_eq!(out.warnings, [writer::SYMBOL_CHANGES]);
let back = read_back(&doc);
assert!(back.symbols[0].dynamic);
let kids = back.layers[0].children().unwrap();
assert!(kids.iter().all(|n| matches!(n.kind, NodeKind::SymbolInstance { .. })));
let want: Vec<_> = doc.layers[0].children().unwrap().iter().map(|n| n.extras().symbol_overrides.clone()).collect();
let got: Vec<_> = kids.iter().map(|n| n.extras().symbol_overrides.clone()).collect();
assert_eq!(got, want);
assert_ne!(got[0], got[1]);
assert!(got[2].is_empty());
}
#[test]
fn static_symbols_write_no_dynamic_entries() {
let mut doc = dynamic_doc();
doc.symbols[0].dynamic = false;
let layer = doc.layers[0].id;
for n in doc.layers[0].children().unwrap().to_vec() {
doc.remove(n.id).unwrap();
}
for x in [10.0, 50.0] {
let i = instance(&mut doc, "Leaf", Affine::translate((x, 10.0)));
doc.insert(Some(layer), usize::MAX, i).unwrap();
}
let p = program(&doc);
assert!(!p.contains("VectorCraftDynamicSymbol") && !p.contains("VectorCraftSymbolOverrides"));
assert!(export_ai_editing(&doc, &opts()).unwrap().warnings.is_empty());
let back = read_back(&doc);
assert!(!back.symbols[0].dynamic);
let kids = back.layers[0].children().unwrap();
assert_eq!(kids.len(), 2);
assert!(kids.iter().all(|n| matches!(n.kind, NodeKind::SymbolInstance { .. }) && n.extras().symbol_overrides.is_empty()));
}
+9 -2
View File
@@ -48,8 +48,9 @@ pub(super) use paints::{
GRADIENT_COMPARISONS, GRADIENT_DITHER, GRADIENT_HUE, GRADIENT_PERCEPTUAL, GRADIENT_SHAPES, GRADIENTS, SCANNED_DEFINITIONS, STOP_LINKS,
SWATCH_PLACEMENT, free_gradient_name,
};
pub(crate) use symbols::{DYNAMIC_KEY, OVERRIDES_KEY, hex_decode};
#[cfg(test)]
pub(super) use symbols::{MISSING_SYMBOL, SYMBOL_ART, SYMBOL_COUNT, SYMBOL_OPTIONS};
pub(super) use symbols::{MISSING_SYMBOL, SYMBOL_ART, SYMBOL_CHANGES, SYMBOL_COUNT, SYMBOL_OPTIONS};
#[cfg(test)]
pub(super) use texts::{FONT_RESOLVES, RESOLVE_EACH_RUN, TYPE_ATTRIBUTES};
#[cfg(test)]
@@ -286,6 +287,7 @@ pub(super) struct Writer<'a> {
symbol_scales: HashMap<String, f64>,
/// The entries a symbol's dictionary adds to its art's dictionary, and the art's id.
root_entries: Option<(vectorcraft_doc::NodeId, String)>,
instance_entries: Option<(vectorcraft_doc::NodeId, String)>,
/// The objects that may be written with an art style, as they were before baking, by id
/// ([`styles::styled_objects`]).
pub(super) styled: HashMap<NodeId, Arc<Node>>,
@@ -405,6 +407,7 @@ impl<'a> Writer<'a> {
inner_scale: 1.0,
symbol_scales: HashMap::new(),
root_entries: None,
instance_entries: None,
styled: HashMap::new(),
symbol_styled: HashMap::new(),
pattern_styled: HashMap::new(),
@@ -818,7 +821,7 @@ impl<'a> Writer<'a> {
mask_window = self.windowed.take();
}
}
NodeKind::SymbolInstance { symbol, xf } if self.live_instance_in_room(n, symbol, *xf) => self.symbol_instance(symbol, *xf, xy),
NodeKind::SymbolInstance { symbol, xf } if self.live_instance_in_room(n, symbol, *xf) => self.symbol_instance(n, symbol, *xf, xy),
NodeKind::SymbolInstance { symbol, xf } => {
if !self.open_group("u") {
return;
@@ -1016,6 +1019,10 @@ impl<'a> Writer<'a> {
Some((id, _)) if *id == n.id => self.root_entries.take().map(|(_, e)| e),
_ => None,
};
let entries = match &self.instance_entries {
Some((id, _)) if *id == n.id => entries.or_else(|| self.instance_entries.take().map(|(_, e)| e)),
_ => entries,
};
let role = match &self.blend_role {
Some((id, _)) if *id == n.id => self.blend_role.take().map(|(_, e)| e),
_ => None,
+38 -5
View File
@@ -14,7 +14,27 @@ use crate::ps;
pub(in crate::ai_editing) const SYMBOL_ART: &str = "symbol instances with a fill, appearance changes, isolation, knockout or knockout shape of their own, instances of symbols with 9-slice guides or pattern paint, instances in pattern tiles or in art cut to a clipping object, instances scaled almost flat, instances that turn, mirror or scale symbols holding type, live objects, instances written as their art, shapes with rounded live corners or strokes written as outlines or brush art, instances that scale their symbol more than 100 times, instances on the layers of a large canvas and instances of symbols past 4,096 are written as their art in the editing data for other apps";
pub(in crate::ai_editing) const SYMBOL_OPTIONS: &str =
"the 9-slice guides, export types and dynamic type of symbols are left out of the editing data for other apps";
"the 9-slice guides and export types of symbols are left out of the editing data for other apps";
pub(in crate::ai_editing) const SYMBOL_CHANGES: &str =
"the changes of dynamic symbol instances are kept in dictionary entries of their own, which other apps leave out";
pub(crate) const DYNAMIC_KEY: &str = "VectorCraftDynamicSymbol";
pub(crate) const OVERRIDES_KEY: &str = "VectorCraftSymbolOverrides";
const MAX_OVERRIDES_BYTES: usize = 1 << 20;
pub(crate) fn hex_decode(s: &str) -> Option<Vec<u8>> {
if !s.len().is_multiple_of(2) || s.len() / 2 > MAX_OVERRIDES_BYTES {
return None;
}
s.as_bytes().chunks(2).map(|c| u8::from_str_radix(std::str::from_utf8(c).ok()?, 16).ok()).collect()
}
fn hex_encode(b: &[u8]) -> String {
b.iter().fold(String::with_capacity(b.len() * 2), |mut s, v| {
let _ = write!(s, "{v:02x}");
s
})
}
pub(in crate::ai_editing) const MISSING_SYMBOL: &str =
"symbol instances of symbols the document doesn't have are written as empty groups in the editing data for other apps";
/// The most an instance may scale its symbol's art, nested instances' scales included: the art's
@@ -55,7 +75,8 @@ impl Writer<'_> {
/// that keeps the art's area as it is written and scales it as the definition allows
/// ([`Self::keeps_scale`]).
pub(super) fn live_instance(&mut self, n: &Node, symbol: &str, xf: Affine) -> bool {
let own = vectorcraft_brush::stain(n).is_some() || !n.extras().symbol_overrides.is_empty();
let dynamic = self.symbol_doc.symbols.iter().any(|s| s.name == symbol && s.dynamic);
let own = vectorcraft_brush::stain(n).is_some() || (!dynamic && !n.extras().symbol_overrides.is_empty());
let group_state = n.isolate || n.knockout != Knockout::Neutral || n.knockout_shape;
// The matrix as written (to ten decimals) must still keep the art's area.
let m = Affine::new((self.instance_space * xf).as_coeffs().map(|v| (v * 1e10).round() / 1e10));
@@ -153,7 +174,16 @@ impl Writer<'_> {
/// canvas's space turned y up about art space's origin there) as `a b c d tx ty
/// /RTransformMatrix` (to ten decimals), `;`, then its state block as a group's: `Xy`, `0 0 Xd`
/// and `6 () XW` when it has transparency, else `9 () XW`. Its dictionary goes between the two.
pub(super) fn symbol_instance(&mut self, symbol: &str, xf: Affine, xy: Xy) {
pub(super) fn symbol_instance(&mut self, n: &Node, symbol: &str, xf: Affine, xy: Xy) {
let o = &n.extras().symbol_overrides;
if !o.is_empty()
&& let Ok(json) = serde_json::to_vec(o)
&& json.len() <= MAX_OVERRIDES_BYTES
{
let e = format!("%_{} /String ({OVERRIDES_KEY}) ,\n", ps::bytes(hex_encode(&json).as_bytes()));
self.instance_entries = Some((n.id, e));
self.warn(SYMBOL_CHANGES);
}
let m = self.instance_space * xf;
let _ = write!(self.body, "/SymbolInstance :\n{} /SymbolRef ,\n", ps::bytes(symbol.as_bytes()));
for v in m.as_coeffs() {
@@ -201,7 +231,7 @@ impl Writer<'_> {
self.warn(SYMBOL_COUNT);
return false;
}
if sym.dynamic || doc.symbol_export_type(name) != SymbolExportType::default() || doc.symbol_nine_slice(name).is_some() {
if doc.symbol_export_type(name) != SymbolExportType::default() || doc.symbol_nine_slice(name).is_some() {
self.warn(SYMBOL_OPTIONS);
}
// The art's effects are its own, not those of a drawn look that first places it, and its
@@ -260,7 +290,10 @@ impl Writer<'_> {
(self.to_art, self.grad_space, self.canvas, self.instance_space) = (Affine::IDENTITY, about_origin, Affine::IDENTITY, about_origin);
self.block_end = usize::MAX;
let registration = u16::from(doc.symbol_registration(name).0.min(8)) + 1;
let entries = format!("%_{registration} /Int (AI13PatternRegistrationType) ,\n");
let mut entries = format!("%_{registration} /Int (AI13PatternRegistrationType) ,\n");
if sym.dynamic {
let _ = writeln!(entries, "%_1 /Int ({DYNAMIC_KEY}) ,");
}
// The canvas draws a symbol's art even when its root is hidden, so the root is written shown.
let shown;
let root: &Node = if sym.art.visible {
+1
View File
@@ -17,6 +17,7 @@
//! objects and points. Anything it doesn't read is an error: the caller opens the file the way it
//! did before (the printed page, or the PDF), with a warning saying why.
mod arrowhead;
mod blend;
mod brush;
mod envelope;
+244
View File
@@ -0,0 +1,244 @@
//! Arrowheads a file defines: the art of a symbol that a stroke's arrowhead entry names
//! ([`super::style::StrokeArrows`]), read into a head ([`head`]).
//!
//! Not publicly documented. As the files have it, an arrowhead symbol's art (y down here, as the
//! document's symbols are) points right along a straight, level sample of the line it ends: an
//! open stroked path with no fill whose anchors and handles all lie on that line, 1 pt wide. The
//! sample ends where the line stops under the head. The rest of the art that paints is the head;
//! its tip is its rightmost point, and a symbol unit is one point on a 1 pt stroke at 100 %, so a
//! unit is the head's weight as it is for VectorCraft's own heads. Art that paints nothing (the
//! frame of the symbol's box, hidden or fully transparent art) is left out.
use vectorcraft_doc::{AppearanceItem, CustomArrowhead, Node, NodeKind, StrokeLayer};
use vectorcraft_geom::{Affine, FillRule, PathData, Point};
/// The most anchors an arrowhead symbol's art is read with, outlined strokes included, before its
/// shapes are united.
const MAX_ART_ANCHORS: usize = 65_536;
/// How deep the groups of an arrowhead symbol's art are read.
const MAX_DEPTH: usize = 16;
/// The head that symbol art `art` (in the document's symbol space) draws, named `name`. `None` when
/// the art doesn't have exactly one sample of the line, its sample isn't 1 pt wide, it holds
/// anything but paths, compound paths and groups (a clip group, say), has an effect, a brush, an
/// opacity mask, partial opacity or a group with fills or strokes of its own, paints no head, or is
/// too detailed for one; or when the
/// line would stop past the head's tip or farther back than a head can reach
/// ([`CustomArrowhead::MAX_UNITS`]).
pub(super) fn head(name: &str, art: &Node) -> Option<CustomArrowhead> {
let mut parts = Parts::default();
match &art.kind {
// The members of the symbol's group are its art's top level, where the sample is.
NodeKind::Group { children, clip: false } if art.visible && plain(art) && !paints(art) => {
for c in children {
parts.member(c, true, 1)?;
}
}
_ => parts.member(art, true, 0)?,
}
let [(axis, line_end)] = parts.lines.as_slice() else { return None };
if parts.shapes.is_empty() {
return None;
}
let refs: Vec<(&PathData, FillRule)> = parts.shapes.iter().map(|(p, r)| (p, *r)).collect();
let area = vectorcraft_pathops::try_unite_all(&refs).ok()?;
let b = area.bounds().filter(|b| b.is_finite() && b.height() > 1e-9)?;
let tip = b.x1;
// Head units: x back from the tip, y across to the right of the way the head points (down).
let h = CustomArrowhead::new(name.to_string(), area.transformed(Affine::new([-1.0, 0.0, 0.0, 1.0, tip, -axis])));
let h = h.with_stop(tip - line_end);
(!h.path.subpaths.is_empty() && h.stop.is_some()).then_some(h)
}
/// What an arrowhead symbol's art is made of.
#[derive(Default)]
struct Parts {
/// Each sample of the line: the line's y, and the x where the sample ends.
lines: Vec<(f64, f64)>,
/// The areas the head paints.
shapes: Vec<(PathData, FillRule)>,
anchors: usize,
}
impl Parts {
/// Read `n`, a member of the art (`top`: of its top level) `depth` groups down. `None` when it
/// is something [`head`] doesn't read.
fn member(&mut self, n: &Node, top: bool, depth: usize) -> Option<()> {
if depth > MAX_DEPTH {
return None;
}
// Hidden or fully transparent art paints nothing.
if !n.visible || n.opacity <= 0.0 {
return Some(());
}
if !plain(n) {
return None;
}
match &n.kind {
NodeKind::Group { children, clip: false } => {
if paints(n) {
return None;
}
children.iter().try_for_each(|c| self.member(c, false, depth + 1))
}
NodeKind::Path { guide: true, .. } => Some(()),
NodeKind::Path { path, rule, .. } => self.painted(n, path, *rule, top),
NodeKind::Compound { children, rule } => {
let mut subpaths = vec![];
for c in children {
subpaths.extend(c.path_data()?.subpaths.iter().cloned());
}
self.painted(n, &PathData::new(subpaths), *rule, false)
}
_ => None,
}
}
/// Read the fills and strokes of path or compound path `n`, its outline `path` filled under
/// `rule` (`top`: a member of the art's top level, which may be the sample of the line).
fn painted(&mut self, n: &Node, path: &PathData, rule: FillRule, top: bool) -> Option<()> {
self.room(path.anchor_count())?;
let mut filled = false;
let mut strokes: Vec<&StrokeLayer> = vec![];
for item in &n.appearance.items {
match item {
AppearanceItem::Fill(f) if f.visible && f.opacity > 0.0 && !f.paint.is_none() => {
if !f.effects.is_empty() || f.opacity < 1.0 {
return None;
}
filled = true;
}
AppearanceItem::Stroke(s) if s.visible && s.opacity > 0.0 && !s.paint.is_none() && s.width > 0.0 => {
if !s.effects.is_empty() || s.brush.is_some() || s.opacity < 1.0 {
return None;
}
strokes.push(s);
}
_ => {}
}
}
if top
&& !filled
&& let [line] = strokes.as_slice()
&& let Some(sample) = sample_line(path)
{
// The sample is 1 pt, the weight of a head at one unit; another weight (art stored
// at another scale, as a Large Canvas file's) gives the units no known size.
if (line.width - 1.0).abs() > 1e-6 {
return None;
}
self.lines.push(sample);
return Some(());
}
if filled {
self.shapes.push((path.clone(), rule));
}
for s in strokes {
let outline = vectorcraft_effects::stroke::outline_region(path, rule, s);
self.room(outline.anchor_count())?;
if !outline.subpaths.is_empty() {
self.shapes.push((outline, FillRule::NonZero));
}
}
Some(())
}
/// Count `anchors` more; `None` past [`MAX_ART_ANCHORS`].
fn room(&mut self, anchors: usize) -> Option<()> {
self.anchors = self.anchors.saturating_add(anchors);
(self.anchors <= MAX_ART_ANCHORS).then_some(())
}
}
/// Does `n` draw as its shapes alone: fully opaque, with no effects and no opacity mask applied?
/// A head is one opaque shape, so partly transparent or masked art isn't read as one.
fn plain(n: &Node) -> bool {
n.opacity >= 1.0 && n.appearance.effects.is_empty() && n.extras().mask.as_ref().is_none_or(|m| m.disabled)
}
/// Does `n` (a group) have fills or strokes of its own that paint?
fn paints(n: &Node) -> bool {
n.appearance.items.iter().any(|i| match i {
AppearanceItem::Fill(f) => f.visible && !f.paint.is_none(),
AppearanceItem::Stroke(s) => s.visible && !s.paint.is_none(),
})
}
/// `path` as a sample of the line, when it is one open subpath of two anchors or more whose anchors
/// and handles all lie level with its first anchor: that y, and the x where it ends (its
/// rightmost anchor).
fn sample_line(path: &PathData) -> Option<(f64, f64)> {
let [sub] = path.subpaths.as_slice() else { return None };
if sub.closed || sub.anchors.len() < 2 {
return None;
}
let y = sub.anchors.first()?.p.y;
let level = |q: Point| q.x.is_finite() && (q.y - y).abs() <= 1e-6 * (1.0 + y.abs());
if !y.is_finite() || !sub.anchors.iter().all(|a| level(a.p) && level(a.h_in) && level(a.h_out)) {
return None;
}
Some((y, sub.anchors.iter().map(|a| a.p.x).fold(f64::NEG_INFINITY, f64::max)))
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use vectorcraft_color::{Color, Paint};
use vectorcraft_doc::{Appearance, Node, NodeId, OpacityMask};
use vectorcraft_geom::{PathData, Point, SubPath};
use super::head;
fn path(id: u64, points: &[(f64, f64)], closed: bool, appearance: Appearance) -> Arc<Node> {
let points: Vec<Point> = points.iter().map(|(x, y)| Point::new(*x, *y)).collect();
Arc::new(Node::path(NodeId(id), PathData::single(SubPath::polyline(&points, closed)), appearance))
}
/// A 1 pt sample of the line from x = −9 to 4 on y = 0.
fn sample() -> Arc<Node> {
path(1, &[(-9.0, 0.0), (4.0, 0.0)], false, Appearance::basic(Paint::None, Paint::solid(Color::BLACK), 1.0))
}
/// A filled wedge from x = 2 back to its tip at x = 8, 3 either side.
fn wedge() -> Arc<Node> {
path(2, &[(2.0, -3.0), (8.0, 0.0), (2.0, 3.0)], true, Appearance::basic(Paint::solid(Color::BLACK), Paint::None, 1.0))
}
fn art(members: Vec<Arc<Node>>) -> Node {
Node::group(NodeId(10), members)
}
#[test]
fn a_wedge_and_its_sample_make_a_head() {
let h = head("W", &art(vec![sample(), wedge()])).expect("a head");
assert_eq!(h.stop(), 4.0);
}
#[test]
fn partly_transparent_or_masked_art_makes_no_head() {
// The head would come in opaque and whole, with the bounds of the art.
let half = |n: Arc<Node>| Arc::new(Node { opacity: 0.5, ..(*n).clone() });
let mut faint_fill = (*wedge()).clone();
let mut ap = (*faint_fill.appearance).clone();
if let Some(f) = ap.fill_mut() {
f.opacity = 0.5;
}
faint_fill.appearance = ap.into();
let mut masked = (*wedge()).clone();
masked.extras_mut().mask = Some(Box::new(OpacityMask { art: sample(), clip: true, invert: false, disabled: false, linked: true }));
let cases = [
("a head at half opacity", art(vec![sample(), half(wedge())])),
("a fill at half opacity", art(vec![sample(), Arc::new(faint_fill)])),
("a group at half opacity", art(vec![sample(), half(Arc::new(art(vec![wedge()])))])),
("the art at half opacity", Node { opacity: 0.5, ..art(vec![sample(), wedge()]) }),
("a head with an opacity mask", art(vec![sample(), Arc::new(masked.clone())])),
];
for (why, a) in cases {
assert!(head("W", &a).is_none(), "{why}");
}
// A disabled mask isn't applied.
masked.extras_mut().mask.as_mut().unwrap().disabled = true;
assert!(head("W", &art(vec![sample(), Arc::new(masked)])).is_some());
}
}
+7 -2
View File
@@ -124,8 +124,8 @@ use vectorcraft_color::swatch::Swatch;
use vectorcraft_color::{BlendMode, Paint};
use vectorcraft_doc::cmyk::Inks;
use vectorcraft_doc::{
Appearance, AppearanceItem, Artboard, ColorMode, Dash, Document, FillLayer, ImageBlob, ImageObject, Knockout, LayerColor, LineCap, LineJoin,
LinkInfo, Node, NodeId, NodeKind, OpacityMask, PageBox, PatternDef, StrokeLayer, Unit,
Appearance, AppearanceItem, Artboard, ColorMode, CustomArrowhead, Dash, Document, FillLayer, ImageBlob, ImageObject, Knockout, LayerColor,
LineCap, LineJoin, LinkInfo, Node, NodeId, NodeKind, OpacityMask, PageBox, PatternDef, StrokeLayer, Unit,
};
use vectorcraft_geom::{AnchorKind, FillRule, PathData};
@@ -544,6 +544,10 @@ struct Reader<'a> {
symbol_bounds: HashMap<String, Rect>,
/// The symbols read, by their name in the file → their name in the document.
symbol_names: HashMap<String, String>,
/// The heads of the arrowhead symbols the art styles' strokes name, by the symbol's name in
/// the file (`None`: not a symbol read, or not one read as a head), read with the styles
/// ([`Reader::read_arrowheads`]).
arrowheads: HashMap<String, Option<Arc<CustomArrowhead>>>,
/// The names the symbols read have in the document, and for each name read more than once,
/// the number its next copy is tried with.
symbol_taken: HashSet<String>,
@@ -843,6 +847,7 @@ impl<'a> Reader<'a> {
unread: Vec::new(),
symbol_bounds: HashMap::new(),
symbol_names: HashMap::new(),
arrowheads: HashMap::new(),
symbol_taken: HashSet::new(),
symbol_suffix: HashMap::new(),
symbol_art_bounds: HashMap::new(),
@@ -752,6 +752,8 @@ impl<'a> Reader<'a> {
if std::mem::replace(&mut self.symbols_checked, true) {
return;
}
// The symbols are all read now: the heads of those defined after the styles.
self.read_arrowheads();
// Each symbol's name in the file (none for one named as an earlier one), and the names its
// instances use.
let files: HashMap<&str, &str> = self.symbol_names.iter().map(|(file, named)| (named.as_str(), file.as_str())).collect();
+11 -2
View File
@@ -128,6 +128,7 @@ impl<'a> Reader<'a> {
// section inside it would replace the file's own.
if self.subreader_depth == 0 {
self.styles = crate::import::ai::style::art_styles_in(section, &mut self.names);
self.read_arrowheads();
}
return Ok(());
}
@@ -398,6 +399,7 @@ impl<'a> Reader<'a> {
sub.gradients = std::mem::take(&mut self.gradients);
sub.global_names = std::mem::take(&mut self.global_names);
sub.styles = std::mem::take(&mut self.styles);
sub.arrowheads = std::mem::take(&mut self.arrowheads);
sub.nodes = self.nodes;
sub.template = self.template;
self.lend_budgets(&mut sub);
@@ -408,6 +410,7 @@ impl<'a> Reader<'a> {
self.names.absorb(std::mem::take(&mut sub.names));
self.global_names = std::mem::take(&mut sub.global_names);
self.styles = std::mem::take(&mut sub.styles);
self.arrowheads = std::mem::take(&mut sub.arrowheads);
// Unread art in the definition, hidden or not, leaves the tile incomplete.
let whole = read.is_ok()
&& sub.unsupported.is_empty()
@@ -429,6 +432,7 @@ impl<'a> Reader<'a> {
sub.gradients = std::mem::take(&mut self.gradients);
sub.global_names = std::mem::take(&mut self.global_names);
sub.styles = std::mem::take(&mut self.styles);
sub.arrowheads = std::mem::take(&mut self.arrowheads);
sub.nodes = self.nodes;
sub.template = self.template;
self.lend_budgets(&mut sub);
@@ -444,6 +448,7 @@ impl<'a> Reader<'a> {
self.gradients = std::mem::take(&mut sub.gradients);
self.global_names = std::mem::take(&mut sub.global_names);
self.styles = std::mem::take(&mut sub.styles);
self.arrowheads = std::mem::take(&mut sub.arrowheads);
self.names.absorb(std::mem::take(&mut sub.names));
let whole = read.is_ok()
&& sub.unsupported.is_empty()
@@ -597,6 +602,7 @@ impl<'a> Reader<'a> {
sub.gradients = std::mem::take(&mut self.gradients);
sub.global_names = std::mem::take(&mut self.global_names);
sub.styles = std::mem::take(&mut self.styles);
sub.arrowheads = std::mem::take(&mut self.arrowheads);
sub.pattern_tiles = std::mem::take(&mut self.pattern_tiles);
sub.v7_patterns.clone_from(&self.v7_patterns);
sub.nodes = self.nodes;
@@ -607,6 +613,7 @@ impl<'a> Reader<'a> {
self.gradients = std::mem::take(&mut sub.gradients);
self.global_names = std::mem::take(&mut sub.global_names);
self.styles = std::mem::take(&mut sub.styles);
self.arrowheads = std::mem::take(&mut sub.arrowheads);
self.pattern_tiles = std::mem::take(&mut sub.pattern_tiles);
self.names.absorb(std::mem::take(&mut sub.names));
// Art stopped by a trailer, or with an array, type, image, placed file, gradient mesh or
@@ -620,7 +627,7 @@ impl<'a> Reader<'a> {
|| sub.mesh.is_some()
|| sub.gradient_def.is_some();
let head = sub.symbol.take().unwrap_or_default();
let registration = head.registration;
let (registration, dynamic) = (head.registration, head.dynamic);
let measured = read.is_ok() && !open && sub.unsupported.is_empty() && sub.unknown.is_empty() && sub.frames.len() == 1;
let Some(frame) = sub.frames.pop().filter(|_| measured) else { return };
let mut kids = frame.children;
@@ -662,7 +669,7 @@ impl<'a> Reader<'a> {
}
}
let named = self.unique_symbol_name(if name.is_empty() { "Symbol" } else { &name });
self.doc.symbols.push(Symbol { name: named.clone(), art: Arc::new(art), dynamic: false });
self.doc.symbols.push(Symbol { name: named.clone(), art: Arc::new(art), dynamic });
if let Some(reg) = registration.and_then(symbol_registration) {
self.doc.set_symbol_registration(&named, reg);
}
@@ -788,6 +795,7 @@ impl<'a> Reader<'a> {
// version 7 form, lent.
sub.gradients = std::mem::take(&mut self.gradients);
sub.styles = std::mem::take(&mut self.styles);
sub.arrowheads = std::mem::take(&mut self.arrowheads);
sub.pattern_tiles = std::mem::take(&mut self.pattern_tiles);
sub.v7_patterns = std::mem::take(&mut self.v7_patterns);
sub.global_names = std::mem::take(&mut self.global_names);
@@ -799,6 +807,7 @@ impl<'a> Reader<'a> {
self.nodes = sub.nodes;
self.gradients = std::mem::take(&mut sub.gradients);
self.styles = std::mem::take(&mut sub.styles);
self.arrowheads = std::mem::take(&mut sub.arrowheads);
self.pattern_tiles = std::mem::take(&mut sub.pattern_tiles);
self.v7_patterns = std::mem::take(&mut sub.v7_patterns);
self.global_names = std::mem::take(&mut sub.global_names);
+16 -1
View File
@@ -455,6 +455,8 @@ pub fn graphic_styles(data: &[u8], large_canvas: bool, names: &mut obj::Names) -
r.large_canvas = large_canvas.then_some(1.0);
// The styles come before the art, so an error in the art leaves them read.
let _ = r.run();
// No layer checks the symbols here: the heads of those defined after the styles.
r.read_arrowheads();
let styles = r.graphic_styles().0;
let used: Vec<&str> = styles.iter().map(|s| s.name.as_str()).collect();
names.absorb_among(std::mem::take(&mut r.names), &used);
@@ -781,6 +783,19 @@ impl<'a> Reader<'a> {
{
head.registration = Some(*r);
}
if self.frames.len() == 1
&& let Some(head) = self.symbol.as_mut()
&& o.nums(crate::ai_editing::DYNAMIC_KEY).first().is_some_and(|v| *v != 0.0)
{
head.dynamic = true;
}
if let Some(text) = o.text(crate::ai_editing::OVERRIDES_KEY)
&& let Some(bytes) = crate::ai_editing::hex_decode(&text)
&& let Ok(list) = serde_json::from_slice::<Vec<vectorcraft_doc::SymbolOverride>>(&bytes)
&& let Some(n) = self.last_object().filter(|n| matches!(n.kind, NodeKind::SymbolInstance { .. }))
{
n.extras_mut().symbol_overrides = list.into_iter().filter(|s| !s.is_empty()).collect();
}
self.constraint_art(o);
self.placed_page(o);
// A blend's key object or spine.
@@ -1183,7 +1198,7 @@ impl<'a> Reader<'a> {
continue;
}
let Some(st) = self.styles.get(&name) else { continue };
let Some(mut appearance) = appearance_from_art_style(st, &self.gradients) else { continue };
let Some(mut appearance) = appearance_from_art_style(st, &self.gradients, &self.arrowheads) else { continue };
// A Large Canvas copy's styles are at its art's scale ([`Self::ensure_space`]).
if let Some(s) = self.large_canvas.filter(|s| *s != 1.0) {
appearance.scale_strokes(s);
+142 -9
View File
@@ -2,9 +2,12 @@ use super::containers::close;
use super::document::slot_of;
use super::types::{BLENDS, FLIP, Frame, GRAPH_UNENDED, IGNORED, Kind, MAX_DEPTH, MAX_NODES, MAX_TAG_TEXT, MAX_TAGS, Place, URL_TAG, line_width};
use super::{
Affine, Appearance, AppearanceItem, Arc, BlendMode, BrushesKept, Dash, FillLayer, FillRule, Global, Gradient, GradientDef, HashMap, HashSet,
Instance, Knockout, LayerColor, LineCap, LineJoin, Node, NodeId, NodeKind, Paint, Reader, Rect, ShownNames, StrokeLayer, V, obj, paint,
Affine, Appearance, AppearanceItem, Arc, BlendMode, BrushesKept, CustomArrowhead, Dash, FillLayer, FillRule, Global, Gradient, GradientDef,
HashMap, HashSet, Instance, Knockout, LayerColor, LineCap, LineJoin, Node, NodeId, NodeKind, Paint, Reader, Rect, ShownNames, StrokeLayer, V,
obj, paint,
};
use vectorcraft_doc::{ArrowAlign, Arrowhead};
use vectorcraft_geom::PathData;
impl<'a> Reader<'a> {
// ---- operators -------------------------------------------------------------------------
@@ -707,6 +710,30 @@ impl<'a> Reader<'a> {
self.note_state();
}
/// Read the heads of the arrowhead symbols the art styles' strokes name into
/// [`Reader::arrowheads`] ([`crate::import::ai::arrowhead::head`]), each symbol once. Called
/// when the styles are read and again when the symbols have all been read ([`Self::check_symbols`]),
/// for a file that defines its symbols after its styles: a name with no symbol read yet is
/// left for then.
pub(super) fn read_arrowheads(&mut self) {
use crate::import::ai::style::StyleItem;
for st in self.styles.values() {
for item in &st.items {
let StyleItem::Stroke { arrows: Some(arrows), .. } = item else { continue };
for name in arrows.symbols() {
if self.arrowheads.contains_key(name) {
continue;
}
let symbol = self.symbol_names.get(name).and_then(|named| self.doc.symbols.iter().find(|s| &s.name == named));
if let Some(s) = symbol {
let head = crate::import::ai::arrowhead::head(name, &s.art).map(Arc::new);
self.arrowheads.insert(name.to_string(), head);
}
}
}
}
}
/// Brings [`Reader::brushes_kept`] up to date with the brushes and brush art read so far.
fn note_brushes_kept(&mut self) {
use super::super::brush;
@@ -818,6 +845,7 @@ impl<'a> Reader<'a> {
brushes: &self.brush_drafts,
kept: &self.brushes_kept.kept,
bending: &self.brushes_kept.bending,
arrowheads: &self.arrowheads,
space,
},
)
@@ -1061,6 +1089,8 @@ struct StylePaints<'a> {
kept: &'a [bool],
/// The art an Art brush draws as the file does, with its length ([`super::super::brush::bending_art`]).
bending: &'a HashMap<String, f64>,
/// The heads of the arrowhead symbols strokes name ([`Reader::arrowheads`]).
arrowheads: &'a HashMap<String, Option<Arc<CustomArrowhead>>>,
space: Affine,
}
@@ -1411,7 +1441,7 @@ fn styled(object: &Node, look: &Node, st: &crate::import::ai::style::ArtStyle, p
return None;
}
}
stroke_layer(item)?
stroke_layer(item, paints.arrowheads)?
}
};
if let Some(look) = st.looks.get(n) {
@@ -1430,6 +1460,88 @@ fn styled(object: &Node, look: &Node, st: &crate::import::ai::style::ArtStyle, p
if !slot && st.effects.iter().any(|e| e.id == "distort.zigZag") && !draws_look_outline(object, &appearance, look) {
return None;
}
heads_placed(object, look, appearance, paints.space)
}
/// What `appearance` paints on path or compound path `object`: its fills' outline and its strokes'
/// areas, heads included, measured exactly (a node's visual bounds allow a head its whole reach on
/// every side). `None` for another object or an appearance that paints nothing.
fn painted_bounds(object: &Node, appearance: &Appearance) -> Option<Rect> {
let (path, rule) = match &object.kind {
NodeKind::Path { path, rule, .. } => (path.clone(), *rule),
NodeKind::Compound { children, rule } => {
(PathData::new(children.iter().filter_map(|c| c.path_data()).flat_map(|p| p.subpaths.iter().cloned()).collect()), *rule)
}
_ => return None,
};
let mut out = None;
for item in &appearance.items {
let painted = match item {
AppearanceItem::Fill(f) if f.visible && !f.paint.is_none() => path.bounds(),
AppearanceItem::Stroke(s) if s.visible && !s.paint.is_none() => vectorcraft_effects::stroke::outline_region(&path, rule, s).bounds(),
_ => None,
};
out = vectorcraft_geom::union_opt(out, painted);
}
out
}
/// `appearance` (on `object`, whose drawn look is `look`, in a space `space` takes to the
/// document) with its strokes' arrowheads placed as the look draws them: the tips on the ends of
/// the path, or past them by the line's length under each head (Extend), whichever gives the
/// object the look's bounds within a quarter of the least distance a head moves between the two
/// (at least 0.05 pt, at most 0.5 pt). `None`
/// when neither does (the file draws the heads elsewhere: on other subpaths, say), or when both do
/// and any head moves 0.2 pt or more between them (the bounds can't tell which the file draws).
fn heads_placed(object: &Node, look: &Node, mut appearance: Appearance, space: Affine) -> Option<Appearance> {
let k = space.determinant().abs().sqrt();
let k = if k.is_finite() && k > 0.0 { k } else { 1.0 };
// How far each head moves between the placements (its line's length under it): the least and
// the most.
let (mut shift, mut most) = (f64::INFINITY, 0.0f64);
for item in &appearance.items {
let AppearanceItem::Stroke(s) = item else { continue };
for (head, end) in [(&s.start_arrow, false), (&s.end_arrow, true)] {
if let Some(Arrowhead::Custom(c)) = head {
let moves = c.stop() * s.arrow_weight(end) * k;
(shift, most) = (shift.min(moves), most.max(moves));
}
}
}
if shift.is_infinite() {
return Some(appearance);
}
let want = look.visual_bounds()?;
// Well under the distance between the placements, and under half a point: a look without
// those heads, or with them elsewhere, is off by more.
let tolerance = (shift / 4.0).clamp(0.05, 0.5);
let mut fits = vec![];
for align in [ArrowAlign::Tip, ArrowAlign::Extend] {
for item in &mut appearance.items {
if let AppearanceItem::Stroke(s) = item {
s.arrow_align = align;
}
}
let mut scaled = appearance.clone();
scaled.scale_strokes(k);
let got = painted_bounds(object, &scaled)?;
let off = [got.x0 - want.x0, got.y0 - want.y0, got.x1 - want.x1, got.y1 - want.y1].iter().fold(0.0f64, |m, d| m.max(d.abs()));
if off <= tolerance {
fits.push(align);
}
}
// Both fit when the bounds can't tell the placements apart (the end inside the bounds of the
// line's other segments), unless every head moves so little that either draws alike.
let align = match fits.as_slice() {
[one] => *one,
[first, _] if most < 0.2 => *first,
_ => return None,
};
for item in &mut appearance.items {
if let AppearanceItem::Stroke(s) = item {
s.arrow_align = align;
}
}
Some(appearance)
}
@@ -1559,7 +1671,11 @@ fn draws_look_outline(object: &Node, appearance: &Appearance, look: &Node) -> bo
/// A style that is one paint is its fill and stroke ([`crate::import::ai::style::ArtStyle::one_paint`]).
/// A style keeps only its gradients' names and angles, so each one's gradient, by VectorCraft's own
/// rule, is fitted to the bounds of whatever object the style is applied to, at its angle.
pub(super) fn appearance_from_art_style(st: &crate::import::ai::style::ArtStyle, gradients: &HashMap<String, Gradient>) -> Option<Appearance> {
pub(super) fn appearance_from_art_style(
st: &crate::import::ai::style::ArtStyle,
gradients: &HashMap<String, Gradient>,
arrowheads: &HashMap<String, Option<Arc<CustomArrowhead>>>,
) -> Option<Appearance> {
use crate::import::ai::style::StyleItem;
if !st.plain {
return None;
@@ -1574,7 +1690,7 @@ pub(super) fn appearance_from_art_style(st: &crate::import::ai::style::ArtStyle,
StyleItem::Fill(paint) => AppearanceItem::Fill(FillLayer::new(paint.clone())),
// A graphic style's brush isn't checked against the file's brushes: it is left out.
StyleItem::Stroke { brush: Some(_), .. } => return None,
StyleItem::Stroke { .. } => stroke_layer(item)?,
StyleItem::Stroke { .. } => stroke_layer(item, arrowheads)?,
StyleItem::Gradient { name, angle } => AppearanceItem::Fill(FillLayer::new(named_gradient(name.as_deref()?, *angle, gradients)?)),
StyleItem::Pattern { .. } => return None,
};
@@ -1665,7 +1781,7 @@ pub(crate) fn read_parsed_style(parsed: &ParsedStyle, own_gradient: Option<&Pain
.collect();
// No gradient is taken by name: on an object, one that isn't its own is placed where its drawn
// look has it.
let mut appearance = appearance_from_art_style(&st, &HashMap::new())?;
let mut appearance = appearance_from_art_style(&st, &HashMap::new(), &HashMap::new())?;
for (item, brush) in appearance.items.iter_mut().zip(brushes) {
if let (AppearanceItem::Stroke(s), Some(brush)) = (item, brush) {
s.brush = Some(brush);
@@ -1680,12 +1796,27 @@ pub(crate) fn parsed_moves_with(parsed: &ParsedStyle, object: &Node) -> bool {
!parsed.style.moves_outline() || moves_with(object, &parsed.style)
}
/// A style's stroke as an appearance item (`None` for a fill).
fn stroke_layer(item: &crate::import::ai::style::StyleItem) -> Option<AppearanceItem> {
let crate::import::ai::style::StyleItem::Stroke { paint, width, cap, join, miter, dash, profile, align, brush } = item else { return None };
/// A style's stroke as an appearance item, its arrowheads the heads of `arrowheads` by symbol
/// name, each tip on its end of the path (where [`heads_placed`] finds the file draws them on an
/// object; a graphic style keeps that). `None` for a fill, or for a stroke
/// whose arrowhead symbol has no head there or whose head's weight would be under the least one
/// draws at ([`StrokeLayer::arrow_weight`]), so the head would draw larger than in the file.
fn stroke_layer(item: &crate::import::ai::style::StyleItem, arrowheads: &HashMap<String, Option<Arc<CustomArrowhead>>>) -> Option<AppearanceItem> {
let crate::import::ai::style::StyleItem::Stroke { paint, width, cap, join, miter, dash, profile, align, brush, arrows } = item else {
return None;
};
let mut layer = StrokeLayer::new(paint.clone(), line_width(*width));
(layer.cap, layer.join, layer.miter_limit, layer.dash, layer.profile, layer.align) = (*cap, *join, *miter, dash.clone(), profile.clone(), *align);
layer.brush = brush.as_ref().map(|(name, _)| name.clone());
if let Some(arrows) = arrows {
let head = |end: &Option<(String, f64)>| -> Option<(Option<Arrowhead>, f64)> {
let Some((name, pct)) = end else { return Some((None, 100.0)) };
let head = arrowheads.get(name)?.clone()?;
(layer.width * pct / 100.0 >= StrokeLayer::LEAST_ARROW_WEIGHT).then_some((Some(Arrowhead::Custom(head)), *pct))
};
let ((start, start_pct), (end, end_pct)) = (head(&arrows.start)?, head(&arrows.end)?);
(layer.start_arrow, layer.end_arrow, layer.arrow_scale, layer.arrow_align) = (start, end, (start_pct, end_pct), ArrowAlign::Tip);
}
Some(AppearanceItem::Stroke(layer))
}
@@ -1914,6 +2045,7 @@ mod tests {
brushes: &brushes,
kept: &[true],
bending: &bending,
arrowheads: &HashMap::new(),
space: Affine::IDENTITY,
};
let look = Node::group(NodeId(1), vec![square(2, Paint::solid(vectorcraft_color::Color::rgb(1.0, 0.0, 0.0)))]);
@@ -1960,6 +2092,7 @@ mod tests {
brushes: &[],
kept: &[],
bending: &bending,
arrowheads: &HashMap::new(),
space: Affine::IDENTITY,
};
let look = Node::group(NodeId(1), vec![square(2, Paint::solid(vectorcraft_color::Color::rgb(1.0, 0.0, 0.0)))]);
+1
View File
@@ -244,6 +244,7 @@ pub(super) struct PatternHead {
pub(super) struct SymbolHead {
/// `AI13PatternRegistrationType` in the dictionary after the art.
pub(super) registration: Option<f64>,
pub(super) dynamic: bool,
/// Art the reader left out (type, a placed file, non-native art, an image it can't read or
/// place, a gradient it can't read): the symbol isn't kept, and its instances come in as the
/// page draws them, within the box of the rest.
+97
View File
@@ -230,6 +230,8 @@ impl ArtStyle {
}
}
// A stroke takes about 300 bytes and the other items about 100; a style holds a few of each.
#[allow(clippy::large_enum_variant)]
#[derive(Clone, Debug, PartialEq)]
pub(super) enum StyleItem {
Fill(Paint),
@@ -258,9 +260,35 @@ pub(super) enum StyleItem {
align: StrokeAlign,
/// A brush: its name, and its settings for this object.
brush: Option<(String, PathBrush)>,
/// Its arrowheads, as symbols of the file (`None`: it has none).
arrows: Option<Box<StrokeArrows>>,
},
}
/// A stroke's arrowheads: each end's symbol (`/GObjRef : (name) /SymbolArt ; (BSArrowBeginSymbol)`
/// or `(BSArrowEndSymbol)` in the stroke's dictionary) by its name in the file, with its scale in
/// percent (`BSArrowBeginScale`, `BSArrowEndScale`; 100 without one). The symbol's art is the head
/// and a sample of the line it ends, which `read::ops` reads into a head once the symbols are read.
#[derive(Clone, Debug, Default, PartialEq)]
pub(super) struct StrokeArrows {
pub start: Option<(String, f64)>,
pub end: Option<(String, f64)>,
}
impl StrokeArrows {
/// The names of the symbols, start first.
pub fn symbols(&self) -> impl Iterator<Item = &str> {
[&self.start, &self.end].into_iter().flatten().map(|(name, _)| name.as_str())
}
}
/// The arrowhead entries of a stroke's dictionary that [`stroke_arrows`] reads. Beside heads, any
/// other entry whose key starts with `BSArrow` isn't read, so the stroke keeps its drawn look.
const ARROW_ENTRIES: [&str; 4] = ["BSArrowBeginSymbol", "BSArrowEndSymbol", "BSArrowBeginScale", "BSArrowEndScale"];
/// The scales an arrowhead takes, in percent.
const ARROW_SCALES: std::ops::RangeInclusive<f64> = 1.0..=1000.0;
/// A fill's or stroke's own state in the stack.
#[derive(Clone, Debug, PartialEq)]
pub(super) struct ItemLook {
@@ -320,6 +348,9 @@ struct Filter {
/// The plug-in object it refers to (`/GObjRef : (name) (plug-in) /PluginObject`): its name and
/// plug-in name.
plugin_object: Option<(String, String)>,
/// The symbols its dictionary refers to (`/GObjRef : (name) /SymbolArt ; (key) ,`): each one's
/// name, by key.
symbols: HashMap<String, String>,
/// `mode opacity … Xy`.
xy: Option<(usize, f32)>,
/// `… isolate knockout … Xy`.
@@ -352,6 +383,7 @@ impl Default for Filter {
pattern: None,
fill_last: LastPaint::None,
plugin_object: None,
symbols: HashMap::new(),
xy: None,
xy_group: None,
data: None,
@@ -533,6 +565,11 @@ pub(super) fn art_styles_in(data: &[u8], names: &mut Names) -> HashMap<String, A
}
}
b"Array" => dict_array = Some(vec![]),
// A symbol the dictionary refers to: `/GObjRef : (name) /SymbolArt ; (key) ,`.
b"SymbolArt" => {
symbol_entry(&mut lex, &mut operands, &mut other_entry, names, filters.last_mut().filter(|_| in_basic));
continue;
}
b"PluginObject" if in_basic => {
let mut texts = operands.iter().rev().filter_map(|v| names.text(v));
if let (Some(plugin), Some(name), Some(f)) = (texts.next(), texts.next(), filters.last_mut()) {
@@ -891,6 +928,7 @@ impl OnePaint {
profile: None,
align: StrokeAlign::Center,
brush: None,
arrows: None,
}),
_ => return Err(()),
}
@@ -1485,11 +1523,68 @@ fn stroke_item(f: &Filter, align: StrokeAlign) -> Result<Option<StyleItem>, ()>
profile: width_profile(&f.arrays),
align,
brush: None,
arrows: stroke_arrows(f)?,
})),
_ => Err(()),
}
}
/// The arrowheads of stroke filter `f` ([`StrokeArrows`]; `None` without any). `Err` for heads
/// beside an arrowhead entry [`ARROW_ENTRIES`] doesn't name, a scale that isn't a number in
/// [`ARROW_SCALES`], or a symbol entry with no symbol's name.
fn stroke_arrows(f: &Filter) -> Result<Option<Box<StrokeArrows>>, ()> {
let end = |symbol: &str, scale: &str| -> Result<Option<(String, f64)>, ()> {
if !f.kinds.contains_key(symbol) {
return Ok(None);
}
let name = f.symbols.get(symbol).ok_or(())?;
let pct = match f.kinds.get(scale) {
None => Some(100.0),
Some(Kind::Real) => entry(f, scale, Kind::Real)?,
Some(_) => entry(f, scale, Kind::Int)?,
};
Ok(Some((name.clone(), pct.filter(|p| ARROW_SCALES.contains(p)).ok_or(())?)))
};
let arrows = StrokeArrows { start: end("BSArrowBeginSymbol", "BSArrowBeginScale")?, end: end("BSArrowEndSymbol", "BSArrowEndScale")? };
if arrows.start.is_none() && arrows.end.is_none() {
return Ok(None);
}
// Another arrowhead entry may change how the heads draw.
if f.kinds.keys().any(|k| k.starts_with("BSArrow") && !ARROW_ENTRIES.contains(&k.as_str())) {
return Err(());
}
Ok(Some(Box::new(arrows)))
}
/// A symbol the dictionary of `filter`, the basic filter being read, refers to,
/// `/GObjRef : (name) /SymbolArt ; (key) ,`, whose `/SymbolArt` `lex` has just read (`operands`:
/// the values before it, read by `names`): the symbol's name by its key in [`Filter::symbols`], the
/// key an entry of another kind. Outside a basic filter (`None`) nothing is read.
fn symbol_entry(lex: &mut Lexer, operands: &mut Vec<V>, other_entry: &mut Option<Option<String>>, names: &mut Names, filter: Option<&mut Filter>) {
let Some(f) = filter else { return };
let symbol = operands.iter().rev().find_map(|v| names.text(v));
(*other_entry, *operands) = (None, vec![]);
let at = lex.offset();
// A comment line is no part of the entry.
let mut next = || loop {
match lex.next_token().map(|t| t.tok) {
Some(Tok::Comment(_)) => continue,
tok => return tok,
}
};
let (close, key) = (next(), next());
// Anything else is read as it comes (a `/KnownStyle` starting the next style, say).
let (Some(Tok::Word(b";")), Some(Tok::Str(key))) = (close, key) else {
lex.seek(at);
return;
};
let key = String::from_utf8_lossy(&key).into_owned();
f.repeated |= f.kinds.insert(key.clone(), Kind::Other).is_some();
if let Some(symbol) = symbol {
f.symbols.insert(key, symbol);
}
}
/// A Stroke Offset filter `f`: a stroke whose own style is in its dictionary, aligned inside its
/// path when `StrokeOffsetInside` is 1 and outside when it is 0 (its `DisplayString` says which).
/// `Err` when that switch is missing or not a switch, or for a stroke [`paint_item`] doesn't read.
@@ -1552,6 +1647,7 @@ fn calligraphic_stroke(f: &Filter) -> Option<StyleItem> {
profile: None,
align: StrokeAlign::Center,
brush: Some((name.clone(), PathBrush::Calligraphic(super::brush::calligraphic(values, variation, codes)))),
arrows: None,
})
}
@@ -1633,6 +1729,7 @@ fn art_stroke(f: &Filter) -> Option<StyleItem> {
profile: None,
align: StrokeAlign::Center,
brush: Some((name.clone(), PathBrush::Art(settings))),
arrows: None,
})
}
+31 -2
View File
@@ -1558,8 +1558,10 @@ fn a_style_of_one_paint_reads_as_the_fill_and_stroke_its_xd_turns_on() {
};
let stroke = "0 R\n0 1 1 0 K\n1 J 2 j 3 w 4 M [2 1]0 d\n";
let Some(Ok(items)) = one(&format!("0 O\n0 0 1 0 k\n{stroke}1 1 Xd\n")) else { panic!("{:?}", one(stroke)) };
let [StyleItem::Fill(fill), StyleItem::Stroke { paint, width, cap, join, miter, dash, profile: None, align: StrokeAlign::Center, brush: None }] =
items.as_slice()
let [
StyleItem::Fill(fill),
StyleItem::Stroke { paint, width, cap, join, miter, dash, profile: None, align: StrokeAlign::Center, brush: None, arrows: _ },
] = items.as_slice()
else {
panic!("{items:?}")
};
@@ -1600,3 +1602,30 @@ fn a_style_of_one_paint_reads_as_the_fill_and_stroke_its_xd_turns_on() {
assert_eq!(one(&paint), Some(Err(())), "{paint}");
}
}
/// A `/SymbolArt` entry cut short (no `; (key)` after it) leaves what follows to be read: here the
/// next style.
#[test]
fn a_symbol_entry_cut_short_leaves_the_next_style_read() {
let stroke = "/BasicFilter :\n(Stroke Style Filter) 0 0 /Filter ,\n1 /Visible ,\n/Dictionary : /NotRecorded ,\n\
/StrokeStyle : 0 R\n0 0 0 1 0 0 0 XA\n0 J 0 j 1 w 10 M []0 d\n0 XR\n1 0 Xd\n/Def ;\n (StrokeStyle) ,\n";
let text = format!(
"/KnownStyle :\n(Cut) /Name ,\n/ActiveStyle :\n/CompoundFilter :\n(Chain Style Filter) 0 0 /Filter ,\n1 /Visible ,\n{stroke}/GObjRef : (W) /SymbolArt\n\
/KnownStyle :\n(Next) /Name ,\n/ActiveStyle :\n/CompoundFilter :\n(Chain Style Filter) 0 0 /Filter ,\n1 /Visible ,\n{stroke}; /Dict ;\n /Part ,\n;\n"
);
let styles = art_styles(text.as_bytes());
assert!(styles.contains_key("Cut") && styles.contains_key("Next"), "{:?}", styles.keys().collect::<Vec<_>>());
assert!(matches!(styles["Next"].items.as_slice(), [StyleItem::Stroke { arrows: None, .. }]), "{:?}", styles["Next"].items);
}
/// A comment line inside a `/SymbolArt` entry is skipped: the entry is still read.
#[test]
fn a_comment_inside_a_symbol_entry_is_skipped() {
let text = "/KnownStyle :\n(Arrowed) /Name ,\n/ActiveStyle :\n/CompoundFilter :\n(Chain Style Filter) 0 0 /Filter ,\n1 /Visible ,\n\
/BasicFilter :\n(Stroke Style Filter) 0 0 /Filter ,\n1 /Visible ,\n/Dictionary : /NotRecorded ,\n\
/GObjRef : (W) /SymbolArt\n%a comment\n; (BSArrowEndSymbol) ,\n\
/StrokeStyle : 0 R\n0 0 0 1 0 0 0 XA\n0 J 0 j 1 w 10 M []0 d\n0 XR\n1 0 Xd\n/Def ;\n (StrokeStyle) ,\n; /Dict ;\n /Part ,\n;\n";
let styles = art_styles(text.as_bytes());
let [StyleItem::Stroke { arrows: Some(arrows), .. }] = styles["Arrowed"].items.as_slice() else { panic!("{:?}", styles["Arrowed"].items) };
assert_eq!(arrows.end, Some(("W".to_string(), 100.0)));
}
+237
View File
@@ -6638,6 +6638,243 @@ fn a_default_style_with_a_stroke_aligned_outside_comes_in() {
assert_eq!(a[0].extras().graphic_style, Some(1));
}
/// An arrowhead symbol's art: an unpainted frame, a 1 pt sample of the line from x = −9 to 4 on
/// y = 0, and the head, a filled wedge from x = 2 back to its tip at x = 8, 3 either side.
const WEDGE_ART: &str = "-10 5 m\n10 5 L\n10 -5 L\n-10 -5 L\n-10 5 L\nn\n0 G\n1 w\n-9 0 m\n4 0 l\nS\n0 g\n2 3 m\n8 0 l\n2 -3 l\nf\n";
/// The end arrowhead entries of a stroke's dictionary: symbol `Wedge` at 50 %.
const END_WEDGE: &str = "50 /Real (BSArrowEndScale) ,\n/GObjRef : (Wedge) /SymbolArt ; (BSArrowEndSymbol) ,\n";
/// An art style named `name`: a black stroke of weight `width` whose stroke dictionary holds
/// `entries`, as a stroke's arrowheads are written.
fn arrow_style(name: &str, entries: &str, width: f64) -> String {
format!(
"/KnownStyle :\n({name}) /Name ,\n/ActiveStyle :\n/CompoundFilter :\n(Chain Style Filter) 0 0 /Filter ,\n1 /Visible ,\n\
/CompoundFilter :\n(Stack Style Filter) 0 0 /Filter ,\n1 /Visible ,\n\
/BasicFilter :\n(Stroke Style Filter) 0 0 /Filter ,\n1 /Visible ,\n2 /FillOrStroke ,\n/Dictionary : /NotRecorded ,\n\
/Dictionary : /NotRecorded ,\n1 /Int (BSAdvStrokeDictionaryVersion) ,\n{entries}; (kAIBeautifulStrokesParamsDictKey) ,\n\
/StrokeStyle : 0 R\n0 0 0 1 0 0 0 XA\n0 J 0 j {width} w 10 M []0 d\n0 XR\n1 0 Xd\n/Def ;\n (StrokeStyle) ,\n; /Dict ;\n /Part ,\n\
/BasicFilter :\n(Conduit Filter) 0 0 /Filter ,\n1 /Visible ,\n;\n /Part ,\n;\n /Part ,\n;\n"
)
}
/// The drawn look of a 2 pt line from (0, 50) to (100, 50) with [`END_WEDGE`] (weight 1) on its end,
/// the tip on the end: the line to 4 before it, under the head from x = 94 to 100, 3 either side.
const END_WEDGE_LOOK: &str = "0 G\n2 w\n0 50 m\n96 50 l\nS\n0 g\n94 53 m\n100 50 l\n94 47 l\nf\n";
/// A line from (0, 50) to (100, 50) drawn as `look`, read as itself with the art style `name`.
fn arrowed_line(name: &str, look: &str) -> String {
format!("0 Ae\nu\n{look}U\n%_0 50 m\n%_100 50 L\n%_N\n1 ({name}) XW\n")
}
/// A file with the arrowhead symbol `Wedge` (art `symbol_art`), the art style `Arrowed`
/// ([`arrow_style`] with `entries` and `width`), listed, and a line drawn with it as `look`.
fn arrowed_file(symbol_art: &str, entries: &str, width: f64, look: &str) -> String {
named_arrowed_file("Wedge", symbol_art, entries, width, look)
}
/// [`arrowed_file`] with the symbol named `name`.
fn named_arrowed_file(name: &str, symbol_art: &str, entries: &str, width: f64, look: &str) -> String {
format!(
"{}{}{}",
symbols(&symbol(name, symbol_art, 5)),
styles_and_list(&[arrow_style("Arrowed", entries, width)], &["Arrowed"]),
layer(&arrowed_line("Arrowed", look))
)
}
/// The object `r` reads, its path, and its stroke.
fn arrowed(r: &Structure) -> (Arc<Node>, vectorcraft_doc::StrokeLayer) {
let a = art(&r.doc);
assert_eq!(a.len(), 1, "{a:#?}");
assert!(matches!(a[0].kind, NodeKind::Path { .. }), "the object, not its look: {:#?} {:?}", a[0], r.warnings);
assert!(!r.warnings.iter().any(|w| w.contains("drawn look")), "{:?}", r.warnings);
let s = a[0].appearance.stroke().expect("a stroke").clone();
(a[0].clone(), s)
}
/// The bounds of the area stroke `s` paints along path `n` (its heads included).
fn painted(n: &Node, s: &vectorcraft_doc::StrokeLayer) -> Rect {
let NodeKind::Path { path, rule, .. } = &n.kind else { panic!("a path") };
vectorcraft_effects::stroke::outline_region(path, *rule, s).bounds().unwrap()
}
#[test]
fn a_strokes_arrowhead_symbols_are_its_arrowheads() {
// GUARDS: a stroke's arrowheads (#8188) were left out: the line came in without its heads.
use vectorcraft_doc::{ArrowAlign, Arrowhead};
let r = read_ok(&arrowed_file(WEDGE_ART, END_WEDGE, 2.0, END_WEDGE_LOOK));
let (object, s) = arrowed(&r);
assert_eq!((s.width, s.arrow_scale, s.arrow_align), (2.0, (100.0, 50.0), ArrowAlign::Tip));
assert!(s.start_arrow.is_none(), "{:?}", s.start_arrow);
let Some(Arrowhead::Custom(head)) = &s.end_arrow else { panic!("a head of the symbol's art: {:?}", s.end_arrow) };
assert_eq!(head.name, "Wedge");
// In head units, one a symbol unit: 6 long from the tip, 3 either side, the line stopping 4
// back from the tip, where the sample ends.
let b = head.path.bounds().expect("an outline");
for (got, want) in [(b.x0, 0.0), (b.x1, 6.0), (b.y0, -3.0), (b.y1, 3.0), (head.stop(), 4.0)] {
assert!((got - want).abs() < 1e-6, "{b:?}, stop {}", head.stop());
}
// Drawn with the tip on the line's end: a head of weight 1 (2 pt at 50 %), 6 pt long.
let end = object.path_data().unwrap().subpaths[0].anchors.last().unwrap().p;
let drawn = painted(&object, &s);
assert!((drawn.x1 - end.x).abs() < 1e-6 && (drawn.height() - 6.0).abs() < 1e-6, "{drawn:?} for an end at {end:?}");
// The listed graphic style has the head too.
let style = r.doc.graphic_styles[0].appearance.stroke().expect("the style's stroke");
assert!(matches!(&style.end_arrow, Some(Arrowhead::Custom(h)) if h == head), "{:?}", style.end_arrow);
}
#[test]
fn a_strokes_start_arrowhead_points_back_and_keeps_its_side() {
use vectorcraft_doc::Arrowhead;
// A head with one barb, below the line in the symbol (its space is y down): on the right of
// the way it points. At the start of a 1 pt line drawn left to right it points left, the barb
// above the line (the file's y up), the line starting 4 in.
let barb = "0 G\n1 w\n-9 0 m\n4 0 l\nS\n0 g\n2 3 m\n8 0 l\n2 0 l\nf\n";
let entries = "/GObjRef : (Wedge) /SymbolArt ; (BSArrowBeginSymbol) ,\n";
let look = "0 G\n1 w\n4 50 m\n100 50 l\nS\n0 g\n6 53 m\n0 50 l\n6 50 l\nf\n";
let r = read_ok(&arrowed_file(barb, entries, 1.0, look));
let (object, s) = arrowed(&r);
assert_eq!(s.arrow_scale, (100.0, 100.0));
assert!(s.end_arrow.is_none());
let Some(Arrowhead::Custom(head)) = &s.start_arrow else { panic!("{:?}", s.start_arrow) };
let b = head.path.bounds().unwrap();
assert!(b.y0.abs() < 1e-6 && (b.y1 - 3.0).abs() < 1e-6, "right of the way it points: {b:?}");
// Drawn: the tip on the start, and 3 pt of head on the barb's side of the line (above it: the
// document's y down) against the line's half point on the other.
let start = object.path_data().unwrap().subpaths[0].anchors.first().unwrap().p;
let drawn = painted(&object, &s);
assert!((drawn.x0 - start.x).abs() < 1e-6, "{drawn:?} for a start at {start:?}");
assert!((start.y - drawn.y0 - 3.0).abs() < 1e-6 && (drawn.y1 - start.y - 0.5).abs() < 1e-6, "{drawn:?} for a start at {start:?}");
}
#[test]
fn a_stroke_takes_both_heads_at_their_own_scales() {
use vectorcraft_doc::Arrowhead;
// The start at 100 % written as a whole number (weight 2: 12 long, 6 either side, the line 8
// in), the end at 50 %, both of a symbol named in Chinese ("wedge").
let entries = "100 /Int (BSArrowBeginScale) ,\n/GObjRef : (楔) /SymbolArt ; (BSArrowBeginSymbol) ,\n\
50 /Real (BSArrowEndScale) ,\n/GObjRef : (楔) /SymbolArt ; (BSArrowEndSymbol) ,\n";
let look = "0 G\n2 w\n8 50 m\n96 50 l\nS\n0 g\n12 56 m\n0 50 l\n12 44 l\nf\n94 53 m\n100 50 l\n94 47 l\nf\n";
let r = read_ok(&named_arrowed_file("楔", WEDGE_ART, entries, 2.0, look));
let (object, s) = arrowed(&r);
assert_eq!(s.arrow_scale, (100.0, 50.0));
for head in [&s.start_arrow, &s.end_arrow] {
assert!(matches!(head, Some(Arrowhead::Custom(h)) if h.name == "楔"), "{head:?}");
}
let drawn = painted(&object, &s);
assert!((drawn.width() - 100.0).abs() < 1e-6 && (drawn.height() - 12.0).abs() < 1e-6, "{drawn:?}");
}
#[test]
fn heads_drawn_past_the_path_extend_it() {
use vectorcraft_doc::ArrowAlign;
// The file draws the head's tip 4 past the end (the line's length under it at weight 1): the
// line keeps its length.
let look = "0 G\n2 w\n0 50 m\n100 50 l\nS\n0 g\n98 53 m\n104 50 l\n98 47 l\nf\n";
let r = read_ok(&arrowed_file(WEDGE_ART, END_WEDGE, 2.0, look));
let (object, s) = arrowed(&r);
assert_eq!(s.arrow_align, ArrowAlign::Extend);
let end = object.path_data().unwrap().subpaths[0].anchors.last().unwrap().p;
assert!((painted(&object, &s).x1 - end.x - 4.0).abs() < 1e-6);
}
#[test]
fn arrowheads_this_does_not_read_keep_the_drawn_look() {
let two_lines = format!("{WEDGE_ART}0 G\n1 w\n-9 0 m\n4 0 l\nS\n");
let no_line = "0 g\n2 3 m\n8 0 l\n2 -3 l\nf\n";
let thin_line = WEDGE_ART.replace("1 w", "0.5 w");
let missing = "/GObjRef : (Elsewhere) /SymbolArt ; (BSArrowEndSymbol) ,\n";
let unknown = format!("{END_WEDGE}1 /Int (BSArrowSomethingElse) ,\n");
let too_large = "2000 /Real (BSArrowEndScale) ,\n/GObjRef : (Wedge) /SymbolArt ; (BSArrowEndSymbol) ,\n";
let line_only = "0 G\n2 w\n0 50 m\n100 50 l\nS\n";
let cases: [(&str, &str, &str, f64, &str); 8] = [
("a symbol the file doesn't define", WEDGE_ART, missing, 2.0, END_WEDGE_LOOK),
("an arrowhead entry this doesn't read", WEDGE_ART, &unknown, 2.0, END_WEDGE_LOOK),
("a scale out of range", WEDGE_ART, too_large, 2.0, END_WEDGE_LOOK),
("a head lighter than the least weight drawn", WEDGE_ART, END_WEDGE, 0.25, END_WEDGE_LOOK),
("a symbol without a sample of the line", no_line, END_WEDGE, 2.0, END_WEDGE_LOOK),
("a symbol with two samples of the line", &two_lines, END_WEDGE, 2.0, END_WEDGE_LOOK),
("a sample of the line that isn't 1 pt", &thin_line, END_WEDGE, 2.0, END_WEDGE_LOOK),
("heads drawn neither on nor past the ends", WEDGE_ART, END_WEDGE, 2.0, line_only),
];
for (why, symbol_art, entries, width, look) in cases {
let r = read_ok(&arrowed_file(symbol_art, entries, width, look));
let a = art(&r.doc);
assert!(r.warnings.iter().any(|w| w.contains("drawn look")), "{why}: {:?} {a:#?}", r.warnings);
assert!(!matches!(a[0].kind, NodeKind::Path { .. }), "{why}: the look, not the object");
// A graphic style with an arrowhead it doesn't read isn't read either, rather than read
// without its heads.
let headless = |i: &AppearanceItem| matches!(i, AppearanceItem::Stroke(s) if s.end_arrow.is_none());
let styles: Vec<_> = r.doc.graphic_styles.iter().filter(|g| g.name == "Arrowed").collect();
assert!(styles.iter().all(|g| !g.appearance.items.iter().any(headless)), "{why}: {styles:?}");
}
}
#[test]
fn heads_whose_placement_the_drawn_bounds_leave_open_keep_the_drawn_look() {
// The line bends back so its end, and a head on it either on the end or 4 past it, lie inside
// the bounds of its earlier segments: those bounds can't tell the two placements apart.
let path = "%_0 50 m\n%_0 0 L\n%_200 0 L\n%_200 100 L\n%_100 100 L\n%_100 50 L\n%_N\n";
let look = "0 G\n2 w\n0 50 m\n0 0 l\n200 0 l\n200 100 l\n100 100 l\n100 54 l\nS\n0 g\n97 56 m\n100 50 l\n103 56 l\nf\n";
let line = format!("0 Ae\nu\n{look}U\n{path}1 (Arrowed) XW\n");
let file = format!(
"{}{}{}",
symbols(&symbol("Wedge", WEDGE_ART, 5)),
styles_and_list(&[arrow_style("Arrowed", END_WEDGE, 2.0)], &["Arrowed"]),
layer(&line)
);
let r = read_ok(&file);
let a = art(&r.doc);
assert!(r.warnings.iter().any(|w| w.contains("drawn look")), "{:?} {a:#?}", r.warnings);
assert!(!matches!(a[0].kind, NodeKind::Path { .. }), "the look, not the object");
}
#[test]
fn a_head_that_stays_put_leaves_a_moving_heads_placement_open() {
// The bent line of the test above, its end head moving 4 between the placements, and a start
// head whose line runs to its tip (a stop of 0), which stays put: the bounds still can't tell
// where the end head goes.
let flat = WEDGE_ART.replace("-9 0 m\n4 0 l", "-9 0 m\n8 0 l");
let entries = format!("50 /Real (BSArrowBeginScale) ,\n/GObjRef : (Flat) /SymbolArt ; (BSArrowBeginSymbol) ,\n{END_WEDGE}");
let path = "%_0 50 m\n%_0 0 L\n%_200 0 L\n%_200 100 L\n%_100 100 L\n%_100 50 L\n%_N\n";
let look =
"0 G\n2 w\n0 50 m\n0 0 l\n200 0 l\n200 100 l\n100 100 l\n100 54 l\nS\n0 g\n-3 44 m\n0 50 l\n3 44 l\nf\n97 56 m\n100 50 l\n103 56 l\nf\n";
let line = format!("0 Ae\nu\n{look}U\n{path}1 (Arrowed) XW\n");
let file = format!(
"{}{}{}",
symbols(&format!("{}{}", symbol("Wedge", WEDGE_ART, 5), symbol("Flat", &flat, 5))),
styles_and_list(&[arrow_style("Arrowed", &entries, 2.0)], &["Arrowed"]),
layer(&line)
);
let r = read_ok(&file);
let a = art(&r.doc);
assert!(r.warnings.iter().any(|w| w.contains("drawn look")), "{:?} {a:#?}", r.warnings);
assert!(!matches!(a[0].kind, NodeKind::Path { .. }), "the look, not the object");
}
#[test]
fn a_style_library_reads_the_heads_of_symbols_defined_after_its_styles() {
// A graphic style library has no layers, so nothing past its styles reads the heads again.
use vectorcraft_doc::Arrowhead;
let data = stream(&format!(
"%AI9_BeginArtStyles\n{}%AI9_EndArtStyles\n{}%AI9_BeginArtStyleList\n(Arrowed)\n%AI9_EndArtStyleList\n",
arrow_style("Arrowed", END_WEDGE, 2.0),
symbols(&symbol("Wedge", WEDGE_ART, 5))
));
let (styles, _) = graphic_styles(data.as_bytes(), false, &mut obj::Names::default());
let stroke = styles.iter().find(|g| g.name == "Arrowed").and_then(|g| g.appearance.stroke());
assert!(matches!(stroke.and_then(|s| s.end_arrow.as_ref()), Some(Arrowhead::Custom(h)) if h.name == "Wedge"), "{styles:?}");
}
#[test]
fn an_arrowhead_entry_without_heads_leaves_the_stroke_read() {
// Only beside heads does an arrowhead entry this doesn't read keep the drawn look.
let r = read_ok(&arrowed_file(WEDGE_ART, "1 /Int (BSArrowSomethingElse) ,\n", 2.0, "0 G\n2 w\n0 50 m\n100 50 l\nS\n"));
let (_, s) = arrowed(&r);
assert!(s.start_arrow.is_none() && s.end_arrow.is_none());
}
#[test]
fn a_symbol_defined_before_the_art_styles_reads_its_styled_objects() {
// GUARDS: objects in a symbol defined ahead of `%AI9_BeginArtStyles` (as Illustrator 24 writes
+27 -1
View File
@@ -2,7 +2,7 @@
//! reader reads back.
use vectorcraft_color::{
Color, Freeform, FreeformPoint, Gradient, GradientGeom, GradientKind, GradientPaint, GradientSpread, GradientStop, Paint, Swatch,
Color, Freeform, FreeformPoint, Gradient, GradientGeom, GradientKind, GradientMethod, GradientPaint, GradientSpread, GradientStop, Paint, Swatch,
};
use vectorcraft_doc::{Appearance, CharStyle, Document, Node, NodeId, NodeKind, StrokeGradientMode, TextObject};
use vectorcraft_geom::{Affine, Point, Rect, Vec2, shapes};
@@ -311,6 +311,32 @@ fn an_overprinting_diamond_gradient_without_a_frame_keeps_the_ink_below_on_a_pos
assert_keeps_the_ink_below(&cases);
}
#[test]
fn an_overprinting_gradient_with_stops_written_between_its_stops_keeps_the_ink_below_on_a_postscript_plate() {
// None of the cyan from 0.3 to 0.6: the stops written between those two stops (along a
// Perceptual or hue mix, or at a Classic gradient's off-centre midpoint) are paper white too.
let (inked, none) = (Color::cmyk(0.6, 0.3, 0.0, 0.0), Color::cmyk(0.0, 0.3, 0.0, 0.0));
let stops = [(0.0, inked), (0.3, none), (0.6, none), (1.0, inked)];
let c = Point::new(100.0, 50.0);
let around = GradientGeom { start: c, end: c + Vec2::new(70.0, -20.0), aspect: 0.7, focal: None };
let across = GradientGeom { start: Point::new(30.0, 40.0), end: Point::new(170.0, 60.0), aspect: 1.0, focal: None };
let cyan = Paint::solid(Color::cmyk(1.0, 0.0, 0.0, 0.0));
let shapes = [(GradientKind::Linear, across, "linear"), (GradientKind::Radial, around, "radial"), (GradientKind::Diamond, around, "diamond")];
let mut cases = vec![];
for method in [GradientMethod::Classic, GradientMethod::Perceptual, GradientMethod::HueClockwise, GradientMethod::HueCounterclockwise] {
for (kind, geom, shape) in shapes {
let mut fill = gradient(kind, &stops, geom, GradientSpread::Pad);
if let Paint::Gradient(g) = &mut fill {
g.gradient.method = method;
g.gradient.stops[1].midpoint = 0.3;
}
cases.push((format!("{shape}, {}", method.label()), overprinting(fill, Paint::None), cyan.clone(), "Cyan"));
}
}
let cases: Vec<_> = cases.iter().map(|(name, art, under, ink)| (name.as_str(), art.clone(), under.clone(), *ink)).collect();
assert_keeps_the_ink_below(&cases);
}
/// [`keeps_the_ink_below`] for each of `cases` (a name, the art, the paint under it and the ink
/// of the plate) at Level 3 and Level 2, with every case that fails named.
fn assert_keeps_the_ink_below(cases: &[(&str, Node, Paint, &str)]) {
+275
View File
@@ -570,6 +570,143 @@ pub fn arc(a: Point, b: Point, slope: f64, closed: bool, _base_along_x: bool) ->
PathData::single(SubPath::new(anchors, closed))
}
/// A circular arc from `start` to `end`: its circle's `center` and `radius`, and the turn from
/// `start` to `end` about the center in radians, positive the way the angle `atan2(y, x)` grows
/// (clockwise on the y-down page). The turn is never 0 and never a whole turn.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct CircularArc {
pub start: Point,
pub end: Point,
pub center: Point,
pub radius: f64,
pub sweep: f64,
}
impl CircularArc {
/// The arc from `start` to `end` that passes through `through`. `None` when two of the points
/// are the same or the three lie on one line ([`circle_through`]).
pub fn through(start: Point, end: Point, through: Point) -> Option<Self> {
let (center, radius) = circle_through(start, end, through)?;
let angle = |p: Point| (p.y - center.y).atan2(p.x - center.x);
let a = angle(start);
let to_end = (angle(end) - a).rem_euclid(TAU);
let to_through = (angle(through) - a).rem_euclid(TAU);
// The turn that goes past `through` on its way to `end`.
let sweep = if to_through < to_end { to_end } else { to_end - TAU };
Self::checked(start, end, center, radius, sweep)
}
/// The arc that leaves `start` heading along `direction` (its tangent there) and ends at
/// `end`. `None` when `start` and `end` are the same, `direction` is zero, or `end` lies on the
/// line through `start` along `direction` (no circle touches that line at `start` and passes
/// through `end`). The same test as [`circle_through`] decides that: twice the area of the
/// triangle `start`, `end` and `start + direction` scaled to the chord's length is at most
/// 10⁻¹⁰ of the chord's length squared.
pub fn leaving(start: Point, direction: Vec2, end: Point) -> Option<Self> {
let len = direction.hypot();
let chord = end - start;
let c2 = chord.hypot2();
if !(len.is_finite() && len > 0.0 && c2.is_finite() && c2 > 0.0) {
return None;
}
let t = direction / len;
// Twice the triangle's area with the tangent as long as the chord.
let cross = t.cross(chord);
if cross.is_nan() || (cross * c2.sqrt()).abs() <= 1e-10 * c2 {
return None;
}
// The center lies on the normal at `start` on the side `end` is: `start + n * s` with
// `|n * s - chord| = |s|`, so `s = |chord|² / (2 n·chord)`.
let n = Vec2::new(-t.y, t.x);
let s = c2 / (2.0 * n.dot(chord));
let center = start + n * s;
let radius = s.abs();
let angle = |p: Point| (p.y - center.y).atan2(p.x - center.x);
let a = angle(start);
let to_end = (angle(end) - a).rem_euclid(TAU);
// Leaving along `t`: the turn grows when `t` points the way the angle grows at `start`.
let grows = Vec2::new(-(start.y - center.y), start.x - center.x).dot(t) > 0.0;
let sweep = if grows { to_end } else { to_end - TAU };
Self::checked(start, end, center, radius, sweep)
}
/// The arc that ends at `end` arriving along `direction` and starts at `start`: [`Self::leaving`]
/// from `end` back along `-direction`, turned round.
pub fn arriving(start: Point, end: Point, direction: Vec2) -> Option<Self> {
let back = Self::leaving(end, -direction, start)?;
Some(Self { start, end, center: back.center, radius: back.radius, sweep: -back.sweep })
}
fn checked(start: Point, end: Point, center: Point, radius: f64, sweep: f64) -> Option<Self> {
let ok = center.is_finite() && radius.is_finite() && radius > 0.0 && sweep.is_finite() && sweep != 0.0 && sweep.abs() < TAU;
ok.then_some(Self { start, end, center, radius, sweep })
}
/// The point at `t` (0 at `start`, 1 at `end`) along the arc.
pub fn at(&self, t: f64) -> Point {
let a = (self.start.y - self.center.y).atan2(self.start.x - self.center.x) + self.sweep * t;
Point::new(self.center.x + self.radius * a.cos(), self.center.y + self.radius * a.sin())
}
/// The open path of the arc: an anchor at `start`, at `end`, and between them as many smooth
/// anchors, evenly spaced, as keep each cubic piece to a quarter turn at most. The ends are the
/// given points exactly.
pub fn to_path(&self) -> PathData {
let quarter = std::f64::consts::FRAC_PI_2;
// A quarter turn and a hair more is still one piece.
let pieces = ((self.sweep.abs() / quarter) - 1e-9).ceil().clamp(1.0, 4.0) as u32;
let step = self.sweep / f64::from(pieces);
// The handle length of a cubic that follows a circle through the turn `step`, per unit
// of radius; negative when the arc runs the other way.
let k = 4.0 / 3.0 * (step / 4.0).tan();
let a0 = (self.start.y - self.center.y).atan2(self.start.x - self.center.x);
let mut anchors = Vec::with_capacity(pieces as usize + 1);
for i in 0..=pieces {
let a = a0 + step * f64::from(i);
let p = if i == 0 {
self.start
} else if i == pieces {
self.end
} else {
Point::new(self.center.x + self.radius * a.cos(), self.center.y + self.radius * a.sin())
};
// The handle along the tangent the way the arc runs.
let d = Vec2::new(-a.sin(), a.cos()) * (self.radius * k);
let h_in = if i == 0 { p } else { p - d };
let h_out = if i == pieces { p } else { p + d };
let kind = if i == 0 || i == pieces { AnchorKind::Corner } else { AnchorKind::Smooth };
anchors.push(Anchor { p, h_in, h_out, kind });
}
PathData::single(SubPath::new(anchors, false))
}
/// [`Self::to_path`] with a smooth anchor at `via`, a point on the arc such as the one
/// [`Self::through`] passes through, so the path passes through it exactly: the arc to `via`
/// and the arc on from it, each cut into quarter turns at most. A `via` at an end, or off the
/// stretch between the ends, gives [`Self::to_path`].
pub fn to_path_via(&self, via: Point) -> PathData {
let angle = |p: Point| (p.y - self.center.y).atan2(p.x - self.center.x);
let turn = (angle(via) - angle(self.start)).rem_euclid(TAU);
// The turn from `start` to `via` the way the arc runs.
let to_via = if self.sweep > 0.0 { turn } else { turn - TAU };
let share = to_via / self.sweep;
if !(share > 0.0 && share < 1.0) || via == self.start || via == self.end {
return self.to_path();
}
let first = Self { end: via, sweep: to_via, ..*self }.to_path();
let second = Self { start: via, sweep: self.sweep - to_via, ..*self }.to_path();
let (Some(a), Some(b)) = (first.subpaths.into_iter().next(), second.subpaths.into_iter().next()) else { return self.to_path() };
let mut anchors: Vec<Anchor> = a.anchors.iter().copied().collect();
let mut rest = b.anchors.iter().copied();
if let (Some(joint), Some(next)) = (anchors.last_mut(), rest.next()) {
joint.h_out = next.h_out;
joint.kind = AnchorKind::Smooth;
}
anchors.extend(rest);
PathData::single(SubPath::new(anchors, false))
}
}
/// Logarithmic spiral with decay per full wind (`segments` quarter turns).
pub fn spiral(center: Point, radius: f64, decay_percent: f64, segments: u32, clockwise: bool) -> PathData {
let decay = (decay_percent / 100.0).clamp(0.05, 0.9999);
@@ -846,6 +983,144 @@ mod tests {
assert!(c.distance(Point::new(4.0, 3.0) + far) < 1e-6 && (radius - 5.0).abs() < 1e-6, "{c:?} {radius}");
}
/// Every point of `path`'s cubics lies on the arc's circle (to 3·10⁻⁴ of the radius, the
/// quarter-turn cubic's error), and the path runs from the arc's start to its end.
fn assert_on_circle(arc: &CircularArc) {
use kurbo::ParamCurve;
let path = arc.to_path();
let sp = &path.subpaths[0];
assert!(!sp.closed);
assert_eq!(sp.anchors.first().map(|a| a.p), Some(arc.start));
assert_eq!(sp.anchors.last().map(|a| a.p), Some(arc.end));
for seg in path.to_bezpath().segments() {
for i in 0..=8 {
let p = seg.eval(f64::from(i) / 8.0);
assert!((p.distance(arc.center) - arc.radius).abs() <= 3e-4 * arc.radius, "{p:?} off the circle");
}
}
}
/// The arc through a third point: from (0, 0) to (8, 0) through (4, -2) (above the chord on the
/// page) bulges up; through (4, 2) it bulges down; each has the circle through the three points
/// and goes past the third point. Through (4, 10) it is the larger part of its circle.
#[test]
fn the_arc_through_a_point_passes_through_it() {
let (a, b) = (Point::ORIGIN, Point::new(8.0, 0.0));
for (c, major) in
[(Point::new(4.0, -2.0), false), (Point::new(4.0, 2.0), false), (Point::new(4.0, 10.0), true), (Point::new(-1.0, -3.0), true)]
{
let arc = CircularArc::through(a, b, c).unwrap();
let (center, radius) = circle_through(a, b, c).unwrap();
assert!(arc.center.distance(center) < 1e-12 && (arc.radius - radius).abs() < 1e-12);
assert_eq!(arc.sweep.abs() > PI, major, "{c:?}: {}", arc.sweep);
// The third point is on the arc: some point along it is the third point.
let nearest = (0..=10_000).map(|i| arc.at(f64::from(i) / 10_000.0).distance(c)).fold(f64::INFINITY, f64::min);
assert!(nearest < 0.01, "{c:?}: {nearest}");
assert!(arc.at(0.0).distance(a) < 1e-12 && arc.at(1.0).distance(b) < 1e-9);
assert_on_circle(&arc);
}
// A half circle: two pieces, its middle anchor at the third point.
let arc = CircularArc::through(a, b, Point::new(4.0, -4.0)).unwrap();
let path = arc.to_path();
assert_eq!(path.subpaths[0].anchors.len(), 3);
assert!(path.subpaths[0].anchors[1].p.distance(Point::new(4.0, -4.0)) < 1e-12);
assert_eq!(path.subpaths[0].anchors[1].kind, AnchorKind::Smooth);
// Almost a whole circle: four pieces.
let arc = CircularArc::through(a, Point::new(0.0, 0.01), Point::new(8.0, 0.0)).unwrap();
assert_eq!(arc.to_path().subpaths[0].anchors.len(), 5);
assert_on_circle(&arc);
}
/// With an anchor at the third point, the path passes through it exactly, whichever way the
/// arc runs, even where one cubic would miss it (a quarter turn of radius 1000 misses a point
/// 20° along by about 0.27). Each part keeps to a quarter turn, the anchor there is smooth, and
/// a point at an end leaves the path as `to_path` makes it.
#[test]
fn the_path_via_the_third_point_passes_through_it_exactly() {
let center = Point::new(0.0, 0.0);
let on = |deg: f64| Point::new(1000.0 * deg.to_radians().cos(), 1000.0 * deg.to_radians().sin());
for (a, b, c) in [(0.0, 90.0, 20.0), (90.0, 0.0, 20.0), (0.0, 300.0, 170.0), (300.0, 0.0, 10.0)] {
let arc = CircularArc::through(on(a), on(b), on(c)).unwrap();
assert!(arc.center.distance(center) < 1e-6);
let path = arc.to_path_via(on(c));
let sp = &path.subpaths[0];
let joint = sp.anchors.iter().find(|x| x.p == on(c)).expect("an anchor at the third point");
assert_eq!(joint.kind, AnchorKind::Smooth);
assert_eq!((sp.anchors.first().map(|x| x.p), sp.anchors.last().map(|x| x.p)), (Some(arc.start), Some(arc.end)));
// No piece turns more than a quarter turn.
let points: Vec<Point> = sp.anchors.iter().map(|x| x.p).collect();
for w in points.windows(2) {
let (u, v) = (w[0] - arc.center, w[1] - arc.center);
assert!(u.cross(v).atan2(u.dot(v)).abs() <= std::f64::consts::FRAC_PI_2 + 1e-9, "{a} {b} {c}");
}
use kurbo::ParamCurve;
for seg in path.to_bezpath().segments() {
for i in 0..=8 {
let p = seg.eval(f64::from(i) / 8.0);
assert!((p.distance(arc.center) - arc.radius).abs() <= 0.3, "{p:?} off the circle");
}
}
}
// A third point a hair from an end is still an anchor.
let near = Point::new(1000.0, 0.0000005);
let arc = CircularArc::through(on(0.0), on(90.0), near).unwrap();
assert!(arc.to_path_via(near).subpaths[0].anchors.iter().any(|x| x.p == near));
let arc = CircularArc::through(on(0.0), on(90.0), on(20.0)).unwrap();
assert_eq!(arc.to_path_via(on(0.0)), arc.to_path());
assert_eq!(arc.to_path_via(on(180.0)), arc.to_path());
}
/// The arc that leaves its start along a direction: from (0, 0) heading up the page (-y) to
/// (8, 0) is the upper half circle about (4, 0); heading down, the lower one. Its tangent at the
/// start is the direction, and arriving at the end mirrors it.
#[test]
fn the_arc_leaving_along_a_direction_has_that_tangent() {
let (a, b) = (Point::ORIGIN, Point::new(8.0, 0.0));
let up = CircularArc::leaving(a, Vec2::new(0.0, -3.0), b).unwrap();
assert!(up.center.distance(Point::new(4.0, 0.0)) < 1e-12 && (up.radius - 4.0).abs() < 1e-12);
assert!(up.at(0.5).distance(Point::new(4.0, -4.0)) < 1e-9, "{:?}", up.at(0.5));
let down = CircularArc::leaving(a, Vec2::new(0.0, 3.0), b).unwrap();
assert!(down.at(0.5).distance(Point::new(4.0, 4.0)) < 1e-9, "{:?}", down.at(0.5));
// Leaving at 45° up and right: a quarter circle, tangent along the direction.
for d in [Vec2::new(1.0, -1.0), Vec2::new(1.0, 1.0), Vec2::new(-1.0, -0.2), Vec2::new(-1.0, 3.0)] {
let arc = CircularArc::leaving(a, d, b).unwrap();
let first = &arc.to_path().subpaths[0].anchors[0];
let tangent = first.h_out - first.p;
assert!((tangent.normalize().dot(d.normalize()) - 1.0).abs() < 1e-12, "{d:?}: {tangent:?}");
assert_on_circle(&arc);
// Arriving along a direction at the end: the tangent into the end is the direction.
let arc = CircularArc::arriving(a, b, d).unwrap();
let last = arc.to_path().subpaths[0].anchors.last().copied().unwrap();
let tangent = last.p - last.h_in;
assert!((tangent.normalize().dot(d.normalize()) - 1.0).abs() < 1e-12, "{d:?}: {tangent:?}");
assert_eq!((arc.start, arc.end), (a, b));
assert_on_circle(&arc);
}
}
/// No arc for points that are the same, a third point on the chord's line, a zero or not
/// finite direction, or a direction along the chord's line.
#[test]
fn degenerate_points_give_no_arc() {
let (a, b) = (Point::new(1.0, 2.0), Point::new(5.0, 7.0));
assert_eq!(CircularArc::through(a, a, b), None);
assert_eq!(CircularArc::through(a, b, b), None);
assert_eq!(CircularArc::through(a, b, a.midpoint(b)), None);
assert_eq!(CircularArc::through(a, b, a + (b - a) * 3.0), None);
assert_eq!(CircularArc::through(a, b, Point::new(f64::INFINITY, 0.0)), None);
assert_eq!(CircularArc::leaving(a, Vec2::new(1.0, 0.0), a), None);
assert_eq!(CircularArc::leaving(a, Vec2::ZERO, b), None);
assert_eq!(CircularArc::leaving(a, Vec2::new(f64::NAN, 1.0), b), None);
assert_eq!(CircularArc::leaving(a, b - a, b), None);
assert_eq!(CircularArc::leaving(a, a - b, b), None);
assert_eq!(CircularArc::arriving(a, b, b - a), None);
// Off the line by 10⁻⁴ over a chord of 2000 still makes an arc.
let (p, q) = (Point::new(-1000.0, 0.0), Point::new(1000.0, 0.0));
assert!(CircularArc::leaving(p, Vec2::new(2000.0, 1e-4), q).is_some());
// Off the line by 10⁻¹² of the chord is in line: no arc, rather than a circle 10¹² chords wide.
assert_eq!(CircularArc::leaving(p, Vec2::new(1.0, 1e-12), q), None);
}
/// Two points that are the same, or three on one line, give no circle.
#[test]
fn coincident_or_collinear_points_give_no_circle() {
+9
View File
@@ -29,6 +29,10 @@ impl Default for Headless {
}
}
/// Desktop UI commands that the app refuses for every control and MCP request, because each one
/// opens another app (`refuse_automation` in `vectorcraft-ui-egui`). `--connect` does not run them.
const KEYBOARD_ONLY: &[&str] = &["attributes.openUrl", "file.export.svg.browser", "file.saveForWeb.browser", "file.showPackage"];
/// Commands the desktop app adds on top of the engine; the headless backend implements them too so
/// `run_command` behaves the same in both modes.
const HOST_COMMANDS: &[(&str, &str, &str)] = &[
@@ -157,6 +161,11 @@ impl Headless {
None if vectorcraft_engine::find_command(id).is_some() => {
self.session.check_params(id, params).map_err(|e| e.to_string())?;
}
None if KEYBOARD_ONLY.contains(&id) => {
return Err(format!(
"`{id}` opens another app: only the person at the keyboard can run it in the desktop app; control and MCP requests are refused, `--connect` included"
));
}
None if crate::ui_catalog::UI_COMMANDS.iter().any(|(cid, ..)| *cid == id) => {
return Err(format!(
"`{id}` is a desktop UI command (`ui: true`); start `vectorcraft --control 7979` and use `vectorcraft-cli mcp --connect`"
+17
View File
@@ -338,6 +338,23 @@ fn headless_command_list_includes_ui_commands() {
assert!(text_of(&r).contains("--connect"), "{r}");
}
/// Desktop commands that the app refuses for every automated request are not offered through
/// `--connect`: the headless error says only the person at the keyboard can run them.
#[test]
fn headless_does_not_send_keyboard_only_commands_to_connect() {
let mut s = server();
rpc(&mut s, 1, "initialize", json!({"protocolVersion": PROTOCOL_VERSION}));
s.handle_line(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#);
for (n, id) in ["attributes.openUrl", "file.export.svg.browser", "file.saveForWeb.browser", "file.showPackage"].iter().enumerate() {
assert!(crate::ui_catalog::UI_COMMANDS.iter().any(|(cid, ..)| cid == id), "{id} is not a desktop UI command");
let r = call(&mut s, 10 + n as u64, "command_run", json!({"id": id, "params": {}}));
assert_eq!(r["isError"], true, "{id}: {r}");
let text = text_of(&r);
assert!(text.contains("only the person at the keyboard"), "{id}: {r}");
assert!(!text.contains("start `vectorcraft --control"), "{id}: {r}");
}
}
// ---------- headless end-to-end ----------
#[test]
Loaded 100 of 236 files, more files were not shown because too many files have changed in this diff. Show more