diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d686da692..026d5aac3 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,6 +1,10 @@ name: Release on: + # A nightly dry run on main: every release build except macOS, nothing signed or released + # (craft-common-actions release.yml `dry-run`). Finds release-only breakage before release day. + schedule: + - cron: "40 1 * * *" push: branches: [release] workflow_dispatch: @@ -30,6 +34,7 @@ jobs: # Intentionally tracked at @main (not SHA-pinned) so org-wide CI improvements, security fixes, and build optimizations propagate without PR churn across all craftapp repos. uses: storytold/craft-common-actions/.github/workflows/release.yml@main with: + dry-run: ${{ github.event_name == 'schedule' }} app-name: figcraft app-title: FigCraft # Combined Latin presentation and core UI catalog. Required web builds enforce diff --git a/Cargo.lock b/Cargo.lock index 7c94d0f61..04c8da5f2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1785,7 +1785,7 @@ checksum = "b97b65636e5b9ef369943878ac74335ba1c55c1cb6adbf1e2c293c624248d693" [[package]] name = "figcraft" -version = "0.17.1" +version = "0.18.1" dependencies = [ "arboard", "craft-menu", @@ -1817,7 +1817,7 @@ dependencies = [ [[package]] name = "figcraft-cli" -version = "0.17.1" +version = "0.18.1" dependencies = [ "clap", "clap_complete", @@ -1835,7 +1835,7 @@ dependencies = [ [[package]] name = "figcraft-collab" -version = "0.17.1" +version = "0.18.1" dependencies = [ "base64 0.22.1", "chrono", @@ -1853,7 +1853,7 @@ dependencies = [ [[package]] name = "figcraft-collab-net" -version = "0.17.1" +version = "0.18.1" dependencies = [ "base64 0.22.1", "figcraft-collab", @@ -1876,7 +1876,7 @@ dependencies = [ [[package]] name = "figcraft-color" -version = "0.17.1" +version = "0.18.1" dependencies = [ "kurbo", "serde", @@ -1885,7 +1885,7 @@ dependencies = [ [[package]] name = "figcraft-doc" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-color", "figcraft-geom", @@ -1898,7 +1898,7 @@ dependencies = [ [[package]] name = "figcraft-engine" -version = "0.17.1" +version = "0.18.1" dependencies = [ "base64 0.22.1", "craft-docpath", @@ -1932,7 +1932,7 @@ dependencies = [ [[package]] name = "figcraft-format" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-doc", "figcraft-layout", @@ -1949,7 +1949,7 @@ dependencies = [ [[package]] name = "figcraft-geom" -version = "0.17.1" +version = "0.18.1" dependencies = [ "kurbo", "serde", @@ -1957,7 +1957,7 @@ dependencies = [ [[package]] name = "figcraft-layout" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-doc", "figcraft-geom", @@ -1965,7 +1965,7 @@ dependencies = [ [[package]] name = "figcraft-mcp" -version = "0.17.1" +version = "0.18.1" dependencies = [ "base64 0.22.1", "figcraft-collab-net", @@ -1981,7 +1981,7 @@ dependencies = [ [[package]] name = "figcraft-pathops" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-doc", "figcraft-geom", @@ -1990,7 +1990,7 @@ dependencies = [ [[package]] name = "figcraft-pdf" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-color", "figcraft-doc", @@ -2007,7 +2007,7 @@ dependencies = [ [[package]] name = "figcraft-plugin" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-color", "serde", @@ -2020,7 +2020,7 @@ dependencies = [ [[package]] name = "figcraft-render" -version = "0.17.1" +version = "0.18.1" dependencies = [ "crc32fast", "figcraft-color", @@ -2039,7 +2039,7 @@ dependencies = [ [[package]] name = "figcraft-server" -version = "0.17.1" +version = "0.18.1" dependencies = [ "chrono", "crc32fast", @@ -2064,7 +2064,7 @@ dependencies = [ [[package]] name = "figcraft-svg" -version = "0.17.1" +version = "0.18.1" dependencies = [ "base64 0.22.1", "figcraft-color", @@ -2080,7 +2080,7 @@ dependencies = [ [[package]] name = "figcraft-text" -version = "0.17.1" +version = "0.18.1" dependencies = [ "core-text", "craft-font-catalog", @@ -2098,7 +2098,7 @@ dependencies = [ [[package]] name = "figcraft-ui-egui" -version = "0.17.1" +version = "0.18.1" dependencies = [ "base64 0.22.1", "chrono", @@ -2126,7 +2126,7 @@ dependencies = [ [[package]] name = "figcraft-vectordrawable" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-color", "figcraft-doc", @@ -2140,7 +2140,7 @@ dependencies = [ [[package]] name = "figcraft-web" -version = "0.17.1" +version = "0.18.1" dependencies = [ "base64 0.22.1", "craft-web-api", @@ -6763,7 +6763,7 @@ checksum = "9440ea3e5aeabb0ac63af70daf835274065238cdd0cec83418f417eae38bacee" [[package]] name = "xtask" -version = "0.17.1" +version = "0.18.1" dependencies = [ "figcraft-engine", "serde_json", diff --git a/Cargo.toml b/Cargo.toml index d24d8f03d..80ca99a27 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,7 @@ exclude = ["plugins"] # default-members = ["crates/*", "apps/figcraft", "apps/figcraft-cli", "xtask"] [workspace.package] -version = "0.17.1" +version = "0.18.1" edition = "2024" license = "MIT OR Apache-2.0" rust-version = "1.95" diff --git a/ROADMAP.md b/ROADMAP.md index dc6204b44..74638c4cc 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -2,7 +2,7 @@ **Stage: alpha** · next: beta, ~26 points and ~162–292 h away (one Opus 5.5 agent; ~33–67 h wall-clock with 5 agents) -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-07 · **Change:** patch (the handoff mode reads Developer Mode in the interface, its ids and saved fields unchanged; the left rail's and tab strip's icons are larger, 20 pt (#553); Suggest auto layout adds nested auto layout frames by rows and columns and keeps the placement of the design, as the help center describes (#1823); the Local variables window selects several variables (click, Shift+click for a range, Cmd/Ctrl+click to toggle, Escape to clear) and delete, move to a group and scope act on the selected local variables in one undo step (#2002); the desktop UI takes a system face for Ethiopic, Devanagari, Gurmukhi, Gujarati, Tamil, Telugu, Kannada and Malayalam, Sinhala, Lao, Myanmar, Khmer, Armenian and Georgian as it did for Hebrew and Arabic, so a String variable's Amharic value draws in the panels instead of boxes (#2014); a layer's effect binding takes only a field its effect has; ; the boolean operation menu leads each entry with an original icon (#2003); glass takes one sample instead of its dispersion window where the colours split under 1/256 px; glass bends towards its core, and rounded rectangles work it out in closed form; glass's light is a line on its bevel and splay turns the bend towards the centre; glass bends with a thick-lens profile and splits its colours over 8 steps; glass effects take variables and keep their frost within 0–100; web host bridge: `?host=parent` or `data-host="page"` hands a page the app's files, documented in the hosting guide; a connector end moved with Cmd/Ctrl held goes on any part of an object, and stays there as the object moves or resizes; a tap on a plugin panel's button keeps what was typed in its fields; a Dash cap setting (none, round or square) on Dash and Custom strokes, drawn on both ends of every dash; library analytics list how many layers and files use each style and variable; the Controller menu names each button as PlayStation and Switch controllers do; widgets draw lines and SVG pictures (plugin API 6); a connector end dropped along a side of a shape attaches to that side (#1708); regression tests pin a rounded shape's one-sided stroke and SVG ids and font families without XML-forbidden characters (#1351, #1124); a damaged image is refused with a reason instead of showing as an empty box (#1474); an image copied in another app pastes again on the desktop, and in the browser for the first time (#492); SwiftUI and Compose code names a bound variable by its iOS or Android code syntax; the colour picker's Image tab shows a placeholder and Upload from computer, an asset preview, and a file dropped on it replaces the image, keeping the fill mode, crop and position (#1682); the Frame tool's Phone presets have the iPhone 17 family (#1691); Show in folder works in the Flatpak build and selects the file on Linux (#1701); a dashed line starts and ends with a half-length dash, on the canvas and in exports; the Pages, Layers and Assets search fields keep their text in the middle of the field (#1703); a board connector's path can be reshaped by dragging its path handles (#1710); boards have 16 more shapes (arrows, polygons, star, plus and flowchart symbols), in pickers that lay them out in a grid; library analytics count insertions and show insertions and detachments over the past 30 days, 90 days or year; a stroke's Custom style takes a dash pattern of any length as a comma-separated list (#1681); a control request can set its own timeout, up to 10 minutes (`timeoutMs`; `figcraft-cli mcp --attach PORT --timeout SECONDS`) (#1696); gap 6: a widget opens its plugin's panel (plugin API 5), whose callbacks redraw it; the keyboard's Menu key opens the context menu, as Shift+F10 does; an Open link action can open in place of the prototype, with "Open in new tab" off (gap 15); a collection of this file can be extended (Extend collection on its row, `variable.extendCollection`), its extension following its edits at once, and extended collections extend again in the file; the eyedropper with Cmd/Ctrl+Shift makes a colour style or variable of what it picks; a live session's welcome sends the document compressed to clients that read it, about seven times smaller (#1665); a control request that times out says truthfully whether it was dropped or is still running and will take effect, and only screenshots and input blame the window (#1673); a board keeps earlier votes' results, listed newest first in Results and deleted one at a time; the object a stamp will stick to is outlined while the stamp tool is over it or a stamp is dragged over it, and board objects take no drops (gap 24); a server can list the files shared from it now for everyone who reaches it, Home ▸ Online shows them and their links carry no secret (`team_files`, part of #742); team library analytics count detached instances per component and file (gap 10); skipping the Open link notice by command is saved with the preferences at once (gap 15); a selected connector's bar on a board sets its start and end points, solid or dashed, its weight and any colour (#1596); cells copied from a spreadsheet paste onto a board as a table; a long layer name stays on one line in the Export button and the Dev Mode header, ending with an ellipsis, and no longer covers the Design panel (#1650); with hundreds of layers selected, the Design panel and the selection overlays stop going over the whole selection on every frame, so dragging 648 layers averages about 1.1 ms of UI per frame (#1571); plugin panels show pictures: an `image` control, base64 within 256 KB and 4,096 px a side, named by its label (gap 6); `.fig` connector labels without a saved snapshot are kept, centred on their line (gap 1); a drag moving many layers re-runs only what sits around them, not each layer's bindings, sizing, text and instance checks, on every move (#1571); damaged font tracking table offsets are checked instead of wrapping on 32-bit targets, and font indexing makes its existing offset bounds explicit (#1125); Bosnian (`bs`) draft catalog; text style dedupe is O(spans) via a last-two cache and fingerprint buckets (#1102); pasted layers whose image the clipboard lacks are named and show a placeholder that reads as missing (#1646); paint-style colours on layers pasted from another design app keep their style instead of turning black (#1638); progress docs cleaned of what merges left twice: rows merged into one, repeated status items removed, and `cargo xtask docs` (in `ci`) fails on a repeated table row or status item; a name typed for a variable or collection finds the one with that exact id before one named like it, and stored mode ids, font family variables and the panels' labels read exact ids (#1613); plugin widgets have hover styles: a layer's `hover` fill, stroke, opacity or text colour shows while the pointer is over it (gap 6); `.fig` elbowed and curved connectors without a saved path are routed like board connectors instead of drawn straight (gap 1); every file a command reads whole by path is a regular file within a cap that fits it: documents 16 GiB, placed images 256 MiB, CLI scripts 1 GiB; `figcraft-cli connect publish` publishes a code repository's code connect mappings to a design file (gap 16); while a drag only moves a large selection, its outlines, box, slots, spacing and Design panel values are worked out once and shifted, not rebuilt on every move (#1571); Shift+Cmd/Ctrl+Enter on a selected board shape adds the next shape already joined to it, and goes on typing (#1597); an imported or pasted file finds an installed family under the other names its fonts give it, and with other case and spacing, instead of reporting it missing (#1292); a development example generates figcraft-cli's shell completions and man pages from its clap definitions (part of #1396); `.fig` ZIP image reads share a total byte budget and count skipped images in the import warnings (#1076); German terminology corrections (M10): gradient stops, OpenType stylistic sets and the Home-screen preference; a component set's property rows fit the 240 px right panel: variant values wrap two to a line there and every + and − stays in view; the server key is checked by comparing SHA-256 hashes of the presented and the kept key, as the deployment guide says (#1130); opening a file contacts no team library server it names until you check it (#1097); a hostile server can no longer grow a client's memory with made-up people, and a session remembers a bounded number of deleted layer ids (#1121); `doc.list` gives AI agents and plugins the open files' names, not their paths (#1117); with a large selection, frames where nothing changed reuse the selection's outlines, box and slots and the Design panel's instance and position values instead of working them out again (#1571); team libraries and plugins larger than the 16 MiB download burst can be downloaded again, more slowly (#1089); a batch keeps one undo snapshot, not one per step (#1099); files nested 256 levels deep import on the browser's 1 MB stack (#1101); SVG and PDF exports count pattern sources and the renders they embed from the layer's depth, so one cap bounds a whole export (#1082); an explicit variables file path (`variable.import`, the `variables` of `file.open` and `file.import`) is refused past 256 MiB or when it isn't a regular file, as the sibling `variables.json` already was (part of #1114); joining and leaving a file nobody is editing reads and writes nothing on the server: it stays loaded a minute after everyone leaves (#1074); opening a `.figcraft` file unpacks at most 6 GiB in all (2 GiB in the browser), every area together (#1079); hovering the canvas hit-tests once per pointer move, not on every frame, and moving an auto layout frame no longer lays out its contents again on every move (#1571); `.fig` instance expansion no longer walks variable nodes for every instance or copies every outer override row into each nested instance (#1077); `comment.people` lists names that were only @mentioned, and `comment.next` and `comment.prompt` carry the mentions too (#1415); grid auto-placement looks for free cells a 64-bit word at a time and skips what blocks it, with the same placements (#1083); with the pen out, Enter or a double-click ends the path and edits the vector with the Move tool instead of drawing on (#1430); a recovery copy made while a version is previewed holds the file, not the version shown; a FigJam `.jam` file opens as a board (#1342); the Actions palette offers only commands that run from it, and no second row reading like a menu item: Place image opens the file dialog (#1574); share links can comment: a third access level beside edit and view, whose holder sees the file live and adds, replies to, reacts to and resolves comments but can't change the design; Preferences ▸ Scroll wheel zoom: a mouse wheel zooms the canvas about the pointer and Cmd/Ctrl+wheel scrolls (#1390); `comment.list {mentions}` lists only the threads that @mention a name (#1415); in the browser an internal error that stops the page keeps its unsaved files, which open again on reload (#1123); boolean operations refuse input past their caps, and a boolean group past them draws without its result (#1104); figcraft-cli parses its arguments with clap, following RFC-0012 (#1396); the selection and hover outlines of rounded rectangles and frames follow their corners (#1506); component properties keep the order they were made in when one is renamed, and Make slot asks for the slot's name first (#1536, #1537); the browser build publishes files to a server, so Share ▸ Online and Publish to server work there (#917); the browser build uses the fonts installed on the computer once asked, each read when text uses it (#1051); SVG import reads `color()` and `color-mix()` colours, with a note and a grey for those it can't (#1550); the portable Windows zip keeps its settings, recovery copies and plugins in `config\` beside the executable, starting with an installed copy's preferences; the window starts on other graphics when its first ones fail before the first frame: Direct3D 12 compiles with FXC and no device compiles wgpu's indirect-validation shaders, then Vulkan, OpenGL and lower requirements on the power-saving GPU (#965, #1438); Thai, Lao, Khmer and Burmese lines break between words (#1219); an AI agent attached over MCP shows where it works (#1416); a manual overlay's position can be dragged on the canvas (#405); one name for live sessions and comments: Preferences ▸ Your name, in the Join dialog too, kept in the browser, and a rename shows at once in the sessions you are in (#1380); requests that change a server's files have a budget per address, the server key's too, and join codes are found by their hash (#1075); the Join dialog shows a join from the click until its file is ready, with Cancel, and a failed join with Try again (#1381); SVG import draws each pattern tile once per scale, within the layer budget (#1080); Vietnamese letters typed with combining marks (decomposed) take one font that has every mark, instead of missing-glyph boxes beside the letter (#1478); comment.list reports each message's @mentions (#1415); mask groups draw only over the area they can paint, and nested isolated layers share one memory budget (#1061); components can't contain their own instances, directly or through other components; `edit.duplicate` returns an id map with `map: true` (#995); the batches kept for reconnecting apps are bounded in bytes by default, and `figcraft-server` takes `max_log_mb` (#1069); MCP and control calls name their document (#998); sibling placement in live sessions searches instead of counting (#1065); an AI agent attached over MCP comments under its own name, with an Agent label (#1414); the instance-swap menus have a search field (#1338); a refused batch's fixes take time linear in the batch (#1063); the connector tool shows the connector it will make while dragging, ends snapping to attach points (#1387); large images on the canvas draw from a smaller copy, so two 16k images no longer lag (#1483); a file's JPEG thumbnail can't crash the home screen (#1491's progressive JPEG check, now shared); `.fig` import: library text styles linked by asset key, and override rows restating a nested level (#1234); `.fig` import keeps the file's saved line breaks while the text and its box are unedited (#1236); Download a missing free font from the Missing fonts window (`font.download`, #754); the web build's wasm back under its 24 MiB gate (#1472); shadows of images with transparent pixels follow their alpha (#1289); Crop image: Object ▸ Crop image, the right-click menu and the image fill row enter crop mode (`image.crop`, #1464); offline Penpot 2.x import/export (#1143); optional batch continue-on-error with per-step outcomes (#1386); the Design panel's sections on one grid (#858); FigJam outer shape outlines and sticky body fallback beside author text (#1341, #1397); images placed at their own size, 2x screenshots in points (#1360); the toolbar on one 32 pt grid, without its Resources button (#1210); M4: zero-length round-capped dashes draw dots; dash expansion uses the existing safety budget; extracted from #1143; Arabic draft catalog; scaled instances keep their scale when their main is rebuilt (#922); .fig embedded images are copied once per blob, not once per hash (#1059); page ruler guides survive save and reopen (#1476); colour picker LCH and OKLCH models; non-ASCII layer names transliterate in code export (#1235); branches in live sessions and branch history entries, gap 17; plugin widgets take text input and a property menu (plugin API 4); boards: templates and tables; boards: a shared timer and voting sessions; boards: the dot grid, connector ends dragged to re-attach, curved connectors; Installed weights of an embedded font family (#1246); `.sketch` import, best effort (Sketch 48 and newer); CJK line breaking: JIS X 4051's line-start and line-end sets completed with the halfwidth small kana, the halfwidth and spacing (semi-)voiced sound marks, the iteration marks 〱–〵 and the halfwidth parentheses, with behaviour cases for each; Adobe Fonts found on macOS (#298); egui 0.37 hidden-capture deadline contract; Dev Mode measurements kept on the canvas and a read-only layers panel; boards: a board area row and progress entry; community fixes in #507, #510, #529 and #530: auto-save, a text box by dragging, batch step references, removing someone from a live session, Russian and Turkish catalogs reviewed, Czech and Indonesian drafts, the Japanese draft completed, zoom previews, the web clipboard, Alt-drag snapping and Cmd+D repeat, recovery copies, crash and rollback fixes, colour emoji, `.fig` import fixes; earlier changes are in the revision history below) · **Target:** Figma Design (desktop app 126.10.7) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-10 · **Change:** minor (mind maps, first step: a first node with three children on curved branches, laid out again after every edit (`board.mindMap`, `board.mindMapAdd`, #2226); the handoff mode reads Developer Mode in the interface, its ids and saved fields unchanged; the left rail's and tab strip's icons are larger, 20 pt (#553); Suggest auto layout adds nested auto layout frames by rows and columns and keeps the placement of the design, as the help center describes (#1823); the Local variables window selects several variables (click, Shift+click for a range, Cmd/Ctrl+click to toggle, Escape to clear) and delete, move to a group and scope act on the selected local variables in one undo step (#2002); the desktop UI takes a system face for Ethiopic, Devanagari, Gurmukhi, Gujarati, Tamil, Telugu, Kannada and Malayalam, Sinhala, Lao, Myanmar, Khmer, Armenian and Georgian as it did for Hebrew and Arabic, so a String variable's Amharic value draws in the panels instead of boxes (#2014); a layer's effect binding takes only a field its effect has; ; the boolean operation menu leads each entry with an original icon (#2003); glass takes one sample instead of its dispersion window where the colours split under 1/256 px; glass bends towards its core, and rounded rectangles work it out in closed form; glass's light is a line on its bevel and splay turns the bend towards the centre; glass bends with a thick-lens profile and splits its colours over 8 steps; glass effects take variables and keep their frost within 0–100; web host bridge: `?host=parent` or `data-host="page"` hands a page the app's files, documented in the hosting guide; a connector end moved with Cmd/Ctrl held goes on any part of an object, and stays there as the object moves or resizes; a tap on a plugin panel's button keeps what was typed in its fields; a Dash cap setting (none, round or square) on Dash and Custom strokes, drawn on both ends of every dash; library analytics list how many layers and files use each style and variable; the Controller menu names each button as PlayStation and Switch controllers do; widgets draw lines and SVG pictures (plugin API 6); a connector end dropped along a side of a shape attaches to that side (#1708); regression tests pin a rounded shape's one-sided stroke and SVG ids and font families without XML-forbidden characters (#1351, #1124); a damaged image is refused with a reason instead of showing as an empty box (#1474); an image copied in another app pastes again on the desktop, and in the browser for the first time (#492); SwiftUI and Compose code names a bound variable by its iOS or Android code syntax; the colour picker's Image tab shows a placeholder and Upload from computer, an asset preview, and a file dropped on it replaces the image, keeping the fill mode, crop and position (#1682); the Frame tool's Phone presets have the iPhone 17 family (#1691); Show in folder works in the Flatpak build and selects the file on Linux (#1701); a dashed line starts and ends with a half-length dash, on the canvas and in exports; the Pages, Layers and Assets search fields keep their text in the middle of the field (#1703); a board connector's path can be reshaped by dragging its path handles (#1710); boards have 16 more shapes (arrows, polygons, star, plus and flowchart symbols), in pickers that lay them out in a grid; library analytics count insertions and show insertions and detachments over the past 30 days, 90 days or year; a stroke's Custom style takes a dash pattern of any length as a comma-separated list (#1681); a control request can set its own timeout, up to 10 minutes (`timeoutMs`; `figcraft-cli mcp --attach PORT --timeout SECONDS`) (#1696); gap 6: a widget opens its plugin's panel (plugin API 5), whose callbacks redraw it; the keyboard's Menu key opens the context menu, as Shift+F10 does; an Open link action can open in place of the prototype, with "Open in new tab" off (gap 15); a collection of this file can be extended (Extend collection on its row, `variable.extendCollection`), its extension following its edits at once, and extended collections extend again in the file; the eyedropper with Cmd/Ctrl+Shift makes a colour style or variable of what it picks; a live session's welcome sends the document compressed to clients that read it, about seven times smaller (#1665); a control request that times out says truthfully whether it was dropped or is still running and will take effect, and only screenshots and input blame the window (#1673); a board keeps earlier votes' results, listed newest first in Results and deleted one at a time; the object a stamp will stick to is outlined while the stamp tool is over it or a stamp is dragged over it, and board objects take no drops (gap 24); a server can list the files shared from it now for everyone who reaches it, Home ▸ Online shows them and their links carry no secret (`team_files`, part of #742); team library analytics count detached instances per component and file (gap 10); skipping the Open link notice by command is saved with the preferences at once (gap 15); a selected connector's bar on a board sets its start and end points, solid or dashed, its weight and any colour (#1596); cells copied from a spreadsheet paste onto a board as a table; a long layer name stays on one line in the Export button and the Dev Mode header, ending with an ellipsis, and no longer covers the Design panel (#1650); with hundreds of layers selected, the Design panel and the selection overlays stop going over the whole selection on every frame, so dragging 648 layers averages about 1.1 ms of UI per frame (#1571); plugin panels show pictures: an `image` control, base64 within 256 KB and 4,096 px a side, named by its label (gap 6); `.fig` connector labels without a saved snapshot are kept, centred on their line (gap 1); a drag moving many layers re-runs only what sits around them, not each layer's bindings, sizing, text and instance checks, on every move (#1571); damaged font tracking table offsets are checked instead of wrapping on 32-bit targets, and font indexing makes its existing offset bounds explicit (#1125); Bosnian (`bs`) draft catalog; text style dedupe is O(spans) via a last-two cache and fingerprint buckets (#1102); pasted layers whose image the clipboard lacks are named and show a placeholder that reads as missing (#1646); paint-style colours on layers pasted from another design app keep their style instead of turning black (#1638); progress docs cleaned of what merges left twice: rows merged into one, repeated status items removed, and `cargo xtask docs` (in `ci`) fails on a repeated table row or status item; a name typed for a variable or collection finds the one with that exact id before one named like it, and stored mode ids, font family variables and the panels' labels read exact ids (#1613); plugin widgets have hover styles: a layer's `hover` fill, stroke, opacity or text colour shows while the pointer is over it (gap 6); `.fig` elbowed and curved connectors without a saved path are routed like board connectors instead of drawn straight (gap 1); every file a command reads whole by path is a regular file within a cap that fits it: documents 16 GiB, placed images 256 MiB, CLI scripts 1 GiB; `figcraft-cli connect publish` publishes a code repository's code connect mappings to a design file (gap 16); while a drag only moves a large selection, its outlines, box, slots, spacing and Design panel values are worked out once and shifted, not rebuilt on every move (#1571); Shift+Cmd/Ctrl+Enter on a selected board shape adds the next shape already joined to it, and goes on typing (#1597); an imported or pasted file finds an installed family under the other names its fonts give it, and with other case and spacing, instead of reporting it missing (#1292); a development example generates figcraft-cli's shell completions and man pages from its clap definitions (part of #1396); `.fig` ZIP image reads share a total byte budget and count skipped images in the import warnings (#1076); German terminology corrections (M10): gradient stops, OpenType stylistic sets and the Home-screen preference; a component set's property rows fit the 240 px right panel: variant values wrap two to a line there and every + and − stays in view; the server key is checked by comparing SHA-256 hashes of the presented and the kept key, as the deployment guide says (#1130); opening a file contacts no team library server it names until you check it (#1097); a hostile server can no longer grow a client's memory with made-up people, and a session remembers a bounded number of deleted layer ids (#1121); `doc.list` gives AI agents and plugins the open files' names, not their paths (#1117); with a large selection, frames where nothing changed reuse the selection's outlines, box and slots and the Design panel's instance and position values instead of working them out again (#1571); team libraries and plugins larger than the 16 MiB download burst can be downloaded again, more slowly (#1089); a batch keeps one undo snapshot, not one per step (#1099); files nested 256 levels deep import on the browser's 1 MB stack (#1101); SVG and PDF exports count pattern sources and the renders they embed from the layer's depth, so one cap bounds a whole export (#1082); an explicit variables file path (`variable.import`, the `variables` of `file.open` and `file.import`) is refused past 256 MiB or when it isn't a regular file, as the sibling `variables.json` already was (part of #1114); joining and leaving a file nobody is editing reads and writes nothing on the server: it stays loaded a minute after everyone leaves (#1074); opening a `.figcraft` file unpacks at most 6 GiB in all (2 GiB in the browser), every area together (#1079); hovering the canvas hit-tests once per pointer move, not on every frame, and moving an auto layout frame no longer lays out its contents again on every move (#1571); `.fig` instance expansion no longer walks variable nodes for every instance or copies every outer override row into each nested instance (#1077); `comment.people` lists names that were only @mentioned, and `comment.next` and `comment.prompt` carry the mentions too (#1415); grid auto-placement looks for free cells a 64-bit word at a time and skips what blocks it, with the same placements (#1083); with the pen out, Enter or a double-click ends the path and edits the vector with the Move tool instead of drawing on (#1430); a recovery copy made while a version is previewed holds the file, not the version shown; a FigJam `.jam` file opens as a board (#1342); the Actions palette offers only commands that run from it, and no second row reading like a menu item: Place image opens the file dialog (#1574); share links can comment: a third access level beside edit and view, whose holder sees the file live and adds, replies to, reacts to and resolves comments but can't change the design; Preferences ▸ Scroll wheel zoom: a mouse wheel zooms the canvas about the pointer and Cmd/Ctrl+wheel scrolls (#1390); `comment.list {mentions}` lists only the threads that @mention a name (#1415); in the browser an internal error that stops the page keeps its unsaved files, which open again on reload (#1123); boolean operations refuse input past their caps, and a boolean group past them draws without its result (#1104); figcraft-cli parses its arguments with clap, following RFC-0012 (#1396); the selection and hover outlines of rounded rectangles and frames follow their corners (#1506); component properties keep the order they were made in when one is renamed, and Make slot asks for the slot's name first (#1536, #1537); the browser build publishes files to a server, so Share ▸ Online and Publish to server work there (#917); the browser build uses the fonts installed on the computer once asked, each read when text uses it (#1051); SVG import reads `color()` and `color-mix()` colours, with a note and a grey for those it can't (#1550); the portable Windows zip keeps its settings, recovery copies and plugins in `config\` beside the executable, starting with an installed copy's preferences; the window starts on other graphics when its first ones fail before the first frame: Direct3D 12 compiles with FXC and no device compiles wgpu's indirect-validation shaders, then Vulkan, OpenGL and lower requirements on the power-saving GPU (#965, #1438); Thai, Lao, Khmer and Burmese lines break between words (#1219); an AI agent attached over MCP shows where it works (#1416); a manual overlay's position can be dragged on the canvas (#405); one name for live sessions and comments: Preferences ▸ Your name, in the Join dialog too, kept in the browser, and a rename shows at once in the sessions you are in (#1380); requests that change a server's files have a budget per address, the server key's too, and join codes are found by their hash (#1075); the Join dialog shows a join from the click until its file is ready, with Cancel, and a failed join with Try again (#1381); SVG import draws each pattern tile once per scale, within the layer budget (#1080); Vietnamese letters typed with combining marks (decomposed) take one font that has every mark, instead of missing-glyph boxes beside the letter (#1478); comment.list reports each message's @mentions (#1415); mask groups draw only over the area they can paint, and nested isolated layers share one memory budget (#1061); components can't contain their own instances, directly or through other components; `edit.duplicate` returns an id map with `map: true` (#995); the batches kept for reconnecting apps are bounded in bytes by default, and `figcraft-server` takes `max_log_mb` (#1069); MCP and control calls name their document (#998); sibling placement in live sessions searches instead of counting (#1065); an AI agent attached over MCP comments under its own name, with an Agent label (#1414); the instance-swap menus have a search field (#1338); a refused batch's fixes take time linear in the batch (#1063); the connector tool shows the connector it will make while dragging, ends snapping to attach points (#1387); large images on the canvas draw from a smaller copy, so two 16k images no longer lag (#1483); a file's JPEG thumbnail can't crash the home screen (#1491's progressive JPEG check, now shared); `.fig` import: library text styles linked by asset key, and override rows restating a nested level (#1234); `.fig` import keeps the file's saved line breaks while the text and its box are unedited (#1236); Download a missing free font from the Missing fonts window (`font.download`, #754); the web build's wasm back under its 24 MiB gate (#1472); shadows of images with transparent pixels follow their alpha (#1289); Crop image: Object ▸ Crop image, the right-click menu and the image fill row enter crop mode (`image.crop`, #1464); offline Penpot 2.x import/export (#1143); optional batch continue-on-error with per-step outcomes (#1386); the Design panel's sections on one grid (#858); FigJam outer shape outlines and sticky body fallback beside author text (#1341, #1397); images placed at their own size, 2x screenshots in points (#1360); the toolbar on one 32 pt grid, without its Resources button (#1210); M4: zero-length round-capped dashes draw dots; dash expansion uses the existing safety budget; extracted from #1143; Arabic draft catalog; scaled instances keep their scale when their main is rebuilt (#922); .fig embedded images are copied once per blob, not once per hash (#1059); page ruler guides survive save and reopen (#1476); colour picker LCH and OKLCH models; non-ASCII layer names transliterate in code export (#1235); branches in live sessions and branch history entries, gap 17; plugin widgets take text input and a property menu (plugin API 4); boards: templates and tables; boards: a shared timer and voting sessions; boards: the dot grid, connector ends dragged to re-attach, curved connectors; Installed weights of an embedded font family (#1246); `.sketch` import, best effort (Sketch 48 and newer); CJK line breaking: JIS X 4051's line-start and line-end sets completed with the halfwidth small kana, the halfwidth and spacing (semi-)voiced sound marks, the iteration marks 〱–〵 and the halfwidth parentheses, with behaviour cases for each; Adobe Fonts found on macOS (#298); egui 0.37 hidden-capture deadline contract; Dev Mode measurements kept on the canvas and a read-only layers panel; boards: a board area row and progress entry; community fixes in #507, #510, #529 and #530: auto-save, a text box by dragging, batch step references, removing someone from a live session, Russian and Turkish catalogs reviewed, Czech and Indonesian drafts, the Japanese draft completed, zoom previews, the web clipboard, Alt-drag snapping and Cmd+D repeat, recovery copies, crash and rollback fixes, colour emoji, `.fig` import fixes; earlier changes are in the revision history below) · **Target:** Figma Design (desktop app 126.10.7) FigCraft is a clean-room, open-source, pure-Rust reimplementation of the Figma design workflow, native on macOS, Windows, Linux and FreeBSD and in the browser, fully drivable by agents through @@ -365,6 +365,7 @@ Ranked; detail and milestones in [`docs/roadmap.md`](docs/roadmap.md). | Date | Change | Summary | |---|---|---| +| 2026-11-10 | minor | M12, #2226 (step 1 of 4): mind maps in the document and engine. `board.mindMap` places a first node with three children on curved branches and `board.mindMapAdd` adds a child or a sibling; the normalize pass lays a touched map out again from its first node (88 between columns, 48 between siblings, stacks centred on their parents). No toolbar entry yet; numbers unchanged. | | 2026-11-03 | minor | Traditional Chinese (Taiwan) (`zh-Hant`, 繁體中文（台灣）) draft catalog: every UI string (1,975), command label (641) and menu wording (31), translated clean-room from the English source; `zh-TW`, `zh-HK`, `zh-MO` and `zh-Hant` read it while an explicit Hans stays Simplified; the desktop UI prefers an installed Noto Sans CJK TC, then Microsoft JhengHei, PingFang TC and Heiti TC; no font is bundled; native review pending. Numbers unchanged | | 2026-11-06 | patch | M1, #2028: Edit ▸ Set default properties gives new rectangles, ellipses, polygons and stars drawn with the tools (and, set from a text layer, new text) the selected layer's properties; it only copied them for Paste properties. Tests: `default_props_tests` (3). Numbers unchanged | | 2026-11-06 | patch | M5, #2027: `proto.settings` refuses an unknown device name with the list of devices (it saved any string, and the presenter showed no device), takes known names in any case, and answers the page's prototype settings, so `proto.settings {}` reads them back over MCP. Test: `proto_present_tests::unknown_devices_are_refused_and_settings_read_back`. Numbers unchanged | diff --git a/crates/collab/src/board_sync_tests.rs b/crates/collab/src/board_sync_tests.rs index 422d60134..442388477 100644 --- a/crates/collab/src/board_sync_tests.rs +++ b/crates/collab/src/board_sync_tests.rs @@ -29,6 +29,7 @@ fn a_boards_kind_and_its_objects_metadata_sync() { to: End::Point { x: 5.0, y: 5.0 }, routing: Routing::Elbow, path: None, + branch: false, })); let mut r = host.clone(); r.apply(&diff(&host, &edited).unwrap().changes, Mode::Strict).unwrap(); @@ -38,6 +39,7 @@ fn a_boards_kind_and_its_objects_metadata_sync() { to: End::Point { x: 9.0, y: 1.0 }, routing: Routing::Straight, path: None, + branch: false, })); let d = diff(&r, &moved).unwrap(); assert!(matches!(d.changes.as_slice(), [Change::Set { prop: Prop::Board, .. }]), "{:?}", d.changes); diff --git a/crates/doc/src/board.rs b/crates/doc/src/board.rs index 89413b2e9..bcd6452e8 100644 --- a/crates/doc/src/board.rs +++ b/crates/doc/src/board.rs @@ -62,18 +62,29 @@ pub enum BoardItem { /// A table: a frame of row frames holding cell frames with text (its column lines are thin /// rectangles laid over it). Table, + /// A mind map's node: a frame hugging its text, with no outline. What it hangs from is the + /// branch (a connector with `branch`) arriving at it. + MindNode, } impl BoardItem { /// Objects selected and moved as a whole: a click on their text or outline picks them, and /// they never take other layers in. pub fn is_atom(&self) -> bool { - matches!(self, BoardItem::Sticky { .. } | BoardItem::Shape { .. } | BoardItem::Label { .. } | BoardItem::Stamp { .. } | BoardItem::Table) + matches!( + self, + BoardItem::Sticky { .. } + | BoardItem::Shape { .. } + | BoardItem::Label { .. } + | BoardItem::Stamp { .. } + | BoardItem::Table + | BoardItem::MindNode + ) } /// Objects whose first text layer is their text (a double-click or Enter edits it). pub fn has_text(&self) -> bool { - matches!(self, BoardItem::Sticky { .. } | BoardItem::Shape { .. } | BoardItem::Label { .. }) + matches!(self, BoardItem::Sticky { .. } | BoardItem::Shape { .. } | BoardItem::Label { .. } | BoardItem::MindNode) } /// Who made it (stickies and stamps; empty when unknown). @@ -115,6 +126,7 @@ impl BoardItem { BoardItem::Stamp { .. } => "stamp", BoardItem::Ink => "ink", BoardItem::Table => "table", + BoardItem::MindNode => "mindNode", } } } @@ -619,4 +631,7 @@ pub struct Connector { /// Its path as reshaped by hand; `None`: routed by itself. #[serde(default, skip_serializing_if = "Option::is_none")] pub path: Option, + /// A mind map's branch: `from` is the parent, `to` the child. The map's shape is read from these. + #[serde(default, skip_serializing_if = "crate::node::is_default")] + pub branch: bool, } diff --git a/crates/doc/src/board_mindmap.rs b/crates/doc/src/board_mindmap.rs new file mode 100644 index 000000000..53b72fbc3 --- /dev/null +++ b/crates/doc/src/board_mindmap.rs @@ -0,0 +1,138 @@ +//! Mind map layout: where the nodes of a map go, from their sizes and their tree. Pure geometry, +//! like `board_route`; the engine's normalize pass reads the tree from the branches and moves the +//! layers (#2226). + +use figcraft_geom::{Point, Rect}; + +use crate::NodeId; + +/// The room between a node's column and its children's column. +pub const MIND_GAP_X: f64 = 88.0; +/// The room between a node (with everything under it) and the next one below. +pub const MIND_GAP_Y: f64 = 48.0; +/// The most nodes one map is laid out with (a larger one is left as it is). +pub const MIND_MAX_NODES: usize = 2000; +/// The deepest level of a map that is laid out (the first node is level 0). +pub const MIND_MAX_DEPTH: usize = 64; + +/// One node of a mind map as the layout sees it. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct MindBox { + pub id: NodeId, + /// Its box on the page now. The root's stays; of the others only the size counts, and the + /// centre's y, which orders siblings. + pub rect: Rect, + /// Its parent's index in the slice (`None`: the root, entry 0). Always a smaller index. + pub parent: Option, + /// Left of the root. Read on the root's children only: deeper nodes follow their parent. + pub left: bool, +} + +fn finite(r: Rect) -> bool { + [r.x0, r.y0, r.x1, r.y1].iter().all(|v| v.is_finite()) +} + +/// Where every node but the root goes: its box's top-left on the page. Nodes whose parent isn't +/// an earlier entry, that are deeper than [`MIND_MAX_DEPTH`] or that would land off the finite +/// plane are left out; a slice that is empty, longer than [`MIND_MAX_NODES`], whose first entry +/// has a parent or that holds a box that is not finite is left alone altogether. +pub fn mind_layout(nodes: &[MindBox]) -> Vec<(NodeId, Point)> { + let n = nodes.len(); + let Some(root) = nodes.first().filter(|r| r.parent.is_none()) else { return Vec::new() }; + if n > MIND_MAX_NODES || !nodes.iter().all(|b| finite(b.rect)) { + return Vec::new(); + } + // The tree: who is a child of whom, which side of the root it is on, how deep. + let (mut left, mut depth, mut valid) = (vec![false; n], vec![0_usize; n], vec![false; n]); + if let Some(v) = valid.first_mut() { + *v = true; + } + // Children by parent and side (0: right, 1: left; below the root only the parent's side is used). + let mut kids: Vec<[Vec; 2]> = vec![[Vec::new(), Vec::new()]; n]; + for (i, b) in nodes.iter().enumerate().skip(1) { + let Some(p) = b.parent.filter(|p| *p < i && valid.get(*p).copied().unwrap_or(false)) else { continue }; + let d = depth.get(p).copied().unwrap_or(0) + 1; + if d > MIND_MAX_DEPTH { + continue; + } + let side = if p == 0 { b.left } else { left.get(p).copied().unwrap_or(false) }; + if let (Some(v), Some(l), Some(dp)) = (valid.get_mut(i), left.get_mut(i), depth.get_mut(i)) { + (*v, *l, *dp) = (true, side, d); + } + if let Some(k) = kids.get_mut(p) { + k[usize::from(side)].push(i); + } + } + // Siblings keep the order they are in: by their middles, then by id. + for k in kids.iter_mut().flatten() { + k.sort_by(|a, b| { + let (x, y) = (nodes.get(*a), nodes.get(*b)); + match (x, y) { + (Some(x), Some(y)) => x.rect.center().y.total_cmp(&y.rect.center().y).then(x.id.cmp(&y.id)), + _ => std::cmp::Ordering::Equal, + } + }); + } + let height = |i: usize| nodes.get(i).map_or(0.0, |b| b.rect.height()); + let width = |i: usize| nodes.get(i).map_or(0.0, |b| b.rect.width()); + // Span, backward: a node's room is its own height or its children's stack, whichever is more. + let stack = |span: &[f64], list: &[usize]| { + let total: f64 = list.iter().map(|c| span.get(*c).copied().unwrap_or(0.0)).sum(); + total + MIND_GAP_Y * list.len().saturating_sub(1) as f64 + }; + let mut span = vec![0.0_f64; n]; + for i in (1..n).rev() { + let own = kids.get(i).map_or(0.0, |k| stack(&span, &k[usize::from(left.get(i).copied().unwrap_or(false))])); + if let Some(s) = span.get_mut(i) { + *s = height(i).max(own); + } + } + // Place, forward. `column[i]`: where node i's children's column begins (its left edge on the + // right side, its right edge on the left side); `centre[i]`: its middle. + let mut column = vec![0.0_f64; n]; + let mut centre = vec![0.0_f64; n]; + let mut out = Vec::new(); + let root_c = root.rect.center().y; + if let Some(c) = centre.first_mut() { + *c = root_c; + } + let mut ok = vec![false; n]; + if let Some(o) = ok.first_mut() { + *o = true; + } + for i in 0..n { + if !ok.get(i).copied().unwrap_or(false) { + continue; + } + let Some(k) = kids.get(i) else { continue }; + for side in [false, true] { + let list = k[usize::from(side)].as_slice(); + if list.is_empty() { + continue; + } + // The column the group starts in: past the widest node of its parent's own group. + let x = + if i == 0 { if side { root.rect.x0 - MIND_GAP_X } else { root.rect.x1 + MIND_GAP_X } } else { column.get(i).copied().unwrap_or(0.0) }; + let widest = list.iter().map(|c| width(*c)).fold(0.0, f64::max); + let mut top = centre.get(i).copied().unwrap_or(0.0) - stack(&span, list) / 2.0; + for &c in list { + let s = span.get(c).copied().unwrap_or(0.0); + let mid = top + s / 2.0; + let at = Point::new(if side { x - width(c) } else { x }, mid - height(c) / 2.0); + top += s + MIND_GAP_Y; + if !(at.x.is_finite() && at.y.is_finite() && mid.is_finite()) { + continue; + } + if let (Some(m), Some(col), Some(o)) = (centre.get_mut(c), column.get_mut(c), ok.get_mut(c)) { + *m = mid; + *col = if side { x - widest - MIND_GAP_X } else { x + widest + MIND_GAP_X }; + *o = true; + } + if let Some(b) = nodes.get(c) { + out.push((b.id, at)); + } + } + } + } + out +} diff --git a/crates/doc/src/board_mindmap_tests.rs b/crates/doc/src/board_mindmap_tests.rs new file mode 100644 index 000000000..add424574 --- /dev/null +++ b/crates/doc/src/board_mindmap_tests.rs @@ -0,0 +1,99 @@ +//! Mind map layout (`board_mindmap`): columns 88 apart, siblings 48 apart, stacks centred on their +//! parents (#2226). + +use figcraft_geom::{Point, Rect}; + +use crate::NodeId; +use crate::board_mindmap::{MIND_GAP_X, MIND_GAP_Y, MIND_MAX_NODES, MindBox, mind_layout}; + +/// The first node, always at the origin, 200 x 36. +fn root() -> MindBox { + MindBox { id: NodeId(1), rect: Rect::new(0.0, 0.0, 200.0, 36.0), parent: None, left: false } +} + +/// A node `w` x `h` whose current top is `y` (only its middle, which orders siblings, counts). +fn node(id: u64, parent: usize, (w, h): (f64, f64), y: f64) -> MindBox { + MindBox { id: NodeId(id), rect: Rect::new(0.0, y, w, y + h), parent: Some(parent), left: false } +} + +fn at(placed: &[(NodeId, Point)], id: u64) -> (f64, f64) { + let p = placed.iter().find(|(n, _)| *n == NodeId(id)).map(|(_, p)| *p).unwrap_or_else(|| panic!("node {id} not placed in {placed:?}")); + (p.x, p.y) +} + +/// The root and three children (100, 60 and 80 wide) whose middles are in that order; `middle` is +/// the second child's size. +fn three(middle: (f64, f64)) -> Vec { + vec![root(), node(2, 0, (100.0, 24.0), 0.0), node(3, 0, middle, 22.0 - middle.1 / 2.0), node(4, 0, (80.0, 24.0), 20.0)] +} + +/// The root, two children (100 and 60 wide) under it, two more under the first and one under the second. +fn six() -> Vec { + vec![ + root(), + node(2, 0, (100.0, 24.0), 0.0), + node(3, 0, (60.0, 24.0), 10.0), + node(4, 1, (40.0, 24.0), 0.0), + node(5, 1, (40.0, 24.0), 10.0), + node(6, 2, (40.0, 24.0), 0.0), + ] +} + +#[test] +fn three_children_stand_88_right_of_the_root_72_apart_centred_on_it() { + assert_eq!((MIND_GAP_X, MIND_GAP_Y), (88.0, 48.0)); + let placed = mind_layout(&three((60.0, 24.0))); + assert_eq!([at(&placed, 2), at(&placed, 3), at(&placed, 4)], [(288.0, -66.0), (288.0, 6.0), (288.0, 78.0)]); + assert!(placed.iter().all(|(n, _)| *n != NodeId(1)), "the first node stays where it is"); +} + +#[test] +fn a_taller_node_pushes_its_neighbours_half_its_growth_each_way() { + let placed = mind_layout(&three((60.0, 72.0))); + assert_eq!([at(&placed, 2), at(&placed, 3), at(&placed, 4)], [(288.0, -90.0), (288.0, -18.0), (288.0, 102.0)]); +} + +#[test] +fn grandchildren_share_a_column_past_the_widest_sibling_and_their_parents_make_room() { + let nodes = six(); + let placed = mind_layout(&nodes); + // 476 = 288 + 100 + 88, although B is only 60 wide. + let got: Vec<(f64, f64)> = (2..=6).map(|i| at(&placed, i)).collect(); + assert_eq!(got, [(288.0, -30.0), (288.0, 78.0), (476.0, -66.0), (476.0, 6.0), (476.0, 78.0)]); +} + +#[test] +fn left_children_mirror_the_right_ones() { + let mut l = node(2, 0, (80.0, 24.0), 0.0); + l.left = true; + let placed = mind_layout(&[root(), l, node(3, 1, (50.0, 24.0), 0.0)]); + assert_eq!((at(&placed, 2), at(&placed, 3)), ((-168.0, 6.0), (-306.0, 6.0))); +} + +#[test] +fn the_layout_is_a_fixed_point_ties_go_by_id_and_junk_is_skipped() { + let nodes = six(); + let placed = mind_layout(&nodes); + let again: Vec = nodes + .iter() + .map(|b| { + let p = placed.iter().find(|(n, _)| *n == b.id).map_or(b.rect.origin(), |(_, p)| *p); + MindBox { rect: Rect::from_origin_size(p, b.rect.size()), ..*b } + }) + .collect(); + assert_eq!(mind_layout(&again), placed, "a laid out map is left as it is"); + // The same height: the lower id goes first. + let tied = mind_layout(&[root(), node(9, 0, (10.0, 24.0), 5.0), node(7, 0, (10.0, 24.0), 5.0)]); + assert!(at(&tied, 7).1 < at(&tied, 9).1); + // Junk: nothing placed, nothing panics. + assert!(mind_layout(&[]).is_empty()); + let mut nan = three((60.0, 24.0)); + nan[2].rect = Rect::new(f64::NAN, 0.0, 1.0, 1.0); + assert!(mind_layout(&nan).is_empty()); + let mut orphan = three((60.0, 24.0)); + orphan.push(node(8, 9, (10.0, 24.0), 0.0)); + assert!(!mind_layout(&orphan).iter().any(|(n, _)| *n == NodeId(8)), "a parent that doesn't come first"); + let mut huge = vec![root()]; + huge.extend((0..MIND_MAX_NODES as u64).map(|i| node(i + 2, 0, (10.0, 24.0), i as f64))); + assert!(mind_layout(&huge).is_empty()); +} diff --git a/crates/doc/src/lib.rs b/crates/doc/src/lib.rs index 81760d718..6a0c2aedf 100644 --- a/crates/doc/src/lib.rs +++ b/crates/doc/src/lib.rs @@ -9,6 +9,7 @@ #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)] pub mod board; +mod board_mindmap; mod board_route; pub mod colors; pub mod comments; @@ -27,6 +28,7 @@ pub mod vector_faces; pub mod vector_regions; pub use board::*; +pub use board_mindmap::{MIND_GAP_X, MIND_GAP_Y, MIND_MAX_DEPTH, MIND_MAX_NODES, MindBox, mind_layout}; pub use board_route::{END_GAP, MAX_RUNS, RouteEnd, attach_points, attached_sides, path_handles, reshaped, route_along, route_points}; pub use colors::*; pub use comments::*; @@ -1314,6 +1316,8 @@ fn remap_action(a: &mut proto::Action, map: &BTreeMap) { #[cfg(test)] mod blur_tests; #[cfg(test)] +mod board_mindmap_tests; +#[cfg(test)] mod board_route_tests; #[cfg(test)] mod board_shape_tests; diff --git a/crates/doc/src/props.rs b/crates/doc/src/props.rs index 99b9d9c39..15d557d88 100644 --- a/crates/doc/src/props.rs +++ b/crates/doc/src/props.rs @@ -1399,6 +1399,10 @@ impl ExportSize { Some((i, c)) if c.is_ascii_alphabetic() => (s.get(..i)?.trim(), Some(c)), _ => (s.as_str(), None), }; + // Plain decimal only: no sign, exponent, "inf" or "nan". + if !num.bytes().all(|b| b.is_ascii_digit() || b == b'.') { + return None; + } let value: f64 = num.parse().ok()?; match unit { None | Some('x') => ExportSize::Scale { value }, diff --git a/crates/doc/src/text.rs b/crates/doc/src/text.rs index b9587293e..390aa703f 100644 --- a/crates/doc/src/text.rs +++ b/crates/doc/src/text.rs @@ -886,6 +886,25 @@ impl TextData { } pl.indent = pl.indent.min(MAX_LIST_INDENT); } + self.fold_paragraph_lists(); + } + + /// Give paragraphs `a..=b` (by index) no start number of their own, as an item made by Enter + /// has none. Touches nothing else: a plain paragraph keeps its level, a bullet its settings. + /// One pass over the range, and nothing at all when no paragraph carries a start. + pub fn clear_list_starts(&mut self, a: usize, b: usize) { + if self.paragraphs.iter().all(|p| p.start_offset == 0) { + return; + } + self.fill_paragraphs(); + for pl in self.paragraphs.get_mut(a..=b).unwrap_or(&mut []) { + pl.start_offset = 0; + } + self.fold_paragraph_lists(); + } + + /// One style for all paragraphs with no nesting or start folds back into `list`. + fn fold_paragraph_lists(&mut self) { if let Some(first) = self.paragraphs.first().copied() && first == (ParaList { list: first.list, ..ParaList::default() }) && self.paragraphs.iter().all(|p| *p == first) @@ -1104,6 +1123,25 @@ mod case_tests { t.set_para_lists(0, 0, |p| p.list = P); assert_eq!(t.para_list(0), ParaList::default()); } + + #[test] + fn clear_list_starts_touches_only_starts() { + use ListStyle::{None as P, Numbered as N}; + let mut t = TextData { characters: "a\nb\nc".into(), ..Default::default() }; + t.paragraphs = vec![ + ParaList { list: N, start_offset: 4, ..ParaList::default() }, + ParaList { list: P, indent: 1, ..ParaList::default() }, + ParaList { list: N, indent: 2, start_offset: 7, ..ParaList::default() }, + ]; + t.clear_list_starts(1, 2); + assert_eq!(t.para_list(0).start_offset, 4, "outside the range"); + assert_eq!(t.para_list(1), ParaList { list: P, indent: 1, ..ParaList::default() }, "a plain paragraph keeps its level"); + assert_eq!(t.para_list(2), ParaList { list: N, indent: 2, start_offset: 0, ..ParaList::default() }); + // Out of range and no-start cases leave it alone. + t.clear_list_starts(5, 9); + t.clear_list_starts(0, 0); + assert_eq!(t.para_list(0).start_offset, 0); + } } #[cfg(test)] diff --git a/crates/engine/src/al_drag_tests.rs b/crates/engine/src/al_drag_tests.rs index 528fdd9d7..0c5119fc5 100644 --- a/crates/engine/src/al_drag_tests.rs +++ b/crates/engine/src/al_drag_tests.rs @@ -69,3 +69,100 @@ fn grid_drag_takes_the_cell_under_the_pointer() { let cl = s.doc().unwrap().node(kids[0]).unwrap().child_layout.clone(); assert_eq!((cl.grid_column, cl.grid_row), (None, None), "one undo step"); } + +/// Three 60 x 60 rectangles in a row (or column), gap 20, at 0, 80 and 160 along the flow. +fn three(s: &mut Session, mode: &str) -> (NodeId, [NodeId; 3]) { + let f = id(s.execute("frame.create", &json!({"x": 0, "y": 0, "width": 300, "height": 300})).unwrap()); + let kids: Vec = + (0..3).map(|_| id(s.execute("shape.rectangle", &json!({"x": 0, "y": 0, "width": 60, "height": 60, "parent": f})).unwrap())).collect(); + s.execute("layout.add", &json!({"ids": [f]})).unwrap(); + s.execute("node.set", &json!({"id": f, "props": {"layoutMode": mode, "gap": 20, "padding": 0, "sizingH": "fixed", "sizingV": "fixed"}})).unwrap(); + s.execute("select.none", &json!({})).unwrap(); + (f, [kids[0], kids[1], kids[2]]) +} + +/// The order after dragging kid `which` by `by` along the flow, grabbed `grab` from its start edge. +fn dragged_order(mode: &str, which: usize, grab: f64, by: f64) -> Vec { + let mut s = Session::new(); + let (f, kids) = three(&mut s, mode); + let vertical = mode == "vertical"; + let b = s.doc().unwrap().world_bounds(kids[which]).unwrap(); + let from = if vertical { (b.center().x, b.y0 + grab) } else { (b.x0 + grab, b.center().y) }; + let to = if vertical { (from.0, from.1 + by) } else { (from.0 + by, from.1) }; + drag(&mut s, from, to); + let order = s.doc().unwrap().node(f).unwrap().children.clone(); + order.iter().map(|c| kids.iter().position(|k| k == c).unwrap()).collect() +} + +#[test] +fn a_child_dragged_right_passes_a_sibling_when_its_leading_edge_reaches_the_siblings_middle() { + assert_eq!(dragged_order("horizontal", 0, 30.0, 49.0), vec![0, 1, 2]); + assert_eq!(dragged_order("horizontal", 0, 30.0, 50.0), vec![1, 0, 2]); + assert_eq!(dragged_order("horizontal", 0, 30.0, 129.0), vec![1, 0, 2]); + assert_eq!(dragged_order("horizontal", 0, 30.0, 130.0), vec![1, 2, 0]); +} + +#[test] +fn where_the_child_is_grabbed_does_not_change_its_slot() { + assert_eq!(dragged_order("horizontal", 0, 10.0, 49.0), vec![0, 1, 2]); + assert_eq!(dragged_order("horizontal", 0, 10.0, 50.0), vec![1, 0, 2]); + assert_eq!(dragged_order("horizontal", 0, 10.0, 129.0), vec![1, 0, 2]); + assert_eq!(dragged_order("horizontal", 0, 10.0, 130.0), vec![1, 2, 0]); +} + +#[test] +fn a_child_dragged_left_passes_a_sibling_by_its_left_edge() { + assert_eq!(dragged_order("horizontal", 2, 30.0, -49.0), vec![0, 1, 2]); + assert_eq!(dragged_order("horizontal", 2, 30.0, -50.0), vec![0, 2, 1]); + assert_eq!(dragged_order("horizontal", 2, 30.0, -130.0), vec![2, 0, 1]); +} + +#[test] +fn a_column_reorders_by_the_bottom_edge() { + assert_eq!(dragged_order("vertical", 0, 30.0, 50.0), vec![1, 0, 2]); + assert_eq!(dragged_order("vertical", 0, 30.0, 130.0), vec![1, 2, 0]); +} + +#[test] +fn a_child_dragged_left_passes_the_second_sibling_one_pixel_later() { + assert_eq!(dragged_order("horizontal", 2, 30.0, -129.0), vec![0, 2, 1]); +} + +#[test] +fn a_column_reorders_at_the_boundaries_both_ways() { + assert_eq!(dragged_order("vertical", 0, 30.0, 49.0), vec![0, 1, 2]); + assert_eq!(dragged_order("vertical", 0, 30.0, 129.0), vec![1, 0, 2]); + assert_eq!(dragged_order("vertical", 2, 30.0, -49.0), vec![0, 1, 2]); + assert_eq!(dragged_order("vertical", 2, 30.0, -50.0), vec![0, 2, 1]); + assert_eq!(dragged_order("vertical", 2, 30.0, -129.0), vec![0, 2, 1]); + assert_eq!(dragged_order("vertical", 2, 30.0, -130.0), vec![2, 0, 1]); +} + +#[test] +fn a_drag_with_no_move_along_the_flow_keeps_the_slot() { + // Back at the start, and a drag across the flow only, with snapping on (the default). + assert_eq!(dragged_order("horizontal", 1, 30.0, 0.0), vec![0, 1, 2]); + assert_eq!(dragged_order("vertical", 1, 30.0, 0.0), vec![0, 1, 2]); + let mut s = Session::new(); + let (f, kids) = three(&mut s, "horizontal"); + let b = s.doc().unwrap().world_bounds(kids[1]).unwrap(); + let from = (b.center().x, b.center().y); + drag(&mut s, from, (from.0, from.1 + 40.0)); + let order = s.doc().unwrap().node(f).unwrap().children.clone(); + assert_eq!(order, kids.to_vec()); +} + +#[test] +fn several_dragged_children_use_their_combined_box() { + // Kids 0 and 1 together span 0..140; moved right by 49 the leading edge is at 189, just short of the middle of kid 2 (190). + for (by, expected) in [(49.0, vec![0, 1, 2]), (50.0, vec![2, 0, 1])] { + let mut s = Session::new(); + let (f, kids) = three(&mut s, "horizontal"); + s.execute("select.set", &json!({"ids": [kids[0], kids[1]]})).unwrap(); + let b = s.doc().unwrap().world_bounds(kids[0]).unwrap(); + let from = (b.center().x, b.center().y); + drag(&mut s, from, (from.0 + by, from.1)); + let order: Vec = s.doc().unwrap().node(f).unwrap().children.iter().map(|c| kids.iter().position(|k| k == c).unwrap()).collect(); + assert_eq!(order, expected, "by {by}"); + } +} diff --git a/crates/engine/src/automation/file_access.rs b/crates/engine/src/automation/file_access.rs index 5ce06b122..249d3483c 100644 --- a/crates/engine/src/automation/file_access.rs +++ b/crates/engine/src/automation/file_access.rs @@ -12,6 +12,11 @@ //! existing folder is resolved and the rest must be plain names. The comparison is by whole //! components (`/work2` is not inside `/work`), and the I/O uses the resolved path, so what was //! checked is what is opened. +//! +//! On Windows, resolving a path opens it, and opening a path on another computer contacts that +//! computer and may send it the signed-in user's credentials. So on Windows, before anything is +//! resolved, a path on another computer whose share no root is on, a device path, or one reached +//! through a link that leads to them is refused by how it is spelled (#1094). #![allow(clippy::disallowed_methods)] use std::cell::RefCell; @@ -19,6 +24,8 @@ use std::ffi::{OsStr, OsString}; use std::path::{Component, Path, PathBuf}; use std::sync::Arc; +use craft_docpath::Refused; + use crate::{EngineError, Result}; /// What a command does with a file. @@ -58,6 +65,19 @@ impl Roots { Access::Read => ([self.read.as_slice(), self.write.as_slice()].concat(), "read"), Access::Write => (self.write.clone(), "written"), }; + if cfg!(windows) { + match refused_unresolved(path, &roots) { + Some(Unresolved::Spelled(Refused::Network)) => { + return Err(format!( + "automation path rejected: {asked} is on another computer, and no folder that may be {what} is on its share" + )); + } + Some(Unresolved::Spelled(_)) => return Err(format!("automation path rejected: {asked} names a device, not a file")), + // Where a link leads is only told by the usual message: it would say what is there. + Some(Unresolved::Linked) => return Err(outside(asked, &roots, what)), + None => {} + } + } match resolve(path) { Ok(resolved) if roots.iter().any(|r| resolved.starts_with(r)) => return Ok(resolved), Ok(_) => {} @@ -65,11 +85,7 @@ impl Roots { Err(why) if inside_as_far_as_it_exists(path, &roots) => return Err(format!("automation path rejected: {asked}: {why}")), Err(_) => {} } - if roots.is_empty() { - return Err(format!("automation path rejected: no folder may be {what} (no root for it was given): {asked}")); - } - let shown: Vec = roots.iter().map(|r| shown(r)).collect(); - Err(format!("automation path rejected: {asked} is outside the folders that may be {what}: {}", shown.join(", "))) + Err(outside(asked, &roots, what)) } /// The folders as JSON, resolved: `{read: [every folder that may be read], write: [the write roots]}`. @@ -79,23 +95,165 @@ impl Roots { } } +/// Why `asked` is refused: it is outside every one of `roots`, the folders that may be `what` +/// ("read" or "written"). The message lists those folders, or says that no folder may be `what` +/// when `roots` is empty. +fn outside(asked: std::path::Display<'_>, roots: &[PathBuf], what: &str) -> String { + if roots.is_empty() { + return format!("automation path rejected: no folder may be {what} (no root for it was given): {asked}"); + } + let shown: Vec = roots.iter().map(|r| shown(r)).collect(); + format!("automation path rejected: {asked} is outside the folders that may be {what}: {}", shown.join(", ")) +} + +/// Why a path is refused before it is resolved (#1094). +#[derive(Debug, PartialEq, Eq)] +enum Unresolved { + /// Its spelling leads to another computer ([`Refused::Network`]) or a device ([`Refused::Device`]). + Spelled(Refused), + /// A link on the way leads there, or the way there can't be looked at: a link or folder on it + /// can't be read, it has more than [`MAX_LINKS`] links, or the path can't be made absolute. + Linked, +} + +/// How many links are followed on the way to a path before it is given up on, as on Linux. +const MAX_LINKS: u8 = 40; + +/// Why `path` is refused before anything on the way to it is opened, if it is: resolving it would +/// open a path on another computer, which on Windows contacts that computer and may send it the +/// signed-in user's credentials, or open a device (#1094). That is the case when the path as +/// given or made absolute is refused by its spelling ([`refused_spelling`]), or when a link on +/// the way, or on the way on from where one leads, leads to such a path ([`link_refused`]). A path +/// on the share of one of `roots` goes on to the usual check. A path that can't be made absolute +/// is refused as well, rather than left to what comes next. +fn refused_unresolved(path: &Path, roots: &[PathBuf]) -> Option { + // Made absolute without looking at the disk (on Windows `GetFullPathNameW`, which also turns a + // bare device name such as `NUL` into `\\.\NUL`, as opening it would). Like opening, it takes + // `..` by name, so `link\..\x` is `x` and never goes through the link. + let Ok(abs) = std::path::absolute(path) else { return Some(Unresolved::Linked) }; + if let Some(why) = [path, abs.as_path()].into_iter().find_map(|p| refused_spelling(&p.to_string_lossy(), roots)) { + return Some(Unresolved::Spelled(why)); + } + link_refused(&abs, roots, MAX_LINKS, &on_disk).then_some(Unresolved::Linked) +} + +/// What is at a path, looked at without following a link there. +#[derive(Debug, Clone, PartialEq, Eq)] +enum Entry { + /// Nothing ([`nothing_there`]): resolving the path meets the same there and goes no further. + Missing, + /// Something that can't be looked at (no permission, for one). It may be a link that resolving + /// the path would still follow, so the path is refused. + Unreadable, + /// A file or a folder. + Plain, + /// A link, with where it leads (`None` when that can't be read). + Link(Option), +} + +/// What is at `p` on disk (see [`Entry`]), looked at with [`std::fs::symlink_metadata`], which +/// doesn't follow a link there; a link's target is read with [`std::fs::read_link`]. +fn on_disk(p: &Path) -> Entry { + match std::fs::symlink_metadata(p) { + Ok(m) if m.is_symlink() => Entry::Link(std::fs::read_link(p).ok()), + Ok(_) => Entry::Plain, + Err(e) if nothing_there(&e) => Entry::Missing, + Err(_) => Entry::Unreadable, + } +} + +/// Whether looking at a path failed with `e` because nothing is there: no such name, a file where +/// a folder was expected, or a name no file can have. Any other failure says nothing about what is +/// there. +fn nothing_there(e: &std::io::Error) -> bool { + use std::io::ErrorKind::{InvalidFilename, NotADirectory, NotFound}; + matches!(e.kind(), NotFound | NotADirectory | InvalidFilename) +} + +/// Why path `p` is refused by its spelling alone, if it is (see [`craft_docpath::resolve`], which +/// reads both `/` and `\` as separators and compares names ignoring case): +/// - on another computer (`\\server\share`, `//server/share`, `\\?\UNC\…`, `\\.\UNC\…`, or a +/// server without a share) and on no root's share; +/// - a device path (`\\.\pipe\…`, `\\?\GLOBALROOT\…`, `\\.\C:\…`), other than a local volume's +/// `\\?\Volume{…}\` or `\\.\Volume{…}\`, which a folder can be mounted as; +/// - or with a device name (`CON`, `NUL`, `COM1.png`, `lpt1 `…) as any of its names: each folder on +/// the way is opened in turn while the path is resolved, and the device behind a name such as +/// `LPT1` can be a printer on another computer. +fn refused_spelling(p: &str, roots: &[PathBuf]) -> Option { + match craft_docpath::resolve(p, None) { + // With a root passed as the document path (what a link would be relative to), a path on + // that root's share is allowed. + Err(Refused::Network) if !roots.iter().any(|r| craft_docpath::resolve(p, Some(r)) != Err(Refused::Network)) => { + return Some(Refused::Network); + } + Err(Refused::Device) if !is_volume(p) => return Some(Refused::Device), + _ => {} + } + // `craft_docpath` stops at the first name it refuses, which may not be the device's. + p.split(['\\', '/']).any(device_name).then_some(Refused::Device) +} + +/// Whether `p` is in a local volume by its `\\?\Volume{…}` (or `\\.\Volume{…}`) name. +fn is_volume(p: &str) -> bool { + let mut names = p.split(['\\', '/']); + let (Some(""), Some(""), Some("?" | "."), Some(volume)) = (names.next(), names.next(), names.next(), names.next()) else { + return false; + }; + volume.get(..7).is_some_and(|v| v.eq_ignore_ascii_case("Volume{")) && volume.ends_with('}') +} + +/// Whether a link on the way to `abs` (an absolute path) leads to a path [`refused_spelling`] +/// refuses, following at most `links` links: one that leads to another, or on through further +/// links, is followed too, as resolving the path would. A link that can't be read, a name on the +/// way that can't be looked at ([`Entry::Unreadable`]), or more links than that, are refused as +/// well. Each name on the way is looked at with `look` ([`on_disk`]), which doesn't follow a +/// link: where a link leads is looked at only once its spelling is known not to be refused. +fn link_refused(abs: &Path, roots: &[PathBuf], links: u8, look: &dyn Fn(&Path) -> Entry) -> bool { + let mut at = PathBuf::new(); + let mut rest = abs.components(); + while let Some(c) = rest.next() { + at.push(c); + if !matches!(c, Component::Normal(_)) { + continue; + } + let target = match look(&at) { + Entry::Plain => continue, + // Nothing is below what isn't there, so no link either. + Entry::Missing => return false, + Entry::Unreadable => return true, + Entry::Link(target) => target, + }; + let (Some(links), Some(target)) = (links.checked_sub(1), target) else { return true }; + // A relative target is relative to the link's folder; an absolute one replaces it. + let next = lexical(&at.parent().unwrap_or(&at).join(target).join(rest.as_path())); + return refused_spelling(&next.to_string_lossy(), roots).is_some() || link_refused(&next, roots, links, look); + } + false +} + +/// `p` with its `.` and `..` taken by name, as Windows takes them. +fn lexical(p: &Path) -> PathBuf { + let mut out = PathBuf::new(); + for c in p.components() { + match c { + Component::ParentDir => { + out.pop(); + } + Component::CurDir => {} + c => out.push(c), + } + } + out +} + /// Whether `path` lies in one of `roots` once made absolute with its `.` and `..` taken by name and /// its longest leading part that exists resolved, so links on the way are followed as the roots' /// were (`/tmp/work/x` is inside root `/private/tmp/work`, a link out of a root leads out of it). fn inside_as_far_as_it_exists(path: &Path, roots: &[PathBuf]) -> bool { let Ok(abs) = std::path::absolute(path) else { return false }; - let mut lexical = PathBuf::new(); - for c in abs.components() { - match c { - Component::ParentDir => { - lexical.pop(); - } - Component::CurDir => {} - c => lexical.push(c), - } - } + let folded = lexical(&abs); let mut rest: Vec<&OsStr> = Vec::new(); - let mut at = lexical.as_path(); + let mut at = folded.as_path(); let resolved = loop { if let Ok(mut base) = std::fs::canonicalize(at) { base.extend(rest.iter().rev()); @@ -169,18 +327,24 @@ fn resolve(path: &Path) -> std::result::Result { fn plain_name(name: &OsStr) -> std::result::Result<(), String> { if cfg!(windows) { let n = name.to_string_lossy(); - let stem = n.split('.').next().unwrap_or_default().trim_end().to_ascii_uppercase(); - let device = matches!(stem.as_str(), "CON" | "PRN" | "AUX" | "NUL" | "CONIN$" | "CONOUT$") - || ((stem.starts_with("COM") || stem.starts_with("LPT")) - && stem.chars().count() == 4 - && stem.chars().last().is_some_and(|c| c.is_ascii_digit() || matches!(c, '¹' | '²' | '³'))); - if device || n.contains(':') { + if device_name(&n) || n.contains(':') { return Err(format!("`{n}` is a device or stream name, not a file")); } } Ok(()) } +/// Whether Windows opens a device for file or folder name `n`: `CON`, `PRN`, `AUX`, `NUL`, +/// `CONIN$`, `CONOUT$`, `COM1`…`COM9` and `LPT1`…`LPT9` (also with `¹`, `²` or `³`), in any case, +/// and with anything after a dot or a colon or trailing spaces (`nul.txt`, `COM1 .png`, `con:x`). +fn device_name(n: &str) -> bool { + let stem = n.split(['.', ':']).next().unwrap_or_default().trim_end().to_ascii_uppercase(); + matches!(stem.as_str(), "CON" | "PRN" | "AUX" | "NUL" | "CONIN$" | "CONOUT$") + || ((stem.starts_with("COM") || stem.starts_with("LPT")) + && stem.chars().count() == 4 + && stem.chars().last().is_some_and(|c| c.is_ascii_digit() || matches!(c, '¹' | '²' | '³'))) +} + thread_local! { static ROOTS: RefCell>> = const { RefCell::new(None) }; } diff --git a/crates/engine/src/automation/file_access/tests.rs b/crates/engine/src/automation/file_access/tests.rs index 72f471f94..d642befb1 100644 --- a/crates/engine/src/automation/file_access/tests.rs +++ b/crates/engine/src/automation/file_access/tests.rs @@ -191,6 +191,283 @@ fn windows_case_devices_and_streams() { assert!(!e.contains(r"\\?\"), "{e}"); } +/// How each spelling of a path on another computer or of a device is told apart from a local path +/// (#1094), on every system: only Windows checks them, but they are spelled the same everywhere. +#[test] +fn spellings_of_other_computers_and_devices_are_refused() { + use super::refused_spelling; + use craft_docpath::Refused::{Device, Network}; + let local = [PathBuf::from(r"C:\work")]; + // On `\\192.0.2.1\share`. + let on_the_share = [ + r"\\192.0.2.1\share\x.png", + "//192.0.2.1/share/x.png", + r"\/192.0.2.1/share\x.png", + r"\\?\UNC\192.0.2.1\share\x.png", + r"\\?\unc\192.0.2.1\share\x.png", + "//?/UNC/192.0.2.1/share/x.png", + r"\\.\UNC\192.0.2.1\share\x.png", + ]; + let elsewhere = [ + // A server without a share is contacted too. + r"\\192.0.2.1", + r"\\192.0.2.1\", + r"\\SERVER.\share \x.png", + ]; + let network = [&on_the_share[..], &elsewhere[..]].concat(); + let device = [ + r"\\.\pipe\figcraft", + r"\\?\GLOBALROOT\Device\Mup\192.0.2.1\share\x.png", + r"\\.\C:\work\x.png", + r"\\.\COM1", + r"\??\UNC\192.0.2.1\share\x.png", + // A device name anywhere: each folder on the way is opened as the path is resolved. + r"C:\work\COM1", + r"C:\work\nul.txt", + r"C:\work\Com1 .png", + r"C:\work\lpt1.\x.png", + r"C:\work\LPT³\x.png", + r"C:\work\conout$", + r"C:\work\aux:stream", + // After a name `craft_docpath` refuses for another reason. + r"C:\work\a:b\prn.png", + ]; + let fine = [ + r"C:\work\x.png", + r"\\?\C:\work\x.png", + r"C:\work\console.png", + r"C:\work\com10.png", + r"C:\work\lpt.png", + r"C:\work\nul-ish.txt", + r"\\?\Volume{0b3b1c63-0000-0000-0000-100000000000}\x.png", + r"\\.\Volume{0b3b1c63-0000-0000-0000-100000000000}\x.png", + "/home/u/work/x.png", + "x.png", + r"..\x.png", + ]; + for (paths, want) in [(&network[..], Some(Network)), (&device[..], Some(Device)), (&fine[..], None)] { + for p in paths { + assert_eq!(refused_spelling(p, &[]), want, "{p}"); + assert_eq!(refused_spelling(p, &local), want, "{p} with a local root"); + } + } + // A root on a share lets the paths on that share through, in any case and spelling, and only them: + // every spelling above of a path on `\\192.0.2.1\share`, but not the server without a share + // or another server. + for root in [r"\\?\UNC\192.0.2.1\share", r"\\192.0.2.1\share\work"] { + let on_share = [PathBuf::from(root)]; + for p in on_the_share { + assert_eq!(refused_spelling(p, &on_share), None, "{p} with root {root}"); + } + for p in elsewhere { + assert_eq!(refused_spelling(p, &on_share), Some(Network), "{p} with root {root}"); + } + } + let shared = [PathBuf::from(r"\\?\UNC\Server\Share\work")]; + for p in [r"\\server\SHARE\work\x.png", r"\\?\UNC\SERVER\share\elsewhere\x.png", "//Server/Share/work/x.png"] { + assert_eq!(refused_spelling(p, &shared), None, "{p}"); + } + for p in [r"\\server\other\x.png", r"\\other\share\x.png", r"\\server", r"\\server.\share\x.png"] { + assert_eq!(refused_spelling(p, &shared), Some(Network), "{p}"); + } + assert_eq!(refused_spelling(r"\\server\share\work\COM1", &shared), Some(Device)); +} + +/// The links on the way to a path are followed by their spelling before anything they lead to is +/// opened (#1094). The links are made up here, so this runs where tests may not make links. +#[test] +fn links_on_the_way_are_followed_by_their_spelling_first() { + use super::{Entry, MAX_LINKS, link_refused}; + use std::cell::RefCell; + use std::collections::HashMap; + let base = std::env::temp_dir().join("figcraft-links"); + let at = |rel: &str| base.join(rel); + let mut links: HashMap> = HashMap::from([ + // Relative to the link's folder, to a device name. + (at("root/dev"), Some(PathBuf::from("../outside/nul"))), + // To another link. + (at("root/hop"), Some(at("root/dev"))), + // Within the root. + (at("root/alias"), Some(PathBuf::from("sub"))), + (at("root/loop"), Some(at("root/loop"))), + (at("root/unreadable"), None), + // Below a name that isn't there: never looked at. + (at("missing/dev"), Some(PathBuf::from("nul"))), + ]); + if cfg!(windows) { + links.insert(at("root/remote"), Some(PathBuf::from(r"\\192.0.2.1\share"))); + links.insert(at("root/far"), Some(at("root/remote/work"))); + } + // Chains of `n` links, `root/-1` to `root/-2` and so on, the last one to `root/sub`. + for n in [MAX_LINKS - 1, MAX_LINKS, MAX_LINKS + 1] { + for i in 1..=n { + let next = if i == n { at("root/sub") } else { at(&format!("root/{n}-{}", i + 1)) }; + links.insert(at(&format!("root/{n}-{i}")), Some(next)); + } + } + let plain = [at("root"), at("root/sub"), at("outside")]; + // What can't be looked at (no permission, say) may be a link, so it isn't taken for nothing. + let unreadable = at("root/locked"); + let looked = RefCell::new(Vec::new()); + let look = |p: &Path| { + looked.borrow_mut().push(p.to_path_buf()); + match links.get(p) { + Some(target) => Entry::Link(target.clone()), + None if base.starts_with(p) || plain.iter().any(|q| q == p) => Entry::Plain, + None if p == unreadable => Entry::Unreadable, + None => Entry::Missing, + } + }; + let refused = |rel: &str, roots: &[PathBuf]| link_refused(&at(rel), roots, MAX_LINKS, &look); + for rel in ["root/dev/x.png", "root/hop/x.png", "root/loop/x.png", "root/unreadable/x.png", "root/locked/x.png", "root/locked"] { + assert!(refused(rel, &[]), "{rel}"); + } + for rel in ["root/alias/x.png", "root/sub/x.png", "root/x.png", "missing/dev/x.png"] { + assert!(!refused(rel, &[]), "{rel}"); + } + // As many links as are followed lead on; one more is refused. + assert!(!refused(&format!("root/{}-1/x.png", MAX_LINKS - 1), &[])); + assert!(!refused(&format!("root/{MAX_LINKS}-1/x.png"), &[])); + assert!(refused(&format!("root/{}-1/x.png", MAX_LINKS + 1), &[])); + // A refused target isn't looked at, nor is anything below what isn't there. + let looked = looked.take(); + assert!(!looked.contains(&at("outside/nul")) && !looked.contains(&at("missing/dev")), "{looked:?}"); + if cfg!(windows) { + for rel in ["root/remote/x.png", "root/far/x.png"] { + assert!(refused(rel, &[]), "{rel}"); + // Unless a root is on that share. + assert!(!refused(rel, &[PathBuf::from(r"\\?\UNC\192.0.2.1\share")]), "{rel}"); + } + } +} + +/// A path that can't be looked at is refused rather than taken for one with nothing there (#1094): +/// only a failure that says nothing is there lets the walk stop, and a path that can't even be +/// made absolute isn't left to the checks after it. +#[test] +fn what_cannot_be_looked_at_is_refused() { + use super::{Unresolved, nothing_there, refused_unresolved}; + use std::io::{Error, ErrorKind}; + for kind in [ErrorKind::NotFound, ErrorKind::NotADirectory, ErrorKind::InvalidFilename] { + assert!(nothing_there(&Error::from(kind)), "{kind:?}"); + } + for kind in [ErrorKind::PermissionDenied, ErrorKind::ResourceBusy, ErrorKind::Interrupted, ErrorKind::Other] { + assert!(!nothing_there(&Error::from(kind)), "{kind:?}"); + } + assert_eq!(refused_unresolved(Path::new(""), &[]), Some(Unresolved::Linked)); +} + +/// On Windows a path is classified as Windows opens it (#1094): with `..` taken by name before +/// anything is opened (so a link followed by `..` is never gone through), and with names that +/// aren't Unicode (a lone surrogate) still read for the parts that are spelled in ASCII. +#[cfg(windows)] +#[test] +fn paths_are_classified_as_windows_opens_them() { + use super::{Unresolved, refused_unresolved}; + use craft_docpath::Refused::{Device, Network}; + use std::ffi::OsString; + use std::os::windows::ffi::OsStringExt; + assert_eq!(std::path::absolute(r"C:\work\remote\..\x.png").unwrap(), PathBuf::from(r"C:\work\x.png")); + // `before`, a lone surrogate, then `after`. + let odd = |before: &str, after: &str| { + let wide: Vec = before.encode_utf16().chain([0xD800]).chain(after.encode_utf16()).collect(); + PathBuf::from(OsString::from_wide(&wide)) + }; + assert_eq!(refused_unresolved(&odd(r"\\192.0.2.1\share\", ".png"), &[]), Some(Unresolved::Spelled(Network))); + assert_eq!(refused_unresolved(&odd(r"C:\figcraft-no-such-folder\", r"\nul"), &[]), Some(Unresolved::Spelled(Device))); + assert_eq!(refused_unresolved(&odd(r"C:\figcraft-no-such-folder\", ".png"), &[]), None); + // A NUL can't be passed to Windows at all, so the path can't be made absolute. + assert_eq!(refused_unresolved(Path::new("C:\\work\\a\0b.png"), &[]), Some(Unresolved::Linked)); +} + +/// `..` after a link is taken by name, by the check and by Windows when it opens the path, so +/// `root\j\..\in.txt` is `root\in.txt` and the link `j` is never gone through (#1094). Shown with +/// a junction, a link any account can make: `j` leads out of the root to `outside`, and beside +/// `outside` is another `in.txt`, which is what `..` would reach through the link. +#[cfg(windows)] +#[test] +fn a_parent_after_a_link_is_taken_by_name() { + use super::{Entry, on_disk}; + let f = Fixture::new("parent"); + let r = f.rw(); + std::fs::write(f.0.join("in.txt"), b"beside").unwrap(); + let made = std::process::Command::new("cmd").args(["/C", "mklink", "/J"]).arg(f.0.join(r"root\j")).arg(f.0.join("outside")).output(); + assert!(made.is_ok_and(|o| o.status.success()), "a junction can be made"); + // The junction is a link to the check, and what is through it is outside. + assert!(matches!(on_disk(&f.0.join(r"root\j")), Entry::Link(Some(_)))); + assert!(r.check(Path::new(&f.p(r"root\j\secret.txt")), Access::Read).is_err()); + let through = f.p(r"root\j\..\in.txt"); + assert_eq!(r.check(Path::new(&through), Access::Read), r.check(Path::new(&f.p(r"root\in.txt")), Access::Read)); + assert!(r.check(Path::new(&through), Access::Read).is_ok()); + assert_eq!(std::fs::read(&through).unwrap(), b"in", "Windows opens the file in the root"); +} + +/// A path on another computer and a device path are refused before anything is opened: resolving +/// them made Windows contact the server, which may send it the signed-in user's credentials +/// (#1094). Each is refused with a message that only the check before resolving gives: had the +/// path been resolved, 192.0.2.1 (an address for documentation, where nothing answers) would have +/// been contacted and the message would be the one for a path that can't be resolved. +#[cfg(windows)] +#[test] +fn other_computers_and_devices_are_refused_before_anything_is_opened() { + let f = Fixture::new("network"); + let r = f.rw(); + let read_only = Roots::new(&[f.p("root")], &[]).unwrap(); + let refused = |roots: &Roots, p: &str, access: Access| roots.check(Path::new(p), access).expect_err(p); + for p in + [r"\\192.0.2.1\share\x.png", "//192.0.2.1/share/x.png", r"\\?\UNC\192.0.2.1\share\x.png", r"\\.\UNC\192.0.2.1\share\x.png", r"\\192.0.2.1"] + { + for access in [Access::Read, Access::Write] { + let e = refused(&r, p, access); + assert!(e.contains("is on another computer, and no folder that may be"), "{p}: {e}"); + } + let e = refused(&read_only, p, Access::Write); + assert!(e.ends_with("is on another computer, and no folder that may be written is on its share"), "{p}: {e}"); + } + for p in [r"\\.\pipe\figcraft-roots", r"\\?\GLOBALROOT\Device\Mup\192.0.2.1\share\x.png", &f.p(r"root\COM1\x.png"), "nul"] { + for access in [Access::Read, Access::Write] { + let e = refused(&r, p, access); + assert!(e.ends_with("names a device, not a file"), "{p}: {e}"); + } + } + // Local paths, in either spelling, are checked as before. + let inside = std::fs::canonicalize(f.p("root")).unwrap().join("in.txt"); + assert!(r.check(&inside, Access::Read).is_ok()); + assert!(r.check(Path::new(&f.p(r"root\in.txt")), Access::Read).is_ok()); +} + +/// A link in a root to another computer is refused before it is followed (#1094), also through +/// another link, and with the message any path outside gets: it doesn't tell where the link +/// leads. Had the link been followed, the message would be the one for a path that can't be +/// resolved. This needs real links, which Windows lets only some accounts make: elsewhere it +/// says so and checks nothing (`links_on_the_way_are_followed_by_their_spelling_first` covers the +/// same walk with made-up links on every system). +#[cfg(windows)] +#[test] +fn links_to_other_computers_are_refused_before_they_are_followed() { + let f = Fixture::new("network-links"); + let r = f.rw(); + if !symlink_dir(Path::new(r"\\192.0.2.1\share"), &f.0.join("root/remote")) || !symlink_dir(&f.0.join("root/remote/work"), &f.0.join("root/hop")) { + eprintln!("skipped: this system doesn't let tests make symbolic links"); + return; + } + // Relative to the link's folder. + assert!(symlink_dir(Path::new(r"..\remote"), &f.0.join("root/sub/up"))); + assert!(symlink_file(Path::new(r"\\.\pipe\figcraft-roots"), &f.0.join("root/pipe"))); + let standard = |p: &str| format!("automation path rejected: {p} is outside the folders that may be"); + for p in [f.p("root/remote/x.png"), f.p("root/hop/x.png"), f.p("root/sub/up/x.png"), f.p("root/pipe")] { + for access in [Access::Read, Access::Write] { + let e = r.check(Path::new(&p), access).expect_err(&p); + assert!(e.starts_with(&standard(&p)), "{p}: {e}"); + } + } + // `..` after the link is taken by name, so the link isn't gone through. + assert!(r.check(Path::new(&f.p(r"root\remote\..\in.txt")), Access::Read).is_ok()); + // A link to a folder in the root still leads there. + assert!(symlink_dir(&f.0.join("root/sub"), &f.0.join("root/alias"))); + assert!(r.check(Path::new(&f.p("root/alias/x.png")), Access::Write).is_ok()); +} + #[test] fn a_scope_confines_the_thread_and_ends_with_it() { let f = Fixture::new("scope"); diff --git a/crates/engine/src/board_mindmap_tests.rs b/crates/engine/src/board_mindmap_tests.rs new file mode 100644 index 000000000..19bb459ae --- /dev/null +++ b/crates/engine/src/board_mindmap_tests.rs @@ -0,0 +1,385 @@ +//! Mind maps (#2226): `board.mindMap` and `board.mindMapAdd` make nodes and branches, and the +//! normalize pass lays a touched map out again from its first node after every edit. + +use figcraft_color::{Color, Paint}; +use figcraft_doc::{BoardItem, Connector, Document, END_GAP, End, LetterSpacing, LineHeight, NodeId, NodeKind, Routing, Side, StrokeCap}; +use figcraft_geom::{Point, Rect}; +use serde_json::{Value, json}; + +use crate::Session; +use crate::board::text_of; +use crate::board_tests::{board, connector, drawn, id, near, node}; +use crate::collab_live_tests::Room; + +fn bx(s: &Session, id: NodeId) -> Rect { + s.doc().unwrap().world_bounds(id).unwrap() +} + +fn same(a: f64, b: f64) -> bool { + (a - b).abs() < 1e-6 +} + +/// `board.mindMap` at (100, 200): the first node, its three children and their branches. +fn map(s: &mut Session) -> (NodeId, [NodeId; 3], [NodeId; 3]) { + let out = s.execute("board.mindMap", &json!({"x": 100, "y": 200})).unwrap(); + let kids: Vec = out["children"].as_array().unwrap().clone(); + let (c, k): (Vec, Vec) = kids.iter().map(|v| (id(v, "id"), id(v, "connector"))).unzip(); + (id(&out, "id"), [c[0], c[1], c[2]], [k[0], k[1], k[2]]) +} + +fn text_data(s: &Session, n: NodeId) -> figcraft_doc::TextData { + let t = text_of(s.doc().unwrap(), n).unwrap(); + match node(s, t).kind { + NodeKind::Text(td) => td, + other => panic!("not text: {other:?}"), + } +} + +fn is_mind_node(s: &Session, n: NodeId) -> bool { + node(s, n).board == Some(BoardItem::MindNode) +} + +/// The nodes hanging off `parent`, top to bottom, in `doc`. +fn kids(doc: &Document, parent: NodeId) -> Vec { + let mut v: Vec<(f64, NodeId)> = doc + .nodes() + .filter_map(|n| match &n.board { + Some(BoardItem::Connector(Connector { from: End::Node { node, .. }, to: End::Node { node: to, .. }, branch: true, .. })) + if *node == parent => + { + doc.world_bounds(*to).map(|b| (b.center().y, *to)) + } + _ => None, + }) + .collect(); + v.sort_by(|a, b| a.0.total_cmp(&b.0)); + v.into_iter().map(|p| p.1).collect() +} + +fn places(s: &Session, ids: &[NodeId]) -> Vec { + ids.iter().map(|i| bx(s, *i)).collect() +} + +fn branches(s: &Session) -> Vec { + s.doc().unwrap().nodes().filter(|n| matches!(&n.board, Some(BoardItem::Connector(c)) if c.branch)).map(|n| n.id).collect() +} + +/// Starter child `i` (`k`, on branch `line`) of the first node: its text, its place and its branch. +fn check_child(s: &Session, root: NodeId, (k, line): (NodeId, NodeId), i: usize) { + let r = bx(s, root); + let td = text_data(s, k); + assert_eq!(td.characters, ["Idea 1", "Idea 2", "Idea 3"][i]); + assert_eq!((td.style.font_size, td.style.font_style.as_str()), (16.0, "Medium")); + assert_eq!((td.style.line_height, td.style.letter_spacing), (LineHeight::Percent(150.0), LetterSpacing::Percent(-1.1))); + let b = bx(s, k); + assert!(same(b.x0, r.x1 + 88.0), "child {i}: 88 right of the root"); + assert_eq!(b.height(), 24.0); + let t = bx(s, text_of(s.doc().unwrap(), k).unwrap()); + assert!(same(b.width(), t.width()), "child {i}: the node is its text, no padding"); + assert!(is_mind_node(s, k)); + let want = Connector { + from: End::Node { node: root, side: Side::Right, at: None }, + to: End::Node { node: k, side: Side::Left, at: None }, + routing: Routing::Curved, + path: None, + branch: true, + }; + assert_eq!(connector(s, line), want); + let l = node(s, line); + assert_eq!((l.stroke.cap_start, l.stroke.cap_end), (StrokeCap::Round, StrokeCap::Round)); + assert_eq!((l.stroke.weight, l.strokes), (4.0, vec![Paint::solid(Color::from_rgb8_const(0x75, 0x75, 0x75))])); + let pts = drawn(s, line); + assert!(near(pts[0], Point::new(r.x1 + END_GAP, r.center().y)), "{pts:?}"); + assert!(near(*pts.last().unwrap(), Point::new(b.x0 - END_GAP, b.center().y)), "{pts:?}"); +} + +#[test] +fn a_mind_map_is_a_first_node_with_three_children_on_branches() { + let mut s = board(); + let before = s.doc().unwrap().ids().count(); + let depth = s.undo_depth().0; + let (root, kids, lines) = map(&mut s); + assert_eq!(node(&s, root).board, Some(BoardItem::MindNode)); + assert!(node(&s, root).is_board_atom()); + let r = bx(&s, root); + assert_eq!((r.x0, r.y0), (100.0, 200.0)); + let td = text_data(&s, root); + assert_eq!((td.characters.as_str(), td.style.font_size, td.style.font_style.as_str()), ("Topic", 24.0, "Bold")); + assert_eq!((td.style.line_height, td.style.letter_spacing), (LineHeight::Percent(150.0), LetterSpacing::Percent(-1.9))); + assert_eq!(r.height(), 36.0, "one line at 150%"); + let text = text_of(s.doc().unwrap(), root).unwrap(); + assert_eq!(node(&s, text).fills, vec![Paint::solid(Color::from_rgb8_const(0x1E, 0x1E, 0x1E))]); + for (i, pair) in kids.into_iter().zip(lines).enumerate() { + check_child(&s, root, pair, i); + } + let h = bx(&s, kids[0]).height(); + assert!(same(bx(&s, kids[1]).center().y, r.center().y)); + assert!(same(bx(&s, kids[0]).center().y, r.center().y - h - 48.0)); + assert!(same(bx(&s, kids[2]).center().y, r.center().y + h + 48.0)); + assert_eq!(s.selection(), vec![root]); + assert_eq!(s.undo_depth().0, depth + 1); + s.execute("edit.undo", &json!({})).unwrap(); + assert_eq!(s.doc().unwrap().ids().count(), before); +} + +#[test] +fn a_new_child_goes_below_its_siblings_and_the_stack_stays_centred() { + let mut s = board(); + let (root, kids3, _) = map(&mut s); + let h = bx(&s, kids3[0]).height(); + let was = places(&s, &kids3); + s.ui_requests.clear(); + let out = s.execute("board.mindMapAdd", &json!({"id": root, "text": "Four", "edit": true})).unwrap(); + let new = id(&out, "id"); + assert!(is_mind_node(&s, new)); + assert_eq!(text_data(&s, new).style.font_size, 16.0); + let order = kids(s.doc().unwrap(), root); + assert_eq!(order, [kids3[0], kids3[1], kids3[2], new]); + let cy: Vec = order.iter().map(|n| bx(&s, *n).center().y).collect(); + assert!(cy.windows(2).all(|w| same(w[1] - w[0], h + 48.0)), "{cy:?}"); + assert!(same((cy[0] + cy[3]) / 2.0, bx(&s, root).center().y)); + assert!(same(bx(&s, kids3[0]).y0, was[0].y0 - (h + 48.0) / 2.0), "the first one moved up 36"); + assert_eq!(s.selection(), vec![new]); + assert!(s.ui_requests.iter().any(|q| q.kind == "board.editText" && q.data["id"] == json!(new))); + s.execute("edit.undo", &json!({})).unwrap(); + assert_eq!(places(&s, &kids3), was, "the three are back exactly"); + // Without an id the selected first node is the one. + s.execute("select.set", &json!({"ids": [root]})).unwrap(); + s.execute("board.mindMapAdd", &json!({})).unwrap(); + assert_eq!(kids(s.doc().unwrap(), root).len(), 4); +} + +#[test] +fn a_childs_child_starts_the_next_column_and_a_sibling_goes_right_after() { + let mut s = board(); + let (root, [c0, c1, c2], _) = map(&mut s); + let h = bx(&s, c0).height(); + let g1 = id(&s.execute("board.mindMapAdd", &json!({"id": c0})).unwrap(), "id"); + let g2 = id(&s.execute("board.mindMapAdd", &json!({"id": c0})).unwrap(), "id"); + let column = [c0, c1, c2].iter().map(|n| bx(&s, *n).x1).fold(f64::MIN, f64::max) + 88.0; + assert!(same(bx(&s, g1).x0, column) && same(bx(&s, g2).x0, column), "past the widest of the three"); + assert!(same(bx(&s, g2).center().y - bx(&s, g1).center().y, h + 48.0)); + assert!(same((bx(&s, g1).center().y + bx(&s, g2).center().y) / 2.0, bx(&s, c0).center().y)); + for g in [g1, g2] { + let line = s.doc().unwrap().nodes().find(|n| matches!(&n.board, Some(BoardItem::Connector(c)) if c.to.node() == Some(g))).unwrap().id; + assert!(matches!(connector(&s, line).from, End::Node { node, side: Side::Right, .. } if node == c0)); + } + assert!(same(bx(&s, c1).center().y - bx(&s, c0).center().y, (2.0 * h + 48.0) / 2.0 + 48.0 + h / 2.0), "108 below"); + let new = id(&s.execute("board.mindMapAdd", &json!({"id": c1, "relation": "sibling"})).unwrap(), "id"); + let line = s.doc().unwrap().nodes().find(|n| matches!(&n.board, Some(BoardItem::Connector(c)) if c.to.node() == Some(new))).unwrap().id; + assert!(matches!(connector(&s, line).from, End::Node { node, .. } if node == root)); + assert_eq!(kids(s.doc().unwrap(), root), [c0, c1, new, c2]); +} + +#[test] +fn more_lines_push_the_siblings_apart() { + let mut s = board(); + let (root, [c0, c1, c2], _) = map(&mut s); + let (h, was) = (bx(&s, c1).height(), places(&s, &[c0, c1, c2])); + let t = text_of(s.doc().unwrap(), c1).unwrap(); + s.execute("node.set", &json!({"id": t, "props": {"characters": "one\ntwo\nthree"}})).unwrap(); + let h3 = bx(&s, c1).height(); + assert_eq!((h, h3), (24.0, 72.0)); + assert!(same(bx(&s, c1).center().y, bx(&s, root).center().y)); + for k in [c0, c2] { + assert!(same((bx(&s, k).center().y - bx(&s, c1).center().y).abs(), (h + h3) / 2.0 + 48.0)); + } + assert!(same(bx(&s, c0).y0, was[0].y0 - (h3 - h) / 2.0), "24 up"); + s.execute("edit.undo", &json!({})).unwrap(); + assert_eq!(places(&s, &[c0, c1, c2]), was); +} + +#[test] +fn the_first_node_carries_the_map_and_a_child_moved_by_hand_goes_back_or_swaps() { + let mut s = board(); + let (root, kids3, lines) = map(&mut s); + let was = places(&s, &kids3); + s.execute("transform.move", &json!({"ids": [root], "dx": 50, "dy": 30})).unwrap(); + for (k, w) in kids3.iter().zip(&was) { + let b = bx(&s, *k); + assert!(same(b.x0, w.x0 + 50.0) && same(b.y0, w.y0 + 30.0), "{b:?} from {w:?}"); + } + for l in lines { + assert!(near(drawn(&s, l)[0], Point::new(bx(&s, root).x1 + END_GAP, bx(&s, root).center().y))); + } + let now = places(&s, &kids3); + s.execute("transform.move", &json!({"ids": [kids3[2]], "dx": 300, "dy": 5})).unwrap(); + assert_eq!(places(&s, &kids3), now, "it goes back"); + s.execute("transform.move", &json!({"ids": [kids3[0]], "dx": 0, "dy": 100})).unwrap(); + assert_eq!(kids(s.doc().unwrap(), root), [kids3[1], kids3[0], kids3[2]], "past the middle one's middle: they swap"); + assert!(same(bx(&s, kids3[1]).center().y, bx(&s, root).center().y - 72.0)); +} + +#[test] +fn a_deleted_node_leaves_its_children_in_place_and_takes_its_branches() { + let mut s = board(); + let (root, [c0, c1, c2], _) = map(&mut s); + let h = bx(&s, c0).height(); + let g = id(&s.execute("board.mindMapAdd", &json!({"id": c1})).unwrap(), "id"); + let at = bx(&s, g); + let (undo, _) = s.undo_depth(); + s.execute("edit.delete", &json!({"ids": [c1]})).unwrap(); + let left = branches(&s); + assert_eq!(left.len(), 2, "the root's two others"); + for l in &left { + assert!(!matches!(connector(&s, *l).to, End::Node { node, .. } if node == c1 || node == g), "none to the gone node or its child"); + } + assert_eq!(bx(&s, g), at, "the child stays where it was"); + assert!(is_mind_node(&s, g)); + let r = bx(&s, root).center().y; + assert!(same(bx(&s, c0).center().y, r - (h + 48.0) / 2.0) && same(bx(&s, c2).center().y, r + (h + 48.0) / 2.0)); + let line = s.doc().unwrap().nodes().find(|n| matches!(&n.board, Some(BoardItem::Connector(c)) if c.to.node() == Some(c2))).unwrap().id; + let spot = bx(&s, c2); + s.execute("edit.delete", &json!({"ids": [line]})).unwrap(); + assert_eq!(bx(&s, c2), spot, "a detached node stays"); + assert!(same(bx(&s, c0).center().y, r)); + assert_eq!(branches(&s).len(), 1); + s.execute("edit.undo", &json!({})).unwrap(); + s.execute("edit.undo", &json!({})).unwrap(); + assert_eq!(s.undo_depth().0, undo); + assert_eq!(branches(&s).len(), 4); + assert!(s.doc().unwrap().contains(c1)); +} + +#[test] +fn two_people_adding_at_once_end_with_one_layout() { + let mut s = board(); + let (root, [c0, ..], _) = map(&mut s); + let h = bx(&s, c0).height(); + let mut room = Room::new(s.doc().unwrap().clone(), 2, 7); + for i in 0..2 { + room.s(i).execute("board.mindMapAdd", &json!({"id": root})).unwrap(); + } + room.settle(); + room.check(); + let doc = room.server.document(); + let order = kids(doc, root); + assert_eq!(order.len(), 5); + let centres = |doc: &Document, order: &[NodeId]| order.iter().map(|n| doc.world_bounds(*n).unwrap().center().y).collect::>(); + let cy = centres(doc, &order); + assert!(cy.windows(2).all(|w| w[1] > w[0] && same(w[1] - w[0], h + 48.0)), "{cy:?}"); + assert!(same((cy[0] + cy[4]) / 2.0, doc.world_bounds(root).unwrap().center().y)); + // One makes a child three lines tall while the other adds one. + let t = text_of(doc, order[1]).unwrap(); + room.s(0).execute("node.set", &json!({"id": t, "props": {"characters": "one\ntwo\nthree"}})).unwrap(); + room.s(1).execute("board.mindMapAdd", &json!({"id": root})).unwrap(); + room.settle(); + room.check(); + let doc = room.server.document(); + let order = kids(doc, root); + assert_eq!(order.len(), 6); + let (boxes, mut gap_ok) = (order.iter().map(|n| doc.world_bounds(*n).unwrap()).collect::>(), true); + for w in boxes.windows(2) { + gap_ok &= same(w[1].y0 - w[0].y1, 48.0); + } + assert!(gap_ok, "48 between every pair: {boxes:?}"); + assert!(boxes.iter().any(|b| same(b.height(), 3.0 * h))); + let (top, bottom) = (boxes[0].y0, boxes[5].y1); + assert!(same((top + bottom) / 2.0, doc.world_bounds(root).unwrap().center().y)); +} + +#[test] +fn refusals_saved_files_and_a_second_pass_changes_nothing() { + let mut d = Session::new(); + d.execute("file.new", &json!({})).unwrap(); + for cmd in ["board.mindMap", "board.mindMapAdd"] { + assert!(matches!(d.execute(cmd, &json!({})), Err(crate::EngineError::Disabled(..))), "{cmd} on a design file"); + } + let mut s = board(); + let (root, ..) = map(&mut s); + let sticky = id(&s.execute("board.sticky", &json!({"x": 900, "y": 0})).unwrap(), "id"); + for p in [json!({"id": sticky}), json!({"id": root, "relation": "cousin"}), json!({"id": root, "relation": "sibling"})] { + assert!(s.execute("board.mindMapAdd", &p).is_err(), "{p}"); + } + s.execute("select.none", &json!({})).unwrap(); + assert!(s.execute("board.mindMapAdd", &json!({})).is_err(), "nothing selected"); + let twenty_one: Vec = (0..21).map(|i| format!("n{i}")).collect(); + assert!(s.execute("board.mindMap", &json!({"children": twenty_one})).is_err()); + assert!(s.execute("board.mindMap", &json!({"children": "x"})).is_err()); + let doc = s.doc().unwrap(); + let (back, _) = figcraft_format::from_json(&figcraft_format::to_json(doc).unwrap().to_string()).unwrap(); + assert_eq!(back.nodes().filter(|n| n.board == Some(BoardItem::MindNode)).count(), 4); + assert_eq!(back.nodes().filter(|n| matches!(&n.board, Some(BoardItem::Connector(c)) if c.branch)).count(), 3); + // An ordinary connector writes no `branch`; a file without it reads `false`. + let mut plain = board(); + let a = id(&plain.execute("board.sticky", &json!({"x": 0, "y": 0})).unwrap(), "id"); + let b = id(&plain.execute("board.sticky", &json!({"x": 400, "y": 0})).unwrap(), "id"); + plain.execute("board.connector", &json!({"from": a, "to": b})).unwrap(); + assert!(!figcraft_format::to_json(plain.doc().unwrap()).unwrap().to_string().contains("\"branch\"")); + let item: BoardItem = serde_json::from_value(json!({"type": "connector", "from": {"x": 0, "y": 0}, "to": {"x": 1, "y": 1}})).unwrap(); + assert!(matches!(item, BoardItem::Connector(c) if !c.branch)); + // Every layer touched again: a laid out map is not an edit. + let mut again = doc.clone(); + again.mark_dirty(doc.ids().collect::>()); + crate::normalize(&mut again, doc); + assert!(again == *doc, "a second pass changes nothing"); +} + +/// Every layer touched again on a copy of `s`'s document: a map in place is left as it is. +fn second_pass_is_a_no_op(s: &Session) { + let doc = s.doc().unwrap(); + let mut again = doc.clone(); + again.mark_dirty(doc.ids().collect::>()); + crate::normalize(&mut again, doc); + assert!(again == *doc, "a second pass changes nothing"); +} + +#[test] +fn a_map_around_its_own_container_stays_put() { + let mut s = board(); + let sec = id(&s.execute("node.create", &json!({"type": "section", "x": 0, "y": 0, "width": 800, "height": 600})).unwrap(), "id"); + let out = s.execute("board.mindMap", &json!({"parent": sec, "x": 40, "y": 40})).unwrap(); + let line = id(&out["children"][1], "connector"); + s.execute("board.reattach", &json!({"id": line, "end": "to", "target": sec})).unwrap(); + let was = bx(&s, sec); + second_pass_is_a_no_op(&s); + s.execute("node.set", &json!({"id": id(&out, "id"), "props": {"name": "again"}})).unwrap(); + assert_eq!(bx(&s, sec), was, "the section stays where it is"); + second_pass_is_a_no_op(&s); +} + +#[test] +fn a_branch_moved_by_its_start_leaves_no_gap_and_odd_structures_settle() { + let mut s = board(); + let (root, [c0, c1, c2], lines) = map(&mut s); + let (h, at) = (bx(&s, c1).height(), bx(&s, c1)); + s.execute("board.reattach", &json!({"id": lines[1], "end": "from", "target": {"x": 900, "y": 900}})).unwrap(); + assert_eq!(branches(&s).len(), 2, "one branch fewer"); + assert_eq!(bx(&s, c1), at, "that child stays where it was"); + let r = bx(&s, root).center().y; + assert!(same(bx(&s, c0).center().y, r - (h + 48.0) / 2.0), "{:?}", bx(&s, c0)); + assert!(same(bx(&s, c2).center().y, r + (h + 48.0) / 2.0), "{:?}", bx(&s, c2)); + second_pass_is_a_no_op(&s); + + // Two branches arrive at one node: the lower connector id stays its parent. + let mut s = board(); + let (root, [c0, c1, _], lines) = map(&mut s); + let g = id(&s.execute("board.mindMapAdd", &json!({"id": c0})).unwrap(), "id"); + let gl = branches(&s).into_iter().find(|b| !lines.contains(b)).unwrap(); + s.execute("board.reattach", &json!({"id": gl, "end": "to", "target": c1})).unwrap(); + assert_eq!(kids(s.doc().unwrap(), root).len(), 3); + assert!(same(bx(&s, c1).x0, bx(&s, root).x1 + 88.0), "c1 stays in the root's column"); + assert!(is_mind_node(&s, g)); + second_pass_is_a_no_op(&s); + + // A cycle: nothing in it moves, and nothing changes after. + let mut s = board(); + let (_, [c0, ..], lines) = map(&mut s); + let g = id(&s.execute("board.mindMapAdd", &json!({"id": c0})).unwrap(), "id"); + let gg = id(&s.execute("board.mindMapAdd", &json!({"id": g})).unwrap(), "id"); + s.execute("board.reattach", &json!({"id": lines[0], "end": "from", "target": gg})).unwrap(); + let ring = places(&s, &[c0, g, gg]); + second_pass_is_a_no_op(&s); + assert_eq!(places(&s, &[c0, g, gg]), ring); +} + +#[test] +fn the_caps_refuse_what_is_too_far_and_cut_what_is_too_long() { + let mut s = board(); + assert!(s.execute("board.mindMap", &json!({"x": 2.0e9})).is_err()); + assert!(s.execute("board.mindMap", &json!({"y": -2.0e9})).is_err()); + let long = "x".repeat(600); + let out = s.execute("board.mindMap", &json!({"text": long, "children": [long]})).unwrap(); + assert_eq!(text_data(&s, id(&out, "id")).characters.chars().count(), 500); + assert_eq!(text_data(&s, id(&out["children"][0], "id")).characters.chars().count(), 500); +} diff --git a/crates/engine/src/board_tests.rs b/crates/engine/src/board_tests.rs index 9e99bd1c9..5ddd4e1be 100644 --- a/crates/engine/src/board_tests.rs +++ b/crates/engine/src/board_tests.rs @@ -206,6 +206,7 @@ fn routes_are_the_same_for_the_same_document() { to: End::Point { x: 300.0, y: 500.0 }, routing: Routing::Elbow, path: None, + branch: false, }; let doc = s.doc().unwrap(); let r = route(doc, &c).unwrap(); @@ -357,6 +358,7 @@ fn board_commands_survive_junk() { json!({"path": "M0 0 L 1e308 1e308", "points": [[0, 0], [1e308, 1]]}), json!({"end": "from", "target": {"x": 1e308, "y": -1e308}, "side": "inside", "style": "curved"}), json!({"id": 99_999, "end": 7, "target": [1], "style": "wavy"}), + json!({"id": 99_999, "relation": 7, "children": "x", "text": [1], "x": "NaN", "y": 1e308}), ]; let ids: Vec<&str> = crate::cmd::all_commands() .iter() diff --git a/crates/engine/src/board_tools_tests.rs b/crates/engine/src/board_tools_tests.rs index 6ed291e13..1e306a7d9 100644 --- a/crates/engine/src/board_tools_tests.rs +++ b/crates/engine/src/board_tools_tests.rs @@ -96,7 +96,8 @@ fn routes_take_named_sides_and_free_points() { let a = id(&s.execute("board.shape", &json!({"x": 0, "y": 0, "width": 100, "height": 100})).unwrap(), "id"); let b = id(&s.execute("board.shape", &json!({"x": 300, "y": 300, "width": 100, "height": 100})).unwrap(), "id"); let doc = s.doc().unwrap(); - let elbow = |from, to| route(doc, &figcraft_doc::Connector { from, to, routing: figcraft_doc::Routing::Elbow, path: None }).unwrap(); + let elbow = + |from, to| route(doc, &figcraft_doc::Connector { from, to, routing: figcraft_doc::Routing::Elbow, path: None, branch: false }).unwrap(); let side = |n, side| End::Node { node: n, side, at: None }; let p = |x, y| End::Point { x, y }; let pt = Point::new; @@ -109,8 +110,16 @@ fn routes_take_named_sides_and_free_points() { assert_eq!(elbow(p(0.0, 0.0), p(100.0, 40.0)), vec![pt(0.0, 0.0), pt(50.0, 0.0), pt(50.0, 40.0), pt(100.0, 40.0)]); assert_eq!(elbow(p(0.0, 0.0), p(100.0, 0.0)), vec![pt(0.0, 0.0), pt(100.0, 0.0)]); // An automatic side faces the other end. - let straight = - route(doc, &figcraft_doc::Connector { from: side(a, Side::Auto), to: p(50.0, 500.0), routing: figcraft_doc::Routing::Straight, path: None }); + let straight = route( + doc, + &figcraft_doc::Connector { + from: side(a, Side::Auto), + to: p(50.0, 500.0), + routing: figcraft_doc::Routing::Straight, + path: None, + branch: false, + }, + ); assert_eq!(straight.unwrap(), vec![pt(50.0, 104.0), pt(50.0, 500.0)]); assert_eq!(Side::from_id("TOP"), Some(Side::Top)); assert_eq!(Side::from_id("inside"), None); diff --git a/crates/engine/src/boards/board.rs b/crates/engine/src/boards/board.rs index 1a66eed22..99f43faea 100644 --- a/crates/engine/src/boards/board.rs +++ b/crates/engine/src/boards/board.rs @@ -25,6 +25,7 @@ mod connectors; mod derived; mod edit; mod items; +mod mindmap; mod reshape; mod tools; @@ -70,6 +71,7 @@ pub(crate) use items::add_text; pub use items::{CONNECTED_GAP, connected_place}; use items::{add_connected, ink_cmd, next_sticky, shape_cmd, stamp_cmd, sticky_cmd}; pub use items::{edit_text, owner_of_text, sticky_font_size, text_of}; +pub(crate) use mindmap::settle_mind_maps; pub(crate) use reshape::path_handle_at; pub use reshape::selected_connector_handles; @@ -176,6 +178,20 @@ pub fn specs() -> Vec { true, reshape::reshape ), + spec!( + "board.mindMap", + "Mind map", + "{x?, y? (the first node's top-left in the parent; default the middle of the view), text? (default Topic), children? (their texts, at most 20; default Idea 1, Idea 2, Idea 3), parent?, edit? (start typing in the first node; default false)} → {id, text, children: [{id, text, connector}...]} a first node with children on its right, joined by branches; the map lays itself out", + true, + mindmap::mind_map_cmd + ), + spec!( + "board.mindMapAdd", + "Add mind map node", + "{id? (a mind map node; default the selected or edited one), relation?: child|sibling (default child), text?, edit? (start typing in it; default false)} → {id, text, connector} a child below the node's other children, or a sibling right after it; the map lays itself out again", + true, + mindmap::mind_map_add + ), spec!("board.label", "Connector label", "{id (a connector; default the selection), text (empty removes it)} → {id, label}", true, label_cmd), spec!( "board.stamp", diff --git a/crates/engine/src/boards/board/connectors.rs b/crates/engine/src/boards/board/connectors.rs index f12a7792a..408de045a 100644 --- a/crates/engine/src/boards/board/connectors.rs +++ b/crates/engine/src/boards/board/connectors.rs @@ -65,7 +65,7 @@ pub(super) fn connector_cmd(s: &mut Session, p: &Value) -> Result { let end = cap_of(cmd, p, "endCap")?.unwrap_or(CAPS.1); let page = s.page()?; let doc = s.doc_mut()?; - let id = make(doc, page, Connector { from, to, routing, path: None }, (start, end))?; + let id = make(doc, page, Connector { from, to, routing, path: None, branch: false }, (start, end))?; let mut out = json!({"id": id}); if let Some(text) = string(p, "label").filter(|t| !t.trim().is_empty()) { out["label"] = json!(set_label(doc, id, &text)?); diff --git a/crates/engine/src/boards/board/edit.rs b/crates/engine/src/boards/board/edit.rs index 97be2ba96..88a38d438 100644 --- a/crates/engine/src/boards/board/edit.rs +++ b/crates/engine/src/boards/board/edit.rs @@ -84,7 +84,7 @@ pub(super) fn set_color(s: &mut Session, p: &Value) -> Result { n.strokes = vec![Paint::solid(line_shade(color))]; } BoardItem::Connector(_) | BoardItem::Ink => doc.get_mut(id)?.strokes = vec![Paint::solid(line_shade(color))], - BoardItem::Label { .. } | BoardItem::Stamp { .. } | BoardItem::Table => continue, + BoardItem::Label { .. } | BoardItem::Stamp { .. } | BoardItem::Table | BoardItem::MindNode => continue, } changed.push(id); } @@ -132,7 +132,7 @@ impl Restyle { }; // Text sizes: shapes' and labels' text (stickies size theirs to fit). let sized = match (self.size, &item) { - (Some(size), BoardItem::Shape { .. } | BoardItem::Label { .. }) => resize_text(doc, id, size), + (Some(size), BoardItem::Shape { .. } | BoardItem::Label { .. } | BoardItem::MindNode) => resize_text(doc, id, size), _ => false, }; Ok(changed || sized) diff --git a/crates/engine/src/boards/board/items.rs b/crates/engine/src/boards/board/items.rs index b409eeb90..2a264c5b5 100644 --- a/crates/engine/src/boards/board/items.rs +++ b/crates/engine/src/boards/board/items.rs @@ -250,6 +250,7 @@ pub(super) fn add_connected(s: &mut Session, p: &Value) -> Result { to: End::Node { node: id, side: to_side, at: None }, routing, path: None, + branch: false, }; let line = make(doc, page, connector, CAPS)?; s.set_selection(vec![id]); diff --git a/crates/engine/src/boards/board/mindmap.rs b/crates/engine/src/boards/board/mindmap.rs new file mode 100644 index 000000000..5e2cff1ce --- /dev/null +++ b/crates/engine/src/boards/board/mindmap.rs @@ -0,0 +1,380 @@ +//! Mind maps (#2226): a node is a frame hugging one text ([`BoardItem::MindNode`]) and a branch is +//! a connector with `branch` set, from the parent to the child. The tree is read from the branches +//! and from nothing else; [`settle_mind_maps`] lays a touched map out again in the normalize pass, +//! so the commands only make nodes and branches. + +use std::collections::{BTreeMap, BTreeSet}; + +use figcraft_color::{Color, Paint}; +use figcraft_doc::{ + AutoLayout, BoardItem, Connector, Document, End, LetterSpacing, LineHeight, MIND_GAP_X, MIND_GAP_Y, MIND_MAX_DEPTH, MIND_MAX_NODES, MindBox, + NodeId, NodeKind, Routing, Side, Sizing, StrokeCap, TextAlignH, TextAutoResize, mind_layout, +}; +use figcraft_geom::{Affine, Point, Rect}; +use serde_json::{Value, json}; + +use super::connectors::make; +use super::items::{add, add_text, owner_of_text}; +use super::{INK, Result, Session, bad, boolean, get, id, is_board, num_or, parent_of, require, string, textedit}; +use crate::EngineError; + +/// The first node's text size and the other nodes'. +const MIND_ROOT_SIZE: f64 = 24.0; +const MIND_NODE_SIZE: f64 = 16.0; +/// The line height of every node's text, in percent, and the letter spacing of the first node's +/// and the others' (percent of the size). +const MIND_LINE_HEIGHT: f64 = 150.0; +const MIND_ROOT_TRACKING: f64 = -1.9; +const MIND_NODE_TRACKING: f64 = -1.1; +/// A node's least width: an emptied one stays clickable. +const MIND_MIN_W: f64 = 8.0; +/// What `board.mindMap` puts in the first node and its children when it isn't told. +const MIND_ROOT_TEXT: &str = "Topic"; +const MIND_STARTERS: [&str; 3] = ["Idea 1", "Idea 2", "Idea 3"]; +/// The most children `board.mindMap` makes, and the longest text it puts in a node. +const MIND_MAX_STARTERS: usize = 20; +const MIND_MAX_TEXT: usize = 500; +/// How far from the page's middle a first node may be put. +const MIND_MAX_COORD: f64 = 1.0e9; +/// Branches' look. +const BRANCH: Color = Color::from_rgb8_const(0x75, 0x75, 0x75); +const BRANCH_WEIGHT: f64 = 4.0; + +/// A node's frame and its text, `text` at `size`: the frame hugs the text with no padding, and the +/// text grows on one line. +fn make_node(doc: &mut Document, parent: NodeId, at: (f64, f64), text: &str, root: bool) -> Result<(NodeId, NodeId)> { + let size = if root { MIND_ROOT_SIZE } else { MIND_NODE_SIZE }; + let line = size * MIND_LINE_HEIGHT / 100.0; + let frame = add(doc, parent, NodeKind::Frame, "Mind map node", at, (MIND_MIN_W, line), |n| { + n.fills.clear(); + n.clip = false; + n.layout = Some(AutoLayout { padding: [0.0; 4], ..AutoLayout::default() }); + n.child_layout.sizing_h = Sizing::Hug; + n.child_layout.sizing_v = Sizing::Hug; + n.child_layout.min_w = Some(MIND_MIN_W); + n.child_layout.min_h = Some(line); + n.board = Some(BoardItem::MindNode); + })?; + let label = add_text(doc, frame, text, size, INK, TextAlignH::Left, 1.0)?; + if let Some(n) = doc.node_mut(label) { + n.child_layout.sizing_h = Sizing::Hug; + if let NodeKind::Text(td) = &mut n.kind { + td.auto_resize = TextAutoResize::WidthAndHeight; + td.style.line_height = LineHeight::Percent(MIND_LINE_HEIGHT); + td.style.letter_spacing = LetterSpacing::Percent(if root { MIND_ROOT_TRACKING } else { MIND_NODE_TRACKING }); + if root { + td.style.font_style = "Bold".into(); + } else { + td.style.font_style = "Medium".into(); + } + } + } + Ok((frame, label)) +} + +/// The branch from `parent` to `child` (on its left side when `left`), on `page`. +fn branch(doc: &mut Document, page: NodeId, parent: NodeId, child: NodeId, left: bool) -> Result { + let (out, back) = if left { (Side::Left, Side::Right) } else { (Side::Right, Side::Left) }; + let c = Connector { + from: End::Node { node: parent, side: out, at: None }, + to: End::Node { node: child, side: back, at: None }, + routing: Routing::Curved, + path: None, + branch: true, + }; + let line = make(doc, page, c, (StrokeCap::Round, StrokeCap::Round))?; + let n = doc.get_mut(line)?; + n.strokes = vec![Paint::solid(BRANCH)]; + n.stroke.weight = BRANCH_WEIGHT; + Ok(line) +} + +/// A branch of a map as the tree reads it. +#[derive(Clone, Copy)] +struct Branch { + line: NodeId, + parent: NodeId, + child: NodeId, + left: bool, +} + +/// The branches of `doc` that join two different layers of their own page, by id. (Others are +/// the normalize pass's to remove.) +fn branches(doc: &Document) -> Vec { + let mut v: Vec = doc + .nodes() + .filter_map(|n| match &n.board { + Some(BoardItem::Connector(Connector { from: End::Node { node: a, side, .. }, to: End::Node { node: b, .. }, branch: true, .. })) + if a != b && doc.contains(*a) && doc.contains(*b) && doc.page_of(*a) == doc.page_of(n.id) && doc.page_of(*b) == doc.page_of(n.id) => + { + Some(Branch { line: n.id, parent: *a, child: *b, left: *side == Side::Left }) + } + _ => None, + }) + .collect(); + v.sort_by_key(|b| b.line); + v +} + +/// The branch arriving at `node`: the one with the lowest connector id, when it has several. +fn arriving(bs: &[Branch], node: NodeId) -> Option { + bs.iter().find(|b| b.child == node).copied() +} + +/// The children of `node` on one side, in layout order (by their middles, then id). +fn map_children(doc: &Document, bs: &[Branch], node: NodeId, left: bool) -> Vec { + let mut v: Vec<(f64, NodeId)> = bs + .iter() + .filter(|b| b.parent == node && b.left == left && arriving(bs, b.child).is_some_and(|a| a.line == b.line)) + .filter_map(|b| doc.world_bounds(b.child).map(|r| (r.center().y, b.child))) + .collect(); + v.sort_by(|a, b| a.0.total_cmp(&b.0).then(a.1.cmp(&b.1))); + v.into_iter().map(|p| p.1).collect() +} + +/// Whether `node` is on the left of its map (a first node: no). +fn map_side(bs: &[Branch], node: NodeId) -> bool { + let (mut at, mut left) = (node, false); + for _ in 0..MIND_MAX_DEPTH { + let Some(b) = arriving(bs, at) else { break }; + (at, left) = (b.parent, b.left); + } + left +} + +/// The text `p` gives for `key`, a node's at most [`MIND_MAX_TEXT`] characters. +fn text_param(p: &Value, key: &str) -> String { + string(p, key).unwrap_or_default().chars().take(MIND_MAX_TEXT).collect() +} + +/// A coordinate from the params, finite and within [`MIND_MAX_COORD`] of the origin. +fn coord(cmd: &str, p: &Value, key: &str, default: f64) -> Result { + let v = num_or(p, key, default); + if v.is_finite() && v.abs() <= MIND_MAX_COORD { Ok(v) } else { Err(bad(cmd, format!("`{key}` is a position within a billion of the origin"))) } +} + +/// `children?` of `board.mindMap`: the starter texts. +fn starters(cmd: &str, p: &Value) -> Result> { + match get(p, "children") { + None => Ok(MIND_STARTERS.iter().map(|t| (*t).to_string()).collect()), + Some(Value::Array(a)) if a.len() <= MIND_MAX_STARTERS => { + a.iter().map(|v| v.as_str().map(|t| t.chars().take(MIND_MAX_TEXT).collect()).ok_or_else(|| bad(cmd, "`children` holds texts"))).collect() + } + _ => Err(bad(cmd, format!("`children` is a list of at most {MIND_MAX_STARTERS} texts"))), + } +} + +pub(super) fn mind_map_cmd(s: &mut Session, p: &Value) -> Result { + let cmd = "board.mindMap"; + require(s, cmd)?; + let parent = parent_of(cmd, s, p)?; + let (vx, vy) = { + let v = &s.ds()?.view; + (v.cx, v.cy) + }; + let (x, y) = (coord(cmd, p, "x", vx)?, coord(cmd, p, "y", vy)?); + let texts = starters(cmd, p)?; + let root_text = string(p, "text").map_or_else(|| MIND_ROOT_TEXT.to_string(), |_| text_param(p, "text")); + let page = s.page()?; + let doc = s.doc_mut()?; + let (root, label) = make_node(doc, parent, (x, y), &root_text, true)?; + let mut made = Vec::new(); + // Anywhere below one another will do: the normalize pass puts them right, in this order. + let line = MIND_NODE_SIZE * MIND_LINE_HEIGHT / 100.0 + MIND_GAP_Y; + for (i, t) in texts.iter().enumerate() { + let (k, text) = make_node(doc, parent, (x + MIND_MIN_W + MIND_GAP_X, y + i as f64 * line), t, false)?; + let b = branch(doc, page, root, k, false)?; + made.push(json!({"id": k, "text": text, "connector": b})); + } + s.set_selection(vec![root]); + if boolean(p, "edit") == Some(true) { + s.request_ui("board.editText", json!({"id": root})); + } + Ok(json!({"id": root, "text": label, "children": made})) +} + +pub(super) fn mind_map_add(s: &mut Session, p: &Value) -> Result { + let cmd = "board.mindMapAdd"; + require(s, cmd)?; + let editing = s.ds()?.text_edit.as_ref().map(|t| t.id); + let doc = s.doc()?; + let from = id(p, "id") + .or_else(|| editing.and_then(|t| owner_of_text(doc, t))) + .or_else(|| s.selection().first().copied().map(|i| owner_of_text(doc, i).unwrap_or(i))) + .ok_or_else(|| EngineError::Disabled(cmd.into(), "select a mind map node first".into()))?; + let n = doc.get(from)?; + if n.board != Some(BoardItem::MindNode) { + return Err(bad(cmd, "that isn't a mind map node")); + } + let sibling = match string(p, "relation").as_deref() { + None | Some("child") => false, + Some("sibling") => true, + Some(other) => return Err(bad(cmd, format!("`relation` is child or sibling, not `{other}`"))), + }; + let (page, container) = (s.page()?, n.parent.ok_or_else(|| bad(cmd, "that node has no parent"))?); + if doc.page_of(from) != Some(page) { + return Err(bad(cmd, "that node is on another page")); + } + let bs = branches(doc); + let at = doc.world_bounds(from).ok_or_else(|| bad(cmd, "that node has no place"))?; + let new_h = MIND_NODE_SIZE * MIND_LINE_HEIGHT / 100.0; + // The parent, the side, and where the new node's top-left goes on the page. + let (parent, left, top_left) = if sibling { + let a = arriving(&bs, from).ok_or_else(|| bad(cmd, "the first node has no siblings: add a child"))?; + // Its middle lands between this node and the next sibling, so the order puts it right after. + (a.parent, a.left, Point::new(at.x0, at.y1 + MIND_GAP_Y / 2.0 - new_h / 2.0)) + } else { + let left = map_side(&bs, from); + let last = map_children(doc, &bs, from, left).last().and_then(|l| doc.world_bounds(*l)); + let top = last.map_or(at.center().y - new_h / 2.0, |l| l.y1 + MIND_GAP_Y); + (from, left, Point::new(if left { at.x0 - MIND_GAP_X - MIND_MIN_W } else { at.x1 + MIND_GAP_X }, top)) + }; + let local = doc.world_transform(container).inverse() * top_left; + if !(local.x.is_finite() && local.y.is_finite()) { + return Err(bad(cmd, "the new node can't be placed there")); + } + let text = text_param(p, "text"); + if editing.is_some() { + textedit::end(s)?; + } + let doc = s.doc_mut()?; + let (node, label) = make_node(doc, container, (local.x, local.y), &text, false)?; + let line = branch(doc, page, parent, node, left)?; + s.set_selection(vec![node]); + if boolean(p, "edit") == Some(true) { + s.request_ui("board.editText", json!({"id": node})); + } + Ok(json!({"id": node, "text": label, "connector": line})) +} + +/// The tree of a document's branches: for each layer its arriving branch (the lowest connector +/// id), and each parent's children by it. +type Children = BTreeMap>; + +fn children_of(bs: &[Branch]) -> (BTreeSet, Children) { + let mut arrived = BTreeSet::new(); + let mut kids: Children = BTreeMap::new(); + for b in bs { + if arrived.insert(b.child) { + kids.entry(b.parent).or_default().push(*b); + } + } + (arrived, kids) +} + +/// Every branch that no longer joins two layers of its own page is removed, and the layers it +/// joined that are still there count as stirred (so do the old ends of a touched branch: one that +/// is gone, or that was moved to join something else). +fn prune_branches(doc: &mut Document, before: &Document, touched: &BTreeSet) -> BTreeSet { + let mut stirred = BTreeSet::new(); + let ends = |c: &Connector| [c.from.node(), c.to.node()].into_iter().flatten().collect::>(); + for id in touched { + if let Some(BoardItem::Connector(c)) = before.node(*id).and_then(|n| n.board.as_ref()) + && c.branch + { + stirred.extend(ends(c)); + } + } + let mut gone = Vec::new(); + for n in doc.nodes() { + let Some(BoardItem::Connector(c)) = &n.board else { continue }; + let page = doc.page_of(n.id); + let joins = |e: &End| matches!(e, End::Node { node, .. } if doc.contains(*node) && page.is_some() && doc.page_of(*node) == page); + if c.branch && !(joins(&c.from) && joins(&c.to) && c.from.node() != c.to.node()) { + gone.push((n.id, ends(c))); + } + } + for (line, joined) in gone { + stirred.extend(joined); + let _ = doc.remove(line); + } + stirred.retain(|i| doc.contains(*i)); + stirred +} + +/// The boxes of the map under `root`, breadth first (so a parent always comes before its +/// children), and the connectors that hold it together. `None`: a box is missing, or the map has +/// more than [`MIND_MAX_NODES`] nodes (it is left as it is). +fn map_boxes(doc: &Document, root: NodeId, kids: &Children) -> Option<(Vec, Vec)> { + let first = doc.world_bounds(root)?; + let mut boxes = vec![MindBox { id: root, rect: first, parent: None, left: false }]; + let (mut lines, mut seen) = (Vec::new(), BTreeSet::from([root])); + let (mut at, mut depths) = (0, vec![0_usize]); + while let Some(b) = boxes.get(at).copied() { + let depth = depths.get(at).copied().unwrap_or(MIND_MAX_DEPTH); + for k in kids.get(&b.id).filter(|_| depth < MIND_MAX_DEPTH).into_iter().flatten() { + if !seen.insert(k.child) { + continue; + } + if boxes.len() >= MIND_MAX_NODES { + return None; + } + boxes.push(MindBox { id: k.child, rect: doc.world_bounds(k.child)?, parent: Some(at), left: k.left }); + depths.push(depth + 1); + lines.push(k.line); + } + at += 1; + } + Some((boxes, lines)) +} + +/// Move layer `id` by `d` on the page. +fn shift(doc: &mut Document, id: NodeId, d: Point) { + let parent = doc.node(id).and_then(|n| n.parent).map_or(Affine::IDENTITY, |p| doc.world_transform(p)); + let inverse = parent.inverse(); + if !inverse.as_coeffs().iter().all(|v| v.is_finite()) { + return; + } + if let Some(n) = doc.node_mut(id) { + let moved = inverse * Affine::translate((d.x, d.y)) * parent * n.transform; + if moved.as_coeffs().iter().all(|v| v.is_finite()) { + n.transform = moved; + } + } +} + +/// After layout and before connectors follow: the maps an edit touched are laid out again from +/// their first nodes (a map that is already in place is not written to, so the pass is idempotent). +/// A branch that no longer joins two layers of its page is removed first: the only structural +/// write, and what makes a deleted node's children float free and a detached node stay detached. +pub(crate) fn settle_mind_maps(doc: &mut Document, before: &Document, touched: &BTreeSet) { + if !is_board(doc) || touched.is_empty() { + return; + } + // One look at every layer: a board without a branch (nearly all) goes no further. + if !doc.nodes().any(|n| matches!(&n.board, Some(BoardItem::Connector(c)) if c.branch)) { + return; + } + let stirred = prune_branches(doc, before, touched); + let bs = branches(doc); + if bs.is_empty() { + return; + } + let hit = |doc: &Document, id: NodeId| touched.contains(&id) || doc.ancestors(id).iter().any(|a| touched.contains(a)); + let (arrived, kids) = children_of(&bs); + let roots: Vec = kids.keys().copied().filter(|p| !arrived.contains(p)).collect(); + for root in roots { + let Some((boxes, lines)) = map_boxes(doc, root, &kids) else { continue }; + if boxes.iter().any(|b| !(b.rect.x0.is_finite() && b.rect.y0.is_finite() && b.rect.x1.is_finite() && b.rect.y1.is_finite())) { + continue; + } + // A map holding a layer and something inside it would move that layer with its own + // children: leave it as it is. + let ids: BTreeSet = boxes.iter().map(|b| b.id).collect(); + if boxes.iter().any(|b| doc.ancestors(b.id).iter().any(|a| ids.contains(a))) { + continue; + } + let stale = boxes.iter().any(|b| stirred.contains(&b.id) || hit(doc, b.id)) || lines.iter().any(|l| hit(doc, *l)); + if !stale { + continue; + } + let now: BTreeMap = boxes.iter().map(|b| (b.id, b.rect)).collect(); + for (id, to) in mind_layout(&boxes) { + let Some(was) = now.get(&id) else { continue }; + let d = to - was.origin(); + if d.x.is_finite() && d.y.is_finite() && d.hypot() > 1e-6 { + shift(doc, id, Point::new(d.x, d.y)); + } + } + } +} diff --git a/crates/engine/src/boards/board/reshape.rs b/crates/engine/src/boards/board/reshape.rs index 2f441c7ce..2295b94b6 100644 --- a/crates/engine/src/boards/board/reshape.rs +++ b/crates/engine/src/boards/board/reshape.rs @@ -26,7 +26,7 @@ fn moved(doc: &Document, c: &Connector, portion: usize, p: Point) -> Option