diff --git a/ATTRIBUTION.md b/ATTRIBUTION.md index be99cdce1..77a9cc432 100644 --- a/ATTRIBUTION.md +++ b/ATTRIBUTION.md @@ -1,9 +1,28 @@ # Attribution -Every non-code asset in EffectCraft, with its author, source and licence. Each file listed here also has +Every non-code asset in EffectCraft, with its author, source and licence. Each repository file listed here also has a `.attribution` sidecar with full details. The rules are in [AGENTS.md](AGENTS.md) §1: no Adobe iconography, images or other Adobe assets; open licences only; every asset attributed. `cargo xtask assets` checks that this index and the sidecars cover every asset in the repository. +The complete licence texts and copyright notices for the bundled fonts, including the fonts embedded +by the pinned egui dependency, are reproduced in [`NOTICE`](NOTICE), which every package ships; the +`assets/fonts/OFL-*.txt` files are the upstream copies kept beside the fonts. + +## Bundled dependency fonts + +These fonts are embedded by the pinned egui dependency (epaint_default_fonts 0.37 at +`6d518fc799681571963842f95b55a6b68431b15a`); no font file is added to this repository. +egui-icons is always embedded, `default_fonts` adds Ubuntu Light and Hack, and +`monochrome_emoji_fonts` adds Noto Emoji and emoji-icon-font. The complete copyright notices +and licence texts are in [`NOTICE`](NOTICE). + +| Asset | Author | Source | Licence | +|---|---|---|---| +| `epaint_default_fonts/fonts/egui-icons.ttf` | John Slegers (emoji-icon-font) | https://github.com/storytold/egui/blob/6d518fc799681571963842f95b55a6b68431b15a/crates/epaint_default_fonts/fonts/egui-icons.txt; original https://github.com/jslegers/emoji-icon-font | MIT (complete copyright and permission text in `NOTICE`) | +| `epaint_default_fonts/fonts/emoji-icon-font.ttf` | John Slegers | https://github.com/storytold/egui/blob/6d518fc799681571963842f95b55a6b68431b15a/crates/epaint_default_fonts/fonts/emoji-icon-font-mit-license.txt; original https://github.com/jslegers/emoji-icon-font | MIT (complete copyright and permission text in `NOTICE`) | +| `epaint_default_fonts/fonts/NotoEmoji-Regular.ttf` | Google Inc. (The Noto Project Authors) | https://github.com/storytold/egui/blob/6d518fc799681571963842f95b55a6b68431b15a/crates/epaint_default_fonts/fonts/OFL.txt | OFL-1.1 (complete text in `NOTICE`) | +| `epaint_default_fonts/fonts/Ubuntu-Light.ttf` | Canonical Ltd. and Dalton Maag | https://github.com/storytold/egui/blob/6d518fc799681571963842f95b55a6b68431b15a/crates/epaint_default_fonts/fonts/UFL.txt | Ubuntu Font Licence 1.0 (complete text in `NOTICE`) | +| `epaint_default_fonts/fonts/Hack-Regular.ttf` | Source Foundry Authors; Bitstream Inc. | https://github.com/storytold/egui/blob/6d518fc799681571963842f95b55a6b68431b15a/crates/epaint_default_fonts/fonts/Hack-Regular.txt; original https://github.com/source-foundry/Hack | MIT AND Bitstream-Vera (complete texts in `NOTICE`) | ## Asset files @@ -15,6 +34,7 @@ iconography, images or other Adobe assets; open licences only; every asset attri | `assets/fonts/Inter-Bold.ttf` | The Inter Project Authors | https://github.com/rsms/inter | OFL-1.1 (`assets/fonts/OFL-Inter.txt`) | | `assets/fonts/Inter-Italic.ttf` | The Inter Project Authors | https://github.com/rsms/inter | OFL-1.1 (`assets/fonts/OFL-Inter.txt`) | | `assets/fonts/NotoSerif-Regular.ttf` | The Noto Project Authors | https://github.com/notofonts/latin-greek-cyrillic | OFL-1.1 (`assets/fonts/OFL-NotoSerif.txt`) | +| `assets/fonts/NotoSansSymbols2-Regular.ttf` | The Noto Project Authors | https://github.com/notofonts/symbols | OFL-1.1 (`assets/fonts/OFL-NotoSansSymbols2.txt`) | | `assets/fonts/JetBrainsMono-Regular.ttf` | The JetBrains Mono Project Authors | https://github.com/JetBrains/JetBrainsMono | OFL-1.1 (`assets/fonts/OFL-JetBrainsMono.txt`) | | `apps/effectcraft-web/web/favicon.svg` | EffectCraft contributors | Original work: web app icon, a copy of `assets/app-icon/effectcraft-small.svg` (the unicorn app icon) | MIT OR Apache-2.0 (`assets/app-icon/LICENSE.txt`) | | `packaging/macos/dmg/background.svg` | @XusBadia | Original work: macOS DMG Finder window background, derived from the EffectCraft app icon (`assets/app-icon/effectcraft.svg`); rendered to a TIFF by `packaging/macos/package.sh` at package time | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | diff --git a/Cargo.lock b/Cargo.lock index 68207f1c4..3d73dbc03 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,66 +4,60 @@ version = 4 [[package]] name = "accesskit" -version = "0.24.1" +version = "0.25.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d3b7f7f85a7e5f68090000ed7622545829afd484d210358702ae4cb97dd0c320" +checksum = "ad442f58ee04714aaa0ba0a2768c1ea1935b29507bb22ddece8cbbc76db02932" dependencies = [ "uuid", ] [[package]] name = "accesskit_atspi_common" -version = "0.18.1" +version = "0.21.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1e8c61bee90b42a772d39d06a740207dc71a4e780004ace1db8d99fb1baaa954" +checksum = "52c182f9c282ac9c5638d876d551d15e5f7d397ec263349a0c6a2b61595dd5e4" dependencies = [ "accesskit", - "accesskit_consumer 0.36.0", + "accesskit_consumer", "atspi-common", - "phf 0.13.1", + "phf", "serde", "zvariant", ] [[package]] name = "accesskit_consumer" -version = "0.35.0" +version = "0.39.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "53cf47daed85312e763fbf85ceca136e0d7abc68e0a7e12abe11f48172bc3b10" +checksum = "8a45e2bb300bea6d5f33a82c3e051c3ddc6f41c209750f68a0acbe991a284344" dependencies = [ "accesskit", - "hashbrown 0.16.1", + "hashbrown 0.17.1", ] [[package]] -name = "accesskit_consumer" -version = "0.36.0" +name = "accesskit_ios" +version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "25e0d7e25d06f4dc21d1774d67146e9e80d6789216cbd4d1e88185b0095dba60" +checksum = "28e539d64b27fd4c14de8f78ada8f7c944c092f52f7e49fb63316507a57f6937" dependencies = [ "accesskit", - "hashbrown 0.16.1", -] - -[[package]] -name = "accesskit_consumer" -version = "0.38.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5d10a236f96f87d70732e44520046785431ef01d5bcd6b041317bfadd2f88245" -dependencies = [ - "accesskit", - "hashbrown 0.16.1", + "accesskit_consumer", + "hashbrown 0.17.1", + "objc2 0.5.2", + "objc2-foundation 0.2.2", + "objc2-ui-kit 0.2.2", ] [[package]] name = "accesskit_macos" -version = "0.26.3" +version = "0.27.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ce02dc63b43f0c9296af9ac946312a2dc8814427d7a64d2d600971dac55b6076" +checksum = "5701624bf6a11efb6d4c8e922bf44126ed96250e5faa9a7a0468c979635839a4" dependencies = [ "accesskit", - "accesskit_consumer 0.38.0", - "hashbrown 0.16.1", + "accesskit_consumer", + "hashbrown 0.17.1", "objc2 0.5.2", "objc2-app-kit 0.2.2", "objc2-foundation 0.2.2", @@ -71,9 +65,9 @@ dependencies = [ [[package]] name = "accesskit_unix" -version = "0.21.1" +version = "0.24.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b016ca8db0ea0ea2ceff29a9d6240391492d960716aa471967c00e8cc8cb197c" +checksum = "202f24df034a7476d07b7f74284de84f6d62aabd858dbe7ee9cad3b7ad6f8f9d" dependencies = [ "accesskit", "accesskit_atspi_common", @@ -89,13 +83,13 @@ dependencies = [ [[package]] name = "accesskit_windows" -version = "0.32.1" +version = "0.35.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "eff7009f1a532e917d66970a1e80c965140c6cfbbabbdde3d64e5431e6c78e21" +checksum = "ce63f35d6bdcf59f26b76b3379063f738e6412cef46999cc772d46aa3de35adb" dependencies = [ "accesskit", - "accesskit_consumer 0.35.0", - "hashbrown 0.16.1", + "accesskit_consumer", + "hashbrown 0.17.1", "static_assertions", "windows 0.62.2", "windows-core 0.62.2", @@ -103,11 +97,12 @@ dependencies = [ [[package]] name = "accesskit_winit" -version = "0.32.2" +version = "0.34.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1fe9a94394896352cc4660ca2288bd4ef883d83238853c038b44070c8f134313" +checksum = "ee96dd150375c05912d8a473f98c2fb155fb3234fac88292d396548a2460fa77" dependencies = [ "accesskit", + "accesskit_ios", "accesskit_macos", "accesskit_unix", "accesskit_windows", @@ -222,6 +217,7 @@ dependencies = [ "parking_lot", "percent-encoding", "windows-sys 0.60.2", + "wl-clipboard-rs", "x11rb", ] @@ -607,7 +603,7 @@ dependencies = [ "hashbrown 0.17.1", "indexmap", "once_cell", - "phf 0.14.0", + "phf", "rustc-hash 2.1.3", "static_assertions", ] @@ -980,12 +976,12 @@ dependencies = [ [[package]] name = "craft-docpath" version = "0.1.0" -source = "git+https://github.com/storytold/craft-libs?rev=5bbe9f6254de3bb9f9707ae0740ab0db8170afd5#5bbe9f6254de3bb9f9707ae0740ab0db8170afd5" +source = "git+https://github.com/storytold/craft-libs?rev=a0916808f7d78bed8c7b90cdf937176015454a7f#a0916808f7d78bed8c7b90cdf937176015454a7f" [[package]] name = "craft-pdf" version = "0.1.0" -source = "git+https://github.com/storytold/craft-libs?rev=5bbe9f6254de3bb9f9707ae0740ab0db8170afd5#5bbe9f6254de3bb9f9707ae0740ab0db8170afd5" +source = "git+https://github.com/storytold/craft-libs?rev=a0916808f7d78bed8c7b90cdf937176015454a7f#a0916808f7d78bed8c7b90cdf937176015454a7f" dependencies = [ "hayro-syntax", "thiserror 2.0.21", @@ -994,7 +990,7 @@ dependencies = [ [[package]] name = "craft-ui" version = "0.1.0" -source = "git+https://github.com/storytold/craft-libs?rev=5bbe9f6254de3bb9f9707ae0740ab0db8170afd5#5bbe9f6254de3bb9f9707ae0740ab0db8170afd5" +source = "git+https://github.com/storytold/craft-libs?rev=a0916808f7d78bed8c7b90cdf937176015454a7f#a0916808f7d78bed8c7b90cdf937176015454a7f" dependencies = [ "egui", "log", @@ -1166,9 +1162,8 @@ dependencies = [ [[package]] name = "ecolor" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0656a7530b9e2841ee7a5f983965bdd9840c32f4012f759cfd44b912cced6b34" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "bytemuck", "emath", @@ -1725,9 +1720,8 @@ dependencies = [ [[package]] name = "eframe" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "55ad41fac6e3149abb4866e93df37dbd33baa95db525c3368c944584e95a5dc2" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "ahash", "bytemuck", @@ -1749,6 +1743,7 @@ dependencies = [ "pollster 1.0.1", "profiling", "raw-window-handle", + "send_wrapper", "static_assertions", "wasm-bindgen", "web-sys", @@ -1760,9 +1755,8 @@ dependencies = [ [[package]] name = "egui" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dc938cc27cd911415e1e4d151bc56ff9df063d8db081374e87aeb805ea74b2ba" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "accesskit", "ahash", @@ -1780,9 +1774,8 @@ dependencies = [ [[package]] name = "egui-wgpu" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5cef1f6d1bba40b09a4d0d62cb822b81030922cfbf65c5373398c3a3caafc5bd" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "ahash", "bytemuck", @@ -1800,31 +1793,34 @@ dependencies = [ [[package]] name = "egui-winit" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "98466000559d66ba4db786a30448b01483946add4188e7f10f522a27b4fb89cc" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "accesskit_winit", "arboard", + "block2 0.6.2", "bytemuck", "egui", + "image", "log", "objc2 0.6.4", + "objc2-app-kit 0.3.2", "objc2-foundation 0.3.2", "objc2-ui-kit 0.3.2", + "parking_lot", "profiling", "raw-window-handle", "smithay-clipboard", "web-time", "webbrowser", + "windows-sys 0.61.2", "winit", ] [[package]] name = "egui_glow" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "606ed4167daf341e5753d703285c4c1d562324b2c07aa8f405cd7d066fe58f3b" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "bytemuck", "egui", @@ -1836,9 +1832,8 @@ dependencies = [ [[package]] name = "egui_kittest" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5eb3f3effb2726fee23449293e67acbf6cc6ce35525b1722bd5743bb348114d5" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "eframe", "egui", @@ -1860,9 +1855,8 @@ checksum = "252afb9ae5eaa683babdc6a068b3f5726eb19e05070c731f9b2a23a7c3e8ed34" [[package]] name = "emath" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "52c8d4141cf0f60fb2f7aefaf352d3ffa5171ef0ab09731c64391801e95e48f1" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "bytemuck", ] @@ -1910,9 +1904,8 @@ dependencies = [ [[package]] name = "epaint" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a0ec0308dc23130fc1a7d4623a8534c2ed069c6dc84e258ee4f3de99615aa1a3" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" dependencies = [ "ahash", "bytemuck", @@ -1928,16 +1921,17 @@ dependencies = [ "self_cell", "skrifa", "smallvec", + "unicode-bidi", "unicode-general-category", + "unicode-properties", "unicode-segmentation", "vello_cpu", ] [[package]] name = "epaint_default_fonts" -version = "0.36.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "773fa9c96dd0dbef887e39d0ed6177f141cce4d68e6041df77570aa3702dfa13" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" [[package]] name = "equator" @@ -2545,9 +2539,9 @@ dependencies = [ [[package]] name = "glifo" -version = "0.2.0" +version = "0.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ed4a1bb24121291d27230c1b1b44e07d6a9b28cefdb32fe1581dfb84e14f940a" +checksum = "282a26c1e23de04bdab3e34a21b6f877a479b96737792516b9b8b8f69b6661be" dependencies = [ "bytemuck", "foldhash 0.2.0", @@ -2730,7 +2724,7 @@ checksum = "9f4d0e94ddd48749f06bbe4e5389fb9799a0c45bcaf00495042076ef05e3241a" [[package]] name = "hayro-jbig2" version = "0.3.0" -source = "git+https://github.com/storytold/craft-libs?rev=5bbe9f6254de3bb9f9707ae0740ab0db8170afd5#5bbe9f6254de3bb9f9707ae0740ab0db8170afd5" +source = "git+https://github.com/storytold/craft-libs?rev=a0916808f7d78bed8c7b90cdf937176015454a7f#a0916808f7d78bed8c7b90cdf937176015454a7f" dependencies = [ "hayro-ccitt", ] @@ -2744,7 +2738,7 @@ checksum = "c75ab947623ef4ccaa7acf0579edf7cbb5a73838e3839a7be73335e522f433a1" [[package]] name = "hayro-syntax" version = "0.7.2" -source = "git+https://github.com/storytold/craft-libs?rev=5bbe9f6254de3bb9f9707ae0740ab0db8170afd5#5bbe9f6254de3bb9f9707ae0740ab0db8170afd5" +source = "git+https://github.com/storytold/craft-libs?rev=a0916808f7d78bed8c7b90cdf937176015454a7f#a0916808f7d78bed8c7b90cdf937176015454a7f" dependencies = [ "hayro-jbig2", "hayro-jpeg2000", @@ -3063,12 +3057,12 @@ checksum = "e2db585e1d738fc771bf08a151420d3ed193d9d895a36df7f6f8a9456b911ddc" [[package]] name = "kittest" -version = "0.4.0" +version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "90ceaa75eb0036a32b6b9833962eb18137449e9817e2e586006471925b727fd5" +checksum = "0bb81a721ba76aa095b7f45deb180504f786904e56ca4b8e141f66eb89a78b75" dependencies = [ "accesskit", - "accesskit_consumer 0.35.0", + "accesskit_consumer", ] [[package]] @@ -3397,6 +3391,15 @@ version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2bf50223579dc7cdcfb3bfcacf7069ff68243f8c363f62ffa99cf000a6b9c451" +[[package]] +name = "nom" +version = "8.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df9761775871bdef83bee530e60050f7e54b1105350d6884eb0fb4f46c2f9405" +dependencies = [ + "memchr", +] + [[package]] name = "nu-ansi-term" version = "0.50.3" @@ -3889,6 +3892,16 @@ dependencies = [ "pin-project-lite", ] +[[package]] +name = "os_pipe" +version = "1.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d8fae84b431384b68627d0f9b3b1245fcf9f46f6c0e3dc902e9dce64edd1967" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + [[package]] name = "parking" version = "2.2.1" @@ -3950,14 +3963,14 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" [[package]] -name = "phf" -version = "0.13.1" +name = "petgraph" +version = "0.8.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c1562dc717473dbaa4c1f85a36410e03c047b2e7df7f45ee938fbef64ae7fadf" +checksum = "8701b58ea97060d5e5b155d383a69952a60943f0e6dfe30b04c287beb0b27455" dependencies = [ - "phf_macros 0.13.1", - "phf_shared 0.13.1", - "serde", + "fixedbitset", + "hashbrown 0.15.5", + "indexmap", ] [[package]] @@ -3966,18 +3979,9 @@ version = "0.14.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "010378780309880b08997fae13be7834dba947d36393bd372f2b1556deb2a2f6" dependencies = [ - "phf_macros 0.14.0", - "phf_shared 0.14.0", -] - -[[package]] -name = "phf_generator" -version = "0.13.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "135ace3a761e564ec88c03a77317a7c6b80bb7f7135ef2544dbe054243b89737" -dependencies = [ - "fastrand", - "phf_shared 0.13.1", + "phf_macros", + "phf_shared", + "serde", ] [[package]] @@ -3987,20 +3991,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "aeb62e0959d5a1bebc965f4d15d9e2b7cea002b6b0f5ba8cde6cc26738467100" dependencies = [ "fastrand", - "phf_shared 0.14.0", -] - -[[package]] -name = "phf_macros" -version = "0.13.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "812f032b54b1e759ccd5f8b6677695d5268c588701effba24601f6932f8269ef" -dependencies = [ - "phf_generator 0.13.1", - "phf_shared 0.13.1", - "proc-macro2", - "quote", - "syn 2.0.119", + "phf_shared", ] [[package]] @@ -4009,22 +4000,13 @@ version = "0.14.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5fa8d0ca26d424d27630da600c6624696e7dec8bf7b3b492b383c5dc49e5e085" dependencies = [ - "phf_generator 0.14.0", - "phf_shared 0.14.0", + "phf_generator", + "phf_shared", "proc-macro2", "quote", "syn 2.0.119", ] -[[package]] -name = "phf_shared" -version = "0.13.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e57fef6bc5981e38c2ce2d63bfa546861309f875b8a75f092d1d54ae2d64f266" -dependencies = [ - "siphasher", -] - [[package]] name = "phf_shared" version = "0.14.0" @@ -4609,6 +4591,12 @@ version = "1.0.28" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" +[[package]] +name = "send_wrapper" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd0b0ec5f1c1ca621c432a25813d8d60c88abe6d3e08a3eb9cf37d97a0fe3d73" + [[package]] name = "serde" version = "1.0.229" @@ -5376,6 +5364,17 @@ dependencies = [ "once_cell", ] +[[package]] +name = "tree_magic_mini" +version = "3.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8765b90061cba6c22b5831f675da109ae5561588290f9fa2317adab2714d5a6" +dependencies = [ + "memchr", + "nom", + "petgraph", +] + [[package]] name = "type-map" version = "0.5.1" @@ -5490,9 +5489,9 @@ dependencies = [ [[package]] name = "vello_common" -version = "0.1.0" +version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b2e9aed918117e8152c9eddfd8362d73c465c23f26c44786aa331707b8a64fa2" +checksum = "bbb2141a2bca6e6d598e471fd4d1d7eed8e020aad6a28187edda07f091a325dd" dependencies = [ "bytemuck", "fearless_simd", @@ -5505,9 +5504,9 @@ dependencies = [ [[package]] name = "vello_cpu" -version = "0.1.0" +version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ac7349e1f55f6b801c7c277958df4ea53e7f20f21e8014910ad888b2ecda93ea" +checksum = "ace506ca414548966fcf3c283be94eb1cad8254de488791ee698bf438b0890a9" dependencies = [ "bytemuck", "glifo", @@ -6501,8 +6500,7 @@ checksum = "d6bbff5f0aada427a1e5a6da5f1f98158182f26556f345ac9e04d36d0ebed650" [[package]] name = "winit" version = "0.30.13" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a6755fa58a9f8350bd1e472d4c3fcc25f824ec358933bba33306d0b63df5978d" +source = "git+https://github.com/storytold/winit.git?rev=a517b3846ee8457d84ee4975110bfda6797c44dc#a517b3846ee8457d84ee4975110bfda6797c44dc" dependencies = [ "ahash", "android-activity", @@ -6574,6 +6572,24 @@ version = "0.57.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1ebf944e87a7c253233ad6766e082e3cd714b5d03812acc24c318f549614536e" +[[package]] +name = "wl-clipboard-rs" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4d7888ccd4896447b2d14d3a9350a85df2aeb6f181e2e7a31349d104ac46cac1" +dependencies = [ + "libc", + "log", + "os_pipe", + "rustix 1.1.5", + "thiserror 2.0.21", + "tree_magic_mini", + "wayland-backend", + "wayland-client", + "wayland-protocols", + "wayland-protocols-wlr", +] + [[package]] name = "write16" version = "1.0.0" @@ -6937,3 +6953,23 @@ dependencies = [ "syn 3.0.6", "winnow", ] + +[[patch.unused]] +name = "egui_demo_lib" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" + +[[patch.unused]] +name = "egui_extras" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" + +[[patch.unused]] +name = "egui_inspection" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" + +[[patch.unused]] +name = "egui_system_font_provider" +version = "0.37.0" +source = "git+https://github.com/storytold/egui.git?rev=6d518fc799681571963842f95b55a6b68431b15a#6d518fc799681571963842f95b55a6b68431b15a" diff --git a/Cargo.toml b/Cargo.toml index 6fe7c2947..476ba6ef7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,8 +11,8 @@ rust-version = "1.95" repository = "https://github.com/storytold/effectcraft" [workspace.dependencies] -craft-pdf = { git = "https://github.com/storytold/craft-libs", rev = "5bbe9f6254de3bb9f9707ae0740ab0db8170afd5", version = "=0.1.0", default-features = false, features = ["read"] } -craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "5bbe9f6254de3bb9f9707ae0740ab0db8170afd5" } +craft-pdf = { git = "https://github.com/storytold/craft-libs", rev = "a0916808f7d78bed8c7b90cdf937176015454a7f", version = "=0.1.0", default-features = false, features = ["read"] } +craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "a0916808f7d78bed8c7b90cdf937176015454a7f" } # internal effectcraft-time = { path = "crates/time" } effectcraft-geom = { path = "crates/geom" } @@ -106,10 +106,13 @@ pollster = "0.4" # ui # Shared frontend components; keep this dependency above the engine boundary. -craft-ui = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "5bbe9f6254de3bb9f9707ae0740ab0db8170afd5", features = ["serde"] } -egui = "0.36" -eframe = { version = "0.36", default-features = false } -egui_kittest = "0.36" +# Shared UI and the complete egui family select reviewed immutable commits below. +craft-ui = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "a0916808f7d78bed8c7b90cdf937176015454a7f", features = ["serde"] } +# `default_fonts` and `monochrome_emoji_fonts` are explicit: the app's `FontDefinitions::default()` +# and its `✔`/`▣` chrome glyphs need both, and kittest's own dev-dependencies do not propagate. +egui = { version = "0.37", default-features = false, features = ["default_fonts", "monochrome_emoji_fonts"] } +eframe = { version = "0.37", default-features = false } +egui_kittest = "0.37" rfd = "0.17" cpal = "0.16" # The operating system's interface language (MIT/Apache-2.0, no dependencies on desktop). @@ -216,5 +219,20 @@ lto = "thin" codegen-units = 1 [patch.crates-io] -hayro-syntax = { git = "https://github.com/storytold/craft-libs", rev = "5bbe9f6254de3bb9f9707ae0740ab0db8170afd5", version = "=0.7.2" } -hayro-jbig2 = { git = "https://github.com/storytold/craft-libs", rev = "5bbe9f6254de3bb9f9707ae0740ab0db8170afd5", version = "=0.3.0" } +hayro-syntax = { git = "https://github.com/storytold/craft-libs", rev = "a0916808f7d78bed8c7b90cdf937176015454a7f", version = "=0.7.2" } +hayro-jbig2 = { git = "https://github.com/storytold/craft-libs", rev = "a0916808f7d78bed8c7b90cdf937176015454a7f", version = "=0.3.0" } +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" } +epaint_default_fonts = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui-winit = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui-wgpu = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui_glow = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui_extras = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui_kittest = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui_system_font_provider = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +eframe = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui_demo_lib = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +egui_inspection = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" } +winit = { git = "https://github.com/storytold/winit.git", rev = "a517b3846ee8457d84ee4975110bfda6797c44dc" } diff --git a/NOTICE b/NOTICE index 43bd2e2a9..5cf18a553 100644 --- a/NOTICE +++ b/NOTICE @@ -12,11 +12,280 @@ Third-party material This product bundles third-party material under its own licenses, listed below. The per-file list (author, source, license) is in ATTRIBUTION.md. -Inter (assets/fonts/Inter-*.ttf) — SIL Open Font License 1.1. See assets/fonts/OFL-Inter.txt. -Noto Serif (assets/fonts/NotoSerif-Regular.ttf) — SIL Open Font License 1.1. See assets/fonts/OFL-NotoSerif.txt. -JetBrains Mono (assets/fonts/JetBrainsMono-Regular.ttf) — SIL Open Font License 1.1. See assets/fonts/OFL-JetBrainsMono.txt. +Bundled fonts + +EffectCraft embeds Inter, Noto Serif, JetBrains Mono and Noto Sans Symbols 2 from +assets/fonts/. The pinned egui dependency (epaint_default_fonts, revision +6d518fc799681571963842f95b55a6b68431b15a) additionally embeds Ubuntu Light, Hack, +Noto Emoji, egui-icons and emoji-icon-font through EffectCraft's enabled `default_fonts` +and `monochrome_emoji_fonts` features; no font file from that dependency is added to +this repository. The complete copyright notices and licence texts required for all of +these fonts follow. The optional PDF document reader uses craft-pdf and Hayro-syntax 0.7.2, MIT OR Apache-2.0. The shared patched syntax source is centralized in storytold/craft-libs, transferred from PdfCraft revision 9ed3abe4907a127d36b12fbfeee71d7e26248da1. This parser-only use embeds no Hayro fonts, CMaps or image codecs; EffectCraft keeps its existing fonts and drawing filters. + +SIL Open Font License 1.1 + +Applies to Inter (assets/fonts/Inter-*.ttf), Noto Serif (assets/fonts/NotoSerif-Regular.ttf), +JetBrains Mono (assets/fonts/JetBrainsMono-Regular.ttf), Noto Sans Symbols 2 +(assets/fonts/NotoSansSymbols2-Regular.ttf) and Noto Emoji (NotoEmoji-Regular.ttf). +Copyright notices: + +Copyright (c) 2016 The Inter Project Authors (https://github.com/rsms/inter) +Copyright 2022 The Noto Project Authors (https://github.com/notofonts/latin-greek-cyrillic) +Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono) +Copyright 2022 The Noto Project Authors (https://github.com/notofonts/symbols) +Copyright 2013 Google Inc. All Rights Reserved. + +The fonts in assets/fonts/ also keep their upstream licence files at +assets/fonts/OFL-.txt. The complete licence text follows. + +This Font Software is licensed under the SIL Open Font License, +Version 1.1. + +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font +creation efforts of academic and linguistic communities, and to +provide a free and open framework in which fonts may be shared and +improved in partnership with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply to +any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software +components as distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, +deleting, or substituting -- in part or in whole -- any of the +components of the Original Version, by changing formats or by porting +the Font Software to a new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, +modify, redistribute, and sell modified and unmodified copies of the +Font Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, in +Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the +corresponding Copyright Holder. This restriction only applies to the +primary font name as presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created using +the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. + +Ubuntu Font Licence 1.0 + +Applies to Ubuntu Light (Ubuntu-Light.ttf). Copyright notice: + +Copyright 2011 Canonical Ltd. Licensed under the Ubuntu Font Licence 1.0 + +------------------------------- +UBUNTU FONT LICENCE Version 1.0 +------------------------------- + +PREAMBLE +This licence allows the licensed fonts to be used, studied, modified and +redistributed freely. The fonts, including any derivative works, can be +bundled, embedded, and redistributed provided the terms of this licence +are met. The fonts and derivatives, however, cannot be released under +any other licence. The requirement for fonts to remain under this +licence does not require any document created using the fonts or their +derivatives to be published under this licence, as long as the primary +purpose of the document is not to be a vehicle for the distribution of +the fonts. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this licence and clearly marked as such. This may +include source files, build scripts and documentation. + +"Original Version" refers to the collection of Font Software components +as received under this licence. + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to +a new environment. + +"Copyright Holder(s)" refers to all individuals and companies who have a +copyright ownership of the Font Software. + +"Substantially Changed" refers to Modified Versions which can be easily +identified as dissimilar to the Font Software by users of the Font +Software comparing the Original Version with the Modified Version. + +To "Propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification and with or without charging +a redistribution fee), making available to the public, and in some +countries other activities as well. + +PERMISSION & CONDITIONS +This licence does not grant any rights under trademark law and all such +rights are reserved. + +Permission is hereby granted, free of charge, to any person obtaining a +copy of the Font Software, to propagate the Font Software, subject to +the below conditions: + +1) Each copy of the Font Software must contain the above copyright +notice and this licence. These can be included either as stand-alone +text files, human-readable headers or in the appropriate machine- +readable metadata fields within text or binary files as long as those +fields can be easily viewed by the user. + +2) The font name complies with the following: +(a) The Original Version must retain its name, unmodified. +(b) Modified Versions which are Substantially Changed must be renamed to +avoid use of the name of the Original Version or similar names entirely. +(c) Modified Versions which are not Substantially Changed must be +renamed to both (i) retain the name of the Original Version and (ii) add +additional naming elements to distinguish the Modified Version from the +Original Version. The name of such Modified Versions must be the name of +the Original Version, with "derivative X" where X represents the name of +the new work, appended to that name. + +3) The name(s) of the Copyright Holder(s) and any contributor to the +Font Software shall not be used to promote, endorse or advertise any +Modified Version, except (i) as required by this licence, (ii) to +acknowledge the contribution(s) of the Copyright Holder(s) or (iii) with +their explicit written permission. + +4) The Font Software, modified or unmodified, in part or in whole, must +be distributed entirely under this licence, and must not be distributed +under any other licence. The requirement for fonts to remain under this +licence does not affect any document created using the Font Software, +except any version of the Font Software extracted from a document +created using the Font Software may only be distributed under this +licence. + +TERMINATION +This licence becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF +COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER +DEALINGS IN THE FONT SOFTWARE. + +Hack: MIT License and Bitstream Vera License + +Applies to Hack (Hack-Regular.ttf). Upstream notice and both licence texts: + +The work in the Hack project is Copyright 2018 Source Foundry Authors and licensed under the MIT License + +The work in the DejaVu project was committed to the public domain. + +Bitstream Vera Sans Mono Copyright 2003 Bitstream Inc. and licensed under the Bitstream Vera License with Reserved Font Names "Bitstream" and "Vera" +MIT License + +Copyright (c) 2018 Source Foundry Authors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +BITSTREAM VERA LICENSE + +Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is a trademark of Bitstream, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy of the fonts accompanying this license ("Fonts") and associated documentation files (the "Font Software"), to reproduce and distribute the Font Software, including without limitation the rights to use, copy, merge, publish, distribute, and/or sell copies of the Font Software, and to permit persons to whom the Font Software is furnished to do so, subject to the following conditions: + +The above copyright and trademark notices and this permission notice shall be included in all copies of one or more of the Font Software typefaces. + +The Font Software may be modified, altered, or added to, and in particular the designs of glyphs or characters in the Fonts may be modified and additional glyphs or characters may be added to the Fonts, only if the fonts are renamed to names not containing either the words "Bitstream" or the word "Vera". + +This License becomes null and void to the extent applicable to Fonts or Font Software that has been modified and is distributed under the "Bitstream Vera" names. + +The Font Software may be sold as part of a larger software package but no copy of one or more of the Font Software typefaces may be sold by itself. + +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL BITSTREAM OR THE GNOME FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE. + +Except as contained in this notice, the names of Gnome, the Gnome Foundation, and Bitstream Inc., shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Font Software without prior written authorization from the Gnome Foundation or Bitstream Inc., respectively. For further information, contact: fonts at gnome dot org. + +MIT License (egui-icons and emoji-icon-font) + +Applies to egui-icons.ttf, a five-glyph subset of emoji-icon-font, and the parent +emoji-icon-font.ttf, both by John Slegers, https://github.com/jslegers/emoji-icon-font. + +MIT License + +Copyright (c) 2014 John Slegers + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/apps/effectcraft-web/src/app.rs b/apps/effectcraft-web/src/app.rs index 3f462bd2a..f09bf28a1 100644 --- a/apps/effectcraft-web/src/app.rs +++ b/apps/effectcraft-web/src/app.rs @@ -87,6 +87,17 @@ pub struct WebApp { impl eframe::App for WebApp { fn raw_input_hook(&mut self, ctx: &egui::Context, raw_input: &mut egui::RawInput) { + // Files dropped on the page are input: read them here, where the browser's drop event is + // still the current pass's, not from a later (possibly logic-only) tick. + // + // The list is *taken* out of the raw input: a hidden tab runs `logic` and eframe appends + // the same prepared raw input back for the next pass, so leaving the files there would + // import them again on every hidden logic tick. + let dropped_files = std::mem::take(&mut raw_input.dropped_files); + let dropped: Vec = dropped_files.iter().filter_map(|f| f.web_file().cloned()).collect(); + if !dropped.is_empty() { + files::read_files(dropped, |paths| post(move |app| open_or_import(app, paths))); + } self.app.raw_input_hook(ctx, raw_input); } @@ -95,18 +106,14 @@ impl eframe::App for WebApp { for f in actions { f(&mut self.app); } - // Files dropped on the page: read them, then open/import. - let dropped: Vec = ctx.input(|i| i.raw.dropped_files.iter().filter_map(|f| f.web_file().cloned()).collect()); - if !dropped.is_empty() { - files::read_files(dropped, |paths| post(move |app| open_or_import(app, paths))); - } - self.app.logic(ctx, frame); + self.app.tick(ctx, frame); api::poll_replies(); // Render Queue outputs written this frame (here or by a worker) → downloads. files::flush_downloads(); // What a reload comes back to. if self.persist { - persist::snapshot(&self.app.session, ctx.input(|i| i.time), 1.0); + // The app's monotonic clock: `ctx.input(|i| i.time)` is stale in a logic-only tick. + persist::snapshot(&self.app.session, self.app.now(), 1.0); } api::set_info("gpu", json!({"compositor": self.app.gpu_adapter(), "viewerOnGpu": self.app.viewer_on_gpu()})); api::set_info("frameWorkers", frames::stats()); @@ -114,6 +121,7 @@ impl eframe::App for WebApp { let d = &self.app.session.prefs.disk; diskcache::configure(d.disk_cache_enabled, d.disk_cache_max_gb, storage::quota()); api::set_info("diskCache", diskcache::stats()); + self.app.finish_ime_logic(ctx); } fn ui(&mut self, ui: &mut egui::Ui, frame: &mut eframe::Frame) { @@ -195,7 +203,9 @@ pub async fn start(canvas_id: String) -> Result<(), JsValue> { let home = query_flag("home"); // Browser storage: settings, recent projects, imported media, saved projects, auto-saves and // the last session come back. - let t0 = js_sys::Date::now(); + // Monotonic (performance.now) rather than the wall clock: a system-time jump must not turn + // the storage-load report negative or huge. + let t0 = web_time::Instant::now(); let stored = match persist::load(&query_value("storage").unwrap_or_default()).await { Ok(n) => n, Err(e) => { @@ -203,7 +213,7 @@ pub async fn start(canvas_id: String) -> Result<(), JsValue> { 0 } }; - api::set_info("storage", json!({"backend": persist::backend(), "entries": stored, "loadMs": js_sys::Date::now() - t0})); + api::set_info("storage", json!({"backend": persist::backend(), "entries": stored, "loadMs": t0.elapsed().as_secs_f64() * 1000.0})); audio::install_unlock(); browse::restore(); diskcache::init(); @@ -214,6 +224,7 @@ pub async fn start(canvas_id: String) -> Result<(), JsValue> { canvas, eframe::WebOptions::default(), Box::new(move |cc| { + EffectcraftApp::install_ime_reset_hooks(&cc.egui_ctx); CTX.with(|c| *c.borrow_mut() = Some(cc.egui_ctx.clone())); // The page owns this shared presentation device; worker devices retain their // separate owned-device handlers. No browser error-scope future is blocked on. diff --git a/apps/effectcraft/Cargo.toml b/apps/effectcraft/Cargo.toml index 5ad6c80d1..8a1ea3ae3 100644 --- a/apps/effectcraft/Cargo.toml +++ b/apps/effectcraft/Cargo.toml @@ -15,7 +15,7 @@ effectcraft-host = { workspace = true } effectcraft-ui-egui = { workspace = true } egui = { workspace = true } # `links`: links (Help menu, Discord, Settings) open in the system browser. -eframe = { workspace = true, features = ["default_fonts", "wgpu", "accesskit", "links", "wayland", "x11"] } +eframe = { workspace = true, features = ["default_fonts", "wgpu", "accesskit", "clipboard", "links", "wayland", "x11"] } serde = { workspace = true } serde_json = { workspace = true } # The window's monitors, size and position (src/window.rs), and macOS event-loop options (no app diff --git a/apps/effectcraft/src/main.rs b/apps/effectcraft/src/main.rs index ba30e22fe..335a01046 100644 --- a/apps/effectcraft/src/main.rs +++ b/apps/effectcraft/src/main.rs @@ -213,6 +213,7 @@ fn main() -> eframe::Result { "EffectCraft", options, Box::new(move |cc| { + EffectcraftApp::install_ime_reset_hooks(&cc.egui_ctx); match &cc.wgpu_render_state { Some(rs) => log::info!("graphics: {:?}", rs.adapter.get_info()), None => log::info!("graphics: no wgpu device"), @@ -447,7 +448,8 @@ impl eframe::App for Desktop { fn logic(&mut self, ctx: &egui::Context, frame: &mut eframe::Frame) { #[cfg(target_os = "macos")] self.menu.update(&mut self.app, ctx); - self.app.logic(ctx, frame); + self.app.tick(ctx, frame); + self.app.finish_ime_logic(ctx); if let Some(asked) = &self.file_dialogs { sheet_dialogs::show_asked(asked, frame, ctx); } diff --git a/assets/fonts/NotoSansSymbols2-Regular.ttf b/assets/fonts/NotoSansSymbols2-Regular.ttf new file mode 100644 index 000000000..caf89dd0e Binary files /dev/null and b/assets/fonts/NotoSansSymbols2-Regular.ttf differ diff --git a/assets/fonts/NotoSansSymbols2-Regular.ttf.attribution b/assets/fonts/NotoSansSymbols2-Regular.ttf.attribution new file mode 100644 index 000000000..4d6d416be --- /dev/null +++ b/assets/fonts/NotoSansSymbols2-Regular.ttf.attribution @@ -0,0 +1,8 @@ +asset: NotoSansSymbols2-Regular.ttf +title: Noto Sans Symbols 2 Regular (chrome symbols such as ✔ and ▣) +author: The Noto Project Authors +source: https://github.com/notofonts/symbols (Google Fonts commit 47d54ca1ebb14fd864695f1d39dc734f39017c33, file ofl/notosanssymbols2/NotoSansSymbols2-Regular.ttf) +license: OFL-1.1 +license-file: assets/fonts/OFL-NotoSansSymbols2.txt +added: 2026-10-24 by @skylartaylor +notes: Unmodified font file, sha256 7d5fb73b7ca67a6798101741f5d280a3d016a56a197afcd4199dbb57b4b82a21. Embedded with include_bytes! in crates/ui-egui/src/theme.rs as the last UI fallback so every family can draw the chrome symbols (U+2714 ✔, U+25A3 ▣) that Inter, Inter Medium, Inter SemiBold and JetBrains Mono lack. diff --git a/assets/fonts/OFL-NotoSansSymbols2.txt b/assets/fonts/OFL-NotoSansSymbols2.txt new file mode 100644 index 000000000..7c95767f5 --- /dev/null +++ b/assets/fonts/OFL-NotoSansSymbols2.txt @@ -0,0 +1,93 @@ +Copyright 2022 The Noto Project Authors (https://github.com/notofonts/symbols) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +https://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/crates/engine/src/commands/app_more.rs b/crates/engine/src/commands/app_more.rs index 1bb94952f..b95dd4375 100644 --- a/crates/engine/src/commands/app_more.rs +++ b/crates/engine/src/commands/app_more.rs @@ -13,14 +13,23 @@ use super::{CommandSpec, always, b_p, bad, comp_id, has_comp, has_layers, has_pr use crate::{EngineError, Event, Result, Session, cmd, query}; /// Run `f` (which may run several undoable commands) as one undo step named `label`; on error -/// the project is restored. +/// the project, editor state and undo history are restored. +/// +/// Front-end events emitted by a failed `f` are discarded with the state. Pending-analysis +/// queues and the journal are not part of this rollback and keep their existing behaviour. pub(crate) fn grouped(s: &mut Session, label: &str, f: impl FnOnce(&mut Session) -> Result) -> Result { // The steps `f` records go to an empty stack (so the undo limit can't drop the snapshot - // taken before them), then become one step on the real one. + // taken before them), then become one step on the real one. Keep the complete pre-`f` + // history and editor state for a failure: rollback must not leave a partially retargeted + // editor or a `f`-recorded redo/branch behind. + let saved_history = s.history.clone(); let saved = std::mem::take(&mut s.history.undo); let before = s.project.clone(); + let before_state = s.state.clone(); + let event_mark = s.events.len(); let r = f(s); let changed = !s.history.undo.is_empty(); + let interim_revision = s.ime_revision; s.history.undo = saved; s.history.merge_key = None; match r { @@ -36,9 +45,22 @@ pub(crate) fn grouped(s: &mut Session, label: &str, f: impl FnOnce(&mut Sessi Ok(v) } Err(e) => { + // Snapshot the failing editor before restoring the pre-`f` state: an intermediate + // text.edit / text change / comp switch must invalidate the pre-`f` editor token + // instead of reviving it. + let edited = super::text_edit::active_editor_snapshot(s); + s.project = before; + s.state = before_state; + s.history = saved_history; + s.history.merge_key = None; + // A failed intermediate comp switch must not reach the front end through an + // `OpenComp` event while its state has been rolled back. + s.events.truncate(event_mark); + s.sanitize_after_replacement(edited.as_ref()); + // As in the batch rollback, the IME revision is a high-water mark: leave the highest + // intermediate stamp rather than rewinding to before `f`. + s.ime_revision = s.ime_revision.max(interim_revision); if changed { - s.project = before; - s.sanitize_state(); s.bump(); } Err(e) @@ -704,6 +726,36 @@ pub fn specs() -> Vec { mod tests { use serde_json::json; + #[test] + fn grouped_rollback_restores_the_editor_state_and_history_after_a_transient_text_change() { + let mut s = crate::Session::default(); + s.execute("comp.new", json!({"name": "Main", "width": 320, "height": 180, "duration": 1})).unwrap(); + let lid = s.execute("layer.newText", json!({"text": "abcdef"})).unwrap()["layer"].as_u64().unwrap(); + s.execute("text.edit", json!({"layer": lid, "caret": 3})).unwrap(); + let original_comp = s.active_comp_id().unwrap(); + let owner = s.state.text_edit.as_ref().unwrap().session; + let other = + s.execute("comp.new", json!({"name": "Other", "width": 160, "height": 90, "duration": 1, "open": false})).unwrap()["comp"].as_u64().unwrap(); + let undo = s.history.undo.len(); + s.drain_events(); + + let r = super::grouped(&mut s, "Rollback", |s| -> crate::Result<()> { + // An intermediate document edit and state switch, both undone by the error path. + s.execute("layer.setText", json!({"layer": lid, "text": "ab"}))?; + s.execute("comp.open", json!({"comp": other}))?; + Err(crate::EngineError::Other("stop".into())) + }); + assert!(r.is_err()); + assert_eq!(s.active_comp_id(), Some(original_comp), "the pre-group comp is restored"); + assert_eq!(super::super::text_edit::layer_doc(&s, effectcraft_project::LayerId(lid)).unwrap().text, "abcdef", "the document is restored"); + assert_eq!(s.history.undo.len(), undo, "the partial grouped steps are not left in history"); + assert_ne!(s.state.text_edit.as_ref().unwrap().session, owner, "a transient replacement does not revive the old IME token"); + assert!( + !s.drain_events().iter().any(|e| matches!(e, crate::Event::OpenComp(_))), + "the failed intermediate comp switch is not published to the front end" + ); + } + /// `File.execute()` opens the file as a well-formed `file://` URL (spaces, `#`, `%`). #[test] fn execute_file_opens_an_encoded_file_url() { diff --git a/crates/engine/src/commands/batch.rs b/crates/engine/src/commands/batch.rs index 4bfd2b2b1..03793adbc 100644 --- a/crates/engine/src/commands/batch.rs +++ b/crates/engine/src/commands/batch.rs @@ -75,10 +75,20 @@ fn batch(s: &mut Session, p: &Value) -> Result { Err(e) => { let id = step.get("command").or_else(|| step.get("id")).and_then(Value::as_str).unwrap_or("?"); let note = if atomic { + // The snapshot is the intermediate state the failing step left: comparing it + // with the restored editor detects a restart or cross-comp switch inside the + // batch, so the pre-batch token is never revived. Do not restore + // `ime_revision`: a transient text edit inside the batch already advanced + // this process-monotonic high-water mark, and rewinding it would reuse a + // stamp (letting a wide-selection composition look current). An unrelated + // failed batch did not advance it, so its value stays exactly as it was. + let edited = crate::commands::text_edit::active_editor_snapshot(s); + let interim_revision = s.ime_revision; s.project = project; s.history = history; s.state = state; - s.sanitize_state(); + s.sanitize_after_replacement(edited.as_ref()); + s.ime_revision = s.ime_revision.max(interim_revision); s.bump(); "; the batch was rolled back (nothing changed)".to_string() } else { diff --git a/crates/engine/src/commands/edit.rs b/crates/engine/src/commands/edit.rs index 3630efeee..05015e6b4 100644 --- a/crates/engine/src/commands/edit.rs +++ b/crates/engine/src/commands/edit.rs @@ -227,6 +227,9 @@ fn delete(s: &mut Session, p: &Value) -> Result { st.selected_keys.clear(); Ok(()) })?; + // A removed layer may have been the edited one: end that session before another command + // can reuse it. Undo restores a layer as a new editor, never by reviving the old IME session. + s.sanitize_state(); Ok(json!(ids.len())) } diff --git a/crates/engine/src/commands/layer.rs b/crates/engine/src/commands/layer.rs index 13037c88a..8ff43f32e 100644 --- a/crates/engine/src/commands/layer.rs +++ b/crates/engine/src/commands/layer.rs @@ -200,7 +200,14 @@ fn new_text(s: &mut Session, p: &Value) -> Result { let n = doc.char_len(); let id = insert_layer(proj, st, cid, l)?; if edit { - st.text_edit = Some(super::text_edit::TextEdit { layer: id, anchor: 0, caret: n, created: true, ..Default::default() }); + st.text_edit = Some(super::text_edit::TextEdit { + layer: id, + anchor: 0, + caret: n, + created: true, + session: super::text_edit::next_edit_session(), + ..Default::default() + }); } Ok(id) })?; @@ -1474,6 +1481,9 @@ fn set_text(s: &mut Session, p: &Value) -> Result { } s.bump(); } + // A changed Source Text is handled by `Session::edit`: its boundary clamps the selection and + // starts a new IME epoch only when the CTI document actually changed, so an identical text + // write stays a no-op and keeps the editor's owner. s.edit("Edit Text", merge_p(p), |proj, _| { let l = layer_mut(proj, cid, lid)?; let lt = l.layer_time(t); diff --git a/crates/engine/src/commands/text_edit.rs b/crates/engine/src/commands/text_edit.rs index 9d12e458c..9de40c588 100644 --- a/crates/engine/src/commands/text_edit.rs +++ b/crates/engine/src/commands/text_edit.rs @@ -6,15 +6,58 @@ //! Positions are character indices. The selection is `anchor..caret` (either order). use effectcraft_keyframe::{CharStyle, TextDoc, Value as KV}; -use effectcraft_project::{LayerId, LayerSource}; +use effectcraft_project::{ItemId, LayerId, LayerSource}; use serde::{Deserialize, Serialize}; use serde_json::{Value, json}; +/// Session tokens for the on-canvas editor, unique across the process (so a recreated session +/// never reuses a live IME context). Exhaustion wraps; it cannot panic. +static NEXT_EDIT_SESSION: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(1); + +pub(super) fn next_edit_session() -> u64 { + NEXT_EDIT_SESSION.fetch_add(1, std::sync::atomic::Ordering::Relaxed) +} + +/// Process-global checked high-water allocator for [`crate::Session::ime_revision`] stamps. +/// +/// egui's unavailable-IME receipt identity must be process-monotonic. Allocating the stamp from +/// one process-global counter means neither a second session nor a rollback can reuse a value. +/// The counter fails closed at `u64::MAX`: it returns `None` without wrapping, and callers keep +/// their existing stamp. An unavailable before/after pair then compares equal, so it earns no +/// receipt rather than claiming a mutation with a reused revision. +static NEXT_IME_REVISION: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0); + +pub(crate) fn next_ime_revision() -> Option { + allocate_ime_revision(&NEXT_IME_REVISION) +} + +fn allocate_ime_revision(counter: &std::sync::atomic::AtomicU64) -> Option { + use std::sync::atomic::Ordering::Relaxed; + let mut current = counter.load(Relaxed); + loop { + let next = current.checked_add(1)?; + match counter.compare_exchange_weak(current, next, Relaxed, Relaxed) { + Ok(_) => return Some(next), + Err(observed) => current = observed, + } + } +} + +#[test] +fn ime_revision_allocation_stops_at_exhaustion_without_reusing_a_stamp() { + use std::sync::atomic::{AtomicU64, Ordering::Relaxed}; + let counter = AtomicU64::new(u64::MAX - 1); + assert_eq!(allocate_ime_revision(&counter), Some(u64::MAX)); + assert_eq!(allocate_ime_revision(&counter), None); + assert_eq!(allocate_ime_revision(&counter), None); + assert_eq!(counter.load(Relaxed), u64::MAX); +} + use super::{CommandSpec, b_p, bad, comp_id, layer_mut, resolve_layer, str_p}; use crate::{EditorState, EngineError, Result, Session, cmd}; /// An on-canvas text editing session. -#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] pub struct TextEdit { pub layer: LayerId, pub anchor: usize, @@ -28,6 +71,23 @@ pub struct TextEdit { /// Line position kept by repeated up / down moves (layout space). #[serde(default)] pub goal_x: Option, + /// This editing session's identity. + /// + /// It changes when the editor is started and when its layer or document is replaced, by + /// undo/redo, a history jump, a rollback, or a time change showing another document. A + /// restore that keeps the same composition, layer and byte/style-equal document (an opacity + /// undo while editing) keeps it, so an active IME composition survives an unrelated change. + /// It is deliberately not serialized: a saved token belongs to a previous process and + /// cannot identify a new target. The IME owner uses it as its replacement epoch, so an old + /// composition is never inherited by a recreated layer or a replaced document. + #[serde(skip, default = "next_edit_session")] + pub session: u64, +} + +impl Default for TextEdit { + fn default() -> Self { + Self { layer: LayerId(0), anchor: 0, caret: 0, pending: None, created: false, goal_x: None, session: next_edit_session() } + } } impl TextEdit { @@ -49,6 +109,139 @@ pub fn layer_doc(s: &Session, lid: LayerId) -> Option { } } +/// The largest committed-text window an IME observation copies. +/// +/// This mirrors `egui::output::MAX_IME_SURROUNDING_TEXT_BYTES`: a selection wider than this is +/// reported as unavailable rather than silently truncated. +pub const MAX_IME_TEXT_BYTES: usize = 4000; + +/// The editor's committed-text revision for an IME receipt whose surrounding text is +/// unavailable (a selection wider than [`MAX_IME_TEXT_BYTES`]). +/// +/// Unlike [`Session::revision`], unrelated project edits (an opacity undo) do not advance it, so +/// they cannot make an active composition look stale. +pub fn ime_stamp_revision(s: &Session) -> u64 { + s.ime_revision +} + +/// Bounded committed text around an IME selection, with UTF-8 byte offsets. +/// +/// The Type tool keeps the input method's pre-edit in egui's temporary data, never in the +/// layer's [`TextDoc`], so [`Self::text`] is committed text only. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct ImeSurrounding { + /// At most [`MAX_IME_TEXT_BYTES`] bytes of the edited layer's text. + pub text: String, + /// The caret (primary selection end) as a UTF-8 byte offset in [`Self::text`]. + pub cursor: usize, + /// The other selection end; larger than `cursor` for a reversed selection. + pub anchor: usize, +} + +impl ImeSurrounding { + /// A bounded window of `text` around the selection `cursor`/`anchor`. + /// + /// Returns `None` when an offset is past the text or inside a character, or when the + /// selection itself is wider than [`MAX_IME_TEXT_BYTES`]: the caller then reports + /// surrounding text as unavailable instead of sending a truncated selection. + pub fn from_text(text: &str, cursor: usize, anchor: usize) -> Option { + if cursor > text.len() || anchor > text.len() || !text.is_char_boundary(cursor) || !text.is_char_boundary(anchor) { + return None; + } + let (start, end) = (cursor.min(anchor), cursor.max(anchor)); + let selection = end - start; + if selection > MAX_IME_TEXT_BYTES { + return None; + } + // Spend the remaining budget on both sides of the selection, giving unused room on one + // side to the other. Only this bounded window is copied. + let budget = MAX_IME_TEXT_BYTES - selection; + let mut before = (budget / 2).min(start); + let mut after = (budget - before).min(text.len() - end); + before = (budget - after).min(start); + after = (budget - before).min(text.len() - end); + let mut window_start = start - before; + let mut window_end = end + after; + // Byte budgets can land inside a multi-byte character: shrink the window so it never + // splits one and the selection stays inside it. + while window_start < start && !text.is_char_boundary(window_start) { + window_start += 1; + } + while end < window_end && !text.is_char_boundary(window_end) { + window_end -= 1; + } + Some(Self { + text: text.get(window_start..window_end)?.to_owned(), + cursor: cursor.checked_sub(window_start)?, + anchor: anchor.checked_sub(window_start)?, + }) + } +} + +/// The edited layer's committed text around its selection, or `None` when there is no edit +/// session, the layer is gone, or the selection is wider than [`MAX_IME_TEXT_BYTES`]. +/// +/// The caret and the anchor are converted to UTF-8 byte offsets separately, so a reversed +/// selection stays reversed. A valid empty document is `Some` with empty text, never `None`. +pub fn ime_surrounding(s: &Session) -> Option { + let e = s.state.text_edit.as_ref()?; + let comp = s.active_comp()?; + let layer = comp.layer(e.layer)?; + let prop = layer.props.prop("text/sourceText")?; + // A static Source Text (the normal case) is borrowed in place; only an animated one has to + // be evaluated into a temporary. Either way only the bounded window is copied. + if !prop.is_animated() { + return match &prop.value { + KV::Text(doc) => { + let (caret, anchor) = doc_bytes(doc, e.caret, e.anchor); + ImeSurrounding::from_text(&doc.text, caret, anchor) + } + KV::Str(text) => { + let (caret, anchor) = char_bytes(text, e.caret, e.anchor); + ImeSurrounding::from_text(text, caret, anchor) + } + _ => None, + }; + } + match prop.value_at(layer.layer_time(s.time())) { + KV::Text(doc) => { + let (caret, anchor) = doc_bytes(&doc, e.caret, e.anchor); + ImeSurrounding::from_text(&doc.text, caret, anchor) + } + KV::Str(text) => { + let (caret, anchor) = char_bytes(&text, e.caret, e.anchor); + ImeSurrounding::from_text(&text, caret, anchor) + } + _ => None, + } +} + +/// Byte offsets of two character positions in `text` (clamped to its end), scanning once. +/// +/// The second position may be before the first; the returned pair keeps the caller's order. +fn char_bytes(text: &str, first: usize, second: usize) -> (usize, usize) { + let (lo, hi) = if first <= second { (first, second) } else { (second, first) }; + let mut lo_byte = if lo == 0 { 0 } else { text.len() }; + let mut hi_byte = if hi == 0 { 0 } else { text.len() }; + if hi != 0 { + for (i, (b, _)) in text.char_indices().enumerate() { + if i == lo { + lo_byte = b; + } + if i == hi { + hi_byte = b; + break; + } + } + } + if first <= second { (lo_byte, hi_byte) } else { (hi_byte, lo_byte) } +} + +/// Byte offsets of the editor's caret and anchor in a document, in that order. +fn doc_bytes(doc: &TextDoc, caret: usize, anchor: usize) -> (usize, usize) { + char_bytes(&doc.text, caret, anchor) +} + /// The text layer a text command targets: `layer`, the edited layer, or the selected text layer. fn target(s: &Session, p: &Value, cmd: &str) -> Result { let cid = comp_id(s, p)?; @@ -78,7 +271,7 @@ fn session_on(s: &mut Session, lid: LayerId) -> TextEdit { Some(e) if e.layer == lid => e.clone(), _ => { let n = layer_doc(s, lid).map_or(0, |d| d.char_len()); - let e = TextEdit { layer: lid, anchor: n, caret: n, ..Default::default() }; + let e = TextEdit { layer: lid, anchor: n, caret: n, session: next_edit_session(), ..Default::default() }; s.state.selected_layers = vec![lid]; s.state.text_edit = Some(e.clone()); e @@ -101,7 +294,8 @@ pub(crate) fn edit_doc( ) -> Result<()> { let cid = s.active_comp_id().ok_or(EngineError::NoComp)?; let t = s.time(); - s.edit(label, merge, |proj, st| { + let revision = s.revision; + s.edit_text_doc(label, merge, |proj, st| { let l = layer_mut(proj, cid, lid)?; let lt = l.layer_time(t); let pr = l.props.prop_mut("text/sourceText").ok_or_else(|| bad("text", "not a text layer"))?; @@ -110,16 +304,28 @@ pub(crate) fn edit_doc( KV::Str(t) => TextDoc::plain(&t), _ => TextDoc::default(), }; - let before = first_line_name(&doc.text); + let original = doc.clone(); f(&mut doc, st)?; - let after = first_line_name(&doc.text); - pr.set_value_at(lt, KV::Text(Box::new(doc))); - // Text layers are named after their text until renamed. - if before != after && !after.is_empty() && (l.name == before || l.name.starts_with("Text") || l.name.is_empty()) { - l.name = after; + // A no-op (an IME deletion with nothing around the selection, a set to the value it + // already has) must not turn a static Str into Text or add a keyframe at the CTI: that + // would change the project and record an empty undo step. + if doc != original { + let before = first_line_name(&original.text); + let after = first_line_name(&doc.text); + pr.set_value_at(lt, KV::Text(Box::new(doc))); + // Text layers are named after their text until renamed. + if before != after && !after.is_empty() && (l.name == before || l.name.starts_with("Text") || l.name.is_empty()) { + l.name = after; + } } Ok(()) - }) + })?; + // The editor's unavailable-text receipt identity follows only its own document: an edit to + // another text layer while this editor is open must not cancel the composition. + if s.revision != revision && s.state.text_edit.as_ref().is_some_and(|e| e.layer == lid) { + s.note_text_edit_change(); + } + Ok(()) } fn range_p(p: &Value) -> Option> { @@ -153,7 +359,7 @@ fn edit(s: &mut Session, p: &Value) -> Result { }; let created = b_p(p, "created").unwrap_or(false); s.state.selected_layers = vec![lid]; - s.state.text_edit = Some(TextEdit { layer: lid, anchor, caret, created, ..Default::default() }); + s.state.text_edit = Some(TextEdit { layer: lid, anchor, caret, created, session: next_edit_session(), ..Default::default() }); s.bump(); Ok(state_json(s)) } @@ -314,6 +520,78 @@ fn delete(s: &mut Session, p: &Value) -> Result { Ok(state_json(s)) } +/// How many whole characters `before_bytes` / `after_bytes` cover around `r`. +/// +/// This is the input method's own byte count, as winit reports it: a count that ends inside a +/// UTF-8 character leaves that whole character (stock egui's `surrounding_bytes_to_chars`), so a +/// malformed or platform-specific offset never splits or corrupts the document. +fn surrounding_bytes_as_chars(text: &str, n: usize, r: std::ops::Range, before_bytes: usize, after_bytes: usize) -> (usize, usize) { + let r = r.start.min(n)..r.end.min(n); + let (start_byte, end_byte) = char_bytes(text, r.start, r.end); + let from = start_byte.saturating_sub(before_bytes); + let before = text.get(..start_byte).map_or(0, |head| head.char_indices().rev().take_while(|(i, _)| *i >= from).count()); + let after = text.get(end_byte..).map_or(0, |tail| tail.char_indices().take_while(|(i, c)| i.saturating_add(c.len_utf8()) <= after_bytes).count()); + (before.min(r.start), after.min(n.saturating_sub(r.end))) +} + +/// Delete the text an input method marks for replacement around the selection +/// (`DeleteSurrounding`, `DeleteSurroundingBytes`). +/// +/// Unlike [`delete`] with an explicit range, the **selection stays**: the characters before its +/// start and after its end are removed in two separate ranges, and the following `Commit` +/// replaces the selected text. `bytes` counts UTF-8 bytes (`before`/`after` are characters +/// otherwise); a count that ends inside a character leaves that character. +/// +/// The counts are computed from the one document `edit_doc` already evaluated, so an animated +/// Source Text and a large static document are not copied or evaluated again just to decide what +/// the input method asked to replace. +fn delete_surrounding(s: &mut Session, p: &Value) -> Result { + let lid = target(s, p, "text.deleteSurrounding")?; + // Only an open edit session has a selection to keep: without one there is nothing an input + // method could be replacing. + let e = match &s.state.text_edit { + Some(e) if e.layer == lid => e.clone(), + _ => return Err(bad("text.deleteSurrounding", "not editing this text layer")), + }; + let count = |k: &str| p.get(k).and_then(Value::as_u64).map_or(0, |v| usize::try_from(v).unwrap_or(usize::MAX)); + let (before_count, after_count) = (count("before"), count("after")); + let bytes = b_p(p, "bytes").unwrap_or(false); + let merge = str_p(p, "merge").map(str::to_string); + edit_doc(s, "Edit Text", merge.as_deref(), lid, |doc, st| { + let n = doc.char_len(); + let r = e.range().start.min(n)..e.range().end.min(n); + let (before, after) = if bytes { + surrounding_bytes_as_chars(&doc.text, n, r.clone(), before_count, after_count) + } else { + (before_count.min(r.start), after_count.min(n.saturating_sub(r.end))) + }; + let start = r.start.saturating_sub(before); + let end = r.end.saturating_add(after).min(n); + if start == r.start && end == r.end { + // Deletion-only batches with an empty count, or a document with nothing around the + // selection: no empty undo step. + return Ok(()); + } + // The selection keeps its text: remove after it first, then before it, so the two ranges + // stay valid and the caret/selection shift by the characters before it. + if end > r.end { + doc.replace_range(r.end..end, "", None); + } + if r.start > start { + doc.replace_range(start..r.start, "", None); + } + if let Some(ed) = st.text_edit.as_mut().filter(|ed| ed.layer == lid) { + let shift = r.start.saturating_sub(start); + ed.anchor = ed.anchor.saturating_sub(shift); + ed.caret = ed.caret.saturating_sub(shift); + ed.pending = None; + ed.goal_x = None; + } + Ok(()) + })?; + Ok(state_json(s)) +} + /// Selected text (plain) of the session, and its formatted fragment. fn selection_doc(s: &Session) -> Option { let e = s.state.text_edit.as_ref()?; @@ -448,16 +726,111 @@ fn paste_formatting(s: &mut Session, p: &Value) -> Result { Ok(state_json(s)) } -/// Keep the session valid after undo / external edits: clamp the selection, drop it when the +/// Give the current editor a fresh replacement epoch after its document/layer was replaced. +pub(crate) fn invalidate_session(s: &mut Session) { + let replaced = s.state.text_edit.is_some(); + if let Some(e) = s.state.text_edit.as_mut() { + e.session = next_edit_session(); + } + if replaced { + s.note_text_edit_change(); + } +} + +/// Clamp the editor selection and give it a fresh IME epoch after its document was replaced. +/// +/// This is the one replacement path for document changes outside `edit_doc`: +/// [`crate::Session::edit`] calls [`after_external_change`] after every edit, [`crate::Session::set_time`] +/// and [`crate::Session::sync_related_times`] call it after moving the CTI, and +/// [`crate::Session::sanitize_after_replacement`] calls it with the editor document snapshotted +/// before a history restore or rollback. +/// Clamping first means a shortened document leaves the caret in range, so the next Backspace +/// deletes instead of being swallowed by an out-of-range selection. +pub(crate) fn document_replaced(s: &mut Session) { + sanitize(s); + invalidate_session(s); +} + +/// The identity and document of the active on-canvas editor at one moment. +/// +/// The composition and the editor session are part of the identity: a restoration must not keep +/// a composition alive when the snapshot came from another comp, or from an intermediate editor +/// that was restarted during the operation being rolled back. +#[derive(Clone, Debug, PartialEq)] +pub struct EditorSnapshot { + /// The composition the editor was attached to. + pub comp: ItemId, + /// The edited layer. + pub layer: LayerId, + /// The editor session token, unique across the process. + pub session: u64, + /// The Source Text the editor was showing. + pub doc: TextDoc, +} + +/// The identity and document the active on-canvas editor is showing. +/// +/// [`crate::Session::edit`] and the time setters snapshot this before a change and compare it +/// afterwards: only a change that actually replaces this document starts a new epoch, while a +/// write to another property, layer or composition, a move to a time showing the same text, or a +/// write that leaves the text as it was, keeps the editor's owner. With no editor open this is a +/// single `Option` check, with no document copy. +pub fn active_editor_snapshot(s: &Session) -> Option { + let e = s.state.text_edit.as_ref()?; + Some(EditorSnapshot { comp: s.active_comp_id()?, layer: e.layer, session: e.session, doc: layer_doc(s, e.layer)? }) +} + +/// Finish an edit outside the editor: if it replaced the document the editor owned, clamp the +/// selection and start a new IME epoch. +/// +/// An edit that itself moves or closes the editor owns the resulting session, so an identity +/// mismatch is not a replacement here. +pub(crate) fn after_external_change(s: &mut Session, before: Option<&EditorSnapshot>) { + let Some(before) = before else { return }; + let Some(e) = s.state.text_edit.as_ref() else { return }; + if s.state.active_comp != Some(before.comp) || e.layer != before.layer || e.session != before.session { + return; + } + if layer_doc(s, before.layer).as_ref() != Some(&before.doc) { + document_replaced(s); + } +} + +/// Finish a project-state replacement (undo, redo, a history jump, a rollback): keep the editor +/// only when the restored state still has the same composition, layer and editor session and +/// shows byte/style-equal text. +/// +/// The restored session token is the one saved in the replaced state, so an intermediate +/// restart or cross-comp switch must be detected against the snapshot instead of being assumed +/// to be the editor's own change. +pub(crate) fn after_replacement(s: &mut Session, before: Option<&EditorSnapshot>) { + let Some(before) = before else { + // No editor was open when the snapshot was taken: a restored editor must not inherit a + // composition from the state the replacement replaced. + if s.state.text_edit.is_some() { + document_replaced(s); + } + return; + }; + let same = s.state.text_edit.as_ref().is_some_and(|e| s.state.active_comp == Some(before.comp) && e.layer == before.layer && e.session == before.session); + if !same || layer_doc(s, before.layer).as_ref() != Some(&before.doc) { + document_replaced(s); + } +} + +/// Keep the session valid after routine state cleanup: clamp the selection, drop it when the /// layer is gone or not in the active comp. +/// +/// This is also called after project-item cleanup that leaves the edited document alone, so it +/// must not advance [`TextEdit::session`]: that would make the viewer treat unrelated cleanup as +/// a document replacement and interrupt the active IME composition. Replacement paths call +/// [`document_replaced`] instead. pub(crate) fn sanitize(s: &mut Session) { let Some(e) = s.state.text_edit.clone() else { return }; match layer_doc(s, e.layer) { Some(d) => { let n = d.char_len(); - if (e.anchor > n || e.caret > n) - && let Some(ed) = s.state.text_edit.as_mut() - { + if let Some(ed) = s.state.text_edit.as_mut() { ed.anchor = ed.anchor.min(n); ed.caret = ed.caret.min(n); } @@ -594,6 +967,15 @@ pub fn specs() -> Vec { editing_or_text_layer, delete ), + cmd!( + "text.deleteSurrounding", + "Delete Text Around Selection", + [], + None, + "{layer?, before?, after?, bytes?, merge?} (input-method replacement: the characters before and after the selection are deleted, the selection stays; bytes counts UTF-8 bytes)", + editing_or_text_layer, + delete_surrounding + ), cmd!( "edit.pasteTextMatchFormatting", "Paste Text and Match Formatting", diff --git a/crates/engine/src/history.rs b/crates/engine/src/history.rs index 8b178a05c..d9577285b 100644 --- a/crates/engine/src/history.rs +++ b/crates/engine/src/history.rs @@ -341,13 +341,14 @@ impl Session { let k = new_line.iter().position(|&i| i == target).unwrap_or(0); let undo: Vec<(String, Arc)> = (0..k).map(|i| (a.label[new_line[i + 1]].clone(), a.state[new_line[i]].clone())).collect(); let redo: Vec<(String, Arc)> = new_line[k + 1..].iter().rev().map(|&i| (a.label[i].clone(), a.state[i].clone())).collect(); + let edited = crate::commands::text_edit::active_editor_snapshot(self); let cur = std::mem::replace(&mut self.project, a.state[target].clone()); self.keep_view_settings(&cur); self.history.undo = undo; self.history.redo = redo; self.history.branches = branches; self.history.merge_key = None; - self.sanitize_state(); + self.sanitize_after_replacement(edited.as_ref()); self.bump(); true } diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index 382534a44..83024dd81 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -394,6 +394,15 @@ pub struct Session { pub project: Arc, pub history: History, pub revision: u64, + /// Process-unique monotonic revision of the on-canvas editor's committed text and session. + /// Unlike [`Session::revision`], unrelated project edits do not advance it; the IME receipt + /// uses it when surrounding text is unavailable. Read it with + /// [`commands::text_edit::ime_stamp_revision`]. + /// + /// Stamps come from a process-global checked allocator and are never rewound: a failed + /// atomic batch keeps the highest intermediate stamp. On allocator exhaustion no stamp is + /// issued, so an unavailable receipt cannot be accepted with a reused revision. + pub ime_revision: u64, pub saved_revision: u64, /// The project as last opened or saved: the project is unmodified while it is this very /// snapshot, so undoing back to the saved state clears the modified mark. @@ -562,6 +571,8 @@ impl Default for Session { project, history: History::default(), revision: 0, + // A fresh session gets its own process-monotonic stamp even before its first edit. + ime_revision: commands::text_edit::next_ime_revision().unwrap_or(u64::MAX), saved_revision: 0, path: None, state: EditorState { snapping: true, view_layout: 1, ..Default::default() }, @@ -686,7 +697,25 @@ impl Session { } /// Apply an undoable edit. `merge`: consecutive edits with the same key fold into one step. + /// + /// Every edit is an external boundary for the on-canvas text editor: if it replaced the + /// document the editor is showing, the selection is clamped and the editor gets a fresh IME + /// epoch. The editor's own typing goes through `edit_text_doc`, which owns that + /// document and must not treat its own keystrokes as a replacement. pub fn edit(&mut self, label: &str, merge: Option<&str>, f: impl FnOnce(&mut Project, &mut EditorState) -> Result) -> Result { + let edited = commands::text_edit::active_editor_snapshot(self); + let out = self.edit_inner(label, merge, f)?; + commands::text_edit::after_external_change(self, edited.as_ref()); + Ok(out) + } + + /// [`Session::edit`] for the on-canvas editor's own text changes. Its document is the one + /// the editor owns, so a change here is typing, not a replacement behind the IME's back. + pub(crate) fn edit_text_doc(&mut self, label: &str, merge: Option<&str>, f: impl FnOnce(&mut Project, &mut EditorState) -> Result) -> Result { + self.edit_inner(label, merge, f) + } + + fn edit_inner(&mut self, label: &str, merge: Option<&str>, f: impl FnOnce(&mut Project, &mut EditorState) -> Result) -> Result { let before = self.project.clone(); let mut p = (*self.project).clone(); let mut st = self.state.clone(); @@ -733,6 +762,19 @@ impl Session { Ok(r) } + /// Note a change to the on-canvas editor's committed text or session. + /// + /// Frontends compare this with [`commands::text_edit::ime_stamp_revision`]; an unrelated + /// project change must not advance it. + pub(crate) fn note_text_edit_change(&mut self) { + // Checked process-wide allocation: a stamp is never wrapped or reused. On exhaustion + // keep the previous value; an unavailable before/after pair then compares equal and + // earns no receipt instead of accepting a stale revision. + if let Some(revision) = commands::text_edit::next_ime_revision() { + self.ime_revision = self.ime_revision.max(revision); + } + } + pub fn bump(&mut self) { self.revision += 1; // Back at the saved state (undo, redo, a history jump or a rolled-back batch). @@ -805,26 +847,48 @@ impl Session { pub fn undo(&mut self) -> bool { let Some((label, p)) = self.history.undo.pop() else { return false }; + let edited = commands::text_edit::active_editor_snapshot(self); let cur = std::mem::replace(&mut self.project, p); self.keep_view_settings(&cur); self.history.redo.push((label, cur)); self.history.merge_key = None; - self.sanitize_state(); + self.sanitize_after_replacement(edited.as_ref()); self.bump(); true } pub fn redo(&mut self) -> bool { let Some((label, p)) = self.history.redo.pop() else { return false }; + let edited = commands::text_edit::active_editor_snapshot(self); let cur = std::mem::replace(&mut self.project, p); self.keep_view_settings(&cur); self.history.undo.push((label, cur)); self.history.merge_key = None; - self.sanitize_state(); + self.sanitize_after_replacement(edited.as_ref()); self.bump(); true } + /// Keep selections valid after the project was replaced by another state (undo, redo, a + /// history jump, a rollback): the same layer id can name a different document, so the + /// on-canvas editor gets a fresh IME epoch only when its own document changed. + /// + /// Normally `before` is [`commands::text_edit::active_editor_snapshot`] taken from the + /// state this call is about to replace. Atomic batch rollback is the exception: it has + /// already restored the pre-batch state and passes the snapshot of the failing intermediate + /// state, so a transient restart or component switch inside the batch still rejects reviving + /// the old composition. A restored state that still has the same composition, layer and + /// editor session and shows byte/style-equivalent text (an opacity or other property undo) + /// keeps the editor's owner and selection; a different document, comp, layer or session clamps the + /// selection and starts a new epoch. A closed editor stays closed, and a fallback comp's + /// matching layer id never inherits the old comp's session. `None` means no editor was open + /// when the snapshot was taken; if one is open after the replacement it is treated as an + /// unverified document replacement, so it never inherits an old composition. + pub fn sanitize_after_replacement(&mut self, before: Option<&commands::text_edit::EditorSnapshot>) { + self.sanitize_state(); + commands::text_edit::after_replacement(self, before); + } + /// Drop selections that no longer exist. Each comp keeps its own selection (#1001); a layer id /// counts only inside the comp that owns it, so the active comp never sees another comp's layers. pub fn sanitize_state(&mut self) { @@ -841,6 +905,8 @@ impl Session { }); if self.state.active_comp.is_some_and(|c| p.comp(c).is_none()) { self.clear_live_selection(); + // A matching layer id in the fallback comp is not the document being edited. + self.state.text_edit = None; self.state.active_comp = self.state.open_comps.first().copied(); if let Some(id) = self.state.active_comp { self.recall_selection(id); @@ -900,13 +966,22 @@ impl Session { self.state.active_comp.and_then(|c| self.state.times.get(&c).copied()).unwrap_or(Tick::ZERO) } + /// Move the active comp's current time. + /// + /// Time is an external boundary for the on-canvas text editor too: an animated Source Text + /// can show a different document at another time. The document is snapshotted only while an + /// editor is open, so playback with no text editor does no text copying. pub fn set_time(&mut self, t: Tick) { if let Some(c) = self.state.active_comp { let t = self.project.comp(c).map_or(t, |comp| comp_frame_at(comp, t)); + let edited = commands::text_edit::active_editor_snapshot(self); self.state.times.insert(c, t); if self.prefs.general.sync_time_related_items { - self.sync_related_times(c, t); + // Direct call: this `set_time` owns the editor snapshot for both time changes, + // so a synced move does not take a second snapshot or start a second epoch. + self.sync_related_times_inner(c, t); } + commands::text_edit::after_external_change(self, edited.as_ref()); } } @@ -914,6 +989,14 @@ impl Session { /// `comp` moves the current time of the comps nested in it (through their precomp layers' /// timing) and of the comps it is nested in, so every related viewer shows the same moment. pub fn sync_related_times(&mut self, comp: ItemId, t: Tick) { + // Moving a related comp can move the active one, so the editor's document is checked + // here too; the snapshot is skipped entirely when no text editor is open. + let edited = commands::text_edit::active_editor_snapshot(self); + self.sync_related_times_inner(comp, t); + commands::text_edit::after_external_change(self, edited.as_ref()); + } + + fn sync_related_times_inner(&mut self, comp: ItemId, t: Tick) { let mut seen = std::collections::BTreeSet::from([comp]); let mut todo = vec![(comp, t)]; let mut found = vec![]; @@ -957,6 +1040,9 @@ impl Session { self.state.active_comp = Some(id); self.recall_selection(id); self.state.current_track = None; + // A text-edit session belongs to the comp that owned it. Switching comps ends it; even + // a same-numbered layer in the new comp must not inherit the old IME composition. + self.state.text_edit = None; } /// Leave no comp active, keeping the one that was active in [`EditorState::comp_selections`]. @@ -965,6 +1051,7 @@ impl Session { self.state.active_comp = None; self.clear_live_selection(); self.state.current_track = None; + self.state.text_edit = None; } fn remember_selection(&mut self) { diff --git a/crates/engine/src/tests_text_edit.rs b/crates/engine/src/tests_text_edit.rs index b4d2ff8c0..9e0fbcf97 100644 --- a/crates/engine/src/tests_text_edit.rs +++ b/crates/engine/src/tests_text_edit.rs @@ -6,7 +6,7 @@ use effectcraft_keyframe::{BaselineOption, Justify, Kerning, TextDoc}; use serde_json::json; use crate::Session; -use crate::commands::text_edit::layer_doc; +use crate::commands::text_edit::{MAX_IME_TEXT_BYTES, ime_stamp_revision, ime_surrounding, layer_doc}; fn session(text: &str) -> (Session, u64) { let mut s = Session::default(); @@ -24,6 +24,98 @@ fn sel(s: &Session) -> (usize, usize) { (e.anchor, e.caret) } +/// Start editing the text layer with everything selected (no caret given). +fn begin_edit(s: &mut Session, t: u64) { + s.execute("text.edit", json!({"layer": t})).unwrap(); +} + +/// Start editing the text layer with the caret at `caret`. +fn begin_edit_at(s: &mut Session, t: u64, caret: usize) { + s.execute("text.edit", json!({"layer": t, "caret": caret})).unwrap(); +} + +/// A session with one text layer already open in the editor at `caret`. +fn editing(text: &str, caret: usize) -> (Session, u64) { + let (mut s, t) = session(text); + begin_edit_at(&mut s, t, caret); + (s, t) +} + +/// A session with one text layer already open in the editor with everything selected. +fn editing_all(text: &str) -> (Session, u64) { + let (mut s, t) = session(text); + begin_edit(&mut s, t); + (s, t) +} + +/// The IME owner token of the open editor. +fn ime_owner(s: &Session) -> u64 { + s.state.text_edit.as_ref().unwrap().session +} + +fn undo_steps(s: &Session) -> usize { + s.history.undo.len() +} + +/// The editor kept its document (same IME owner). +fn assert_ime_owner(s: &Session, expected: u64, why: &str) { + assert_eq!(ime_owner(s), expected, "{why}"); +} + +/// The editor's document was replaced (new IME owner/epoch). +fn assert_ime_epoch_changed(s: &Session, previous: u64, why: &str) { + assert_ne!(ime_owner(s), previous, "{why}"); +} + +fn assert_text(s: &Session, t: u64, expected: &str) { + assert_eq!(doc(s, t).text, expected); +} + +/// A new, empty composition called "Other" (the standard second comp). +fn new_other_comp(s: &mut Session) -> u64 { + s.execute("comp.new", json!({"name": "Other", "width": 320, "height": 180, "duration": 2})).unwrap()["comp"].as_u64().unwrap() +} + +/// Stopwatch the layer's Source Text (one key at the CTI). +fn animate_source(s: &mut Session, t: u64) { + s.execute("prop.toggleAnimation", json!({"layer": t, "path": "text/sourceText"})).unwrap(); +} + +/// Add a Source Text key at `time`. +fn add_source_key(s: &mut Session, t: u64, time: f64, value: &str) { + s.execute("prop.addKey", json!({"layer": t, "path": "text/sourceText", "time": time, "value": value})).unwrap(); +} + +/// Write Source Text as a static value (a replacement when it differs from the shown text). +fn set_source(s: &mut Session, t: u64, value: &str) { + s.execute("prop.set", json!({"layer": t, "path": "text/sourceText", "value": value})).unwrap(); +} + +/// Write the Source Text key at `time`. +fn set_source_key(s: &mut Session, t: u64, time: f64, value: &str) { + s.execute("prop.set", json!({"layer": t, "path": "text/sourceText", "time": time, "value": value})).unwrap(); +} + +/// Set the Source Text key at the CTI (`keys.set`). +fn set_source_cti_key(s: &mut Session, t: u64, time: f64, value: &str) { + s.execute("keys.set", json!({"layer": t, "path": "text/sourceText", "time": time, "value": value})).unwrap(); +} + +/// Replace the whole Source Text of the layer (`layer.setText`). +fn replace_text(s: &mut Session, t: u64, text: &str) { + s.execute("layer.setText", json!({"layer": t, "text": text})).unwrap(); +} + +/// Select the character range `start..end` in the open editor. +fn select(s: &mut Session, start: usize, end: usize) { + s.execute("text.setSelection", json!({"start": start, "end": end})).unwrap(); +} + +/// Set both selection ends, keeping their direction (`anchor` is the other end). +fn select_anchor(s: &mut Session, anchor: usize, caret: usize) { + s.execute("text.setSelection", json!({"anchor": anchor, "caret": caret})).unwrap(); +} + #[test] fn set_text_with_a_range_creates_runs_and_undoes() { let (mut s, t) = session("Hello World"); @@ -200,7 +292,573 @@ fn edit_state_round_trips_through_serde() { s.execute("text.edit", json!({"layer": t, "select": [1, 2]})).unwrap(); let j = serde_json::to_value(&s.state).unwrap(); let back: crate::EditorState = serde_json::from_value(j).unwrap(); - assert_eq!(back.text_edit, s.state.text_edit); + let before = s.state.text_edit.clone().expect("editing"); + let after = back.text_edit.clone().expect("editing"); + assert_eq!((after.layer, after.anchor, after.caret), (before.layer, before.anchor, before.caret)); + assert_ne!(after.session, before.session, "a restored editor gets a process-unique replacement epoch"); + assert_ne!(after.session, 0, "the restored epoch is always a real session token"); +} + +#[test] +fn ime_session_epoch_tracks_replaced_text_and_layer_restoration() { + let (mut s, t) = editing_all("abc"); + let first = ime_owner(&s); + + // Replacing Source Text is a new document even though the layer id stays. + replace_text(&mut s, t, "replaced"); + let replaced = ime_owner(&s); + assert_ne!(replaced, first, "layer.setText starts a new IME epoch"); + + // Undo restores another document: it must not revive the token from before either edit. + s.execute("edit.undo", json!({})).unwrap(); + let undone = ime_owner(&s); + assert_ne!(undone, replaced); + assert_ne!(undone, first); + + // Clear + immediate undo in the same command sequence: the layer is gone long enough to + // end the session, and the restored layer cannot inherit a composition. + begin_edit(&mut s, t); + s.execute("edit.clear", json!({"layers": [t]})).unwrap(); + assert!(s.state.text_edit.is_none(), "clearing the edited layer ends the session"); + s.execute("edit.undo", json!({})).unwrap(); + assert!(s.state.text_edit.is_none(), "undo does not recreate the old composition session"); + begin_edit(&mut s, t); + assert_ne!(ime_owner(&s), first); +} + +#[test] +fn no_op_ime_deletion_keeps_a_static_plain_text_value_and_records_no_step() { + use effectcraft_keyframe::Value as KV; + let (mut s, t) = session("abc"); + // Legacy/imported text can still be stored as a plain Str rather than a TextDoc. + let cid = s.active_comp_id().unwrap(); + let pr = std::sync::Arc::make_mut(&mut s.project) + .comp_mut(cid) + .unwrap() + .layer_mut(effectcraft_project::LayerId(t)) + .unwrap() + .props + .prop_mut("text/sourceText") + .unwrap(); + pr.value = KV::Str("abc".into()); + begin_edit_at(&mut s, t, 0); + let steps = undo_steps(&s); + + // A non-zero before count at the document start deletes nothing. + s.execute("text.deleteSurrounding", json!({"before": 1, "after": 0})).unwrap(); + + let pr = s.active_comp().unwrap().layer(effectcraft_project::LayerId(t)).unwrap().props.prop("text/sourceText").unwrap(); + assert!(matches!(&pr.value, KV::Str(_)), "a no-op keeps the static Str variant"); + assert!(pr.keys.is_empty()); + assert_eq!(undo_steps(&s), steps, "a no-op adds no undo step"); +} + +#[test] +fn no_op_ime_deletion_does_not_add_a_keyframe_to_animated_source_text() { + let (mut s, t) = editing("abc", 0); + animate_source(&mut s, t); + let lid = effectcraft_project::LayerId(t); + let keys = |s: &Session| s.active_comp().unwrap().layer(lid).unwrap().props.prop("text/sourceText").unwrap().keys.len(); + assert_eq!(keys(&s), 1, "one key from the stopwatch"); + s.execute("time.set", json!({"time": 1.0})).unwrap(); + let steps = undo_steps(&s); + + // A non-zero before count at the document start deletes nothing, at a time with no key. + s.execute("text.deleteSurrounding", json!({"before": 1, "after": 0})).unwrap(); + + assert_eq!(keys(&s), 1, "a no-op does not key Source Text at the CTI"); + assert_eq!(undo_steps(&s), steps, "a no-op adds no undo step"); +} + +#[test] +fn property_writes_replace_the_edited_document_only_when_the_text_changes() { + let (mut s, t) = session("abc"); + let other = s.execute("layer.newText", json!({"text": "other"})).unwrap()["layer"].as_u64().unwrap(); + begin_edit_at(&mut s, t, 1); + let owner = ime_owner(&s); + let steps = undo_steps(&s); + + // Writing the text the document already has is a no-op: same document, same owner, no step. + set_source(&mut s, t, "abc"); + assert_ime_owner(&s, owner, "a no-op write keeps the IME owner"); + assert_eq!(undo_steps(&s), steps, "a no-op write records no undo step"); + replace_text(&mut s, t, "abc"); + assert_ime_owner(&s, owner, "a no-op layer.setText keeps the IME owner"); + assert_eq!(undo_steps(&s), steps, "a no-op layer.setText records no undo step"); + + // Another property of the edited layer leaves its document alone. + s.execute("prop.set", json!({"layer": t, "path": "transform/opacity", "value": 50})).unwrap(); + assert_ime_owner(&s, owner, "an unrelated property keeps the IME owner"); + + // Source Text of another layer is not the editor's document either. + set_source(&mut s, other, "changed"); + assert_ime_owner(&s, owner, "another layer's text keeps the IME owner"); + + // Replacing the edited layer's Source Text is a document replacement: a new IME epoch. + set_source(&mut s, t, "replaced"); + assert_text(&s, t, "replaced"); + assert_ime_epoch_changed(&s, owner, "replacing the document changes the IME owner"); +} + +#[test] +fn undo_and_redo_of_an_unrelated_property_keep_the_ime_owner_and_selection() { + let (mut s, t) = editing("abcdef", 3); + let owner = ime_owner(&s); + + s.execute("prop.set", json!({"layer": t, "path": "transform/opacity", "value": 50})).unwrap(); + assert_ime_owner(&s, owner, "the opacity write keeps the owner"); + assert_eq!(sel(&s), (3, 3), "the opacity write keeps the selection"); + + // The opacity step does not change Source Text: restoring it keeps the same editor. + s.execute("edit.undo", json!({})).unwrap(); + assert_ime_owner(&s, owner, "undoing only opacity keeps the owner"); + assert_eq!(sel(&s), (3, 3), "undoing only opacity keeps the selection"); + + s.execute("edit.redo", json!({})).unwrap(); + assert_ime_owner(&s, owner, "redoing only opacity keeps the owner"); + assert_eq!(sel(&s), (3, 3), "redoing only opacity keeps the selection"); +} + +#[test] +fn a_style_only_text_change_and_its_undo_replace_the_editor_epoch() { + let (mut s, t) = editing("abcdef", 3); + let owner = ime_owner(&s); + + // The same characters with another run style are still a different document. + s.execute("layer.setText", json!({"layer": t, "range": [1, 4], "size": 12})).unwrap(); + assert_eq!(doc(&s, t).text, "abcdef"); + assert_eq!(doc(&s, t).style_at(2).size, 12.0); + assert_ime_epoch_changed(&s, owner, "a style-only change starts a new IME epoch"); + assert_eq!(sel(&s), (3, 3), "a same-length style change keeps the caret in range"); + let styled = ime_owner(&s); + + s.execute("edit.undo", json!({})).unwrap(); + assert_eq!(doc(&s, t).style_at(2).size, 60.0); + assert_ime_epoch_changed(&s, styled, "undoing a style change starts a new IME epoch"); +} + +#[test] +fn history_jumps_keep_the_owner_over_unrelated_steps_and_replace_it_when_the_text_changes() { + let (mut s, t) = editing("abcdef", 3); + let owner = ime_owner(&s); + s.execute("prop.set", json!({"layer": t, "path": "transform/opacity", "value": 50})).unwrap(); + s.execute("prop.set", json!({"layer": t, "path": "transform/opacity", "value": 25})).unwrap(); + let states = s.execute("edit.history.list", json!({})).unwrap()["states"].as_array().unwrap().clone(); + let cur = states.iter().find(|n| n["current"] == true).unwrap()["index"].as_u64().unwrap(); + let parent = states.iter().find(|n| n["index"].as_u64() == Some(cur)).unwrap()["parent"].as_u64().unwrap(); + + // Both states show the same Source Text: jumping between them keeps the editor. + s.execute("edit.history.goto", json!({"index": parent})).unwrap(); + assert_ime_owner(&s, owner, "jumping to another opacity state keeps the owner"); + assert_eq!(sel(&s), (3, 3), "and the selection"); + s.execute("edit.history.goto", json!({"index": cur})).unwrap(); + assert_ime_owner(&s, owner, "jumping back keeps the owner"); + assert_eq!(sel(&s), (3, 3), "and the selection"); + + // A history state whose Source Text differs is a document replacement. + set_source(&mut s, t, "abc"); + let changed = ime_owner(&s); + assert_ne!(changed, owner); + s.execute("edit.history.goto", json!({"index": parent})).unwrap(); + assert_text(&s, t, "abcdef"); + assert_ime_epoch_changed(&s, changed, "jumping to a different document starts a new epoch"); +} + +#[test] +fn atomic_batch_rollback_keeps_the_owner_for_unrelated_steps_and_replaces_it_for_text_changes() { + let (mut s, t) = editing("abcdef", 3); + let owner = ime_owner(&s); + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "prop.set", "params": {"layer": t, "path": "transform/opacity", "value": 50}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert_ime_owner(&s, owner, "rolling back an unrelated step keeps the owner"); + assert_eq!(sel(&s), (3, 3), "and the selection"); + + // A partially applied text replacement was still shown before the rollback restores the + // original document, so the editor must not revive the composition it had before the batch. + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "layer.setText", "params": {"layer": t, "text": "ab"}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert_text(&s, t, "abcdef"); + assert_ime_epoch_changed(&s, owner, "a rolled-back text change does not revive the old owner"); + assert_eq!(sel(&s), (3, 3), "the restored document keeps the caret in range"); +} + +#[test] +fn atomic_batch_rollback_after_a_transient_editor_restart_bumps_the_epoch() { + let (mut s, t) = editing("abcdef", 3); + let owner = ime_owner(&s); + + // `text.edit` restarts the session even on the layer that is already edited. The rollback + // restores the pre-batch TextEdit (with the old token), so the intermediate restart must be + // detected from the snapshot: neither the old composition nor its token may be revived. + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "text.edit", "params": {"layer": t, "caret": 1}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert_eq!(sel(&s), (3, 3), "the restored selection is the pre-batch one"); + assert_ime_epoch_changed(&s, owner, "a canceled intermediate editor must not revive the old token"); +} + +#[test] +fn atomic_batch_rollback_after_a_cross_comp_editor_switch_bumps_the_epoch() { + let (mut s, t) = session("abcdef"); + let original = s.active_comp_id().unwrap(); + // Give the other comp a layer with the same id and the same Source Text, so only the comp + // and editor-session identity distinguishes the two editors. + let layer = s.active_comp().unwrap().layer(effectcraft_project::LayerId(t)).unwrap().clone(); + let other = new_other_comp(&mut s); + let other_id = effectcraft_project::ItemId(other); + std::sync::Arc::make_mut(&mut s.project).comp_mut(other_id).unwrap().layers.push(layer); + s.execute("comp.open", json!({"comp": original.0})).unwrap(); + begin_edit_at(&mut s, t, 3); + let owner = ime_owner(&s); + + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "comp.open", "params": {"comp": other}}, + {"command": "text.edit", "params": {"layer": t, "caret": 1}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert_eq!(s.active_comp_id(), Some(original), "the batch restored the original comp"); + assert_eq!(sel(&s), (3, 3), "and the pre-batch selection"); + assert_ime_epoch_changed(&s, owner, "an identical layer in another comp must not revive the old token"); +} + +#[test] +fn atomic_batch_rollback_after_closing_the_editor_does_not_revive_it() { + let (mut s, t) = session("abcdef"); + let original = s.active_comp_id().unwrap(); + let other = new_other_comp(&mut s); + s.execute("comp.open", json!({"comp": original.0})).unwrap(); + begin_edit_at(&mut s, t, 3); + let owner = ime_owner(&s); + + // The failing state has no editor at all: the restoration brings the pre-batch one back and + // must treat it as unverified rather than revive its composition. + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "comp.open", "params": {"comp": other}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert!(s.state.text_edit.is_some(), "the batch restored the editor state"); + assert_eq!(sel(&s), (3, 3)); + assert_ime_epoch_changed(&s, owner, "a canceled editor close must not revive the old token"); +} + +#[test] +fn restoring_without_an_editor_snapshot_replaces_an_open_editor() { + let (mut s, _) = editing("abcdef", 3); + let owner = ime_owner(&s); + + // `None` means no editor was open when the state was replaced; an editor that is open + // afterwards cannot prove it kept its document. + s.sanitize_after_replacement(None); + assert_ime_epoch_changed(&s, owner, "an unverified restored editor starts a new epoch"); + assert_eq!(sel(&s), (3, 3)); +} + +#[test] +fn undo_to_a_shorter_document_clamps_the_caret() { + let (mut s, t) = editing("abc", 3); + replace_text(&mut s, t, "abcdef"); + select_anchor(&mut s, 6, 6); + let owner = ime_owner(&s); + assert_eq!(sel(&s), (6, 6)); + + s.execute("edit.undo", json!({})).unwrap(); + assert_text(&s, t, "abc"); + assert_eq!(sel(&s), (3, 3), "undoing to a shorter document clamps the caret"); + assert_ime_epoch_changed(&s, owner, "and starts a new epoch"); +} + +#[test] +fn the_ime_stamp_revision_follows_the_editor_not_unrelated_project_edits() { + let (mut s, t) = editing("abcdef", 6); + let revision = ime_stamp_revision(&s); + + s.execute("prop.set", json!({"layer": t, "path": "transform/opacity", "value": 50})).unwrap(); + assert_eq!(ime_stamp_revision(&s), revision, "an unrelated property write does not advance it"); + s.execute("edit.undo", json!({})).unwrap(); + assert_eq!(ime_stamp_revision(&s), revision, "undoing it does not either"); + + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "prop.set", "params": {"layer": t, "path": "transform/opacity", "value": 25}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert_eq!(ime_stamp_revision(&s), revision, "a rolled-back unrelated batch restores it"); + + s.execute("text.insert", json!({"text": "x"})).unwrap(); + assert!(ime_stamp_revision(&s) > revision, "typing advances it"); + let typed = ime_stamp_revision(&s); + s.execute("layer.setText", json!({"layer": t, "text": "y"})).unwrap(); + assert!(ime_stamp_revision(&s) > typed, "a replaced document advances it too"); +} + +#[test] +fn a_failed_atomic_batch_with_a_transient_edit_keeps_its_high_water_ime_revision() { + let (mut s, t) = editing("abcdef", 6); + let revision = ime_stamp_revision(&s); + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "text.insert", "params": {"text": "x"}}, + {"command": "text.delete", "params": {}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert_text(&s, t, "abcdef"); + // The intermediate document edit is real even though the final document equals the + // pre-batch one: its stamp must remain the high-water mark. + assert!(ime_stamp_revision(&s) > revision, "a transient edit must not rewind the IME revision"); + let after_transient = ime_stamp_revision(&s); + + // An unrelated failed batch really did not edit the document: it must preserve the revision + // exactly, or every wide-selection composition would be canceled by unrelated work. + let r = s.execute( + "engine.batch", + json!({"atomic": true, "steps": [ + {"command": "prop.set", "params": {"layer": t, "path": "transform/opacity", "value": 25}}, + {"command": "no.suchCommand", "params": {}} + ]}), + ); + assert!(r.is_err()); + assert_eq!(ime_stamp_revision(&s), after_transient, "an unrelated rolled-back batch preserves the revision"); +} + +#[test] +fn a_replacing_property_write_clamps_the_selection_so_the_next_backspace_deletes() { + let (mut s, t) = editing("abcdef", 6); + let owner = ime_owner(&s); + + set_source(&mut s, t, "a"); + assert_text(&s, t, "a"); + assert_eq!(sel(&s), (1, 1), "the shortened document leaves the caret in range"); + assert_ne!(ime_owner(&s), owner); + + // Backspace at the clamped caret removes the character instead of no-opping on 5..6. + s.execute("text.delete", json!({})).unwrap(); + assert_text(&s, t, ""); + assert_eq!(sel(&s), (0, 0)); +} + +#[test] +fn keyframe_writes_on_source_text_replace_the_edited_document_only_when_the_cti_value_changes() { + let (mut s, t) = editing("abc", 1); + // Keying the text the CTI already shows leaves the document equal. + animate_source(&mut s, t); + let owner = ime_owner(&s); + + set_source_cti_key(&mut s, t, 0.0, "abc"); + assert_ime_owner(&s, owner, "a no-op key write keeps the IME owner"); + + // `keys.set` changes the key at the CTI: a document replacement. + set_source_cti_key(&mut s, t, 0.0, "replaced"); + assert_text(&s, t, "replaced"); + assert_ime_epoch_changed(&s, owner, "a changed keyframe changes the IME owner"); +} + +#[test] +fn deleting_the_cti_keyframe_first_replaces_the_document_then_the_last_key_is_a_noop() { + let (mut s, t) = editing("abc", 1); + animate_source(&mut s, t); + add_source_key(&mut s, t, 1.0, "later"); + let owner = ime_owner(&s); + let lid = effectcraft_project::LayerId(t); + let pr = s.active_comp().unwrap().layer(lid).unwrap().props.prop("text/sourceText").unwrap(); + let uid = pr.uid; + let times: Vec<_> = pr.keys.iter().map(|k| k.time).collect(); + assert_eq!(times.len(), 2); + + // Deleting the key at the CTI (0s) while the 1s key remains shows the later text: replacing + // the document starts a new epoch. + s.state.selected_keys = vec![crate::KeyRef { layer: lid, prop: uid, time: times[0] }]; + assert_eq!(s.execute("keys.delete", json!({})).unwrap(), json!(1)); + assert_text(&s, t, "later"); + let replaced = ime_owner(&s); + assert_ne!(replaced, owner, "deleting the CTI key changed the document"); + + // Removing the last key turns its value into the static CTI value. That value is what the + // CTI already showed, so the document does not change and the new owner stays. + s.state.selected_keys = vec![crate::KeyRef { layer: lid, prop: uid, time: times[1] }]; + assert_eq!(s.execute("keys.delete", json!({})).unwrap(), json!(1)); + assert_text(&s, t, "later"); + assert_ime_owner(&s, replaced, "removing the last key is a document no-op"); +} + +#[test] +fn moving_the_cti_to_a_shorter_animated_key_clamps_and_starts_a_new_epoch() { + let (mut s, t) = session("abcdef"); + animate_source(&mut s, t); + add_source_key(&mut s, t, 1.0, "a"); + begin_edit_at(&mut s, t, 6); + let owner = ime_owner(&s); + + // The same time still shows the same document: no new epoch. + s.execute("time.set", json!({"time": 0.0})).unwrap(); + assert_text(&s, t, "abcdef"); + assert_ime_owner(&s, owner, "an unchanged CTI document keeps the IME owner"); + + // The key at 1s holds shorter text: the document changes, the selection is clamped and the + // editor gets a new epoch. + s.execute("time.set", json!({"time": 1.0})).unwrap(); + assert_text(&s, t, "a"); + assert_eq!(sel(&s), (1, 1), "the shortened document leaves the caret in range"); + let replaced = ime_owner(&s); + assert_ne!(replaced, owner, "a changed CTI document starts a new IME epoch"); + + // Backspace at the clamped caret removes the character instead of no-opping on 5..6. + s.execute("text.delete", json!({})).unwrap(); + assert_text(&s, t, ""); + assert_eq!(sel(&s), (0, 0)); + assert_ime_owner(&s, replaced, "typing after the replacement keeps its owner"); + + // Staying at the same time after the edit is a no-op for the document too. + s.execute("time.set", json!({"time": 1.0})).unwrap(); + assert_text(&s, t, ""); + assert_ime_owner(&s, replaced, "a no-op time move keeps the IME owner"); +} + +#[test] +fn sync_related_times_replaces_the_edited_document_when_it_moves_the_active_comp() { + let (mut s, t) = session("abcdef"); + animate_source(&mut s, t); + add_source_key(&mut s, t, 1.0, "a"); + let outer = s.active_comp_id().unwrap(); + let r = s.execute("layer.precompose", json!({"layers": [t], "name": "Inner", "open": true})).unwrap(); + let inner = effectcraft_project::ItemId(r["comp"].as_u64().unwrap()); + assert_eq!(s.active_comp_id(), Some(inner)); + + begin_edit_at(&mut s, t, 6); + let owner = ime_owner(&s); + s.sync_related_times(outer, effectcraft_time::Tick::from_seconds_f64(1.0)); + + assert_text(&s, t, "a"); + assert_eq!(sel(&s), (1, 1), "the related time move clamps the selection"); + assert_ime_epoch_changed(&s, owner, "the related time move changed the document"); +} + +#[test] +fn applying_a_preset_that_writes_source_text_replaces_the_edited_document() { + let (mut s, t) = editing("abc", 1); + let owner = ime_owner(&s); + let preset = json!({ + "effectcraftAnimationPreset": 1, + "properties": [{"path": "text/sourceText", "value": {"t": "Text", "v": {"text": "replaced"}}, "keys": []}], + }); + s.execute("anim.applyPreset", json!({"preset": preset, "layers": [t]})).unwrap(); + assert_text(&s, t, "replaced"); + assert_ime_epoch_changed(&s, owner, "a preset that replaces source text changes the IME owner"); +} + +#[test] +fn a_failed_property_write_keeps_the_edited_document_and_its_owner() { + let (mut s, t) = editing("abc", 1); + let owner = ime_owner(&s); + let steps = undo_steps(&s); + + // null cannot coerce to a Text value: the edit fails before anything is committed. + assert!(s.execute("prop.set", json!({"layer": t, "path": "text/sourceText", "value": null})).is_err()); + assert_text(&s, t, "abc"); + assert_ime_owner(&s, owner, "a failed write keeps the IME owner"); + assert_eq!(undo_steps(&s), steps, "a failed write records no undo step"); +} + +#[test] +fn property_writes_off_the_cti_keep_the_owner_until_they_change_the_cti_document() { + let (mut s, t) = editing("abc", 1); + animate_source(&mut s, t); + add_source_key(&mut s, t, 1.0, "later"); + let owner = ime_owner(&s); + + // Writing a key at 1s leaves the CTI (0s) value as it was. + set_source_key(&mut s, t, 1.0, "changed"); + assert_text(&s, t, "abc"); + assert_ime_owner(&s, owner, "an off-CTI write keeps the IME owner"); + + // Writing the CTI value itself replaces the document. + set_source(&mut s, t, "cti"); + assert_text(&s, t, "cti"); + assert_ime_epoch_changed(&s, owner, "a CTI write changes the IME owner"); +} + +#[test] +fn unrelated_project_cleanup_keeps_the_ime_owner_but_replacement_changes_it() { + let (mut s, t) = editing("abc", 1); + let owner = ime_owner(&s); + + // file.removeUnusedFootage calls sanitize_state while the edited document is untouched. + s.execute("file.importSolid", json!({"name": "Unused"})).unwrap(); + let removed = s.execute("file.removeUnusedFootage", json!({})).unwrap(); + assert_eq!(removed["removed"], json!(1), "the unused solid was actually removed"); + assert_ime_owner(&s, owner, "unrelated cleanup keeps the IME owner"); + + // Replacing the Source Text is a document replacement: a new owner. + replace_text(&mut s, t, "replaced"); + assert_ime_epoch_changed(&s, owner, "replacing the document changes the owner"); +} + +#[test] +fn ime_session_does_not_cross_a_composition_switch() { + let (mut s, _) = editing_all("abc"); + let other = new_other_comp(&mut s); + s.execute("comp.open", json!({"comp": other})).unwrap(); + assert!(s.state.text_edit.is_none(), "the old comp's editor is not reused in another comp"); +} + +#[test] +fn removing_the_active_comp_does_not_retarget_its_text_editor() { + for replacement in [false, true] { + let (mut s, t) = session("original"); + let original = s.active_comp_id().unwrap(); + let layer = s.active_comp().unwrap().layer(effectcraft_project::LayerId(t)).unwrap().clone(); + let other = new_other_comp(&mut s); + let other_id = effectcraft_project::ItemId(other); + std::sync::Arc::make_mut(&mut s.project).comp_mut(other_id).unwrap().layers.push(layer); + s.execute("comp.open", json!({"comp": other})).unwrap(); + s.execute("comp.open", json!({"comp": original.0})).unwrap(); + begin_edit_at(&mut s, t, 1); + assert!(s.state.text_edit.is_some()); + + // Reproduce cleanup after a project replacement, bypassing Session::edit's earlier + // document guard so this specifically exercises sanitize_state's fallback-comp branch. + let edited = crate::commands::text_edit::active_editor_snapshot(&s); + std::sync::Arc::make_mut(&mut s.project).items.remove(&original); + if replacement { + s.sanitize_after_replacement(edited.as_ref()); + } else { + s.sanitize_state(); + } + assert_eq!(s.active_comp_id(), Some(other_id)); + assert!(s.state.text_edit.is_none(), "the same-numbered layer belongs to a different comp"); + assert!(s.execute("text.insert", json!({"text": "wrong document"})).is_err()); + assert_eq!(doc(&s, t).text, "original", "the fallback comp was not edited"); + } } #[test] @@ -260,26 +918,32 @@ fn fonts_lists_bundled_and_installed_families() { assert_eq!(crate::font_styles("No Such Family").len(), 5); } -/// A font file of just `name` (the family, Regular) and an `fvar` table with one axis pinned at -/// 400 (so the helpers that look for an installed font with a real axis range never pick it). -fn pinned_variable_font(family: &str) -> Vec { - let u16s = |v: &[u16]| -> Vec { v.iter().flat_map(|x| x.to_be_bytes()).collect() }; - let strings: Vec> = [family, "Regular"].iter().map(|s| s.encode_utf16().flat_map(|u| u.to_be_bytes()).collect()).collect(); - let mut name = u16s(&[0, 2, 30]); +/// A big-endian `u16` array, as sfnt tables store them. +fn u16s(v: &[u16]) -> Vec { + v.iter().flat_map(|x| x.to_be_bytes()).collect() +} + +/// A `name` table with one Windows/Unicode English record per `(id, text)`. +fn name_table(strings: &[(u16, String)]) -> Vec { + let enc: Vec<(u16, Vec)> = strings.iter().map(|(id, s)| (*id, s.encode_utf16().flat_map(|u| u.to_be_bytes()).collect())).collect(); + let mut name = u16s(&[0, enc.len() as u16, 6 + 12 * enc.len() as u16]); let mut off = 0; - for (id, st) in strings.iter().enumerate() { - name.extend(u16s(&[3, 1, 0x409, id as u16 + 1, st.len() as u16, off])); + for (id, st) in &enc { + name.extend(u16s(&[3, 1, 0x409, *id, st.len() as u16, off])); off += st.len() as u16; } - strings.iter().for_each(|st| name.extend(st)); - let mut fvar = u16s(&[1, 0, 16, 2, 1, 20, 0, 8]); - fvar.extend(b"wght".iter().copied().chain(u16s(&[0x190, 0, 0x190, 0, 0x190, 0, 0, 256]))); - let mut out = u16s(&[1, 0, 2, 0, 0, 0]); + enc.iter().for_each(|(_, st)| name.extend(st)); + name +} + +/// A single-face font with `tables` in order (zero checksums, offsets after the directory). +fn sfnt(tables: &[(&[u8; 4], Vec)]) -> Vec { + let mut out = u16s(&[1, 0, tables.len() as u16, 0, 0, 0]); let mut body: Vec = vec![]; - for (tag, data) in [(b"fvar", fvar), (b"name", name)] { - out.extend(tag); + for (tag, data) in tables { + out.extend(*tag); out.extend([0u8; 4]); - out.extend(((12 + 32 + body.len()) as u32).to_be_bytes()); + out.extend(((12 + 16 * tables.len() + body.len()) as u32).to_be_bytes()); out.extend((data.len() as u32).to_be_bytes()); body.extend(data); } @@ -287,6 +951,15 @@ fn pinned_variable_font(family: &str) -> Vec { out } +/// A font file of just `name` (the family, Regular) and an `fvar` table with one axis pinned at +/// 400 (so the helpers that look for an installed font with a real axis range never pick it). +fn pinned_variable_font(family: &str) -> Vec { + let mut fvar = u16s(&[1, 0, 16, 2, 1, 20, 0, 8]); + fvar.extend(b"wght".iter().copied().chain(u16s(&[0x190, 0, 0x190, 0, 0x190, 0, 0, 256]))); + let name = name_table(&[(1, family.to_owned()), (2, "Regular".to_owned())]); + sfnt(&[(b"fvar", fvar), (b"name", name)]) +} + /// The font menu's Variable Fonts filter (After Effects 26.3): `text.fonts {variable: true}` /// lists only families with variation axes, every listing says which families are variable, and /// the font menu's rows carry the flag the filter uses. @@ -321,7 +994,6 @@ fn fonts_filter_variable_families() { /// `Light`) and the named `instances` (style, `wght`), each with a PostScript name /// `-