diff --git a/.github/workflows/packaging-lint.yml b/.github/workflows/packaging-lint.yml index 23db4e93..1ad33f98 100644 --- a/.github/workflows/packaging-lint.yml +++ b/.github/workflows/packaging-lint.yml @@ -54,4 +54,13 @@ jobs: desktop-file-validate packaging/linux/ai.storyteller.vectorcraft.desktop sed -e 's/@VERSION@/0.0.0/' -e 's/@DATE@/2026-01-01/' packaging/linux/ai.storyteller.vectorcraft.metainfo.xml.in >"$RUNNER_TEMP/ai.storyteller.vectorcraft.metainfo.xml" appstreamcli validate --no-net --explain "$RUNNER_TEMP/ai.storyteller.vectorcraft.metainfo.xml" - python3 -c "import yaml; m = yaml.safe_load(open('packaging/linux/flatpak/ai.storyteller.vectorcraft.yml')); assert m['id'] == 'ai.storyteller.vectorcraft' and m['command'] == 'vectorcraft'" + python3 - <<'EOF' + import yaml + src = yaml.safe_load(open("packaging/linux/flatpak/ai.storyteller.vectorcraft.yml")) + bundle = yaml.safe_load(open("packaging/linux/flatpak/ai.storyteller.vectorcraft.bundle.yml")) + for m in (src, bundle): + assert m["id"] == "ai.storyteller.vectorcraft" and m["command"] == "vectorcraft", m["id"] + for key in ("runtime", "runtime-version", "sdk", "finish-args"): + assert src[key] == bundle[key], f"Flatpak manifests disagree on {key}: {src[key]} vs {bundle[key]}" + print("Flatpak manifests ok") + EOF diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index c43c2f06..8bd5dfee 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,9 +1,11 @@ # Release pipeline: every push to `release` builds signed installers for every platform and # creates or updates the draft GitHub Release "VectorCraft v". See docs/releasing.md. # -# All jobs run in the `release` environment (restricted to the `release` branch), which holds -# the signing secrets. Every secret is optional: missing ones produce unsigned artifacts and a -# warning, never a failed build. +# Jobs that sign (macOS, Windows) and the job that creates the release run in the `release` +# environment (restricted to the `release` branch), which holds the signing secrets. Every secret +# is optional: missing ones produce unsigned artifacts and a warning, never a failed build. The +# other jobs sign nothing and get no environment, so a `workflow_dispatch` on any branch is a dry +# run: they build and upload artifacts, the signed jobs are refused, and no release is drafted. name: Release on: @@ -35,7 +37,7 @@ jobs: version: name: version runs-on: ubuntu-latest - environment: release + # No `environment: release`: no secrets here. outputs: version: ${{ steps.v.outputs.version }} date: ${{ steps.v.outputs.date }} @@ -175,7 +177,7 @@ jobs: # The oldest GitHub-hosted image, so the binaries only need glibc >= 2.35 (Ubuntu 22.04+, # Debian 12+, Fedora 36+, RHEL 10). See docs/releasing.md. runs-on: ${{ matrix.runner }} - environment: release + # No `environment: release`: Linux packages are not signed (checksums in SHA256SUMS.txt). strategy: fail-fast: false matrix: @@ -200,7 +202,7 @@ jobs: sudo apt-get update sudo apt-get install -y --no-install-recommends \ libxkbcommon-dev libwayland-dev libx11-dev libxrandr-dev libxi-dev libgl1-mesa-dev \ - desktop-file-utils appstream python3-yaml + desktop-file-utils appstream python3-yaml zsync curl -fsSL -o "$RUNNER_TEMP/nfpm.deb" \ "https://github.com/goreleaser/nfpm/releases/download/v${NFPM_VERSION}/nfpm_${NFPM_VERSION}_${{ matrix.deb }}.deb" sudo dpkg -i "$RUNNER_TEMP/nfpm.deb" @@ -225,6 +227,12 @@ jobs: for appimage in dist/release/*.AppImage; do chmod +x "$appimage" APPIMAGE_EXTRACT_AND_RUN=1 "$appimage" --version + # Update information is embedded, and the .zsync for delta updates sits beside it. + # No APPIMAGE_EXTRACT_AND_RUN here: with it the runtime passes --appimage-* flags on + # to the app instead of answering them itself. + "$appimage" --appimage-updateinformation \ + | grep -F "gh-releases-zsync|${GITHUB_REPOSITORY%%/*}|${GITHUB_REPOSITORY#*/}|latest|vectorcraft-*-linux-${{ matrix.arch }}.AppImage.zsync" + test -s "$appimage.zsync" done - uses: actions/upload-artifact@v4 with: @@ -232,13 +240,52 @@ jobs: path: dist/release/* if-no-files-found: error + flatpak: + name: Flatpak ${{ matrix.arch }} + needs: [version, linux] + # Repackages the Linux job's tarball (the same binaries as the AppImage/deb/rpm); no Rust + # build here. 24.04 for a newer flatpak-builder (1.4) than 22.04 ships. + runs-on: ${{ matrix.runner }} + # No `environment: release`: this job signs nothing, so it gets no release secrets. + strategy: + fail-fast: false + matrix: + include: + - { arch: x86_64, runner: ubuntu-24.04 } + - { arch: aarch64, runner: ubuntu-24.04-arm } + env: + VECTORCRAFT_VERSION: ${{ needs.version.outputs.version }} + VECTORCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }} + steps: + - uses: actions/checkout@v4 + - uses: actions/download-artifact@v4 + with: + name: release-linux-${{ matrix.arch }} + path: dist/linux + - name: Install flatpak-builder + run: | + sudo apt-get update + # librsvg2-common: the SVG pixbuf loader. flatpak-builder runs the host's + # `appstreamcli compose`, which renders the scalable icon and fails without it. + sudo apt-get install -y --no-install-recommends flatpak flatpak-builder librsvg2-common + # Ubuntu 24.04's AppArmor blocks the unprivileged user namespaces bubblewrap needs. + sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0 + - name: Build the Flatpak bundle + run: packaging/linux/flatpak-bundle.sh "dist/linux/vectorcraft-$VECTORCRAFT_VERSION-linux-${{ matrix.arch }}.tar.gz" + - uses: actions/upload-artifact@v4 + with: + name: release-flatpak-${{ matrix.arch }} + path: dist/release/*.flatpak + if-no-files-found: error + freebsd: name: FreeBSD x86_64 needs: version - # GitHub has no FreeBSD runners: build in a FreeBSD 14.3 VM (same image as freebsd.yml). + # GitHub has no FreeBSD runners: build in a FreeBSD 14.3 VM (same image and packages as + # freebsd.yml). runs-on: ubuntu-latest timeout-minutes: 150 - environment: release + # No `environment: release`: this job signs nothing, so it gets no release secrets. env: VECTORCRAFT_VERSION: ${{ needs.version.outputs.version }} VECTORCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }} @@ -262,6 +309,7 @@ jobs: with: release: "14.3" usesh: true + cpu: 4 mem: 12288 # Passed through by name; never templated into the script. envs: "VECTORCRAFT_VERSION VECTORCRAFT_BUILD_DATE VECTORCRAFT_BUILD_SHA" @@ -276,6 +324,8 @@ jobs: export CRAFT_FONTS_DIR="$PWD/craft-fonts" CRAFT_FONTS_REQUIRED=1 export CARGO_TARGET_DIR=/var/tmp/vectorcraft-target CARGO_BUILD_JOBS=4 bash packaging/freebsd/package.sh + tar -tzf dist/release/vectorcraft-*-freebsd-x86_64.tar.gz \ + | grep -E '/bin/vectorcraft$|/bin/vectorcraft-cli$|/share/applications/ai\.storyteller\.vectorcraft\.desktop$' - uses: actions/upload-artifact@v4 with: name: release-freebsd @@ -286,7 +336,7 @@ jobs: name: Web (wasm) needs: version runs-on: ubuntu-latest - environment: release + # No `environment: release`: no secrets here. env: VECTORCRAFT_VERSION: ${{ needs.version.outputs.version }} VECTORCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }} @@ -327,7 +377,9 @@ jobs: release: name: Draft GitHub Release - needs: [version, macos, windows, linux, freebsd, web] + # Needs the signed jobs, so a branch dry run (where the environment refuses them) never + # drafts a release. + needs: [version, macos, windows, linux, flatpak, freebsd, web] runs-on: ubuntu-latest environment: release permissions: diff --git a/AGENTS.md b/AGENTS.md index 3e544b94..ec28c2d4 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,13 +6,19 @@ Formerly **DrawCraft** (renamed 2026-10-01): old `.drawcraft` files and `"format ## Start every session here 1. Read the [honest assessment in `ROADMAP.md`](ROADMAP.md#honest-assessment-2026-10-05): where we stand by dimension, **where we're lacking** (the prioritized gap list) and **where we're going**. Unless the user gives you a task, pick work from that list. -2. Read `plan/STATUS.md` (local session notes, may lag the ROADMAP), then the task in `plan/execution-plan.md` §3 and the relevant `plan/architecture.md` section. Behaviour reference: `plan/illustrator/*.md`. +2. Read `plan/STATUS.md` (local session notes, may lag the ROADMAP), then the task in `plan/execution-plan.md` §3 and the relevant `plan/architecture.md` section. Behaviour reference: public documentation only (see Clean-room below); `plan/illustrator/*.md` holds notes from it. 3. Follow the autonomous operation protocol (`plan/execution-plan.md` §7): orient → plan → implement + test → verify → record → commit. Don't stop to ask unless §7 lists the decision as the user's. `plan/` is gitignored (local only). ## Non-negotiables -- **Clean-room.** Never read, disassemble or copy anything inside the Illustrator bundle (names/listings only). Never copy Adobe icons, artwork, presets or wording beyond feature names. Behaviour comes from public docs and black-box observation of the running app with synthetic documents only (screenshots by window id, stored under `plan/illustrator/screenshots/`, never committed). Never copy GPL/AGPL code (Inkscape, lib2geom…). +- **Clean-room: never use Adobe software (absolute rule, from the project owner).** Adobe's Terms of Use forbid reverse engineering, including observing a program's inputs and outputs to recreate it. So: + - Never launch, run, script, automate (COM, AppleScript, ExtendScript, UI automation), screenshot or measure Illustrator or any other Adobe application, and never compare our output against one. Don't make test files with them, not even "synthetic" ones. + - Never read, disassemble or copy anything inside an Adobe install (binaries, plug-ins, presets, procsets, resources, help files, fonts, ICC profiles). + - Never copy Adobe-authored code or text into this repo, tests included: no PostScript procsets or prologs (AGM, CoolType, the Illustrator prologs), no sample files. Write test inputs from scratch from the public specifications (PostScript Language Reference, PDF / ISO 32000, TIFF, EPSF/DCS). + - Behaviour comes only from public documentation (helpx, published specs, public forum posts), cited by URL, and from files users send us that they own (used locally, never committed). Never copy Adobe icons, artwork, presets or wording beyond feature names. + - If a task seems to need any of this, stop and say so instead. `cargo xtask cleanroom` (run by `cargo xtask ci`) fails on Adobe copyright notices and on fixtures made with Adobe applications. + - Never copy GPL/AGPL code (Inkscape, lib2geom…). - **Assets: no Adobe iconography or images — ever (absolute rule, from the project owner).** - Never add, copy, trace, redraw-from, embed or ship any icon, image, artwork, cursor, preset, swatch/brush/symbol/pattern/style library, ICC profile or screenshot from Adobe products or from any other source whose licence doesn't allow it. - Every image, icon, font or other asset must be one of: @@ -44,7 +50,7 @@ Formerly **DrawCraft** (renamed 2026-10-01): old `.drawcraft` files and `"format ## Running and looking at the app - `cargo run --release -p vectorcraft -- --control 7979 [file.svg|file.vectorcraft]` (sibling apps' agents use the same default port: if the log says it failed to bind, pick another port — otherwise your requests reach a different app). - Drive it: JSON lines on `127.0.0.1:7979`, e.g. `{"id":1,"method":"engine.execute","params":{"command":"shape.rectangle","params":{"x":10,"y":10,"width":100,"height":50}}}` then `{"id":2,"method":"ui.screenshot","params":{"path":"/tmp/shot.png"}}`. Methods: `crates/ui-egui/src/control.rs`. -- **For UI work, look at the result** (take `ui.screenshot`, read the PNG) and compare with `plan/illustrator/02-ui-ux.md` / `10-observed-ui.md`. `ui.screenshot` needs a presented frame: if it errors (screen locked), check the art with `ui.render` / `vectorcraft-cli run … --export x.png`, and cover panels with a headless egui frame test (see `panels/transparency.rs` tests). +- **For UI work, look at the result** (take `ui.screenshot`, read the PNG) and compare with the public documentation (`plan/illustrator/02-ui-ux.md` notes). `ui.screenshot` needs a presented frame: if it errors (screen locked), check the art with `ui.render` / `vectorcraft-cli run … --export x.png`, and cover panels with a headless egui frame test (see `panels/transparency.rs` tests). - **Performance:** `vectorcraft-cli perf` checks the budgets (render/pan/zoom, hit test, save/open, SVG, Pathfinder) on a synthetic 50k-path document; `vectorcraft-cli bench FILE` times one file. Run them before and after renderer, format or geometry changes, on an idle machine (the report warns when the load average makes timings noise). - MCP: `vectorcraft-cli mcp` (see `docs/mcp.md`). - Shell gotcha: `mv`/`cp` are aliased interactive here — use `/bin/mv -f` / `/bin/cp -f`. @@ -53,7 +59,7 @@ Formerly **DrawCraft** (renamed 2026-10-01): old `.drawcraft` files and `"format ## Roadmap `ROADMAP.md` (committed) is the shared picture of where VectorCraft stands. It holds status, the honest assessment (by dimension, the gap list, the direction), milestones, the parity table and time-to-parity estimates. - When a task lands, update it in the same PR: the milestone row, the parity-table row (score, missing items, hours), "Shipped so far", and the gap list if the gap closed or shrank. -- Grade by behaviour against `plan/illustrator/`, not by whether a menu item exists. Scores are self-assessed, so err low. +- Grade by behaviour against the public documentation (`plan/illustrator/` notes), not by whether a menu item exists. Scores are self-assessed, so err low. - Keep the README's Status section in step with the ROADMAP headline. ## Contributor credits (About window) diff --git a/CLAUDE.md b/CLAUDE.md index 0633ac64..932d0b6d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -6,13 +6,19 @@ Formerly **DrawCraft** (renamed 2026-10-01): old `.drawcraft` files and `"format ## Start every session here 1. Read the [honest assessment in `ROADMAP.md`](ROADMAP.md#honest-assessment-2026-10-05): where we stand by dimension, **where we're lacking** (the prioritized gap list) and **where we're going**. Unless the user gives you a task, pick work from that list. -2. Read `plan/STATUS.md` (local session notes, may lag the ROADMAP), then the task in `plan/execution-plan.md` §3 and the relevant `plan/architecture.md` section. Behaviour reference: `plan/illustrator/*.md`. +2. Read `plan/STATUS.md` (local session notes, may lag the ROADMAP), then the task in `plan/execution-plan.md` §3 and the relevant `plan/architecture.md` section. Behaviour reference: public documentation only (see Clean-room below); `plan/illustrator/*.md` holds notes from it. 3. Follow the autonomous operation protocol (`plan/execution-plan.md` §7): orient → plan → implement + test → verify → record → commit. Don't stop to ask unless §7 lists the decision as the user's. `plan/` is gitignored (local only). ## Non-negotiables -- **Clean-room.** Never read, disassemble or copy anything inside the Illustrator bundle (names/listings only). Never copy Adobe icons, artwork, presets or wording beyond feature names. Behaviour comes from public docs and black-box observation of the running app with synthetic documents only (screenshots by window id, stored under `plan/illustrator/screenshots/`, never committed). Never copy GPL/AGPL code (Inkscape, lib2geom…). +- **Clean-room: never use Adobe software (absolute rule, from the project owner).** Adobe's Terms of Use forbid reverse engineering, including observing a program's inputs and outputs to recreate it. So: + - Never launch, run, script, automate (COM, AppleScript, ExtendScript, UI automation), screenshot or measure Illustrator or any other Adobe application, and never compare our output against one. Don't make test files with them, not even "synthetic" ones. + - Never read, disassemble or copy anything inside an Adobe install (binaries, plug-ins, presets, procsets, resources, help files, fonts, ICC profiles). + - Never copy Adobe-authored code or text into this repo, tests included: no PostScript procsets or prologs (AGM, CoolType, the Illustrator prologs), no sample files. Write test inputs from scratch from the public specifications (PostScript Language Reference, PDF / ISO 32000, TIFF, EPSF/DCS). + - Behaviour comes only from public documentation (helpx, published specs, public forum posts), cited by URL, and from files users send us that they own (used locally, never committed). Never copy Adobe icons, artwork, presets or wording beyond feature names. + - If a task seems to need any of this, stop and say so instead. `cargo xtask cleanroom` (run by `cargo xtask ci`) fails on Adobe copyright notices and on fixtures made with Adobe applications. + - Never copy GPL/AGPL code (Inkscape, lib2geom…). - **Assets: no Adobe iconography or images — ever (absolute rule, from the project owner).** - Never add, copy, trace, redraw-from, embed or ship any icon, image, artwork, cursor, preset, swatch/brush/symbol/pattern/style library, ICC profile or screenshot from Adobe products or from any other source whose licence doesn't allow it. - Every image, icon, font or other asset must be one of: @@ -44,7 +50,7 @@ Formerly **DrawCraft** (renamed 2026-10-01): old `.drawcraft` files and `"format ## Running and looking at the app - `cargo run --release -p vectorcraft -- --control 7979 [file.svg|file.vectorcraft]` (sibling apps' agents use the same default port: if the log says it failed to bind, pick another port — otherwise your requests reach a different app). - Drive it: JSON lines on `127.0.0.1:7979`, e.g. `{"id":1,"method":"engine.execute","params":{"command":"shape.rectangle","params":{"x":10,"y":10,"width":100,"height":50}}}` then `{"id":2,"method":"ui.screenshot","params":{"path":"/tmp/shot.png"}}`. Methods: `crates/ui-egui/src/control.rs`. -- **For UI work, look at the result** (take `ui.screenshot`, read the PNG) and compare with `plan/illustrator/02-ui-ux.md` / `10-observed-ui.md`. `ui.screenshot` needs a presented frame: if it errors (screen locked), check the art with `ui.render` / `vectorcraft-cli run … --export x.png`, and cover panels with a headless egui frame test (see `panels/transparency.rs` tests). +- **For UI work, look at the result** (take `ui.screenshot`, read the PNG) and compare with the public documentation (`plan/illustrator/02-ui-ux.md` notes). `ui.screenshot` needs a presented frame: if it errors (screen locked), check the art with `ui.render` / `vectorcraft-cli run … --export x.png`, and cover panels with a headless egui frame test (see `panels/transparency.rs` tests). - **Performance:** `vectorcraft-cli perf` checks the budgets (render/pan/zoom, hit test, save/open, SVG, Pathfinder) on a synthetic 50k-path document; `vectorcraft-cli bench FILE` times one file. Run them before and after renderer, format or geometry changes, on an idle machine (the report warns when the load average makes timings noise). - MCP: `vectorcraft-cli mcp` (see `docs/mcp.md`). - Shell gotcha: `mv`/`cp` are aliased interactive here — use `/bin/mv -f` / `/bin/cp -f`. @@ -53,5 +59,5 @@ Formerly **DrawCraft** (renamed 2026-10-01): old `.drawcraft` files and `"format ## Roadmap `ROADMAP.md` (committed) is the shared picture of where VectorCraft stands. It holds status, the honest assessment (by dimension, the gap list, the direction), milestones, the parity table and time-to-parity estimates. - When a task lands, update it in the same PR: the milestone row, the parity-table row (score, missing items, hours), "Shipped so far", and the gap list if the gap closed or shrank. -- Grade by behaviour against `plan/illustrator/`, not by whether a menu item exists. Scores are self-assessed, so err low. +- Grade by behaviour against the public documentation (`plan/illustrator/` notes), not by whether a menu item exists. Scores are self-assessed, so err low. - Keep the README's Status section in step with the ROADMAP headline. diff --git a/Cargo.lock b/Cargo.lock index 8666f4f2..542cf474 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4297,7 +4297,7 @@ dependencies = [ [[package]] name = "vectorcraft" -version = "0.5.0" +version = "0.6.0" dependencies = [ "arboard", "block2 0.6.2", @@ -4329,7 +4329,7 @@ dependencies = [ [[package]] name = "vectorcraft-brush" -version = "0.5.0" +version = "0.6.0" dependencies = [ "kurbo 0.13.1", "serde", @@ -4341,7 +4341,7 @@ dependencies = [ [[package]] name = "vectorcraft-cad" -version = "0.5.0" +version = "0.6.0" dependencies = [ "image", "kurbo 0.13.1", @@ -4357,7 +4357,7 @@ dependencies = [ [[package]] name = "vectorcraft-cli" -version = "0.5.0" +version = "0.6.0" dependencies = [ "serde_json", "vectorcraft-color", @@ -4373,7 +4373,7 @@ dependencies = [ [[package]] name = "vectorcraft-color" -version = "0.5.0" +version = "0.6.0" dependencies = [ "kurbo 0.13.1", "moxcms", @@ -4385,7 +4385,7 @@ dependencies = [ [[package]] name = "vectorcraft-doc" -version = "0.5.0" +version = "0.6.0" dependencies = [ "image", "jpeg-encoder", @@ -4402,7 +4402,7 @@ dependencies = [ [[package]] name = "vectorcraft-effects" -version = "0.5.0" +version = "0.6.0" dependencies = [ "kurbo 0.13.1", "serde_json", @@ -4416,7 +4416,7 @@ dependencies = [ [[package]] name = "vectorcraft-engine" -version = "0.5.0" +version = "0.6.0" dependencies = [ "crc32fast", "flate2", @@ -4450,7 +4450,7 @@ dependencies = [ [[package]] name = "vectorcraft-eps" -version = "0.5.0" +version = "0.6.0" dependencies = [ "flate2", "image", @@ -4468,7 +4468,7 @@ dependencies = [ [[package]] name = "vectorcraft-format" -version = "0.5.0" +version = "0.6.0" dependencies = [ "flate2", "proptest", @@ -4482,7 +4482,7 @@ dependencies = [ [[package]] name = "vectorcraft-geom" -version = "0.5.0" +version = "0.6.0" dependencies = [ "kurbo 0.13.1", "proptest", @@ -4494,7 +4494,7 @@ dependencies = [ [[package]] name = "vectorcraft-mcp" -version = "0.5.0" +version = "0.6.0" dependencies = [ "image", "log", @@ -4513,7 +4513,7 @@ dependencies = [ [[package]] name = "vectorcraft-metafile" -version = "0.5.0" +version = "0.6.0" dependencies = [ "image", "kurbo 0.13.1", @@ -4527,7 +4527,7 @@ dependencies = [ [[package]] name = "vectorcraft-pathops" -version = "0.5.0" +version = "0.6.0" dependencies = [ "kurbo 0.13.1", "linesweeper", @@ -4539,7 +4539,7 @@ dependencies = [ [[package]] name = "vectorcraft-pdf" -version = "0.5.0" +version = "0.6.0" dependencies = [ "aes", "flate2", @@ -4568,7 +4568,7 @@ dependencies = [ [[package]] name = "vectorcraft-plugins" -version = "0.5.0" +version = "0.6.0" dependencies = [ "serde", "serde_json", @@ -4582,7 +4582,7 @@ dependencies = [ [[package]] name = "vectorcraft-render" -version = "0.5.0" +version = "0.6.0" dependencies = [ "flate2", "gif", @@ -4607,7 +4607,7 @@ dependencies = [ [[package]] name = "vectorcraft-svg" -version = "0.5.0" +version = "0.6.0" dependencies = [ "flate2", "image", @@ -4631,7 +4631,7 @@ dependencies = [ [[package]] name = "vectorcraft-testkit" -version = "0.5.0" +version = "0.6.0" dependencies = [ "image", "kurbo 0.13.1", @@ -4648,7 +4648,7 @@ dependencies = [ [[package]] name = "vectorcraft-text" -version = "0.5.0" +version = "0.6.0" dependencies = [ "harfrust 0.13.3", "kurbo 0.13.1", @@ -4666,7 +4666,7 @@ dependencies = [ [[package]] name = "vectorcraft-tools" -version = "0.5.0" +version = "0.6.0" dependencies = [ "image", "kurbo 0.13.1", @@ -4681,7 +4681,7 @@ dependencies = [ [[package]] name = "vectorcraft-trace" -version = "0.5.0" +version = "0.6.0" dependencies = [ "image", "kurbo 0.13.1", @@ -4694,7 +4694,7 @@ dependencies = [ [[package]] name = "vectorcraft-ui-egui" -version = "0.5.0" +version = "0.6.0" dependencies = [ "egui", "egui_extras", @@ -4723,7 +4723,7 @@ dependencies = [ [[package]] name = "vectorcraft-web" -version = "0.5.0" +version = "0.6.0" dependencies = [ "eframe", "egui", @@ -5826,7 +5826,7 @@ checksum = "9440ea3e5aeabb0ac63af70daf835274065238cdd0cec83418f417eae38bacee" [[package]] name = "xtask" -version = "0.5.0" +version = "0.6.0" dependencies = [ "serde_json", ] diff --git a/Cargo.toml b/Cargo.toml index dd2fb224..430215a8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ members = ["crates/*", "apps/*", "xtask"] default-members = ["crates/*", "apps/vectorcraft", "apps/vectorcraft-cli", "xtask"] [workspace.package] -version = "0.5.0" +version = "0.6.0" edition = "2024" license = "MIT OR Apache-2.0" rust-version = "1.95" diff --git a/README.md b/README.md index bd714dcd..a551a703 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ Why VectorCraft · Quick start · Status · + Downloads · The Crafting Apps · License

@@ -162,9 +163,11 @@ Japanese fonts come from [storytold/craft-fonts](https://github.com/storytold/cr build input (releases always use it): `CRAFT_FONTS_DIR="$PWD/../craft-fonts" cargo run --release -p vectorcraft` (an absolute path). Without it, Japanese text uses the installed system fonts. See [`docs/development.md`](docs/development.md#fonts-craft-fonts-optional-build-input). -On laptops with two graphics processors, VectorCraft uses the power-saving (integrated) one by default. -To use the discrete one, choose **Preferences › Performance › Graphics Processor › High Performance** -and restart, or start the app with `WGPU_POWER_PREF=high` (see [`docs/development.md`](docs/development.md#desktop-graphics-processor)). +On machines with two graphics processors, VectorCraft renders on the power-saving (integrated) one by default on +Windows and macOS, and on the one the desktop runs on under Linux. To choose, use **Preferences › Performance › +Graphics Processor** and restart. If a graphics processor can't show the window, VectorCraft starts again on the +next one. To pick one when starting the app, set `WGPU_POWER_PREF=high` (or `low`), or `WGPU_ADAPTER_NAME` to part of +its name, such as `WGPU_ADAPTER_NAME=nvidia` (see [`docs/development.md`](docs/development.md#desktop-graphics-processor)). On Linux under KDE Plasma 6.3 or later with Wayland, a drawing tablet's pen moves the cursor but VectorCraft doesn't respond to it yet (#491). Start the app under XWayland instead: `WAYLAND_DISPLAY= vectorcraft` (see @@ -220,6 +223,51 @@ Agent and contributor rules (clean-room, the asset policy, no panics in shipped explains how VectorCraft avoids crashing, and [`docs/releasing.md`](docs/releasing.md) how releases are built, signed and published. Every bundled asset is listed with its licence in [`ASSETS.md`](ASSETS.md). +## Downloads + +**New to VectorCraft?** Download it from the [VectorCraft page on getartcraft.com](https://getartcraft.com/apps/vectorcraft). That's the easiest way to install it. + +**Want a specific build or format?** On GitHub, the [latest release](https://github.com/storytold/vectorcraft/releases/latest) has every build listed below, and [all releases](https://github.com/storytold/vectorcraft/releases) has earlier versions and their notes. `` in the file names is the version number, and `SHA256SUMS.txt` lists a checksum for every file. + +### Windows + +| Build | Installer | Portable | +|---|---|---| +| x64 (64-bit Intel/AMD) | `vectorcraft--windows-x64.msi` | `vectorcraft--windows-x64-portable.zip` | +| arm64 (Snapdragon and other ARM PCs) | `vectorcraft--windows-arm64.msi` | `vectorcraft--windows-arm64-portable.zip` | +| x86 (32-bit) | `vectorcraft--windows-x86.msi` | `vectorcraft--windows-x86-portable.zip` | + +Installers and executables are code-signed. + +### macOS + +| Build | File | Notes | +|---|---|---| +| App, universal (Apple silicon + Intel) | `vectorcraft--macos-universal.dmg` | Signed and notarized | +| Command-line tool, universal | `vectorcraft-cli--macos-universal.zip` | Signed and notarized | + +### Linux + +| Format | x86_64 | aarch64 (ARM64) | Notes | +|---|---|---|---| +| AppImage | `vectorcraft--linux-x86_64.AppImage` | `vectorcraft--linux-aarch64.AppImage` | Runs anywhere; updates itself with [AppImageUpdate](https://github.com/AppImageCommunity/AppImageUpdate) (`.zsync` files) | +| Flatpak | `vectorcraft--linux-x86_64.flatpak` | `vectorcraft--linux-aarch64.flatpak` | Sandboxed; `flatpak install --user ` | +| Debian/Ubuntu | `vectorcraft--linux-x86_64.deb` | `vectorcraft--linux-aarch64.deb` | | +| Fedora/RHEL/openSUSE | `vectorcraft--linux-x86_64.rpm` | `vectorcraft--linux-aarch64.rpm` | | +| Tarball | `vectorcraft--linux-x86_64.tar.gz` | `vectorcraft--linux-aarch64.tar.gz` | Unpack anywhere | + +### FreeBSD + +| Build | File | +|---|---| +| x86_64 | `vectorcraft--freebsd-x86_64.tar.gz` | + +### Web (WebAssembly) + +| Build | File | Notes | +|---|---|---| +| Static site | `vectorcraft-web-.zip` | Runs in a modern browser; host it on any static server | + ## The Crafting Apps VectorCraft is one of the **Crafting Apps**: free, open-source creative tools from the diff --git a/ROADMAP.md b/ROADMAP.md index de31900d..8d3b8d5e 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -4,7 +4,7 @@ VectorCraft is a clean-room, open-source, pure-Rust reimplementation of the Adob This file tracks **how far we are and what's left**. Time estimates are wall-clock hours of continuous Claude Opus 5.5 agent work (including builds and the CI gate), given both for **one agent** and for **4–6 parallel agents** on disjoint crates. They are counted from the remaining work (see [Parity estimate](#parity-estimate)), calibrated against measured throughput, and updated as work lands. -_Last updated: 2026-10-08 (after M4.14–M4.98, M8.1–M8.20, M14.4–M14.7, the MCP prompts, resource templates, completions and logging, the 2026-10-07 issue fixes, the Layers panel rework and the 2026-10-08 community contributions: Pen and shape-tool modifiers, path editing, Layers, Artboards, Swatches/Brushes and dialogs, Japanese composition and PDF text, Hebrew/Arabic type, interface languages (Spanish among them), the font menu, saved selections, MCP and EPS, the missing-font export warning (#319), open paths in the Shape Builder (#374), PDF/`.ai` import keeping strokes live and hidden and nested layers (#372), per-corner Live Corners (#381), SVG type opening at the size it draws at (#396), the Wayland clipboard with copied-file paste (#398), ruler guides that can be selected, moved and deleted (#414), two batches of Preferences options that were stored but unused (#394), skeleton reads with `document.find` for large documents over MCP (#416) and anchors dragged with Direct Selection snapping to points, segments and smart guides, clipped SVG layers opening as clipping layers (#420), PDF/`.ai` layers read on pages of tens of millions of operators (#419), Document Color Mode putting RGB greys on the black plate on request and converting pattern tiles (#421) and movable dialogs with Offset Path's Joins dropdown (#423) and numeric fields scrubbed by dragging their label (#400), stroke weight presets in the stroke unit (#426), the Appearance panel's Opacity popup (#430), type on a path brackets, flip and Type on a Path Options that keep the type in place (#429), Layers rows dragged with a ghost and dropped on the trash or New Layer (#435), tool flyouts opening on a right or corner press (#436), tool flyouts torn off into floating toolbars (#437), the Shape Builder's erase mode deleting edges too (#439), installed fonts registered outside the font folders and fonts installed while the app runs listed in the font menus (#443), alike circular corners on rectangles that aren't square (#442), tool cursors as OS cursors so the pointer no longer trails over the canvas (#444), artboards copied and pasted with their art (#446), guides dragged out of the rulers snapping to the art's side midpoints and the artboards, artboard guides (#451), the toolbar's double arrow and Window › Toolbars › Double Column switching between one and two columns in any window height (#455), the Smart Guides display options and Snapping Tolerance (#394), Font Size and Leading combo boxes with preset lists in the Character and Properties panels and the Control bar (#458), screenshots pasted from the clipboard on macOS, Windows and the web (#457), the Properties panel's Fill and Stroke matching the Control bar's, Illustrator's Window menu panel keys (Shift+F7 for Align…) and Alt-wheel zoom whatever the wheel preference (Discord feedback), the point/area type widget (Discord feedback), groups in legacy Illustrator .ai files (Discord feedback), a rotating desktop log file (#465), image controls in the Control bar and Properties panel: Image Trace with its presets, Mask, Crop Image, Embed/Unembed, and an Image Trace object's preset, Expand and Release (Discord feedback), the Pen working as the Anchor Point tool with Alt held over a selected path's handles and anchors, and anchor buttons that convert, connect and cut paths at the selected anchors (Discord feedback), Japanese hanging punctuation (burasagari, #463), Escape leaving Presentation Mode with no screen mode saved across restarts, documents dropped on the desktop app opening as tabs of their own and a note that an `.ai` file's art off its artboards isn't in the part read (#472), Add/Delete Anchor Point tool icons drawn from the Pen tool's (#479), EPS files from Illustrator 2026, Inkscape/cairo, matplotlib, CorelDRAW, Affinity, LibreOffice and Ghostscript opening as vectors, and a preview that stands in saying why (Discord feedback, #466, #469, #474), chords with modifiers recorded in Edit › Keyboard Shortcuts (#487), Type Object Selection by Path Only (#394), Anti-aliased Artwork (#394), Show Pixel Grid (#394), pen and touch taps pressed and lifted within one frame clicking where they tapped and the Linux/Wayland pen-tablet workaround (#491), bounding-box resizes landing on the other objects' anchors and centres with labels, and the Rotate, Scale, Shear and Reflect tools snapping their drags (#482), Shift-drag marquees that toggle the objects or anchors they reach and a Lasso whose Alt subtraction keeps the rest of the selection (#483), the mouse wheel stepping the focused numeric field, the dialogs' and preferences' drag values made such fields (#485), Show The Home Screen When No Documents Are Open (#394), Numbers Without Units Are Points (#394), Auto-Collapse Iconic Panels (#394), the Contextual Task Bar moved by its handle and its More Options menu pinning and resetting its position, a designed macOS DMG window (#493); see [Honest assessment](#honest-assessment-2026-10-05))._ +_Last updated: 2026-10-08 (after M4.14–M4.98, M8.1–M8.20, M14.4–M14.7, the MCP prompts, resource templates, completions and logging, the 2026-10-07 issue fixes, the Layers panel rework and the 2026-10-08 community contributions: Pen and shape-tool modifiers, path editing, Layers, Artboards, Swatches/Brushes and dialogs, Japanese composition and PDF text, Hebrew/Arabic type, interface languages (Spanish among them), the font menu, saved selections, MCP and EPS, the missing-font export warning (#319), open paths in the Shape Builder (#374), PDF/`.ai` import keeping strokes live and hidden and nested layers (#372), per-corner Live Corners (#381), SVG type opening at the size it draws at (#396), the Wayland clipboard with copied-file paste (#398), ruler guides that can be selected, moved and deleted (#414), two batches of Preferences options that were stored but unused (#394), skeleton reads with `document.find` for large documents over MCP (#416) and anchors dragged with Direct Selection snapping to points, segments and smart guides, clipped SVG layers opening as clipping layers (#420), PDF/`.ai` layers read on pages of tens of millions of operators (#419), Document Color Mode putting RGB greys on the black plate on request and converting pattern tiles (#421) and movable dialogs with Offset Path's Joins dropdown (#423) and numeric fields scrubbed by dragging their label (#400), stroke weight presets in the stroke unit (#426), the Appearance panel's Opacity popup (#430), type on a path brackets, flip and Type on a Path Options that keep the type in place (#429), Layers rows dragged with a ghost and dropped on the trash or New Layer (#435), tool flyouts opening on a right or corner press (#436), tool flyouts torn off into floating toolbars (#437), the Shape Builder's erase mode deleting edges too (#439), installed fonts registered outside the font folders and fonts installed while the app runs listed in the font menus (#443), alike circular corners on rectangles that aren't square (#442), tool cursors as OS cursors so the pointer no longer trails over the canvas (#444), artboards copied and pasted with their art (#446), guides dragged out of the rulers snapping to the art's side midpoints and the artboards, artboard guides (#451), the toolbar's double arrow and Window › Toolbars › Double Column switching between one and two columns in any window height (#455), the Smart Guides display options and Snapping Tolerance (#394), Font Size and Leading combo boxes with preset lists in the Character and Properties panels and the Control bar (#458), screenshots pasted from the clipboard on macOS, Windows and the web (#457), the Properties panel's Fill and Stroke matching the Control bar's, Illustrator's Window menu panel keys (Shift+F7 for Align…) and Alt-wheel zoom whatever the wheel preference (Discord feedback), the point/area type widget (Discord feedback), groups in legacy Illustrator .ai files (Discord feedback), a rotating desktop log file (#465), image controls in the Control bar and Properties panel: Image Trace with its presets, Mask, Crop Image, Embed/Unembed, and an Image Trace object's preset, Expand and Release (Discord feedback), the Pen working as the Anchor Point tool with Alt held over a selected path's handles and anchors, and anchor buttons that convert, connect and cut paths at the selected anchors (Discord feedback), Japanese hanging punctuation (burasagari, #463), Escape leaving Presentation Mode with no screen mode saved across restarts, documents dropped on the desktop app opening as tabs of their own and a note that an `.ai` file's art off its artboards isn't in the part read (#472), Add/Delete Anchor Point tool icons drawn from the Pen tool's (#479), EPS files from Illustrator 2026, Inkscape/cairo, matplotlib, CorelDRAW, Affinity, LibreOffice and Ghostscript opening as vectors, and a preview that stands in saying why (Discord feedback, #466, #469, #474), chords with modifiers recorded in Edit › Keyboard Shortcuts (#487), Type Object Selection by Path Only (#394), Anti-aliased Artwork (#394), Show Pixel Grid (#394), pen and touch taps pressed and lifted within one frame clicking where they tapped and the Linux/Wayland pen-tablet workaround (#491), bounding-box resizes landing on the other objects' anchors and centres with labels, and the Rotate, Scale, Shear and Reflect tools snapping their drags (#482), Shift-drag marquees that toggle the objects or anchors they reach and a Lasso whose Alt subtraction keeps the rest of the selection (#483), the mouse wheel stepping the focused numeric field, the dialogs' and preferences' drag values made such fields (#485), Show The Home Screen When No Documents Are Open (#394), Numbers Without Units Are Points (#394), Auto-Collapse Iconic Panels (#394), the Contextual Task Bar moved by its handle and its More Options menu pinning and resetting its position, a designed macOS DMG window (#493), panels, panel groups and the Tools panel undocking into floating panels that move, stack and dock again (#495), the 0.5.0 startup crash on dual-GPU Linux desktops under Wayland fixed: the desktop's own GPU by default and a restart on the next GPU when one can't show the window (#502), path editing while drawing: Cmd/Ctrl with the Pen borrowing Direct Selection and drawing on afterwards, Pen+Alt reshaping segments, handles of a whole selected path dragging, and handle drags no longer re-gathering snap targets every move (#494), the Control bar's and Properties panel's Convert buttons for a path selected as a whole with Direct Selection, the Pen and the anchor tools (#504), the Pen closing a path dragged out of its first anchor every time, without flicker (#501), the Paste menu checking the system clipboard on a background thread on Linux so an X11 clipboard owner that never answers no longer freezes the window (#510), PDF/`.ai` import keeping a type object's outline stroke on the type, wrapped lines as area type, barcode digits in place and layers in the file's stacking order (#508); see [Honest assessment](#honest-assessment-2026-10-05))._ ## Where we are @@ -42,7 +42,7 @@ since 2026-10-01. | **Bundled content:** brush, symbol, style and swatch libraries | ~30% | Ours are original and generated in code, and far fewer than Illustrator ships; brush and symbol libraries are still missing | | **Performance** | unverified | Multithreaded, off-thread rendering and caches are in place. The last budget run (2026-10-01, loaded machine) measured 290 ms for a 50k-path fit against a 16 ms budget. Re-run `vectorcraft-cli perf` on an idle machine | | **Robustness** | good, new | ~2,840 tests, property tests, no panics in shipped code (lints, the `guard` safety net, import fuzzing), Data Recovery. Missing: a corpus of real-world files, Windows/Linux/browser QA | -| **Platforms and 1.0 polish** | ~60% | The macOS app and the web build work, and Finder opens every readable format with the macOS app (#295, #354); hybrid-graphics laptops render on the power-saving GPU by default (#306); web drops land in the document they were dropped on (#359); desktop drops carry no pointer position (winit 0.30), so a dropped document opens as a tab of its own and a picture or text is placed in the middle of the view, while the web places anything dropped on the canvas and opens what is dropped off it, as Illustrator does (#472); a web page that loses its WebGPU device or WebGL context restarts its graphics with the same documents (#369); on Linux/Wayland the clipboard reads the compositor's own (data-control) and copied image files paste, but files can't be dropped on the window under Wayland until eframe moves to winit 0.31 (#398; the Wayland side is verified by compilation only); on KDE Plasma 6.3+ under Wayland, pens and pen displays reach the app only under XWayland (`WAYLAND_DISPLAY=`) or with KWin's `KWIN_WAYLAND_EMULATE_TABLET=1`, since winit 0.30 has no Wayland tablet input (#491, not verified on hardware); Windows/Linux packaging and accessibility are pending; an experimental, unsupported Windows 7 x64 OpenGL build exists (community-contributed, not verified by maintainers) | +| **Platforms and 1.0 polish** | ~60% | The macOS app and the web build work, and Finder opens every readable format with the macOS app (#295, #354); hybrid-graphics laptops render on the power-saving GPU by default on Windows and macOS (#306), and Linux on the GPU the desktop runs on, since a Wayland compositor may refuse frames from the other one; a window that fails on its GPU while starting up starts again on the next one instead of crashing (#502; the dual-GPU Wayland case is verified by unit tests and cross-compilation, not on such hardware); web drops land in the document they were dropped on (#359); desktop drops carry no pointer position (winit 0.30), so a dropped document opens as a tab of its own and a picture or text is placed in the middle of the view, while the web places anything dropped on the canvas and opens what is dropped off it, as Illustrator does (#472); a web page that loses its WebGPU device or WebGL context restarts its graphics with the same documents (#369); on Linux/Wayland the clipboard reads the compositor's own (data-control) and copied image files paste, but files can't be dropped on the window under Wayland until eframe moves to winit 0.31 (#398; the Wayland side is verified by compilation only); on Linux the Paste menu checks the system clipboard on a background thread, so a clipboard owner that never answers no longer freezes the window, while Windows and macOS keep their quick in-line check (#510; the X11 hang verified by the contributor, here by headless tests); on KDE Plasma 6.3+ under Wayland, pens and pen displays reach the app only under XWayland (`WAYLAND_DISPLAY=`) or with KWin's `KWIN_WAYLAND_EMULATE_TABLET=1`, since winit 0.30 has no Wayland tablet input (#491, not verified on hardware); Windows/Linux packaging and accessibility are pending; an experimental, unsupported Windows 7 x64 OpenGL build exists (community-contributed, not verified by maintainers) | | **Agent automation** | beyond Illustrator | Every command, gesture and dialog is drivable over MCP, the CLI and the control channel | | **Scrubby numeric fields** | beyond Illustrator | As in Photoshop, dragging a numeric field's label (`W:`, `Opacity:`, the Character panel's icons) left or right steps its value live; one undo step per drag, Escape cancels (#400) | @@ -100,6 +100,7 @@ grade by behaviour against `plan/illustrator/`, not by whether a menu item exist - Hint bar, contextual task bar, 19 dock panels with ≡ menus. - The contextual task bar's handle drags it anywhere on the canvas (kept whole on it as the window resizes); unpinned it keeps that offset as it follows the selection, and its More Options menu hides it, pins its position across selection changes (`window.taskBar.pin`), resets it under the selection (`window.taskBar.reset`) and shows the Properties panel. As in Illustrator the position isn't kept across launches. Not done: the bar's tool-specific variants (only the selection tools show it). - Tool flyouts tear off: dragging or clicking the tear-off bar on a flyout's right side (or releasing the long press over it) floats its group as a strip of tool buttons, moved by the same bar and put back in the toolbar by the × at its top (`window.floatTools`). While a group floats, the presses that would open its flyout raise the strip instead. Floating strips are kept with the preferences and in user workspaces. Not done: turning a strip vertical, docking it. + - Panels undock (#495): a dock tab, a panel icon or a popped-out panel's title dragged out of the dock floats that panel inside the window, and the strip right of the dock's tabs floats the whole tabbed group. A floating group moves by its title bar, a tab dragged out of it floats on its own, and dropped on another group's title bar or tabs it stacks with that group; dropped on the dock, which lights up under the pointer, its panels go back where they live (the tabbed group or the icon column), as its × and the panel menus' Float Panel / Dock Panel do (`window.panel.float`, `window.panel.dock`). The Tools panel floats by its title bar and docks again on the window's left edge. Floating panels and the Tools panel's position are kept with the preferences and in user workspaces, and clamped into a smaller window. Not done: panels in separate OS windows, docking a panel into a dock group it doesn't belong to, reordering tabs by dragging, collapsing a floating group to icons, resizing floating panels. - The dock's double arrow collapses Properties, Layers and Libraries to icons at the top of the icon column, popping out like the other icon panels, and expands them again (`window.collapseDock`, kept with the preferences and in saved workspaces). The icon column's own arrow (expanding the icon panels into a full column) is not done. - Localised UI: menus (in-window and native), panels, dialogs, toolbar and Preferences read from per-language catalogs (`crates/ui-egui/src/i18n`, see `docs/development.md`); Traditional Chinese (Taiwan), Simplified Chinese (mainland), Japanese and Spanish ship complete, and Czech and Brazilian Portuguese cover every menu label (and more), with system-locale detection on macOS, Windows, Linux and the web (the browser's languages, or `?lang=`), a VectorCraft ▸ Language menu and a Language preference. Names are never translated (fonts and their styles, layers, artboards, saved presets, user libraries, custom workspaces, recent files, plug-ins). - Native macOS menu bar, vector tool cursors, a ⌘K command palette, middle-button panning with any tool. @@ -122,7 +123,8 @@ grade by behaviour against `plan/illustrator/`, not by whether a menu item exist - **Cutting:** Eraser, Scissors, Knife, Mirror & Cut, Line Cut and Rectangle Cut (real geometry, compound paths keep their holes). - **Transform:** Rotate, Reflect, Scale, Shear (click or Alt-click snaps the reference point to anchors and centres; Alt-click opens the tool's dialog, and a drag with Alt down at the release, from the press or pressed mid-drag, transforms a copy), Reshape, Free Transform (free and perspective distort and shear, switched by the keys held during a handle drag). - **Live Corners:** drag a live rectangle's corner widgets (Selection or Direct Selection) to round all corners, with a radius readout; with Direct Selection, select corner anchors to show and round just those corners (#381). Each corner keeps its own radius and kind (Round, Inverted Round, Chamfer): Alt-click a widget to cycle the kind, double-click it for the Corners dialog, and the Properties and Transform radius fields set the selected corners (`object.setLiveShape {corners, radius, kind}`). Corners stay circular when the rectangle is scaled unevenly or along its own sides when rotated (the radius keeps its size, or scales by the mean scale with Scale Corners on); only a shear distorts them. On a rectangle that isn't square every corner is the same circle: a radius past half the shorter side stops there for all of them, the widgets sit on the corners as drawn and turn the edited corners red at that limit, CSS export writes the drawn radii, and rectangles saved stretched by older versions get circular corners when their corners are next set (#442). - - **Pen:** Alt pressed in the middle of dragging out an anchor splits its handles and keeps the curve already shaped into it (only the outgoing handle follows the pointer); Space held while dragging out an anchor moves it, handles and all. Clicking the last anchor of the path being drawn retracts its outgoing handle (convert cursor), and dragging from it pulls out a new one on its own. Auto Add/Delete: over a selected path, a click on a segment adds an anchor and a click on an anchor deletes it (add and delete cursors); Shift held, or Preferences › General › Disable Auto Add/Delete, starts a new path instead. Alt held over a handle end or an anchor of a selected path (the one being drawn too) works as the Anchor Point tool, with its convert cursor: dragging a handle moves it alone, clicking a smooth anchor makes it a corner, dragging an anchor pulls out new symmetric handles; drawing then goes on. + - **Pen:** Alt pressed in the middle of dragging out an anchor splits its handles and keeps the curve already shaped into it (only the outgoing handle follows the pointer); Space held while dragging out an anchor moves it, handles and all. A press on the first anchor of the path being drawn closes it whatever the drag then does: the drag shapes the closing curve (symmetric handles, Alt breaks them) and the release closes the path wherever it ends (#501). Clicking the last anchor of the path being drawn retracts its outgoing handle (convert cursor), and dragging from it pulls out a new one on its own. Auto Add/Delete: over a selected path, a click on a segment adds an anchor and a click on an anchor deletes it (add and delete cursors); Shift held, or Preferences › General › Disable Auto Add/Delete, starts a new path instead. Alt held over a handle end or an anchor of a selected path (the one being drawn too) works as the Anchor Point tool, with its convert cursor: dragging a handle moves it alone, clicking a smooth anchor makes it a corner, dragging an anchor pulls out new symmetric handles, dragging a segment reshapes it; drawing then goes on. Cmd (Ctrl) held drags with the selection tool chosen last, Direct Selection until one is (handles, anchors and segments of the path being drawn or another), and the Pen then goes on drawing its path while that stays selected; the pointer shows that tool's while Cmd is held. The same holds for agents (`pointer_gesture` with `mods.cmd`), as the borrowing now lives in the engine (#494). + - **Path editing (#494):** the handles shown are the handles that drag: Direct Selection drags those of a path selected as a whole (as the Pen leaves it), the Anchor Point tool and Pen+Alt no longer grab handles that Show handles when multiple anchors are selected hides, a handle shorter than the tolerance leaves its anchor to be picked, and the anchor tools pick within Selection & Anchor Display › Tolerance. A dragged segment keeps a smooth anchor at either end smooth. With Direct Selection, the Pen, the Curvature and the anchor tools, a path selected as a whole shows all its anchors selected, and the Control bar and the Properties panel offer Convert (corner, smooth) for them too; Remove and Cut wait for anchors direct-selected (#504). A handle drag gathers its snap targets once per drag (it took 21 ms per pointer move on a 20,000-path document, now 1 ms; `vectorcraft-cli perf` measures handle and segment drags on a 5,000-anchor path). - **Graphs:** Column, Stacked Column, Bar, Stacked Bar, Line, Area, Scatter, Pie and Radar graph tools with Graph Data and Graph Type. - **Other:** Eyedropper, Gradient annotator, Artboard (Alt-drag duplicates an artboard, and its art with Move/Copy Artwork with Artboard on; Copy, Cut and Paste take the artboard with its art, Paste right of the last artboard, Paste in Place where it was, into this or another document, #446), Measure, Type, Hand, Zoom, Rotate View. - **Editing type:** double-clicking type with a selection tool switches to the Type tool with the caret where it was clicked. @@ -153,12 +155,12 @@ grade by behaviour against `plan/illustrator/`, not by whether a menu item exist - **Fonts:** a font is found by any of its names (family and style in every language of its name table, legacy family/style pairs, PostScript name), so documents from other apps open with the font they name; Find Font and `text.fonts` say for each font whether it was found exactly, by another name, substituted or missing, and how many glyphs are missing. PDF and `.ai` import brings Japanese text back as live type: CID fonts without a ToUnicode map read through the standard CMaps, vertical columns (WMode 1) as vertical type, letter spacing as tracking; a glyph is live type only when the installed font (in the closest style of its family) draws the same glyph, and text in a font that isn't installed comes in as live type shown in the fallback font until the font is installed (exports that draw it — PDF, EPS, EMF/WMF, raster, SVG outlines or embedded fonts — warn that they wrote the fallback font; `textAs: outlines` keeps the PDF's embedded glyphs). - **Files (M4):** - `.vectorcraft` (lossless JSON, compressed, atomic saves, save down to v1), Save As with a format chooser, Save a Copy, Revert, templates, Data Recovery after a crash (browser tabs hold their copies with Web Locks too, so a background tab's copies are never taken for a crash's, and a tab repairs copies another removed when it resumes: #367), background save and export. The desktop app writes its warnings and errors (graphics adapter, a lost graphics device, panics the guard recovered from) to standard error and to `logs/vectorcraft.log` next to the preferences, the two previous runs kept and each file capped at 16 MiB, so a launch without a terminal still leaves something to attach to a bug report (#465). - - SVG/SVGZ in and out with SVG Options, Preserve Editing, symbols, filters, rich text and physical units (SVG type under a transform or `viewBox` scale opens at the size it draws at, the scale moved into its size, leading, baseline shift and strokes, a stretch, skew or rotation kept as its transform: #396; a top-level group with a clip path, such as a clipped Inkscape layer, opens as a layer with a clipping mask, its name kept: #420); PDF and PDF-compatible `.ai` in and out (layers, with hidden ones kept hidden with their art and nested ones as sublayers, on pages of up to 64 million operators, art whose layer can't be told going to a hidden, non-printing layer rather than showing or printing: #419; strokes kept live, a fill and a stroke of one outline as one object; masks, editable text with type set along a curve coming back as type on a path, each artboard's art on its own page only, an `.ai`'s white page under its layers left out rather than coming in as art, spot colours, presets, security, marks and bleed, ICC output intents, raster effects, subset fonts, PDF/X, PDF layers, overprint, page thumbnails, fast web view, PDF 1.3). CMYK images keep their ink amounts from PDF import (and from placed CMYK TIFFs) to PDF export: a CMYK JPEG passes through unchanged, others stay CMYK (DeviceCMYK, or ICC-based CMYK in PDF/X-3/X-4) unless the Output settings convert them; the canvas shows them through the working CMYK profile (#320). + - SVG/SVGZ in and out with SVG Options, Preserve Editing, symbols, filters, rich text and physical units (SVG type under a transform or `viewBox` scale opens at the size it draws at, the scale moved into its size, leading, baseline shift and strokes, a stretch, skew or rotation kept as its transform: #396; a top-level group with a clip path, such as a clipped Inkscape layer, opens as a layer with a clipping mask, its name kept: #420); PDF and PDF-compatible `.ai` in and out (layers, with hidden ones kept hidden with their art and nested ones as sublayers, on pages of up to 64 million operators, art whose layer can't be told going to a hidden, non-printing layer rather than showing or printing: #419; strokes kept live, a fill and a stroke of one outline as one object; a type object's stroke written as each glyph's outline stroked back on the type, so it stays one editable object; lines wrapped in a frame (each wrapped line ending in a space, one left edge, leading and font) back as one area type object, left aligned or justified with its paragraph spacing, where laying it out breaks the lines where the file does; glyphs set apart by gaps wider than a space (a barcode's digit groups) keeping their places; layers stacked as the pages mark them even when one first paints on a later page, art ending a layer's marked content or a clip closing in a later layer kept in its own layer, and layers with no art kept empty: #508; masks, editable text with type set along a curve coming back as type on a path, each artboard's art on its own page only, an `.ai`'s white page under its layers left out rather than coming in as art, spot colours, presets, security, marks and bleed, ICC output intents, raster effects, subset fonts, PDF/X, PDF layers, overprint, page thumbnails, fast web view, PDF 1.3). CMYK images keep their ink amounts from PDF import (and from placed CMYK TIFFs) to PDF export: a CMYK JPEG passes through unchanged, others stay CMYK (DeviceCMYK, or ICC-based CMYK in PDF/X-3/X-4) unless the Output settings convert them; the canvas shows them through the working CMYK profile (#320). - EPS and DXF in and out, EMF/WMF in and out; PNG (with PNG-8), JPEG, WebP, GIF, TIFF, BMP, Targa and layered PSD export. EPS import runs Illustrator's AGM/CoolType prologs (resource categories, `resourceforall`, `clipsave`/`cliprestore`, subarrays and substrings that share storage, the standard dictionaries in `systemdict`, `dictstack`, `internaldict`, executable filters, `cshow`, metadata skipped with `flushfile`), so Illustrator 30 EPS files open as vectors. It also runs what other generators write (Discord feedback, #466, #469): Illustrator 2026's procsets (`gcheck`, `rootfont`, `currentcolorrendering`: every Illustrator 2026 EPS fell back to its preview before), cairo/Inkscape (`status`/`flushfile`, images with a mask, `ImageType 3`, reusable streams), matplotlib's Type 3 fonts, Illustrator 8 EPS (stock art's usual format: executable strings such as its gradients' `ed`, `load` by integer keys, #474), Ghostscript's `//name` immediate names, `pdfmark`, `token`, `execform` and user paths. Tiling patterns come in as pattern swatches, uncoloured ones too; Type 3 fonts' glyphs as their outlines, spaced by `ashow`/`widthshow`/`xshow`/`kshow`; mesh and function-based shadings (types 1, 4–7) as gradient meshes; sampled functions (type 0) and Flate/LZW predictors are read. When a file's PostScript still can't be read, it opens as its TIFF preview, its Windows metafile preview (as vectors) or its EPSI preview, and the warning (in the status bar, `document.open`/`app.open`/MCP `open_file` replies and `vectorcraft-cli info`) names the error, the operator that raised it and the procedures it ran in. Legacy PostScript `.ai` files (Illustrator 3–8, written with the prolog that defines their operators) keep their groups and nested groups (`u` … `U`), between and inside clipping groups; EPS and EMF/WMF import nest clips (and groups) at most 128 deep, so a hostile file can't exhaust the stack. DXF TEXT justified Fit or Aligned spans its two points (stretched, or scaled as a whole). - Affinity `.af` preview import: Open follows the container's indexed version-12 `Thmb` PNG record, verify dimensions and decoded pixels with limits, and report that native vectors, layers, text, effects, pages and colour settings were omitted. The preview can be downscaled; files without this verified record fail. Open drops the source save path, and Affinity export is unsupported. Place (including queued or renamed files) is refused so the preview cannot silently replace native art. This is an initial reader, not editable native support; [scope, provenance and remaining work](crates/affinity/README.md). - - Place and the Links panel, Package, File Info, Print with print presets, PostScript output and print tiling, slices and Save for Web, Export for Screens and Asset Export, CSS Properties, PNG/PDF/SVG/text clipboard flavours; files copied in a file manager paste as art (SVG, PDF, EMF/WMF, bitmaps) on every desktop platform, and Linux/Wayland reads the compositor's clipboard (#398); screenshots and other copied pictures paste as embedded images at the view centre everywhere, the web included (#457). + - Place and the Links panel, Package, File Info, Print with print presets, PostScript output and print tiling, slices and Save for Web, Export for Screens and Asset Export, CSS Properties, PNG/PDF/SVG/text clipboard flavours; files copied in a file manager paste as art (SVG, PDF, EMF/WMF, bitmaps) on every desktop platform, and Linux/Wayland reads the compositor's clipboard (#398); on Linux the Paste menu checks the clipboard off the UI thread, so an X11 owner that never answers can't freeze the window (#510); screenshots and other copied pictures paste as embedded images at the view centre everywhere, the web included (#457). - **Performance:** 20k shapes + 1k texts render in 27 ms per full-retina frame (7.8 ms zoomed), 7× faster than the first version. The UI thread never blocks. The web build is 7.1 MB gzipped. -- **Graphics processor:** the canvas is rasterized on the CPU and the GPU only composites it, so the desktop app asks for the power-saving GPU by default (the integrated one on hybrid-graphics laptops, where presenting from the discrete GPU made the window flicker, #306). Preferences › Performance › Graphics Processor (`gpuPreference`) or `WGPU_POWER_PREF` picks the discrete one; Help › About and `ui.inspect` name the adapter in use. When the browser drops the page's WebGPU device or WebGL context, the web build writes recovery copies, starts again on new graphics with the same app and uploads its textures again; if it can't, it removes the stale canvas and says to reload, which offers the copies back. The desktop app writes the copies and says to restart (#369). On Windows and Linux the tools' cursors are OS cursors (bitmaps rasterized once per display scale), which the system moves itself: painted into the window, they trailed the pointer by the frames waiting to be shown, and the window now queues one frame instead of two (#444). macOS and the web still paint them (macOS sizes cursor bitmaps in points, eframe has no bitmap cursors on the web). Pens and touch drive the tools as the mouse does, and a tap pressed and lifted within one frame clicks where it tapped (#491); pen pressure reaches the Liquify tools' Use Pressure Pen on Windows, while winit 0.30 reports none on macOS or Linux and egui none on the web. On Linux, see `docs/development.md` for pens under Wayland. +- **Graphics processor:** the canvas is rasterized on the CPU and the GPU only composites it, so any GPU that can show the window will do. Preferences › Performance › Graphics Processor (`gpuPreference`) is Automatic by default: the power-saving GPU on Windows and macOS (the integrated one on hybrid-graphics laptops, where presenting from the discrete GPU made the window flicker, #306), and the GPU the desktop runs on under Linux, where KWin on an NVIDIA GPU refused frames from a Ryzen's integrated GPU and 0.5.0 crashed at startup (#502). Power Saving and High Performance pick a kind of GPU; `WGPU_POWER_PREF`, `WGPU_ADAPTER_NAME` and `WGPU_BACKEND` override them. The app picks among the adapters that can present to the window (native backends before OpenGL, hardware before software), and if the window fails on one while starting up it starts again without it instead of crashing; Help › About, `ui.inspect` and the log name the adapter in use. When the browser drops the page's WebGPU device or WebGL context, the web build writes recovery copies, starts again on new graphics with the same app and uploads its textures again; if it can't, it removes the stale canvas and says to reload, which offers the copies back. The desktop app writes the copies and says to restart (#369). On Windows and Linux the tools' cursors are OS cursors (bitmaps rasterized once per display scale), which the system moves itself: painted into the window, they trailed the pointer by the frames waiting to be shown, and the window now queues one frame instead of two (#444). macOS and the web still paint them (macOS sizes cursor bitmaps in points, eframe has no bitmap cursors on the web). Pens and touch drive the tools as the mouse does, and a tap pressed and lifted within one frame clicks where it tapped (#491); pen pressure reaches the Liquify tools' Use Pressure Pen on Windows, while winit 0.30 reports none on macOS or Linux and egui none on the web. On Linux, see `docs/development.md` for pens under Wayland. - **Tests and robustness:** ~2,840 automated tests: model-based property tests, a junk-parameter sweep over every command, import fuzzing (SVG, PDF, libraries), golden renders, and MCP end-to-end tests over stdio. Shipped code never panics (workspace lints and a rollback safety net; see `docs/development.md`). ## Milestones and estimates @@ -218,7 +220,7 @@ about 1–1.5 agent-hours each, so the other rows (estimated on the older scale) | Export for Screens, Asset Export, slices, Save for Web | 3 | 85% | polish only (all four are done) | 2–4 | | Print, colour management, separations, flattener | 3 | 80% | print preview fidelity (flattener presets in PDF and print, overprint in PDF and composite print, Print dialog, presets, PostScript, marks, separations, Print Tiling, print overprint/flattener/bitmap options and printer profile are done) | 1–2 | | Automation | 3 | 60% | Variables (data merge), scripting surface, batch | 8–12 | -| UI chrome (panels, contextual Properties, workspaces, prefs) | 6 | 78% | Variables, SVG Interactivity, Properties per context, Consolidate All Windows, context menus beyond the canvas (Links, Asset Export, CSS Properties, Attributes and the canvas context menu are done), about 32 Preferences options stored but not yet acted on (#394: Construction and Spacing Guides, Auto Size New Area Type, Show Font Names in English, Highlight Alternate Glyphs, performance, devices…) | 14–22 | +| UI chrome (panels, contextual Properties, workspaces, prefs) | 6 | 78% | Variables, SVG Interactivity, Properties per context, Consolidate All Windows, floating panels outside the app window and docked into any group, context menus beyond the canvas (Links, Asset Export, CSS Properties, Attributes and the canvas context menu are done), about 32 Preferences options stored but not yet acted on (#394: Construction and Spacing Guides, Auto Size New Area Type, Show Font Names in English, Highlight Alternate Glyphs, performance, devices…) | 14–22 | | Libraries, Links, Package | 2 | 50% | a local Libraries panel (no cloud by design); Links and Package are done | 5–8 | | **Feature parity** | **103** | **~75%** | | **~210–330** | | Interaction-fidelity pass (side by side with Illustrator: every tool modifier, cursor, dialog, Properties context) | | | | 60–90 | @@ -238,7 +240,7 @@ lossless SVG/PDF export of live effects with SVG filters, a documented JSON form command, gesture and dialog drivable by agents (MCP, CLI, control channel). ## Out of scope (by design or by law) -- **Native `.ai` private data:** it's undocumented. We read the PDF-compatible part, so Illustrator-only live objects arrive as appearance, and plain groups arrive ungrouped: that part draws each object on its own and marks only layers, clipping groups and groups with opacity, blending or a mask (those come back). Art outside the artboards isn't in that part at all (Illustrator's PDF part leaves it out), so it doesn't open; the import says so in a note (#472). Art off the page that a PDF does draw opens on the pasteboard. +- **Native `.ai` private data:** it's undocumented. We read the PDF-compatible part, so Illustrator-only live objects arrive as appearance, and plain groups arrive ungrouped: that part draws each object on its own and marks only layers, clipping groups and groups with opacity, blending or a mask (those come back). Art outside the artboards isn't in that part at all (Illustrator's PDF part leaves it out), so it doesn't open; the import says so in a note (#472). That part also has no paragraphs: area type is written line by line, and comes back as area type only where its font is installed and lays the lines out with the same breaks, else as a point type object per line (#508). Art off the page that a PDF does draw opens on the pasteboard. - **Adobe cloud services** (Libraries sync, Adobe Fonts, Firefly/generative): these are pluggable provider APIs, not built in. - **Adobe's bundled assets** (swatch/brush/symbol libraries, presets, icons): ours are original. diff --git a/apps/vectorcraft-cli/src/perf.rs b/apps/vectorcraft-cli/src/perf.rs index f13b0cbe..41da4abc 100644 --- a/apps/vectorcraft-cli/src/perf.rs +++ b/apps/vectorcraft-cli/src/perf.rs @@ -70,6 +70,49 @@ fn load_average() -> Option { text.split_whitespace().map(|t| t.trim_matches(|c| c == '{' || c == '}')).find_map(|t| t.parse().ok()) } +/// Milliseconds per pointer move of a Direct Selection drag of a handle, then of a segment, of a +/// 5,000-anchor wave of smooth anchors added on top of the synthetic `n`-path document. +fn edit_drags(n: usize) -> Result<(f64, f64), String> { + use vectorcraft_engine::tools::{Mods, PointerEvent, PointerKind}; + use vectorcraft_geom::{Anchor, PathData, SubPath, Vec2}; + let mut doc = synthetic(n)?; + let l = doc.layers.first().map(|l| l.id); + let id = doc.alloc_id(); + // Anchors 2 pt apart, up and down by 20 pt, their handles 0.6 pt long. + let anchor = |i: usize| { + let p = Point::new(i as f64 * 2.0, if i.is_multiple_of(2) { 500.0 } else { 520.0 }); + Anchor::smooth(p, p + Vec2::new(0.6, 0.0)) + }; + let path = PathData::single(SubPath::new((0..5000).map(anchor).collect(), false)); + doc.insert(l, usize::MAX, Node::path(id, path, Appearance::default_art())).map_err(|e| e.to_string())?; + let mut s = vectorcraft_engine::Session::new(); + s.add_document(doc, None); + let view = vectorcraft_engine::ViewInfo { zoom: 8.0, ..Default::default() }; + let err = |e: vectorcraft_engine::EngineError| e.to_string(); + let mut drag = |down: Point| -> Result { + let ev = |kind, y: f64| PointerEvent { kind, pos: down + Vec2::new(0.0, y), mods: Mods::default(), pressure: 1.0 }; + s.execute("select.anchors", &json!({"id": id.0, "anchors": [[0, 400]]})).map_err(err)?; + s.select_tool("directSelection", view).map_err(err)?; + let undo = s.doc().map_err(err)?.history.undo.len(); + s.pointer(&ev(PointerKind::Down, 0.0), view).map_err(err)?; + let mut y = 0.0; + let ms = median_ms(9, || { + y += 3.0; + // A failed move shows as the missing undo step below. + let _ = s.pointer(&ev(PointerKind::Drag, y), view); + }); + s.pointer(&ev(PointerKind::Up, y), view).map_err(err)?; + if s.doc().map_err(err)?.history.undo.len() != undo + 1 { + return Err(format!("the drag from {down:?} made no undo step")); + } + Ok(ms) + }; + // Anchor 400 is at (800, 500): its outgoing handle's end, then its segment to anchor 401. + let handle = drag(Point::new(800.6, 500.0))?; + let segment = drag(Point::new(801.0, 510.0))?; + Ok((handle, segment)) +} + pub fn run(args: &[String]) -> Result<(), String> { let mut n = 50_000usize; let mut it = args.iter(); @@ -145,6 +188,15 @@ pub fn run(args: &[String]) -> Result<(), String> { } }); rows.push(("Pathfinder Unite, 1,000 paths", unite, 150.0)); + + // Path editing: one pointer move of a Direct Selection drag (the tool event and the preview it + // applies), on a 5,000-anchor path among the synthetic paths. + let (handle, segment) = edit_drags(n).unwrap_or_else(|e| { + failed = Some(e); + (0.0, 0.0) + }); + rows.push(("handle drag, 5,000-anchor path (per move)", handle, 8.0)); + rows.push(("segment drag, 5,000-anchor path (per move)", segment, 8.0)); if let Some(e) = failed { return Err(e); } diff --git a/apps/vectorcraft/src/gpu.rs b/apps/vectorcraft/src/gpu.rs new file mode 100644 index 00000000..b195d5ec --- /dev/null +++ b/apps/vectorcraft/src/gpu.rs @@ -0,0 +1,470 @@ +//! Which graphics adapter the window renders with (#306, #502), and what happens when it can't +//! show the window. +//! +//! The canvas is rasterized on the CPU; the GPU only composites it and draws the UI, so any +//! adapter that can present to the window will do. [`adapter_order`] ranks the adapters: those that +//! can't present to the window's surface never, then the one `WGPU_ADAPTER_NAME` names, hardware +//! before software, the native backends (Vulkan, Metal, DX12) before OpenGL, and the power +//! preference ([`power_preference`]) among the rest. eframe is handed [`selector`], which takes +//! the first of that order. +//! +//! An adapter can report that it presents to the window and still fail once it does: on a hybrid +//! Linux desktop under Wayland, the compositor runs on one GPU and may refuse the frame buffers +//! another GPU allocates, which kills the window's Wayland connection; egui-wgpu then panics while +//! configuring the surface (#502). Nothing in the process can show a window after that, so when +//! the graphics fail while the window is starting up, [`finish`] starts the app again without +//! that adapter, as the next one in the order would be tried. Each restart leaves out one more +//! adapter, so it ends when none is left. + +use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::{Arc, OnceLock}; + +use eframe::egui_wgpu::NativeAdapterSelectorMethod; +use eframe::wgpu::{self, Backend, DeviceType, PowerPreference}; + +/// The adapters a restart leaves out, those the window failed on, as comma-separated +/// `backend:vendor:device` keys (`Vulkan:1002:164e`). Set by the app itself when it starts again. +pub const SKIP_ENV: &str = "VECTORCRAFT_GPU_SKIP"; + +/// wgpu's variable for choosing an adapter by (part of) its name, any case. +const NAME_ENV: &str = "WGPU_ADAPTER_NAME"; + +/// Where to read how to choose another adapter, for the error that ends the app. +const HELP: &str = + "to choose a graphics adapter, see https://github.com/storytold/vectorcraft/blob/main/docs/development.md#desktop-graphics-processor"; + +/// Frames the UI ran before the failure, below which it was still starting up. The failure in +/// #502 came on the first or second frame; later, the adapter has proved itself, and a lost +/// window is something else (such as the compositor restarting). +const STARTUP_FRAMES: u64 = 10; + +/// The preference used when Preferences say Automatic. Windows and macOS show frames from any GPU +/// (the integrated one avoids the flicker of #306). Elsewhere, the system's own order: Mesa's +/// device-select layer puts the GPU the desktop runs on first (the integrated one on hybrid +/// laptops), and a Wayland compositor may not show frames from another GPU (#502). +pub const AUTOMATIC: PowerPreference = if cfg!(any(windows, target_os = "macos")) { PowerPreference::LowPower } else { PowerPreference::None }; + +/// The power preference that orders the adapters: the `WGPU_POWER_PREF` environment variable +/// (`low`, `high`, `none`) when set, otherwise Preferences › Performance › Graphics Processor +/// (`gpuPreference`). Automatic, and any value this version doesn't know (0.5.0's default +/// `powerSaving`, a newer or damaged preference file), is [`AUTOMATIC`]. +pub fn power_preference(pref: Option<&str>, env: Option) -> PowerPreference { + match (env, pref) { + (Some(p), _) => p, + (None, Some("highPerformance")) => PowerPreference::HighPerformance, + (None, Some("lowPower")) => PowerPreference::LowPower, + (None, _) => AUTOMATIC, + } +} + +/// One adapter, as [`adapter_order`] sees it. +#[derive(Clone, Debug)] +pub struct Candidate { + /// Identifies the adapter across a restart: `backend:vendor:device` ([`key`]). + pub key: String, + pub name: String, + pub backend: Backend, + pub device_type: DeviceType, + /// Reports that it can present to the window's surface. + pub presents: bool, +} + +impl Candidate { + fn new(adapter: &wgpu::Adapter, surface: Option<&wgpu::Surface<'_>>) -> Self { + let info = adapter.get_info(); + Self { + key: key(info.backend, info.vendor, info.device), + presents: surface.is_none_or(|s| adapter.is_surface_supported(s)), + name: info.name, + backend: info.backend, + device_type: info.device_type, + } + } +} + +/// `backend:vendor:device`, e.g. `Vulkan:1002:164e` (PCI ids, as `MESA_VK_DEVICE_SELECT` takes them). +fn key(backend: Backend, vendor: u32, device: u32) -> String { + format!("{backend:?}:{vendor:04x}:{device:04x}") +} + +/// The order to try `candidates` in (their indices): only those that present to the window and +/// aren't in `skip`; the one whose name contains `named` (any case) first; hardware before +/// software; native backends before OpenGL; then by `power`, keeping the system's order among +/// equals (all of it for [`PowerPreference::None`]). +pub fn adapter_order(candidates: &[Candidate], power: PowerPreference, named: Option<&str>, skip: &[String]) -> Vec { + let named = named.map(str::to_lowercase).filter(|n| !n.is_empty()); + let mut order: Vec<(usize, &Candidate)> = candidates.iter().enumerate().filter(|(_, c)| c.presents && !skip.contains(&c.key)).collect(); + // Stable, so equals keep the system's order. + order.sort_by_key(|(_, c)| { + let unnamed = named.as_ref().is_some_and(|n| !c.name.to_lowercase().contains(n)); + (unnamed, c.device_type == DeviceType::Cpu, c.backend == Backend::Gl, power_rank(c.device_type, power)) + }); + order.into_iter().map(|(i, _)| i).collect() +} + +/// wgpu's own ranking for a power preference: the preferred kind of GPU, the other kind, unknown, +/// virtual, software. +fn power_rank(t: DeviceType, power: PowerPreference) -> u8 { + match (power, t) { + (PowerPreference::None, _) => 0, + (PowerPreference::LowPower, DeviceType::IntegratedGpu) | (PowerPreference::HighPerformance, DeviceType::DiscreteGpu) => 0, + (_, DeviceType::IntegratedGpu | DeviceType::DiscreteGpu) => 1, + (_, DeviceType::Other) => 2, + (_, DeviceType::VirtualGpu) => 3, + (_, DeviceType::Cpu) => 4, + } +} + +/// The adapters [`SKIP_ENV`] lists. +pub fn skipped() -> Vec { + std::env::var(SKIP_ENV).map(|v| parse_skip(&v)).unwrap_or_default() +} + +fn parse_skip(v: &str) -> Vec { + v.split(',').map(str::trim).filter(|k| !k.is_empty()).map(String::from).collect() +} + +/// What the window's start-up leaves for [`finish`]. +#[derive(Default)] +pub struct Startup { + /// The key of the adapter [`selector`] picked. + adapter: OnceLock, + /// The UI's context, which counts the frames run. + ui: OnceLock, +} + +impl Startup { + /// The app was created on `ctx`. + pub fn created(&self, ctx: &egui::Context) { + // Set once; the window is created once. + let _ = self.ui.set(ctx.clone()); + } +} + +/// eframe's adapter choice: the first of [`adapter_order`] for `power`, `WGPU_ADAPTER_NAME` and the +/// adapters a restart left out. Every adapter and the choice are logged, for bug reports. +pub fn selector(power: PowerPreference, startup: Arc) -> NativeAdapterSelectorMethod { + let named = std::env::var(NAME_ENV).ok(); + let skip = skipped(); + Arc::new(move |adapters, surface| { + let candidates: Vec = adapters.iter().map(|a| Candidate::new(a, surface)).collect(); + let order = adapter_order(&candidates, power, named.as_deref(), &skip); + let listed: Vec = candidates + .iter() + .map(|c| { + let note = if !c.presents { + ", can't show the window" + } else if skip.contains(&c.key) { + ", failed before" + } else { + "" + }; + format!("{} ({:?}, {:?}, {}{note})", c.name.trim(), c.backend, c.device_type, c.key) + }) + .collect(); + log::info!("graphics adapters: {}", listed.join("; ")); + let first = order.first().and_then(|&i| adapters.get(i).zip(candidates.get(i))); + let Some((adapter, chosen)) = first else { + return Err(format!("no graphics adapter can show the window (power preference {power:?}, {} adapters)", adapters.len())); + }; + // Set once; eframe picks the adapter once. + let _ = startup.adapter.set(chosen.key.clone()); + Ok(adapter.clone()) + }) +} + +/// The last panic came from the graphics stack (see [`watch_panics`]). +static GRAPHICS_PANIC: AtomicBool = AtomicBool::new(false); + +/// Note whether each panic comes from the graphics stack, so [`finish`] can tell a failing adapter +/// from a bug. The default hook still prints it. +pub fn watch_panics() { + let default = std::panic::take_hook(); + std::panic::set_hook(Box::new(move |info| { + GRAPHICS_PANIC.store(info.location().is_some_and(|l| in_graphics_stack(l.file())), Ordering::Relaxed); + default(info); + })); +} + +/// A source file of wgpu (`wgpu-core-30.0.1/src/…`, `wgpu-hal-…`), egui-wgpu or naga. +fn in_graphics_stack(file: &str) -> bool { + file.split(['/', '\\']).any(|dir| ["wgpu-", "egui-wgpu-", "naga-"].iter().any(|p| dir.starts_with(p))) +} + +/// The adapter to start again without: the one picked, when the graphics failed while the window +/// was starting up and it wasn't already left out. +fn restart_without<'a>(graphics_failed: bool, frames: u64, picked: Option<&'a str>, skip: &[String]) -> Option<&'a str> { + picked.filter(|p| graphics_failed && frames < STARTUP_FRAMES && !skip.iter().any(|s| s == p)) +} + +/// After the window's run: `Ok` when it closed normally or the app started again (see the module +/// docs), otherwise why it failed. `outcome` is eframe's result, or the message of a panic that +/// ended it. +pub fn finish(outcome: Result, startup: &Startup) -> Result<(), String> { + let (why, graphics_failed) = match outcome { + Ok(Ok(())) => return Ok(()), + Ok(Err(e @ eframe::Error::Wgpu(_))) => (e.to_string(), true), + Ok(Err(e)) => (e.to_string(), false), + Err(panic) => (panic, GRAPHICS_PANIC.load(Ordering::Relaxed)), + }; + let frames = startup.ui.get().map_or(0, egui::Context::cumulative_frame_nr); + let mut skip = skipped(); + let Some(failed) = restart_without(graphics_failed, frames, startup.adapter.get().map(String::as_str), &skip) else { + return Err(if graphics_failed { format!("{why} ({HELP})") } else { why }); + }; + log::error!("the window failed on graphics adapter {failed} ({why}): starting again without it"); + skip.push(failed.to_string()); + restart(&skip.join(",")).map_err(|e| format!("{why}; starting again failed: {e}")) +} + +/// Start the app again with the same arguments, leaving out the adapters in `skip`. On Unix the +/// new app replaces this process (same process id, so an AppImage keeps its files mounted), and +/// this returns only on failure; on Windows it starts beside this one, which then exits. +fn restart(skip: &str) -> std::io::Result<()> { + log::logger().flush(); + let mut c = std::process::Command::new(std::env::current_exe()?); + c.args(std::env::args_os().skip(1)).env(SKIP_ENV, skip); + #[cfg(unix)] + { + use std::os::unix::process::CommandExt as _; + Err(c.exec()) + } + #[cfg(not(unix))] + c.spawn().map(|_| ()) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn gpu(name: &str, backend: Backend, device_type: DeviceType) -> Candidate { + Candidate { key: format!("{backend:?}:{name}"), name: name.into(), backend, device_type, presents: true } + } + + fn names(c: &[Candidate], order: &[usize]) -> Vec { + order.iter().map(|&i| c[i].name.clone()).collect() + } + + /// The machine of #502 as Vulkan lists it with Mesa's device-select layer: the GPU KDE's + /// compositor runs on (NVIDIA) first, then the Ryzen's integrated GPU, Mesa's software + /// renderer, and OpenGL. + fn issue_502() -> Vec { + vec![ + gpu("NVIDIA GeForce RTX 5070", Backend::Vulkan, DeviceType::DiscreteGpu), + gpu("AMD Ryzen 9 7900X (RADV RAPHAEL_MENDOCINO)", Backend::Vulkan, DeviceType::IntegratedGpu), + gpu("llvmpipe (LLVM 20.1.8, 256 bits)", Backend::Vulkan, DeviceType::Cpu), + gpu("NVIDIA GeForce RTX 5070/PCIe/SSE2", Backend::Gl, DeviceType::Other), + ] + } + + #[test] + fn automatic_keeps_the_systems_order_on_linux_and_saves_power_elsewhere() { + let c = issue_502(); + let order = adapter_order(&c, power_preference(None, None), None, &[]); + let first = &c[order[0]].name; + if cfg!(any(windows, target_os = "macos")) { + assert_eq!(first, "AMD Ryzen 9 7900X (RADV RAPHAEL_MENDOCINO)"); + } else { + // #502: the integrated GPU couldn't show frames to a compositor on the NVIDIA GPU. + assert_eq!(first, "NVIDIA GeForce RTX 5070"); + } + } + + #[test] + fn each_preference_orders_the_adapters_then_falls_back_to_opengl_and_software() { + let c = issue_502(); + let order = |power| names(&c, &adapter_order(&c, power, None, &[])); + assert_eq!( + order(PowerPreference::None), + [ + "NVIDIA GeForce RTX 5070", + "AMD Ryzen 9 7900X (RADV RAPHAEL_MENDOCINO)", + "NVIDIA GeForce RTX 5070/PCIe/SSE2", + "llvmpipe (LLVM 20.1.8, 256 bits)" + ] + ); + assert_eq!( + order(PowerPreference::LowPower), + [ + "AMD Ryzen 9 7900X (RADV RAPHAEL_MENDOCINO)", + "NVIDIA GeForce RTX 5070", + "NVIDIA GeForce RTX 5070/PCIe/SSE2", + "llvmpipe (LLVM 20.1.8, 256 bits)" + ] + ); + assert_eq!( + order(PowerPreference::HighPerformance), + [ + "NVIDIA GeForce RTX 5070", + "AMD Ryzen 9 7900X (RADV RAPHAEL_MENDOCINO)", + "NVIDIA GeForce RTX 5070/PCIe/SSE2", + "llvmpipe (LLVM 20.1.8, 256 bits)" + ] + ); + } + + /// A restart leaves out the adapter the window failed on, so Power Saving on the machine of + /// #502 ends up on the NVIDIA GPU, and once every adapter failed there is nothing to try. + #[test] + fn a_restart_tries_the_next_adapter() { + let c = issue_502(); + let mut skip = vec![]; + let mut tried = vec![]; + while let Some(&i) = adapter_order(&c, PowerPreference::LowPower, None, &skip).first() { + tried.push(c[i].name.clone()); + skip.push(c[i].key.clone()); + } + assert_eq!( + tried, + [ + "AMD Ryzen 9 7900X (RADV RAPHAEL_MENDOCINO)", + "NVIDIA GeForce RTX 5070", + "NVIDIA GeForce RTX 5070/PCIe/SSE2", + "llvmpipe (LLVM 20.1.8, 256 bits)" + ] + ); + } + + #[test] + fn adapters_that_cannot_present_to_the_window_are_never_tried() { + let mut c = issue_502(); + c[0].presents = false; + c[3].presents = false; + for power in [PowerPreference::None, PowerPreference::LowPower, PowerPreference::HighPerformance] { + let order = adapter_order(&c, power, None, &[]); + assert!(!order.contains(&0) && !order.contains(&3), "{power:?}: {order:?}"); + assert_eq!(order.len(), 2); + } + for p in &mut c { + p.presents = false; + } + assert!(adapter_order(&c, PowerPreference::None, None, &[]).is_empty()); + assert!(adapter_order(&[], PowerPreference::HighPerformance, None, &[]).is_empty()); + } + + #[test] + fn wgpu_adapter_name_picks_an_adapter_first_and_the_rest_stay_as_fallbacks() { + let c = issue_502(); + let order = adapter_order(&c, PowerPreference::HighPerformance, Some("radv"), &[]); + assert_eq!(c[order[0]].name, "AMD Ryzen 9 7900X (RADV RAPHAEL_MENDOCINO)"); + assert_eq!(order.len(), 4); + // Any case; every match comes before the rest, natively first. + let order = adapter_order(&c, PowerPreference::LowPower, Some("GeForce"), &[]); + assert_eq!(names(&c, &order[..2]), ["NVIDIA GeForce RTX 5070", "NVIDIA GeForce RTX 5070/PCIe/SSE2"]); + // An empty name or one nothing matches changes nothing. + for named in ["", "no such gpu"] { + assert_eq!(adapter_order(&c, PowerPreference::LowPower, Some(named), &[]), adapter_order(&c, PowerPreference::LowPower, None, &[])); + } + // A named adapter that failed is left out like any other. + let skip = vec![c[1].key.clone()]; + assert_eq!(adapter_order(&c, PowerPreference::None, Some("radv"), &skip)[0], 0); + } + + /// A Windows machine lists every GPU twice (Vulkan and DX12): power saving still takes the + /// integrated GPU first, as wgpu's own choice did (#306). + #[test] + fn hybrid_laptop_on_windows_renders_on_the_integrated_gpu_with_power_saving() { + let c = vec![ + gpu("Intel(R) Arc(TM) A370M", Backend::Vulkan, DeviceType::DiscreteGpu), + gpu("Intel(R) Iris(R) Xe Graphics", Backend::Vulkan, DeviceType::IntegratedGpu), + gpu("Intel(R) Arc(TM) A370M", Backend::Dx12, DeviceType::DiscreteGpu), + gpu("Intel(R) Iris(R) Xe Graphics", Backend::Dx12, DeviceType::IntegratedGpu), + gpu("Microsoft Basic Render Driver", Backend::Dx12, DeviceType::Cpu), + ]; + let order = adapter_order(&c, PowerPreference::LowPower, None, &[]); + assert_eq!(order, [1, 3, 0, 2, 4]); + assert_eq!(adapter_order(&c, PowerPreference::HighPerformance, None, &[]), [0, 2, 1, 3, 4]); + } + + #[test] + fn power_preference_follows_the_environment_then_the_preference() { + assert_eq!(power_preference(None, None), AUTOMATIC); + assert_eq!(power_preference(Some("automatic"), None), AUTOMATIC); + assert_eq!(power_preference(Some("lowPower"), None), PowerPreference::LowPower); + assert_eq!(power_preference(Some("highPerformance"), None), PowerPreference::HighPerformance); + // 0.5.0's default, and values this version doesn't know (a newer or damaged file). + for old in ["powerSaving", "turbo", ""] { + assert_eq!(power_preference(Some(old), None), AUTOMATIC, "{old}"); + } + // WGPU_POWER_PREF wins over the preference, either way. + assert_eq!(power_preference(Some("lowPower"), Some(PowerPreference::HighPerformance)), PowerPreference::HighPerformance); + assert_eq!(power_preference(Some("highPerformance"), Some(PowerPreference::LowPower)), PowerPreference::LowPower); + assert_eq!(power_preference(Some("lowPower"), Some(PowerPreference::None)), PowerPreference::None); + assert_eq!(AUTOMATIC, if cfg!(any(windows, target_os = "macos")) { PowerPreference::LowPower } else { PowerPreference::None }); + } + + /// The preference the engine saves is the one the app reads back before the window opens. + #[test] + fn the_saved_engine_preference_is_found() { + let mut prefs = vectorcraft_engine::Prefs::default(); + let saved = prefs.to_json(); + assert_eq!(saved.get("gpuPreference").and_then(serde_json::Value::as_str), Some("automatic")); + for (value, power) in [("lowPower", PowerPreference::LowPower), ("highPerformance", PowerPreference::HighPerformance)] { + prefs.gpu_preference = value.into(); + let saved = prefs.to_json(); + assert_eq!(power_preference(saved.get("gpuPreference").and_then(serde_json::Value::as_str), None), power); + } + // Every choice Preferences offer means something here. + for (value, _) in vectorcraft_engine::cmd::prefscmds::GPU_PREFERENCES { + assert!(["automatic", "lowPower", "highPerformance"].contains(value), "{value}"); + } + } + + #[test] + fn skipped_adapters_parse_from_a_comma_separated_list() { + assert_eq!(parse_skip("Vulkan:1002:164e, Gl:10de:2f04,,"), ["Vulkan:1002:164e", "Gl:10de:2f04"]); + assert!(parse_skip("").is_empty()); + assert_eq!(key(Backend::Vulkan, 0x1002, 0x164e), "Vulkan:1002:164e"); + assert_eq!(key(Backend::Gl, 0x10de, 0x2f04), "Gl:10de:2f04"); + } + + #[test] + fn panics_in_wgpu_egui_wgpu_and_naga_are_graphics_failures() { + for file in [ + "/home/u/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/egui-wgpu-0.36.2/src/winit.rs", + r"C:\Users\u\.cargo\registry\src\index.crates.io-1949cf8c6b5b557f\wgpu-core-30.0.1\src\device\mod.rs", + "/rustc/deps/wgpu-hal-30.0.1/src/vulkan/adapter.rs", + "naga-30.0.0/src/back/spv/writer.rs", + ] { + assert!(in_graphics_stack(file), "{file}"); + } + for file in [ + "apps/vectorcraft/src/main.rs", + "/home/wgpu/vectorcraft/crates/ui-egui/src/lib.rs", + "egui-0.36.2/src/context.rs", + "winit-0.30.12/src/x.rs", + ] { + assert!(!in_graphics_stack(file), "{file}"); + } + } + + #[test] + fn only_a_graphics_failure_while_starting_up_restarts_without_the_adapter() { + let amd = Some("Vulkan:1002:164e"); + assert_eq!(restart_without(true, 0, amd, &[]), amd); + assert_eq!(restart_without(true, STARTUP_FRAMES - 1, amd, &[]), amd); + // After start-up the adapter has shown frames; a lost window is something else. + assert_eq!(restart_without(true, STARTUP_FRAMES, amd, &[]), None); + // A bug outside the graphics, or no adapter picked: nothing another adapter would change. + assert_eq!(restart_without(false, 0, amd, &[]), None); + assert_eq!(restart_without(true, 0, None, &[]), None); + // Never the same adapter twice, so restarts end. + assert_eq!(restart_without(true, 0, amd, &["Vulkan:1002:164e".into()]), None); + } + + #[test] + fn a_normal_exit_or_another_failure_does_not_restart() { + let startup = Startup::default(); + assert_eq!(finish(Ok(Ok(())), &startup), Ok(())); + // No adapter was picked (none can show the window): the error is returned, nothing restarts. + let none = + eframe::Error::Wgpu(eframe::egui_wgpu::WgpuError::CustomNativeAdapterSelectionError("no graphics adapter can show the window".into())); + assert_eq!( + finish(Ok(Err(none)), &startup), + Err(format!("WGPU error: Adapter selection failed: no graphics adapter can show the window ({HELP})")) + ); + let _ = startup.adapter.set("Vulkan:1002:164e".into()); + GRAPHICS_PANIC.store(false, Ordering::Relaxed); + assert_eq!(finish(Err("a bug".into()), &startup), Err("a bug".into())); + } +} diff --git a/apps/vectorcraft/src/main.rs b/apps/vectorcraft/src/main.rs index 7af8b003..64fc2049 100644 --- a/apps/vectorcraft/src/main.rs +++ b/apps/vectorcraft/src/main.rs @@ -16,6 +16,8 @@ compile_error!("the win7 target requires --no-default-features --features window mod clipboard; mod control_server; +#[cfg(feature = "wgpu")] +mod gpu; mod logging; #[cfg(target_os = "macos")] mod native_menu; @@ -27,7 +29,7 @@ mod window; use vectorcraft_engine::Session; use vectorcraft_engine::cmd::fileio; use vectorcraft_ui_egui::graphics::GraphicsLoss; -use vectorcraft_ui_egui::{FilePick, Services, VectorcraftApp}; +use vectorcraft_ui_egui::{ClipboardProbeFactory, FilePick, Services, VectorcraftApp}; struct App { app: VectorcraftApp, @@ -254,6 +256,10 @@ fn services() -> Services { write_shared: Some(std::sync::Arc::new(write_file)), // Every format Copy offers and Paste reads (menu-bar Paste never sees egui's Paste event). system_clipboard: Some(clipboard::system_clipboard()), + // Linux checks whether Paste has something to take on a background thread: an X11 clipboard + // owner that never answers holds a read for up to 4 s. Windows only asks which formats the + // clipboard holds and macOS asks the pasteboard server, so they check in line. + clipboard_probe: cfg!(target_os = "linux").then(|| Box::new(clipboard::system_clipboard) as ClipboardProbeFactory), // Help → Discord / website / GitHub, the Discord button, About and Home links. open_url: Some(Box::new(|url: &str| { let _ = webbrowser::open(url); @@ -297,23 +303,6 @@ fn app_icon() -> egui::IconData { eframe::icon_data::from_png_bytes(png).unwrap_or_default() } -/// The power preference wgpu picks the window's graphics adapter with (#306): the -/// `WGPU_POWER_PREF` environment variable (`low`, `high`, `none`) when set, otherwise Preferences › -/// Performance › Graphics Processor (`gpuPreference`). Power saving unless the preference asks for -/// high performance: the canvas is rasterized on the CPU and the GPU only composites it, which the -/// integrated GPU of a hybrid-graphics laptop does easily, while presenting frames rendered on the -/// discrete GPU through the integrated one made the window flicker on some laptops. With a single -/// GPU both preferences pick it. -#[cfg(feature = "wgpu")] -fn power_preference(pref: Option<&str>, env: Option) -> eframe::wgpu::PowerPreference { - use eframe::wgpu::PowerPreference; - match (env, pref) { - (Some(p), _) => p, - (None, Some("highPerformance")) => PowerPreference::HighPerformance, - (None, _) => PowerPreference::LowPower, - } -} - /// "name (backend, kind)" of the adapter the window renders with, for Help › About and bug reports. #[cfg(feature = "wgpu")] fn adapter_summary(info: &eframe::wgpu::AdapterInfo) -> String { @@ -324,7 +313,7 @@ fn adapter_summary(info: &eframe::wgpu::AdapterInfo) -> String { /// macOS keeps its traffic lights over the integrated title strip. const CUSTOM_TITLEBAR: bool = !cfg!(target_os = "macos"); -fn main() -> eframe::Result { +fn main() -> std::process::ExitCode { // First, so every start-up warning is recorded (`logging`). let logger = logging::install(); vectorcraft_ui_egui::i18n::detect_system_lang_in_background(); @@ -336,7 +325,7 @@ fn main() -> eframe::Result { "--control" => control_port = args.next().and_then(|p| p.parse().ok()), "--version" => { println!("vectorcraft {}", env!("CARGO_PKG_VERSION")); - return Ok(()); + return std::process::ExitCode::SUCCESS; } _ => files.push(a), } @@ -360,7 +349,9 @@ fn main() -> eframe::Result { #[cfg(feature = "wgpu")] let gpu_pref = saved.as_ref().and_then(|ui| ui.engine_prefs.get("gpuPreference")).and_then(serde_json::Value::as_str); #[cfg(feature = "wgpu")] - let power = power_preference(gpu_pref, eframe::wgpu::PowerPreference::from_env()); + let power = gpu::power_preference(gpu_pref, eframe::wgpu::PowerPreference::from_env()); + #[cfg(feature = "wgpu")] + let startup = std::sync::Arc::new(gpu::Startup::default()); let options = eframe::NativeOptions { viewport: egui::ViewportBuilder::default() .with_title("VectorCraft") @@ -383,86 +374,94 @@ fn main() -> eframe::Result { // One frame queued, not two: the canvas is rasterized on the CPU and the GPU only // composites it, so the window answers the pointer a frame sooner (#444). options.wgpu_options.surface = eframe::egui_wgpu::SurfaceConfig::LOW_LATENCY; + // Only adapters that can show the window, in the order `gpu` gives (#306, #502). if let eframe::egui_wgpu::WgpuSetup::CreateNew(create) = &mut options.wgpu_options.wgpu_setup { - create.power_preference = power; + create.native_adapter_selector = Some(gpu::selector(power, startup.clone())); } options }; + #[cfg(feature = "wgpu")] + gpu::watch_panics(); // Files opened from Finder and the Dock arrive as events, not arguments. #[cfg(target_os = "macos")] open_documents::install(); - eframe::run_native( - "VectorCraft", - options, - Box::new(move |cc| { - let mut app = VectorcraftApp::new(Session::new(), services()); - load_prefs(&mut app, saved); - // Fit the window to its monitor, or put it back where it was (still hidden). - if let Some(w) = cc.winit_window() { - app.ui.window = Some(window::restore(w, saved_window)); - } - // User Defined swatch and graphic style libraries live next to the preferences. - let swatches = prefs_path().and_then(|p| Some(p.parent()?.join("Swatches").to_string_lossy().to_string())); - app.session.swatch_libraries.set_user_dir(swatches); - let styles = prefs_path().and_then(|p| Some(p.parent()?.join("Graphic Styles").to_string_lossy().to_string())); - app.session.style_libraries.set_user_dir(styles); - // Data Recovery copies live next to the preferences too (none for runs without - // preferences, such as agents' test runs, unless the recoveryFolder preference is set). - if std::env::var_os("VECTORCRAFT_NO_PREFS").is_none() { - let recovery = prefs_path().and_then(|p| Some(p.parent()?.join("Data Recovery").to_string_lossy().to_string())); - app.session.recovery.set_default_folder(recovery); - } - let graphics_loss = GraphicsLoss::default(); - #[cfg(feature = "wgpu")] - if let Some(rs) = &cc.wgpu_render_state { - let summary = adapter_summary(&rs.adapter.get_info()); - log::info!("rendering with {summary} (power preference {power:?})"); - app.graphics_adapter = Some(summary); - let (loss, ctx) = (graphics_loss.clone(), cc.egui_ctx.clone()); - rs.device.set_device_lost_callback(move |reason, msg| loss.report(&ctx, format!("{reason:?}: {msg}"))); - } - #[cfg(feature = "windows7")] - { - app.graphics_adapter = Some("OpenGL (Windows 7 compatibility)".into()); - } - app.integrated_titlebar = cfg!(target_os = "macos"); - app.custom_titlebar = CUSTOM_TITLEBAR; - if let Some(port) = control_port { - let rx = control_server::start(port, cc.egui_ctx.clone()); - app = app.with_control(rx); - } - #[cfg(target_os = "macos")] - open_documents::set_ui(&cc.egui_ctx); - open_files(&mut app, files); - Ok(Box::new(App { - app, - graphics_loss, - graphics_lost: false, + #[cfg(feature = "wgpu")] + let created = startup.clone(); + // A panic that ends the window (egui-wgpu's own, #502) is caught here: never a crash. + let outcome = vectorcraft_engine::guard::catch_panic(|| { + eframe::run_native( + "VectorCraft", + options, + Box::new(move |cc| { + let mut app = VectorcraftApp::new(Session::new(), services()); + load_prefs(&mut app, saved); + // Fit the window to its monitor, or put it back where it was (still hidden). + if let Some(w) = cc.winit_window() { + app.ui.window = Some(window::restore(w, saved_window)); + } + // User Defined swatch and graphic style libraries live next to the preferences. + let swatches = prefs_path().and_then(|p| Some(p.parent()?.join("Swatches").to_string_lossy().to_string())); + app.session.swatch_libraries.set_user_dir(swatches); + let styles = prefs_path().and_then(|p| Some(p.parent()?.join("Graphic Styles").to_string_lossy().to_string())); + app.session.style_libraries.set_user_dir(styles); + // Data Recovery copies live next to the preferences too (none for runs without + // preferences, such as agents' test runs, unless the recoveryFolder preference is set). + if std::env::var_os("VECTORCRAFT_NO_PREFS").is_none() { + let recovery = prefs_path().and_then(|p| Some(p.parent()?.join("Data Recovery").to_string_lossy().to_string())); + app.session.recovery.set_default_folder(recovery); + } + let graphics_loss = GraphicsLoss::default(); + #[cfg(feature = "wgpu")] + if let Some(rs) = &cc.wgpu_render_state { + let summary = adapter_summary(&rs.adapter.get_info()); + log::info!("rendering with {summary} (power preference {power:?})"); + created.created(&cc.egui_ctx); + if !gpu::skipped().is_empty() { + app.status(format!("The graphics processor tried first couldn't show the window, so VectorCraft started again on {summary}")); + } + app.graphics_adapter = Some(summary); + let (loss, ctx) = (graphics_loss.clone(), cc.egui_ctx.clone()); + rs.device.set_device_lost_callback(move |reason, msg| loss.report(&ctx, format!("{reason:?}: {msg}"))); + } + #[cfg(feature = "windows7")] + { + app.graphics_adapter = Some("OpenGL (Windows 7 compatibility)".into()); + } + app.integrated_titlebar = cfg!(target_os = "macos"); + app.custom_titlebar = CUSTOM_TITLEBAR; + if let Some(port) = control_port { + let rx = control_server::start(port, cc.egui_ctx.clone()); + app = app.with_control(rx); + } #[cfg(target_os = "macos")] - menu: None, - })) - }), - ) + open_documents::set_ui(&cc.egui_ctx); + open_files(&mut app, files); + Ok(Box::new(App { + app, + graphics_loss, + graphics_lost: false, + #[cfg(target_os = "macos")] + menu: None, + })) + }), + ) + }); + #[cfg(feature = "wgpu")] + let outcome = gpu::finish(outcome, &startup); + #[cfg(not(feature = "wgpu"))] + let outcome = outcome.and_then(|r| r.map_err(|e| e.to_string())); + match outcome { + Ok(()) => std::process::ExitCode::SUCCESS, + Err(e) => { + log::error!("VectorCraft stopped: {e}"); + std::process::ExitCode::FAILURE + } + } } #[cfg(all(test, feature = "wgpu"))] mod tests { use super::*; - use eframe::wgpu::PowerPreference; - - #[test] - fn power_saving_unless_the_preference_or_the_environment_says_otherwise() { - assert_eq!(power_preference(None, None), PowerPreference::LowPower); - assert_eq!(power_preference(Some("powerSaving"), None), PowerPreference::LowPower); - assert_eq!(power_preference(Some("highPerformance"), None), PowerPreference::HighPerformance); - // A value this version doesn't know (a newer or damaged preference file) is the default. - assert_eq!(power_preference(Some("turbo"), None), PowerPreference::LowPower); - assert_eq!(power_preference(Some(""), None), PowerPreference::LowPower); - // WGPU_POWER_PREF wins over the preference, either way. - assert_eq!(power_preference(Some("powerSaving"), Some(PowerPreference::HighPerformance)), PowerPreference::HighPerformance); - assert_eq!(power_preference(Some("highPerformance"), Some(PowerPreference::LowPower)), PowerPreference::LowPower); - assert_eq!(power_preference(None, Some(PowerPreference::None)), PowerPreference::None); - } /// The file extensions the macOS bundle declares: its document types and its own exported type. fn plist_extensions(plist: &str) -> Vec<&str> { @@ -492,16 +491,4 @@ mod tests { assert!(types > 1 && plist.matches("LSHandlerRank").count() == types, "every document type has a rank"); assert_eq!(plist.matches("Owner").count(), 2, "only VectorCraft documents and templates are owned"); } - - /// The preference the engine saves is the one the app reads back before the window opens. - #[test] - fn the_saved_engine_preference_is_found() { - let mut prefs = vectorcraft_engine::Prefs::default(); - let saved = prefs.to_json(); - assert_eq!(saved.get("gpuPreference").and_then(serde_json::Value::as_str), Some("powerSaving")); - prefs.gpu_preference = "highPerformance".into(); - let saved = prefs.to_json(); - let pref = saved.get("gpuPreference").and_then(serde_json::Value::as_str); - assert_eq!(power_preference(pref, None), PowerPreference::HighPerformance); - } } diff --git a/crates/engine/src/cmd/draw2.rs b/crates/engine/src/cmd/draw2.rs index 2ce91936..6d870d77 100644 --- a/crates/engine/src/cmd/draw2.rs +++ b/crates/engine/src/cmd/draw2.rs @@ -701,13 +701,16 @@ fn reshape_segment(s: &mut Session, p: &Value) -> Result { return Err(EngineError::Other("no such segment".into())); } let n = sp.anchors.len(); - // Moving both inner control points by v moves B(t) by 3t(1-t)·v. + // Moving both inner control points by v moves B(t) by 3t(1-t)·v. A smooth anchor stays + // smooth: its other handle turns with the moved one. let v = dv / (3.0 * t * (1.0 - t)); let (i0, i1) = (seg % n, (seg + 1) % n); - let a = sp.anchors[i0]; - sp.anchors[i0] = Anchor::with_handles(a.p, a.h_in, a.h_out + v); - let b = sp.anchors[i1]; - sp.anchors[i1] = Anchor::with_handles(b.p, b.h_in + v, b.h_out); + if let Some(a) = sp.anchors.get_mut(i0) { + a.set_handle(true, a.h_out + v, false); + } + if let Some(b) = sp.anchors.get_mut(i1) { + b.set_handle(false, b.h_in + v, false); + } Ok(()) })?; ok() diff --git a/crates/engine/src/cmd/fileio/mod.rs b/crates/engine/src/cmd/fileio/mod.rs index 9b0aabc5..0c7ba360 100644 --- a/crates/engine/src/cmd/fileio/mod.rs +++ b/crates/engine/src/cmd/fileio/mod.rs @@ -79,7 +79,7 @@ pub fn specs() -> Vec { "Open Document", [], None, - "{path} or {name, dataBase64}, PDF/.ai: pages?: \"2-3, 5\" (1-based, default all; one artboard each) | page?: n, cropTo?: bounding|art|crop (default)|trim|bleed|media (the box each artboard gets; bounding: the art's bounds), password? (encrypted PDFs; see document.pdfInfo), textAs?: text (default: point type per line, in the file's fonts by name; missing ones are listed in warnings) | outlines (glyph paths), layers?: true (default: optional content groups become layers with their visibility, print state and lock — art that is off comes in as a hidden layer; other art goes to a layer per page) | false (one layer per page, without the art that is off; Save then asks for a name), colorMode?: rgb|cmyk (the mode the document opens in, its colours converted as file.documentColorMode does, grays? as there; default: the file's — a PDF keeps CMYK, Gray and spot inks (spot swatches at a tint) and opens in CMYK when painted mostly in CMYK), DXF: dxf?: {layout?: \"Model\" (default) | a paper layout's name (document.dxfInfo lists them), unit?, scale? (the ratio: 1 unit of the art = scale drawing units; default: the drawing at 1:1 in its own unit), fit?: false (scale to fit an artboard of fitTo?: [612, 792], turned to the art's orientation), scaleLineweights?: false (lineweights scale with the art), center?: true (false: the drawing's origin on the artboard's bottom-left corner; fitted art's bottom-left corner), mergeLayers?: false (all art on one layer)} → {index, title, format, warnings, restored, missingLinks, modifiedLinks, updatedLinks: [{name, path, ids}]}; any readable format (see document.formats): .vectorcraft/.drawcraft, .svg/.svgz, .pdf/.ai, .ait, ASCII .dxf (each DXF layer with art a layer; blocks symbols; what can't come in is listed in warnings), PNG/JPEG/GIF/WebP/TIFF/BMP (an image opens as a document of its pixel size), .emf/.wmf (one artboard, the picture's frame; records VectorCraft doesn't read are skipped with one warning), .eps and PostScript .ai (one artboard, the bounding box: an EPS file VectorCraft wrote restores the document it carries, restored: true; other files are read by a PostScript interpreter — paths, colours and spot inks, clips, gradients, images, type in the fonts named — and come in as their TIFF preview, with a warning, when their PostScript can't be read). A PDF/.ai/.ait or SVG saved with Preserve Editing restores the native document it carries (restored: true; a PDF only when no pages are picked), unless the file was changed elsewhere since or the data can't be read: then its artwork is imported and the first warning says why. Templates (native templates, .ait) open as a new untitled document; a restored .ai keeps its path (Save writes .ai again). Linked images are read from their files (looked for at their path, then relative to the document): missing ones show their saved preview (links.relink), modified ones are read again only with Preferences › Update Links: Automatically (else links.update). An SVG's files (relative links from the SVG's folder) stay linked, SVG files become art, missing ones a placeholder in their box (a warning and missingLinks)", + "{path} or {name, dataBase64}, PDF/.ai: pages?: \"2-3, 5\" (1-based, default all; one artboard each) | page?: n, cropTo?: bounding|art|crop (default)|trim|bleed|media (the box each artboard gets; bounding: the art's bounds), password? (encrypted PDFs; see document.pdfInfo), textAs?: text (default: point type per line, lines wrapped in a frame as area type where they lay out the same, in the file's fonts by name; missing ones are listed in warnings) | outlines (glyph paths), layers?: true (default: optional content groups become layers with their visibility, print state and lock — art that is off comes in as a hidden layer; other art goes to a layer per page) | false (one layer per page, without the art that is off; Save then asks for a name), colorMode?: rgb|cmyk (the mode the document opens in, its colours converted as file.documentColorMode does, grays? as there; default: the file's — a PDF keeps CMYK, Gray and spot inks (spot swatches at a tint) and opens in CMYK when painted mostly in CMYK), DXF: dxf?: {layout?: \"Model\" (default) | a paper layout's name (document.dxfInfo lists them), unit?, scale? (the ratio: 1 unit of the art = scale drawing units; default: the drawing at 1:1 in its own unit), fit?: false (scale to fit an artboard of fitTo?: [612, 792], turned to the art's orientation), scaleLineweights?: false (lineweights scale with the art), center?: true (false: the drawing's origin on the artboard's bottom-left corner; fitted art's bottom-left corner), mergeLayers?: false (all art on one layer)} → {index, title, format, warnings, restored, missingLinks, modifiedLinks, updatedLinks: [{name, path, ids}]}; any readable format (see document.formats): .vectorcraft/.drawcraft, .svg/.svgz, .pdf/.ai, .ait, ASCII .dxf (each DXF layer with art a layer; blocks symbols; what can't come in is listed in warnings), PNG/JPEG/GIF/WebP/TIFF/BMP (an image opens as a document of its pixel size), .emf/.wmf (one artboard, the picture's frame; records VectorCraft doesn't read are skipped with one warning), .eps and PostScript .ai (one artboard, the bounding box: an EPS file VectorCraft wrote restores the document it carries, restored: true; other files are read by a PostScript interpreter — paths, colours and spot inks, clips, gradients, images, type in the fonts named — and come in as their TIFF preview, with a warning, when their PostScript can't be read). A PDF/.ai/.ait or SVG saved with Preserve Editing restores the native document it carries (restored: true; a PDF only when no pages are picked), unless the file was changed elsewhere since or the data can't be read: then its artwork is imported and the first warning says why. Templates (native templates, .ait) open as a new untitled document; a restored .ai keeps its path (Save writes .ai again). Linked images are read from their files (looked for at their path, then relative to the document): missing ones show their saved preview (links.relink), modified ones are read again only with Preferences › Update Links: Automatically (else links.update). An SVG's files (relative links from the SVG's folder) stay linked, SVG files become art, missing ones a placeholder in their box (a warning and missingLinks)", always, load::open ), diff --git a/crates/engine/src/cmd/prefscmds.rs b/crates/engine/src/cmd/prefscmds.rs index 545b062c..b7fb4c38 100644 --- a/crates/engine/src/cmd/prefscmds.rs +++ b/crates/engine/src/cmd/prefscmds.rs @@ -82,8 +82,11 @@ pub const UNITS: &[(&str, &str)] = &[ ("feet", "Feet"), ]; const LINE_STYLE: &[(&str, &str)] = &[("lines", "Lines"), ("dots", "Dots")]; -/// Performance › Graphics Processor (`gpuPreference`), read by the desktop app at startup. -pub const GPU_PREFERENCES: &[(&str, &str)] = &[("powerSaving", "Power Saving (integrated)"), ("highPerformance", "High Performance (discrete)")]; +/// Performance › Graphics Processor (`gpuPreference`), read by the desktop app at startup. The +/// values are WebGPU's power preferences plus `automatic`; 0.5.0's default, `powerSaving`, reads as +/// `automatic` (#502). +pub const GPU_PREFERENCES: &[(&str, &str)] = + &[("automatic", "Automatic"), ("lowPower", "Power Saving (integrated)"), ("highPerformance", "High Performance (discrete)")]; const BLACK: &[(&str, &str)] = &[("accurate", "Display All Blacks Accurately"), ("rich", "Display All Blacks as Rich Black")]; const BLACK_OUT: &[(&str, &str)] = &[("accurate", "Output All Blacks Accurately"), ("rich", "Output All Blacks as Rich Black")]; diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index 453b9b1d..beac971a 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -446,10 +446,13 @@ pub struct Prefs { pub gpu_performance: bool, pub animated_zoom: bool, /// Which graphics processor the desktop app asks for at startup (it takes effect after a - /// restart): `powerSaving` (the integrated GPU on hybrid-graphics laptops) or `highPerformance` - /// (the discrete one). The canvas is rasterized on the CPU and only composited on the GPU, so - /// the integrated GPU is plenty; presenting from the discrete GPU through the integrated one - /// made some hybrid laptops flicker (#306). Single-GPU machines are unaffected. + /// restart): `automatic`, `lowPower` (the integrated GPU on hybrid-graphics machines) or + /// `highPerformance` (the discrete one). The canvas is rasterized on the CPU and only + /// composited on the GPU, so the integrated GPU is plenty; presenting from the discrete GPU + /// through the integrated one made some hybrid laptops flicker (#306). Automatic is power + /// saving on Windows and macOS and the system's default GPU elsewhere, the one the desktop + /// runs on: a Wayland compositor may not show frames from another GPU (#502). Single-GPU + /// machines are unaffected. pub gpu_preference: String, pub history_states: u32, pub real_time_drawing: bool, @@ -653,7 +656,7 @@ impl Default for Prefs { interface_language: s("auto"), gpu_performance: true, animated_zoom: true, - gpu_preference: s("powerSaving"), + gpu_preference: s("automatic"), history_states: 500, real_time_drawing: true, render_threads: -1, @@ -718,6 +721,12 @@ pub struct Session { /// Executed commands (for actions and debugging). pub journal: Vec<(String, Value)>, pub(crate) tool: Box, + /// While Cmd lends `tool` (a selection tool) for a drag: the tool it was lent to, which comes + /// back as it was at the release ([`Session::pointer`]). + pub(crate) lender: Option>, + /// The selection tool chosen last (Selection, Direct Selection or Group Selection): the one Cmd + /// lends the other tools. None until one is chosen. + pub(crate) last_selection_tool: Option<&'static str>, pub(crate) last_view: ViewInfo, depth: u32, /// Set when the active tool panicked (see [`guard`]); reported by the next tool event. @@ -797,6 +806,8 @@ impl Session { clipboard: Clipboard::default(), journal: vec![], tool: vectorcraft_tools::create("selection"), + lender: None, + last_selection_tool: None, last_view: ViewInfo::default(), depth: 0, tool_panic: None, @@ -855,6 +866,8 @@ impl Session { return; } let view = self.last_view; + // The switch goes on whatever the lent tool's last actions did, as for the deactivation. + let _ = self.give_back_tool(view); let acts = self.with_tool_cx(view, |t, cx| t.deactivate(cx)); let _ = self.apply_actions(acts); // A batch leaves its interaction open in the document it leaves, to keep or roll back with diff --git a/crates/engine/src/tests_draw2.rs b/crates/engine/src/tests_draw2.rs index ccb8f5a5..760c0f07 100644 --- a/crates/engine/src/tests_draw2.rs +++ b/crates/engine/src/tests_draw2.rs @@ -57,6 +57,20 @@ fn click(s: &mut Session, tool: &str, x: f64, y: f64) -> Vec { drag(s, tool, &[(x, y)], Mods::default()) } +/// A gesture of the active tool, `m` held throughout: press at the first point, drag through the +/// others, release at the last. The undo steps it made. +fn gesture(s: &mut Session, pts: &[(f64, f64)], m: Mods) -> usize { + let v = view(); + let undo = undo_steps(s); + s.pointer(&PointerEvent::new(PointerKind::Down, pts[0].0, pts[0].1).with_mods(m), v).unwrap(); + for &(x, y) in &pts[1..] { + s.pointer(&PointerEvent::new(PointerKind::Drag, x, y).with_mods(m), v).unwrap(); + } + let l = pts[pts.len() - 1]; + s.pointer(&PointerEvent::new(PointerKind::Up, l.0, l.1).with_mods(m), v).unwrap(); + undo_steps(s) - undo +} + /// A wavy stroke sampled every 2 pt. fn wave(x0: f64, x1: f64, y: f64) -> Vec<(f64, f64)> { let n = ((x1 - x0) / 2.0) as usize; @@ -622,16 +636,6 @@ fn pen_with_alt_moves_one_handle_and_converts_anchors() { let anchors = json!([{"x": 100, "y": 200}, {"x": 200, "y": 100, "in": [150, 100], "out": [250, 100]}, {"x": 300, "y": 200}]); let id = NodeId(s.execute("path.create", &json!({"anchors": anchors})).unwrap()["id"].as_u64().unwrap()); s.select_tool("pen", v).unwrap(); - let gesture = |s: &mut Session, pts: &[(f64, f64)], m: Mods| { - let undo = undo_steps(s); - s.pointer(&PointerEvent::new(PointerKind::Down, pts[0].0, pts[0].1).with_mods(m), v).unwrap(); - for &(x, y) in &pts[1..] { - s.pointer(&PointerEvent::new(PointerKind::Drag, x, y).with_mods(m), v).unwrap(); - } - let l = pts[pts.len() - 1]; - s.pointer(&PointerEvent::new(PointerKind::Up, l.0, l.1).with_mods(m), v).unwrap(); - undo_steps(s) - undo - }; // Alt-drag the out handle: it moves alone, the in handle stays. assert_eq!(gesture(&mut s, &[(250.0, 100.0), (260.0, 130.0), (275.0, 165.0)], alt), 1); assert!(!s.in_interaction()); @@ -659,3 +663,130 @@ fn pen_with_alt_moves_one_handle_and_converts_anchors() { assert_eq!(path(&s, new).subpaths[0].anchors.len(), 3); assert_eq!(paths(&s).len(), 2); } + +/// The anchor's handles point opposite ways. +fn smooth(a: vectorcraft_geom::Anchor) -> bool { + let (i, o) = (a.h_in - a.p, a.h_out - a.p); + (i.x * o.y - i.y * o.x).abs() < 1e-6 && i.x * o.x + i.y * o.y < 0.0 +} + +#[test] +fn pen_with_cmd_borrows_direct_selection_and_goes_on_drawing() { + // #494: Cmd (Ctrl) held with the Pen drags with the selection tool used last (Direct Selection + // until one is chosen): handles, segments and anchors of the path being drawn; released, the + // Pen goes on drawing that path. Through pointer events, so agents reach it too. + let (none, cmd) = (Mods::default(), Mods { cmd: true, ..Mods::default() }); + let v = view(); + let mut s = session(); + s.select_tool("pen", v).unwrap(); + gesture(&mut s, &[(100.0, 300.0)], none); + gesture(&mut s, &[(200.0, 300.0), (250.0, 300.0)], none); + let id = s.doc().unwrap().selection.objects[0]; + assert_eq!(s.cursor(Point::new(250.0, 300.0), none, v), vectorcraft_tools::Cursor::Pen); + assert_eq!(s.cursor(Point::new(250.0, 300.0), cmd, v), vectorcraft_tools::Cursor::ArrowHollow, "Direct Selection's"); + // The new anchor's outgoing handle: it moves, its incoming one turning with it. + s.pointer(&PointerEvent::new(PointerKind::Down, 250.0, 300.0).with_mods(cmd), v).unwrap(); + assert_eq!(s.tool_id(), "directSelection"); + s.pointer(&PointerEvent::new(PointerKind::Drag, 250.0, 260.0).with_mods(cmd), v).unwrap(); + s.pointer(&PointerEvent::new(PointerKind::Up, 250.0, 260.0).with_mods(cmd), v).unwrap(); + assert_eq!(s.tool_id(), "pen"); + let a = path(&s, id).subpaths[0].anchors[1]; + assert!(a.h_out == Point::new(250.0, 260.0) && smooth(a), "{a:?}"); + // The segment between the two anchors bends, the smooth anchor staying smooth. + let before = path(&s, id).subpaths[0].anchors[1].h_in; + gesture(&mut s, &[(120.0, 300.0), (120.0, 270.0)], cmd); + let a = path(&s, id).subpaths[0].anchors[1]; + assert!(a.h_in != before && smooth(a), "{a:?}"); + assert_eq!(s.tool_id(), "pen"); + // A plain click goes on drawing the same path. + gesture(&mut s, &[(300.0, 350.0)], none); + assert_eq!((paths(&s).len(), path(&s, id).subpaths[0].anchors.len()), (1, 3)); + // A Cmd-click away from the art deselects: the path is done, the next click starts another. + gesture(&mut s, &[(600.0, 100.0)], cmd); + gesture(&mut s, &[(400.0, 500.0)], none); + assert_eq!(paths(&s).len(), 2); + assert_eq!(path(&s, id).subpaths[0].anchors.len(), 3); + // With the Selection tool chosen last, Cmd lends it. + s.select_tool("selection", v).unwrap(); + s.select_tool("pen", v).unwrap(); + s.pointer(&PointerEvent::new(PointerKind::Down, 600.0, 100.0).with_mods(cmd), v).unwrap(); + assert_eq!(s.tool_id(), "selection"); + s.pointer(&PointerEvent::new(PointerKind::Up, 600.0, 100.0).with_mods(cmd), v).unwrap(); + assert_eq!(s.tool_id(), "pen"); + // Choosing a tool mid-gesture keeps it: the Pen doesn't come back over it. + s.pointer(&PointerEvent::new(PointerKind::Down, 600.0, 100.0).with_mods(cmd), v).unwrap(); + s.select_tool("rectangle", v).unwrap(); + s.pointer(&PointerEvent::new(PointerKind::Up, 600.0, 100.0), v).unwrap(); + assert_eq!(s.tool_id(), "rectangle"); +} + +#[test] +fn reshaping_a_segment_keeps_smooth_anchors_smooth() { + // #494: the anchors at the ends of a dragged segment keep their kind: a smooth one's other + // handle turns with the moved one (at its length), a corner's stays. + let mut s = session(); + let anchors = json!([{"x": 100, "y": 300}, {"x": 200, "y": 300, "in": [160, 300], "out": [240, 300]}, {"x": 300, "y": 300}]); + let id = NodeId(s.execute("path.create", &json!({"anchors": anchors})).unwrap()["id"].as_u64().unwrap()); + s.execute("path.reshapeSegment", &json!({"id": id.0, "segment": 0, "t": 0.5, "dx": 0, "dy": -30})).unwrap(); + let sp = &path(&s, id).subpaths[0]; + let a = sp.anchors[1]; + assert!(near(a.h_in, Point::new(160.0, 260.0)) && smooth(a), "{a:?}"); + assert!((a.h_out.distance(a.p) - 40.0).abs() < 1e-9, "its length kept"); + assert!(near(sp.anchors[0].h_out, Point::new(100.0, 260.0)) && !sp.anchors[0].has_in(), "the corner end: {:?}", sp.anchors[0]); +} + +#[test] +fn pen_drag_from_the_first_anchor_closes_the_path() { + // #501: closing a path by dragging out of its first anchor flickered between a close and a new + // path, and released at the wrong moment left the shape open. The press decides: the drag + // shapes the closing curve, symmetric, and the release closes the path wherever it ends. + let none = Mods::default(); + let v = view(); + let mut s = session(); + s.select_tool("pen", v).unwrap(); + for (x, y) in [(100.0, 300.0), (200.0, 300.0), (200.0, 400.0)] { + gesture(&mut s, &[(x, y)], none); + } + let id = s.doc().unwrap().selection.objects[0]; + let pts: Vec<(f64, f64)> = (0..=12).map(|i| (100.0 + 5.0 * f64::from(i), 300.0 - 4.0 * f64::from(i))).collect(); + s.pointer(&PointerEvent::new(PointerKind::Down, 100.0, 300.0), v).unwrap(); + for &(x, y) in &pts[1..] { + s.pointer(&PointerEvent::new(PointerKind::Drag, x, y), v).unwrap(); + let p = path(&s, id); + assert!(p.subpaths[0].closed && paths(&s).len() == 1, "closed throughout the drag, at ({x}, {y})"); + } + s.pointer(&PointerEvent::new(PointerKind::Up, 160.0, 252.0), v).unwrap(); + assert!(!s.in_interaction()); + let sp = &path(&s, id).subpaths[0]; + assert!(sp.closed && sp.anchors.len() == 3, "{sp:?}"); + let a = sp.anchors[0]; + assert_eq!((a.h_in, a.h_out), (Point::new(40.0, 348.0), Point::new(160.0, 252.0)), "symmetric"); + assert_eq!(paths(&s).len(), 1); + // The next click starts a new path. + gesture(&mut s, &[(500.0, 500.0)], none); + assert_eq!(paths(&s).len(), 2); +} + +#[test] +fn pen_with_alt_converts_the_anchors_of_the_path_being_drawn() { + // #504: while drawing, Alt-click on a smooth anchor of the path makes it a corner and Alt-drag + // on a corner one pulls out smooth handles; the next click goes on drawing the path. + let (none, alt) = (Mods::default(), Mods { alt: true, ..Mods::default() }); + let v = view(); + let mut s = session(); + s.select_tool("pen", v).unwrap(); + gesture(&mut s, &[(100.0, 300.0)], none); + gesture(&mut s, &[(200.0, 300.0), (240.0, 300.0)], none); + gesture(&mut s, &[(300.0, 400.0)], none); + gesture(&mut s, &[(400.0, 300.0)], none); + let id = s.doc().unwrap().selection.objects[0]; + assert!(smooth(path(&s, id).subpaths[0].anchors[1])); + assert_eq!(gesture(&mut s, &[(200.0, 300.0)], alt), 1); + let a = path(&s, id).subpaths[0].anchors[1]; + assert!(!a.has_in() && !a.has_out(), "a corner: {a:?}"); + assert_eq!(gesture(&mut s, &[(300.0, 400.0), (320.0, 400.0), (340.0, 400.0)], alt), 1); + let a = path(&s, id).subpaths[0].anchors[2]; + assert!(smooth(a) && a.h_out == Point::new(340.0, 400.0), "smooth: {a:?}"); + gesture(&mut s, &[(500.0, 400.0)], none); + assert_eq!((paths(&s).len(), path(&s, id).subpaths[0].anchors.len()), (1, 5)); +} diff --git a/crates/engine/src/tests_prefs.rs b/crates/engine/src/tests_prefs.rs index 71fc6bc3..214f5ceb 100644 --- a/crates/engine/src/tests_prefs.rs +++ b/crates/engine/src/tests_prefs.rs @@ -123,34 +123,37 @@ fn prefs_serde_round_trip_and_tolerates_missing_fields() { assert_eq!(partial.corner_radius, 12.0); } -/// Performance › Graphics Processor (#306): power saving by default, set by value or label, kept -/// through a save/load round trip, and a bad value is an error that changes nothing. +/// Performance › Graphics Processor (#306, #502): automatic by default, set by value or label, +/// kept through a save/load round trip, and a bad value (0.5.0's `powerSaving` among them) is an +/// error that changes nothing. #[test] -fn gpu_preference_defaults_to_power_saving_and_validates() { +fn gpu_preference_defaults_to_automatic_and_validates() { let mut s = Session::new(); - assert_eq!(s.prefs.gpu_preference, "powerSaving"); - assert_eq!(s.execute("prefs.get", &json!({"key": "gpuPreference"})).unwrap(), json!("powerSaving")); + assert_eq!(s.prefs.gpu_preference, "automatic"); + assert_eq!(s.execute("prefs.get", &json!({"key": "gpuPreference"})).unwrap(), json!("automatic")); s.execute("prefs.set", &json!({"key": "gpuPreference", "value": "highPerformance"})).unwrap(); assert_eq!(s.prefs.gpu_preference, "highPerformance"); s.execute("prefs.set", &json!({"key": "gpuPreference", "value": "Power Saving (integrated)"})).unwrap(); - assert_eq!(s.prefs.gpu_preference, "powerSaving"); - for bad in [json!("turbo"), json!(""), json!(1), json!(null), json!(["highPerformance"])] { + assert_eq!(s.prefs.gpu_preference, "lowPower"); + s.execute("prefs.set", &json!({"key": "gpuPreference", "value": "automatic"})).unwrap(); + assert_eq!(s.prefs.gpu_preference, "automatic"); + for bad in [json!("powerSaving"), json!("turbo"), json!(""), json!(1), json!(null), json!(["highPerformance"])] { assert!(s.execute("prefs.set", &json!({"key": "gpuPreference", "value": bad})).is_err(), "{bad}"); - assert_eq!(s.prefs.gpu_preference, "powerSaving"); + assert_eq!(s.prefs.gpu_preference, "automatic"); } - let p = Prefs { gpu_preference: "highPerformance".into(), ..Default::default() }; + let p = Prefs { gpu_preference: "lowPower".into(), ..Default::default() }; let back: Prefs = serde_json::from_value(p.to_json()).unwrap(); - assert_eq!(back.gpu_preference, "highPerformance"); + assert_eq!(back.gpu_preference, "lowPower"); // Preference files written before the preference existed get the default. let old: Prefs = serde_json::from_value(json!({"gpuPerformance": true})).unwrap(); - assert_eq!(old.gpu_preference, "powerSaving"); + assert_eq!(old.gpu_preference, "automatic"); let l = s.execute("prefs.list", &json!({})).unwrap(); let row = l.as_array().unwrap().iter().find(|e| e["key"] == "gpuPreference").unwrap().clone(); assert_eq!(row["category"], "Performance"); - assert_eq!(row["options"], json!(["powerSaving", "highPerformance"])); + assert_eq!(row["options"], json!(["automatic", "lowPower", "highPerformance"])); s.execute("prefs.set", &json!({"key": "gpuPreference", "value": "highPerformance"})).unwrap(); s.execute("prefs.reset", &json!({"category": "Performance"})).unwrap(); - assert_eq!(s.prefs.gpu_preference, "powerSaving"); + assert_eq!(s.prefs.gpu_preference, "automatic"); } /// Selection & Anchor Display › Tolerance, Object Selection by Path Only and Command Click to diff --git a/crates/engine/src/tooling.rs b/crates/engine/src/tooling.rs index b149c31a..e093a28f 100644 --- a/crates/engine/src/tooling.rs +++ b/crates/engine/src/tooling.rs @@ -82,6 +82,7 @@ impl Session { /// Switch to tool `id` without choosing it afresh (back from a temporary tool: a hidden /// perspective grid stays hidden), finishing any pending tool work first. pub fn switch_tool(&mut self, id: &str, view: ViewInfo) -> Result<()> { + self.give_back_tool(view)?; if self.tool.id() == id { return Ok(()); } @@ -89,9 +90,47 @@ impl Session { self.apply_actions(acts)?; self.keep_tool_settings(); self.tool = self.make_tool(id); + if vectorcraft_tools::catalog::is_selection_tool(id) { + self.last_selection_tool = Some(self.tool.id()); + } Ok(()) } + /// The selection tool Cmd lends tool `id` for a drag: the one chosen last; until one is, + /// Direct Selection to the tools that edit anchors (the Pen) and Selection to the others. + /// None for the selection tools themselves and the view tools. + fn lent_tool(&self, id: &str) -> Option<&'static str> { + use vectorcraft_tools::catalog::{edits_anchors, is_selection_tool}; + if is_selection_tool(id) || matches!(id, "hand" | "zoom" | "rotateView") { + return None; + } + Some(self.last_selection_tool.unwrap_or(if edits_anchors(id) { "directSelection" } else { "selection" })) + } + + /// A press with Cmd held (Ctrl elsewhere) and any other tool than a selection tool: the + /// selection tool [`Self::lent_tool`] takes the gesture, pressing without Cmd (a plain click, + /// not Select Behind). The tool lent to stays as it was, unaware, until the release. + fn lend_selection_tool(&mut self, ev: &PointerEvent) -> PointerEvent { + if ev.kind != PointerKind::Down || !ev.mods.cmd || self.lender.is_some() { + return *ev; + } + let Some(id) = self.lent_tool(self.tool.id()) else { return *ev }; + let lent = self.make_tool(id); + self.lender = Some(std::mem::replace(&mut self.tool, lent)); + PointerEvent { mods: Mods { cmd: false, ..ev.mods }, ..*ev } + } + + /// The lent selection tool's gesture is over: the tool it was lent to is back as it was (the + /// Pen goes on drawing its path). + pub(crate) fn give_back_tool(&mut self, view: ViewInfo) -> Result<()> { + let Some(lender) = self.lender.take() else { return Ok(()) }; + let acts = self.with_tool_cx(view, |t, cx| t.deactivate(cx)); + let r = self.apply_actions(acts); + self.keep_tool_settings(); + self.tool = lender; + r.map(drop) + } + /// A fresh `id` tool with the options it keeps ([`settings`]): its last values, from this /// session or a saved one. pub(crate) fn make_tool(&self, id: &str) -> Box { @@ -212,13 +251,19 @@ impl Session { if let Some(r) = self.plane_widget_pointer(ev, view) { return r; } + let ev = &self.lend_selection_tool(ev); let acts = self.with_tool_cx(view, |t, cx| t.pointer(cx, ev)); - self.take_tool_panic()?; - // A gesture may change options (Alt-drag sizes a Liquify brush): keep them. + let r = self.take_tool_panic().and_then(|()| { + // A gesture may change options (Alt-drag sizes a Liquify brush): keep them. + if ev.kind == PointerKind::Up { + self.keep_tool_settings(); + } + self.apply_actions(acts) + }); if ev.kind == PointerKind::Up { - self.keep_tool_settings(); + self.give_back_tool(view)?; } - self.apply_actions(acts) + r } /// A guide dragged out of a ruler, whatever the tool: a vertical one out of the left ruler, a @@ -325,9 +370,20 @@ impl Session { } /// The pointer the active tool shows at `p` (General › Use Precise Cursors makes the drawing - /// tools' a crosshair, [`Cursor::precise`]). + /// tools' a crosshair, [`Cursor::precise`]). With Cmd held, the pointer of the selection tool a + /// press would borrow ([`Self::lend_selection_tool`]). pub fn cursor(&mut self, p: Point, mods: Mods, view: ViewInfo) -> Cursor { - let c = self.with_tool_cx(view, |t, cx| t.cursor(cx, p, mods)); + let lent = if mods.cmd && self.lender.is_none() { self.lent_tool(self.tool.id()) } else { None }; + let c = match lent { + Some(id) => { + let lent = self.make_tool(id); + let own = std::mem::replace(&mut self.tool, lent); + let c = self.with_tool_cx(view, |t, cx| t.cursor(cx, p, Mods { cmd: false, ..mods })); + self.tool = own; + c + } + None => self.with_tool_cx(view, |t, cx| t.cursor(cx, p, mods)), + }; if self.prefs.use_precise_cursors { c.precise() } else { c } } diff --git a/crates/engine/tests/import_fuzz.rs b/crates/engine/tests/import_fuzz.rs index 2d671446..e6f8e449 100644 --- a/crates/engine/tests/import_fuzz.rs +++ b/crates/engine/tests/import_fuzz.rs @@ -552,6 +552,10 @@ fn arb_rich_op() -> impl Strategy { "/Sh0 sh", "/Sh1 sh", "BT /F1 12 Tf 10 10 Td (Hi there) Tj [(a) -900 (b)] TJ ET", + // Lines wrapped in a frame, digits set apart by gaps, glyph outlines stroked (#508). + "BT /F1 10 Tf 10 80 Td (Wrapped line ) Tj 0 -12 Td (and its next ) Tj 0 -12 Td (end.) Tj ET", + "BT /F1 10 Tf 10 40 Td (3) Tj 20 0 Td (5331) Tj 40 0 Td (0106) Tj ET", + "0.5 w 10 10 m 14 18 l 18 10 l h S", "7 Tr", "q 10 10 50 50 re W n", "Q", diff --git a/crates/mcp/src/lib.rs b/crates/mcp/src/lib.rs index 21b664a4..ed3dc08b 100644 --- a/crates/mcp/src/lib.rs +++ b/crates/mcp/src/lib.rs @@ -49,6 +49,8 @@ mod tests_links; #[cfg(test)] mod tests_liquify; #[cfg(test)] +mod tests_pen; +#[cfg(test)] mod tests_persp; #[cfg(test)] mod tests_place; diff --git a/crates/mcp/src/tests_pen.rs b/crates/mcp/src/tests_pen.rs new file mode 100644 index 00000000..ae89a3b4 --- /dev/null +++ b/crates/mcp/src/tests_pen.rs @@ -0,0 +1,66 @@ +//! The Pen over MCP, headless: `pointer_gesture` with the modifiers held as on the desktop. + +use serde_json::{Value, json}; + +use crate::{Backend, Headless, call_tool}; + +fn text(r: &crate::ToolResult) -> Value { + assert!(!r.is_error, "{r:?}"); + serde_json::from_str(r.content[0]["text"].as_str().unwrap()).unwrap() +} + +/// A press at the first point, drags through the others, the release at the last. +fn gesture(pts: &[(f64, f64)]) -> Value { + let (first, last) = (pts[0], pts[pts.len() - 1]); + let mut events = vec![json!({"kind": "down", "x": first.0, "y": first.1})]; + events.extend(pts[1..].iter().map(|(x, y)| json!({"kind": "drag", "x": x, "y": y}))); + events.push(json!({"kind": "up", "x": last.0, "y": last.1})); + json!({ "events": events }) +} + +/// The anchors of each path, in paint order. +fn paths(h: &Headless) -> Vec> { + let mut v = vec![]; + h.session.doc().unwrap().doc.walk(|n| { + if let Some(p) = n.path_data() { + v.push(p.subpaths.iter().flat_map(|s| s.anchors.clone()).collect()); + } + }); + v +} + +/// #494: Cmd held at the press borrows Direct Selection from the Pen; the path goes on afterwards. +#[test] +fn cmd_with_the_pen_edits_the_path_being_drawn() { + let mut h = Headless::new(); + h.call("engine.execute", json!({"command": "file.new", "params": {"width": 800, "height": 600}})).unwrap(); + text(&call_tool(&mut h, "select_tool", &json!({"tool": "pen"}))); + text(&call_tool(&mut h, "pointer_gesture", &gesture(&[(100.0, 300.0)]))); + text(&call_tool(&mut h, "pointer_gesture", &gesture(&[(200.0, 300.0), (250.0, 300.0)]))); + let mut drag = gesture(&[(250.0, 300.0), (250.0, 280.0), (250.0, 263.0)]); + drag["mods"] = json!({"cmd": true}); + let r = text(&call_tool(&mut h, "pointer_gesture", &drag)); + assert_eq!(r["tool"], "pen", "{r}"); + assert_eq!(paths(&h)[0][1].h_out, vectorcraft_geom::Point::new(250.0, 263.0)); + text(&call_tool(&mut h, "pointer_gesture", &gesture(&[(300.0, 350.0)]))); + assert_eq!(paths(&h).iter().map(Vec::len).collect::>(), [3], "the same path, three anchors"); +} + +/// #501: a drag out of the first anchor closes the path, shaping the closing curve. +#[test] +fn a_drag_from_the_first_anchor_closes_the_path() { + let mut h = Headless::new(); + h.call("engine.execute", json!({"command": "file.new", "params": {"width": 800, "height": 600}})).unwrap(); + text(&call_tool(&mut h, "select_tool", &json!({"tool": "pen"}))); + for p in [(100.0, 300.0), (200.0, 300.0), (200.0, 400.0)] { + text(&call_tool(&mut h, "pointer_gesture", &gesture(&[p]))); + } + let close: Vec<(f64, f64)> = (0..=12).map(|i| (100.0 + 5.0 * f64::from(i), 300.0 - 4.0 * f64::from(i))).collect(); + text(&call_tool(&mut h, "pointer_gesture", &gesture(&close))); + let d = &h.session.doc().unwrap().doc; + let mut closed = vec![]; + d.walk(|n| closed.extend(n.path_data().map(|p| p.is_closed()))); + assert_eq!(closed, [true], "one path, closed"); + let first = paths(&h)[0][0]; + assert_eq!((first.h_in, first.h_out), (vectorcraft_geom::Point::new(40.0, 348.0), vectorcraft_geom::Point::new(160.0, 252.0))); +} diff --git a/crates/pdf/src/import.rs b/crates/pdf/src/import.rs index 88833c88..f9f6db07 100644 --- a/crates/pdf/src/import.rs +++ b/crates/pdf/src/import.rs @@ -23,7 +23,7 @@ use crate::import_color::{Colors, Native}; use crate::import_mask::{MaskSpec, contains, is_rectangle, luminance, mask_spec, white_cover}; use crate::import_scan::{MAX_NESTING, Ocgs, Scan, all_on, hides_forms, scan_page, tag_key}; use crate::import_shading::{clipped, extend_clip, fold_stop_opacity, mesh_shading, shading_gradient}; -use crate::import_text::{Families, Look, Placement, TextLine, Upright}; +use crate::import_text::{Families, LineFacts, Look, Placement, TextLine, Upright}; use crate::{CropTo, ImportOptions, ImportReport, PdfError, TextAs}; /// The name of the paths text imports as. @@ -76,6 +76,33 @@ fn place_group(g: usize, ocgs: &Ocgs, slots: &mut Vec, nesting: &mut Nesti slots.push(Slot::Group(child)); } +/// The top-level group that group `g` is listed under (`g` itself when it isn't a sublayer). +fn top_group(g: usize, ocgs: &Ocgs) -> usize { + let mut top = g; + for _ in 0..=MAX_NESTING { + match ocgs.list.get(top).and_then(|o| o.parent) { + Some(parent) => top = parent, + None => break, + } + } + top +} + +/// Merge the top-level groups a page marks (`page`, in the order it first marks each, its empty +/// ones too) into the stacking order of the pages before (`order`, bottom first; `known`: its +/// groups). A group new to it goes right below the first group the page marks after it that it +/// has: a layer whose art starts on a later page keeps its place among the others (#508). +fn merge_order(order: &mut Vec, known: &mut HashSet, page: &[usize]) { + let mut above = None; + for &g in page.iter().rev() { + if known.insert(g) { + let at = above.and_then(|a| order.iter().position(|&x| x == a)).unwrap_or(order.len()); + order.insert(at, g); + } + above = Some(g); + } +} + /// The layer of group `g`, in `color`: its art and sublayers. `None` for a group that isn't read. fn group_layer( b: &mut Builder<'_>, @@ -166,6 +193,8 @@ pub fn import_with_report(bytes: &[u8], opts: &ImportOptions) -> Result = vec![]; let mut group_art: HashMap>> = HashMap::new(); let mut nesting = Nesting::new(); + // The top-level groups in the order the pages mark them, bottom first. + let (mut order, mut known) = (vec![], HashSet::new()); for (i, &number) in picked.iter().enumerate() { let Some(page) = pages.get(number) else { continue }; // The chosen box sits at (x, 0); the page draws round it. @@ -175,6 +204,11 @@ pub fn import_with_report(bytes: &[u8], opts: &ImportOptions) -> Result = scan.tags.iter().filter_map(|(_, g)| g.map(|g| top_group(g, &ocgs))).filter(|g| seen.insert(*g)).collect(); + merge_order(&mut order, &mut known, &marked); + } b.begin_page(scan); interpret_page(page, &mut ctx, &mut b); let mut parts = b.end_page(); @@ -239,8 +273,25 @@ pub fn import_with_report(bytes: &[u8], opts: &ImportOptions) -> Result = order.iter().enumerate().map(|(i, &g)| (g, i)).collect(); + let at: Vec = slots.iter().enumerate().filter(|(_, s)| matches!(s, Slot::Group(_))).map(|(i, _)| i).collect(); + let mut stacked: Vec = slots.iter().filter_map(|s| if let Slot::Group(g) = s { Some(*g) } else { None }).collect(); + stacked.sort_by_key(|g| rank.get(g).copied().unwrap_or(usize::MAX)); + for (i, g) in at.into_iter().zip(stacked) { + if let Some(s) = slots.get_mut(i) { + *s = Slot::Group(g); + } + } for (n, slot) in slots.into_iter().enumerate() { - let layer = match slot { + let mut layer = match slot { Slot::Page(l) => *l, // Sublayers take their top-level layer's colour. Slot::Group(g) => match group_layer(&mut b, g, &ocgs, &nesting, &mut group_art, LayerColor::Preset((n % 27) as u8)) { @@ -248,6 +299,9 @@ pub fn import_with_report(bytes: &[u8], opts: &ImportOptions) -> Result continue, }, }; + if let Some(art) = layer.children_mut() { + crate::import_lines::rebuild(art, &b.lines); + } doc.layers.push(Arc::new(layer)); } for (k, blob) in b.images.drain() { @@ -567,6 +621,8 @@ struct Builder<'p> { nested: u32, /// The last filled path: its node and its outline (a stroke of the same outline joins it). last_fill: Option<(NodeId, BezPath)>, + /// What each line of type made tells beyond its text object ([`crate::import_lines`]). + lines: HashMap, } fn blend(b: hayro_interpret::BlendMode) -> BlendMode { @@ -701,6 +757,7 @@ impl<'p> Builder<'p> { pending: false, nested: 0, last_fill: None, + lines: HashMap::new(), } } @@ -786,10 +843,11 @@ impl<'p> Builder<'p> { let current = self.current_group(); let Some(f) = self.stack.last_mut() else { return }; f.children.push(n); + // A frame's art goes where its first art was drawn (a clip can end in a later group). if root { self.root_groups.push(group.or(current)); } else if f.group.is_none() { - f.group = group; + f.group = group.or(current); } } @@ -955,9 +1013,10 @@ impl<'p> Builder<'p> { } fn flush_text(&mut self) { - let Some((t, opacity)) = self.text.take().and_then(TextLine::finish) else { return }; + let Some((t, opacity, facts)) = self.text.take().and_then(TextLine::finish) else { return }; let mut n = Node::new(self.id(), NodeKind::Text(Box::new(t))); n.opacity = opacity; + self.lines.insert(n.id, facts); self.push_node(n); } @@ -1227,6 +1286,14 @@ impl<'p> Builder<'p> { place(&mut line); self.text = Some(line); } + // Its ink: a stroke the file draws as outlines of the glyphs is told by it. + let mut ink = o.outline(); + if let Some(line) = &mut self.text + && !ink.elements().is_empty() + { + ink.apply_affine(m); + line.ink.push(ink.bounding_box()); + } true } } @@ -1570,8 +1637,10 @@ impl<'a> Device<'a> for Builder<'_> { if self.nested > 0 { return; } - if self.marked.pop().flatten().is_some() { + // The runs gathered within a layer's sequence are its art: finish them before it ends. + if self.marked.last().copied().flatten().is_some() { self.flush(); } + self.marked.pop(); } } diff --git a/crates/pdf/src/import_lines.rs b/crates/pdf/src/import_lines.rs new file mode 100644 index 00000000..2009355c --- /dev/null +++ b/crates/pdf/src/import_lines.rs @@ -0,0 +1,254 @@ +//! What a file's lines of type were, beyond what each line says on its own (#508). An editor +//! writes what PDF text can't say as more art next to the text, and the type it wrapped in a +//! frame as lines: +//! - a stroke added to a type object (above or below its characters) comes as the outline of each +//! glyph stroked, one path per glyph, right after the type (or right before it): it is the +//! type's stroke again, so the type stays one object; +//! - area type comes as a line of point type per line, each wrapped line ending in a space. Lines +//! in a row sharing a left edge, font, size and leading (and paragraph spacing) are one area +//! type object again, aligned left or justified, where laying its text out in the frame breaks +//! it where the file does: else, as where its font isn't installed, they stay lines. + +use std::collections::HashMap; +use std::sync::Arc; + +use kurbo::{Point, Rect, Shape}; +use vectorcraft_color::BlendMode; +use vectorcraft_doc::{AppearanceItem, Justify, Node, NodeId, NodeKind, TextKind, TextObject, TextRun}; +use vectorcraft_geom::shapes; + +use crate::import_text::LineFacts; + +/// Rebuild the type among `nodes` (and in their groups) from what its lines tell (`lines`). +pub(crate) fn rebuild(nodes: &mut Vec>, lines: &HashMap) { + if lines.is_empty() { + return; + } + for n in nodes.iter_mut() { + if n.children().is_some_and(|c| !c.is_empty()) + && let Some(children) = Arc::make_mut(n).children_mut() + { + rebuild(children, lines); + } + } + join_strokes(nodes, lines); + join_paragraphs(nodes, lines); +} + +/// The stroke paths `nodes` draw when they are the outlines of the glyphs whose ink boxes are +/// `ink`, stroked one by one alike (no fill, mask or blending, fully opaque). +fn outline_stroke(nodes: &[Arc], ink: &[Rect]) -> Option { + let first = nodes.first()?; + let [stroke @ AppearanceItem::Stroke(_)] = first.appearance.items.as_slice() else { return None }; + let on_glyph = |n: &Node, r: &Rect| { + let tol = 0.01 * (r.width() + r.height()) + 0.01; + let NodeKind::Path { path, clipping: false, guide: false, live: None, .. } = &n.kind else { return false }; + let b = path.to_bezpath().bounding_box(); + n.appearance == first.appearance + && n.mask.is_none() + && n.opacity >= 0.999 + && n.blend == BlendMode::Normal + && [(b.x0, r.x0), (b.y0, r.y0), (b.x1, r.x1), (b.y1, r.y1)].iter().all(|(a, b)| (a - b).abs() <= tol) + }; + (nodes.len() == ink.len() && nodes.iter().zip(ink).all(|(n, r)| on_glyph(n, r))).then(|| stroke.clone()) +} + +/// Each type object among `nodes` whose glyphs' outlines are stroked by the paths right after it +/// (or right before it) takes that stroke above (or below) its characters, and the paths go. +fn join_strokes(nodes: &mut Vec>, lines: &HashMap) { + let mut i = 0; + while i < nodes.len() { + let ink = nodes + .get(i) + .filter(|n| matches!(n.kind, NodeKind::Text(_)) && n.appearance.items.is_empty()) + .and_then(|n| lines.get(&n.id)) + .map_or(&[][..], |f| f.ink.as_slice()); + let k = ink.len(); + if k > 0 { + if let Some(stroke) = nodes.get(i + 1..i + 1 + k).and_then(|after| outline_stroke(after, ink)) { + nodes.drain(i + 1..i + 1 + k); + if let Some(t) = nodes.get_mut(i) { + Arc::make_mut(t).appearance.items.push(stroke); + } + } else if let Some(stroke) = i.checked_sub(k).and_then(|from| nodes.get(from..i)).and_then(|before| outline_stroke(before, ink)) { + nodes.drain(i - k..i); + i -= k; + if let Some(t) = nodes.get_mut(i) { + let ap = &mut Arc::make_mut(t).appearance; + ap.items.insert(0, stroke); + ap.set_contents_at(1); + } + } + } + i += 1; + } +} + +/// `n` as a line that can be part of area type: horizontal point type, with what its line told. +fn line<'a>(n: &'a Node, lines: &'a HashMap) -> Option<(&'a TextObject, &'a LineFacts)> { + let NodeKind::Text(t) = &n.kind else { return None }; + let point = matches!(t.kind, TextKind::Point) && !t.vertical && n.mask.is_none() && !t.runs.is_empty(); + point.then_some(())?; + Some((t, lines.get(&n.id)?)) +} + +/// Lines of type in a row that may be one area type object. +struct Block { + /// The step from a wrapped line's baseline to the next. + leading: f64, + /// The extra step after a line ending a paragraph. + space: f64, + /// Each line's baseline below the first (text space). + ys: Vec, +} + +/// The lines from `nodes`' first on that share its left edge, angle, font and size, its look +/// (opacity, blending, appearance) and steps down by one leading after a wrapped line and by +/// another (the leading and paragraph spacing) after a line ending a paragraph: how many, and +/// the block they make unless none of them was wrapped (0 and `None`: the first isn't a line). +fn block(nodes: &[Arc], lines: &HashMap) -> (usize, Option) { + let Some((head, (t0, f0))) = nodes.first().and_then(|n| Some((n, line(n, lines)?))) else { return (0, None) }; + let st = t0.first_style(); + let size = st.size; + let inv = t0.xf.inverse(); + let lin = |t: &TextObject| { + let [a, b, c, d, ..] = t.xf.as_coeffs(); + [a, b, c, d] + }; + let (mut ys, mut wraps) = (vec![0.0], f0.wraps); + let (mut leading, mut para): (Option, Option) = (None, None); + for n in nodes.iter().skip(1) { + let Some((t, f)) = line(n, lines) else { break }; + let s = t.first_style(); + let alike = n.opacity == head.opacity + && n.blend == head.blend + && n.appearance == head.appearance + && s.font_family == st.font_family + && s.font_style == st.font_style + && (s.size - size).abs() <= size * 0.01 + && t.para == t0.para + && lin(t).iter().zip(lin(t0)).all(|(a, b)| (a - b).abs() < 1e-6); + let at = inv * (t.xf * Point::ZERO); + let step = at.y - ys.last().copied().unwrap_or_default(); + if !alike || at.x.abs() > size * 0.02 || !(step > size * 0.5 && step < size * 4.0) { + break; + } + let slot = if wraps { &mut leading } else { &mut para }; + match *slot { + Some(s) if (s - step).abs() > size * 0.01 => break, + Some(_) => {} + None => *slot = Some(step), + } + ys.push(at.y); + wraps = f.wraps; + } + let count = ys.len(); + let Some(leading) = leading else { return (count, None) }; + let space = para.map_or(0.0, |p| p - leading); + (count, (space > -size * 0.01).then_some(Block { leading, space: space.max(0.0), ys })) +} + +/// Lines `nodes` of block `b` as one area type object, aligned left or justified, when laying it +/// out breaks its lines where the file does. +fn area_type(nodes: &[Arc], lines: &HashMap, b: &Block) -> Option { + let texts: Vec<(&TextObject, &LineFacts)> = nodes.iter().map(|n| line(n, lines)).collect::>()?; + let (first, _) = texts.first()?; + let size = first.first_style().size; + // Each line's tracking (a line with spaces tracked apart was set by hand). + let trackings: Vec = texts + .iter() + .map(|(t, _)| { + let mut all = t.runs.iter().map(|r| r.style.tracking); + let one = all.next()?; + all.all(|x| x == one).then_some(one) + }) + .collect::>()?; + let median = |mut v: Vec| { + v.sort_by(f64::total_cmp); + v.get(v.len() / 2).copied() + }; + let wrapped: Vec = texts.iter().filter(|(_, f)| f.wraps).map(|(_, f)| f.length).collect(); + let longest = |v: &[f64]| v.iter().copied().fold(0.0, f64::max); + let mut tries = vec![]; + // Wrapped lines all as long: justified (a paragraph's last line aligned left), tracked as the + // lines that end paragraphs are (the others are spaced out). + let full = longest(&wrapped); + if wrapped.len() >= 2 && wrapped.iter().all(|l| (full - l).abs() <= size * 0.02) { + let ends: Vec = texts.iter().zip(&trackings).filter(|((_, f), _)| !f.wraps).map(|(_, t)| *t).collect(); + let tracking = median(ends).or_else(|| trackings.iter().copied().reduce(f64::min))?; + tries.push((Justify::JustifyLeft, full, tracking)); + } + let all: Vec = texts.iter().map(|(_, f)| f.length).collect(); + tries.push((Justify::Left, longest(&all) + size * 0.02, median(trackings)?)); + tries.into_iter().find_map(|(justify, width, tracking)| laid_out(&texts, b, justify, width, tracking)) +} + +/// The area type of lines `texts` (block `b`): `width` wide, aligned `justify`, its characters +/// tracked `tracking`; `None` when it doesn't lay out as the lines did. +fn laid_out(texts: &[(&TextObject, &LineFacts)], b: &Block, justify: Justify, width: f64, tracking: f64) -> Option { + let (first, _) = texts.first()?; + let size = first.first_style().size; + // Leading as set, unless it is Auto's (120% of the size). + let explicit = + (b.leading - size * 1.2).abs() > size * 1e-3 || texts.iter().any(|(t, _)| t.runs.iter().any(|r| (r.style.size - size).abs() > 1e-9)); + let mut runs: Vec = vec![]; + for (k, (t, f)) in texts.iter().enumerate() { + for r in &t.runs { + let mut style = r.style.clone(); + style.tracking = tracking; + style.leading = explicit.then_some((b.leading * 1000.0).round() / 1000.0); + match runs.last_mut() { + Some(last) if last.style == style => last.text.push_str(&r.text), + _ => runs.push(TextRun { text: r.text.clone(), style }), + } + } + // A wrapped line's space, or the end of a paragraph. + if k + 1 < texts.len() + && let Some(last) = runs.last_mut() + { + last.text.push(if f.wraps { ' ' } else { '\n' }); + } + } + let mut t = (*first).clone(); + t.runs = runs; + t.para.justify = justify; + t.para.space_before = b.space; + let last = b.ys.last().copied()?; + let db = vectorcraft_text::FontDb::global(); + // The frame's top puts the first baseline where the file has it. + t.kind = TextKind::Area { frame: shapes::rectangle(Rect::new(0.0, 0.0, width, last + b.leading.max(size) + size)) }; + let top = -vectorcraft_text::layout(db, &t).lines.first()?.baseline; + t.kind = TextKind::Area { frame: shapes::rectangle(Rect::new(0.0, top, width, last + b.leading.max(size))) }; + let laid = vectorcraft_text::layout(db, &t); + let plain = t.plain_text(); + let same = !laid.overflow + && laid.lines.len() == texts.len() + && laid.lines.iter().zip(texts).zip(&b.ys).all(|((l, (line, f)), y)| { + let text = plain.get(l.start..l.end).unwrap_or_default(); + text.trim() == line.plain_text().trim() + && (l.baseline - y).abs() <= size * 0.05 + && (justify != Justify::JustifyLeft || !f.wraps || (l.x1 - f.length).abs() <= size * 0.05) + }); + t.cached_bounds = Some(laid.bounds); + same.then_some(t) +} + +/// Lines of point type in a row among `nodes` that were wrapped in a frame become one area type +/// object again (see [`area_type`]). +fn join_paragraphs(nodes: &mut Vec>, lines: &HashMap) { + let mut i = 0; + while i < nodes.len() { + let (count, b) = nodes.get(i..).map_or((0, None), |rest| block(rest, lines)); + let area = b.filter(|_| count > 1).and_then(|b| area_type(nodes.get(i..i + count)?, lines, &b)); + if let Some(area) = area + && let Some(head) = nodes.get_mut(i) + { + Arc::make_mut(head).kind = NodeKind::Text(Box::new(area)); + nodes.drain(i + 1..i + count); + i += 1; + } else { + // Lines that don't make area type: none of them starts it either. + i += count.max(1); + } + } +} diff --git a/crates/pdf/src/import_text.rs b/crates/pdf/src/import_text.rs index 3c9b440e..de2a2e47 100644 --- a/crates/pdf/src/import_text.rs +++ b/crates/pdf/src/import_text.rs @@ -9,9 +9,10 @@ use std::collections::HashMap; -use kurbo::{Affine, BezPath, Point, Vec2}; +use kurbo::{Affine, BezPath, Point, Rect, Vec2}; use vectorcraft_color::Paint; use vectorcraft_doc::{CharStyle, ParaDirection, TextKind, TextObject, TextRun}; +use vectorcraft_text::TextLayout; /// One glyph's placement: its baseline origin, advance direction, size and horizontal scale. #[derive(Clone, Copy, Debug)] @@ -103,6 +104,8 @@ pub(crate) struct TextLine { next: Point, /// The last glyph's origin. last: Point, + /// Where the last glyph that isn't a space ends. + visible: Point, /// The last glyph's baseline direction. last_dir: Vec2, /// Each glyph's baseline origin, then where the last one ends. @@ -112,6 +115,24 @@ pub(crate) struct TextLine { upright: Option, /// The glyphs make a column (vertical type), each below the last. column: bool, + /// Each glyph's ink box as drawn (document space), in drawing order; glyphs without ink are + /// left out. + pub ink: Vec, + /// The spaces read from gaps between glyphs: their byte offset in the text, and the gap from + /// the end of the glyph before to the start of the next (points). + gaps: Vec<(usize, f64)>, +} + +/// What a finished line of type tells beyond its text object (see [`crate::import_lines`]). +#[derive(Clone, Debug, Default)] +pub(crate) struct LineFacts { + /// [`TextLine::ink`]. + pub ink: Vec, + /// Horizontal point type: it ended in a space (as a line an editor wrapped in a frame does). + pub wraps: bool, + /// Horizontal point type: how long the file set it, from its first glyph's origin to the end + /// of its last glyph that isn't a space (points, along the baseline). + pub length: f64, } /// The most a glyph on a curve turns from the one before it (about 20°). @@ -119,7 +140,20 @@ const CURVE_TURN_COS: f64 = 0.94; impl TextLine { pub fn new(at: Placement, opacity: f32) -> Self { - Self { at, opacity, next: at.origin, last: at.origin, last_dir: at.dir, baseline: vec![], runs: vec![], upright: None, column: false } + Self { + at, + opacity, + next: at.origin, + last: at.origin, + visible: at.origin, + last_dir: at.dir, + baseline: vec![], + runs: vec![], + upright: None, + column: false, + ink: vec![], + gaps: vec![], + } } /// Add glyph `text` set vertically (`upright`) if it continues this column (or makes this @@ -171,6 +205,7 @@ impl TextLine { if self.column || self.upright.is_some() { return false; } + let bytes: usize = self.runs.iter().map(|(_, t)| t.len()).sum(); if let Some((last, run)) = self.runs.last_mut() { let size = self.at.size.max(at.size); let gap = (at.origin - self.next).dot(self.last_dir); @@ -192,6 +227,9 @@ impl TextLine { // A gap wider than a fifth of an em reads as a space. if gap > size * 0.2 && !run.ends_with(' ') && !text.starts_with(' ') { run.push(' '); + if on_line { + self.gaps.push((bytes, gap)); + } } if last.takes(look) { run.push_str(text); @@ -202,6 +240,9 @@ impl TextLine { self.runs.push((look.clone(), text.to_string())); } self.next = at.origin + at.dir * advance; + if !text.trim().is_empty() { + self.visible = self.next; + } self.last = at.origin; self.last_dir = at.dir; self.baseline.push(at.origin); @@ -247,10 +288,12 @@ impl TextLine { true } - /// The point type object and its opacity. - pub fn finish(mut self) -> Option<(TextObject, f32)> { + /// The point type object, its opacity and what else the line tells. + pub fn finish(mut self) -> Option<(TextObject, f32, LineFacts)> { + let mut facts = LineFacts { ink: std::mem::take(&mut self.ink), ..LineFacts::default() }; // Turned along a curve: type on a path through the glyphs. let path = if self.curved() { self.baseline_path() } else { None }; + facts.wraps = path.is_none() && self.upright.is_none() && self.runs.last().is_some_and(|(_, t)| t.ends_with(' ')); if let Some((_, last)) = self.runs.last_mut() { last.truncate(last.trim_end().len()); } @@ -272,7 +315,7 @@ impl TextLine { t.kind = TextKind::OnPath { path: vectorcraft_geom::PathData::from_bezpath(&path), start: 0.0, end: None }; t.xf = Affine::IDENTITY; t.cached_bounds = Some(vectorcraft_text::layout(db, &t).bounds); - return Some((t, self.opacity)); + return Some((t, self.opacity, facts)); } let (start, along) = match self.upright { // Vertical point type (a column, or a single upright glyph) is anchored at the top @@ -286,26 +329,87 @@ impl TextLine { }; // Tracking that makes the line as long as in the file: the PDF placed each glyph, the // layout sets them by their advances. Spread over the gaps between characters (tracking - // follows each character, the last one's past the end of the line). - let length = (self.next - start).dot(along); + // follows each character, the last one's past the end of the line). A horizontal line is + // measured to its last glyph that isn't a space: the spaces after it were dropped. + let length = (if t.vertical { self.next } else { self.visible } - start).dot(along); + if !t.vertical { + facts.length = length; + } let laid = vectorcraft_text::layout(db, &t); let natural: f64 = laid.glyphs.iter().map(|g| g.advance).sum(); let chars: usize = t.runs.iter().map(|r| r.text.chars().count()).sum(); let size = self.at.size; let mut bounds = laid.bounds; if chars > 1 && length.is_finite() && (length - natural).abs() > size * 0.01 { - let tracking = ((length - natural) / (chars - 1) as f64 / size * 1000.0).clamp(-1000.0, 1000.0).round(); - for r in &mut t.runs { - r.style.tracking = tracking; - } + // The spaces read from gaps keep their own place only in text left in the file's order. + let total: usize = t.runs.iter().map(|r| r.text.len()).sum(); + let gaps: Vec<(usize, f64)> = + if t.para.direction.is_none() { self.gaps.into_iter().filter(|(b, _)| *b < total).collect() } else { vec![] }; + let (tracking, spaces) = spacing(&laid, &gaps, length - natural, chars, size); + t.runs = tracked(std::mem::take(&mut t.runs), tracking, &spaces); // Tracked: laid out again for its bounds. bounds = vectorcraft_text::layout(db, &t).bounds; } t.cached_bounds = Some(bounds); - Some((t, self.opacity)) + Some((t, self.opacity, facts)) } } +/// The tracking (thousandths of an em) that sets a line of `chars` characters, laid out untracked +/// as `laid`, `extra` points longer, as the file set it: the same after every character, except +/// the spaces read from gaps (`gaps`: byte offset, gap in points) where that would put the glyphs +/// after them more than a tenth of an em off (a barcode's digits, set in groups apart). Those take +/// their own tracking, given with their byte offsets. +fn spacing(laid: &TextLayout, gaps: &[(usize, f64)], extra: f64, chars: usize, size: f64) -> (f64, Vec<(usize, f64)>) { + let pairs = chars.saturating_sub(1).max(1) as f64; + // The space and the character before it take `need` (the gap less the space) between them; + // tracking gives them twice its share. + let space = |b: usize| laid.glyphs.iter().find(|g| g.byte == b).map(|g| g.advance); + let needs: Vec<(usize, f64)> = gaps.iter().filter_map(|&(b, gap)| Some((b, gap - space(b)?))).collect(); + let mut own: Vec<(usize, f64)> = vec![]; + let mut tracking = extra / pairs; + // Each space taken apart changes the others' share: until no more are. + loop { + let more: Vec<(usize, f64)> = + needs.iter().filter(|(b, need)| !own.iter().any(|(o, _)| o == b) && (need - 2.0 * tracking).abs() > size * 0.1).copied().collect(); + if more.is_empty() { + break; + } + own.extend(more); + let rest = pairs - 2.0 * own.len() as f64; + tracking = if rest >= 1.0 { (extra - own.iter().map(|(_, need)| need).sum::()) / rest } else { 0.0 }; + } + own.sort_by_key(|(b, _)| *b); + let em = |pts: f64| (pts / size * 1000.0).clamp(-1000.0, 1000.0).round(); + (em(tracking), own.into_iter().map(|(b, need)| (b, em(need - tracking))).collect()) +} + +/// `runs` with tracking `tracking`, and each space at a byte offset of `spaces` (in order) a run +/// of its own with the tracking given with it. +fn tracked(runs: Vec, tracking: f64, spaces: &[(usize, f64)]) -> Vec { + let mut out = Vec::with_capacity(runs.len() + 2 * spaces.len()); + let mut off = 0; + for r in runs { + let style = CharStyle { tracking, ..r.style }; + let end = off + r.text.len(); + let mut from = 0; + for &(b, own) in spaces.iter().filter(|(b, _)| (off..end).contains(b)) { + let at = b - off; + let (Some(before), Some(space)) = (r.text.get(from..at), r.text.get(at..at + 1)) else { continue }; + if !before.is_empty() { + out.push(TextRun { text: before.to_string(), style: style.clone() }); + } + out.push(TextRun { text: space.to_string(), style: CharStyle { tracking: own, ..style.clone() } }); + from = at + 1; + } + if let Some(rest) = r.text.get(from..).filter(|t| !t.is_empty()) { + out.push(TextRun { text: rest.to_string(), style }); + } + off = end; + } + out +} + fn round(v: f64) -> f64 { (v * 1000.0).round() / 1000.0 } diff --git a/crates/pdf/src/lib.rs b/crates/pdf/src/lib.rs index 61ce4b35..2cbc4176 100644 --- a/crates/pdf/src/lib.rs +++ b/crates/pdf/src/lib.rs @@ -48,6 +48,7 @@ mod images; mod import; mod import_color; mod import_image; +mod import_lines; mod import_mask; mod import_scan; mod import_shading; @@ -231,6 +232,8 @@ mod tests_import_fidelity; #[cfg(test)] mod tests_import_layers; #[cfg(test)] +mod tests_import_lines; +#[cfg(test)] mod tests_import_options; #[cfg(test)] mod tests_layers; diff --git a/crates/pdf/src/tests_import_fidelity.rs b/crates/pdf/src/tests_import_fidelity.rs index 8c52ded8..b6098eed 100644 --- a/crates/pdf/src/tests_import_fidelity.rs +++ b/crates/pdf/src/tests_import_fidelity.rs @@ -242,11 +242,13 @@ fn text_becomes_point_type() { // The baseline origin, in y-down page space. let o = t[0].xf * kurbo::Point::ORIGIN; assert!((o.x - 10.0).abs() < 0.01 && (o.y - 70.0).abs() < 0.01, "{o:?}"); - // A gap of an em between words reads as a space; another font on the line is another run. + // A gap of an em between words reads as a space, tracked on its own to keep the gap's width + // (#508); another font on the line is another run. assert_eq!(text(&t[1]), "Next line in bold"); let runs: Vec<(&str, &str)> = t[1].runs.iter().map(|r| (r.text.as_str(), r.style.font_style.as_str())).collect(); - assert_eq!(runs, [("Next line", "Regular"), (" in bold", "Bold")]); - assert_eq!(t[1].runs[1].style.fill.color(), Some(Color::rgb(0.0, 0.0, 1.0))); + assert_eq!(runs, [("Next", "Regular"), (" ", "Regular"), ("line", "Regular"), (" in bold", "Bold")]); + assert!(t[1].runs[1].style.tracking > t[1].runs[0].style.tracking + 100.0, "{:?}", t[1].runs); + assert_eq!(t[1].runs[3].style.fill.color(), Some(Color::rgb(0.0, 0.0, 1.0))); assert!(!r.warnings.iter().any(|w| w.contains("outlines")), "{:?}", r.warnings); // As outlines: paths, no type. let r = open_with(&bytes, |o| o.text_as = TextAs::Outlines); diff --git a/crates/pdf/src/tests_import_lines.rs b/crates/pdf/src/tests_import_lines.rs new file mode 100644 index 00000000..6005e7f0 --- /dev/null +++ b/crates/pdf/src/tests_import_lines.rs @@ -0,0 +1,203 @@ +//! What a file's lines of type were (#508): the layer art ending a group's marked content belongs +//! to, layers ordered as the pages mark them, a stroke written as stroked glyph outlines, spaces +//! read from wide gaps, and lines wrapped in a frame rebuilt as area type. + +use kurbo::{BezPath, PathEl, Point, Shape}; +use serde_json::json; +use vectorcraft_color::{Color, Paint}; +use vectorcraft_doc::{AppearanceItem, CharStyle, Document, Justify, Node, NodeKind, TextKind, TextObject}; +use vectorcraft_geom::{Affine, Rect, shapes}; +use vectorcraft_testkit::pdf::{PdfPage, first_extra, pdf_with_catalog}; + +use crate::*; + +const HELVETICA: &str = "/Font << /F1 << /Type /Font /Subtype /Type1 /BaseFont /Helvetica >> >>"; + +/// Groups "A" and "B" (A painted first) for a file of `pages` pages, and the catalog entries. +fn groups(pages: usize) -> ([String; 2], String, String) { + let (a, b) = (first_extra(pages), first_extra(pages) + 1); + let objs = ["<< /Type /OCG /Name (A) >>".to_string(), "<< /Type /OCG /Name (B) >>".to_string()]; + let catalog = format!("/OCProperties << /OCGs [{a} 0 R {b} 0 R] /D << /Order [{b} 0 R {a} 0 R] >> >> "); + let resources = format!("/Properties << /MC0 {a} 0 R /MC1 {b} 0 R >> {HELVETICA}"); + (objs, catalog, resources) +} + +/// A file of 100 × 100 pt pages drawing `contents`, with groups A (`/MC0`) and B (`/MC1`). +fn layered(contents: &[&str]) -> Document { + let (objs, catalog, resources) = groups(contents.len()); + let pages: Vec = contents.iter().map(|c| PdfPage { resources: resources.clone(), ..PdfPage::new(100.0, 100.0, c) }).collect(); + import(&pdf_with_catalog(&pages, &[&objs[0], &objs[1]], &catalog, None)).unwrap() +} + +/// The layers' names, bottom first, and the kinds of their art. +fn layers(d: &Document) -> Vec<(String, Vec<&'static str>)> { + let kind = |n: &std::sync::Arc| match n.kind { + NodeKind::Text(_) => "text", + NodeKind::Group { .. } => "group", + _ => "path", + }; + d.layers.iter().map(|l| (l.name.clone().unwrap_or_default(), l.children().map_or(vec![], |c| c.iter().map(kind).collect()))).collect() +} + +fn texts(d: &Document) -> Vec { + let mut v = vec![]; + d.walk(|n| { + if let NodeKind::Text(t) = &n.kind { + v.push((**t).clone()); + } + }); + v +} + +fn named(layers: &[(&str, &[&'static str])]) -> Vec<(String, Vec<&'static str>)> { + layers.iter().map(|(n, k)| (n.to_string(), k.to_vec())).collect() +} + +#[test] +fn type_ending_a_layers_marked_content_stays_in_its_layer() { + // The line is still being gathered when the group's sequence ends. + let d = layered(&["/OC /MC0 BDC 0 0 1 rg 0 0 10 10 re f BT /F1 12 Tf 10 50 Td (Lead) Tj ET EMC /OC /MC1 BDC EMC"]); + assert_eq!(layers(&d), named(&[("A", &["path", "text"]), ("B", &[])])); +} + +#[test] +fn a_clip_ending_in_a_later_group_stays_with_its_art() { + // The clip opens in A, its art is drawn in A, and it closes after B's (empty) sequence. + let d = layered(&["/OC /MC0 BDC q 0 0 50 50 re W n 1 0 0 rg 40 40 20 20 re f EMC /OC /MC1 BDC EMC Q"]); + assert_eq!(layers(&d), named(&[("A", &["group"]), ("B", &[])])); +} + +#[test] +fn layers_stack_as_the_pages_mark_them_when_one_first_paints_on_a_later_page() { + // A, the bottom layer, is empty on page 1 and has art on page 2 only. + let d = layered(&["/OC /MC0 BDC EMC /OC /MC1 BDC 1 0 0 rg 0 0 10 10 re f EMC", "/OC /MC0 BDC 0 0 1 rg 0 0 10 10 re f EMC /OC /MC1 BDC EMC"]); + assert_eq!(layers(&d), named(&[("A", &["path"]), ("B", &["path"])])); + // A group marked with no art on any page is an empty layer in its place. + let d = layered(&["/OC /MC0 BDC EMC /OC /MC1 BDC 1 0 0 rg 0 0 10 10 re f EMC"]); + assert_eq!(layers(&d), named(&[("A", &[]), ("B", &["path"])])); +} + +/// A 100 × 100 pt page drawing `content` in Helvetica. +fn page(content: &str) -> Vec { + vectorcraft_testkit::pdf::pdf(&[PdfPage { resources: HELVETICA.into(), ..PdfPage::new(100.0, 100.0, content) }], None) +} + +/// The outline of glyph `c` drawn at 24 pt from (x, 50), in PDF operators (y up), stroked. +fn outline(c: char, x: f64) -> String { + let opts = ImportOptions { text_as: TextAs::Outlines, ..Default::default() }; + let d = import_with_report(&page(&format!("BT /F1 24 Tf {x} 50 Td ({c}) Tj ET")), &opts).unwrap().document; + let mut p: Option = None; + d.walk(|n| { + if let NodeKind::Path { path, .. } = &n.kind { + p = Some(path.to_bezpath()); + } + }); + let pt = |q: Point| format!("{:.3} {:.3}", q.x, 100.0 - q.y); + let ops: String = p + .unwrap() + .elements() + .iter() + .map(|e| match e { + PathEl::MoveTo(a) => format!("{} m ", pt(*a)), + PathEl::LineTo(a) => format!("{} l ", pt(*a)), + PathEl::QuadTo(a, b) => format!("{} {} {} c ", pt(*a), pt(*b), pt(*b)), + PathEl::CurveTo(a, b, c) => format!("{} {} {} c ", pt(*a), pt(*b), pt(*c)), + PathEl::ClosePath => "h ".into(), + }) + .collect(); + ops + "S " +} + +#[test] +fn a_stroke_written_as_stroked_glyph_outlines_is_the_types_stroke() { + // "Hi": the H is 722 units wide in Helvetica. + let strokes = format!("0 0 1 RG 0.5 w {}{}", outline('H', 10.0), outline('i', 10.0 + 0.722 * 24.0)); + let text = "BT 1 0 0 rg /F1 24 Tf 10 50 Td (Hi) Tj ET "; + for (content, below) in [(format!("{text}{strokes}"), false), (format!("{strokes}{text}"), true)] { + let d = import(&page(&content)).unwrap(); + let art = d.layers[0].children().unwrap(); + assert_eq!(art.len(), 1, "one object: {art:?}"); + let NodeKind::Text(t) = &art[0].kind else { panic!("{:?}", art[0].kind) }; + assert_eq!(t.plain_text(), "Hi"); + assert_eq!(t.first_style().fill.color(), Some(Color::rgb(1.0, 0.0, 0.0))); + let ap = &art[0].appearance; + let [AppearanceItem::Stroke(st)] = ap.items.as_slice() else { panic!("{ap:?}") }; + assert_eq!(st.paint.color(), Some(Color::rgb(0.0, 0.0, 1.0))); + assert!((st.width - 0.5).abs() < 1e-6); + assert_eq!(ap.contents_at(), usize::from(below), "a stroke drawn first paints below the characters"); + } + // A stroke that isn't on the glyphs stays a path. + let d = import(&page(&format!("{text}0 0 1 RG 0.5 w {}", outline('H', 40.0)))).unwrap(); + assert_eq!(d.layers[0].children().unwrap().len(), 2); +} + +/// A 300 × 200 pt page with `lines` of (x, y from the top, size, text) in Source Sans 3. +fn source_sans(lines: &[(f32, f32, f32, &str)]) -> Vec { + crate::tests_live_text::text_pdf(lines, false) +} + +#[test] +fn spaces_read_from_wide_gaps_keep_the_glyphs_after_them_in_place() { + // A barcode's digits in three groups, set apart by more than a space. + let (x1, x2) = (29.0, 69.0); + let bytes = source_sans(&[(20.0, 50.0, 10.0, "3"), (x1, 50.0, 10.0, "533121"), (x2, 50.0, 10.0, "010629")]); + let t = texts(&import(&bytes).unwrap()); + assert_eq!(t.len(), 1); + assert_eq!(t[0].plain_text(), "3 533121 010629"); + let laid = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &t[0]); + let at = |byte: usize| (t[0].xf * laid.glyphs.iter().find(|g| g.byte == byte).unwrap().origin).x; + assert!((at(2) - f64::from(x1)).abs() < 0.05, "the second group starts where the file has it: {} vs {x1}", at(2)); + assert!((at(9) - f64::from(x2)).abs() < 0.05, "the third group starts where the file has it: {} vs {x2}", at(9)); +} + +/// A document of area type `text` (Source Sans 3, 10 pt) `width` wide at (20, 30). +fn area_doc(text: &str, justify: Justify, width: f64, space_before: f64) -> Document { + let style = CharStyle { size: 10.0, fill: Paint::solid(Color::BLACK), ..Default::default() }; + let mut t = TextObject::point(Point::ORIGIN, text, style); + t.kind = TextKind::Area { frame: shapes::rectangle(Rect::new(0.0, 0.0, width, 200.0)) }; + t.xf = Affine::translate((20.0, 30.0)); + t.para.justify = justify; + t.para.space_before = space_before; + let mut d = Document::new(300.0, 300.0); + let l = d.layers[0].id; + let n = Node::new(d.alloc_id(), NodeKind::Text(Box::new(t))); + d.insert(Some(l), 0, n).unwrap(); + d +} + +/// `d` exported (real text) and imported again. +fn round_trip(d: &Document) -> Document { + let settings: PdfSettings = serde_json::from_value(json!({"compression": {"compressText": false}, "advanced": {"outlineText": false}})).unwrap(); + let bytes = export_with_report(d, &PdfOptions { settings, ..Default::default() }).unwrap().bytes; + import(&bytes).unwrap() +} + +const PROSE: &str = "Stop losing your sinkers on the cast: the clip holds the lead until a snag pulls it free, \ + so the fish swims on without the weight.\nIt works on every running rig and leaves the line clear."; + +#[test] +fn lines_wrapped_in_a_frame_come_back_as_area_type() { + for (justify, space) in [(Justify::Left, 0.0), (Justify::JustifyLeft, 4.0)] { + let d = round_trip(&area_doc(PROSE, justify, 120.0, space)); + let t = texts(&d); + assert_eq!(t.len(), 1, "{justify:?}: one object, not a line each: {:?}", t.iter().map(TextObject::plain_text).collect::>()); + assert_eq!(t[0].plain_text(), PROSE); + assert_eq!(t[0].para.justify, justify); + assert!((t[0].para.space_before - space).abs() < 0.01, "{}", t[0].para.space_before); + let TextKind::Area { frame } = &t[0].kind else { panic!("{:?}", t[0].kind) }; + let w = frame.to_bezpath().bounding_box().width(); + assert!(w <= 120.5 && w > 100.0, "{w}"); + let origin = t[0].xf * Point::ZERO; + assert!((origin.x - 20.0).abs() < 0.05, "{origin:?}"); + } +} + +#[test] +fn lines_that_were_not_wrapped_stay_point_type() { + // A list: each line its own, none ending in a space. + let bytes = source_sans(&[(20.0, 50.0, 10.0, "Hooks"), (20.0, 62.0, 10.0, "Swivels"), (20.0, 74.0, 10.0, "Leads")]); + assert_eq!(texts(&import(&bytes).unwrap()).len(), 3); + // Wrapped lines whose breaks a frame doesn't give again (a line far short of the others). + let bytes = source_sans(&[(20.0, 50.0, 10.0, "One two three four five six "), (20.0, 62.0, 10.0, "a "), (20.0, 74.0, 10.0, "seven")]); + assert_eq!(texts(&import(&bytes).unwrap()).len(), 3); +} diff --git a/crates/pdf/src/tests_live_text.rs b/crates/pdf/src/tests_live_text.rs index 32ebc975..cdbe985c 100644 --- a/crates/pdf/src/tests_live_text.rs +++ b/crates/pdf/src/tests_live_text.rs @@ -13,7 +13,7 @@ const SOURCE_SERIF: &[u8] = include_bytes!("../../../assets/fonts/SourceSerif4-R /// A 300 × 200 pt page with `lines` of (x, y from the top, size, text) in Source Sans 3, and the /// same rotated 90° when `rotated`. -fn text_pdf(lines: &[(f32, f32, f32, &str)], rotated: bool) -> Vec { +pub(crate) fn text_pdf(lines: &[(f32, f32, f32, &str)], rotated: bool) -> Vec { let mut pdf = krilla::Document::new(); let mut page = pdf.start_page_with(PageSettings::from_wh(300.0, 200.0).unwrap()); let mut s = page.surface(); @@ -269,7 +269,7 @@ fn a_single_upright_glyph_comes_in_as_vertical_type_and_takes_no_horizontal_glyp let mut line = TextLine::new(at(100.0, 100.0), 1.0); assert!(line.push_upright(&look, at(100.0, 100.0), 1.0, Upright { top: Point::new(110.0, 82.0) }, "§")); assert!(!line.push(&look, at(130.0, 100.0), 1.0, 10.0, "a"), "a horizontal glyph starts another line"); - let (t, _) = line.finish().unwrap(); + let (t, ..) = line.finish().unwrap(); assert!(t.vertical, "one upright glyph is vertical type"); assert_eq!(t.plain_text(), "§"); } @@ -294,7 +294,7 @@ fn letter_spaced_vertical_type_keeps_its_characters_together() { let y = 100.0 + 30.0 * i as f64; assert!(line.push_upright(&look, at(y), 1.0, Upright { top: Point::new(110.0, y - 18.0) }, c)); } - let (t, _) = line.finish().unwrap(); + let (t, ..) = line.finish().unwrap(); assert!(t.vertical); assert_eq!(t.plain_text(), "§§§", "letter spacing isn't a space"); } diff --git a/crates/tools/src/catalog.rs b/crates/tools/src/catalog.rs index 400a07af..df8699bf 100644 --- a/crates/tools/src/catalog.rs +++ b/crates/tools/src/catalog.rs @@ -154,6 +154,17 @@ pub fn group_of(id: &str) -> Option { TOOL_GROUPS.iter().position(|g| g.iter().any(|t| t.id == id)) } +/// Selection, Direct Selection and Group Selection: the tools Cmd held lends the others for a drag. +pub fn is_selection_tool(id: &str) -> bool { + matches!(id, "selection" | "directSelection" | "groupSelection") +} + +/// The tools that show a selected path's anchors and handles as Direct Selection does, and drag +/// them: a Cmd drag with one of them is a Direct Selection drag until a selection tool is chosen. +pub fn edits_anchors(id: &str) -> bool { + matches!(id, "directSelection" | "pen" | "addAnchor" | "deleteAnchor" | "anchorPoint" | "curvature") +} + #[cfg(test)] mod tests { use super::*; @@ -178,5 +189,7 @@ mod tests { assert_eq!(tool_for_shortcut("V").unwrap().id, "selection"); assert_eq!(tool_for_shortcut("Shift+M").unwrap().id, "shapeBuilder"); assert_eq!(group_of("star"), group_of("rectangle")); + assert!(is_selection_tool("groupSelection") && !is_selection_tool("pen")); + assert!(edits_anchors("pen") && !edits_anchors("rectangle")); } } diff --git a/crates/tools/src/direct.rs b/crates/tools/src/direct.rs index 0f2f5055..f7dfc6e0 100644 --- a/crates/tools/src/direct.rs +++ b/crates/tools/src/direct.rs @@ -28,11 +28,11 @@ use std::borrow::Cow; use serde_json::{Value, json}; use vectorcraft_doc::hit::{HitKind, hit_test}; use vectorcraft_doc::{AnchorRef, Node, NodeId, NodeKind}; -use vectorcraft_geom::{PathData, Point, Rect}; +use vectorcraft_geom::{Anchor, PathData, Point, Rect}; use crate::bbox::move_delta; use crate::corners::{self, CornerDrag, over_widget}; -use crate::guides::{PointSnap, Targets}; +use crate::guides::{HandleSnap, PointSnap, Targets}; use crate::meshedit::MeshEdit; use crate::pathtype::{self, BracketDrag, over_bracket}; use crate::rulerguide::GuideEdit; @@ -112,6 +112,8 @@ pub struct DirectSelectionTool { guides: Vec, /// What the dragged anchors snap to, gathered when the drag begins. anchor_snap: Option, + /// What the dragged handle snaps to. + handle_snap: HandleSnap, /// What the objects being moved snap to, gathered when the move begins. move_snap: Option, /// The anchor under the pointer (Highlight anchors on mouse over): its path, where it is. @@ -128,6 +130,7 @@ impl DirectSelectionTool { mesh: MeshEdit::default(), guides: vec![], anchor_snap: None, + handle_snap: HandleSnap::default(), move_snap: None, hover: None, guide: GuideEdit::default(), @@ -217,30 +220,37 @@ fn hit_frame_edge(cx: &ToolContext, p: Point, tol: f64) -> Option<(NodeId, Vec bool { - multiple || selection.anchors.values().map(|set| set.len()).sum::() <= 1 +/// The anchors whose direction handles show, and drag, with the tools that edit anchors +/// ([`crate::catalog::edits_anchors`]): the direct-selected anchors of a path, every anchor of a +/// path selected as a whole. Selection & Anchor Display → Show handles when multiple anchors are +/// selected off, none while more than one anchor is selected. +fn handle_anchors(cx: &ToolContext) -> Vec<(NodeId, usize, usize, Anchor)> { + let mut v = vec![]; + for &id in &cx.selection.objects { + let Some(pd) = cx.doc.node(id).and_then(|n| n.path_data()) else { continue }; + let shown = cx.selection.partial(id); + v.extend(pd.anchors().filter(|(si, ai, _)| shown.is_none_or(|set| set.contains(&(*si, *ai)))).map(|(si, ai, a)| (id, si, ai, *a))); + } + if !cx.handles_multiple && v.len() > 1 { + v.clear(); + } + v } -/// Direction handle of a partially selected anchor under `p`: (id, si, ai, is_out). -fn hit_handle(cx: &ToolContext, p: Point, tol: f64) -> Option<(NodeId, usize, usize, bool)> { - if !handles_shown(cx.selection, cx.handles_multiple) { - return None; - } - for (id, set) in &cx.selection.anchors { - let Some(pd) = cx.doc.node(*id).and_then(|n| n.path_data()) else { continue }; - for &(si, ai) in set { - let Some(a) = pd.subpaths.get(si).and_then(|s| s.anchors.get(ai)) else { continue }; - if a.has_out() && a.h_out.distance(p) <= tol { - return Some((*id, si, ai, true)); - } - if a.has_in() && a.h_in.distance(p) <= tol { - return Some((*id, si, ai, false)); +/// The end of a shown direction handle ([`handle_anchors`]) nearest to `p` within `tol`, and +/// nearer to it than the handle's anchor (a short handle leaves its anchor to be picked): (path, +/// subpath, anchor, is_out). +pub(crate) fn hit_handle(cx: &ToolContext, p: Point, tol: f64) -> Option<(NodeId, usize, usize, bool)> { + let mut best: Option<((NodeId, usize, usize, bool), f64)> = None; + for (id, si, ai, a) in handle_anchors(cx) { + for (out, has, h) in [(true, a.has_out(), a.h_out), (false, a.has_in(), a.h_in)] { + let d = h.distance(p); + if has && d <= tol && d < a.p.distance(p) && best.is_none_or(|b| d < b.1) { + best = Some(((id, si, ai, out), d)); } } } - None + best.map(|b| b.0) } fn anchors_json(v: &[AnchorRef]) -> Value { @@ -335,6 +345,7 @@ impl Tool for DirectSelectionTool { self.mesh.unfocus(); if let Some((id, si, ai, out)) = hit_handle(cx, p, tol) { self.state = State::Handle { id, si, ai, out }; + self.handle_snap = HandleSnap::default(); return vec![Action::Begin("Reshape".into())]; } if let Some((id, anchor, from)) = hit_spine_point(cx, p, tol) { @@ -471,7 +482,7 @@ impl Tool for DirectSelectionTool { out } (PointerKind::Drag, State::Handle { id, si, ai, out }) => { - let (q, guides) = crate::guides::snap_handle(cx, (id, si, ai), p, ev.mods.shift); + let (q, guides) = self.handle_snap.snap(cx, (id, si, ai), p, ev.mods.shift); self.guides = guides; vec![Action::Preview( "path.setHandle".into(), @@ -871,6 +882,61 @@ mod tests { assert!(matches!(&a[..], [Action::Begin(_), Action::Preview(c, _)] if c == "object.transform"), "{a:?}"); } + /// #494: the handles shown are the handles dragged. A path selected as a whole (the one the + /// Pen just drew) shows all its handles, and they drag; the direct-selected anchors' handles + /// only otherwise; none with Show handles when multiple anchors are selected off and several + /// anchors selected. A handle shorter than the tolerance leaves its anchor to be picked, and + /// the tolerance is the preference's, in screen pixels at any zoom. + #[test] + fn the_handles_shown_are_the_handles_dragged() { + let (d, arch) = arch_doc(); + let p = paint(); + // Does a press at (x, y) take a handle? + let handle = |c: &ToolContext, x: f64, y: f64| { + DirectSelectionTool::new(false).pointer(c, &PointerEvent::new(PointerKind::Down, x, y)) == vec![Action::Begin("Reshape".into())] + }; + let mut whole = Selection::default(); + whole.set([arch]); + let c = cx(&d, &whole, &p); + assert!(handle(&c, 101.0, 251.0), "the first anchor's handle, the path selected whole"); + let mut t = DirectSelectionTool::new(false); + t.pointer(&c, &PointerEvent::new(PointerKind::Down, 101.0, 251.0)); + let a = t.pointer(&c, &PointerEvent::new(PointerKind::Drag, 120.0, 240.0)); + assert!(matches!(&a[..], [Action::Preview(c, v)] if c == "path.setHandle" && v["anchor"] == 0 && v["which"] == "out"), "{a:?}"); + // Only the second anchor direct-selected: the first one's handle is hidden. + let second = anchors_of(arch, &[(0, 1)]); + assert!(!handle(&cx(&d, &second, &p), 101.0, 251.0)); + assert!(handle(&cx(&d, &second, &p), 201.0, 251.0)); + // Show handles when multiple anchors are selected off: the whole path's are hidden. + assert!(!handle(&ToolContext { handles_multiple: false, ..cx(&d, &whole, &p) }, 101.0, 251.0)); + assert!(handle(&ToolContext { handles_multiple: false, ..cx(&d, &second, &p) }, 201.0, 251.0)); + // The tolerance is the preference's, in screen pixels: 3 px is 0.75 pt at 400%. + let zoomed = ToolContext { zoom: 4.0, ..cx(&d, &whole, &p) }; + assert!(!handle(&zoomed, 101.0, 251.0)); + assert!(handle(&zoomed, 100.5, 250.5)); + assert!(handle(&ToolContext { selection_tolerance: 8.0, ..cx(&d, &whole, &p) }, 106.0, 254.0)); + } + + /// #494: a handle 2 pt long, inside the tolerance round its anchor, doesn't hide the anchor. + #[test] + fn a_short_handle_leaves_its_anchor_to_be_picked() { + let (mut d, _) = doc_with_rect(); + let l = d.layers[0].id; + let id = d.alloc_id(); + let mut sp = vectorcraft_geom::SubPath::polyline(&[Point::new(100.0, 300.0), Point::new(200.0, 300.0)], false); + sp.anchors[0].h_out = Point::new(102.0, 300.0); + d.insert(Some(l), 1, vectorcraft_doc::Node::path(id, PathData::single(sp), vectorcraft_doc::Appearance::default_art())).unwrap(); + let s = anchors_of(id, &[(0, 0)]); + let p = paint(); + let c = cx(&d, &s, &p); + let mut t = DirectSelectionTool::new(false); + assert_eq!(t.pointer(&c, &PointerEvent::new(PointerKind::Down, 100.0, 300.0)), vec![], "the anchor, already selected"); + let a = t.pointer(&c, &PointerEvent::new(PointerKind::Drag, 90.0, 290.0)); + assert_eq!(a[0], Action::Begin("Move".into())); + t.pointer(&c, &PointerEvent::new(PointerKind::Up, 90.0, 290.0)); + assert_eq!(t.pointer(&c, &PointerEvent::new(PointerKind::Down, 102.5, 300.0)), vec![Action::Begin("Reshape".into())], "the handle"); + } + /// [`doc_with_rect`] (A, 100..200) and a second square B, 300..400: (A, B). fn two_squares() -> (vectorcraft_doc::Document, NodeId, NodeId) { let (mut d, a) = doc_with_rect(); diff --git a/crates/tools/src/draw2.rs b/crates/tools/src/draw2.rs index 3efacfa1..152ca38a 100644 --- a/crates/tools/src/draw2.rs +++ b/crates/tools/src/draw2.rs @@ -15,7 +15,6 @@ use vectorcraft_geom::{Anchor, AnchorKind, BezPath, Point, SubPath}; use crate::{Action, Tool, ToolContext}; pub use anchor::AnchorTool; -pub(crate) use anchor::hit_handle; pub use curvature::CurvatureTool; pub use family::FamilyTool; pub use gesture::GestureTool; diff --git a/crates/tools/src/draw2/anchor.rs b/crates/tools/src/draw2/anchor.rs index 135ddc5c..c2c2d5ba 100644 --- a/crates/tools/src/draw2/anchor.rs +++ b/crates/tools/src/draw2/anchor.rs @@ -12,6 +12,8 @@ use vectorcraft_doc::NodeId; use vectorcraft_geom::Point; use super::{hit_anchor, hit_segment, insert_anchor, remove_anchor}; +use crate::direct::hit_handle; +use crate::guides::HandleSnap; use crate::{Action, Cursor, Mods, Overlay, PointerEvent, PointerKind, Tool, ToolContext}; #[derive(Clone, Copy, Debug)] @@ -25,8 +27,9 @@ enum State { pub struct AnchorTool { id: &'static str, state: State, - /// Smart guides of the handle being dragged. + /// Smart guides of the handle being dragged, and what it snaps to. guides: Vec, + snap: HandleSnap, } impl AnchorTool { @@ -37,36 +40,18 @@ impl AnchorTool { "scissors" => "scissors", _ => "addAnchor", }; - Self { id, state: State::Idle, guides: vec![] } + Self { id, state: State::Idle, guides: vec![], snap: HandleSnap::default() } } fn add(cx: &ToolContext, p: Point) -> Vec { - hit_segment(cx, p, cx.tol(4.0)).map(insert_anchor).into_iter().collect() + hit_segment(cx, p, cx.pick_tol()).map(insert_anchor).into_iter().collect() } fn delete(cx: &ToolContext, p: Point) -> Vec { - hit_anchor(cx, p, cx.tol(4.0)).map(remove_anchor).into_iter().collect() + hit_anchor(cx, p, cx.pick_tol()).map(remove_anchor).into_iter().collect() } } -/// A direction handle of a selected path under `p`, among those shown (a path with anchors -/// direct-selected shows theirs only): (id, subpath, anchor, is_out). -pub(crate) fn hit_handle(cx: &ToolContext, p: Point, tol: f64) -> Option<(NodeId, usize, usize, bool)> { - for id in &cx.selection.objects { - let Some(pd) = cx.doc.node(*id).and_then(|n| n.path_data()) else { continue }; - let shown = cx.selection.partial(*id); - for (si, ai, a) in pd.anchors().filter(|(si, ai, _)| shown.is_none_or(|set| set.contains(&(*si, *ai)))) { - if a.has_out() && a.h_out.distance(p) <= tol { - return Some((*id, si, ai, true)); - } - if a.has_in() && a.h_in.distance(p) <= tol { - return Some((*id, si, ai, false)); - } - } - } - None -} - impl Tool for AnchorTool { fn id(&self) -> &'static str { self.id @@ -76,7 +61,7 @@ impl Tool for AnchorTool { } fn pointer(&mut self, cx: &ToolContext, ev: &PointerEvent) -> Vec { let p = ev.pos; - let tol = cx.tol(4.0); + let tol = cx.pick_tol(); match (self.id, ev.kind) { ("addAnchor", PointerKind::Down) => { if ev.mods.alt { @@ -104,6 +89,7 @@ impl Tool for AnchorTool { ("anchorPoint", PointerKind::Down) => { if let Some((id, si, ai, out)) = hit_handle(cx, p, tol) { self.state = State::Handle { id, si, ai, out, began: false }; + self.snap = HandleSnap::default(); } else if let Some((id, si, ai)) = hit_anchor(cx, p, tol) { self.state = State::Convert { id, si, ai, start: p, began: false }; } else if let Some((id, si, seg, t)) = hit_segment(cx, p, tol) { @@ -134,7 +120,7 @@ impl Tool for AnchorTool { json!({"id": id.0, "subpath": si, "anchor": ai, "to": "smooth", "x": p.x, "y": p.y}), ), State::Handle { id, si, ai, out, .. } => { - let (q, guides) = crate::guides::snap_handle(cx, (id, si, ai), p, ev.mods.shift); + let (q, guides) = self.snap.snap(cx, (id, si, ai), p, ev.mods.shift); self.guides = guides; Action::Preview( "path.setHandle".into(), @@ -192,7 +178,7 @@ impl Tool for AnchorTool { "deleteAnchor" if !m.alt => Cursor::PenDelete, "deleteAnchor" => Cursor::PenAdd, "scissors" => { - if hit_segment(cx, p, cx.tol(4.0)).is_some() { + if hit_segment(cx, p, cx.pick_tol()).is_some() { Cursor::Crosshair } else { Cursor::NotAllowed @@ -257,4 +243,38 @@ mod tests { let a = t.pointer(&cx, &PointerEvent::new(PointerKind::Drag, 150.0, 230.0)); assert!(matches!(&a[1], Action::Preview(c, v) if c == "path.reshapeSegment" && v["dy"] == 30.0)); } + + /// #494: the Anchor Point tool picks within Selection & Anchor Display → Tolerance, and drags + /// only the handles shown. + #[test] + fn anchor_point_picks_within_the_tolerance_and_drags_shown_handles() { + let (mut d, _) = doc_with_rect(); + let l = d.layers[0].id; + let id = d.alloc_id(); + let mut sp = vectorcraft_geom::SubPath::polyline(&[Point::new(100.0, 300.0), Point::new(200.0, 300.0), Point::new(300.0, 300.0)], false); + sp.anchors[1] = vectorcraft_geom::Anchor::smooth(Point::new(200.0, 300.0), Point::new(240.0, 300.0)); + let path = vectorcraft_geom::PathData::single(sp); + d.insert(Some(l), 1, vectorcraft_doc::Node::path(id, path, vectorcraft_doc::Appearance::default_art())).unwrap(); + let mut s = Selection::default(); + s.set([id]); + let p = paint(); + let press = |c: &ToolContext, x: f64, y: f64| { + let mut t = AnchorTool::new("anchorPoint"); + t.pointer(c, &PointerEvent::new(PointerKind::Down, x, y)); + t.pointer(c, &PointerEvent::new(PointerKind::Drag, x + 10.0, y + 30.0)) + }; + let dragged = |a: Vec| match a.as_slice() { + [Action::Begin(_), Action::Preview(c, _)] => c.clone(), + _ => String::new(), + }; + // The segment 6 px off: picked with an 8 px tolerance, not with the default 3 px. + assert_eq!(dragged(press(&cx(&d, &s, &p), 150.0, 306.0)), ""); + let wide = ToolContext { selection_tolerance: 8.0, ..cx(&d, &s, &p) }; + assert_eq!(dragged(press(&wide, 150.0, 306.0)), "path.reshapeSegment"); + // The middle anchor's handle drags; with Show handles when multiple anchors are selected + // off it's hidden (three anchors selected) and the press finds the segment under it. + assert_eq!(dragged(press(&cx(&d, &s, &p), 240.0, 301.0)), "path.setHandle"); + let single = ToolContext { handles_multiple: false, ..cx(&d, &s, &p) }; + assert_eq!(dragged(press(&single, 240.0, 301.0)), "path.reshapeSegment"); + } } diff --git a/crates/tools/src/guides.rs b/crates/tools/src/guides.rs index 89d914b3..778eccb7 100644 --- a/crates/tools/src/guides.rs +++ b/crates/tools/src/guides.rs @@ -553,25 +553,35 @@ impl PointSnap { } } -/// Where a dragged direction handle of anchor `ai` of subpath `si` of path `id` goes for the -/// pointer at `p`: with Shift at a multiple of 45° (from the Constrain Angle) round its anchor, -/// else snapped as a drawn point is (smart guides, the grid, pixels). -pub fn snap_handle(cx: &ToolContext, (id, si, ai): (NodeId, usize, usize), p: Point, shift: bool) -> (Point, Vec) { - let path = cx.doc.node(id).and_then(|n| n.path_data()); - if shift && let Some(a) = path.and_then(|pd| pd.subpaths.get(si)?.anchors.get(ai)) { - return (a.p + vectorcraft_geom::constrain_angle_from(p - a.p, 45.0, cx.constrain_angle), vec![]); - } - snap_with(cx, p, || { - // The path's bounds move with the handle, so they would chase it: its anchors (which stay - // put) are the targets instead, the handle lining up with them too. - let mut t = Targets::collect(cx.doc, &[id], None); - for (_, _, a) in path.into_iter().flat_map(|pd| pd.anchors()).take(20_000) { - t.points.push((a.p, Kind::Anchor)); - t.xs.push((a.p.x, a.p, Kind::Anchor)); - t.ys.push((a.p.y, a.p, Kind::Anchor)); +/// Snapping for a dragged direction handle: Shift keeps it at 45° steps round its anchor, else it +/// snaps as a drawn point does. The targets are gathered on the first move that needs them and +/// kept for the rest of the drag (gathering them takes as long as the document is big). +#[derive(Default)] +pub struct HandleSnap(Option); + +impl HandleSnap { + /// Where the handle of anchor `ai` of subpath `si` of path `id` goes with the pointer at `p`, + /// and the guides showing why. + pub fn snap(&mut self, cx: &ToolContext, (id, si, ai): (NodeId, usize, usize), p: Point, shift: bool) -> (Point, Vec) { + let path = cx.doc.node(id).and_then(|n| n.path_data()); + if shift && let Some(a) = path.and_then(|pd| pd.subpaths.get(si)?.anchors.get(ai)) { + return (a.p + vectorcraft_geom::constrain_angle_from(p - a.p, 45.0, cx.constrain_angle), vec![]); } - t - }) + let snap = self.0.get_or_insert_with(|| { + PointSnap::new(cx, || { + // The path's bounds move with the handle, so they would chase it: its anchors + // (which stay put) are the targets instead, the handle lining up with them too. + let mut t = Targets::collect(cx.doc, &[id], None); + for (_, _, a) in path.into_iter().flat_map(|pd| pd.anchors()).take(20_000) { + t.points.push((a.p, Kind::Anchor)); + t.xs.push((a.p.x, a.p, Kind::Anchor)); + t.ys.push((a.p.y, a.p, Kind::Anchor)); + } + t + }) + }); + snap.snap(cx, p) + } } /// Snap a picked point (a transform tool's reference point) to the nearest anchor or centre of the diff --git a/crates/tools/src/pen.rs b/crates/tools/src/pen.rs index 1b2b3fef..1a6327a4 100644 --- a/crates/tools/src/pen.rs +++ b/crates/tools/src/pen.rs @@ -3,11 +3,14 @@ //! Click adds a corner anchor; click-drag adds a smooth anchor with symmetric handles (Alt breaks //! them: the incoming handle stays where it was when Alt went down and only the outgoing one //! follows the pointer; Space held moves the anchor, handles and all); Shift constrains to 45°. -//! Clicking the first anchor closes the path. Clicking the last one retracts its outgoing handle, so -//! the next segment leaves it as a corner; dragging from it pulls a new one out on its own. -//! Alt held over a handle end or an anchor of a selected path (the one being drawn too) works as -//! the Anchor Point tool: dragging a handle moves it alone, clicking a smooth anchor makes it a -//! corner and dragging an anchor pulls out new symmetric handles. +//! A press on the first anchor closes the path, the drag shaping the closing curve. Clicking the +//! last one retracts its outgoing handle, so the next segment leaves it as a corner; dragging from +//! it pulls a new one out on its own. +//! Alt held over a handle end, an anchor or a segment of a selected path (the one being drawn too) +//! works as the Anchor Point tool: dragging a handle moves it alone, clicking a smooth anchor makes +//! it a corner, dragging an anchor pulls out new symmetric handles and dragging a segment reshapes +//! it. Cmd held lends the selection tool used last for a drag (the engine's +//! `Session::pointer`); the path being drawn goes on afterwards while it stays selected. //! Enter/Esc (or switching tools) ends the path. Clicking the end of a selected open path continues //! it. The rubber-band preview shows the next segment (Enable Rubber Band for Pen Tool). Auto Add/Delete: between paths, a click on a //! segment of a selected path adds an anchor there and a click on one of its anchors deletes it @@ -18,14 +21,18 @@ use serde_json::json; use vectorcraft_doc::{NodeId, NodeKind}; use vectorcraft_geom::{BezPath, Point}; -use crate::draw2::{AnchorTool, hit_handle}; +use crate::direct::hit_handle; +use crate::draw2::AnchorTool; use crate::{Action, Cursor, Mods, Overlay, PointerEvent, PointerKind, Tool, ToolContext, ToolKey}; #[derive(Default)] pub struct PenTool { - /// The path being drawn (set once the first anchor exists and the engine selected it). + /// A path is being drawn... drawing: bool, - drag: Option<(Point, bool)>, + /// ...this one, once the engine made it: another path selected meanwhile isn't drawn on. + path: Option, + /// The anchor a press placed, while the drag shapes its handles. + drag: Option, hover: Option, /// The incoming handle of the anchor being dragged out, as last previewed. in_h: Point, @@ -38,6 +45,17 @@ pub struct PenTool { convert: Option, } +/// An anchor being placed, as the press decided: where it is, the path it goes on (none: the +/// first anchor of a new path) and whether it closes that path (the press was on its first +/// anchor). The drag only shapes its handles, whatever the path looks like meanwhile: a closing +/// preview leaves the path closed, so no longer one the pen draws on. +#[derive(Clone, Copy)] +struct Place { + at: Point, + path: Option, + closing: bool, +} + /// The open path the pen is extending: the single selected open path. fn active_path(cx: &ToolContext) -> Option<(NodeId, Point, Point, Point)> { if cx.selection.objects.len() != 1 { @@ -63,10 +81,14 @@ fn last_anchor(cx: &ToolContext, id: NodeId) -> Option<(usize, usize)> { Some((si, ai)) } -/// Alt held over a handle end or an anchor of a selected path: the Anchor Point tool's gesture. +/// Alt held over a handle end, an anchor or a segment of a selected path: the Anchor Point tool's +/// gesture, within its tolerance. fn alt_converts(cx: &ToolContext, p: Point, m: Mods) -> bool { - let tol = cx.tol(4.0); - m.alt && (hit_handle(cx, p, tol).is_some() || crate::draw2::anchor_in(cx, editable_paths(cx), p, tol).is_some()) + let tol = cx.pick_tol(); + m.alt + && (hit_handle(cx, p, tol).is_some() + || crate::draw2::anchor_in(cx, editable_paths(cx), p, tol).is_some() + || crate::draw2::segment_in(cx, editable_paths(cx), p, tol).is_some()) } /// The selected paths the pen edits (not guides, nor locked or hidden ones). @@ -97,9 +119,13 @@ impl Tool for PenTool { let exclude: Vec = if self.drawing { cx.selection.objects.clone() } else { vec![] }; let (mut p, _) = if matches!(ev.kind, PointerKind::Down) { crate::guides::snap_draw(cx, ev.pos, &exclude) } else { (ev.pos, vec![]) }; let tol = cx.tol(5.0); - let active = if self.drawing { active_path(cx) } else { None }; + // The path a press began is the selected one by the next event. + if self.drawing && self.path.is_none() { + self.path = active_path(cx).map(|a| a.0); + } + let active = self.active(cx); if self.drawing && active.is_none() && ev.kind == PointerKind::Down { - self.drawing = false; + self.stop(); } match ev.kind { PointerKind::Move => { @@ -115,7 +141,7 @@ impl Tool for PenTool { let end = last_anchor(cx, id); // A one-anchor path doesn't close on itself: its anchor is the last one too. if p.distance(first) <= tol && end.is_some_and(|(_, ai)| ai > 0) { - self.drag = Some((first, true)); + self.drag = Some(Place { at: first, path: Some(id), closing: true }); return vec![Action::Begin("Close Path".into()), Action::Preview("path.close".into(), json!({"id": id.0}))]; } if p.distance(last) <= tol @@ -127,7 +153,7 @@ impl Tool for PenTool { if let Some(acts) = self.alt_convert(cx, ev) { return acts; } - self.drag = Some((p, false)); + self.drag = Some(Place { at: p, path: Some(id), closing: false }); self.in_h = p; return vec![Action::Begin("Pen".into()), Action::Preview("path.appendAnchor".into(), json!({"id": id.0, "x": p.x, "y": p.y}))]; } @@ -142,6 +168,7 @@ impl Tool for PenTool { && (p.distance(last) <= tol || p.distance(first) <= tol) { self.drawing = true; + self.path = active_path(cx).map(|a| a.0); if p.distance(first) <= tol && p.distance(last) > tol { return vec![Action::Exec("path.reverse".into(), json!({}))]; } @@ -150,8 +177,8 @@ impl Tool for PenTool { if let Some(act) = auto_add_delete(cx, ev.pos, ev.mods, tol) { return vec![act]; } - self.drawing = true; - self.drag = Some((p, false)); + (self.drawing, self.path) = (true, None); + self.drag = Some(Place { at: p, path: None, closing: false }); vec![Action::Begin("Pen".into()), Action::Preview("path.create".into(), json!({"anchors": [{"x": p.x, "y": p.y}]}))] } PointerKind::Drag => { @@ -165,13 +192,13 @@ impl Tool for PenTool { } return vec![set_out_handle(id, si, ai, h)]; } - let Some((mut a, closing)) = self.drag else { return vec![] }; + let Some(Place { at: mut a, path, closing }) = self.drag else { return vec![] }; // Space held moves the anchor being placed, handles and all. if ev.mods.space && !closing { let d = ev.pos - self.last; a += d; self.in_h += d; - self.drag = Some((a, closing)); + self.drag = Some(Place { at: a, path, closing }); } self.last = ev.pos; let mut out_h = ev.pos; @@ -179,7 +206,7 @@ impl Tool for PenTool { out_h = a + vectorcraft_geom::constrain_angle(ev.pos - a, 45.0); } let alt = ev.mods.alt; - let Some((id, ..)) = active_path(cx).or(active) else { + let Some(id) = path else { // First anchor of a new path: re-issue create with handles. let in_h = a - (out_h - a); return vec![Action::Preview( @@ -209,9 +236,9 @@ impl Tool for PenTool { if self.handle.take().is_some() { return vec![Action::Commit]; } - let Some((_, closing)) = self.drag.take() else { return vec![] }; - if closing { - self.drawing = false; + let Some(place) = self.drag.take() else { return vec![] }; + if place.closing { + self.stop(); } vec![Action::Commit] } @@ -221,7 +248,7 @@ impl Tool for PenTool { fn key(&mut self, cx: &ToolContext, key: ToolKey, _m: Mods) -> Vec { match key { ToolKey::Enter | ToolKey::Escape => { - self.drawing = false; + self.stop(); self.drag = None; self.handle = None; // An Alt gesture under way ends as it stands. @@ -231,17 +258,17 @@ impl Tool for PenTool { } } fn deactivate(&mut self, cx: &ToolContext) -> Vec { - self.drawing = false; + self.stop(); self.convert.take().map(|mut t| t.deactivate(cx)).unwrap_or_default() } fn overlays(&self, cx: &ToolContext) -> Vec { if let Some(t) = &self.convert { return t.overlays(cx); } - if !cx.pen_rubber_band || !self.drawing || self.drag.is_some() || self.handle.is_some() { + if !cx.pen_rubber_band || self.drag.is_some() || self.handle.is_some() { return vec![]; } - let (Some((id, _, last, out)), Some(h)) = (active_path(cx), self.hover) else { return vec![] }; + let (Some((id, _, last, out)), Some(h)) = (self.active(cx), self.hover) else { return vec![] }; let mut bp = BezPath::new(); bp.move_to(last); if out.distance(last) > 1e-9 { @@ -254,10 +281,7 @@ impl Tool for PenTool { } fn cursor(&self, cx: &ToolContext, p: Point, m: Mods) -> Cursor { let tol = cx.tol(5.0); - let active = active_path(cx); - if self.drawing - && let Some((id, first, last, _)) = active - { + if let Some((id, first, last, _)) = self.active(cx) { let one = last_anchor(cx, id).is_some_and(|(_, ai)| ai == 0); if p.distance(first) <= tol && !one { return Cursor::PenClose; @@ -275,7 +299,7 @@ impl Tool for PenTool { Some([_]) => return Cursor::PenAdd, _ => {} } - if active.is_some_and(|(_, first, last, _)| p.distance(last) <= tol || p.distance(first) <= tol) { + if active_path(cx).is_some_and(|(_, first, last, _)| p.distance(last) <= tol || p.distance(first) <= tol) { return Cursor::PenContinue; } match auto_add_delete(cx, p, m, tol) { @@ -289,13 +313,27 @@ impl Tool for PenTool { } impl PenTool { - /// Hand an Alt press on a selected path's handle or anchor to the Anchor Point tool. + /// The open path being drawn: the one the pen made or went on with, while it is the single + /// selected open path. + fn active(&self, cx: &ToolContext) -> Option<(NodeId, Point, Point, Point)> { + active_path(cx).filter(|(id, ..)| self.drawing && self.path.is_none_or(|p| p == *id)) + } + + /// The path is finished. + fn stop(&mut self) { + (self.drawing, self.path) = (false, None); + } + + /// Hand an Alt press on a selected path's handle, anchor or segment to the Anchor Point tool. fn alt_convert(&mut self, cx: &ToolContext, ev: &PointerEvent) -> Option> { if !alt_converts(cx, ev.pos, ev.mods) { return None; } let mut t = AnchorTool::new("anchorPoint"); let acts = t.pointer(cx, ev); + if !t.busy() { + return None; + } self.convert = Some(t); Some(acts) } @@ -467,6 +505,32 @@ mod tests { assert_eq!(t.cursor(&cx, Point::new(10.0, 300.0), Mods::default()), Cursor::PenClose); } + /// #501: a press on the first anchor closes the path, however far the drag then goes: the + /// closing preview leaves the path closed (so not one the pen extends), and each move still + /// previews the close with symmetric handles (Alt breaks them), released as a close. + #[test] + fn a_drag_from_the_first_anchor_always_closes() { + let pts = [Point::new(100.0, 300.0), Point::new(200.0, 300.0), Point::new(200.0, 400.0)]; + let (mut d, id, s) = drawing(vectorcraft_geom::SubPath::polyline(&pts, false)); + let p = paint(); + let mut t = PenTool { drawing: true, ..PenTool::default() }; + let a = t.pointer(&cx(&d, &s, &p), &PointerEvent::new(PointerKind::Down, 101.0, 301.0)); + assert_eq!(a, vec![Action::Begin("Close Path".into()), Action::Preview("path.close".into(), json!({"id": id.0}))]); + // What the tool sees once the preview applied: the path closed. + d.node_mut(id).unwrap().path_data_mut().unwrap().subpaths[0].closed = true; + let c = cx(&d, &s, &p); + let close = |x: f64, y: f64, alt: bool| { + vec![Action::Preview("path.close".into(), json!({"id": id.0, "in": [200.0 - x, 600.0 - y], "independent": alt}))] + }; + for (x, y) in [(105.0, 290.0), (130.0, 260.0), (160.0, 240.0)] { + assert_eq!(t.pointer(&c, &PointerEvent::new(PointerKind::Drag, x, y)), close(x, y, false), "at ({x}, {y})"); + } + let alt = Mods { alt: true, ..Mods::default() }; + assert_eq!(t.pointer(&c, &PointerEvent::new(PointerKind::Drag, 170.0, 250.0).with_mods(alt)), close(170.0, 250.0, true)); + assert_eq!(t.pointer(&c, &PointerEvent::new(PointerKind::Up, 170.0, 250.0)), vec![Action::Commit]); + assert!(!t.busy() && t.active(&c).is_none(), "the path is done"); + } + #[test] fn a_one_anchor_path_does_not_close_on_itself() { let (d, id, s) = drawing(vectorcraft_geom::SubPath::polyline(&[Point::new(10.0, 300.0)], false)); @@ -587,4 +651,53 @@ mod tests { let cx1 = cx(&d, &s, &p); assert_eq!(t.cursor(&cx1, Point::new(250.0, 101.0), alt), Cursor::Pen); } + + /// #494: Alt held over a segment of a selected path reshapes it as the Anchor Point tool does, + /// while drawing too; Alt away from paths still places an anchor. + #[test] + fn alt_over_a_segment_reshapes_it() { + let (d, id, s) = drawing(vectorcraft_geom::SubPath::polyline(&[Point::new(100.0, 300.0), Point::new(200.0, 300.0)], false)); + let p = paint(); + let cx = cx(&d, &s, &p); + let alt = Mods { alt: true, ..Mods::default() }; + let mut t = PenTool { drawing: true, ..PenTool::default() }; + assert_eq!(t.cursor(&cx, Point::new(150.0, 302.0), alt), Cursor::PenConvert); + assert_eq!(t.cursor(&cx, Point::new(150.0, 302.0), Mods::default()), Cursor::Pen); + assert_eq!(t.pointer(&cx, &PointerEvent::new(PointerKind::Down, 150.0, 302.0).with_mods(alt)), vec![]); + let a = t.pointer(&cx, &PointerEvent::new(PointerKind::Drag, 150.0, 262.0).with_mods(alt)); + assert_eq!(a[0], Action::Begin("Reshape".into())); + assert!( + matches!(&a[1], Action::Preview(c, v) if c == "path.reshapeSegment" && v["id"] == id.0 && v["segment"] == 0 && v["dy"] == -40.0), + "{a:?}" + ); + assert_eq!(t.pointer(&cx, &PointerEvent::new(PointerKind::Up, 150.0, 262.0)), vec![Action::Commit]); + let a = t.pointer(&cx, &PointerEvent::new(PointerKind::Down, 250.0, 400.0).with_mods(alt)); + assert!(matches!(&a[..], [Action::Begin(_), Action::Preview(c, _)] if c == "path.appendAnchor"), "{a:?}"); + } + + /// #494: the Pen goes on drawing the path it drew while that path stays selected (after a Cmd + /// drag with Direct Selection), but never another open path selected meanwhile. + #[test] + fn the_pen_draws_on_the_path_it_began_only() { + let (mut d, a, s) = drawing(vectorcraft_geom::SubPath::polyline(&[Point::new(10.0, 300.0), Point::new(60.0, 300.0)], false)); + let l = d.layers[0].id; + let b = d.alloc_id(); + let line = vectorcraft_geom::shapes::line(Point::new(10.0, 400.0), Point::new(60.0, 400.0)); + d.insert(Some(l), 2, vectorcraft_doc::Node::path(b, line, vectorcraft_doc::Appearance::default_art())).unwrap(); + let p = paint(); + let mut t = PenTool { drawing: true, ..PenTool::default() }; + let cx_a = cx(&d, &s, &p); + let appended = |acts: &[Action]| match acts { + [Action::Begin(_), Action::Preview(c, v)] if c == "path.appendAnchor" => v["id"].as_u64(), + _ => None, + }; + assert_eq!(appended(&click(&mut t, &cx_a, 100.0, 320.0, Mods::default())), Some(a.0)); + // Path B selected instead: the next click starts a new path. + let mut sb = Selection::default(); + sb.set([b]); + let cx_b = cx(&d, &sb, &p); + assert_eq!(t.cursor(&cx_b, Point::new(150.0, 350.0), Mods::default()), Cursor::Pen); + let acts = click(&mut t, &cx_b, 150.0, 350.0, Mods::default()); + assert!(matches!(&acts[..], [Action::Begin(_), Action::Preview(c, _)] if c == "path.create"), "{acts:?}"); + } } diff --git a/crates/ui-egui/src/canvas.rs b/crates/ui-egui/src/canvas.rs index d377f4a3..83e2559d 100644 --- a/crates/ui-egui/src/canvas.rs +++ b/crates/ui-egui/src/canvas.rs @@ -76,31 +76,19 @@ enum Drag { start_angle: f64, start_rot: f64, }, - /// Cmd held: temporary selection tool; restore this tool on release. - TempSelect, /// A Selection tool move dragged off the canvas: the panels get the art - /// ([`widgets::PanelDrag::Art`]); `temp` restores the tool Cmd switched from on release. - Art { - temp: bool, - }, + /// ([`widgets::PanelDrag::Art`]). + Art, } fn drag_id() -> egui::Id { egui::Id::new("canvas-drag") } -fn temp_tool_id() -> egui::Id { - egui::Id::new("canvas-temp-tool") -} /// Where the pointer was last seen during a press on the canvas. fn drag_pos_id() -> egui::Id { egui::Id::new("canvas-drag-pos") } -/// Selection, Direct Selection and Group Selection: the tools Cmd switches to for a drag. -pub(crate) fn is_selection_tool(id: &str) -> bool { - matches!(id, "selection" | "directSelection" | "groupSelection") -} - /// The pen pressure (0..1) of the press in progress: the force of this frame's pen or touch /// input, else the last one seen since the press (`pressed`: a new press, whose mouse has none /// until a pen reports it). A mouse presses fully (1). @@ -531,19 +519,10 @@ fn handle_input(app: &mut VectorcraftApp, ui: &Ui, resp: &egui::Response, rect: let c = rect.center(); Drag::RotateView { start_angle: (p.y - c.y).atan2(p.x - c.x) as f64, start_rot: v.rotation } } else { - let mut kind = Drag::Tool; - // Cmd with another tool: drag with the selection tool used last. - if m.command && !is_selection_tool(tool) { - ui.data_mut(|d| d.insert_temp(temp_tool_id(), tool.to_string())); - let last = app.ui.last_selection_tool.clone(); - app.select_tool(if is_selection_tool(&last) { &last } else { "selection" }); - kind = Drag::TempSelect; - } - // Cmd only brought the selection tool: its click is a plain one, not Select Behind. - let mods = Mods { cmd: m.command && kind != Drag::TempSelect, ..mods(m, space) }; - let ev = PointerEvent { kind: PointerKind::Down, pos: xf.to_doc(p), mods, pressure: pen_pressure(ui, true) }; + // Cmd with another tool drags with the selection tool used last (the session lends it). + let ev = PointerEvent { kind: PointerKind::Down, pos: xf.to_doc(p), mods: mods(m, space), pressure: pen_pressure(ui, true) }; dispatch(app, &ev, view); - kind + Drag::Tool }; ui.data_mut(|dd| { dd.insert_temp(drag_id(), d); @@ -580,11 +559,11 @@ fn handle_input(app: &mut VectorcraftApp, ui: &Ui, resp: &egui::Response, rect: vm.rotation = vectorcraft_geom::normalize_deg(deg); } } - Drag::ZoomBox { .. } | Drag::Art { .. } => {} - Drag::Tool | Drag::TempSelect if drag_art_out(app, ui, resp, p, view) => { - ui.data_mut(|dd| dd.insert_temp(drag_id(), Drag::Art { temp: d == Drag::TempSelect })); + Drag::ZoomBox { .. } | Drag::Art => {} + Drag::Tool if drag_art_out(app, ui, resp, p, view) => { + ui.data_mut(|dd| dd.insert_temp(drag_id(), Drag::Art)); } - Drag::Tool | Drag::TempSelect => { + Drag::Tool => { if pointer.delta() != egui::Vec2::ZERO { let ev = PointerEvent { kind: PointerKind::Drag, pos: xf.to_doc(p), mods: mods(m, space), pressure: pen_pressure(ui, false) }; dispatch(app, &ev, view); @@ -620,17 +599,11 @@ fn handle_input(app: &mut VectorcraftApp, ui: &Ui, resp: &egui::Response, rect: } } } - Drag::Tool | Drag::TempSelect | Drag::Art { .. } => { - if !matches!(d, Drag::Art { .. }) { - let ev = PointerEvent { kind: PointerKind::Up, pos: xf.to_doc(p), mods: mods(m, space), pressure: pen_pressure(ui, false) }; - dispatch(app, &ev, view); - } - if matches!(d, Drag::TempSelect | Drag::Art { temp: true }) - && let Some(prev) = ui.data(|dd| dd.get_temp::(temp_tool_id())) - { - app.restore_tool(&prev); - } + Drag::Tool => { + let ev = PointerEvent { kind: PointerKind::Up, pos: xf.to_doc(p), mods: mods(m, space), pressure: pen_pressure(ui, false) }; + dispatch(app, &ev, view); } + Drag::Art => {} Drag::Pan { .. } | Drag::RotateView { .. } => {} } } @@ -1371,7 +1344,7 @@ fn selection_overlay(app: &mut VectorcraftApp, p: &egui::Painter, xf: &Xf) { let app = &*app; let Some(st) = app.session.active() else { return }; let tool = app.session.tool_id(); - let direct = matches!(tool, "directSelection" | "pen" | "addAnchor" | "deleteAnchor" | "anchorPoint" | "curvature"); + let direct = vectorcraft_tools::catalog::edits_anchors(tool); // Selection & Anchor Display › Size (1–7, 3 the default): anchors, handles and the bounding // box's handles a point bigger or smaller per step. let look = HandleLook::of(&app.session.prefs); diff --git a/crates/ui-egui/src/chrome.rs b/crates/ui-egui/src/chrome.rs index 45e28b34..14a96d82 100644 --- a/crates/ui-egui/src/chrome.rs +++ b/crates/ui-egui/src/chrome.rs @@ -108,10 +108,32 @@ pub fn app_bar(app: &mut VectorcraftApp, ui: &mut Ui) { /// An anchor button: icon, tooltip, command and the convert command's `to`. type AnchorButton<'a> = (&'a str, &'a str, &'a str, Option<&'a str>); -/// What the Control bar and the Properties panel offer for direct-selected anchors: "Convert:" -/// corner or smooth, then "Anchors:" remove, connect (Join) and cut. Each group is a row of its -/// own: inline in the Control bar, one under the other in a panel. -pub fn anchor_buttons(app: &mut VectorcraftApp, ui: &mut Ui) { +/// The anchor controls the Control bar and the Properties panel show. +#[derive(Clone, Copy, PartialEq, Eq)] +pub enum AnchorControls { + None, + /// Paths selected as a whole with a tool that edits anchors (Direct Selection, the Pen…), + /// which shows all their anchors selected: "Convert:" only, as removing or cutting at every + /// anchor isn't what they're for. + Convert, + /// Anchors direct-selected: "Convert:" and "Anchors:". + All, +} + +/// Which anchor controls show for the selection and the active tool. +pub fn anchor_controls(app: &VectorcraftApp) -> AnchorControls { + let Some(st) = app.session.active() else { return AnchorControls::None }; + if !st.selection.anchors.is_empty() { + return AnchorControls::All; + } + let paths = st.selection.objects.iter().any(|id| st.doc.node(*id).is_some_and(|n| matches!(n.kind, NodeKind::Path { .. }))); + if paths && vectorcraft_tools::catalog::edits_anchors(app.session.tool_id()) { AnchorControls::Convert } else { AnchorControls::None } +} + +/// What the Control bar and the Properties panel offer for selected anchors ([`anchor_controls`]): +/// "Convert:" corner or smooth, then "Anchors:" remove, connect (Join) and cut. Each group is a +/// row of its own: inline in the Control bar, one under the other in a panel. +pub fn anchor_buttons(app: &mut VectorcraftApp, ui: &mut Ui, controls: AnchorControls) { let t = Tokens::get(ui.ctx()); let mut run = None; let groups: [(&str, &[AnchorButton]); 2] = [ @@ -131,7 +153,12 @@ pub fn anchor_buttons(app: &mut VectorcraftApp, ui: &mut Ui) { ], ), ]; - for (label, buttons) in groups { + let shown = match controls { + AnchorControls::None => 0, + AnchorControls::Convert => 1, + AnchorControls::All => groups.len(), + }; + for (label, buttons) in groups.into_iter().take(shown) { ui.horizontal(|ui| { ui.label(egui::RichText::new(label).size(12.0).color(t.text)); for &(icon, tip, id, to) in buttons { @@ -166,9 +193,9 @@ pub fn control_bar(app: &mut VectorcraftApp, ui: &mut Ui) { let sel = st.selection.objects.clone(); let units = app.session.general_unit(); let first = sel.first().and_then(|id| st.doc.node(*id)).cloned(); - let anchor_mode = !st.selection.anchors.is_empty(); + let anchors = anchor_controls(app); let label = match &first { - Some(_) if sel.len() == 1 && anchor_mode => tl!("Anchor Point"), + Some(_) if sel.len() == 1 && anchors != AnchorControls::None => tl!("Anchor Point"), Some(vectorcraft_doc::Node { kind: NodeKind::Image(im), .. }) if sel.len() == 1 => { if im.link.is_some() { tl!("Linked File") @@ -180,8 +207,8 @@ pub fn control_bar(app: &mut VectorcraftApp, ui: &mut Ui) { _ => tl!(crate::panels::appearance::object_label(app)), }; ui.label(egui::RichText::new(label).font(theme::semibold(12.0)).color(t.text)); - if anchor_mode { - anchor_buttons(app, ui); + if anchors != AnchorControls::None { + anchor_buttons(app, ui, anchors); } ui.add_space(6.0); // An image or an Image Trace object shows its own controls in place of Fill and Stroke. diff --git a/crates/ui-egui/src/clipboard_probe.rs b/crates/ui-egui/src/clipboard_probe.rs new file mode 100644 index 00000000..902024ba --- /dev/null +++ b/crates/ui-egui/src/clipboard_probe.rs @@ -0,0 +1,99 @@ +//! Checks the system clipboard for Paste off the UI thread. `has()` can block for seconds when the +//! clipboard owner never answers (an unresponsive X11 client), so it must not run on the thread that +//! draws the window: a worker owns a second clipboard handle, sends its verdict when it changes, and +//! the UI only reads the latest one. Without a worker the check stays in line, as before (the web, +//! and hosts that don't install a factory). + +use std::sync::mpsc::{Receiver, RecvTimeoutError, Sender, TryRecvError}; +use std::time::{Duration, Instant}; + +use vectorcraft_engine::cmd::clipboard::PASTE_ORDER; + +use crate::sysclip::ClipboardProbeFactory; + +/// How often the worker looks at the clipboard while the UI wants to know. +const PROBE_INTERVAL: Duration = Duration::from_millis(250); + +/// How long dropping the probe waits for the worker to let go of its clipboard handle. +const STOP_WAIT: Duration = Duration::from_millis(250); + +/// The background clipboard check ([`crate::VectorcraftApp`]'s `clipboard_probe`). +pub(crate) struct Probe { + /// Tells the worker whether Paste depends on the system clipboard; dropped to stop it. + wants: Option>, + wanted: bool, + verdicts: Receiver, + /// The worker's last verdict. + last: bool, +} + +impl Probe { + /// Start the worker. `None` on wasm, or when the thread can't be spawned: the caller then falls + /// back to the in-line check. + pub(crate) fn start(make: ClipboardProbeFactory, ctx: egui::Context) -> Option { + if cfg!(target_arch = "wasm32") { + return None; + } + let (wants, wanted_rx) = std::sync::mpsc::channel(); + let (tx, verdicts) = std::sync::mpsc::channel(); + std::thread::Builder::new() + .name("vectorcraft-clip".into()) + .spawn(move || { + let mut clipboard = make(); + let (mut wanted, mut sent) = (false, None); + loop { + if wanted { + // This thread may wait here for a slow owner; the UI's never does. + let verdict = clipboard.has(&PASTE_ORDER); + if sent != Some(verdict) { + if tx.send(verdict).is_err() { + break; + } + sent = Some(verdict); + ctx.request_repaint(); + } + } + // Sleep until the next look (no looks while unwanted) or the UI's next word. + let next = + if wanted { wanted_rx.recv_timeout(PROBE_INTERVAL) } else { wanted_rx.recv().map_err(|_| RecvTimeoutError::Disconnected) }; + match next { + Ok(w) => wanted = w, + Err(RecvTimeoutError::Timeout) => {} + Err(RecvTimeoutError::Disconnected) => break, + } + } + // The handle goes before the app stops waiting (`Drop`): on X11 the last one alive + // hands what the app copied to the clipboard manager, which must finish before exit. + drop(clipboard); + drop(tx); + }) + .ok()?; + Some(Self { wants: Some(wants), wanted: false, verdicts, last: false }) + } + + /// Paste can take from the system clipboard: `wanted` (nothing copied in the app, a document + /// open) and the worker's latest verdict says so. Never blocks. `None` once the worker is gone. + pub(crate) fn pasteable(&mut self, wanted: bool) -> Option { + if wanted != self.wanted { + self.wants.as_ref()?.send(wanted).ok()?; + self.wanted = wanted; + } + loop { + match self.verdicts.try_recv() { + Ok(verdict) => self.last = verdict, + Err(TryRecvError::Empty) => return Some(wanted && self.last), + Err(TryRecvError::Disconnected) => return None, + } + } + } +} + +impl Drop for Probe { + /// Wake the worker to stop and wait (a moment at most: it may be stuck on an owner that never + /// answers) until it has let go of its clipboard handle. + fn drop(&mut self) { + self.wants = None; + let end = Instant::now() + STOP_WAIT; + while self.verdicts.recv_timeout(end.saturating_duration_since(Instant::now())).is_ok() {} + } +} diff --git a/crates/ui-egui/src/dock.rs b/crates/ui-egui/src/dock.rs index 4345ada6..f0c2c197 100644 --- a/crates/ui-egui/src/dock.rs +++ b/crates/ui-egui/src/dock.rs @@ -8,7 +8,7 @@ use serde_json::json; use crate::state::{DockTab, ICON_PANEL_GROUPS, ICON_PANELS}; use crate::theme::{self, Tokens}; -use crate::{VectorcraftApp, icons, panels, widgets}; +use crate::{VectorcraftApp, floating, icons, panels, widgets}; const ICON_COL: f32 = 38.0; /// Height of the strip along the top of a dock column that carries its double arrow. @@ -57,18 +57,26 @@ fn toggle(app: &mut VectorcraftApp, collapsed: bool) { } } -/// One icon of the column: a click pops its panel out (or puts it away). -fn panel_icon(app: &mut VectorcraftApp, ui: &mut Ui, id: &str, label: &str, icon: &str) { +/// One icon of the column: a click pops its panel out (or puts it away); dragged out of the +/// column (`column`), the panel floats. +fn panel_icon(app: &mut VectorcraftApp, ui: &mut Ui, id: &'static str, label: &str, icon: &str, column: Rect) { let open = app.ui.open_panel.as_deref() == Some(id); - if widgets::icon_button(ui, icon, label, open, 30.0).clicked() { + // Its own id: the icons below it move up when it floats, and mustn't take over its drag. + let (_, rect) = ui.allocate_space(vec2(30.0, 30.0)); + let resp = widgets::paint_icon_button(ui, ui.interact(rect, ui.id().with(("panel-icon", id)), Sense::click_and_drag()), icon, label, open); + if resp.clicked() { app.ui.open_panel = if open { None } else { Some(id.to_string()) }; } + if resp.dragged() && ui.input(|i| i.pointer.interact_pos()).is_some_and(|p| !column.contains(p)) { + floating::tear(app, ui.ctx(), &[id], id, floating::strip_grab(ui.ctx(), resp.rect.left())); + } } pub fn show(app: &mut VectorcraftApp, ui: &mut Ui) { let t = Tokens::get(ui.ctx()); - // Main tabbed group, unless it is collapsed to icons. - if !app.ui.dock_collapsed { + let shown = floating::shown_tab(&app.ui); + // Main tabbed group, unless it is collapsed to icons or all its panels float. + let group = shown.filter(|_| !app.ui.dock_collapsed).map(|active| { egui::Panel::right("dock") .resizable(true) .default_size(DOCK_WIDTH) @@ -78,47 +86,31 @@ pub fn show(app: &mut VectorcraftApp, ui: &mut Ui) { if collapse_header(ui, false) { toggle(app, true); } - // Tab strip. - let (strip, _) = ui.allocate_exact_size(vec2(ui.available_width(), 33.0), Sense::hover()); - ui.painter().rect_filled(strip, 0.0, t.tab_strip); - ui.painter().line_segment([strip.left_bottom(), strip.right_bottom()], Stroke::new(1.0, t.border)); - let mut x = strip.left(); - for tab in DockTab::ALL { - let (_, label, _) = tab.info(); - let active = app.ui.dock_tab == tab; - let galley = - ui.painter().layout_no_wrap(tl!(label).to_string(), theme::semibold(12.5), if active { t.text_strong } else { t.text_dim }); - let r = egui::Rect::from_min_size(egui::pos2(x, strip.top()), vec2(galley.size().x + 24.0, strip.height() - 1.0)); - let resp = ui.interact(r, ui.id().with(("docktab", label)), Sense::click()); - if active { - ui.painter().rect_filled(r, 0.0, t.panel); - } - ui.painter().galley(egui::pos2(r.left() + 12.0, r.center().y - galley.size().y / 2.0), galley, t.text); - ui.painter().line_segment([r.right_top(), r.right_bottom()], Stroke::new(1.0, t.border)); - if resp.clicked() { - app.ui.dock_tab = tab; - } - x = r.right(); + if tab_strip(app, ui, active) { + // It floats from this frame on. + return; } - let menu_id = app.ui.dock_tab.info().0; - panels::panel_menu(app, ui, menu_id, egui::Rect::from_center_size(strip.right_center() - vec2(14.0, 0.0), vec2(16.0, 16.0))); - egui::Frame::NONE.inner_margin(egui::Margin { left: 12, right: 10, top: 10, bottom: 8 }).show(ui, |ui| match app.ui.dock_tab { + egui::Frame::NONE.inner_margin(egui::Margin { left: 12, right: 10, top: 10, bottom: 8 }).show(ui, |ui| match active { DockTab::Properties => { egui::ScrollArea::vertical().id_salt("props").auto_shrink([false, false]).show(ui, |ui| panels::properties::show(app, ui)); } DockTab::Layers => panels::layers::show(app, ui), DockTab::Libraries => panels::libraries(app, ui), }); - }); - } + }) + .response + .rect + }); // Collapsed icon-panel strip, left of the expanded panel group (like Illustrator's dock). A - // collapsed group's panels head it, under the « that expands them again. - let collapsed = app.ui.dock_collapsed; + // collapsed group's panels head it, under the « that expands them again. Floating panels leave + // it. + let collapsed = app.ui.dock_collapsed && shown.is_some(); let column = egui::Panel::right("icon_column") .resizable(false) .exact_size(ICON_COL) .frame(egui::Frame::NONE.fill(t.panel).stroke(Stroke::new(1.5, t.border))) .show(ui, |ui| { + let bounds = ui.max_rect(); if collapsed && collapse_header(ui, true) { toggle(app, false); } @@ -129,41 +121,98 @@ pub fn show(app: &mut VectorcraftApp, ui: &mut Ui) { if collapsed { for tab in DockTab::ALL { let (id, label, icon) = tab.info(); - panel_icon(app, ui, id, label, icon); + if floating::group_of(&app.ui, id).is_none() { + panel_icon(app, ui, id, label, icon, bounds); + } } } - for (gi, group) in ICON_PANEL_GROUPS.iter().enumerate() { - if gi > 0 || collapsed { - let (r, _) = ui.allocate_exact_size(vec2(ui.available_width(), 7.0), Sense::hover()); - ui.painter() - .line_segment([r.left_center() + vec2(4.0, 0.0), r.right_center() - vec2(4.0, 0.0)], Stroke::new(1.0, t.divider)); - } + // A divider above each group with icons left, but the first. + let mut divider = collapsed; + for group in ICON_PANEL_GROUPS { + let mut first = true; for id in group.iter() { let Some((_, label, icon)) = ICON_PANELS.iter().find(|p| p.0 == *id) else { continue }; - panel_icon(app, ui, id, label, icon); + if floating::group_of(&app.ui, id).is_some() { + continue; + } + if std::mem::take(&mut first) && std::mem::replace(&mut divider, true) { + let (r, _) = ui.allocate_exact_size(vec2(ui.available_width(), 7.0), Sense::hover()); + ui.painter() + .line_segment([r.left_center() + vec2(4.0, 0.0), r.right_center() - vec2(4.0, 0.0)], Stroke::new(1.0, t.divider)); + } + panel_icon(app, ui, id, label, icon, bounds); } } }); }); }); - let left = column.response.rect.left(); - ui.ctx().data_mut(|d| d.insert_temp(column_left_id(), left)); + let column = column.response.rect; + let dock = group.map_or(column, |g| g.union(column)); + ui.ctx().data_mut(|d| { + d.insert_temp(column_left_id(), column.left()); + d.insert_temp(floating::dock_rect_id(), dock); + }); +} + +/// The tabbed group's tab strip, showing `active`: a click on a tab shows it, a tab dragged out of +/// the strip floats on its own, and the strip right of the tabs floats the whole group. True when +/// the shown panel floats now. +fn tab_strip(app: &mut VectorcraftApp, ui: &mut Ui, active: DockTab) -> bool { + let t = Tokens::get(ui.ctx()); + let (strip, _) = ui.allocate_exact_size(vec2(ui.available_width(), 33.0), Sense::hover()); + ui.painter().rect_filled(strip, 0.0, t.tab_strip); + ui.painter().line_segment([strip.left_bottom(), strip.right_bottom()], Stroke::new(1.0, t.border)); + let out = ui.input(|i| i.pointer.interact_pos()).is_some_and(|p| !strip.contains(p)); + // What a drag out of the strip floats: the panels, the one shown, where its tab began. + let mut tear: Option<(Vec<&'static str>, &'static str, f32)> = None; + let mut x = strip.left(); + for tab in DockTab::ALL { + let (id, label, _) = tab.info(); + if floating::group_of(&app.ui, id).is_some() { + continue; + } + let galley = + ui.painter().layout_no_wrap(tl!(label).to_string(), theme::semibold(12.5), if tab == active { t.text_strong } else { t.text_dim }); + let r = Rect::from_min_size(egui::pos2(x, strip.top()), vec2(galley.size().x + 24.0, strip.height() - 1.0)); + let resp = ui.interact(r, ui.id().with(("docktab", label)), Sense::click_and_drag()); + if tab == active { + ui.painter().rect_filled(r, 0.0, t.panel); + } + ui.painter().galley(egui::pos2(r.left() + 12.0, r.center().y - galley.size().y / 2.0), galley, t.text); + ui.painter().line_segment([r.right_top(), r.right_bottom()], Stroke::new(1.0, t.border)); + if resp.clicked() { + app.ui.dock_tab = tab; + } else if resp.dragged() && out { + tear = Some((vec![id], id, r.left())); + } + x = r.right(); + } + let menu = Rect::from_center_size(strip.right_center() - vec2(14.0, 0.0), vec2(16.0, 16.0)); + let rest = Rect::from_min_max(egui::pos2(x, strip.top()), egui::pos2(menu.left() - 4.0, strip.bottom())); + if rest.width() > 0.0 { + let resp = ui.interact(rest, ui.id().with("dock-group-bar"), Sense::drag()); + if resp.dragged() && out { + tear = Some((floating::docked_tabs(&app.ui).map(|t| t.info().0).collect(), active.info().0, strip.left())); + } + resp.on_hover_cursor(egui::CursorIcon::Grab).on_hover_text(tl!("Drag to float the panel group")); + } + panels::panel_menu(app, ui, active.info().0, menu); + if let Some((ids, id, left)) = tear { + floating::tear(app, ui.ctx(), &ids, id, floating::strip_grab(ui.ctx(), left)); + } + // Torn off, or floated from its menu. + floating::group_of(&app.ui, active.info().0).is_some() } /// A panel popped out next to the icon column: an icon panel, or one of the tabbed group's panels -/// while the dock is collapsed. +/// while the dock is collapsed. Dragging its title floats it. pub fn floating_panel(app: &mut VectorcraftApp, ctx: &egui::Context) { - let Some(id) = app.ui.open_panel.clone() else { return }; - let tab = DockTab::from_id(&id); - let label = match tab { - Some(tab) if app.ui.dock_collapsed => tab.info().1, - // Expanded, the group shows its panels in the dock itself. - Some(_) => return, - None => match ICON_PANELS.iter().find(|p| p.0 == id) { - Some((_, label, _)) => *label, - None => return, - }, - }; + let Some((id, label)) = app.ui.open_panel.as_deref().and_then(|p| crate::state::all_panels().find(|(q, _)| *q == p)) else { return }; + let tab = DockTab::from_id(id); + // Expanded, the group shows its panels in the dock itself; a floating panel shows in its group. + if tab.is_some() && !app.ui.dock_collapsed || floating::group_of(&app.ui, id).is_some() { + return; + } let t = Tokens::get(ctx); let screen = ctx.content_rect(); // Pinned by its right edge, 6 points left of the icon column wherever the dock's width (or its @@ -179,52 +228,39 @@ pub fn floating_panel(app: &mut VectorcraftApp, ctx: &egui::Context) { let right = column - 6.0; // The tabbed group's panels fill their height (Layers) or scroll (Properties): give them one // that keeps the flyout on screen. - // The tabbed group's panels keep the width the dock gives them; icon panels are 256 points. - let width = if tab.is_some() { DOCK_WIDTH } else { 256.0 }; + let width = panel_width(id); let tall = (screen.height() - FLYOUT_TOP - 26.0 - 20.0 - 40.0).clamp(160.0, 560.0); let mut open = true; + let mut torn = None; let area = egui::Area::new(egui::Id::new("icon-panel")).order(egui::Order::Foreground).pivot(egui::Align2::RIGHT_TOP); area.fixed_pos(egui::pos2(right, FLYOUT_TOP)).show(ctx, |ui| { egui::Frame::popup(ui.style()).fill(t.panel).corner_radius(CornerRadius::same(4)).inner_margin(egui::Margin::ZERO).show(ui, |ui| { ui.set_width(width); let (strip, _) = ui.allocate_exact_size(vec2(width, 26.0), Sense::hover()); ui.painter().rect_filled(strip, CornerRadius { nw: 4, ne: 4, sw: 0, se: 0 }, t.panel_darker); - let title = egui::Rect::from_min_size( + let title = Rect::from_min_size( strip.min, vec2(ui.painter().layout_no_wrap(tl!(label).to_string(), theme::semibold(12.0), t.text).size().x + 24.0, 26.0), ); ui.painter().rect_filled(title, CornerRadius { nw: 4, ne: 0, sw: 0, se: 0 }, t.panel); ui.painter().text(title.left_center() + vec2(12.0, 0.0), egui::Align2::LEFT_CENTER, tl!(label), theme::semibold(12.0), t.text); - let close = egui::Rect::from_center_size(strip.right_center() - vec2(13.0, 0.0), vec2(14.0, 14.0)); + let close = Rect::from_center_size(strip.right_center() - vec2(13.0, 0.0), vec2(14.0, 14.0)); let cr = ui.interact(close, ui.id().with("close-panel"), Sense::click()); icons::paint(ui, "chevrons-right", close, if cr.hovered() { t.text } else { t.text_dim }); if cr.clicked() { open = false; } - let menu_r = egui::Rect::from_center_size(strip.right_center() - vec2(34.0, 0.0), vec2(16.0, 16.0)); - panels::panel_menu(app, ui, &id, menu_r); - egui::Frame::NONE.inner_margin(egui::Margin::same(10)).show(ui, |ui| { - ui.set_width(width - 20.0); - match tab { - Some(DockTab::Properties) => { - // At least `tall` when the sections are taller: the flyout's area keeps the - // size its content needs, and egui sizes a new area at most 400 points high, - // so a scroll area that only took the room it was given never grew past it. - egui::ScrollArea::vertical() - .id_salt("props-flyout") - .max_height(tall) - .min_scrolled_height(tall) - .auto_shrink([false, true]) - .show(ui, |ui| panels::properties::show(app, ui)); - } - Some(DockTab::Layers) => { - ui.set_max_height(tall); - panels::layers::show(app, ui); - } - Some(DockTab::Libraries) => panels::libraries(app, ui), - None => panels::show_icon_panel(app, ui, &id), - } - }); + let menu_r = Rect::from_center_size(strip.right_center() - vec2(34.0, 0.0), vec2(16.0, 16.0)); + panels::panel_menu(app, ui, id, menu_r); + let drag = ui.interact(title, ui.id().with("title"), Sense::drag()).on_hover_cursor(egui::CursorIcon::Grab); + if drag.dragged() && ui.input(|i| i.pointer.is_decidedly_dragging()) { + torn = Some(title.left()); + } + // Torn off, or floated from its menu: it floats from this frame on. + if torn.is_some() || floating::group_of(&app.ui, id).is_some() { + return; + } + panel_body(app, ui, id, width, tall); }); }); // User Interface › Auto-Collapse Iconic Panels (#394): a press away from the flyout puts it @@ -240,11 +276,46 @@ pub fn floating_panel(app: &mut VectorcraftApp, ctx: &egui::Context) { open = false; } } - if !open { + if let Some(left) = torn { + floating::tear(app, ctx, &[id], id, floating::strip_grab(ctx, left)); + } else if !open { app.ui.open_panel = None; } } +/// The width of a popped-out or floating panel: the tabbed group's panels keep the width the dock +/// gives them; icon panels are 256 points. +pub(crate) fn panel_width(id: &str) -> f32 { + if DockTab::from_id(id).is_some() { DOCK_WIDTH } else { 256.0 } +} + +/// Panel `id`'s contents in a popped-out or floating panel `width` wide; the tabbed group's panels +/// fill (Layers) or scroll (Properties) `tall` points. +pub(crate) fn panel_body(app: &mut VectorcraftApp, ui: &mut Ui, id: &str, width: f32, tall: f32) { + egui::Frame::NONE.inner_margin(egui::Margin::same(10)).show(ui, |ui| { + ui.set_width(width - 20.0); + match DockTab::from_id(id) { + Some(DockTab::Properties) => { + // At least `tall` when the sections are taller: the flyout's area keeps the size its + // content needs, and egui sizes a new area at most 400 points high, so a scroll area + // that only took the room it was given never grew past it. + egui::ScrollArea::vertical() + .id_salt("props-flyout") + .max_height(tall) + .min_scrolled_height(tall) + .auto_shrink([false, true]) + .show(ui, |ui| panels::properties::show(app, ui)); + } + Some(DockTab::Layers) => { + ui.set_max_height(tall); + panels::layers::show(app, ui); + } + Some(DockTab::Libraries) => panels::libraries(app, ui), + None => panels::show_icon_panel(app, ui, id), + } + }); +} + #[cfg(test)] mod tests { use serde_json::json; diff --git a/crates/ui-egui/src/floating.rs b/crates/ui-egui/src/floating.rs new file mode 100644 index 00000000..818b80f7 --- /dev/null +++ b/crates/ui-egui/src/floating.rs @@ -0,0 +1,769 @@ +//! Floating panels: panels dragged out of the dock float inside the window as groups of tabs. +//! +//! A dock tab, an icon of the icon column or a popped-out panel's title dragged out of the dock +//! floats that panel; the strip right of the dock's tabs floats the whole tabbed group. A floating +//! group moves by its title bar (or the strip right of its tabs, or the tab of a lone panel), and a +//! tab dragged out of a group floats on its own. Dropped on the dock, which lights up while the +//! pointer is over it, a group's panels go back to where they live in the dock (the tabbed group or +//! the icon column); dropped on another group's title bar or tabs, they stack with that group. The +//! × of a group puts its panels back in the dock too. The Tools panel floats the same way by its +//! title bar ([`crate::toolbar`]) and docks again on the window's left edge. +//! +//! `window.panel.float` / `window.panel.dock` do the same for agents. The groups and the Tools +//! panel's position are kept with the preferences and in user workspaces, and a position saved on +//! a bigger window is clamped into this one when drawn. + +use egui::{CornerRadius, Id, Pos2, Rect, Sense, Stroke, Vec2, pos2, vec2}; +use serde_json::{Value, json}; + +use crate::state::{DockTab, FloatingPanels, UiState, all_panels}; +use crate::theme::{self, Tokens}; +use crate::{VectorcraftApp, dock, icons, panels}; + +/// Height of a floating group's title bar (its grip and ×). +pub const TITLE: f32 = 14.0; +/// Height of a floating group's tab strip. +pub const STRIP: f32 = 26.0; +/// Where `window.panel.float` floats a group given no position; each further group 24 points +/// lower right. +const FLOAT_AT: [f32; 2] = [420.0, 120.0]; +/// Where `window.panel.float {panel: "tools"}` floats the Tools panel given no position. +const TOOLS_AT: [f32; 2] = [60.0, 120.0]; +/// Points the pointer travels from its press before a drop counts (a click on a title bar that +/// overlaps the dock doesn't dock its group). +const TRAVEL: f32 = 4.0; + +/// What a move carries. +#[derive(Clone, Copy, Debug, PartialEq)] +enum Moving { + /// The floating group holding this panel. + Panel(&'static str), + /// The floating Tools panel. + Tools, +} + +/// A move in progress: what moves, where the pointer holds it from its top-left corner, and where +/// the press began. +#[derive(Clone, Copy, Debug)] +struct Move { + what: Moving, + grab: Vec2, + from: Pos2, +} + +/// Where a moved group or Tools panel lands. +#[derive(Clone, Copy, Debug, PartialEq)] +enum Drop { + /// Back in the dock (the Tools panel: at the window's left edge). + Dock, + /// Stacked with the floating group holding this panel. + Stack(&'static str), +} + +fn move_id() -> Id { + Id::new("floating-move") +} + +/// The dock (tabbed group and icon column) as last drawn: a group dropped there docks. +pub(crate) fn dock_rect_id() -> Id { + Id::new("floating-dock-rect") +} + +/// The strip along the window's left edge where the Tools panel docks, as last laid out. +pub(crate) fn tools_zone_id() -> Id { + Id::new("floating-tools-zone") +} + +/// The area of the floating group whose first panel is `first`. +pub fn area_id(first: &str) -> Id { + Id::new(("floating-panels", first)) +} + +/// Panel `id` (`window.panel`) as a static string and its English label, if it is a panel. +fn panel(id: &str) -> Option<(&'static str, &'static str)> { + all_panels().find(|(p, _)| *p == id) +} + +/// The floating group holding panel `id`. +pub fn group_of(ui: &UiState, id: &str) -> Option { + ui.floating_panels.iter().position(|g| g.panels.iter().any(|p| p == id)) +} + +/// The panels of group `g`, as static ids. +fn ids_of(g: &FloatingPanels) -> Vec<&'static str> { + g.panels.iter().filter_map(|p| panel(p)).map(|(id, _)| id).collect() +} + +/// The dock tabs left in the dock, in tab order. +pub fn docked_tabs(ui: &UiState) -> impl Iterator + '_ { + DockTab::ALL.into_iter().filter(|t| group_of(ui, t.info().0).is_none()) +} + +/// The dock tab the tabbed group shows: the chosen one, or the first left when it floats. +pub fn shown_tab(ui: &UiState) -> Option { + docked_tabs(ui).find(|t| *t == ui.dock_tab).or_else(|| docked_tabs(ui).next()) +} + +/// Take `ids` out of the floating groups, dropping the groups left empty. +fn take(ui: &mut UiState, ids: &[&str]) { + ui.floating_panels.retain_mut(|g| { + let active = g.panels.get(g.active).filter(|p| !ids.contains(&p.as_str())).cloned(); + g.panels.retain(|p| !ids.contains(&p.as_str())); + g.active = active.and_then(|a| g.panels.iter().position(|p| *p == a)).unwrap_or(0); + !g.panels.is_empty() + }); +} + +/// Float `ids` (out of the dock or of the group they were in) as a new group with its top-left +/// corner at `pos`, showing `active`. +pub fn float(ui: &mut UiState, ids: &[&str], active: &str, pos: Pos2) { + take(ui, ids); + if ui.open_panel.as_deref().is_some_and(|p| ids.contains(&p)) { + ui.open_panel = None; + } + let panels: Vec = ids.iter().map(|id| id.to_string()).collect(); + let active = panels.iter().position(|p| p == active).unwrap_or(0); + ui.floating_panels.push(FloatingPanels { panels, active, pos: [pos.x, pos.y] }); + // The tabbed group shows another of its tabs when the one it showed floats. + if let Some(tab) = shown_tab(ui) { + ui.dock_tab = tab; + } +} + +/// Stack `ids` with the floating group holding `onto` (not one of them), showing `active`. +pub fn stack(ui: &mut UiState, ids: &[&str], active: &str, onto: &str) { + take(ui, ids); + if ui.open_panel.as_deref().is_some_and(|p| ids.contains(&p)) { + ui.open_panel = None; + } + if let Some(g) = group_of(ui, onto).and_then(|i| ui.floating_panels.get_mut(i)) { + g.panels.extend(ids.iter().map(|id| id.to_string())); + g.active = g.panels.iter().position(|p| p == active).unwrap_or(g.active); + } + if let Some(tab) = shown_tab(ui) { + ui.dock_tab = tab; + } +} + +/// Put `ids` back in the dock: the dock tabs in the tabbed group (showing `active`, or the first of +/// them), the other panels in the icon column. +pub fn dock(ui: &mut UiState, ids: &[&str], active: &str) { + take(ui, ids); + if let Some(tab) = DockTab::from_id(active).or_else(|| ids.iter().find_map(|id| DockTab::from_id(id))) { + ui.dock_tab = tab; + } + ui.dock = true; +} + +/// `pos`, a saved top-left corner, moved so that a `size` box there is inside `screen` (its +/// top-left corner first when it doesn't fit). Pulled in by whole points: egui rounds an area's +/// position, which would push a box of fractional size half a point past the edge. +pub fn clamp(pos: [f32; 2], size: Vec2, screen: Rect) -> Pos2 { + let [x, y] = pos; + let (x, y) = if x.is_finite() && y.is_finite() { (x, y) } else { (screen.left() + 60.0, screen.top() + 100.0) }; + let fit = |v: f32, max: f32| if v > max { max.floor() } else { v }; + pos2(fit(x, screen.right() - size.x).max(screen.left()), fit(y, screen.bottom() - size.y).max(screen.top())) +} + +/// Start moving `what` with the pointer, held `grab` from its top-left corner. +fn start(ctx: &egui::Context, what: Moving, grab: Vec2) { + let Some(from) = ctx.input(|i| i.pointer.press_origin().or(i.pointer.interact_pos())) else { return }; + ctx.data_mut(|d| d.insert_temp(move_id(), Move { what, grab, from })); +} + +/// Where the pointer holds a group torn off by a press `left` points right of where the group's +/// tab strip will begin (under its title bar, past its 1-point border). +pub(crate) fn strip_grab(ctx: &egui::Context, left: f32) -> Vec2 { + let x = ctx.input(|i| i.pointer.press_origin()).map_or(12.0, |p| p.x - left); + vec2(1.0 + x.max(0.0), 1.0 + TITLE + STRIP / 2.0) +} + +/// Float `ids` under the pointer, held `grab` from the new group's top-left corner, and carry on +/// moving them with the pointer (a tab or group dragged out of the dock or out of its group). +pub(crate) fn tear(app: &mut VectorcraftApp, ctx: &egui::Context, ids: &[&'static str], active: &'static str, grab: Vec2) { + let Some(at) = ctx.input(|i| i.pointer.interact_pos()) else { return }; + float(&mut app.ui, ids, active, at - grab); + start(ctx, Moving::Panel(active), grab); +} + +/// The Tools panel's title bar was pressed (`title`, the panel's bounds `bounds`): docked, dragging +/// it out of the panel floats the panel under the pointer; floating at `floating`, a drag moves it. +pub(crate) fn drag_tools(app: &mut VectorcraftApp, ctx: &egui::Context, title: &egui::Response, bounds: Rect, floating: Option) { + let Some(at) = ctx.input(|i| i.pointer.interact_pos()) else { return }; + match floating { + Some(pos) if title.drag_started() => start(ctx, Moving::Tools, at - pos), + None if title.dragged() && !bounds.contains(at) => { + // Held where the press grabbed the title bar. + let grab = ctx.input(|i| i.pointer.press_origin()).map_or(vec2(10.0, 7.0), |p| p - bounds.min); + let p = at - grab; + app.ui.toolbar_pos = Some([p.x, p.y]); + start(ctx, Moving::Tools, grab); + } + _ => {} + } +} + +/// Where the pointer at `at` would drop `what`, and the zone that lights up for it. +fn drop_target(app: &VectorcraftApp, ctx: &egui::Context, what: Moving, at: Pos2) -> Option<(Drop, Rect)> { + let zone = |id: Id| ctx.data(|d| d.get_temp::(id)).filter(|r| r.contains(at)); + let Moving::Panel(id) = what else { return zone(tools_zone_id()).map(|r| (Drop::Dock, r)) }; + let own = group_of(&app.ui, id); + // Another group's title bar and tabs stack with it. + for (i, g) in app.ui.floating_panels.iter().enumerate() { + let Some((first, _)) = g.panels.first().and_then(|p| panel(p)).filter(|_| Some(i) != own) else { continue }; + let head = ctx.memory(|m| m.area_rect(area_id(first))).map(|r| Rect::from_min_size(r.min, vec2(r.width(), 1.0 + TITLE + STRIP))); + if let Some(head) = head.filter(|h| h.contains(at)) { + return Some((Drop::Stack(first), head)); + } + } + zone(dock_rect_id()).filter(|_| app.ui.dock && app.ui.screen_mode < 3).map(|r| (Drop::Dock, r)) +} + +/// Light up a drop zone: over the docked panels, under the floating ones (the moved one too). +fn highlight(ctx: &egui::Context, zone: Rect) { + let t = Tokens::get(ctx); + let painter = ctx.layer_painter(egui::LayerId::new(egui::Order::Background, Id::new("floating-drop-zone"))); + painter.rect(zone.shrink(1.0), CornerRadius::same(2), t.accent.gamma_multiply(0.2), Stroke::new(2.0, t.accent), egui::StrokeKind::Inside); +} + +/// Carry a move on (at the start of a frame, before the panels are drawn): the group or Tools panel +/// follows the pointer and the zone it would drop on lights up; the release drops it there. +pub fn track(app: &mut VectorcraftApp, ctx: &egui::Context) { + let Some(m) = ctx.data(|d| d.get_temp::(move_id())) else { return }; + let at = ctx.input(|i| i.pointer.interact_pos()); + let target = at.filter(|at| at.distance(m.from) > TRAVEL).and_then(|at| drop_target(app, ctx, m.what, at)); + if ctx.input(|i| i.pointer.primary_down()) { + if let Some(p) = at.map(|at| at - m.grab) + && p.x.is_finite() + && p.y.is_finite() + { + match m.what { + Moving::Panel(id) => { + if let Some(g) = group_of(&app.ui, id).and_then(|i| app.ui.floating_panels.get_mut(i)) { + g.pos = [p.x, p.y]; + } + } + Moving::Tools if app.ui.toolbar_pos.is_some() => app.ui.toolbar_pos = Some([p.x, p.y]), + Moving::Tools => {} + } + } + if let Some((_, zone)) = target { + highlight(ctx, zone); + } + return; + } + ctx.data_mut(|d| d.remove::(move_id())); + let Some((drop, _)) = target else { return }; + let Moving::Panel(id) = m.what else { + app.ui.toolbar_pos = None; + return; + }; + let Some(g) = group_of(&app.ui, id).and_then(|i| app.ui.floating_panels.get(i)) else { return }; + let ids = ids_of(g); + let active = ids.get(g.active).copied().unwrap_or(id); + match drop { + Drop::Dock => dock(&mut app.ui, &ids, active), + Drop::Stack(onto) => stack(&mut app.ui, &ids, active, onto), + } +} + +/// What a press on a floating group did. +enum Action { + /// Show the group's `k`th tab. + Activate(usize, usize), + /// Its × puts the group's panels back in the dock. + Close(usize), + /// Move the group holding this panel, drawn at this corner. + Move(&'static str, Pos2), + /// Float this panel out of its group; its tab began this far right. + Tear(&'static str, f32), +} + +/// The floating groups, each a stack of tabs under a title bar. Hidden with the dock (Tab, +/// Presentation Mode). +pub fn show(app: &mut VectorcraftApp, ctx: &egui::Context) { + if app.ui.floating_panels.is_empty() || !app.ui.dock || app.ui.screen_mode >= 3 { + return; + } + let t = Tokens::get(ctx); + let screen = ctx.content_rect(); + let pointer = ctx.input(|i| i.pointer.interact_pos()); + let mut action = None; + for gi in 0..app.ui.floating_panels.len() { + let Some(g) = app.ui.floating_panels.get(gi) else { break }; + let ids = ids_of(g); + let Some(&first) = ids.first() else { continue }; + let active = ids.get(g.active).copied().unwrap_or(first); + let area = area_id(first); + let size = ctx.memory(|m| m.area_rect(area)).map_or(vec2(dock::panel_width(active), 200.0), |r| r.size()); + let pos = clamp(g.pos, size, screen); + // The tabbed group's panels fill (Layers) or scroll (Properties) to near the window's bottom, + // leaving room for their margins (a group that only just fitted would creep up a little each + // frame). + let tall = (screen.bottom() - pos.y - TITLE - STRIP - 60.0).clamp(120.0, 560.0); + let lone = ids.len() == 1; + egui::Area::new(area).order(egui::Order::Middle).fixed_pos(pos).show(ctx, |ui| { + let frame = egui::Frame::popup(ui.style()).fill(t.panel).corner_radius(CornerRadius::same(4)).inner_margin(egui::Margin::ZERO); + frame.show(ui, |ui| { + ui.spacing_mut().item_spacing = Vec2::ZERO; + let tabs: Vec<_> = ids + .iter() + .map(|id| { + let label = panel(id).map_or(*id, |(_, label)| label); + let color = if *id == active { t.text_strong } else { t.text_dim }; + ui.painter().layout_no_wrap(tl!(label).to_string(), theme::semibold(12.0), color) + }) + .collect(); + let tabs_width: f32 = tabs.iter().map(|g| g.size().x + 24.0).sum(); + let width = ids.iter().map(|id| dock::panel_width(id)).fold(tabs_width + 32.0, f32::max); + ui.set_width(width); + // Title bar: a grip that moves the group, and the × that docks it. + let (bar, _) = ui.allocate_exact_size(vec2(width, TITLE), Sense::hover()); + ui.painter().rect_filled(bar, CornerRadius { nw: 4, ne: 4, sw: 0, se: 0 }, t.tab_strip); + let close = Rect::from_center_size(bar.right_center() - vec2(10.0, 0.0), vec2(TITLE, TITLE)); + let grip = ui.interact(Rect::from_min_max(bar.min, pos2(close.left(), bar.bottom())), ui.id().with("title"), Sense::drag()); + for k in 0..2 { + let y = bar.center().y - 1.5 + k as f32 * 3.0; + ui.painter().line_segment([pos2(bar.center().x - 9.0, y), pos2(bar.center().x + 9.0, y)], Stroke::new(0.6, t.text_disabled)); + } + if grip.drag_started() { + action = Some(Action::Move(active, pos)); + } + grip.on_hover_cursor(egui::CursorIcon::Grab).on_hover_text(tl!("Drag to move")); + let x = ui.interact(close, ui.id().with("close"), Sense::click()); + icons::paint(ui, "x", close.shrink(3.0), if x.hovered() { t.text_strong } else { t.text_dim }); + if x.on_hover_text(tl!("Put back in the dock")).clicked() { + action = Some(Action::Close(gi)); + } + // Tab strip: a click shows a tab, a drag out of the strip floats it on its own. + let (strip, _) = ui.allocate_exact_size(vec2(width, STRIP), Sense::hover()); + ui.painter().rect_filled(strip, 0.0, t.panel_darker); + let mut left = strip.left(); + for (k, (&id, galley)) in ids.iter().zip(tabs).enumerate() { + let r = Rect::from_min_size(pos2(left, strip.top()), vec2(galley.size().x + 24.0, STRIP)); + left = r.right(); + let resp = ui.interact(r, ui.id().with(("tab", id)), Sense::click_and_drag()); + if id == active { + ui.painter().rect_filled(r, 0.0, t.panel); + } + ui.painter().galley(pos2(r.left() + 12.0, r.center().y - galley.size().y / 2.0), galley, t.text); + if resp.clicked() { + action = Some(Action::Activate(gi, k)); + } else if lone && resp.drag_started() { + action = Some(Action::Move(id, pos)); + } else if !lone && resp.dragged() && pointer.is_some_and(|p| !strip.expand(4.0).contains(p)) { + action = Some(Action::Tear(id, r.left())); + } + } + let menu = Rect::from_center_size(strip.right_center() - vec2(14.0, 0.0), vec2(16.0, 16.0)); + let rest = Rect::from_min_max(pos2(left, strip.top()), pos2(menu.left() - 4.0, strip.bottom())); + if rest.width() > 0.0 { + let resp = ui.interact(rest, ui.id().with("strip"), Sense::drag()); + if resp.drag_started() { + action = Some(Action::Move(active, pos)); + } + resp.on_hover_cursor(egui::CursorIcon::Grab).on_hover_text(tl!("Drag to move")); + } + panels::panel_menu(app, ui, active, menu); + dock::panel_body(app, ui, active, width, tall); + }); + }); + } + match action { + Some(Action::Activate(gi, k)) => { + if let Some(g) = app.ui.floating_panels.get_mut(gi) { + g.active = k; + } + } + Some(Action::Close(gi)) => { + if let Some(g) = app.ui.floating_panels.get(gi) { + let ids = ids_of(g); + let active = ids.get(g.active).copied().unwrap_or_default(); + dock(&mut app.ui, &ids, active); + } + } + Some(Action::Move(id, pos)) => { + // From where it is drawn (a position saved on a bigger window was clamped into this one). + if let Some(g) = group_of(&app.ui, id).and_then(|i| app.ui.floating_panels.get_mut(i)) { + g.pos = [pos.x, pos.y]; + } + if let Some(at) = pointer { + start(ctx, Moving::Panel(id), at - pos); + } + } + Some(Action::Tear(id, left)) => tear(app, ctx, &[id], id, strip_grab(ctx, left)), + None => {} + } +} + +/// `window.panel.float` and `window.panel.dock`; `None` for other commands. +pub fn command(app: &mut VectorcraftApp, id: &str, p: &Value) -> Option> { + let float = match id { + "window.panel.float" => true, + "window.panel.dock" => false, + _ => return None, + }; + Some(float_or_dock(app, float, p)) +} + +/// The `x`, `y` params: a top-left corner in screen points, if given. +fn position(p: &Value) -> Result, String> { + let coord = |k: &str| match p.get(k) { + None | Some(Value::Null) => Some(None), + Some(v) => v.as_f64().filter(|f| f.abs() < 1e6).map(|f| Some(f as f32)), + }; + match (coord("x"), coord("y")) { + (Some(Some(x)), Some(Some(y))) => Ok(Some(pos2(x, y))), + (Some(None), Some(None)) => Ok(None), + _ => Err("x and y must both be numbers".into()), + } +} + +fn float_or_dock(app: &mut VectorcraftApp, float_it: bool, p: &Value) -> Result { + let raw = p.get("panel").and_then(Value::as_str).unwrap_or_default().trim(); + let group = crate::menus::opt_bool(p, "group")?.unwrap_or(false); + let at = position(p)?; + if raw.eq_ignore_ascii_case("tools") || raw.eq_ignore_ascii_case("toolbar") { + app.ui.toolbar_pos = float_it.then(|| at.map_or(TOOLS_AT, |p| [p.x, p.y])); + app.ui.toolbar |= float_it; + return Ok(json!({ "panel": "tools", "floating": float_it, "pos": app.ui.toolbar_pos })); + } + let Some(id) = crate::menus::normalize_panel(raw) else { return Err(format!("unknown panel `{raw}`")) }; + let own = group_of(&app.ui, id); + // The panel, or with `group` its whole group: its floating group, or the tabs left in the dock. + let ids: Vec<&'static str> = match (group, own.and_then(|i| app.ui.floating_panels.get(i))) { + (true, Some(g)) => ids_of(g), + (true, None) if DockTab::from_id(id).is_some() => docked_tabs(&app.ui).map(|t| t.info().0).collect(), + _ => vec![id], + }; + app.ui.dock = true; + if !float_it { + dock(&mut app.ui, &ids, id); + return Ok(json!({ "panel": id, "floating": false })); + } + match p.get("onto").and_then(Value::as_str) { + Some(onto) => { + let onto = crate::menus::normalize_panel(onto) + .filter(|o| !ids.contains(o) && group_of(&app.ui, o).is_some_and(|g| Some(g) != own)) + .ok_or("onto must name a panel floating in another group")?; + stack(&mut app.ui, &ids, id, onto); + } + // Its own group already: moved there (or left where it is), showing the panel. + None => match own.and_then(|i| app.ui.floating_panels.get_mut(i)).filter(|g| g.panels.len() == ids.len()) { + Some(g) => { + g.active = g.panels.iter().position(|p| p == id).unwrap_or(g.active); + if let Some(at) = at { + g.pos = [at.x, at.y]; + } + } + None => { + let n = app.ui.floating_panels.len() as f32; + let at = at.unwrap_or(pos2(FLOAT_AT[0] + 24.0 * n, FLOAT_AT[1] + 24.0 * n)); + float(&mut app.ui, &ids, id, at); + } + }, + } + let g = group_of(&app.ui, id).and_then(|i| app.ui.floating_panels.get(i)); + Ok(json!({ "panel": id, "floating": true, "group": g.map(|g| &g.panels), "pos": g.map(|g| g.pos) })) +} + +#[cfg(test)] +mod tests { + use egui::{Event, PointerButton}; + use serde_json::json; + use vectorcraft_engine::Session; + + use super::*; + + const SCREEN: Vec2 = vec2(1400.0, 900.0); + + /// Frames of the whole window, 1400 × 900, with pointer input one event a frame (as the + /// control channel's `ui.drag` sends it). + struct Harness { + app: VectorcraftApp, + ctx: egui::Context, + time: f64, + } + + fn button(pos: Pos2, pressed: bool) -> Event { + Event::PointerButton { pos, button: PointerButton::Primary, pressed, modifiers: Default::default() } + } + + impl Harness { + fn new() -> Self { + let mut app = VectorcraftApp::new(Session::new(), Default::default()); + app.run("file.new", json!({"width": 300, "height": 300})).unwrap(); + let mut h = Self { app, ctx: egui::Context::default(), time: 0.0 }; + h.settle(); + h + } + + fn frame(&mut self, events: Vec) { + self.time += 0.05; + let screen = Rect::from_min_size(Pos2::ZERO, SCREEN); + let raw = egui::RawInput { time: Some(self.time), screen_rect: Some(screen), events, ..Default::default() }; + let app = &mut self.app; + self.ctx + .run_ui(raw, |ui| { + app.logic(ui.ctx()); + app.ui(ui); + }) + .textures_delta + .clear(); + } + + fn settle(&mut self) { + for _ in 0..4 { + self.frame(vec![]); + } + } + + /// Press at `from` and move to `to` in steps, the button still down. + fn hold(&mut self, from: Pos2, to: Pos2) { + self.frame(vec![Event::PointerMoved(from)]); + self.frame(vec![button(from, true)]); + for k in 1..=8 { + self.frame(vec![Event::PointerMoved(from + (to - from) * (k as f32 / 8.0))]); + } + } + + fn release(&mut self, at: Pos2) { + self.frame(vec![button(at, false)]); + self.settle(); + } + + fn drag(&mut self, from: Pos2, to: Pos2) { + self.hold(from, to); + self.release(to); + } + + fn click(&mut self, at: Pos2) { + self.frame(vec![Event::PointerMoved(at), button(at, true)]); + self.release(at); + } + + fn temp_rect(&self, id: Id) -> Rect { + self.ctx.data(|d| d.get_temp::(id)).unwrap() + } + + /// The floating group whose first panel is `first`, as drawn. + fn group(&self, first: &str) -> Rect { + self.ctx.memory(|m| m.area_rect(area_id(first))).unwrap() + } + + /// A point on a floating group's title bar (left of its ×). + fn title(&self, first: &str) -> Pos2 { + let r = self.group(first); + pos2(r.left() + 30.0, r.top() + 1.0 + TITLE / 2.0) + } + + /// The rects of the widgets that sense a drag and pass `keep`, top to bottom, left to right. + fn widgets(&self, keep: impl Fn(Rect) -> bool) -> Vec { + let mut r: Vec = self.ctx.viewport(|vp| { + vp.prev_pass.widgets.layers().flat_map(|(_, w)| w.iter()).filter(|w| w.sense.senses_drag() && keep(w.rect)).map(|w| w.rect).collect() + }); + r.sort_by(|a, b| a.top().total_cmp(&b.top()).then(a.left().total_cmp(&b.left()))); + r + } + + /// The dock's tabs, left to right. + fn dock_tabs(&self) -> Vec { + let dock = self.temp_rect(dock_rect_id()); + self.widgets(|r| r.height() == 32.0 && dock.contains_rect(r)) + } + + /// The icon column's panel icons, top to bottom. + fn icons(&self) -> Vec { + let dock = self.temp_rect(dock_rect_id()); + self.widgets(|r| r.size() == vec2(30.0, 30.0) && dock.contains_rect(r)) + } + + fn groups(&self) -> Vec> { + self.app.ui.floating_panels.iter().map(|g| g.panels.iter().map(String::as_str).collect()).collect() + } + } + + #[test] + fn a_dock_tab_dragged_out_floats_and_dropped_on_the_dock_docks_again() { + let mut h = Harness::new(); + let tabs = h.dock_tabs(); + assert_eq!(tabs.len(), 3, "Properties, Layers, Libraries: {tabs:?}"); + let to = pos2(600.0, 400.0); + h.drag(tabs[1].center(), to); + assert_eq!(h.groups(), [["layers"]], "Layers floats"); + assert!(h.group("layers").contains(to), "under the pointer: {:?}", h.group("layers")); + assert_eq!(h.dock_tabs().len(), 2, "its tab left the dock"); + assert_eq!(h.app.ui.dock_tab, DockTab::Properties); + // A click on its title bar moves nothing, even over the dock. + let dock = h.temp_rect(dock_rect_id()); + h.app.run("window.panel.float", json!({"panel": "layers", "x": dock.left() + 10.0, "y": 300})).unwrap(); + h.settle(); + h.click(h.title("layers")); + assert_eq!(h.groups(), [["layers"]], "a click doesn't dock it"); + // Dragged by its title bar onto the dock, the dock lights up, and the release docks it. + h.app.run("window.panel.float", json!({"panel": "layers", "x": 500, "y": 300})).unwrap(); + h.settle(); + let over = dock.center(); + h.hold(h.title("layers"), over); + assert!(h.group("layers").contains(over), "the group follows the pointer"); + let target = drop_target(&h.app, &h.ctx, Moving::Panel("layers"), over); + assert_eq!(target.map(|t| t.0), Some(Drop::Dock), "the dock is the drop zone"); + h.release(over); + assert!(h.groups().is_empty(), "docked: {:?}", h.groups()); + assert_eq!((h.dock_tabs().len(), h.app.ui.dock_tab), (3, DockTab::Layers), "back in the dock, shown"); + } + + #[test] + fn the_strip_right_of_the_tabs_floats_the_whole_group_and_its_close_box_docks_it() { + let mut h = Harness::new(); + let tabs = h.dock_tabs(); + let rest = tabs[2].right_center() + vec2(30.0, 0.0); + h.drag(rest, pos2(500.0, 300.0)); + assert_eq!(h.groups(), [["properties", "layers", "libraries"]]); + assert!(h.dock_tabs().is_empty(), "the tabbed group left the dock"); + let column = h.temp_rect(dock_rect_id()); + assert!(column.width() < 40.0, "only the icon column is left: {column:?}"); + // Its × puts them back. + let g = h.group("properties"); + h.click(pos2(g.right() - 11.0, g.top() + 1.0 + TITLE / 2.0)); + assert!(h.groups().is_empty()); + assert_eq!(h.dock_tabs().len(), 3); + } + + #[test] + fn icons_dragged_out_float_stack_onto_another_group_and_tear_out_of_it() { + let mut h = Harness::new(); + // Color, Color Guide, Swatches… top to bottom. + let icons = h.icons(); + let count = icons.len(); + h.drag(icons[2].center(), pos2(500.0, 250.0)); + assert_eq!(h.groups(), [["swatches"]]); + assert_eq!(h.icons().len(), count - 1, "its icon left the column"); + h.drag(h.icons()[0].center(), pos2(500.0, 650.0)); + assert_eq!(h.groups(), [["swatches"], ["color"]]); + // Color's title bar dropped on the Swatches group's tabs stacks them. + let onto = h.group("swatches").left_top() + vec2(150.0, 1.0 + TITLE + STRIP / 2.0); + h.hold(h.title("color"), onto); + assert_eq!(drop_target(&h.app, &h.ctx, Moving::Panel("color"), onto).map(|t| t.0), Some(Drop::Stack("swatches"))); + h.release(onto); + assert_eq!(h.groups(), [["swatches", "color"]]); + assert_eq!(h.app.ui.floating_panels[0].active, 1, "showing the panel dropped on it"); + // A click shows a tab; a tab dragged out of the strip floats on its own again. + let g = h.group("swatches"); + let tabs = h.widgets(|r| r.height() == STRIP && g.contains_rect(r)); + assert_eq!(tabs.len(), 3, "two tabs and the strip right of them: {tabs:?}"); + h.click(tabs[0].center()); + assert_eq!(h.app.ui.floating_panels[0].active, 0); + let to = pos2(900.0, 500.0); + h.drag(tabs[1].center(), to); + assert_eq!(h.groups(), [["swatches"], ["color"]]); + assert!(h.group("color").contains(to)); + // Window › Color shows it where it floats; Dock Panel puts it back. + assert_eq!(h.app.run("window.panel", json!({"panel": "Color"})).unwrap(), json!({"floating": ["color"]})); + assert_eq!(crate::menus::checked(&h.app, "window.panel", &json!({"panel": "color"})), Some(true)); + h.app.run("window.panel.dock", json!({"panel": "color"})).unwrap(); + h.settle(); + assert_eq!(h.icons().len(), count - 1, "Color is back in the column"); + } + + #[test] + fn a_popped_out_panel_dragged_by_its_title_floats() { + let mut h = Harness::new(); + h.app.run("window.panel", json!({"panel": "swatches"})).unwrap(); + h.settle(); + let flyout = h.ctx.memory(|m| m.area_rect(Id::new("icon-panel"))).unwrap(); + let to = pos2(500.0, 400.0); + h.drag(flyout.left_top() + vec2(20.0, 13.0), to); + assert_eq!((h.groups(), h.app.ui.open_panel.as_deref()), (vec![vec!["swatches"]], None)); + assert!(h.group("swatches").contains(to), "under the pointer: {:?}", h.group("swatches")); + // Its panel menu docks it again. + h.app.run("window.panel.dock", json!({"panel": "swatches"})).unwrap(); + assert!(h.groups().is_empty()); + } + + #[test] + fn the_tools_panel_floats_by_its_title_bar_and_docks_on_the_left_edge() { + let mut h = Harness::new(); + let zone = h.temp_rect(tools_zone_id()); + let title = zone.left_top() + vec2(30.0, 7.0); + let to = pos2(400.0, 300.0); + h.drag(title, to); + let pos = h.app.ui.toolbar_pos.expect("the Tools panel floats"); + let float = h.ctx.memory(|m| m.area_rect(Id::new("toolbar-floating"))).unwrap(); + assert!(float.contains(to) && (pos2(pos[0], pos[1]) - float.min).length() < 1.0, "under the pointer: {float:?}"); + // Back on the window's left edge. + let edge = pos2(10.0, 400.0); + h.hold(float.left_top() + vec2(30.0, 7.0), edge); + assert_eq!(drop_target(&h.app, &h.ctx, Moving::Tools, edge).map(|t| t.0), Some(Drop::Dock)); + h.release(edge); + assert_eq!(h.app.ui.toolbar_pos, None, "docked"); + // A click on the title bar still switches the columns. + let double = h.app.ui.toolbar_double; + h.click(title); + assert_ne!(h.app.ui.toolbar_double, double); + } + + #[test] + fn floating_panels_are_kept_in_workspaces_and_preferences_and_clamped_into_the_window() { + let mut h = Harness::new(); + let app = &mut h.app; + // Saved on a much bigger screen. + app.run("window.panel.float", json!({"panel": "layers", "x": 5000, "y": 4000})).unwrap(); + let r = app.run("window.panel.float", json!({"panel": "stroke", "onto": "Layers"})).unwrap(); + assert_eq!(r["group"], json!(["layers", "stroke"])); + app.run("window.panel.float", json!({"panel": "tools", "x": 300, "y": 200})).unwrap(); + app.run("window.workspace.new", json!({"name": "Floating"})).unwrap(); + let saved = app.ui.floating_panels.clone(); + app.run("window.workspace", json!({"name": "Essentials"})).unwrap(); + assert!(app.ui.floating_panels.is_empty() && app.ui.toolbar_pos.is_none(), "Essentials docks everything"); + app.run("window.workspace", json!({"name": "Floating"})).unwrap(); + assert_eq!((&app.ui.floating_panels, app.ui.toolbar_pos), (&saved, Some([300.0, 200.0]))); + let prefs: UiState = serde_json::from_slice(&serde_json::to_vec(&app.ui).unwrap()).unwrap(); + let prefs = prefs.sanitized(); + assert_eq!((&prefs.floating_panels, prefs.toolbar_pos), (&saved, Some([300.0, 200.0]))); + // Unknown and repeated panels (a hand-edited file) are dropped. + let edited: UiState = serde_json::from_value(json!({ + "floating_panels": [{"panels": ["nope", "layers"], "active": 7, "pos": [1, 2]}, {"panels": ["layers"], "pos": [3, 4]}], + })) + .unwrap(); + let edited = edited.sanitized(); + assert_eq!(edited.floating_panels, [FloatingPanels { panels: vec!["layers".into()], active: 0, pos: [1.0, 2.0] }]); + h.settle(); + let g = h.group("layers"); + let screen = Rect::from_min_size(Pos2::ZERO, SCREEN); + assert!(screen.contains_rect(g), "clamped into the window: {g:?}"); + assert!(h.dock_tabs().len() == 2 && h.app.ui.dock_tab == DockTab::Properties); + } + + #[test] + fn float_and_dock_commands_check_their_params() { + let mut app = VectorcraftApp::new(Session::new(), Default::default()); + assert!(app.run("window.panel.float", json!({"panel": "nope"})).is_err()); + assert!(app.run("window.panel.float", json!({"panel": "layers", "x": "left", "y": 2})).is_err()); + assert!(app.run("window.panel.float", json!({"panel": "layers", "x": 2})).is_err(), "both x and y"); + assert!(app.run("window.panel.float", json!({"panel": "layers", "group": "yes"})).is_err()); + assert!(app.run("window.panel.float", json!({"panel": "layers", "onto": "color"})).is_err(), "Color isn't floating"); + assert!(app.ui.floating_panels.is_empty()); + // The tabbed group's tabs float together. + let r = app.run("window.panel.float", json!({"panel": "layers", "group": true})).unwrap(); + assert_eq!(r["group"], json!(["properties", "layers", "libraries"])); + assert_eq!(app.ui.floating_panels[0].active, 1); + assert!(app.run("window.panel.float", json!({"panel": "layers", "onto": "properties"})).is_err(), "not onto its own group"); + // Floated out of its group; a lone panel moves. + app.run("window.panel.float", json!({"panel": "layers", "x": 10, "y": 20})).unwrap(); + assert_eq!((app.ui.floating_panels.len(), floating_pos(&app, "layers")), (2, [10.0, 20.0])); + app.run("window.panel.float", json!({"panel": "layers", "x": 30, "y": 40})).unwrap(); + assert_eq!((app.ui.floating_panels.len(), floating_pos(&app, "layers")), (2, [30.0, 40.0])); + app.run("window.panel.dock", json!({"panel": "properties", "group": true})).unwrap(); + assert_eq!(app.ui.floating_panels.len(), 1); + assert_eq!(app.ui.dock_tab, DockTab::Properties); + assert_eq!(app.run("window.panel.dock", json!({"panel": "tools"})).unwrap()["floating"], json!(false)); + app.ui.toolbar = false; + app.run("window.panel.float", json!({"panel": "Toolbar"})).unwrap(); + assert!(app.ui.toolbar && app.ui.toolbar_pos == Some(TOOLS_AT), "floating shows the Tools panel"); + } + + fn floating_pos(app: &VectorcraftApp, id: &str) -> [f32; 2] { + group_of(&app.ui, id).map(|i| app.ui.floating_panels[i].pos).unwrap() + } +} diff --git a/crates/ui-egui/src/i18n/cs.tsv b/crates/ui-egui/src/i18n/cs.tsv index bffe5345..b8b572f8 100644 --- a/crates/ui-egui/src/i18n/cs.tsv +++ b/crates/ui-egui/src/i18n/cs.tsv @@ -611,4 +611,6 @@ Drag to move Přetažením přesunete Drag to float as a toolbar Přetažením vytvoříte plovoucí panel nástrojů Put back in the toolbar Vrátit do panelu nástrojů + Float Panel Plovoucí panel + Dock Panel Ukotvit panel Float Tool Group Plovoucí skupina nástrojů diff --git a/crates/ui-egui/src/i18n/es.tsv b/crates/ui-egui/src/i18n/es.tsv index ef065c98..6de71837 100644 --- a/crates/ui-egui/src/i18n/es.tsv +++ b/crates/ui-egui/src/i18n/es.tsv @@ -3053,6 +3053,12 @@ axis Both Ambos Drag to move Arrastrar para mover Drag to float as a toolbar Arrastrar para flotar como barra de herramientas Put back in the toolbar Devolver a la barra de herramientas + Float Panel Hacer flotar el panel + Dock Panel Anclar panel + Drag to float the panel group Arrastrar para hacer flotar el grupo de paneles + Put back in the dock Devolver al área de paneles + Drag to float the toolbar Arrastrar para hacer flotar la barra de herramientas + Drag to the window's left edge to dock Arrastrar al borde izquierdo de la ventana para anclar Float Tool Group Hacer flotar el grupo de herramientas # Status and error messages (`@msg`), translated where the status bar shows them; the message itself @@ -3565,6 +3571,7 @@ axis Both Ambos @msg Sent to {_1} Se envió a {_1} @msg {_1} files {_1} archivos @msg The graphics were lost and have been restarted Se perdieron los gráficos y se reiniciaron +@msg The graphics processor tried first couldn't show the window, so VectorCraft started again on {summary} El procesador gráfico probado primero no pudo mostrar la ventana, así que VectorCraft se inició de nuevo con {summary} @msg Loading VectorCraft… Cargando VectorCraft… @msg VectorCraft failed to start: {e} VectorCraft no pudo iniciarse: {e} @msg A browser with WebGPU or WebGL2 is required. Se necesita un navegador con WebGPU o WebGL2. @@ -3573,3 +3580,5 @@ axis Both Ambos @msg Reload the page to go on (changes not saved yet may be lost). Vuelve a cargar la página para continuar (los cambios que aún no se guardaron podrían perderse). @msg tool (a tool id) is required se requiere tool (un id de herramienta) @msg {tool} isn't in a toolbar group of several tools {tool} no está en un grupo de la barra de herramientas con varias herramientas +@msg onto must name a panel floating in another group onto debe nombrar un panel que flote en otro grupo +@msg x and y must both be numbers x e y deben ser números diff --git a/crates/ui-egui/src/i18n/ja.tsv b/crates/ui-egui/src/i18n/ja.tsv index 958e37c4..c3ecb5fd 100644 --- a/crates/ui-egui/src/i18n/ja.tsv +++ b/crates/ui-egui/src/i18n/ja.tsv @@ -3041,4 +3041,10 @@ axis Both 両方 Drag to move 移動するにはドラッグ Drag to float as a toolbar ドラッグしてツールバーとして浮かせる Put back in the toolbar ツールバーに戻す + Float Panel パネルをフローティング + Dock Panel パネルをドッキング + Drag to float the panel group ドラッグしてパネルグループをフローティング + Put back in the dock ドックに戻す + Drag to float the toolbar ドラッグしてツールバーをフローティング + Drag to the window's left edge to dock ウィンドウの左端までドラッグしてドッキング Float Tool Group ツールグループをフローティング diff --git a/crates/ui-egui/src/i18n/pt-br.tsv b/crates/ui-egui/src/i18n/pt-br.tsv index 01bfad39..0e47c699 100644 --- a/crates/ui-egui/src/i18n/pt-br.tsv +++ b/crates/ui-egui/src/i18n/pt-br.tsv @@ -2633,4 +2633,6 @@ Drag to move Arraste para mover Drag to float as a toolbar Arraste para flutuar como barra de ferramentas Put back in the toolbar Devolver à barra de ferramentas + Float Panel Flutuar Painel + Dock Panel Encaixar Painel Float Tool Group Flutuar Grupo de Ferramentas diff --git a/crates/ui-egui/src/i18n/zh-hans.tsv b/crates/ui-egui/src/i18n/zh-hans.tsv index 35cf2c8e..8c01b809 100644 --- a/crates/ui-egui/src/i18n/zh-hans.tsv +++ b/crates/ui-egui/src/i18n/zh-hans.tsv @@ -3298,4 +3298,10 @@ axis Both 两者 Drag to move 拖动以移动 Drag to float as a toolbar 拖动使其浮动为工具栏 Put back in the toolbar 放回工具栏 + Float Panel 浮动面板 + Dock Panel 停放面板 + Drag to float the panel group 拖动以浮动面板组 + Put back in the dock 放回停放区 + Drag to float the toolbar 拖动以浮动工具栏 + Drag to the window's left edge to dock 拖到窗口左边缘以停放 Float Tool Group 浮动工具组 diff --git a/crates/ui-egui/src/i18n/zh-hant.tsv b/crates/ui-egui/src/i18n/zh-hant.tsv index 02ff7856..05467689 100644 --- a/crates/ui-egui/src/i18n/zh-hant.tsv +++ b/crates/ui-egui/src/i18n/zh-hant.tsv @@ -3072,4 +3072,10 @@ axis Both 兩者 Drag to move 拖曳以移動 Drag to float as a toolbar 拖曳使其浮動為工具列 Put back in the toolbar 放回工具列 + Float Panel 浮動面板 + Dock Panel 停駐面板 + Drag to float the panel group 拖曳以浮動面板群組 + Put back in the dock 放回停駐區 + Drag to float the toolbar 拖曳以浮動工具列 + Drag to the window's left edge to dock 拖曳到視窗左側邊緣以停駐 Float Tool Group 浮動工具組 diff --git a/crates/ui-egui/src/lib.rs b/crates/ui-egui/src/lib.rs index 7817a1bb..8cf17d93 100644 --- a/crates/ui-egui/src/lib.rs +++ b/crates/ui-egui/src/lib.rs @@ -17,6 +17,7 @@ pub mod background; mod brand; pub mod canvas; pub mod chrome; +mod clipboard_probe; pub mod community; pub mod control; pub mod credits; @@ -24,6 +25,7 @@ pub mod cursors; pub mod dialogs; pub mod dock; pub mod find_font; +pub mod floating; pub mod font_menu; pub mod graphics; pub mod i18n; @@ -128,6 +130,8 @@ mod tests_sysclip; #[cfg(test)] mod tests_sysclip_emf; #[cfg(test)] +mod tests_sysclip_probe; +#[cfg(test)] mod tests_transparencygrid; #[cfg(test)] mod tests_widthtool; @@ -141,7 +145,7 @@ use vectorcraft_engine::{Session, ViewInfo}; pub use control::{ControlRequest, ControlResponse}; pub use state::{UiState, View}; -pub use sysclip::SystemClipboard; +pub use sysclip::{ClipboardProbeFactory, SystemClipboard}; /// What a file dialog shows: a suggested file name (save dialogs), the folder to start in and the /// file-type filters. @@ -204,6 +208,10 @@ pub struct Services { /// Paste takes SVG, PDF, text and bitmaps from other apps. Without it, SVG text only (through /// egui and `clipboard_read`). pub system_clipboard: Option>, + /// A second system-clipboard handle, for checking whether Paste has something to take on a + /// background thread (Linux: an X11 clipboard owner that never answers would freeze the UI). + /// Taken on the first frame. Without it the check runs on the UI thread. + pub clipboard_probe: Option, /// File → Show in Folder: select a file in the system file manager (desktop). pub reveal: Option, /// Write a file from any thread (desktop): lets Background Save and Export write off the UI @@ -326,8 +334,11 @@ pub struct VectorcraftApp { /// (SVG without a `system_clipboard`) while the internal clipboard is empty. It enables the /// Paste menu items. pub(crate) system_paste: bool, - /// When `system_paste` was last checked (app time, s; at most once per frame). + /// When `system_paste` was last checked in line (app time, s; at most once per frame). system_paste_at: f64, + /// The thread that checks the system clipboard for `system_paste` instead + /// ([`Services::clipboard_probe`]). + clipboard_probe: Option, /// Keyboard pastes of something other than text (see [`shortcuts::PasteChord`]). pub(crate) paste_chord: shortcuts::PasteChord, /// Saves and exports running in the background (Preferences → File Handling). @@ -403,6 +414,7 @@ impl VectorcraftApp { place: Default::default(), system_paste: false, system_paste_at: f64::NEG_INFINITY, + clipboard_probe: None, paste_chord: Default::default(), background: Default::default(), recovery: Default::default(), @@ -539,19 +551,8 @@ impl VectorcraftApp { /// Select a tool (also used by the toolbar and shortcuts). pub fn select_tool(&mut self, id: &str) { - self.change_tool(id, true); - } - - /// Go back to tool `id` after a temporary one, without choosing it afresh - /// ([`vectorcraft_engine::Session::switch_tool`]). - pub fn restore_tool(&mut self, id: &str) { - self.change_tool(id, false); - } - - fn change_tool(&mut self, id: &str, choose: bool) { let v = self.view_info(); - let r = if choose { self.session.select_tool(id, v) } else { self.session.switch_tool(id, v) }; - if let Err(e) = r { + if let Err(e) = self.session.select_tool(id, v) { self.ui.status = e.to_string(); } if let Some(g) = vectorcraft_tools::catalog::group_of(id) @@ -559,9 +560,6 @@ impl VectorcraftApp { { *slot = id.to_string(); } - if canvas::is_selection_tool(id) { - self.ui.last_selection_tool = id.to_string(); - } toolbar::remember(self, id); self.ui.flyout = None; } @@ -742,11 +740,20 @@ impl VectorcraftApp { } self.last_time = now; self.sync_views(); - // Read the system clipboard only when that alone decides whether Paste is enabled, and at - // most a few times a second (opening it locks it against other apps on some systems). - if !(0.0..SYSTEM_CLIPBOARD_POLL).contains(&(now - self.system_paste_at)) { + // Read the system clipboard only when that alone decides whether Paste is enabled. A + // background thread reads it where the host installs one (an unresponsive owner must never + // stall the frame loop); otherwise, or once that thread is gone, it is read here, at most a + // few times a second (opening it locks it against other apps on some systems). + let wanted = self.session.clipboard.is_empty() && self.session.active().is_some(); + if let Some(make) = self.services.clipboard_probe.take() { + self.clipboard_probe = clipboard_probe::Probe::start(make, ctx.clone()); + } + if let Some(pasteable) = self.clipboard_probe.as_mut().and_then(|p| p.pasteable(wanted)) { + self.system_paste = pasteable; + } else if !(0.0..SYSTEM_CLIPBOARD_POLL).contains(&(now - self.system_paste_at)) { + self.clipboard_probe = None; self.system_paste_at = now; - self.system_paste = self.session.clipboard.is_empty() && self.session.active().is_some() && self.system_clipboard_pasteable(); + self.system_paste = wanted && self.system_clipboard_pasteable(); } background::poll(self); if !self.background.jobs.is_empty() { @@ -895,6 +902,7 @@ impl VectorcraftApp { let t0 = now_ms(); scrub::begin_frame(self, &ctx); font_menu::end_stale_preview(self, &ctx); + floating::track(self, &ctx); let t = theme::Tokens::get(&ctx); if self.ui.screen_mode < 2 { chrome::app_bar(self, ui); @@ -919,6 +927,7 @@ impl VectorcraftApp { canvas::show(self, ui); }); dock::floating_panel(self, &ctx); + floating::show(self, &ctx); panels::library_panel::show_window(self, &ctx); dialogs::show(self, &ctx); palette::show(self, &ctx); diff --git a/crates/ui-egui/src/menus.rs b/crates/ui-egui/src/menus.rs index f409d949..683e72d1 100644 --- a/crates/ui-egui/src/menus.rs +++ b/crates/ui-egui/src/menus.rs @@ -225,6 +225,18 @@ pub const UI_COMMANDS: &[(&str, &str, &str, &str)] = &[ ("window.taskBar.reset", "Reset Bar Position", "", "{} unpin the Contextual Task Bar and put it back under the selection"), ("window.dock", "Panels", "Tab", "{} show/hide all panels"), ("window.panel", "Show Panel", "", "{panel: id} e.g. layers, swatches, stroke (case-insensitive; display labels like \"Layers\" work too)"), + ( + "window.panel.float", + "Float Panel", + "", + "{panel: id or \"tools\", x?, y?, onto?: id, group?: bool} float a panel out of the dock (or out of its floating group) as its own floating group with its top-left corner at x, y in window points (default: cascaded), as dragging its tab out of the dock does; `onto` stacks it with the floating group holding that panel instead; `group` takes its whole group (its floating group, or the Properties | Layers | Libraries tabs left in the dock); a panel alone in its group is moved. \"tools\" floats the Tools panel. Returns {panel, floating, group, pos}", + ), + ( + "window.panel.dock", + "Dock Panel", + "", + "{panel: id or \"tools\", group?: bool} put a floating panel (with `group`, its whole group) back in the dock, as dropping it on the dock or its group's × does: Properties, Layers and Libraries in the tabbed group, the other panels in the icon column; \"tools\" docks the Tools panel at the window's left edge", + ), ( "window.collapseDock", "Collapse Panels to Icons", @@ -772,13 +784,13 @@ pub const UI_COMMANDS: &[(&str, &str, &str, &str)] = &[ /// Canonical panel id for `window.panel`: a dock tab's or an icon panel's id or display label, /// matched case-insensitively (`"Layers"`, `"swatches"`, `"Color Guide"`). -fn normalize_panel(input: &str) -> Option<&'static str> { +pub(crate) fn normalize_panel(input: &str) -> Option<&'static str> { let name = input.trim(); crate::state::all_panels().find(|(id, label)| name.eq_ignore_ascii_case(id) || name.eq_ignore_ascii_case(label)).map(|(id, _)| id) } /// An optional `{key?: bool}` param: none when it is omitted or null (the commands then toggle). -fn opt_bool(p: &Value, key: &str) -> Result, String> { +pub(crate) fn opt_bool(p: &Value, key: &str) -> Result, String> { match p.get(key) { None | Some(Value::Null) => Ok(None), Some(Value::Bool(b)) => Ok(Some(*b)), @@ -803,7 +815,10 @@ pub fn run_ui_command(app: &mut VectorcraftApp, id: &str, p: &Value) -> Option Option Option { let panel = p.get("panel").and_then(Value::as_str).unwrap_or(""); let canonical = normalize_panel(panel); match canonical.and_then(DockTab::from_id) { - Some(tab) if !app.ui.dock_collapsed => app.ui.dock_tab == tab, + _ if canonical.is_some_and(|id| crate::floating::group_of(&app.ui, id).is_some()) => true, + Some(tab) if !app.ui.dock_collapsed => crate::floating::shown_tab(&app.ui) == Some(tab), _ => canonical.is_some_and(|id| app.ui.open_panel.as_deref() == Some(id)), } } diff --git a/crates/ui-egui/src/panels/mod.rs b/crates/ui-egui/src/panels/mod.rs index c955d01d..a6c13939 100644 --- a/crates/ui-egui/src/panels/mod.rs +++ b/crates/ui-egui/src/panels/mod.rs @@ -113,8 +113,9 @@ pub fn show_icon_panel(app: &mut VectorcraftApp, ui: &mut Ui, id: &str) { } } -/// Items of a panel's (≡) menu. Unimplemented Illustrator items are listed disabled. -pub fn panel_menu_items(app: &mut VectorcraftApp, ui: &mut Ui, id: &str) { +/// Items of a panel's (≡) menu. Unimplemented Illustrator items are listed disabled. False for a +/// panel without items of its own. +pub fn panel_menu_items(app: &mut VectorcraftApp, ui: &mut Ui, id: &str) -> bool { match id { "swatches" => swatches::menu(app, ui), "color" => color::menu(app, ui), @@ -152,10 +153,9 @@ pub fn panel_menu_items(app: &mut VectorcraftApp, ui: &mut Ui, id: &str) { links::ID => links::menu(app, ui), asset_export::ID => asset_export::menu(app, ui), css_properties::ID => css_properties::menu(app, ui), - _ => { - ui.add_enabled(false, egui::Button::new(tl!("No options")).frame(false)); - } + _ => return false, } + true } /// The ≡ panel-menu button drawn into `rect` (the right end of a panel's title/tab strip). @@ -167,7 +167,20 @@ pub fn panel_menu(app: &mut VectorcraftApp, ui: &mut Ui, id: &str, rect: Rect) { egui::Popup::menu(&resp).show(|ui| { crate::widgets::menu_scroll(ui, |ui| { ui.set_min_width(220.0); - panel_menu_items(app, ui, id); + if panel_menu_items(app, ui, id) { + ui.separator(); + } + // The panel floats out of the dock or goes back in, as dragging its tab does. + let (label, cmd) = if crate::floating::group_of(&app.ui, id).is_some() { + (tl!("Dock Panel"), "window.panel.dock") + } else { + (tl!("Float Panel"), "window.panel.float") + }; + if crate::widgets::menu_item(ui, label, true, false) + && let Err(e) = app.run(cmd, json!({ "panel": id })) + { + app.ui.status = e; + } }); }); } diff --git a/crates/ui-egui/src/panels/properties.rs b/crates/ui-egui/src/panels/properties.rs index 225d3660..49f07c5d 100644 --- a/crates/ui-egui/src/panels/properties.rs +++ b/crates/ui-egui/src/panels/properties.rs @@ -16,7 +16,7 @@ pub fn show(app: &mut VectorcraftApp, ui: &mut Ui) { return; }; let n_sel = st.selection.len(); - let anchor_mode = !st.selection.anchors.is_empty(); + let anchors = crate::chrome::anchor_controls(app); let first = first_selected(app); let label = match (&first, n_sel) { (None, _) => tl!("Document").to_string(), @@ -85,10 +85,10 @@ pub fn show(app: &mut VectorcraftApp, ui: &mut Ui) { } }); } - if anchor_mode { + if anchors != crate::chrome::AnchorControls::None { divider(ui); section_header(ui, tl!("Anchor Point")); - crate::chrome::anchor_buttons(app, ui); + crate::chrome::anchor_buttons(app, ui, anchors); } divider(ui); section_header(ui, tl!("Quick Actions")); diff --git a/crates/ui-egui/src/prefs_dialog.rs b/crates/ui-egui/src/prefs_dialog.rs index 3c706a5c..c638b1d3 100644 --- a/crates/ui-egui/src/prefs_dialog.rs +++ b/crates/ui-egui/src/prefs_dialog.rs @@ -6,7 +6,7 @@ use serde_json::{Map, Value, json}; use vectorcraft_engine::Prefs; -use vectorcraft_engine::cmd::prefscmds::{PREF_CATEGORIES, PREF_GROUPS, PREF_SPECS, PrefKind}; +use vectorcraft_engine::cmd::prefscmds::{GPU_PREFERENCES, PREF_CATEGORIES, PREF_GROUPS, PREF_SPECS, PrefKind}; use crate::state::Dialog; use crate::theme::{self, Brightness, Tokens}; @@ -69,6 +69,11 @@ pub fn restore(app: &mut VectorcraftApp) { { p.interface_language = code; } + // 0.5.0 saved its default, `powerSaving`, which Automatic replaced (#502): any value this + // version doesn't offer reads as the default, as the desktop app reads it at startup. + if !GPU_PREFERENCES.iter().any(|(v, _)| *v == p.gpu_preference) { + p.gpu_preference = Prefs::default().gpu_preference; + } app.session.apply_prefs(p); } @@ -454,8 +459,8 @@ mod tests { assert_eq!(a.session.prefs.ui_brightness, "light"); } - /// Performance › Graphics Processor (#306): shown with its restart note, applied by OK and - /// saved with the UI state under the key the desktop app reads before the window opens. + /// Performance › Graphics Processor (#306, #502): shown with its restart note, applied by OK + /// and saved with the UI state under the key the desktop app reads before the window opens. #[test] fn graphics_processor_preference_shows_and_persists() { fn texts(s: &egui::Shape, out: &mut Vec) { @@ -477,7 +482,7 @@ mod tests { let mut shown = vec![]; out.shapes.iter().for_each(|c| texts(&c.shape, &mut shown)); assert!(shown.iter().any(|t| t.starts_with("Graphics Processor")), "{shown:?}"); - assert!(shown.iter().any(|t| t == "Power Saving (integrated)"), "{shown:?}"); + assert!(shown.iter().any(|t| t == "Automatic"), "{shown:?}"); assert!(shown.iter().any(|t| t == "Applies the next time VectorCraft starts."), "{shown:?}"); a.ui.dialog.as_mut().unwrap().fields.insert("gpuPreference".into(), json!("highPerformance")); confirm(&mut a).unwrap(); @@ -514,6 +519,19 @@ mod tests { assert!(picas_in_use(d), "enabled with a unit in picas"); } + /// 0.5.0 saved `powerSaving` for everyone (its default): it reads as Automatic, while the + /// choices this version offers are kept (#502). + #[test] + fn a_graphics_processor_this_version_does_not_offer_reads_as_automatic() { + for (saved, read) in [("powerSaving", "automatic"), ("turbo", "automatic"), ("lowPower", "lowPower"), ("highPerformance", "highPerformance")] + { + let mut a = app(); + a.ui.engine_prefs = json!({"gpuPreference": saved}); + restore(&mut a); + assert_eq!(a.session.prefs.gpu_preference, read, "{saved}"); + } + } + #[test] fn every_category_renders_fields() { for c in PREF_CATEGORIES { diff --git a/crates/ui-egui/src/shortcuts.rs b/crates/ui-egui/src/shortcuts.rs index c4cb88f8..9b59f454 100644 --- a/crates/ui-egui/src/shortcuts.rs +++ b/crates/ui-egui/src/shortcuts.rs @@ -246,7 +246,7 @@ pub fn handle(app: &mut VectorcraftApp, ctx: &egui::Context) { // Enter with a selection tool opens the Move dialog, as a double-click on its button // does. let tool = app.session.tool_id(); - if app.ui.dialog.is_none() && crate::canvas::is_selection_tool(tool) { + if app.ui.dialog.is_none() && vectorcraft_tools::catalog::is_selection_tool(tool) { // Nothing selected: it fails and nothing opens (the menu item is disabled then too). let _ = crate::toolbar::open_options(app, tool); } diff --git a/crates/ui-egui/src/state.rs b/crates/ui-egui/src/state.rs index 14f5919a..e81b8cd9 100644 --- a/crates/ui-egui/src/state.rs +++ b/crates/ui-egui/src/state.rs @@ -268,6 +268,13 @@ pub struct UiState { /// Tool flyouts torn off the toolbar into floating panels. #[serde(default)] pub floating_flyouts: Vec, + /// Panels dragged out of the dock: each group floats as its own stack of tabs. + #[serde(default)] + pub floating_panels: Vec, + /// The Tools panel floats with its top-left corner here (dragged out by its title bar); `None`: + /// docked at the window's left edge. + #[serde(default)] + pub toolbar_pos: Option<[f32; 2]>, pub status_bar: bool, pub dock: bool, pub view: ViewFlags, @@ -276,9 +283,6 @@ pub struct UiState { pub flyout: Option, /// Last tool shown for each toolbar group (flyout selection sticks). pub group_tool: Vec, - /// The selection tool used last (Selection, Direct Selection or Group Selection): a Cmd press - /// with any other tool drags with it. - pub last_selection_tool: String, pub status: String, pub palette_open: bool, pub palette_query: String, @@ -411,6 +415,34 @@ pub struct TaskBarPlace { pub offset: Option<(u64, egui::Vec2)>, } +/// A group of panels dragged out of the dock: it floats as a stack of tabs, one panel shown. +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +pub struct FloatingPanels { + /// Panel ids (`window.panel`), in tab order. + pub panels: Vec, + /// The tab shown. + #[serde(default)] + pub active: usize, + /// Top-left corner in screen points. + pub pos: [f32; 2], +} + +impl FloatingPanels { + /// Keep known panels, each in one group, drop the groups left empty and the toolbar position + /// that isn't a number (a hand-edited preferences file or workspace). + pub fn sanitize(groups: &mut Vec, toolbar_pos: &mut Option<[f32; 2]>) { + let mut seen = std::collections::BTreeSet::new(); + groups.retain_mut(|g| { + g.panels.retain(|id| all_panels().any(|(p, _)| p == id) && seen.insert(id.clone())); + g.active = g.active.min(g.panels.len().saturating_sub(1)); + !g.panels.is_empty() + }); + if toolbar_pos.is_some_and(|p| !p.iter().all(|v| v.is_finite())) { + *toolbar_pos = None; + } + } +} + impl UiState { /// Clear transient state after loading saved preferences. pub fn sanitized(mut self) -> Self { @@ -429,6 +461,7 @@ impl UiState { f.tools.retain(|id| vectorcraft_tools::tool_info(id).is_some()); f.tools.first().is_some_and(|k| seen.insert(k.clone())) }); + FloatingPanels::sanitize(&mut self.floating_panels, &mut self.toolbar_pos); // Overrides that can't fire (modifier-only chords recorded by older versions, #487) give // the default back. self.shortcut_overrides.retain(|_, c| c.is_empty() || crate::shortcut_editor::normalize(c).is_some()); @@ -452,13 +485,14 @@ impl Default for UiState { task_bar_place: TaskBarPlace::default(), slot_tool: Default::default(), floating_flyouts: vec![], + floating_panels: vec![], + toolbar_pos: None, status_bar: true, dock: true, view: ViewFlags::default(), dialog: None, flyout: None, group_tool: vectorcraft_tools::TOOL_GROUPS.iter().map(|g| g[0].id.to_string()).collect(), - last_selection_tool: "selection".into(), status: String::new(), palette_open: false, palette_query: String::new(), diff --git a/crates/ui-egui/src/sysclip.rs b/crates/ui-egui/src/sysclip.rs index a63cd5df..aefd3b86 100644 --- a/crates/ui-egui/src/sysclip.rs +++ b/crates/ui-egui/src/sysclip.rs @@ -24,6 +24,11 @@ pub trait SystemClipboard { fn has(&mut self, mimes: &[&'static str]) -> bool; } +/// Makes a second system-clipboard handle, to check off the UI thread whether Paste has something +/// to take ([`Services::clipboard_probe`](crate::Services::clipboard_probe)). It is called on that +/// thread and the handle lives and dies there, so the handle needn't be `Send`. +pub type ClipboardProbeFactory = Box Box + Send>; + /// The command (and its params) that loads `f` into the internal clipboard, centred on `center`. pub(crate) fn import_command(f: &Flavour, center: Option<[f64; 2]>) -> (&'static str, Value) { let b64 = || vectorcraft_format::base64_encode(&f.data); diff --git a/crates/ui-egui/src/tests_removeanchors.rs b/crates/ui-egui/src/tests_removeanchors.rs index 64e7e6df..0baee6c3 100644 --- a/crates/ui-egui/src/tests_removeanchors.rs +++ b/crates/ui-egui/src/tests_removeanchors.rs @@ -205,3 +205,26 @@ fn the_control_bar_converts_connects_and_cuts_selected_anchors() { assert!(app.session.active().unwrap().doc.node(id).unwrap().path_data().unwrap().subpaths[0].closed); assert_eq!(anchor_count(&app, id), 4, "the coincident ends merge"); } + +/// #504: with a tool that edits anchors (Direct Selection, the Pen…), a path selected as a whole +/// shows all its anchors selected, and the Control bar and the Properties panel offer to convert +/// them; removing and cutting wait for anchors direct-selected. The Selection tool shows neither. +#[test] +fn a_whole_path_converts_with_the_tools_that_edit_anchors() { + let mut app = app(); + let id = rect(&mut app); + let ctx = egui::Context::default(); + crate::theme::install_fonts(&ctx); + app.select_tool("selection"); + assert!(!has(&control_frame(&mut app, &ctx, vec![]), "Convert:")); + for tool in ["directSelection", "pen"] { + app.select_tool(tool); + let texts = control_frame(&mut app, &ctx, vec![]); + assert!(has(&texts, "Convert:") && !has(&texts, "Anchors:"), "{tool}: {texts:?}"); + let props = crate::tests_labels::painted_text(&mut app, crate::panels::properties::show); + assert!(props.contains("Convert:") && !props.contains("Anchors:"), "{tool}: {props}"); + } + click_button(&mut app, &ctx, "Convert:", 1); + let sp = app.session.active().unwrap().doc.node(id).unwrap().path_data().unwrap().subpaths[0].clone(); + assert!(sp.anchors.iter().all(|a| a.has_in() && a.has_out()), "every corner made smooth: {sp:?}"); +} diff --git a/crates/ui-egui/src/tests_sysclip.rs b/crates/ui-egui/src/tests_sysclip.rs index 854d6a49..3b793843 100644 --- a/crates/ui-egui/src/tests_sysclip.rs +++ b/crates/ui-egui/src/tests_sysclip.rs @@ -66,7 +66,7 @@ pub(super) fn run(app: &mut VectorcraftApp, id: &str, p: Value) -> Value { app.run(id, p).unwrap_or_else(|e| panic!("{id}: {e}")) } -fn copy_rect(app: &mut VectorcraftApp) { +pub(super) fn copy_rect(app: &mut VectorcraftApp) { let id = run(app, "shape.rectangle", json!({"x": 10, "y": 10, "width": 40, "height": 20}))["id"].clone(); run(app, "paint.setFill", json!({"color": "#ff0000"})); run(app, "select.set", json!({"ids": [id]})); diff --git a/crates/ui-egui/src/tests_sysclip_probe.rs b/crates/ui-egui/src/tests_sysclip_probe.rs new file mode 100644 index 00000000..e09ba3a0 --- /dev/null +++ b/crates/ui-egui/src/tests_sysclip_probe.rs @@ -0,0 +1,156 @@ +//! The system clipboard is checked for Paste off the UI thread where the host installs a probe +//! (Linux): an X11 clipboard owner that never answers used to block the frame loop for seconds, so +//! the window stopped drawing and could not even be closed. The in-line check (no probe: the web, +//! Windows, macOS) is covered by `tests_clipboard` and `tests_sysclip`. + +use std::sync::atomic::{AtomicUsize, Ordering}; +use std::sync::{Arc, Mutex}; +use std::time::{Duration, Instant}; + +use serde_json::json; +use vectorcraft_engine::Session; +use vectorcraft_engine::cmd::clipboard::Flavour; + +use crate::tests_sysclip::{copy_rect, run}; +use crate::{Services, SystemClipboard, VectorcraftApp, menus}; + +/// What the clipboard handles saw: the thread each `has()` ran on, and how many handles are alive. +#[derive(Default)] +struct Recorder { + threads: Mutex>>, + alive: AtomicUsize, +} + +impl Recorder { + fn looks(&self) -> usize { + self.threads.lock().unwrap().len() + } +} + +/// A system clipboard whose `has()` takes `delay` (an owner slow to answer) and answers `verdict`, +/// or panics without one (a bug in the platform code). +struct Slow { + rec: Arc, + delay: Duration, + verdict: Option, +} + +impl Slow { + fn boxed(rec: &Arc, delay: Duration, verdict: Option) -> Box { + rec.alive.fetch_add(1, Ordering::SeqCst); + Box::new(Self { rec: Arc::clone(rec), delay, verdict }) + } +} + +impl Drop for Slow { + fn drop(&mut self) { + self.rec.alive.fetch_sub(1, Ordering::SeqCst); + } +} + +impl SystemClipboard for Slow { + fn write(&mut self, _flavours: &[Flavour]) -> Result<(), String> { + Ok(()) + } + fn holds_ours(&mut self) -> bool { + false + } + fn read(&mut self, _mimes: &[&'static str]) -> Option { + None + } + fn has(&mut self, _mimes: &[&'static str]) -> bool { + self.rec.threads.lock().unwrap().push(std::thread::current().name().map(str::to_owned)); + std::thread::sleep(self.delay); + self.verdict.expect("the clipboard failed") + } +} + +/// An app whose two clipboard handles record into `rec`: the UI's says `inline`, the probe's +/// `probe`, each after `delay`. +fn app(rec: &Arc, delay: Duration, inline: bool, probe: Option) -> VectorcraftApp { + let make = { + let rec = Arc::clone(rec); + move || Slow::boxed(&rec, delay, probe) + }; + let services = + Services { system_clipboard: Some(Slow::boxed(rec, delay, Some(inline))), clipboard_probe: Some(Box::new(make)), ..Default::default() }; + VectorcraftApp::new(Session::new(), services) +} + +/// One headless frame of app logic in the test's one context (a new one would restart the fonts), +/// half a second after the last: past the in-line check's throttle, so it would run every frame. +fn frame(app: &mut VectorcraftApp) { + thread_local! { + static CTX: egui::Context = egui::Context::default(); + static NOW: std::cell::Cell = const { std::cell::Cell::new(0.0) }; + } + let time = NOW.with(|t| { + t.set(t.get() + 0.5); + t.get() + }); + let input = egui::RawInput { time: Some(time), ..Default::default() }; + CTX.with(|ctx| ctx.run_ui(input, |ui| app.logic(ui.ctx())).textures_delta.clear()); +} + +/// Frames for `wait`, or until `done` holds; whether it does. +fn frames_until(app: &mut VectorcraftApp, wait: Duration, done: impl Fn(&VectorcraftApp) -> bool) -> bool { + let end = Instant::now() + wait; + loop { + frame(app); + if done(app) || Instant::now() > end { + return done(app); + } + std::thread::sleep(Duration::from_millis(5)); + } +} + +#[test] +fn a_slow_clipboard_is_read_off_the_ui_thread() { + let rec = Arc::new(Recorder::default()); + let mut app = app(&rec, Duration::from_secs(1), false, Some(true)); + // The first frames install the UI fonts. Without a document Paste is off whatever the clipboard + // holds: nobody looks. + assert!(!frames_until(&mut app, Duration::from_millis(100), |_| rec.looks() > 0)); + run(&mut app, "file.new", json!({"width": 100, "height": 100})); + frame(&mut app); + let t0 = Instant::now(); + frame(&mut app); + assert!(t0.elapsed() < Duration::from_millis(300), "the frame waited on the clipboard: {:?}", t0.elapsed()); + // The probe's verdict (the UI's own handle would say no) enables Paste once it arrives. + assert!(frames_until(&mut app, Duration::from_secs(3), |app| app.system_paste), "the probe's verdict never arrived"); + assert!(menus::enabled(&app, "edit.paste")); + let threads = rec.threads.lock().unwrap().clone(); + assert!(threads.iter().all(|n| n.as_deref() == Some("vectorcraft-clip")), "checked on: {threads:?}"); +} + +#[test] +fn the_probe_rests_after_a_copy_and_stops_with_the_app() { + let rec = Arc::new(Recorder::default()); + let mut app = app(&rec, Duration::ZERO, false, Some(true)); + run(&mut app, "file.new", json!({"width": 100, "height": 100})); + assert!(frames_until(&mut app, Duration::from_secs(2), |app| app.system_paste)); + // Something copied in the app enables Paste alone: the clipboard isn't read any more. + copy_rect(&mut app); + frames_until(&mut app, Duration::from_millis(50), |_| false); + let looks = rec.looks(); + frames_until(&mut app, Duration::from_millis(600), |_| false); + assert_eq!(rec.looks(), looks); + assert!(!app.system_paste && menus::enabled(&app, "edit.paste")); + // Quitting waits until the probe's thread has let go of its handle: on X11 the last handle + // alive hands what the app copied to the clipboard manager. + assert_eq!(rec.alive.load(Ordering::SeqCst), 2); + drop(app); + assert_eq!(rec.alive.load(Ordering::SeqCst), 0, "the probe's thread kept its clipboard"); +} + +#[test] +fn without_its_thread_the_check_runs_in_line_again() { + let rec = Arc::new(Recorder::default()); + // The probe's clipboard panics: its thread ends. + let mut app = app(&rec, Duration::ZERO, true, None); + run(&mut app, "file.new", json!({"width": 100, "height": 100})); + assert!(frames_until(&mut app, Duration::from_secs(2), |app| app.system_paste), "no fallback"); + assert!(app.clipboard_probe.is_none()); + let threads = rec.threads.lock().unwrap().clone(); + assert_eq!(threads.first().cloned().flatten().as_deref(), Some("vectorcraft-clip"), "{threads:?}"); +} diff --git a/crates/ui-egui/src/toolbar.rs b/crates/ui-egui/src/toolbar.rs index de28b9b6..0f927167 100644 --- a/crates/ui-egui/src/toolbar.rs +++ b/crates/ui-egui/src/toolbar.rs @@ -89,148 +89,170 @@ pub fn remember(app: &mut VectorcraftApp, id: &str) { pub fn show(app: &mut VectorcraftApp, ui: &mut Ui) { let t = Tokens::get(ui.ctx()); - let all = slots(app); // The user's choice alone: a window too short for the tools scrolls them. let cols = if app.ui.toolbar_double { 2 } else { 1 }; let w = if cols == 2 { 76.0 } else { WIDTH }; - egui::Panel::left("toolbar") - .resizable(false) - .exact_size(w) - .frame(egui::Frame::NONE.fill(t.panel).inner_margin(egui::Margin { left: 0, right: 0, top: 0, bottom: 4 }).stroke(Stroke::new(1.5, t.border))) - .show(ui, |ui| { - ui.spacing_mut().item_spacing = vec2(0.0, 0.0); - // Dock header with » and a grip strip. - let (hdr, hresp) = ui.allocate_exact_size(vec2(ui.available_width(), 14.0), Sense::click()); - ui.painter().rect_filled(hdr, 0.0, t.tab_strip); - icons::paint( - ui, - if cols == 2 { "chevrons-left" } else { "chevrons-right" }, - egui::Rect::from_min_size(hdr.left_top() + vec2(3.0, 2.0), vec2(10.0, 10.0)), - if hresp.hovered() { t.text_strong } else { t.text }, - ); - if hresp.on_hover_text(tl!("Toggle single/double column")).clicked() - // It only fails on bad params, which this never sends; show it all the same. - && let Err(e) = app.run("window.toolbarColumns", json!({ "double": cols == 1 })) - { - app.ui.status = e; - } - let (grip, _) = ui.allocate_exact_size(vec2(ui.available_width(), 6.0), Sense::hover()); - for k in 0..6 { - ui.painter().line_segment( - [pos2(grip.center().x - 9.0, grip.top() + 1.5 + k as f32 * 0.6), pos2(grip.center().x + 9.0, grip.top() + 1.5 + k as f32 * 0.6)], - Stroke::new(0.4, t.text_disabled), - ); - } - // The tools and the controls under them scroll in a window too short for them. - widgets::strip_scroll(ui, "toolbar", |ui| { - let active = app.session.tool_id(); - // The tool button whose long press opened its flyout, until the next press. - let held_id = egui::Id::new("toolbar-held"); - if ui.input(|inp| inp.pointer.any_pressed()) { - ui.data_mut(|d| d.remove::(held_id)); - } - let held: Option = ui.data(|d| d.get_temp(held_id)); - let mut open_flyout: Option<(Vec<&'static str>, egui::Rect)> = None; - // A group torn off into a floating flyout is raised instead of opening its flyout. - let mut raise: Option<&'static str> = None; - let mut i = 0; - while i < all.len() { - if let Some(cat) = all[i].0 { - let (r, _) = ui.allocate_exact_size(vec2(ui.available_width(), 18.0), Sense::hover()); - // A long name is cut to its first four characters in the single column. - let cat = tl!(cat); - let label = if cols == 1 && cat.chars().count() > 6 { - format!("{}...", cat.chars().take(4).collect::()) - } else { - cat.to_string() - }; - ui.painter().text(r.center() + vec2(0.0, 2.0), egui::Align2::CENTER_CENTER, label, egui::FontId::proportional(11.0), t.text); - } - // One row = `cols` slots (a category label always starts a new row). - let mut row = vec![i]; - while row.len() < cols && i + row.len() < all.len() && all[i + row.len()].0.is_none() { - row.push(i + row.len()); - } - ui.horizontal(|ui| { - ui.spacing_mut().item_spacing.x = 0.0; - if cols == 1 { - ui.add_space((WIDTH - 36.0) / 2.0); - } else { - ui.add_space(2.0); - } - for &k in &row { - let slot = &all[k].1; - let shown_id = if slot.contains(&active) { - active.to_string() - } else { - app.ui.slot_tool.get(slot[0]).cloned().unwrap_or_else(|| slot[0].to_string()) - }; - let Some(shown) = tool_info(&shown_id).or_else(|| tool_info(slot[0])) else { continue }; - let is_active = slot.contains(&active); - let (rect, resp) = ui.allocate_exact_size(vec2(36.0, PITCH - 1.0), Sense::click_and_drag()); - let well = egui::Rect::from_center_size(rect.center(), vec2(35.5, 27.5)); - if is_active { - ui.painter().rect_filled(well, CornerRadius::same(1), t.tool_active); - } else if resp.hovered() { - ui.painter().rect_filled(well, CornerRadius::same(1), t.hover); - } - let ir = egui::Rect::from_center_size(rect.center(), vec2(18.0, 18.0)); - icons::paint(ui, icons::tool_icon(shown.icon), ir, if is_active { t.text_strong } else { t.icon }); - if slot.len() > 1 { - let c = rect.center() + vec2(12.5, 10.0); - ui.painter().add(egui::Shape::convex_polygon( - vec![c, c + vec2(-3.5, 0.0), c + vec2(0.0, -3.5)], - t.icon, - Stroke::NONE, - )); - } - let press = if slot.len() > 1 { flyout_press(ui, &resp, rect) } else { None }; - let alt = ui.input(|inp| inp.modifiers.alt); - if press.is_some() { - if is_floating(app, slot[0]) { - raise = Some(slot[0]); - } else { - open_flyout = Some((slot.clone(), rect)); - } - if press == Some(FlyoutPress::Primary) { - ui.data_mut(|d| d.insert_temp(held_id, resp.id)); - } - } else if resp.clicked() && held == Some(resp.id) { - // Releasing the long press that opened the flyout leaves it open. - } else if resp.clicked() && alt && slot.len() > 1 { - let idx = slot.iter().position(|x| *x == shown.id).unwrap_or(0); - app.select_tool(slot[(idx + 1) % slot.len()]); - } else if resp.double_clicked() { - app.select_tool(shown.id); - app.run("tool.options", json!({ "tool": shown.id })).ok(); - } else if resp.clicked() { - app.select_tool(shown.id); - } - resp.on_hover_text(tip(shown)); - } - }); - i += row.len(); - } - if let Some(key) = raise { - raise_floating(ui.ctx(), key); - } - if let Some((slot, rect)) = open_flyout { - app.ui.flyout = Some(0); - ui.data_mut(|d| { - d.insert_temp(egui::Id::new("flyout-anchor"), rect); - d.insert_temp(egui::Id::new("flyout-tools"), slot.iter().map(|s| s.to_string()).collect::>()); - }); - } - ui.add_space(8.0); - bottom_controls(app, ui, &t); + // Where the panel docks: along the window's left edge, under the bars. + let edge = ui.available_rect_before_wrap(); + ui.ctx().data_mut(|d| d.insert_temp(crate::floating::tools_zone_id(), egui::Rect::from_min_size(edge.min, vec2(WIDTH, edge.height())))); + let frame = + egui::Frame::NONE.fill(t.panel).inner_margin(egui::Margin { left: 0, right: 0, top: 0, bottom: 4 }).stroke(Stroke::new(1.5, t.border)); + match app.ui.toolbar_pos { + None => { + egui::Panel::left("toolbar").resizable(false).exact_size(w).frame(frame).show(ui, |ui| body(app, ui, cols, None)); + } + Some(pos) => { + // Floating, kept inside the window, its tools scrolling when they don't fit under it. + let ctx = ui.ctx().clone(); + let id = egui::Id::new("toolbar-floating"); + let screen = ctx.content_rect(); + // Kept on screen by its title bar and first tools: the rest scrolls. + let size = ctx.memory(|m| m.area_rect(id)).map_or(vec2(w, 160.0), |r| vec2(r.width(), r.height().min(160.0))); + let at = crate::floating::clamp(pos, size, screen); + egui::Area::new(id).order(egui::Order::Middle).fixed_pos(at).show(&ctx, |ui| { + flyout_frame(&t, false).inner_margin(egui::Margin { left: 0, right: 0, top: 0, bottom: 4 }).show(ui, |ui| { + ui.set_width(w); + ui.set_max_height(screen.bottom() - at.y - 12.0); + body(app, ui, cols, Some(at)); + }); }); - }); + } + } // Before the flyout: one torn off this frame floats from the next (its bar mustn't be in two // layers in one frame). floating(app, ui.ctx()); flyout(app, ui.ctx()); } +/// The Tools panel's contents, docked or floating at `floating`. +fn body(app: &mut VectorcraftApp, ui: &mut Ui, cols: usize, floating: Option) { + let t = Tokens::get(ui.ctx()); + let all = slots(app); + let bounds = ui.max_rect(); + ui.spacing_mut().item_spacing = vec2(0.0, 0.0); + // Title bar with » and a grip strip: a drag on either floats the panel or moves it. + let (hdr, hresp) = ui.allocate_exact_size(vec2(ui.available_width(), 14.0), Sense::click_and_drag()); + ui.painter().rect_filled(hdr, 0.0, t.tab_strip); + icons::paint( + ui, + if cols == 2 { "chevrons-left" } else { "chevrons-right" }, + egui::Rect::from_min_size(hdr.left_top() + vec2(3.0, 2.0), vec2(10.0, 10.0)), + if hresp.hovered() { t.text_strong } else { t.text }, + ); + let (grip, gresp) = ui.allocate_exact_size(vec2(ui.available_width(), 6.0), Sense::drag()); + for k in 0..6 { + ui.painter().line_segment( + [pos2(grip.center().x - 9.0, grip.top() + 1.5 + k as f32 * 0.6), pos2(grip.center().x + 9.0, grip.top() + 1.5 + k as f32 * 0.6)], + Stroke::new(0.4, t.text_disabled), + ); + } + crate::floating::drag_tools(app, ui.ctx(), &hresp.union(gresp.clone()), bounds, floating); + if hresp.on_hover_text(tl!("Toggle single/double column")).clicked() + // It only fails on bad params, which this never sends; show it all the same. + && let Err(e) = app.run("window.toolbarColumns", json!({ "double": cols == 1 })) + { + app.ui.status = e; + } + let grip_tip = if floating.is_some() { tl!("Drag to the window's left edge to dock") } else { tl!("Drag to float the toolbar") }; + gresp.on_hover_cursor(egui::CursorIcon::Grab).on_hover_text(grip_tip); + // The tools and the controls under them scroll in a window too short for them. + widgets::strip_scroll(ui, "toolbar", |ui| { + let active = app.session.tool_id(); + // The tool button whose long press opened its flyout, until the next press. + let held_id = egui::Id::new("toolbar-held"); + if ui.input(|inp| inp.pointer.any_pressed()) { + ui.data_mut(|d| d.remove::(held_id)); + } + let held: Option = ui.data(|d| d.get_temp(held_id)); + let mut open_flyout: Option<(Vec<&'static str>, egui::Rect)> = None; + // A group torn off into a floating flyout is raised instead of opening its flyout. + let mut raise: Option<&'static str> = None; + let mut i = 0; + while i < all.len() { + if let Some(cat) = all[i].0 { + let (r, _) = ui.allocate_exact_size(vec2(ui.available_width(), 18.0), Sense::hover()); + // A long name is cut to its first four characters in the single column. + let cat = tl!(cat); + let label = + if cols == 1 && cat.chars().count() > 6 { format!("{}...", cat.chars().take(4).collect::()) } else { cat.to_string() }; + ui.painter().text(r.center() + vec2(0.0, 2.0), egui::Align2::CENTER_CENTER, label, egui::FontId::proportional(11.0), t.text); + } + // One row = `cols` slots (a category label always starts a new row). + let mut row = vec![i]; + while row.len() < cols && i + row.len() < all.len() && all[i + row.len()].0.is_none() { + row.push(i + row.len()); + } + ui.horizontal(|ui| { + ui.spacing_mut().item_spacing.x = 0.0; + if cols == 1 { + ui.add_space((WIDTH - 36.0) / 2.0); + } else { + ui.add_space(2.0); + } + for &k in &row { + let slot = &all[k].1; + let shown_id = if slot.contains(&active) { + active.to_string() + } else { + app.ui.slot_tool.get(slot[0]).cloned().unwrap_or_else(|| slot[0].to_string()) + }; + let Some(shown) = tool_info(&shown_id).or_else(|| tool_info(slot[0])) else { continue }; + let is_active = slot.contains(&active); + let (rect, resp) = ui.allocate_exact_size(vec2(36.0, PITCH - 1.0), Sense::click_and_drag()); + let well = egui::Rect::from_center_size(rect.center(), vec2(35.5, 27.5)); + if is_active { + ui.painter().rect_filled(well, CornerRadius::same(1), t.tool_active); + } else if resp.hovered() { + ui.painter().rect_filled(well, CornerRadius::same(1), t.hover); + } + let ir = egui::Rect::from_center_size(rect.center(), vec2(18.0, 18.0)); + icons::paint(ui, icons::tool_icon(shown.icon), ir, if is_active { t.text_strong } else { t.icon }); + if slot.len() > 1 { + let c = rect.center() + vec2(12.5, 10.0); + ui.painter().add(egui::Shape::convex_polygon(vec![c, c + vec2(-3.5, 0.0), c + vec2(0.0, -3.5)], t.icon, Stroke::NONE)); + } + let press = if slot.len() > 1 { flyout_press(ui, &resp, rect) } else { None }; + let alt = ui.input(|inp| inp.modifiers.alt); + if press.is_some() { + if is_floating(app, slot[0]) { + raise = Some(slot[0]); + } else { + open_flyout = Some((slot.clone(), rect)); + } + if press == Some(FlyoutPress::Primary) { + ui.data_mut(|d| d.insert_temp(held_id, resp.id)); + } + } else if resp.clicked() && held == Some(resp.id) { + // Releasing the long press that opened the flyout leaves it open. + } else if resp.clicked() && alt && slot.len() > 1 { + let idx = slot.iter().position(|x| *x == shown.id).unwrap_or(0); + app.select_tool(slot[(idx + 1) % slot.len()]); + } else if resp.double_clicked() { + app.select_tool(shown.id); + app.run("tool.options", json!({ "tool": shown.id })).ok(); + } else if resp.clicked() { + app.select_tool(shown.id); + } + resp.on_hover_text(tip(shown)); + } + }); + i += row.len(); + } + if let Some(key) = raise { + raise_floating(ui.ctx(), key); + } + if let Some((slot, rect)) = open_flyout { + app.ui.flyout = Some(0); + ui.data_mut(|d| { + d.insert_temp(egui::Id::new("flyout-anchor"), rect); + d.insert_temp(egui::Id::new("flyout-tools"), slot.iter().map(|s| s.to_string()).collect::>()); + }); + } + ui.add_space(8.0); + bottom_controls(app, ui, &t); + }); +} + /// How a press on a tool group's button opens its flyout. #[derive(Clone, Copy, PartialEq, Eq, Debug)] enum FlyoutPress { @@ -278,7 +300,7 @@ pub fn open_options(app: &mut VectorcraftApp, tool: &str) -> Result app.run("view.fitArtboard", json!({})), "zoom" => app.run("view.actualSize", json!({})), "rotate" | "scale" | "reflect" | "shear" | "selection" | "directSelection" | "groupSelection" => { - let dialog = if crate::canvas::is_selection_tool(tool) { "move" } else { tool }; + let dialog = if vectorcraft_tools::catalog::is_selection_tool(tool) { "move" } else { tool }; let id = format!("object.{dialog}"); if let Some(c) = vectorcraft_engine::find_command(&id) { (c.enabled)(&app.session)?; @@ -631,9 +653,7 @@ fn floating(app: &mut VectorcraftApp, ctx: &egui::Context) { } // Kept on screen (a smaller window, or a position saved on a bigger one). let size = ctx.memory(|m| m.area_rect(id)).map_or(vec2(strip_width(&f.tools), PITCH), |r| r.size()); - let [x, y] = f.pos; - let (x, y) = if x.is_finite() && y.is_finite() { (x, y) } else { (screen.left() + 60.0, screen.top() + 100.0) }; - let pos = pos2(x.min(screen.right() - size.x).max(screen.left()), y.min(screen.bottom() - size.y).max(screen.top())); + let pos = crate::floating::clamp(f.pos, size, screen); let mut input = FlyoutInput::default(); egui::Area::new(id).order(egui::Order::Middle).fixed_pos(pos).show(ctx, |ui| { flyout_frame(&t, flash).show(ui, |ui| input = flyout_body(ui, &t, active, &f.tools, true)); diff --git a/crates/ui-egui/src/widgets.rs b/crates/ui-egui/src/widgets.rs index a54a2965..8c007656 100644 --- a/crates/ui-egui/src/widgets.rs +++ b/crates/ui-egui/src/widgets.rs @@ -9,8 +9,15 @@ use crate::{icons, scrub}; /// Square icon button; `selected` draws the pressed well. pub fn icon_button(ui: &mut Ui, icon: &str, tip: &str, selected: bool, size: f32) -> Response { + let (_, resp) = ui.allocate_exact_size(Vec2::splat(size), Sense::click()); + paint_icon_button(ui, resp, icon, tip, selected) +} + +/// [`icon_button`] drawn for a response the caller made (its own id or sense). +pub fn paint_icon_button(ui: &mut Ui, resp: Response, icon: &str, tip: &str, selected: bool) -> Response { let t = Tokens::get(ui.ctx()); - let (rect, resp) = ui.allocate_exact_size(Vec2::splat(size), Sense::click()); + let rect = resp.rect; + let size = rect.width(); let bg = if selected { t.tool_active } else if resp.hovered() { diff --git a/crates/ui-egui/src/workspaces.rs b/crates/ui-egui/src/workspaces.rs index 3a9af4fa..6e7fd1c9 100644 --- a/crates/ui-egui/src/workspaces.rs +++ b/crates/ui-egui/src/workspaces.rs @@ -7,7 +7,7 @@ use std::sync::atomic::Ordering; use serde::{Deserialize, Serialize}; use serde_json::{Value, json}; -use crate::state::{Dialog, DockTab, FloatingFlyout, UiState}; +use crate::state::{Dialog, DockTab, FloatingFlyout, FloatingPanels, UiState}; use crate::theme::Tokens; use crate::{VectorcraftApp, widgets}; @@ -29,6 +29,10 @@ pub struct Workspace { pub status_bar: bool, /// Tool groups torn off the toolbar into floating strips (built-in workspaces: none). pub floating_flyouts: Vec, + /// Panels dragged out of the dock, where they float (built-in workspaces: none). + pub floating_panels: Vec, + /// Where the Tools panel floats (built-in workspaces: docked). + pub toolbar_pos: Option<[f32; 2]>, } impl Default for Workspace { @@ -123,6 +127,8 @@ pub fn capture(ui: &UiState, name: &str) -> Workspace { open_panel: ui.open_panel.clone(), status_bar: ui.status_bar, floating_flyouts: ui.floating_flyouts.clone(), + floating_panels: ui.floating_panels.clone(), + toolbar_pos: ui.toolbar_pos, } } @@ -140,6 +146,9 @@ pub fn apply(ui: &mut UiState, w: &Workspace) { ui.open_panel = w.open_panel.clone(); ui.status_bar = w.status_bar; ui.floating_flyouts = w.floating_flyouts.clone(); + ui.floating_panels = w.floating_panels.clone(); + ui.toolbar_pos = w.toolbar_pos; + FloatingPanels::sanitize(&mut ui.floating_panels, &mut ui.toolbar_pos); ui.flyout = None; ui.workspace = w.name.clone(); } diff --git a/docs/control-protocol.md b/docs/control-protocol.md index 25d66011..3844c82f 100644 --- a/docs/control-protocol.md +++ b/docs/control-protocol.md @@ -22,7 +22,7 @@ so only enable it while you use it. Transport: `apps/vectorcraft/src/control_ser | `ui.menu.list` / `ui.menu.invoke` | `{command, params}` | the full menu tree / invoke an item | | `ui.contextMenu.list` | | the canvas context menu for the current selection, flattened like `ui.menu.list` (`path` holds its submenus). `ui.click {x, y, button: "right"}` on the canvas opens it, after selecting the object there unless it is already selected | | `ui.tool.select` / `ui.tool.list` | `{tool}` | | -| `ui.pointer` | `{events:[{kind: down|drag|up|move|doubleclick, x, y, space?: "doc"|"screen", mods?}]}` | drive the active tool exactly like the mouse | +| `ui.pointer` | `{events:[{kind: down|drag|up|move|doubleclick, x, y, space?: "doc"|"screen", mods?}]}` | drive the active tool exactly like the mouse: `mods.cmd` held at a press with any tool but a selection tool drags with the selection tool chosen last (Direct Selection with the Pen until one is), and the release gives the tool back as it was | | `ui.key` / `ui.text` | `{key, shift?, alt?, cmd?}` / `{text}` | synthetic keyboard input | | `ui.wheel` | `{x, y, dy?, dx?, unit?: "line"\|"point", shift?, alt?, cmd?}` | a mouse wheel turn over screen point (x, y): `dy` notches up (+) or down, `dx` sideways. Over the canvas the wheel scrolls and Cmd- or Alt-wheel (Option on the Mac) zooms about the pointer; with the `zoomWithMouseWheel` preference the wheel and Alt-wheel zoom about the pointer, Shift-wheel scrolls up and down and Cmd-wheel (Ctrl on Windows and Linux) sideways. Over a focused numeric field (click it first) each notch steps its value as Up/Down do (Shift: ten, Cmd/Ctrl: a tenth) and the panel stays put; over anything else in a panel the wheel scrolls it | | `ui.set` | `{brightness?, panel?, rulers?, outline?, grid?, smartGuides?, boundingBox?, controlBar?}` | | @@ -214,6 +214,20 @@ Bar Position (`window.taskBar.reset`), which unpins it and puts it back under th Panel. As in Illustrator, neither the position nor the pin is saved: each launch starts with the bar under the selection. +Floating panels: dragging a dock tab, a panel icon or a popped-out panel's title out of the dock floats that panel +inside the window, and the strip right of the dock's tabs floats the whole Properties | Layers | Libraries group. A +floating group moves by its title bar (or the strip right of its tabs); a tab dragged out of it floats on its own; +dropped on another group's title bar or tabs it stacks with that group, and dropped on the dock (lit up while the +pointer is over it) or closed with its × its panels go back to the tabbed group or the icon column. +`window.panel.float {panel, x?, y?, onto?, group?}` floats a panel (with `group`, its whole group) with its top-left +corner at `x`, `y` (window points; default cascaded), or stacks it with the floating group holding `onto`; +`window.panel.dock {panel, group?}` puts it back. `panel` takes the `window.panel` ids and labels, and `"tools"` for +the Tools panel, which floats by its title bar and docks on the window's left edge. `window.panel` on a floating +panel shows its tab. `ui.floating_panels` in `ui.inspect` lists the groups (panel ids, the index of the tab shown, +the top-left corner) and `ui.toolbar_pos` the Tools panel's corner (null: docked); both are saved with the +preferences and in user workspaces (the built-in workspaces dock everything), and a corner saved on a bigger window +is clamped into this one when drawn. Floating panels stay inside the app window (no separate OS windows). + Flatten Transparency: `ui.flattenTransparencyDialog` opens the `flattenTransparency` dialog for the selection (fields `preset`: a preset name, setting it loads that preset's options; the option keys of `object.flattenTransparency`: `balance` 0–100, `lineArtPpi` and `gradientPpi` 1–2400, `textToOutlines`, diff --git a/docs/development.md b/docs/development.md index a8d5fe70..5f9487af 100644 --- a/docs/development.md +++ b/docs/development.md @@ -36,10 +36,19 @@ How the web shell (`apps/vectorcraft-web/src/web.rs`) differs from desktop: ## Desktop graphics processor -The canvas is rasterized on the CPU (`vectorcraft-render`, vello_cpu); the GPU (wgpu, through eframe) only composites the canvas texture and draws the UI. The desktop app (`apps/vectorcraft/src/main.rs`) therefore asks wgpu for the **power-saving** adapter by default, which is the integrated GPU on hybrid-graphics laptops. Presenting frames rendered on a discrete GPU through the integrated one made the window flicker on some laptops (#306). A machine with one GPU gets that GPU either way. +The canvas is rasterized on the CPU (`vectorcraft-render`, vello_cpu); the GPU (wgpu, through eframe) only composites the canvas texture and draws the UI, so any GPU that can show the window will do. The desktop app picks the window's adapter itself (`apps/vectorcraft/src/gpu.rs`, eframe's `native_adapter_selector`) and logs every adapter it found and the one it uses. -- **Preferences › Performance › Graphics Processor** (`gpuPreference`: `powerSaving` or `highPerformance`) picks the other one. The adapter is chosen when the window opens, so a change applies after a restart. -- The `WGPU_POWER_PREF` environment variable (`low`, `high` or `none`) overrides the preference. +- **Order:** adapters that report they can't present to the window are never tried; then the one `WGPU_ADAPTER_NAME` names; hardware before software (llvmpipe, WARP); the native backends (Vulkan, Metal, DX12) before OpenGL; then the power preference, keeping the system's order among equals. +- **Preferences › Performance › Graphics Processor** (`gpuPreference`): `automatic` (the default), `lowPower` (Power Saving, the integrated GPU) or `highPerformance` (the discrete GPU). The adapter is chosen when the window opens, so a change applies after a restart. + - **Automatic on Windows and macOS** is power saving: the system shows frames from any GPU, and presenting frames rendered on a discrete GPU through the integrated one made the window flicker on some hybrid laptops (#306). + - **Automatic on Linux and the BSDs** keeps the system's order: Mesa's Vulkan device-select layer puts the GPU the desktop runs on first (the integrated one on hybrid laptops; `DRI_PRIME` and `MESA_VK_DEVICE_SELECT` steer it). A Wayland compositor may not accept frames from another GPU: on a desktop whose compositor ran on an NVIDIA GPU, rendering on the Ryzen's integrated GPU made KWin end the window's connection ("importing the supplied dmabufs failed") and 0.5.0 crashed at startup (#502). + - 0.5.0 saved `powerSaving`, its default, for everyone; it reads as `automatic`. +- **If the window fails on its adapter while starting up** (an error from wgpu, or a panic inside wgpu or egui-wgpu during the first frames), the app starts again without that adapter and tries the next one, telling which in the status bar; the run that failed keeps its log as `vectorcraft.1.log`. On Unix the new app replaces the process (an AppImage stays mounted); on Windows it starts beside it. The adapters left out travel in `VECTORCRAFT_GPU_SKIP` (`backend:vendor:device`, such as `Vulkan:1002:164e`), one more on each restart, so the restarts end. When no adapter is left, the app logs why and exits with an error instead of panicking. +- **Environment variables** for when the choice still goes wrong, all read at startup and stronger than the preference: + - `WGPU_POWER_PREF`: `low`, `high` or `none` (the system's order). + - `WGPU_ADAPTER_NAME`: part of an adapter's name, any case (`WGPU_ADAPTER_NAME=nvidia`, `=radv`, `=intel`); the names are in the log. + - `WGPU_BACKEND`: the backends to use, such as `vulkan`, `dx12`, `metal` or `gl`. + - On Linux with Mesa, `MESA_VK_DEVICE_SELECT=10de:2f04!` (vendor:device as `vulkaninfo --summary` or `lspci -nn` show it) leaves only that GPU to Vulkan, and `DRI_PRIME=1` picks the other GPU. - Help › About and the control channel's `ui.inspect` (`graphicsAdapter`) show the adapter in use, and the app logs it at startup. ## Logs @@ -55,13 +64,17 @@ By default VectorCraft's own crates log at `info` and everything else at `warn`. | `VECTORCRAFT_CONTROL_PORT` | Same as `--control ` | | `VECTORCRAFT_NO_PREFS` | No preferences read or written, no default Data Recovery folder and no log file (agents' test runs) | | `WGPU_POWER_PREF` | Graphics adapter: `low`, `high` or `none` (see [Desktop graphics processor](#desktop-graphics-processor)) | +| `WGPU_ADAPTER_NAME` | Graphics adapter by (part of) its name, any case (see [Desktop graphics processor](#desktop-graphics-processor)) | +| `WGPU_BACKEND` | Graphics backends: `vulkan`, `dx12`, `metal`, `gl` | +| `VECTORCRAFT_GPU_SKIP` | Set by the app when it starts again without a graphics adapter that failed (see [Desktop graphics processor](#desktop-graphics-processor)) | | `RUST_LOG` | Log levels for standard error and the log file (see [Logs](#logs)) | ## Linux: Wayland and X11 -The window runs natively on Wayland (eframe's `wayland` feature) and on X11. The system clipboard (`apps/vectorcraft/src/clipboard.rs`) is arboard with its `wayland-data-control` feature: +The window runs natively on Wayland (eframe's `wayland` feature) and on X11. On machines with two GPUs it renders on the one the desktop runs on unless Preferences say otherwise; see [Desktop graphics processor](#desktop-graphics-processor) (#502). The system clipboard (`apps/vectorcraft/src/clipboard.rs`) is arboard with its `wayland-data-control` feature: - **Clipboard:** under Wayland arboard talks to the compositor through the data-control protocol (wlroots compositors such as Sway and Hyprland, KDE Plasma), so bitmaps (`image/png`), SVG markup and text copied in any app paste (#398). Where the compositor lacks the protocol (GNOME's Mutter, [arboard#223](https://github.com/1Password/arboard/issues/223)), arboard falls back to the X11 clipboard through XWayland, which only holds what X11 apps copied. egui's own text paste into fields goes through smithay-clipboard and works either way. +- **Clipboard owners that never answer (#510):** reading the clipboard waits on the app that owns it: arboard gives up on an X11 owner after 4 s, and a Wayland read waits for the owner to send its data. So on Linux the check that enables the Paste menu items runs on a background thread with a second clipboard handle (`crates/ui-egui/src/clipboard_probe.rs`, installed as `Services::clipboard_probe`), only while nothing is copied in the app and a document is open, and the window keeps drawing. A paste itself still reads on the UI thread, so pasting from such an owner waits for it once. Windows and macOS keep the check on the UI thread: Windows only asks which formats the clipboard holds, macOS asks the pasteboard server. - **Copied files:** files copied in a file manager (`text/uri-list`; `CF_HDROP` on Windows, file URLs on macOS) paste as the first one that is art (SVG, PDF, EMF/WMF or a bitmap), before the clipboard's other formats (which include the files' paths as text). - **Dropping files on the window does not work under Wayland:** winit 0.30, which eframe 0.36 runs on, has no Wayland drag and drop ([winit#1881](https://github.com/rust-windowing/winit/issues/1881), added in winit 0.31; [egui#1563](https://github.com/emilk/egui/issues/1563)), so no `dropped_files` arrive. Until eframe moves to winit 0.31: copy the files in the file manager and paste them, use File › Place or Open, or run the app under XWayland, where drops work (`WAYLAND_DISPLAY= vectorcraft`). - **Pens and pen displays under Wayland (#491):** winit 0.30 doesn't bind the Wayland tablet protocol (`zwp_tablet_v2`; tablet input arrives in winit 0.31, [winit#4318](https://github.com/rust-windowing/winit/pull/4318), [egui#7731](https://github.com/emilk/egui/pull/7731)). Since Plasma 6.3, KWin no longer turns tablet input into pointer input for such apps ([kwin!6336](https://invent.kde.org/plasma/kwin/-/merge_requests/6336)): the pen moves the compositor's cursor over the window, but the app gets no motion or presses and shows none of its own cursors. Until eframe moves to winit 0.31, either run the app under XWayland, which supports the tablet protocol and hands the pen to X11 apps as a pointer (`WAYLAND_DISPLAY= vectorcraft`, or `env -u WAYLAND_DISPLAY vectorcraft`; for a desktop launcher, put `env WAYLAND_DISPLAY=` before the command in its `Exec=` line), or turn KWin's deprecated emulation back on for the whole session by setting `KWIN_WAYLAND_EMULATE_TABLET=1` in KWin's environment (for example in a file under `~/.config/environment.d/` or in `/etc/environment`) and logging in again. The pen then works as a mouse, without pressure: winit 0.30 reads pen pressure on Windows only (Windows Ink, which reaches the Liquify tools' Use Pressure Pen). Other compositors that don't emulate a pointer for tablets behave the same way. diff --git a/docs/mcp.md b/docs/mcp.md index 4eac72a7..e681bcb1 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -402,11 +402,14 @@ their stop opacity and stop where the shading doesn't extend. Text becomes point the file's font (by name; fonts that aren't available are listed in `warnings` and show in the fallback font, and every export that draws that type — PDF, EPS, EMF/WMF, raster images, SVG with outlined or embedded fonts — says in its `warnings` that it wrote the fallback font) — `textAs: "outlines"` keeps the glyph outlines the file draws instead -(its embedded fonts, installed or not). Strokes stay live strokes (width, cap, join, miter limit, dash and paint), and +(its embedded fonts, installed or not). Lines wrapped in a frame (each wrapped line ending in a space, sharing a left +edge, font and leading) come back as one area type object, left aligned or justified, where laying it out breaks the +lines where the file does; a stroke written as each glyph's outline stroked is the type object's stroke; glyphs set +apart by gaps wider than a space keep their places. Strokes stay live strokes (width, cap, join, miter limit, dash and paint), and an object written as a fill and then a stroke of the same outline is one path with both. Optional content groups (the layers of PDF and PDF-compatible `.ai` files) become layers with their name, visibility (the default configuration's, -or a view state that is off), print state and lock, nested as sublayers the way the file's layer order nests them; art -that is off comes in as a hidden layer. Art outside them goes to a layer per page (except the opaque white page a `.ai` +or a view state that is off), print state and lock, nested as sublayers the way the file's layer order nests them, stacked as the pages mark them +(layers with no art come in empty); art that is off comes in as a hidden layer. Art outside them goes to a layer per page (except the opaque white page a `.ai` paints under its layers, which isn't art). `layers: false` gives one layer per page of only what shows: ```json @@ -1049,7 +1052,20 @@ on top of each other, and an open path becomes one path per piece. Each cut leav so `path.moveAnchors {dx, dy}` (or a Direct Selection drag) pulls the path apart there; `path.join {}` (Connect Selected End Points) joins the ends again. `path.convertAnchor {id, subpath?, anchor, to, x?, y?}` and `path.split {id, subpath?, anchor}` do the same to one anchor (the Anchor Point and Scissors tools); the Pen with Alt -held over a selected path's handle or anchor works as the Anchor Point tool. +held over a selected path's handle, anchor or segment works as the Anchor Point tool. `path.reshapeSegment {id, +subpath?, segment, t, dx, dy}` (a segment dragged with Direct Selection or the Anchor Point tool) moves the segment's +point at `t` by `dx`, `dy`: a smooth anchor at either end stays smooth, its other handle turning with the moved one. + +A `pointer_gesture` with `mods: {cmd: true}` held at the press, with any tool but the selection tools (Command on +macOS, Ctrl elsewhere), drags with the selection tool chosen last (`select_tool`), or Direct Selection with the Pen, +Curvature and anchor tools until one is chosen; the release gives the tool back as it was, so the Pen goes on drawing +the path it had begun while that stays selected. Its reply's `tool` is the tool given back. + +```json +{"name":"pointer_gesture","arguments":{"tool":"pen","events":[{"kind":"down","x":100,"y":300},{"kind":"up","x":100,"y":300},{"kind":"down","x":200,"y":300},{"kind":"drag","x":250,"y":300},{"kind":"up","x":250,"y":300}]}} +{"name":"pointer_gesture","arguments":{"mods":{"cmd":true},"events":[{"kind":"down","x":250,"y":300},{"kind":"drag","x":250,"y":260},{"kind":"up","x":250,"y":260}]}} +{"name":"pointer_gesture","arguments":{"events":[{"kind":"down","x":300,"y":350},{"kind":"up","x":300,"y":350}]}} +``` ```json {"name":"run_command","arguments":{"command":"select.anchors","params":{"id":12,"anchors":[[0,2]]}}} @@ -1153,8 +1169,9 @@ Effects off a 100 pt wide rectangle with a 10 pt stroke set to `width: 220` gets The Selection & Anchor Display and General preferences apply to `pointer_gesture` as they do to the mouse: -- `selectionTolerance` (1–8 px, 3 by default): how near a click must be to a path to pick it, and to an anchor or - handle for Direct Selection. +- `selectionTolerance` (1–8 px, 3 by default): how near a click must be to a path to pick it, and to an anchor, + handle or segment for Direct Selection, the Anchor Point, Add and Delete Anchor Point and Scissors tools, and the + Pen with Alt. A handle shorter than that leaves its anchor to be picked when pressed nearer the anchor. - `objectSelectionByPathOnly`: a click inside a filled path or compound path doesn't select it, one on its path does. - `ctrlClickSelectsBehind` (on by default): a Selection tool click with `mods: {cmd: true}` (Command on macOS, Ctrl elsewhere) selects the object under the selected one there, the next such click the one under that, then the @@ -1168,8 +1185,9 @@ The Selection & Anchor Display and General preferences apply to `pointer_gesture hidden art with the artboard too; off (the default) it stays where it is. - `penRubberBand`, `curvatureRubberBand` (on by default): off, the Pen and Curvature tools draw no preview segment to the pointer. -- `showHandlesMultipleAnchors` (on by default): off, Direct Selection shows and drags direction handles only while a - single anchor is selected. `handleStyle` (`solid`, `hollow`, `large`) draws their ends (desktop app). +- `showHandlesMultipleAnchors` (on by default): off, Direct Selection (and the Anchor Point tool, and the Pen with Alt) + shows and drags direction handles only while a single anchor is selected. On, the handles of the direct-selected + anchors, or of every anchor of a path selected as a whole, show and drag. `handleStyle` (`solid`, `hollow`, `large`) draws their ends (desktop app). - `hideCornerWidgetAbove` (177° by default): corners wider than this show no Live Corners widget (a rectangle's right angles hide below 90°). - `transformPatternTiles` (off by default): the default of the transforms' `patterns` param (`object.transform`, diff --git a/docs/releasing.md b/docs/releasing.md index 5389dd15..a3b238ed 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -1,7 +1,7 @@ # Releasing VectorCraft Every push to the `release` branch runs `.github/workflows/release.yml`. The workflow builds -installers for macOS, Windows, Linux and FreeBSD, plus the web build, and creates or updates a +installers for macOS, Windows, Linux (including Flatpak bundles) and FreeBSD, plus the web build, and creates or updates a **draft** GitHub Release named `VectorCraft v`. Nobody sees a draft until a maintainer publishes it. @@ -34,8 +34,11 @@ Once the draft is published, the workflow refuses to touch that version again: b **Test runs:** *Actions › Release › Run workflow* runs the whole pipeline by hand. The optional `version` input (such as `0.4.0-rc.1`) overrides `Cargo.toml` for that run only; each build job -applies it with `cargo xtask version set` before building. The jobs run in the `release` -environment, which only the `release` branch can use, so pick that branch in the dialog. +applies it with `cargo xtask version set` before building. The signing jobs (macOS, Windows) and +the draft-release job run in the `release` environment, which only the `release` branch can use, so +pick that branch for a full run. Run on any other branch, it is a dry run: the Linux, Flatpak, +FreeBSD and web jobs build and upload their artifacts, the environment refuses the signing jobs, +and no draft release is created. ## What gets built @@ -47,6 +50,8 @@ environment, which only the `release` branch can use, so pick that branch in the | Windows on ARM64 | `vectorcraft--windows-arm64.msi`, `vectorcraft--windows-arm64-portable.zip` | `windows-latest` (cross-compiled) | | Linux x86_64 | `vectorcraft--linux-x86_64.{AppImage,deb,rpm,tar.gz}` | `ubuntu-22.04` | | Linux aarch64 | `vectorcraft--linux-aarch64.{AppImage,deb,rpm,tar.gz}` | `ubuntu-22.04-arm` | +| Linux AppImage updates | `vectorcraft--linux-{x86_64,aarch64}.AppImage.zsync` | with the AppImages | +| Flatpak x86_64, aarch64 | `vectorcraft--linux-{x86_64,aarch64}.flatpak` | `ubuntu-24.04`, `ubuntu-24.04-arm` (repackages the Linux tarball) | | FreeBSD 14 x86_64 | `vectorcraft--freebsd-x86_64.tar.gz` | a FreeBSD 14.3 VM on `ubuntu-latest` | | Web | `vectorcraft-web-.zip`, a static site (see [`packaging/web/README.md`](../packaging/web/README.md)) | `ubuntu-latest` | @@ -132,9 +137,21 @@ glibc 2.35 or newer: Ubuntu 22.04+, Debian 12+, Fedora 36+ and RHEL 10. Moving t image raises that floor, so do it deliberately. After packaging, the job prints the `.deb`'s metadata and contents, runs `ldd` on the binary and runs each AppImage with `--version`. -`packaging/linux/flatpak/ai.storyteller.vectorcraft.yml` is a Flatpak manifest ready for a -Flathub submission (its header says how to build it). The release doesn't build a Flatpak; the -workflows only check the manifest's id. +**AppImage updates.** Each AppImage embeds the update information +`gh-releases-zsync|storytold|vectorcraft|latest|vectorcraft-*-linux-.AppImage.zsync` +(appimagetool `-u`), and `package.sh` writes the matching `.zsync` beside it when `zsyncmake` (the +`zsync` package) is installed. [AppImageUpdate](https://github.com/AppImageCommunity/AppImageUpdate) +and AppImageLauncher then download only the changed blocks from the newest published, +non-pre-release release. The job checks both are there. + +**Flatpak.** The `flatpak` jobs (x86_64 on `ubuntu-24.04`, aarch64 on `ubuntu-24.04-arm`) take the +Linux job's tarball and repackage it with `packaging/linux/flatpak-bundle.sh` and +`packaging/linux/flatpak/ai.storyteller.vectorcraft.bundle.yml` into a single-file bundle +(`flatpak install --user vectorcraft--linux-.flatpak`), then install it and run +`vectorcraft-cli --version` in the sandbox. No Rust build happens there, so the bundle carries the +same binaries as the AppImage. `packaging/linux/flatpak/ai.storyteller.vectorcraft.yml` is the +from-source manifest for a Flathub submission (its header says how to build it); packaging-lint +keeps the runtime and sandbox permissions of the two manifests identical. ### FreeBSD @@ -159,8 +176,9 @@ the job fails and asks for a version bump (`cargo xtask version set`). ## Secrets -All jobs run in the `release` environment, which only the `release` branch can use and which holds -the signing secrets. Every secret is optional: a missing one produces unsigned artifacts and a +The jobs that sign (macOS, Windows) and the draft-release job run in the `release` environment, +which only the `release` branch can use and which holds the signing secrets. The other jobs get no +secrets. Every secret is optional: a missing one produces unsigned artifacts and a warning, never a failed build. | Secret | Used for | diff --git a/packaging/linux/flatpak-bundle.sh b/packaging/linux/flatpak-bundle.sh new file mode 100755 index 00000000..bb844193 --- /dev/null +++ b/packaging/linux/flatpak-bundle.sh @@ -0,0 +1,72 @@ +#!/usr/bin/env bash +# Repackage a VectorCraft Linux tarball as a single-file Flatpak bundle: +# +# $DIST/vectorcraft--linux-.flatpak +# +# Usage: packaging/linux/flatpak-bundle.sh [--no-test] [TARBALL] +# +# TARBALL defaults to $DIST/vectorcraft--linux-.tar.gz from package.sh. The bundle +# is built for the host architecture (x86_64 or aarch64), which must match the tarball's. +# Needs flatpak, flatpak-builder and the SVG pixbuf loader (librsvg2-common) for the host's +# `appstreamcli compose`; the freedesktop runtime and SDK named in the manifest are +# installed per-user from Flathub. Unless --no-test, the bundle is then installed per-user and +# `vectorcraft-cli --version` is run inside the sandbox as a smoke test. +# Manifest: packaging/linux/flatpak/ai.storyteller.vectorcraft.bundle.yml. +set -euo pipefail +# shellcheck source=../env.sh +. "$(dirname "${BASH_SOURCE[0]}")/../env.sh" +HERE="$ROOT/packaging/linux" +APP_ID=ai.storyteller.vectorcraft +FLATHUB=https://dl.flathub.org/repo/flathub.flatpakrepo + +TEST=1 +TARBALL="" +while [ $# -gt 0 ]; do + case "$1" in + --no-test) TEST=0; shift ;; + -h | --help) sed -n '2,14p' "$0"; exit 0 ;; + -*) echo "unknown argument: $1" >&2; exit 2 ;; + *) TARBALL="$1"; shift ;; + esac +done + +ARCH="$(uname -m)" +case "$ARCH" in + x86_64) ;; + aarch64 | arm64) ARCH=aarch64 ;; + *) echo "unsupported architecture $ARCH" >&2; exit 2 ;; +esac +BASENAME="vectorcraft-$VERSION-linux-$ARCH" +TARBALL="${TARBALL:-$DIST/$BASENAME.tar.gz}" +[ -f "$TARBALL" ] || { echo "error: $TARBALL not found (run packaging/linux/package.sh --formats tar first)" >&2; exit 1; } +for tool in flatpak flatpak-builder; do + command -v "$tool" >/dev/null || { echo "error: $tool not found (apt install flatpak flatpak-builder librsvg2-common)" >&2; exit 1; } +done + +echo "==> VectorCraft $VERSION Flatpak bundle for $ARCH from $(basename "$TARBALL")" + +WORK="$CARGO_TARGET_DIR/flatpak-bundle" +rm -rf "$WORK" +mkdir -p "$WORK/stage" +tar -xzf "$TARBALL" -C "$WORK/stage" --strip-components=1 +[ -x "$WORK/stage/bin/vectorcraft" ] || { echo "error: $TARBALL has no bin/vectorcraft" >&2; exit 1; } +cp "$HERE/flatpak/$APP_ID.bundle.yml" "$WORK/$APP_ID.yml" + +flatpak remote-add --user --if-not-exists flathub "$FLATHUB" +# --disable-rofiles-fuse: no FUSE in containers and CI runners. +flatpak-builder --user --install-deps-from=flathub --disable-rofiles-fuse --force-clean \ + --default-branch=stable --repo="$WORK/repo" --state-dir="$WORK/state" "$WORK/build" "$WORK/$APP_ID.yml" + +OUT="$DIST/$BASENAME.flatpak" +# --runtime-repo lets `flatpak install` fetch the freedesktop runtime from Flathub if missing. +flatpak build-bundle --runtime-repo="$FLATHUB" "$WORK/repo" "$OUT" "$APP_ID" stable +echo "wrote $OUT" + +if [ "$TEST" = 1 ]; then + flatpak install --user -y --noninteractive --reinstall "$OUT" + flatpak info --user "$APP_ID" + flatpak run --command=vectorcraft-cli "$APP_ID" --version + flatpak run --command=sh "$APP_ID" -c 'ls /app/share/applications /app/share/metainfo /app/share/mime/packages /app/share/icons/hicolor/scalable/apps' +fi +echo "==> done" +ls -lh "$OUT" diff --git a/packaging/linux/flatpak/ai.storyteller.vectorcraft.bundle.yml b/packaging/linux/flatpak/ai.storyteller.vectorcraft.bundle.yml new file mode 100644 index 00000000..36ab122d --- /dev/null +++ b/packaging/linux/flatpak/ai.storyteller.vectorcraft.bundle.yml @@ -0,0 +1,47 @@ +# Flatpak manifest for the single-file bundle attached to every GitHub release +# (vectorcraft--linux-.flatpak). Build it with packaging/linux/flatpak-bundle.sh. +# +# It repackages the release's own Linux tarball (vectorcraft--linux-.tar.gz, +# built on Ubuntu 22.04 by package.sh) instead of compiling Rust inside flatpak-builder: no +# network and no vendored crate sources during the build, a few seconds instead of 20+ minutes, +# and byte-for-byte the same binaries as the AppImage/deb/rpm. The script unpacks the tarball +# into `stage/` next to a copy of this file. The binaries need glibc >= 2.35 and load X11, +# Wayland, xkbcommon and Vulkan at runtime; the freedesktop runtime has all of them, and the +# GPU driver comes from its org.freedesktop.Platform.GL extension. +# +# ai.storyteller.vectorcraft.yml (same directory) is the from-source manifest for Flathub. Keep +# runtime, runtime-version, sdk and finish-args identical in both (packaging-lint checks this). +id: ai.storyteller.vectorcraft +runtime: org.freedesktop.Platform +runtime-version: '25.08' +sdk: org.freedesktop.Sdk +command: vectorcraft +finish-args: + # X11 shared memory (MIT-SHM). Without it the X11 fallback is slow or fails. + - --share=ipc + # Display: Wayland first; X11 only when no Wayland compositor is running. + - --socket=wayland + - --socket=fallback-x11 + # GPU access for the wgpu renderer (Vulkan, or GL as a fallback). + - --device=dri + # Open/Save dialogs use the file-chooser portal (rfd), and drag-and-drop uses the document + # portal, so broad filesystem access isn't needed. Pictures is granted for opening files by + # path from the command line. + - --filesystem=xdg-pictures + # Deliberately not granted: network (the optional --control server listens on 127.0.0.1 in + # the sandbox; `flatpak override --user --share=network ai.storyteller.vectorcraft` exposes it + # to host agents) and home/host filesystem access. +modules: + - name: vectorcraft + buildsystem: simple + build-commands: + - install -Dm755 bin/vectorcraft /app/bin/vectorcraft + - install -Dm755 bin/vectorcraft-cli /app/bin/vectorcraft-cli + - install -Dm644 share/applications/ai.storyteller.vectorcraft.desktop /app/share/applications/ai.storyteller.vectorcraft.desktop + - install -Dm644 share/mime/packages/ai.storyteller.vectorcraft.xml /app/share/mime/packages/ai.storyteller.vectorcraft.xml + # Already has the release's version and date substituted by package.sh. + - install -Dm644 share/metainfo/ai.storyteller.vectorcraft.metainfo.xml /app/share/metainfo/ai.storyteller.vectorcraft.metainfo.xml + - mkdir -p /app/share/icons /app/share/doc && cp -R share/icons/hicolor /app/share/icons/ && cp -R share/doc/vectorcraft /app/share/doc/ + sources: + - type: dir + path: stage diff --git a/packaging/linux/flatpak/ai.storyteller.vectorcraft.yml b/packaging/linux/flatpak/ai.storyteller.vectorcraft.yml index 11038201..91953152 100644 --- a/packaging/linux/flatpak/ai.storyteller.vectorcraft.yml +++ b/packaging/linux/flatpak/ai.storyteller.vectorcraft.yml @@ -8,6 +8,7 @@ # flatpak run ai.storyteller.vectorcraft # # For Flathub, replace the `dir` source with a `git` source pinned to a release tag and commit. +# Release bundles (.flatpak on GitHub Releases) use ai.storyteller.vectorcraft.bundle.yml instead. id: ai.storyteller.vectorcraft runtime: org.freedesktop.Platform runtime-version: '25.08' @@ -16,6 +17,7 @@ sdk-extensions: - org.freedesktop.Sdk.Extension.rust-stable command: vectorcraft finish-args: + # Keep identical to ai.storyteller.vectorcraft.bundle.yml (the release bundle); comments there. - --share=ipc - --socket=wayland - --socket=fallback-x11 diff --git a/packaging/linux/package.sh b/packaging/linux/package.sh index 1644d6a7..1036031f 100755 --- a/packaging/linux/package.sh +++ b/packaging/linux/package.sh @@ -2,6 +2,7 @@ # Build and package VectorCraft for Linux ( is x86_64 or aarch64): # # $DIST/vectorcraft--linux-.AppImage any distro with glibc >= the build host's +# $DIST/vectorcraft--linux-.AppImage.zsync delta updates (needs zsyncmake) # $DIST/vectorcraft--linux-.deb Debian, Ubuntu, Mint, Pop!_OS, ... # $DIST/vectorcraft--linux-.rpm Fedora, openSUSE, RHEL, ... # $DIST/vectorcraft--linux-.tar.gz plain FHS-style tree (bin/, share/) @@ -10,7 +11,8 @@ # # Needs: cargo; nfpm for deb/rpm (https://nfpm.goreleaser.com); appimagetool for the AppImage # (downloaded into $CARGO_TARGET_DIR if missing). Build on an old distro (CI: Ubuntu 22.04, -# glibc 2.35) so the binaries run on newer ones. Optional: desktop-file-validate, appstreamcli. +# glibc 2.35) so the binaries run on newer ones. Optional: desktop-file-validate, appstreamcli, +# zsyncmake (the zsync package) for the AppImage's .zsync. set -euo pipefail # shellcheck source=../env.sh . "$(dirname "${BASH_SOURCE[0]}")/../env.sh" @@ -108,11 +110,29 @@ if has appimage; then chmod +x "$TOOL" fi fi - OUT="$DIST/$BASENAME.AppImage" + # Absolute, because appimagetool runs in $DIST below (CARGO_TARGET_DIR or APPIMAGETOOL may be + # relative, e.g. target/agent-). + OUT="$(cd "$DIST" && pwd)/$BASENAME.AppImage" + APPDIR="$(cd "$APPDIR" && pwd)" + TOOL="$(cd "$(dirname "$TOOL")" && pwd)/$(basename "$TOOL")" + # A .zsync left by an earlier run would hide a missing zsyncmake and describe another file. + rm -f "$OUT.zsync" + # Update information: AppImageUpdate, AppImageLauncher and the like read it from the file and + # fetch only the blocks that changed in a newer release, through the .zsync published next to + # each AppImage on GitHub Releases. `latest` is the newest published release that is not a + # pre-release. A fork's builds point at its own releases through GITHUB_REPOSITORY. + REPO="${GITHUB_REPOSITORY:-storytold/vectorcraft}" + UPDATE_INFO="gh-releases-zsync|${REPO%%/*}|${REPO#*/}|latest|vectorcraft-*-linux-$ARCH.AppImage.zsync" # Extract-and-run: works without FUSE (containers, CI). The output embeds the static runtime, - # so users don't need libfuse2 either. - ARCH="$ARCH" APPIMAGE_EXTRACT_AND_RUN=1 "$TOOL" --no-appstream "$APPDIR" "$OUT" + # so users don't need libfuse2 either. With zsyncmake on the host (CI installs the zsync + # package) appimagetool also writes the .zsync, into its working directory, hence the cd. + (cd "$DIST" && ARCH="$ARCH" APPIMAGE_EXTRACT_AND_RUN=1 "$TOOL" --no-appstream -u "$UPDATE_INFO" "$APPDIR" "$OUT") echo "wrote $OUT" + if [ -s "$OUT.zsync" ]; then + echo "wrote $OUT.zsync" + else + warn "zsyncmake not found, so $OUT.zsync was not written; AppImage delta updates need it" + fi fi "$STAGE/usr/bin/vectorcraft-cli" --version