From 56542407292b911ad30523cfcfa987923fe2f8e2 Mon Sep 17 00:00:00 2001 From: aiongg <67543387+aiongg@users.noreply.github.com> Date: Tue, 27 Oct 2026 21:28:53 -0400 Subject: [PATCH 01/49] refactor(cli): parse `cadcraft-cli` arguments with clap, following RFC-0012 (#2268) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * test(cli): pin today's command-line behaviour The later commits change these tests on purpose, so each behaviour change shows in their diff. * refactor(cli): split main.rs into modules, move only - output: outln!, stdout state, atomic write, export helpers, view/window helpers - args: USAGE, option validation, framing options, MCP argument parsing and its tests - info, convert, sample, mcp: one subcommand each - perf: synthetic drawing, Rng, perf subcommands - run: run subcommand and {last} handle chaining - main: crate docs, mod lines, install_io, open, main, cli, unit tests No behaviour change. * refactor(cli): typed errors and run(args, out, err) cadcraft-cli is now a library plus a thin binary. `cadcraft_cli::run(args, out, err) -> i32` is the whole program; main.rs only passes `args_os()` and the process streams. Handlers write through a `Streams` wrapper (output.rs) instead of the process streams; it keeps the closed-stdout semantics (drop later output, carry on, a closed pipe is not an error, other write errors are reported once and make the exit code 1). `mcp` still speaks MCP on the real stdin/stdout. Errors are typed (thiserror): CliError (error.rs) wraps EngineError, DocError, IoError, io::Error and the per-module WindowError, ArgsError, RunError, OutputError and PerfError. `run` prints `error: {e}` and exits 1. The usage text and the "unknown option/argument" messages stay as one transitional CliError::Usage(String), printed without the `error: ` prefix. USAGE stays a const; step 4 (clap) removes both. The engine's IoHooks take `Result<_, String>`, so the three `.map_err(|e| e.to_string())` in install_io remain. The hooks are set-once (OnceLock), so installing them on every `run` call is harmless. tests/it/usage.rs calls `run` in-process with Vec writers; the headless mcp case runs through the binary (it reads the real stdin) and a non-Unicode argument test is new. Behaviour changes (old -> new): - Every error line other than the usage-class ones gains the prefix `error: ` (e.g. `--view needs ...` -> `error: --view needs ...`, `unknown command `x`` -> `error: unknown command `x``, `invalid parameters for `open`: ...` -> `error: invalid parameters ...`, `unsupported file type` likewise). - `cadcraft-cli: cannot connect to HOST:PORT: e` -> `error: cannot connect to HOST:PORT: e` (the old prefix is replaced). - A non-Unicode argument: panic, exit 101 -> `error: argument "..." is not valid Unicode`, exit 1. - Unchanged: usage text, `X: unknown option --y`, `unknown option --y`, `mcp: unknown argument ...` (no prefix); warnings and `wrote ...` lines; the `cadcraft-cli: can't write to stdout: e` report; exit codes. * refactor(cli): parse arguments with clap Replace the hand-written parser (USAGE, validate_options, OptionSpec, framing_option, parse_mcp_args, CliError::Usage) with clap derive types in args.rs: a Cli parser and one Args struct per subcommand, with the framing flags (--window, --view) in a FramingArgs struct flattened into convert and run. USAGE's framing and --cmd chaining text moves into the subcommands' and flags' doc comments and run's long help, so --help carries it. `commands` moves from an inline closure to commands.rs. `command()` exposes the clap definition for man pages and completions. clap reads the arguments as OsStrings. Help and --version go to stdout with exit 0; usage errors are clap's, on stderr with exit 2. A bare --help or -h before `--` shows the subcommand's help even after a mistake on the line (`run --script --help`). run opens its drawings (FILEs, --sample, --metric) and runs its steps (--script, --script-file, --cmd) in command-line order, from ArgMatches::indices_of. Values stay strings checked by the handlers, with their messages and exit 1 (--window, --view, --cmd JSON, sample names, perf counts). The last of a repeated flag wins (args_override_self on every subcommand but mcp). Behaviour changes: Help and version - --help, -h, help: the USAGE page -> clap's help, first line "cadcraft-cli: headless CADCraft". - bare cadcraft-cli: USAGE on stderr, exit 1 -> clap's help on stderr, exit 2. - --help / -h, help : "unknown option --help" (exit 1), the USAGE page (convert, help ) or a file named -h (info -h, run -h) -> that subcommand's help, stdout, exit 0. - --version: "unknown option --version", exit 1 -> clap's unexpected argument, exit 2. Usage errors (exit 1 -> exit 2, clap's messages) - Unknown subcommand, empty subcommand, unknown top-level flag: USAGE -> "error: unrecognized subcommand 'foo'" / "error: unexpected argument '--bogus' found". - Unknown flag on any subcommand: "info: unknown option --bogus", "unknown option --bogus", "mcp: unknown argument --bogus" or USAGE (convert) -> "error: unexpected argument '--bogus' found". - A short flag where a file is expected (info -x): opened as a file -> unexpected argument; `--` before it keeps it a file name. - A value flag at the end or followed by a flag (--window, --view, --script, --script-file, --cmd, --save, --export, --connect): "error: --script needs text" and the like, or the next flag taken as the value (--window --view, --script --sample, --cmd --sample, --script-file --sample) -> "error: a value is required for '--script ' but none was supplied". --connect followed by an unknown flag (--connect --foo, --connect -v) names that flag instead (clap reports the unknown argument, not the missing value). - mcp --connect with an empty value: "error: --connect needs HOST:PORT ..." -> "error: invalid value ' ' for '--connect ': expected HOST:PORT (...)"; --connect=-v likewise. - mcp --connect twice: "error: --connect given more than once" -> "error: the argument '--connect ' cannot be used multiple times". - mcp --lazy / --launch without --connect: "error: --lazy and --launch need --connect HOST:PORT" -> "error: the following required arguments were not provided: --connect ". - Missing positionals (info, convert with 0 or 1 files, sample with 0 or 1 arguments): USAGE -> "error: the following required arguments were not provided". - Extra positionals: convert with three files (USAGE), and info, commands, perf, sample, which ignored the extra argument -> "error: unexpected argument 'extra' found". - perf -5: opened as a file -> unexpected argument '-5'. - A non-Unicode argument where text is expected: "error: argument ... is not valid Unicode", exit 1 -> "error: invalid UTF-8 was detected in one or more arguments", exit 2. Accepted where they were errors - --x=v is a spelling of --x v for every value flag (--window, --view, --script, --script-file, --cmd, --save, --export, --connect); before it was an unknown option or USAGE. A value starting with - needs the = form (--cmd=-x). - commands --: "unknown option --" -> `--` ends the options (all commands listed). - run --view extents --view current: "use only one of --window and --view" -> the last wins, like every other repeat. Other - run --sample --sample opens one sample drawing (was two): repeated flags are last-wins. - run checks --window/--view values before opening any drawing, so a bad framing value is reported ahead of a missing file. - `-h` after a mistake shows the long help (`--help`): the retry asks for --help. Unchanged: --window with --view, framing without an image output, --view's case-insensitivity, all value messages (--window numbers, --view values, --cmd JSON, {last}, sample names, --script-file read errors), multiple FILEs, --sample with --metric or a FILE, last-wins for --save, --export, --window, --script/--cmd order, and `\n` in --script. clap forced: exit 2 for usage errors, its message wording, and the unknown-flag-over-missing-value precedence above. * refactor(cli): reject repeated flags, long version (photocraft#7071 decisions) Behaviour changes, old -> new: - --save, --export, --window, --view, --sample, --metric, --lazy, --launch given twice: last one won -> usage error, exit 2 ("the argument ... cannot be used multiple times"). --connect was already rejected. --script, --script-file, --cmd and run's FILEs still repeat. - --version / -V: "cadcraft-cli " -> "cadcraft-cli ()", sha from CADCRAFT_BUILD_SHA or "dev", as the desktop app prints it. - "cadcraft-cli version" is an unrecognized-subcommand usage error (as before; now tested). - A value starting with "-" needs the = form for every value flag (as before, tested). --window -10,-10,10,10 stays a usage error ("unexpected argument -1"); write --window=-10,-10,10,10. clap's allow_negative_numbers does not accept a comma list, and allow_hyphen_values would let --window swallow the next flag, so neither is set. The --window help text names the = form. * refactor(cli): typed values and flag relations Step 6 of #2228: values are parsed into their types and flag relations are checked at parse time, so a bad value or combination is a usage error (exit 2) naming the flag, before any work starts. The handlers receive typed values only. Runtime failures (files, the engine, a `{last}` with no earlier handle) stay exit 1. - --window parses to a Bounds2 (parse_window plus cadcraft_io's check_window); its WindowError is the value parser's error. - --view is a ValueEnum (extents, current), case-insensitive; the long help lists what each value does. - --window conflicts_with --view. In run, --window/--view require --export (an ArgGroup "framing" with requires). A framing flag with an output that isn't an image (convert's OUT, run's --export) is a UsageError turned into a clap error by into_clap (ArgumentConflict). - sample's name is a ValueEnum (bracket, floorplan); `floor` stays a hidden alias. - perf's N|FILE is one typed positional: a value that parses as a count is one, clamped to 1..=20000000 as before (so `perf 0` still times one entity); anything else is a drawing. - --cmd 'id {json}' parses to an id and a serde_json::Value (default {}); `{last}` is still filled in when the command runs. - Paths are PathBufs (info FILE, convert IN/OUT, run FILEs, --script-file, --save, --export, sample OUT, perf FILE). The engine and io crates take file names as text, so a path that isn't valid Unicode is refused by the handler, naming the file (exit 1). - Deleted: check_framed_output, the --view match, ArgsError, CliError::Window/Args/UnknownSample, RunError::CmdJson, PerfError::BadCount. - run's FILEs, --sample and --metric still combine (each opens another drawing, the last is current): neither photocraft#7071 nor RFC-0012 requires otherwise. Behaviour changes (old -> new): - --window with a bad value (wrong count, not a number, NaN/inf, reversed corners, beyond 1e12): exit 1 `error: --window ...` -> exit 2 `error: invalid value 'V' for '--window ': `. The reasons no longer repeat the flag or the value. - --view with a bad value: exit 1 `error: --view needs `extents` or `current`` -> exit 2 `error: invalid value 'V' for '--view '` plus clap's possible-values line. - --window with --view: exit 1 `error: use only one of --window and --view` -> exit 2 `error: the argument '--window ' cannot be used with '--view '`. - run --window/--view without --export: exit 1 `error: --window/--view need an image output ...` -> exit 2 `error: the following required arguments were not provided: --export `. - A framing flag with a non-image output: exit 1 `error: --window/--view only apply to image output (png, svg, pdf), not `OUT`` -> exit 2 `error: --window only applies to image output (png, svg, pdf), not `OUT`` (or --view: the message names the flag given). - sample with an unknown name: exit 1 `error: unknown sample `X` (bracket, floorplan)` -> exit 2 `error: invalid value 'X' for ''` plus the possible values. sample's help lists the possible values. - --cmd with JSON that doesn't parse: exit 1 `error: --cmd ID: `, after the earlier steps ran -> exit 2 `error: invalid value 'V' for '--cmd ': `, before anything runs. - --cmd with an empty id (`--cmd=` or `--cmd ' {}'`): exit 1 `error: unknown command `` ` -> exit 2 `... expected a command id, then optionally its JSON parameters`. - An empty path argument (info "", sample bracket "", perf "", ...): exit 1 from the engine or io -> exit 2 `error: a value is required for '' but none was supplied` (clap's PathBuf parser). - A path that isn't valid Unicode: exit 2 `error: invalid UTF-8 was detected ...` -> exit 1 `error: PATH: the file name is not valid Unicode` (text values that aren't Unicode stay exit 2). A non-Unicode --save or --export is refused before any drawing opens. - perf's help gives the count range. Tests: usage.rs rows above moved to exit 2 with clap's messages; new rows for --view with a non-image output, run's framing with a dxf --export, an empty --cmd id, bad --cmd JSON after a good step, a `{last}` with no earlier handle, --window beyond 1e12, case-sensitive sample names and empty paths. The non-Unicode test covers both a path (exit 1) and text (exit 2). Unit tests: the --window parser tests moved to args.rs; new ones for --cmd values and perf targets; framing_options checks the clap error kinds. * refactor(cadcraft): move launch-argument parsing into launch_args Moves the hand-written parser (the argument loop, control_port_from, control_flag and their tests) from main.rs into launch_args.rs, which returns LaunchArgs. No behaviour change. * refactor(cadcraft): parse launch flags with clap (RFC-0012) Replaces the hand-written loop in launch_args.rs with clap derive types, as photocraft's launch_args.rs does. --help is generated from the doc comments and lists the other CADCRAFT_* variables. Behaviour changes (old -> new): - An unknown flag (--sampel) was opened as a file; it is now a usage error on stderr, exit 2, before the window opens. A file starting with "-" goes after "--". - A repeated --control or --sample was accepted (last wins); it is now exit 2. - A bad port (--control abc, 70000, -1) was logged and the control channel left off; it is now exit 2. The same for CADCRAFT_CONTROL_PORT, and the error names the variable when the value came from it. - A bare --control (no value) kept CADCRAFT_CONTROL_PORT's port with a warning; it is now exit 2 ("a value is required"). A following flag is never taken as the value. - An empty or blank CADCRAFT_CONTROL_PORT was logged as a bad port; it is now unset. - --control=7979 is accepted (the equals form was opened as a file before). - --version / -V and --help stop parsing at once and exit 0; version text is unchanged ("cadcraft ()"). - -psn_* (Finder process serial number) is dropped instead of opened as a file. - A file name that is not valid Unicode used to panic in std::env::args(); it is now read from args_os and reported with a log warning, not opened, because CadApp::open_path takes text. Copied from photocraft's crates/automation/src/args.rs: blank_env_is_unset and name_env_vars unchanged (name_env_vars gets a local use for ContextKind/ContextValue); control_port and NotAPort unchanged. allow_negative_numbers is set on --control as in photocraft, so -1 is a bad value rather than a missing one. * feat(cli): shell completions and man pages Adds examples/man-and-completions.rs, which writes cadcraft-cli's bash, zsh, fish, elvish and PowerShell completions (clap_complete) and man pages (clap_mangen: cadcraft-cli.1 and one per subcommand) into a directory. clap_complete and clap_mangen are dev-dependencies, so the binary is unchanged. packaging/linux/package.sh builds the example in its own cargo run, runs it (through $EMULATOR for cross builds; warns and leaves the files out without one) and installs the man pages and the bash, zsh and fish completions into the staged tree. nfpm.yaml already ships the whole usr/share tree, so it needs no change. CADCraft has no FreeBSD packaging, so there is no FreeBSD script to update. macOS and Windows packaging are untouched. tests/man_and_completions.rs checks the generated file names. * ci(cli): check the command-line code with ast-grep (RFC-0012) Adds ast-grep rules from RFC-0012, run by craft-common-actions' reusable ast-grep workflow (Linux, no Rust build, path-filtered): - clap-error-message: a string literal, format!, .to_string() or SCREAMING_CASE const passed to Command::error / Error::raw - clap-error-message-variable: the same message built into a variable first, in the same function - string-error: Result<_, String>, Err(format!(..)), Err(".."), Err(x.to_string()) - args-os: std::env::args(), which panics on non-Unicode arguments Scan paths: apps/cadcraft-cli/src, apps/cadcraft/src/launch_args.rs, apps/cadcraft/src/main.rs. Rule tests run first in CI. Source: photocraft#9750 at d16686cd. Only the scan paths and the workflow path filters differ from it. Fixes: none needed. The rule tests pass (4 passed) and the scan finds nothing in the scanned paths. * docs(cli): cadcraft-cli page, following RFC-0012 docs/cli.md: --help is the reference; exit codes, streams, usage errors, values starting with -, paths, completions and man pages; the environment variables (none for cadcraft-cli, CADCRAFT_CONTROL_PORT for the desktop app's --control); and the rules not followed yet, with the reason. The README links it. * feat(cli): refuse an output that replaces an input RFC-0012 rule 1.6: nothing destructive by default. Behaviour change: `convert a.dxf a.dxf`, `run a.dxf … --save a.dxf` and `run a.dxf … --export a.dxf` used to overwrite the input. They are now a usage error (exit 2, `error: …` on stderr, nothing opened or written) unless `--in-place` is given. "Same file" is file identity (same-file crate), so `dir/./a.dxf` and a symlink to the input count. An output that does not exist, or a failed identity check, is not refused; the open or write reports the real error. Replacing an existing file that is not an input is still allowed. Scope: `--save` and `--export` only. A save that a --cmd or script runs (for example `saveas`) is the engine's and is not checked. Every write the CLI makes (convert OUT, --save, --export, sample OUT) resolves an existing output first, so writing through a symlink updates the file it points to and the link stays a link; the atomic rename used to replace the link with a regular file, leaving the target (with --in-place, the input) unchanged. * feat(cli): --compact for JSON output RFC-0012 rule 1.3: info and commands pretty-print their JSON by default; --compact prints it on one line. run prints one JSON line per --cmd result (JSON lines, one result per step), as its help and the README document, so it takes no --compact. mcp's stdout is the MCP protocol and is unchanged. Behaviour change: info and commands accept --compact (it was an unknown flag, exit 2). Their default output is unchanged. docs/cli.md says which subcommand prints which form, and lists perf's text table (no --json) and saves a --cmd or script runs (not checked by --in-place) under "Not followed yet". * fix(cadcraft): one Switch parser for boolean environment switches CADCRAFT_VSYNC, CADCRAFT_SYSTEM_CURSOR, CADCRAFT_WAYLAND and CADCRAFT_NO_NATIVE_MENU each had their own idea of "on". They now share cadcraft_ui_egui::switch::Switch: 1/on/true/yes is On, 0/off/false/no is Off (case- and space-insensitive), unset or blank is Default, and any other value is Default and logged with the variable name. The ENVIRONMENT help text says the same for all four. Behaviour changes (old -> new): - CADCRAFT_WAYLAND=0 counted as on (any value did); now only On keeps native Wayland. - CADCRAFT_NO_NATIVE_MENU=0 counted as on (any value did); now only On keeps the menus inside the window. - CADCRAFT_SYSTEM_CURSOR treated every value except ""/0/false/off as on; now only the On spellings do, and an unknown value is logged. - CADCRAFT_VSYNC is unchanged except that an unknown value is logged. * fix(cli): keep paths as paths until a file is opened A path is now text only where text is needed. - cadcraft: FileNames.unreadable is Vec, logged with {:?} (escaped bytes) instead of a lossy rendering. - cadcraft-cli: unicode() is called only inside open(), the one place that sends a path to the engine as JSON. convert, sample and run --save/--export pass the output as &Path. write_atomic, export, export_framed and OutputError::Write take or hold a Path/PathBuf; errors use .display(), and the `wrote ...` line uses .display(). - Dropped the dead find_subcommand lookup in launch_args (LaunchArgs has no subcommands). - docs/cli.md: non-Unicode names are refused only where a drawing is opened. Behaviour change: an output name that is not valid Unicode used to be refused (exit 1); it is now written under that exact name. Opening such a drawing is still refused. Lossy strings that remain (all feed APIs that take text and only look at the extension, never at the path the bytes are written to): - cadcraft_io::write / write_framed (name picks the format) in sample.rs and output.rs::export_framed; - cadcraft_io::is_image in convert.rs, run.rs and args.rs (framing flag check); - cadcraft_engine::cmd::file::drops_unknown in export_framed. These go away when cadcraft_io and the engine take impl AsRef (the A1 follow-up). A non-Unicode extension is not a known format either way, so it is rejected as an unsupported type, as before. * refactor(cadcraft): read the environment once into Env The desktop app reads its CADCRAFT_* variables once at startup into apps/cadcraft/src/env.rs `Env` and passes the values on; no library crate reads a CADCRAFT_* variable at run time any more. - One `VARS` table (name, help line) feeds both the reader and the Environment section of `cadcraft --help`. A test checks that every variable the reader asks for is in the table, that every table entry sets a field, and that the help lists every entry. - vsync goes to `gpu::surface_config`, the system cursor to `CadApp::set_system_cursor_default` (Options reset and Reset Palettes go back to it), FONTALT/FONTFALLBACK to the `cadcraft_fonts::ttf` setters (re-exported as `cadcraft_engine::fonts`), the settings directory to the new `cadcraft_engine::settings_dir::set`, and to `Workspace::load`. - The three copies of the settings-directory rule (main.rs, workspace.rs, the engine's plotter folder) are one: `settings_dir::platform`. - `Switch::from_env` is gone; `Switch::parse` stays. - The child-process tests for CADCRAFT_CONTROL_PORT are replaced by tests that inject the variable lookup (`blank_env_is_unset`) or point `--control`'s fallback at PATH. cadcraft-cli: plotter configurations matter to its output (`run --cmd plot` or a script's PLOT with a user device, and the same through `mcp`), and the font variables change how convert/run/sample draw text. So, following RFC-0012 rule 1.7, the variables become fallbacks of flags declared with `env =`: --config-dir (CADCRAFT_CONFIG_DIR), --fontalt (CADCRAFT_FONTALT) and --fontfallback (CADCRAFT_FONTFALLBACK) on convert, run, mcp and sample. Behaviour changes: - CADCRAFT_CONFIG_DIR set but empty counts as unset everywhere: the workspace file and the plotter folder use the platform folder (was: workspace persistence and the plotter folder off). Logs and autosave already treated it so. - The workspace file and the plotter folder ignore a relative XDG_CONFIG_HOME, as logs and autosave did (was: used it). - A blank CADCRAFT_LOCALE means the system's languages (was: [""]). - cadcraft-cli: the three variables apply only to convert, run, mcp and sample, as flag fallbacks (was: read by the engine and fonts in every subcommand, perf included). A font variable that isn't valid Unicode is a usage error naming the flag (was: ignored). * refactor(io): one Format enum for file extensions `cadcraft_doc::Format` (re-exported as `cadcraft_io::Format`) is the one place that maps a file name's extension to a format: Dxf, Dwg, Dwt, Svg, Svgz, Png, Pdf. `from_path` is ASCII case-insensitive; no extension (or a trailing dot) is Dxf; an unknown extension is None. `READ` and `WRITE` list the formats `read` and `write` accept. It lives in cadcraft-doc because the engine depends on cadcraft-io only for tests. Each place used to match on its own lower-cased extension string and now matches on Format, with the same results: - io::read: svg/svgz -> SVG reader, dxf/none -> DXF reader, other -> try DXF, else Unsupported(ext). - io::write_with: dxf/none -> DXF, dwg -> DWG bridge, other with binary -> error, rest -> write_framed. - io::write_framed: dwt -> DWG; dxf/none/dwg -> write_with; svg, png, pdf -> image writers; other -> Unsupported(ext). - io::is_image: svg, png, pdf (not svgz, which is read only). - engine file.rs is_dxf, drops_unknown (dwg, dwt), is_drawing_file (dxf, dwg, dwt, none). Behaviour change (help text only): the CLI help lists the formats from Format::READ / Format::WRITE instead of hand-written lists. `info` and `convert IN` now name svg and svgz as readable, and `convert`, `sample`, `run --save` and `run --export` name dwt (and `sample` pdf) as writable. A test checks each file argument's help names every format of its list. * refactor: one version string for the app and the CLI cadcraft_engine::build_version() builds " ()" once; the desktop app's --version, its start-up log line and cadcraft-cli --version all use it. No change in output. * refactor(cli): share the environment helpers with the CLI Move blank_env_is_unset and name_env_vars from the desktop app into cadcraft_mcp::args and apply them in the CLI parser. Behaviour changes (old -> new): - Empty or blank CADCRAFT_FONTALT / CADCRAFT_FONTFALLBACK: reached clap as Some("") -> counts as unset. - A bad value from an environment variable: the error named the flag -> names the variable. - CADCRAFT_CONFIG_DIR is unchanged: empty still means no settings folder. - Desktop app: unchanged; it uses the shared helpers. * refactor: pass paths, not text, through io, engine and open_path cadcraft_io::{read, write, write_with, write_framed, is_image}, the engine's drops_unknown/is_drawing_file/read_text_file and CadApp::open_path take paths (impl AsRef / &Path). The desktop launch arguments and the CLI no longer convert paths to text to call them. Behaviour changes (old -> new): - A dropped file whose name is not valid Unicode opened with a "can't read" error naming a mangled path; it now opens natively. (Its path is not remembered for QSAVE, which then asks where to save.) - A launch argument that is not valid Unicode was logged and skipped; it now opens like any other. - A .dwt export builds the .dwg name as a path, not formatted text. - On the web, a non-Unicode path passed to open_path reports "the path is not valid Unicode" instead of a lossy name. - Opening errors print path.display(). FileNames and LaunchArgs::file_names are removed; the launch tests assert the parsed PathBufs. New io test: non-Unicode names pick the format by extension. * docs(cli): CADCRAFT_CONFIG_DIR is the one flag fallback where empty isn't unset * fix(engine): refuse a drawing path that isn't valid Unicode read_file opened such a path with no saved path, so QSAVE could not save back to it. It now returns an open error naming the file before reading it. The ui-egui opener already reports read_file errors like any other failed open. * fix(cli): report a failed write of help or version A write error on help or version output (other than a closed pipe) now exits 1 and tries to say so on stderr; it was ignored and exited with the clap code. A closed pipe keeps the clap exit code. * fix(cli): --connect needs HOST:PORT --connect example.com was accepted and failed later. It is now a usage error (exit 2) unless the value is a non-empty host (or a bracketed IPv6 address) and a u16 port. The host is not resolved. * docs(cli): run prints no line for a command with no result * refactor(cli): explicit imports and smaller functions for the stricter lints Lints: clippy::wildcard_imports, too_many_arguments, cognitive_complexity (30). Replaced the non-test `use super::*;` in args, commands, convert, info, output, perf and run with explicit imports; lib.rs keeps only the imports its non-test code uses, and its test module imports the rest itself. The `super::*` in the test modules stays. A clippy run with all three lints and threshold 30 reports nothing in apps/cadcraft-cli or in code this branch added, so no function needed splitting. --- .github/workflows/ast-grep.yml | 26 + Cargo.lock | 159 +++ Cargo.toml | 4 + README.md | 5 +- apps/cadcraft-cli/Cargo.toml | 17 + .../examples/man-and-completions.rs | 41 + apps/cadcraft-cli/src/args.rs | 786 ++++++++++++ apps/cadcraft-cli/src/commands.rs | 17 + apps/cadcraft-cli/src/convert.rs | 22 + apps/cadcraft-cli/src/error.rs | 29 + apps/cadcraft-cli/src/info.rs | 14 + apps/cadcraft-cli/src/lib.rs | 315 +++++ apps/cadcraft-cli/src/main.rs | 1113 +---------------- apps/cadcraft-cli/src/mcp.rs | 17 + apps/cadcraft-cli/src/output.rs | 177 +++ apps/cadcraft-cli/src/perf.rs | 196 +++ apps/cadcraft-cli/src/run.rs | 223 ++++ apps/cadcraft-cli/src/sample.rs | 14 + apps/cadcraft-cli/tests/it/help.rs | 14 +- apps/cadcraft-cli/tests/it/main.rs | 1 + apps/cadcraft-cli/tests/it/mcp_connect.rs | 9 +- apps/cadcraft-cli/tests/it/usage.rs | 950 ++++++++++++++ .../cadcraft-cli/tests/man_and_completions.rs | 30 + apps/cadcraft/Cargo.toml | 2 + apps/cadcraft/src/env.rs | 172 +++ apps/cadcraft/src/launch_args.rs | 158 +++ apps/cadcraft/src/logging.rs | 2 +- apps/cadcraft/src/main.rs | 171 +-- apps/cadcraft/src/workspace.rs | 43 +- crates/doc/src/format.rs | 100 ++ crates/doc/src/lib.rs | 2 + crates/engine/src/cmd/file.rs | 31 +- crates/engine/src/cmd/plotters.rs | 18 +- crates/engine/src/lib.rs | 10 + crates/engine/src/lisp/builtins/files.rs | 6 +- crates/engine/src/lisp/drawing.rs | 2 +- crates/engine/src/lisp/startup.rs | 2 +- crates/engine/src/settings_dir.rs | 82 ++ crates/engine/tests/read_file_unicode.rs | 25 + crates/engine/tests/xref.rs | 2 +- crates/fonts/src/ttf.rs | 15 +- crates/io/src/lib.rs | 58 +- crates/io/src/tests.rs | 14 + crates/mcp/Cargo.toml | 1 + crates/mcp/src/args.rs | 51 + crates/mcp/src/lib.rs | 1 + crates/ui-egui/src/chrome.rs | 2 +- crates/ui-egui/src/docking.rs | 6 +- crates/ui-egui/src/gpu.rs | 26 +- crates/ui-egui/src/lib.rs | 39 +- crates/ui-egui/src/menus.rs | 16 +- crates/ui-egui/src/opening.rs | 26 +- crates/ui-egui/src/options.rs | 4 +- crates/ui-egui/src/switch.rs | 54 + crates/ui-egui/tests/bedit_dialog.rs | 4 +- crates/ui-egui/tests/it/system_cursor.rs | 20 + crates/ui-egui/tests/recent_files.rs | 8 +- docs/cli.md | 58 + docs/control-protocol.md | 2 +- docs/plotters.md | 3 +- lint/ast-grep/rule-tests/args-os-test.yml | 19 + .../rule-tests/clap-error-message-test.yml | 13 + .../clap-error-message-variable-test.yml | 47 + .../ast-grep/rule-tests/string-error-test.yml | 14 + lint/ast-grep/rules/args-os.yml | 21 + .../rules/clap-error-message-variable.yml | 35 + lint/ast-grep/rules/clap-error-message.yml | 26 + lint/ast-grep/rules/string-error.yml | 21 + lint/ast-grep/sgconfig.yml | 6 + packaging/linux/package.sh | 25 + 70 files changed, 4228 insertions(+), 1414 deletions(-) create mode 100644 .github/workflows/ast-grep.yml create mode 100644 apps/cadcraft-cli/examples/man-and-completions.rs create mode 100644 apps/cadcraft-cli/src/args.rs create mode 100644 apps/cadcraft-cli/src/commands.rs create mode 100644 apps/cadcraft-cli/src/convert.rs create mode 100644 apps/cadcraft-cli/src/error.rs create mode 100644 apps/cadcraft-cli/src/info.rs create mode 100644 apps/cadcraft-cli/src/lib.rs create mode 100644 apps/cadcraft-cli/src/mcp.rs create mode 100644 apps/cadcraft-cli/src/output.rs create mode 100644 apps/cadcraft-cli/src/perf.rs create mode 100644 apps/cadcraft-cli/src/run.rs create mode 100644 apps/cadcraft-cli/src/sample.rs create mode 100644 apps/cadcraft-cli/tests/it/usage.rs create mode 100644 apps/cadcraft-cli/tests/man_and_completions.rs create mode 100644 apps/cadcraft/src/env.rs create mode 100644 apps/cadcraft/src/launch_args.rs create mode 100644 crates/doc/src/format.rs create mode 100644 crates/engine/src/settings_dir.rs create mode 100644 crates/engine/tests/read_file_unicode.rs create mode 100644 crates/mcp/src/args.rs create mode 100644 crates/ui-egui/src/switch.rs create mode 100644 docs/cli.md create mode 100644 lint/ast-grep/rule-tests/args-os-test.yml create mode 100644 lint/ast-grep/rule-tests/clap-error-message-test.yml create mode 100644 lint/ast-grep/rule-tests/clap-error-message-variable-test.yml create mode 100644 lint/ast-grep/rule-tests/string-error-test.yml create mode 100644 lint/ast-grep/rules/args-os.yml create mode 100644 lint/ast-grep/rules/clap-error-message-variable.yml create mode 100644 lint/ast-grep/rules/clap-error-message.yml create mode 100644 lint/ast-grep/rules/string-error.yml create mode 100644 lint/ast-grep/sgconfig.yml diff --git a/.github/workflows/ast-grep.yml b/.github/workflows/ast-grep.yml new file mode 100644 index 000000000..aab570b63 --- /dev/null +++ b/.github/workflows/ast-grep.yml @@ -0,0 +1,26 @@ +# Structural rules for the command-line code (RFC-0012): lint/ast-grep's rule tests, then a scan. +# Seconds, no Rust build. +name: ast-grep + +on: + push: + branches: [main] + paths: ["lint/ast-grep/**", "apps/cadcraft-cli/src/**", "apps/cadcraft/src/launch_args.rs", "apps/cadcraft/src/main.rs", ".github/workflows/ast-grep.yml"] + pull_request: + paths: ["lint/ast-grep/**", "apps/cadcraft-cli/src/**", "apps/cadcraft/src/launch_args.rs", "apps/cadcraft/src/main.rs", ".github/workflows/ast-grep.yml"] + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: ast-grep-${{ github.ref }} + cancel-in-progress: true + +jobs: + scan: + # Tracked at @main like the other shared workflows. + uses: storytold/craft-common-actions/.github/workflows/ast-grep.yml@main + with: + config: lint/ast-grep/sgconfig.yml + paths: apps/cadcraft-cli/src apps/cadcraft/src/launch_args.rs apps/cadcraft/src/main.rs diff --git a/Cargo.lock b/Cargo.lock index 0633f38f3..ab48c95da 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -196,6 +196,56 @@ dependencies = [ "libc", ] +[[package]] +name = "anstream" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "is_terminal_polyfill", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000" + +[[package]] +name = "anstyle-parse" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "anstyle-wincon" +version = "3.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d" +dependencies = [ + "anstyle", + "once_cell_polyfill", + "windows-sys 0.61.2", +] + [[package]] name = "anyhow" version = "1.0.104" @@ -571,6 +621,7 @@ dependencies = [ "cadcraft-mcp", "cadcraft-ui-egui", "chrono", + "clap", "craft-ui", "craft-update", "craft-window", @@ -583,6 +634,7 @@ dependencies = [ "rfd", "serde_json", "sys-locale", + "thiserror 2.0.21", "windows", "winit", "winresource", @@ -597,7 +649,12 @@ dependencies = [ "cadcraft-io", "cadcraft-mcp", "cadcraft-render", + "clap", + "clap_complete", + "clap_mangen", + "same-file", "serde_json", + "thiserror 2.0.21", ] [[package]] @@ -710,6 +767,7 @@ dependencies = [ "cadcraft-engine", "cadcraft-io", "cadcraft-render", + "clap", "getrandom 0.4.3", "log", "serde_json", @@ -863,6 +921,65 @@ dependencies = [ "num-traits", ] +[[package]] +name = "clap" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa8876b300ab35ba921adea3dfd70157a46249b33f95c9084ae5709785478946" +dependencies = [ + "clap_builder", + "clap_derive", +] + +[[package]] +name = "clap_builder" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0797fb7aeb1406c84efac526901f7ec3ead2124f946b494e72879d4b54704d" +dependencies = [ + "anstream", + "anstyle", + "clap_lex", + "strsim", +] + +[[package]] +name = "clap_complete" +version = "4.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "037e2a1a92236d0aff7e845093f64661d6df4c02c9fcc61a60e9e1d736fa392f" +dependencies = [ + "clap", +] + +[[package]] +name = "clap_derive" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9c751b79415d4e559e3d1fcf128e09e720eb673a06d26cf6f392d37d75b66e0" +dependencies = [ + "heck", + "proc-macro2", + "quote", + "syn 3.0.9", +] + +[[package]] +name = "clap_lex" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c133bc6a41be0d194c306b5506d15e6feeea7b1d6604bd3f8310dfb2ca96486" + +[[package]] +name = "clap_mangen" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "211d617eaa4b735c96c9e0228fcbdb5120ef623f2b8cb67ffb84c3e02dbc28a4" +dependencies = [ + "clap", + "roff", +] + [[package]] name = "clipboard-win" version = "5.4.3" @@ -907,6 +1024,12 @@ version = "1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3d7b894f5411737b7867f4827955924d7c254fc9f4d91a6aad6b097804b1018b" +[[package]] +name = "colorchoice" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570" + [[package]] name = "colored" version = "2.2.0" @@ -2085,6 +2208,12 @@ dependencies = [ "stable_deref_trait", ] +[[package]] +name = "heck" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" + [[package]] name = "hermit-abi" version = "0.5.3" @@ -2387,6 +2516,12 @@ dependencies = [ "once_cell", ] +[[package]] +name = "is_terminal_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" + [[package]] name = "itertools" version = "0.15.0" @@ -3241,6 +3376,12 @@ version = "1.21.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" +[[package]] +name = "once_cell_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" + [[package]] name = "open" version = "5.4.5" @@ -3813,6 +3954,12 @@ dependencies = [ "windows-sys 0.52.0", ] +[[package]] +name = "roff" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "323c417e1d9665a65b263ec744ba09030cfb277e9daa0b018a4ab62e57bc8189" + [[package]] name = "ron" version = "0.12.2" @@ -4328,6 +4475,12 @@ dependencies = [ "unicode-properties", ] +[[package]] +name = "strsim" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" + [[package]] name = "subsetter" version = "0.2.6" @@ -4801,6 +4954,12 @@ version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" +[[package]] +name = "utf8parse" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" + [[package]] name = "uuid" version = "1.29.0" diff --git a/Cargo.toml b/Cargo.toml index 3265938f5..2b38a218f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -29,9 +29,13 @@ craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-l # PDF writing (krilla) for plots, and reading them back in tests. The root patches below pin # craft-pdf's patched backends to the same revision (Cargo ignores dependency-local patches). craft-pdf = { version = "=0.1.0", git = "https://github.com/storytold/craft-libs", rev = "92d392cff132eaf53e13afff77f38b5c11b73aa0", default-features = false } +clap = { version = "4", features = ["derive", "env"] } +clap_complete = "4.6.11" +clap_mangen = { version = "0.3.3", features = ["env"] } # foundation thiserror = "2" +same-file = "1" serde = { version = "1", features = ["derive", "rc"] } serde_json = { version = "1", features = ["float_roundtrip"] } log = "0.4" diff --git a/README.md b/README.md index 142ebb1af..c45b619dc 100644 --- a/README.md +++ b/README.md @@ -196,7 +196,7 @@ crashed survives the next start. The file stops growing at 16 MiB. `--version` w | Variable | Effect | |---|---| -| `CADCRAFT_CONFIG_DIR` | Use this directory instead of the platform settings directory (the log goes to its `logs/`) | +| `CADCRAFT_CONFIG_DIR` | Use this directory instead of the platform settings directory (the log goes to its `logs/`); empty means no settings folder (no log file, autosave, workspace or plotters) | | `RUST_LOG` | Log levels for standard error and the log file. Default: `info` for CADCraft's own crates, `warn` for everything else. env_logger-style directives replace that, e.g. `RUST_LOG=debug`, `RUST_LOG=warn,cadcraft_io=trace` or `RUST_LOG=info,wgpu_core=warn`; a directive ending in `*` covers every target starting with it (`cadcraft*=debug`). `cadcraft_engine=debug` also logs every command-line message. | The logger is `apps/cadcraft/src/logging.rs`; the web build logs to the browser console instead. @@ -238,6 +238,9 @@ MCP tools include `command_line` (type at the prompt), `execute` (any command wi To run LISP routines, scripts and alias files, or to drive CADCraft from your own programs, see [docs/customization.md](docs/customization.md). +`cadcraft-cli --help` documents every subcommand and flag; exit codes, streams, environment +variables and its RFC-0012 conventions are in [docs/cli.md](docs/cli.md). + ## Architecture ```text diff --git a/apps/cadcraft-cli/Cargo.toml b/apps/cadcraft-cli/Cargo.toml index b852183f4..cac076c17 100644 --- a/apps/cadcraft-cli/Cargo.toml +++ b/apps/cadcraft-cli/Cargo.toml @@ -6,6 +6,14 @@ edition.workspace = true license.workspace = true publish = false +[lib] +name = "cadcraft_cli" +path = "src/lib.rs" + +[[bin]] +name = "cadcraft-cli" +path = "src/main.rs" + [lints] workspace = true @@ -14,4 +22,13 @@ cadcraft-engine = { workspace = true } cadcraft-io = { workspace = true } cadcraft-mcp = { workspace = true } cadcraft-render = { workspace = true } +clap = { workspace = true } +same-file = { workspace = true } serde_json = { workspace = true } +thiserror = { workspace = true } + +[dev-dependencies] +# Shell completions and man pages (examples/man-and-completions.rs, for the Linux packages); not +# in the binary. +clap_complete = { workspace = true } +clap_mangen = { workspace = true } diff --git a/apps/cadcraft-cli/examples/man-and-completions.rs b/apps/cadcraft-cli/examples/man-and-completions.rs new file mode 100644 index 000000000..ddcfbf062 --- /dev/null +++ b/apps/cadcraft-cli/examples/man-and-completions.rs @@ -0,0 +1,41 @@ +//! Writes cadcraft-cli's shell completions ([`clap_complete`]: bash, zsh, fish, elvish, +//! PowerShell) and man pages ([`clap_mangen`]: `cadcraft-cli.1` and one per subcommand, such as +//! `cadcraft-cli-convert.1`) into a directory. The Linux packages ship them +//! (`packaging/linux/package.sh`): +//! +//! ```sh +//! cargo run -p cadcraft-cli --example man-and-completions -- +//! ``` + +use std::path::Path; +use std::process::ExitCode; + +use clap::ValueEnum; +use clap_complete::Shell; + +fn main() -> ExitCode { + let mut args = std::env::args_os().skip(1); + let (Some(dir), None) = (args.next(), args.next()) else { + eprintln!("usage: man-and-completions "); + return ExitCode::from(2); + }; + let dir = Path::new(&dir); + match generate(dir) { + Ok(()) => ExitCode::SUCCESS, + Err(e) => { + eprintln!("error: {}: {e}", dir.display()); + ExitCode::FAILURE + } + } +} + +pub(crate) fn generate(dir: &Path) -> std::io::Result<()> { + std::fs::create_dir_all(dir)?; + let mut cmd = cadcraft_cli::command(); + for &shell in Shell::value_variants() { + clap_complete::generate_to(shell, &mut cmd, "cadcraft-cli", dir)?; + } + // A fresh command: `clap_complete::generate_to` built `cmd`, adding the `help` subcommand, + // which `clap_mangen` would otherwise give pages of its own (`cadcraft-cli-help-convert.1`). + clap_mangen::generate_to(cadcraft_cli::command(), dir) +} diff --git a/apps/cadcraft-cli/src/args.rs b/apps/cadcraft-cli/src/args.rs new file mode 100644 index 000000000..16b57eeb7 --- /dev/null +++ b/apps/cadcraft-cli/src/args.rs @@ -0,0 +1,786 @@ +//! The command line, as clap types. Values are parsed into their types here and the relations +//! between flags are checked, so a bad value or combination is a usage error (exit 2) naming the +//! flag, before any work starts; the handlers receive typed values only. A flag a subcommand +//! doesn't take is a usage error too, so a typo can't be silently ignored. A value flag never takes +//! the next flag as its value: a value starting with `-` is written `--save=-out.dxf` (or +//! `./-out.dxf`). + +use std::ffi::{OsStr, OsString}; +use std::path::{Path, PathBuf}; + +use cadcraft_engine::geom::{Bounds2, Vec2}; +use cadcraft_io::Format; +use cadcraft_mcp::args::{blank_env_is_unset, name_env_vars}; +use clap::builder::{OsStringValueParser, PathBufValueParser, TypedValueParser}; +use clap::error::ErrorKind; +use clap::parser::ValueSource; +use clap::{ArgAction, ArgGroup, ArgMatches, Args, CommandFactory, FromArgMatches, Parser, Subcommand, ValueEnum}; +use serde_json::Value; + +/// Help text that names the formats of `list`, built once from [`Format::READ`] or [`Format::WRITE`] +/// so it can't drift from what the code accepts. +fn with_formats(cell: &'static std::sync::OnceLock, before: &str, list: &[Format], after: &str) -> &'static str { + cell.get_or_init(|| format!("{before}({}){after}", Format::list(list))) +} + +/// The drawing an input argument names. +fn read_help() -> &'static str { + static C: std::sync::OnceLock = std::sync::OnceLock::new(); + with_formats(&C, "The drawing to read ", Format::READ, "") +} + +fn open_help() -> &'static str { + static C: std::sync::OnceLock = std::sync::OnceLock::new(); + with_formats(&C, "Drawings to open ", Format::READ, "") +} + +fn write_help() -> &'static str { + static C: std::sync::OnceLock = std::sync::OnceLock::new(); + with_formats(&C, "The file to write; its extension picks the format ", Format::WRITE, "") +} + +fn save_help() -> &'static str { + static C: std::sync::OnceLock = std::sync::OnceLock::new(); + with_formats(&C, "Save the drawing to this file; its extension picks the format ", Format::WRITE, "") +} + +fn export_help() -> &'static str { + static C: std::sync::OnceLock = std::sync::OnceLock::new(); + with_formats(&C, "Export the drawing to this file; its extension picks the format ", Format::WRITE, "") +} + +fn convert_about() -> &'static str { + static C: std::sync::OnceLock = std::sync::OnceLock::new(); + with_formats(&C, "Convert a drawing; OUT's extension picks the format ", Format::WRITE, "") +} + +fn convert_long_about() -> &'static str { + static C: std::sync::OnceLock = std::sync::OnceLock::new(); + C.get_or_init(|| { + format!( + "{}\n\nImage output (png 2400x1600, svg, pdf) shows model space, fitted to the drawing extents unless\n--window or --view says otherwise.", + convert_about() + ) + }) +} + +/// cadcraft-cli: headless CADCraft +#[derive(Parser)] +#[command(name = "cadcraft-cli", version = cadcraft_engine::build_version(), arg_required_else_help = true)] +pub(crate) struct Cli { + #[command(subcommand)] + pub(crate) command: Command, +} + +#[derive(Subcommand)] +pub(crate) enum Command { + Info(InfoArgs), + Convert(ConvertArgs), + Run(RunArgs), + Commands(CommandsArgs), + Mcp(McpArgs), + Perf(PerfArgs), + Sample(SampleArgs), +} + +/// Print a drawing's summary as JSON +#[derive(Args)] +pub(crate) struct InfoArgs { + #[arg(help = read_help())] + pub(crate) file: PathBuf, + /// One line of JSON instead of pretty-printed + #[arg(long)] + pub(crate) compact: bool, +} + +/// Convert a drawing; OUT's extension picks the format +#[derive(Args)] +#[command(about = convert_about(), long_about = convert_long_about())] +pub(crate) struct ConvertArgs { + #[arg(value_name = "IN", help = read_help())] + pub(crate) input: PathBuf, + #[arg(value_name = "OUT", help = write_help())] + pub(crate) output: PathBuf, + #[command(flatten)] + pub(crate) framing: FramingArgs, + /// Allow an output that is an input file, replacing the original + #[arg(long)] + pub(crate) in_place: bool, + #[command(flatten)] + pub(crate) settings: Settings, +} + +/// The settings the desktop app reads from its environment, for the subcommands that draw or run +/// commands. A variable is the flag's fallback; an empty one counts as unset, except +/// `CADCRAFT_CONFIG_DIR`. +#[derive(Args)] +#[command(next_help_heading = "Settings")] +pub(crate) struct Settings { + /// The settings folder; plotter configurations are in its `plotters` folder (default: the + /// platform's settings folder). An empty value means no settings folder + // Not RFC-0012 rule 1.7's "an empty variable counts as unset": an empty value is the + // documented way to run with no settings folder (isolated runs, tests), and it predates the + // CLI port. Keep it out of any blanket treatment of empty variables. + #[arg(long, value_name = "DIR", env = "CADCRAFT_CONFIG_DIR", value_parser = OsStringValueParser::new().map(PathBuf::from))] + pub(crate) config_dir: Option, + /// The font that replaces a missing one (FONTALT) + #[arg(long, value_name = "FONT", env = "CADCRAFT_FONTALT")] + pub(crate) fontalt: Option, + /// The fonts tried, in order, for characters a font lacks, comma-separated (FONTFALLBACK) + #[arg(long, value_name = "FONTS", env = "CADCRAFT_FONTFALLBACK")] + pub(crate) fontfallback: Option, +} + +impl Settings { + /// Install the settings for this run; an unset one is the default. An empty or blank + /// `--config-dir` is no settings folder. + pub(crate) fn apply(&self) { + cadcraft_engine::settings_dir::set(self.settings_dir()); + cadcraft_engine::fonts::ttf::set_font_alt(self.fontalt.as_deref().unwrap_or("")); + cadcraft_engine::fonts::ttf::set_fallback_fonts(self.fontfallback.as_deref().unwrap_or("")); + } + + /// The settings folder: `--config-dir`, else the platform's; `None` when the flag is empty or + /// blank. + fn settings_dir(&self) -> Option { + match &self.config_dir { + Some(dir) if dir.to_str().is_some_and(|d| d.trim().is_empty()) => None, + Some(dir) => Some(dir.clone()), + None => cadcraft_engine::settings_dir::platform(|k| std::env::var_os(k)), + } + } +} + +// What part of model space an image shows: shared by `convert` and `run`. +#[derive(Args)] +pub(crate) struct FramingArgs { + /// Show this rectangle (drawing units, x0, + /// What part of model space the image shows (case-insensitive) + #[arg(long, value_name = "extents|current", value_enum, ignore_case = true)] + pub(crate) view: Option, +} + +/// `--view`. +#[derive(Clone, Copy, Debug, PartialEq, ValueEnum)] +pub(crate) enum ViewMode { + /// Always fit the drawing extents + Extents, + /// The current view, as last set by zoom, pan or view.set (a freshly opened drawing's view is + /// its extents plus a 10% margin) + Current, +} + +/// Open drawings (or start a new one), run scripts and commands in order, save or export the result +/// +/// Drawings open in the order given, and the last one is current; without any, a new imperial +/// drawing is used. --script, --script-file and --cmd steps run in the order given, and each +/// --cmd prints its JSON result on one line (JSON lines); a command with no result prints nothing. +/// An image --export (png 2400x1600, svg, pdf) shows model space: +/// the current view if the steps changed it (zoom, pan, view.set…), otherwise the drawing +/// extents, unless --window or --view says otherwise. +#[derive(Args)] +#[command(group(ArgGroup::new("framing").args(["window", "view"]).multiple(true).requires("export")))] +#[command(after_long_help = r#"--cmd chaining: + A --cmd parameter value of exactly "{last}" is replaced with the last object handle an + earlier --cmd in the same run returned, so a command can act on what the previous one made: + --cmd 'mview {"p1":[20,20],"p2":[200,150]}' prints {"viewports":["100"]} + --cmd 'viewport.set {"handle":"{last}","scale":1}' changes viewport 100 + It works in any parameter, at any depth (e.g. "handles":["{last}"]); every other string is + passed unchanged. With no earlier returned handle the run fails and says so."#)] +pub(crate) struct RunArgs { + #[arg(value_name = "FILE", help = open_help())] + pub(crate) files: Vec, + /// Open the built-in sample drawing + #[arg(long)] + pub(crate) sample: bool, + /// Start a new metric drawing + #[arg(long)] + pub(crate) metric: bool, + /// Command-line script text to run (`\n` separates lines) + #[arg(long, value_name = "TEXT", action = ArgAction::Append)] + pub(crate) script: Vec, + /// A script file (.scr) to run + #[arg(long, value_name = "F.scr", action = ArgAction::Append)] + pub(crate) script_file: Vec, + /// An engine command and its JSON parameters (default {}); see "--cmd chaining" in --help + #[arg(long, value_name = "id {json}", action = ArgAction::Append, value_parser = cmd_step)] + pub(crate) cmd: Vec, + #[arg(long, value_name = "OUT.dxf", help = save_help())] + pub(crate) save: Option, + #[arg(long, value_name = "OUT.png", help = export_help())] + pub(crate) export: Option, + #[command(flatten)] + pub(crate) framing: FramingArgs, + /// Allow an output that is an input file, replacing the original + #[arg(long)] + pub(crate) in_place: bool, + #[command(flatten)] + pub(crate) settings: Settings, + /// The drawings, in command-line order, set by [`parse`]. + #[arg(skip)] + pub(crate) drawings: Vec, + /// The steps, in command-line order, set by [`parse`]. + #[arg(skip)] + pub(crate) steps: Vec, +} + +/// A drawing `run` opens. +#[derive(Clone, Debug, PartialEq)] +pub(crate) enum Drawing { + File(PathBuf), + Sample, + Metric, +} + +/// A `--script`, `--script-file` or `--cmd` of `run`. +#[derive(Clone, Debug, PartialEq)] +pub(crate) enum Step { + Script(String), + ScriptFile(PathBuf), + Cmd(CmdStep), +} + +/// `--cmd 'id {json}'`: an engine command and its parameters. `{last}` placeholders are filled in +/// when it runs. +#[derive(Clone, Debug, PartialEq)] +pub(crate) struct CmdStep { + pub(crate) id: String, + pub(crate) params: Value, +} + +/// Print the command catalog as JSON +#[derive(Args)] +pub(crate) struct CommandsArgs { + /// Only the commands whose id or label contains this text (case-insensitive) + pub(crate) filter: Option, + /// One line of JSON instead of pretty-printed + #[arg(long)] + pub(crate) compact: bool, +} + +/// Run the MCP server on stdio: a headless drawing session, or a bridge to the running app +#[derive(Args)] +pub(crate) struct McpArgs { + /// Bridge to the app's control channel (its --control port, e.g. 127.0.0.1:7979) + #[arg(long, value_name = "HOST:PORT", value_parser = connect_addr)] + pub(crate) connect: Option, + /// Reach the app at the first call instead of at startup, so the server can start before the + /// app is open + #[arg(long, requires = "connect")] + pub(crate) lazy: bool, + /// Like --lazy, and a call that finds nothing at HOST:PORT opens the app with that control + /// port first (macOS) + #[arg(long, requires = "connect")] + pub(crate) launch: bool, + #[command(flatten)] + pub(crate) settings: Settings, +} + +/// Time the engine on a synthetic N-entity drawing (default 200000), or the canvas display-list +/// build of a drawing, zoomed in step by step +#[derive(Args)] +pub(crate) struct PerfArgs { + /// An entity count (clamped to 1-20000000), or a drawing to time + #[arg(value_name = "N|FILE", value_parser = PathBufValueParser::new().map(perf_target))] + pub(crate) target: Option, +} + +/// What `perf` times. +#[derive(Clone, Debug, PartialEq)] +pub(crate) enum PerfTarget { + /// A synthetic drawing with this many entities, within [`MAX_PERF_COUNT`]. + Count(usize), + File(PathBuf), +} + +/// The largest synthetic drawing `perf` builds. +const MAX_PERF_COUNT: usize = 20_000_000; + +/// `perf N|FILE`: a value that reads as a count is one, clamped to 1..=[`MAX_PERF_COUNT`] so `perf +/// 0` still times something; anything else is a drawing. +fn perf_target(p: PathBuf) -> PerfTarget { + match p.to_str().and_then(|t| t.parse::().ok()) { + Some(n) => PerfTarget::Count(n.clamp(1, MAX_PERF_COUNT)), + None => PerfTarget::File(p), + } +} + +/// Write a built-in sample drawing +#[derive(Args)] +pub(crate) struct SampleArgs { + /// Which sample + #[arg(value_name = "bracket|floorplan", value_enum)] + pub(crate) name: SampleName, + #[arg(value_name = "OUT", help = write_help())] + pub(crate) output: PathBuf, + #[command(flatten)] + pub(crate) settings: Settings, +} + +/// `sample`'s drawings. +#[derive(Clone, Copy, Debug, PartialEq, ValueEnum)] +pub(crate) enum SampleName { + Bracket, + #[value(alias = "floor")] + Floorplan, +} + +/// What part of model space an image export shows. +#[derive(Clone, Copy, Debug, PartialEq)] +pub(crate) enum Framing { + /// `run`: the current view if the commands changed it, else the extents. `convert`: extents. + Auto, + Extents, + Current, + Window(Bounds2), +} + +/// Why a `--window` value is refused: clap prints it after the flag and its value (exit 2). +#[derive(Debug, thiserror::Error)] +pub(crate) enum WindowError { + #[error("expected four numbers x0,y0,x1,y1")] + NeedsFour, + #[error("{name} must be a finite number, got `{value}`")] + NotFinite { name: &'static str, value: String }, + #[error("need x0 < x1 and y0 < y1 (lower-left corner first)")] + Order, + #[error(transparent)] + Limits(#[from] cadcraft_io::IoError), +} + +/// Why a value is refused: clap prints it after the flag and its value (exit 2). +#[derive(Debug, thiserror::Error)] +pub(crate) enum ValueError { + #[error("expected HOST:PORT (the app's --control port, e.g. 127.0.0.1:7979)")] + Connect, + #[error("expected a command id, then optionally its JSON parameters")] + CmdId, + #[error(transparent)] + CmdJson(#[from] serde_json::Error), +} + +/// Why `parse` refuses flags clap accepted: clap prints it as a usage error (exit 2). +#[derive(Debug, thiserror::Error)] +enum UsageError { + /// The framing flags choose what an image shows; a drawing file has nothing to frame. + #[error("{flag} only applies to image output (png, svg, pdf), not `{}`", .out.display())] + FramingNeedsImage { flag: &'static str, out: PathBuf }, + /// The output is one of the input files, so writing it would replace the original. + #[error("{} is an input file, so the result would replace the original: choose another output, or pass --in-place to overwrite it", .0.display())] + OutIsInput(PathBuf), +} + +impl UsageError { + fn into_clap(self, cmd: &mut clap::Command) -> clap::Error { + let kind = match self { + Self::FramingNeedsImage { .. } | Self::OutIsInput(_) => ErrorKind::ArgumentConflict, + }; + cmd.error(kind, self) + } +} + +/// Parse `--window x0,y0,x1,y1` (min corner first). Hostile values are errors, never panics. +pub(crate) fn parse_window(text: &str) -> Result { + let parts: Vec<&str> = text.split(',').map(str::trim).collect(); + let [x0, y0, x1, y1] = parts.as_slice() else { + return Err(WindowError::NeedsFour); + }; + let num = |name: &'static str, v: &str| -> Result { + match v.parse::() { + Ok(n) if n.is_finite() => Ok(n), + _ => Err(WindowError::NotFinite { name, value: v.to_string() }), + } + }; + let (x0, y0, x1, y1) = (num("x0", x0)?, num("y0", y0)?, num("x1", x1)?, num("y1", y1)?); + if !(x0 < x1 && y0 < y1) { + return Err(WindowError::Order); + } + let w = Bounds2 { min: Vec2::new(x0, y0), max: Vec2::new(x1, y1) }; + cadcraft_io::check_window(&w)?; + Ok(w) +} + +/// `run --cmd 'id {json}'`: the id up to the first space, then JSON parameters (default `{}`). +/// Whether they suit the command is the command's to say. +fn cmd_step(s: &str) -> Result { + let (id, json) = s.split_once(' ').unwrap_or((s, "{}")); + if id.is_empty() { + return Err(ValueError::CmdId); + } + Ok(CmdStep { id: id.to_string(), params: serde_json::from_str(json)? }) +} + +impl FramingArgs { + /// The framing `--window` or `--view` asks for (clap refuses both together). + pub(crate) fn framing(&self) -> Framing { + match (self.window, self.view) { + (Some(w), _) => Framing::Window(w), + (None, Some(ViewMode::Extents)) => Framing::Extents, + (None, Some(ViewMode::Current)) => Framing::Current, + (None, None) => Framing::Auto, + } + } + + /// The framing flag given, if any. + fn flag(&self) -> Option<&'static str> { + if self.window.is_some() { + Some("--window") + } else if self.view.is_some() { + Some("--view") + } else { + None + } + } +} + +/// A framing flag given with an output that isn't an image (the extension decides). `run` without +/// `--export` is clap's `requires` error. +fn framing_error(cli: &Cli) -> Option { + let (framing, out): (&FramingArgs, Option<&Path>) = match &cli.command { + Command::Convert(c) => (&c.framing, Some(&c.output)), + Command::Run(r) => (&r.framing, r.export.as_deref()), + _ => return None, + }; + let (flag, out) = (framing.flag()?, out?); + (!cadcraft_io::is_image(out)).then(|| UsageError::FramingNeedsImage { flag, out: out.to_path_buf() }) +} + +/// An output that is the same file as an input, without `--in-place`. An output that doesn't exist +/// can't be an input, and an I/O error in the comparison is left to the open or write that follows. +fn out_is_input(cli: &Cli) -> Option { + let same = |input: &Path, out: &Path| out.exists() && same_file::is_same_file(input, out).unwrap_or(false); + match &cli.command { + Command::Convert(c) if !c.in_place && same(&c.input, &c.output) => Some(UsageError::OutIsInput(c.output.clone())), + Command::Run(r) if !r.in_place => { + let inputs = r.drawings.iter().filter_map(|d| if let Drawing::File(f) = d { Some(f) } else { None }); + let inputs: Vec<&PathBuf> = inputs.collect(); + [&r.save, &r.export].into_iter().flatten().find(|out| inputs.iter().any(|i| same(i, out))).map(|out| UsageError::OutIsInput(out.clone())) + } + _ => None, + } +} + +/// The backend `cadcraft-cli mcp` serves from. +#[derive(Debug, PartialEq, Eq)] +pub(crate) enum McpTarget { + /// An in-process drawing session (no `--connect`). + Headless, + /// The running app's control channel at `HOST:PORT`; `lazy`: reached at the first call; + /// `launch`: opened then if it isn't running. + Connect { addr: String, lazy: bool, launch: bool }, +} + +impl McpArgs { + pub(crate) fn target(&self) -> McpTarget { + match &self.connect { + // `--launch` connects at the first call too (the app opens then). + Some(addr) => McpTarget::Connect { addr: addr.clone(), lazy: self.lazy || self.launch, launch: self.launch }, + None => McpTarget::Headless, + } + } +} + +/// `mcp --connect`: an empty, flag-like or port-less address is an error, never a silent fall back +/// to a headless session (#103). The host is not resolved here. +fn connect_addr(s: &str) -> Result { + let s = s.trim(); + let valid = !s.starts_with('-') + && s.rsplit_once(':').is_some_and(|(host, port)| { + let host = host.strip_prefix('[').and_then(|h| h.strip_suffix(']')).unwrap_or(host); + !host.is_empty() && port.parse::().is_ok() + }); + if valid { Ok(s.to_string()) } else { Err(ValueError::Connect) } +} + +/// The values of `id` with their command-line indices. +fn indexed<'a, T: Clone + Send + Sync + 'static>(m: &'a ArgMatches, id: &str) -> impl Iterator { + let at = m.indices_of(id).into_iter().flatten(); + let values = m.try_get_many::(id).ok().flatten().into_iter().flatten(); + at.zip(values) +} + +/// The command-line index of flag `id`, when it was given. +fn flag_index(m: &ArgMatches, id: &str) -> Option { + if m.value_source(id) == Some(ValueSource::CommandLine) { m.indices_of(id).and_then(Iterator::last) } else { None } +} + +/// `run`'s drawings and steps back in command-line order: clap keeps each flag's values apart, +/// their indices say how they interleave. +fn run_order(m: &ArgMatches) -> (Vec, Vec) { + let mut drawings: Vec<(usize, Drawing)> = indexed(m, "files").map(|(i, f): (_, &PathBuf)| (i, Drawing::File(f.clone()))).collect(); + drawings.extend(flag_index(m, "sample").map(|i| (i, Drawing::Sample))); + drawings.extend(flag_index(m, "metric").map(|i| (i, Drawing::Metric))); + drawings.sort_by_key(|d| d.0); + let mut steps: Vec<(usize, Step)> = indexed(m, "script").map(|(i, s): (_, &String)| (i, Step::Script(s.clone()))).collect(); + steps.extend(indexed(m, "script_file").map(|(i, s): (_, &PathBuf)| (i, Step::ScriptFile(s.clone())))); + steps.extend(indexed(m, "cmd").map(|(i, c): (_, &CmdStep)| (i, Step::Cmd(c.clone())))); + steps.sort_by_key(|s| s.0); + (drawings.into_iter().map(|d| d.1).collect(), steps.into_iter().map(|s| s.1).collect()) +} + +/// Parse the arguments (without the binary name). clap reads them as `OsString`s: a path need not +/// be valid Unicode, text must. A bare `--help` or `-h` is help even after a mistake on the same +/// line (`run --script --help`): clap reports the mistake first. +pub(crate) fn parse(args: &[OsString]) -> Result { + parse_with(command(|k| std::env::var_os(k)), args) +} + +/// The command line. An empty or blank variable counts as unset, except `CADCRAFT_CONFIG_DIR`: +/// empty means no settings folder. `var` looks a variable up. +fn command(var: impl Fn(&OsStr) -> Option + Copy) -> clap::Command { + let blank = move |a: clap::Arg| if a.get_id() == "config_dir" { a } else { blank_env_is_unset(a, var) }; + Cli::command().mut_args(blank).mut_subcommands(|s| s.mut_args(blank)) +} + +/// [`parse`] with `cmd` from [`command`]; a bad value from a variable is a usage error naming the +/// variable. +fn parse_with(mut cmd: clap::Command, args: &[OsString]) -> Result { + let argv = std::iter::once(OsString::from("cadcraft-cli")).chain(args.iter().cloned()); + let matches = match cmd.try_get_matches_from_mut(argv) { + // `use_stderr`: a real error, not the help `-h` asked for (a retry would make it `--help`). + Err(e) if e.use_stderr() && args.iter().take_while(|a| *a != "--").any(|a| *a == "--help" || *a == "-h") => { + let help = [OsString::from("cadcraft-cli"), args.first().cloned().unwrap_or_default(), OsString::from("--help")]; + return Err(cmd.try_get_matches_from_mut(help).err().unwrap_or(e)); + } + matches => matches.map_err(|e| name_env_vars(e, &cmd, args))?, + }; + let mut cli = Cli::from_arg_matches(&matches)?; + if let (Command::Run(r), Some((_, m))) = (&mut cli.command, matches.subcommand()) { + (r.drawings, r.steps) = run_order(m); + } + if let Some(e) = framing_error(&cli).or_else(|| out_is_input(&cli)) { + if let Some(sub) = matches.subcommand_name().and_then(|n| cmd.find_subcommand_mut(n)) { + return Err(e.into_clap(sub)); + } + return Err(e.into_clap(&mut cmd)); + } + Ok(cli) +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::json; + + fn parse_args(a: &[&str]) -> Result { + parse(&a.iter().map(OsString::from).collect::>()) + } + + fn mcp(a: &[&str]) -> Result { + let args: Vec<&str> = std::iter::once("mcp").chain(a.iter().copied()).collect(); + match parse_args(&args)?.command { + Command::Mcp(m) => Ok(m.target()), + _ => panic!("{a:?} is not mcp"), + } + } + + /// Every file argument's help names each format of the list it uses. + #[test] + fn help_names_every_format() { + let cli = Cli::command(); + let help = |sub: &str, arg: &str| { + let a = cli.find_subcommand(sub).and_then(|c| c.get_arguments().find(|a| a.get_id() == arg)).expect("argument exists"); + a.get_help().map(|h| h.to_string()).unwrap_or_default() + }; + let cases: [(&str, &str, &[Format]); 8] = [ + ("info", "file", Format::READ), + ("convert", "input", Format::READ), + ("convert", "output", Format::WRITE), + ("run", "files", Format::READ), + ("run", "save", Format::WRITE), + ("run", "export", Format::WRITE), + ("sample", "output", Format::WRITE), + ("convert", "", Format::WRITE), + ]; + for (sub, arg, list) in cases { + let text = if arg.is_empty() { + cli.find_subcommand(sub).and_then(|c| c.get_about()).map(|a| a.to_string()).unwrap_or_default() + } else { + help(sub, arg) + }; + for f in list { + assert!(text.contains(f.extension()), "`{sub} {arg}` help `{text}` lacks {}", f.extension()); + } + } + } + + #[test] + fn mcp_without_connect_is_headless() { + assert_eq!(mcp(&[]).unwrap(), McpTarget::Headless); + } + + #[test] + fn mcp_connect_with_address_selects_remote() { + let to = |addr: &str, lazy, launch| McpTarget::Connect { addr: addr.into(), lazy, launch }; + assert_eq!(mcp(&["--connect", "127.0.0.1:7979"]).unwrap(), to("127.0.0.1:7979", false, false)); + assert_eq!(mcp(&["--connect", " localhost:7979 "]).unwrap(), to("localhost:7979", false, false)); + assert_eq!(mcp(&["--lazy", "--connect", "localhost:7979"]).unwrap(), to("localhost:7979", true, false)); + assert_eq!(mcp(&["--connect", "localhost:7979", "--launch"]).unwrap(), to("localhost:7979", true, true)); + assert_eq!(mcp(&["--connect", "[::1]:7979"]).unwrap(), to("[::1]:7979", false, false)); + // Without an app to reach they mean nothing: never a headless session. + for flag in ["--lazy", "--launch"] { + assert_eq!(mcp(&[flag]).unwrap_err().kind(), clap::error::ErrorKind::MissingRequiredArgument, "{flag}"); + } + } + + #[test] + fn mcp_connect_without_address_is_an_error_not_headless() { + for bad in [ + &["--connect"][..], + &["--connect", ""], + &["--connect", " "], + &["--connect=-v"], + &["--connect", "example.com"], + &["--connect", ":7979"], + &["--connect", "host:99999"], + &["--connect", "[]:1"], + ] { + let r = mcp(bad); + let Err(e) = r else { panic!("{bad:?} should be rejected, got {r:?}") }; + assert_eq!(e.exit_code(), 2, "{bad:?}"); + assert!(e.to_string().contains("--connect "), "{bad:?}: {e}"); + } + } + + #[test] + fn mcp_rejects_unknown_and_repeated_arguments() { + assert!(mcp(&["--conect", "127.0.0.1:7979"]).is_err()); + assert!(mcp(&["127.0.0.1:7979"]).is_err()); + // clap names the unknown flag, not the value it left missing. + for flag in ["--foo", "-v"] { + assert_eq!(mcp(&["--connect", flag]).unwrap_err().kind(), clap::error::ErrorKind::UnknownArgument, "{flag}"); + } + assert!(mcp(&["--connect", "127.0.0.1:1", "--connect", "127.0.0.1:2"]).is_err()); + } + + #[test] + fn run_keeps_command_line_order() { + let args = + ["run", "a.dxf", "--script", "S1", "--metric", "--cmd", "c1", "b.dxf", "--script-file", "f.scr", "--sample", "--cmd", "c2 {\"n\":1}"]; + let Command::Run(r) = parse_args(&args).unwrap().command else { panic!("not run") }; + let file = |f: &str| Drawing::File(f.into()); + let cmd = |id: &str, params| Step::Cmd(CmdStep { id: id.into(), params }); + assert_eq!(r.drawings, [file("a.dxf"), Drawing::Metric, file("b.dxf"), Drawing::Sample]); + assert_eq!(r.steps, [Step::Script("S1".into()), cmd("c1", json!({})), Step::ScriptFile("f.scr".into()), cmd("c2", json!({"n": 1}))]); + } + + #[test] + fn cmd_values() { + assert_eq!(cmd_step("line").unwrap(), CmdStep { id: "line".into(), params: json!({}) }); + assert_eq!(cmd_step("line [1]").unwrap(), CmdStep { id: "line".into(), params: json!([1]) }); + for bad in ["", " {}", "line {bad json", "line "] { + assert!(cmd_step(bad).is_err(), "`{bad}` should be rejected"); + } + } + + #[test] + fn perf_targets() { + let target = |a: &[&str]| -> Option { + let args: Vec<&str> = std::iter::once("perf").chain(a.iter().copied()).collect(); + let Command::Perf(p) = parse_args(&args).unwrap().command else { panic!("not perf") }; + p.target + }; + assert_eq!(target(&[]), None); + assert_eq!(target(&["5"]), Some(PerfTarget::Count(5))); + assert_eq!(target(&["0"]), Some(PerfTarget::Count(1))); + assert_eq!(target(&["999999999"]), Some(PerfTarget::Count(MAX_PERF_COUNT))); + assert_eq!(target(&["a.dxf"]), Some(PerfTarget::File("a.dxf".into()))); + assert_eq!(target(&["1e3"]), Some(PerfTarget::File("1e3".into()))); + } + + #[test] + fn framing_options() { + let framing = |out: &str, a: &[&str]| -> Result { + let args: Vec<&str> = ["convert", "a.dxf", out].iter().chain(a).copied().collect(); + let Command::Convert(c) = parse_args(&args)?.command else { panic!("not convert") }; + Ok(c.framing.framing()) + }; + let b = |x0, y0, x1, y1| Bounds2::new(Vec2::new(x0, y0), Vec2::new(x1, y1)); + assert_eq!(framing("b.png", &[]).unwrap(), Framing::Auto); + assert_eq!(framing("b.png", &["--view", "extents"]).unwrap(), Framing::Extents); + assert_eq!(framing("b.png", &["--view", "CURRENT"]).unwrap(), Framing::Current); + assert_eq!(framing("b.png", &["--window", "0,0,2,1"]).unwrap(), Framing::Window(b(0.0, 0.0, 2.0, 1.0))); + assert_eq!(framing("b.dxf", &[]).unwrap(), Framing::Auto); + let kind = |out: &str, a: &[&str]| framing(out, a).map(|_| ()).unwrap_err().kind(); + assert_eq!(kind("b.png", &["--view", "selection"]), ErrorKind::InvalidValue); + assert_eq!(kind("b.png", &["--window", "0,0,2,1", "--view", "extents"]), ErrorKind::ArgumentConflict); + assert_eq!(kind("b.dxf", &["--view", "extents"]), ErrorKind::ArgumentConflict); + assert_eq!(kind("b.dxf", &["--window", "0,0,2,1"]), ErrorKind::ArgumentConflict); + } + + #[test] + fn window_parses() { + let b = |x0, y0, x1, y1| Bounds2::new(Vec2::new(x0, y0), Vec2::new(x1, y1)); + assert_eq!(parse_window("0,0,30,20").unwrap(), b(0.0, 0.0, 30.0, 20.0)); + assert_eq!(parse_window(" -5.5, -1e3 ,2e3,4 ").unwrap(), b(-5.5, -1000.0, 2000.0, 4.0)); + } + + #[test] + fn hostile_window_is_an_error() { + for w in [ + "", + "1,2,3", + "1,2,3,4,5", + "a,0,1,1", + "NaN,0,1,1", + "0,0,inf,1", + "0,0,1e400,1", + "0,0,0,1", + "0,0,1,0", + "5,0,1,1", + "0,5,1,1", + "-1e300,-1e300,1e300,1e300", + "0,0,1e-12,1e-12", + ] { + assert!(parse_window(w).is_err(), "`{w}` should be rejected"); + } + } + + /// The subcommands that draw or run commands take the settings flags; the others refuse them. + #[test] + fn settings_flags() { + let Command::Convert(c) = + parse_args(&["convert", "a.dxf", "b.png", "--config-dir", "/p", "--fontalt", "Noto Sans", "--fontfallback="]).unwrap().command + else { + panic!("not convert") + }; + assert_eq!(c.settings.config_dir, Some(PathBuf::from("/p"))); + assert_eq!((c.settings.fontalt.as_deref(), c.settings.fontfallback.as_deref()), (Some("Noto Sans"), Some(""))); + for empty in ["--config-dir=", "--config-dir= "] { + let Command::Run(r) = parse_args(&["run", "--sample", empty]).unwrap().command else { panic!("not run") }; + assert_eq!(r.settings.settings_dir(), None, "`{empty}` is no settings folder"); + } + let Command::Convert(c) = parse_args(&["convert", "a.dxf", "b.png", "--config-dir", "/p"]).unwrap().command else { panic!("not convert") }; + assert_eq!(c.settings.settings_dir(), Some(PathBuf::from("/p"))); + assert!(parse_args(&["sample", "bracket", "b.dxf", "--fontalt", "x"]).is_ok()); + assert!(parse_args(&["mcp", "--config-dir", "/p"]).is_ok()); + assert!(parse_args(&["info", "a.dxf", "--config-dir", "/p"]).is_err()); + } + + #[test] + fn blank_variables_count_as_unset_except_the_config_dir() { + let cmd = command(|_| Some("".into())); + for sub in cmd.get_subcommands().filter(|s| s.get_arguments().any(|a| a.get_id() == "fontalt")) { + let env = |id: &str| sub.get_arguments().find(|a| a.get_id() == id).and_then(|a| a.get_env()); + assert_eq!((env("fontalt"), env("fontfallback")), (None, None), "{}", sub.get_name()); + assert_eq!(env("config_dir"), Some(OsStr::new("CADCRAFT_CONFIG_DIR")), "{}", sub.get_name()); + } + } + + /// `--fontalt` falls back to `PATH` and rejects every value here, as a bad value from a + /// variable would; tests can't set a variable (`set_var` is unsafe). + #[test] + fn a_bad_value_from_a_variable_names_the_variable() { + // Cargo sets CARGO_PKG_NAME for every test binary, so the variable always has a value. + let reject = clap::builder::PossibleValuesParser::new(["never"]); + let cmd = || Cli::command().mut_subcommand("sample", |s| s.mut_arg("fontalt", |a| a.env("CARGO_PKG_NAME").value_parser(reject.clone()))); + let args = |a: &[&str]| a.iter().map(OsString::from).collect::>(); + let text = parse_with(cmd(), &args(&["sample"])).err().map(|e| e.to_string()).unwrap_or_default(); + assert!(text.contains("for 'CARGO_PKG_NAME'") && !text.contains("--fontalt"), "{text}"); + let text = parse_with(cmd(), &args(&["sample", "--fontalt", "x"])).err().map(|e| e.to_string()).unwrap_or_default(); + assert!(text.contains("--fontalt"), "{text}"); + } +} diff --git a/apps/cadcraft-cli/src/commands.rs b/apps/cadcraft-cli/src/commands.rs new file mode 100644 index 000000000..51fc06606 --- /dev/null +++ b/apps/cadcraft-cli/src/commands.rs @@ -0,0 +1,17 @@ +use super::args::CommandsArgs; +use super::error::Result; +use super::output::Streams; +use cadcraft_engine::Session; +use serde_json::Value; + +pub(crate) fn commands(a: &CommandsArgs, io: &mut Streams) -> Result { + let s = Session::new(); + let f = a.filter.as_ref().map(|x| x.to_ascii_lowercase()); + let v: Vec = cadcraft_engine::command_specs() + .iter() + .filter(|c| f.as_ref().is_none_or(|f| c.id.contains(f.as_str()) || c.label.to_ascii_lowercase().contains(f.as_str()))) + .map(|c| serde_json::to_value(c.info(&s)).unwrap_or_default()) + .collect(); + io.json(&Value::Array(v), a.compact); + Ok(()) +} diff --git a/apps/cadcraft-cli/src/convert.rs b/apps/cadcraft-cli/src/convert.rs new file mode 100644 index 000000000..6a9c4edbf --- /dev/null +++ b/apps/cadcraft-cli/src/convert.rs @@ -0,0 +1,22 @@ +use super::args::ConvertArgs; +use super::error::Result; +use super::output::{Streams, export_framed, export_window, skipped_message, undrawn_message}; +use super::{open, unicode}; +use cadcraft_engine::Session; + +pub(crate) fn convert(a: &ConvertArgs, io: &mut Streams) -> Result { + let i = unicode(&a.input)?; + let framing = a.framing.framing(); + let mut s = Session::empty(); + open(&mut s, &a.input)?; + if let Some(m) = skipped_message(s.doc()?, i) { + io.errln(format_args!("{m}")); + } + if cadcraft_io::is_image(&a.output) + && let Some(m) = undrawn_message(s.doc()?, i) + { + io.errln(format_args!("{m}")); + } + let window = export_window(&s, framing, None)?; + export_framed(&s, &a.output, window, io) +} diff --git a/apps/cadcraft-cli/src/error.rs b/apps/cadcraft-cli/src/error.rs new file mode 100644 index 000000000..51b816890 --- /dev/null +++ b/apps/cadcraft-cli/src/error.rs @@ -0,0 +1,29 @@ +use crate::output::OutputError; +use crate::perf::PerfError; +use crate::run::RunError; + +/// Why a subcommand failed: printed as `error: {e}`, exit 1. +#[derive(Debug, thiserror::Error)] +pub(crate) enum CliError { + #[error(transparent)] + Engine(#[from] cadcraft_engine::EngineError), + #[error(transparent)] + Doc(#[from] cadcraft_engine::doc::DocError), + #[error(transparent)] + Format(#[from] cadcraft_io::IoError), + #[error(transparent)] + Io(#[from] std::io::Error), + #[error(transparent)] + Run(#[from] RunError), + #[error(transparent)] + Output(#[from] OutputError), + #[error(transparent)] + Perf(#[from] PerfError), + /// The engine and io crates take file names as text. + #[error("{}: the file name is not valid Unicode", .0.display())] + NotUnicode(std::path::PathBuf), + #[error("cannot connect to {addr}: {source}")] + McpConnect { addr: String, source: std::io::Error }, +} + +pub(crate) type Result = std::result::Result; diff --git a/apps/cadcraft-cli/src/info.rs b/apps/cadcraft-cli/src/info.rs new file mode 100644 index 000000000..bac94108e --- /dev/null +++ b/apps/cadcraft-cli/src/info.rs @@ -0,0 +1,14 @@ +use super::args::InfoArgs; +use super::error::Result; +use super::open; +use super::output::Streams; +use cadcraft_engine::Session; +use serde_json::json; + +pub(crate) fn info(a: &InfoArgs, io: &mut Streams) -> Result { + let mut s = Session::empty(); + open(&mut s, &a.file)?; + let v = s.execute("drawing.inspect", &json!({ "entities": false }))?; + io.json(&v, a.compact); + Ok(()) +} diff --git a/apps/cadcraft-cli/src/lib.rs b/apps/cadcraft-cli/src/lib.rs new file mode 100644 index 000000000..c858417e2 --- /dev/null +++ b/apps/cadcraft-cli/src/lib.rs @@ -0,0 +1,315 @@ +//! `cadcraft-cli`: headless CADCraft. The subcommands and their options are the clap types in +//! `args.rs`; `cadcraft-cli --help` lists them. +#![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)] + +use std::ffi::OsString; +use std::io::Write; + +use cadcraft_engine::Session; +use serde_json::json; + +mod args; +mod commands; +mod convert; +mod error; +mod info; +mod mcp; +mod output; +mod perf; +mod run; +mod sample; + +#[cfg(test)] +use args::Framing; +use args::{Command, parse}; +use clap::CommandFactory; +use commands::commands; +use convert::convert; +use error::Result; +use info::info; +use mcp::mcp; +use output::Streams; +#[cfg(test)] +use output::{export_window, model_views, write_atomic}; +use perf::perf; +use run::run_cmds; +#[cfg(test)] +use run::{fill_last, returned_handle}; +use sample::sample; + +fn install_io() { + cadcraft_engine::cmd::file::set_io(cadcraft_engine::cmd::file::IoHooks { + read: |b, name| cadcraft_io::read(b, name).map_err(|e| e.to_string()), + write: |d, name| cadcraft_io::write(d, name).map_err(|e| e.to_string()), + plot: Some(|d, space, opts| cadcraft_io::plotter::plot(d, space, opts).map_err(|e| e.to_string())), + }); + cadcraft_engine::cmd::file::set_write_as(|d, name, o| { + cadcraft_io::write_with(d, name, &cadcraft_io::SaveOptions { version: o.version, binary: o.binary }).map_err(|e| e.to_string()) + }); + // AutoLISP's entget, entmake and entmod see entities as DXF groups. + cadcraft_engine::cmd::file::set_entity_codec(cadcraft_engine::cmd::file::EntityCodec { + groups: cadcraft_io::entity_groups, + entity: cadcraft_io::entity_from_groups, + }); +} + +/// `path` as text, for the engine and io calls that take a file name as a string. +fn unicode(path: &std::path::Path) -> Result<&str> { + path.to_str().ok_or_else(|| error::CliError::NotUnicode(path.to_path_buf())) +} + +fn open(s: &mut Session, path: &std::path::Path) -> Result { + s.execute("open", &json!({ "path": unicode(path)? }))?; + Ok(()) +} + +/// The command line's clap definition, for generating shell completions and man pages. +pub fn command() -> clap::Command { + args::Cli::command() +} + +/// Run the CLI on its arguments (without the program name). Returns the process exit code (0 ok, +/// 1 failure, 2 usage). clap reads the arguments as they are: a value that is not valid Unicode +/// is a usage error, never a panic as with `std::env::args()`. +pub fn run(args: I, out: &mut dyn Write, err: &mut dyn Write) -> i32 +where + I: IntoIterator, + T: Into, +{ + let args: Vec = args.into_iter().map(Into::into).collect(); + // Help and `--version` (`help`, `-h`, ` --help`, `-V`) come back as errors too, + // for `out`, exit 0: the subcommand never runs. + let cli = match parse(&args) { + Ok(cli) => cli, + Err(e) => { + let to: &mut dyn Write = if e.use_stderr() { err } else { out }; + return match write!(to, "{}", e.render()) { + Err(w) if w.kind() != std::io::ErrorKind::BrokenPipe => { + let _ = writeln!(err, "error: can't write the output: {w}"); + 1 + } + _ => e.exit_code(), + }; + } + }; + // The engine's hooks are set-once, so installing them on every call is harmless. + install_io(); + match &cli.command { + Command::Convert(a) => a.settings.apply(), + Command::Run(a) => a.settings.apply(), + Command::Mcp(a) => a.settings.apply(), + Command::Sample(a) => a.settings.apply(), + Command::Info(_) | Command::Commands(_) | Command::Perf(_) => {} + } + let mut io = Streams::new(out, err); + let result = match &cli.command { + Command::Info(a) => info(a, &mut io), + Command::Convert(a) => convert(a, &mut io), + Command::Run(a) => run_cmds(a, &mut io), + Command::Commands(a) => commands(a, &mut io), + Command::Mcp(a) => mcp(a), + Command::Perf(a) => perf(a.target.as_ref(), &mut io), + Command::Sample(a) => sample(a, &mut io), + }; + let mut code = 0; + if let Err(e) = result { + io.errln(format_args!("error: {e}")); + code = 1; + } + io.finish(); + if io.stdout_failed() { 1 } else { code } +} + +#[cfg(test)] +mod tests { + use super::*; + use cadcraft_engine::doc::Space; + use cadcraft_engine::geom::{Bounds2, Vec2}; + + fn scratch_dir(tag: &str) -> std::path::PathBuf { + let dir = std::env::temp_dir().join(format!("cadcraft-cli-{tag}-{}", std::process::id())); + let _ = std::fs::remove_dir_all(&dir); + std::fs::create_dir_all(&dir).expect("create scratch dir"); + dir + } + + struct FailingWriter(std::io::ErrorKind); + + impl Write for FailingWriter { + fn write(&mut self, _: &[u8]) -> std::io::Result { + Err(self.0.into()) + } + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + #[test] + fn a_failed_write_of_help_exits_1_unless_the_pipe_is_closed() { + let mut err = Vec::new(); + assert_eq!(run(["--help"], &mut FailingWriter(std::io::ErrorKind::StorageFull), &mut err), 1); + assert!(String::from_utf8_lossy(&err).starts_with("error: ")); + assert_eq!(run(["--help"], &mut FailingWriter(std::io::ErrorKind::BrokenPipe), &mut Vec::new()), 0); + } + + #[test] + fn write_atomic_replaces_file_and_leaves_no_staging_files() { + let dir = scratch_dir("replace"); + let out = dir.join("a.dxf"); + write_atomic(&out, b"old").expect("create"); + write_atomic(&out, b"new").expect("overwrite"); + assert_eq!(std::fs::read(&out).expect("read"), b"new"); + assert_eq!(std::fs::read_dir(&dir).expect("list").count(), 1); + let _ = std::fs::remove_dir_all(&dir); + } + + #[test] + fn write_atomic_failure_keeps_destination_and_cleans_up() { + let dir = scratch_dir("fail"); + let out = dir.join("target"); + std::fs::create_dir(&out).expect("dir as destination"); + std::fs::write(out.join("keep"), b"x").expect("seed"); + assert!(write_atomic(&out, b"new").is_err()); + assert_eq!(std::fs::read(out.join("keep")).expect("kept"), b"x"); + assert_eq!(std::fs::read_dir(&dir).expect("list").count(), 1); + let _ = std::fs::remove_dir_all(&dir); + } + + fn b(x0: f64, y0: f64, x1: f64, y1: f64) -> Bounds2 { + Bounds2::new(Vec2::new(x0, y0), Vec2::new(x1, y1)) + } + + fn sample_session() -> Session { + let mut s = Session::empty(); + s.open_drawing(cadcraft_engine::sample::default_sample(), "Bracket", None); + s + } + + fn view_box(svg: &str) -> String { + let i = svg.find("viewBox=\"").map(|i| i + 9).unwrap_or(0); + svg[i..].split('"').next().unwrap_or("").to_string() + } + + fn assert_near(a: Bounds2, e: Bounds2) { + let d = (a.min - e.min).len().max((a.max - e.max).len()); + assert!(d < 1e-9, "{a:?} != {e:?}"); + } + + #[test] + fn last_placeholder_takes_the_previous_handle() { + let mut s = sample_session(); + let r = s.execute("line", &json!({"points": [[0, 0], [10, 0]]})).unwrap(); + let h = returned_handle(&s, &r).expect("LINE returns its handle"); + assert_eq!(fill_last(&json!({"handle": "{last}"}), Some(h)).unwrap(), json!({"handle": h.hex()})); + // Nested, as in a selection list. + assert_eq!(fill_last(&json!({"handles": ["{last}", "1"]}), Some(h)).unwrap(), json!({"handles": [h.hex(), "1"]})); + // Only the exact token: a name or a sentence that merely contains it stays as written. + for p in [json!("last"), json!("{last} "), json!({"name": "last"})] { + assert_eq!(fill_last(&p, Some(h)).unwrap(), p); + } + // Nothing returned yet: an error, not a token passed to the command as a bad handle. + assert!(fill_last(&json!({"handle": "{last}"}), None).unwrap_err().to_string().contains("{last}")); + } + + /// Handles are read from a result by looking the strings up in the drawing: counts and names + /// are not mistaken for handles, and `mview`'s `viewports` works like `handle`/`handles`. + #[test] + fn returned_handle_reads_only_real_handles() { + let mut s = Session::empty(); + s.new_drawing(false); + s.execute("layout.set", &json!({"name": "Layout1"})).unwrap(); + let r = s.execute("mview", &json!({"p1": [20, 20], "p2": [200, 150]})).unwrap(); + let h = returned_handle(&s, &r).expect("mview returns its viewport handle"); + assert!(r["viewports"].as_array().is_some_and(|a| a.iter().any(|v| v.as_str() == Some(h.hex().as_str()))), "{r}"); + assert_eq!(returned_handle(&s, &json!({"changed": 3, "name": "A1"})), None); + // The most recent of several. + let a = s.execute("line", &json!({"points": [[0, 0], [1, 0]]})).unwrap(); + let b = s.execute("line", &json!({"points": [[0, 0], [2, 0]]})).unwrap(); + let (ha, hb) = (returned_handle(&s, &a).unwrap(), returned_handle(&s, &b).unwrap()); + assert_eq!(returned_handle(&s, &json!({"handles": [ha.hex(), hb.hex()]})), Some(hb)); + } + + #[test] + fn default_framing_is_extents() { + // convert: nothing ran, always the extents. + let s = sample_session(); + assert_eq!(export_window(&s, Framing::Auto, None).unwrap(), None); + // run: commands that leave the view alone keep the extents framing. + let mut s = sample_session(); + let before = model_views(&s); + s.script("LINE 0,0 10,10\n\n").unwrap(); + assert_eq!(export_window(&s, Framing::Auto, Some(&before)).unwrap(), None); + // A fresh drawing too. + let mut s = Session::empty(); + s.new_drawing(false); + let before = model_views(&s); + s.execute("circle", &json!({"center": [0, 0], "radius": 5})).unwrap(); + assert_eq!(export_window(&s, Framing::Auto, Some(&before)).unwrap(), None); + } + + #[test] + fn zoom_window_frames_export() { + let mut s = sample_session(); + let before = model_views(&s); + s.execute("zoom", &json!({"mode": "window", "p1": [0, 0], "p2": [30, 20]})).unwrap(); + let w = export_window(&s, Framing::Auto, Some(&before)).unwrap().unwrap(); + // The CLI viewport is 3:2, so a 3:2 window is shown exactly. + assert_near(w, b(0.0, 0.0, 30.0, 20.0)); + assert_eq!(export_window(&s, Framing::Current, Some(&before)).unwrap(), Some(w)); + // --view extents and --window override the zoom. + assert_eq!(export_window(&s, Framing::Extents, Some(&before)).unwrap(), None); + let explicit = b(1.0, 1.0, 2.0, 2.0); + assert_eq!(export_window(&s, Framing::Window(explicit), Some(&before)).unwrap(), Some(explicit)); + // A taller window keeps its height; the 3:2 image adds room left and right. + s.execute("zoom", &json!({"mode": "center", "center": [5, 5], "height": 4})).unwrap(); + assert_near(export_window(&s, Framing::Auto, Some(&before)).unwrap().unwrap(), b(2.0, 3.0, 8.0, 7.0)); + } + + #[test] + fn zoom_object_frames_the_selection() { + let mut s = sample_session(); + let before = model_views(&s); + // The smallest entity with an area, selected then framed with ZOOM Object. + let d = s.doc().unwrap(); + let bounds = |e: &cadcraft_engine::doc::Entity| cadcraft_engine::doc::entity_bounds(d, e, 0); + let e = d + .model + .iter() + .filter(|e| bounds(e).width() > 0.0 && bounds(e).height() > 0.0) + .min_by(|a, b| bounds(a).width().total_cmp(&bounds(b).width())) + .unwrap(); + let (h, eb, ext) = (e.handle, bounds(e), d.extents(&Space::Model)); + s.set_selection(vec![h]); + s.execute("zoom", &json!({"mode": "object"})).unwrap(); + let w = export_window(&s, Framing::Auto, Some(&before)).unwrap().unwrap(); + assert!(w.contains(eb.min) && w.contains(eb.max)); + assert!(w.width() < ext.width() && w.height() < ext.height(), "{w:?} vs extents {ext:?}"); + } + + #[test] + fn run_export_honours_zoom() { + let dir = std::env::temp_dir().join(format!("cadcraft-cli-165-{}", std::process::id())); + std::fs::create_dir_all(&dir).unwrap(); + let path = |n: &str| dir.join(n).to_string_lossy().to_string(); + let run_svg = |extra: &[&str], out: &str| -> String { + let mut args: Vec = ["run", "--sample"].iter().chain(extra).map(|a| a.to_string()).collect(); + args.extend(["--export".to_string(), path(out)]); + assert_eq!(run(args, &mut Vec::new(), &mut Vec::new()), 0); + std::fs::read_to_string(path(out)).unwrap() + }; + let base = run_svg(&[], "base.svg"); + let zoomed = run_svg(&["--cmd", r#"zoom {"mode":"window","p1":[0,0],"p2":[30,20]}"#], "zoom.svg"); + let window = run_svg(&["--window", "0,0,30,20"], "window.svg"); + let forced = run_svg(&["--cmd", r#"zoom {"mode":"window","p1":[0,0],"p2":[30,20]}"#, "--view", "extents"], "forced.svg"); + assert_ne!(view_box(&zoomed), view_box(&base)); + assert_eq!(view_box(&zoomed), "0 0 30.000000 20.000000"); + assert_eq!(zoomed, window); + assert_eq!(forced, base); + // Hostile --window: a usage error, nothing written. + let mut err = Vec::new(); + assert_eq!(run(["run", "--sample", "--window", "0,0,NaN,1", "--export", &path("bad.png")], &mut Vec::new(), &mut err), 2); + assert!(String::from_utf8_lossy(&err).contains("--window")); + assert!(!dir.join("bad.png").exists()); + let _ = std::fs::remove_dir_all(&dir); + } +} diff --git a/apps/cadcraft-cli/src/main.rs b/apps/cadcraft-cli/src/main.rs index 99a8b4282..7561b96b5 100644 --- a/apps/cadcraft-cli/src/main.rs +++ b/apps/cadcraft-cli/src/main.rs @@ -1,1111 +1,8 @@ -//! `cadcraft-cli`: headless CADCraft. -//! -//! ```text -//! cadcraft-cli info FILE.dxf summary as JSON -//! cadcraft-cli convert IN.dxf OUT.(dxf|svg|png) [--window x0,y0,x1,y1 | --view extents|current] -//! cadcraft-cli run [FILE|--sample|--metric] [--script TEXT|--script-file F.scr] [--cmd 'id {json}']... [--save OUT] [--export OUT.png] [--window ... | --view ...] -//! cadcraft-cli commands [FILTER] command catalog (JSON) -//! cadcraft-cli mcp [--connect HOST:PORT [--lazy] [--launch]] MCP server on stdio (headless or bridged to the app) -//! cadcraft-cli perf [N] timing table on a synthetic N-entity drawing -//! cadcraft-cli perf FILE canvas display-list build of a drawing, zoomed in step by step -//! cadcraft-cli sample (bracket|floorplan) OUT write a built-in sample drawing -//! ``` #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)] -/// `println!` that doesn't panic when stdout is closed (`cadcraft-cli commands | head`) with -/// "failed printing to stdout: Broken pipe (os error 32)". Once stdout has failed, later output is -/// dropped and the work goes on: see `stdout_failed`. -macro_rules! outln { - ($($arg:tt)*) => {{ - use std::io::Write as _; - if !$crate::stdout_gone() { - if let Err(e) = writeln!(std::io::stdout(), $($arg)*) { - $crate::stdout_failed(e); - } - } - }}; -} - -use std::process::ExitCode; - -use cadcraft_engine::doc::{Handle, Space}; -use cadcraft_engine::geom::{Bounds2, Vec2}; -use cadcraft_engine::{Session, View}; -use serde_json::{Value, json}; -use std::sync::atomic::{AtomicBool, Ordering}; - -/// Set once a write to stdout has failed; later output is dropped. -static STDOUT_GONE: AtomicBool = AtomicBool::new(false); -/// Set when stdout failed for a reason other than a closed reader: the exit status becomes 1. -static STDOUT_ERROR: AtomicBool = AtomicBool::new(false); - -fn stdout_gone() -> bool { - STDOUT_GONE.load(Ordering::Relaxed) -} - -/// stdout went away. The program doesn't stop there: the rest of `run` (later `--cmd` results, -/// `--save`, `--export`) still happens, so `cadcraft-cli run … --save out.dxf | head` keeps the -/// drawing. A reader that stopped early (a closed pipe) is not an error, as in ripgrep; any other -/// write error is reported and makes the exit status 1. -fn stdout_failed(e: std::io::Error) { - if STDOUT_GONE.swap(true, Ordering::Relaxed) || e.kind() == std::io::ErrorKind::BrokenPipe { - return; - } - eprintln!("cadcraft-cli: can't write to stdout: {e}"); - STDOUT_ERROR.store(true, Ordering::Relaxed); -} - -const USAGE: &str = "usage: - cadcraft-cli info FILE.dxf - cadcraft-cli convert IN.dxf OUT.(dxf|dwg|svg|png|pdf) [FRAMING] - cadcraft-cli run [FILE | --sample | --metric] [--script TEXT] [--script-file F.scr] [--cmd 'id {json}']... [--save OUT.dxf] [--export OUT.(png|svg|pdf)] [FRAMING] - cadcraft-cli commands [FILTER] - cadcraft-cli mcp [--connect HOST:PORT [--lazy] [--launch]] - cadcraft-cli perf [N | FILE] - cadcraft-cli sample (bracket|floorplan) OUT.(dxf|dwg|svg|png) - cadcraft-cli --version - -image framing (png 2400x1600, svg, pdf; always model space): - default convert: fit the drawing extents. - run --export: the current view if the script/commands changed it - (zoom, pan, view.set...), otherwise fit the drawing extents. - --window x0,y0,x1,y1 show this rectangle (drawing units, x0 Result { - let parts: Vec<&str> = text.split(',').map(str::trim).collect(); - let [x0, y0, x1, y1] = parts.as_slice() else { - return Err(format!("--window needs four numbers x0,y0,x1,y1, got `{text}`")); - }; - let num = |name: &str, v: &str| -> Result { - match v.parse::() { - Ok(n) if n.is_finite() => Ok(n), - _ => Err(format!("--window: {name} must be a finite number, got `{v}`")), - } - }; - let (x0, y0, x1, y1) = (num("x0", x0)?, num("y0", y0)?, num("x1", x1)?, num("y1", y1)?); - if !(x0 < x1 && y0 < y1) { - return Err(format!("--window: need x0 < x1 and y0 < y1 (lower-left corner first), got {x0},{y0},{x1},{y1}")); - } - let w = Bounds2 { min: Vec2::new(x0, y0), max: Vec2::new(x1, y1) }; - cadcraft_io::check_window(&w).map_err(|e| format!("--window: {e}"))?; - Ok(w) -} - -/// Parse a framing option (`--window`, `--view`) at `a`, taking its value from `it`. `Ok(false)` -/// means `a` is not a framing option. -fn framing_option<'a>(a: &str, it: &mut impl Iterator, framing: &mut Framing) -> Result { - let f = match a { - "--window" => Framing::Window(parse_window(it.next().ok_or("--window needs x0,y0,x1,y1")?)?), - "--view" => match it.next().map(|v| v.to_ascii_lowercase()).as_deref() { - Some("extents") => Framing::Extents, - Some("current") => Framing::Current, - _ => return Err("--view needs `extents` or `current`".into()), - }, - _ => return Ok(false), - }; - if *framing != Framing::Auto && std::mem::discriminant(framing) != std::mem::discriminant(&f) { - return Err("use only one of --window and --view".into()); - } - *framing = f; - Ok(true) -} - -/// The model-space view of every open drawing, by drawing id (to tell whether commands changed it). -fn model_views(s: &Session) -> Vec<(u64, Option)> { - s.docs.iter().map(|st| (st.uid, st.views.iter().find(|(sp, _)| *sp == Space::Model).map(|(_, v)| *v))).collect() -} - -/// The active drawing's current model-space view as a rectangle with the viewport's aspect ratio -/// (the CLI viewport is 3:2 like the PNG export, so the image shows exactly this view). -fn current_window(s: &Session) -> Option { - let st = s.state().ok()?; - let v = st.views.iter().find(|(sp, _)| *sp == Space::Model).map(|(_, v)| *v)?; - let (w, h) = s.viewport_px; - let half = Vec2::new(v.height * w / h.max(1.0), v.height) * 0.5; - Some(Bounds2::new(v.center - half, v.center + half)) -} - -/// The window an image export shows, or `None` to fit the extents. `before` is [`model_views`] -/// taken before the commands ran (`None` for `convert`, where nothing ran). -fn export_window(s: &Session, framing: Framing, before: Option<&[(u64, Option)]>) -> Result, String> { - match framing { - Framing::Window(w) => Ok(Some(w)), - Framing::Extents => Ok(None), - Framing::Current => current_window(s).map(Some).ok_or_else(|| "--view current: the drawing has no model-space view".into()), - Framing::Auto => { - let Some(before) = before else { return Ok(None) }; - let Ok(st) = s.state() else { return Ok(None) }; - let now = model_views(s); - let was = before.iter().find(|(uid, _)| *uid == st.uid); - let is = now.iter().find(|(uid, _)| *uid == st.uid); - // Only a view the commands changed counts; a drawing opened by the commands keeps - // the extents framing. - match (was, is) { - (Some(a), Some(b)) if a.1 != b.1 => Ok(current_window(s)), - _ => Ok(None), - } - } - } -} - -fn install_io() { - cadcraft_engine::cmd::file::set_io(cadcraft_engine::cmd::file::IoHooks { - read: |b, name| cadcraft_io::read(b, name).map_err(|e| e.to_string()), - write: |d, name| cadcraft_io::write(d, name).map_err(|e| e.to_string()), - plot: Some(|d, space, opts| cadcraft_io::plotter::plot(d, space, opts).map_err(|e| e.to_string())), - }); - cadcraft_engine::cmd::file::set_write_as(|d, name, o| { - cadcraft_io::write_with(d, name, &cadcraft_io::SaveOptions { version: o.version, binary: o.binary }).map_err(|e| e.to_string()) - }); - // AutoLISP's entget, entmake and entmod see entities as DXF groups. - cadcraft_engine::cmd::file::set_entity_codec(cadcraft_engine::cmd::file::EntityCodec { - groups: cadcraft_io::entity_groups, - entity: cadcraft_io::entity_from_groups, - }); -} - -fn open(s: &mut Session, path: &str) -> Result<(), String> { - s.execute("open", &json!({ "path": path })).map(|_| ()).map_err(|e| e.to_string()) -} - -#[derive(Clone, Copy)] -struct OptionSpec { - name: &'static str, - takes_value: bool, -} - -fn validate_options(command: &str, args: &[String], specs: &[OptionSpec]) -> Result<(), String> { - let mut i = 0; - while let Some(arg) = args.get(i) { - if let Some(name) = arg.strip_prefix("--") { - let Some(spec) = specs.iter().find(|spec| spec.name == arg) else { - return Err(format!("{command}: unknown option --{name}")); - }; - if spec.takes_value && args.get(i + 1).is_some_and(|value| !value.starts_with("--")) { - i += 2; - } else { - i += 1; - } - } else { - i += 1; - } - } - Ok(()) -} - -const NO_OPTIONS: &[OptionSpec] = &[]; - -fn info(path: &str) -> Result<(), String> { - let mut s = Session::empty(); - open(&mut s, path)?; - let v = s.execute("drawing.inspect", &json!({ "entities": false })).map_err(|e| e.to_string())?; - outln!("{}", serde_json::to_string_pretty(&v).unwrap_or_default()); - Ok(()) -} - -/// Write `bytes` to `out` through the engine's atomic writer (an exclusively created sibling file -/// renamed over `out`), so a failed or interrupted write leaves the previous file untouched. -fn write_atomic(out: &str, bytes: &[u8]) -> std::io::Result<()> { - cadcraft_engine::atomic_write::write_atomic(std::path::Path::new(out), bytes) -} - -fn export(s: &Session, out: &str) -> Result<(), String> { - export_framed(s, out, None) -} - -fn export_framed(s: &Session, out: &str, window: Option) -> Result<(), String> { - let d = s.doc().map_err(|e| e.to_string())?; - let bytes = cadcraft_io::write_framed(d, out, window).map_err(|e| e.to_string())?; - write_atomic(out, &bytes).map_err(|e| format!("{out}: {e}"))?; - eprintln!("wrote {out} ({} bytes)", bytes.len()); - if cadcraft_engine::cmd::file::drops_unknown(out) { - let lost = cadcraft_engine::cmd::file::not_saved(d); - if let Some(m) = cadcraft_engine::cmd::file::not_saved_message(&lost) { - eprintln!("{m}"); - } - } - Ok(()) -} - -fn sample(args: &[String]) -> Result<(), String> { - let (Some(which), Some(out)) = (args.first(), args.get(1)) else { return Err(USAGE.into()) }; - let d = match which.as_str() { - "bracket" => cadcraft_engine::sample::bracket(), - "floorplan" | "floor" => cadcraft_engine::sample::floor_plan(), - other => return Err(format!("unknown sample `{other}` (bracket, floorplan)")), - }; - let bytes = cadcraft_io::write(&d, out).map_err(|e| e.to_string())?; - write_atomic(out, &bytes).map_err(|e| format!("{out}: {e}"))?; - eprintln!("wrote {out} ({} bytes)", bytes.len()); - Ok(()) -} - -/// Reject an explicit framing option without an image output to apply it to. -fn check_framed_output(framing: Framing, out: Option<&str>) -> Result<(), String> { - match out { - _ if framing == Framing::Auto => Ok(()), - Some(o) if !cadcraft_io::is_image(o) => Err(format!("--window/--view only apply to image output (png, svg, pdf), not `{o}`")), - Some(_) => Ok(()), - None => Err("--window/--view need an image output (--export OUT.png|svg|pdf)".into()), - } -} - -fn convert(args: &[String]) -> Result<(), String> { - let mut framing = Framing::Auto; - let mut files = Vec::new(); - let mut it = args.iter(); - while let Some(a) = it.next() { - if !framing_option(a, &mut it, &mut framing)? { - files.push(a); - } - } - let [i, o] = files.as_slice() else { return Err(USAGE.into()) }; - check_framed_output(framing, Some(o))?; - let mut s = Session::empty(); - open(&mut s, i)?; - if let Some(m) = skipped_message(s.doc().map_err(|e| e.to_string())?, i) { - eprintln!("{m}"); - } - if cadcraft_io::is_image(o) - && let Some(m) = undrawn_message(s.doc().map_err(|e| e.to_string())?, i) - { - eprintln!("{m}"); - } - let window = export_window(&s, framing, None)?; - export_framed(&s, o, window) -} - -/// The warning for the model-space entities of `path` an image can't show, by type (those kept -/// as unknown objects, `Proxy` in `info`), or `None` when there are none. -fn undrawn_message(d: &cadcraft_engine::doc::Drawing, path: &str) -> Option { - let mut types: std::collections::BTreeMap<&str, usize> = std::collections::BTreeMap::new(); - for e in d.model.iter() { - if let cadcraft_engine::doc::EntityKind::Unknown(u) = &e.kind { - let n = types.entry(u.dxf_type.as_str()).or_insert(0); - *n = n.saturating_add(1); - } - } - let n = types.values().fold(0usize, |a, n| a.saturating_add(*n)); - if n == 0 { - return None; - } - let list: Vec = types.iter().map(|(t, n)| format!("{t}: {n}")).collect(); - let entities = if n == 1 { "entity" } else { "entities" }; - Some(format!("{path}: {n} {entities} not drawn ({})", list.join(", "))) -} - -/// The warning for the records of `path` the reader could not place, or `None` when there are none. -fn skipped_message(d: &cadcraft_engine::doc::Drawing, path: &str) -> Option { - let n = d.skipped_records.values().fold(0usize, |a, n| a.saturating_add(*n)); - if n == 0 { - return None; - } - let list: Vec = d.skipped_records.iter().map(|(section, n)| format!("{section}: {n}")).collect(); - let records = if n == 1 { "record" } else { "records" }; - Some(format!("{path}: {n} {records} could not be read and are left out ({})", list.join(", "))) -} - -/// A `--cmd` parameter value of exactly `{last}` is filled in with the last object handle an -/// earlier `--cmd` in the same run returned: `mview` answers `{"viewports":["100"]}`, so -/// `viewport.set {"handle":"{last}","scale":1}` changes viewport 100. Any other string is passed -/// through unchanged, and `--script` text is never rewritten. -const LAST_HANDLE: &str = "{last}"; - -/// How deep [`result_handles`] walks a command result (results are the engine's own JSON). -const RESULT_DEPTH: usize = 16; - -/// Result keys whose values are object references: the engine's result convention for handles. -/// A handle can be a string (`handle`, `viewport`, `insert`…) or a list of them (`handles`, -/// `viewports`, `members`…). Every other field may hold a user-defined name, a message or a -/// count, and is never read as a handle — a group named `100` is a name, not object `100`. -fn handle_field(key: &str) -> bool { - matches!( - key, - "handle" - | "handles" - | "viewport" - | "viewports" - | "boundary" - | "clip" - | "insert" - | "members" - | "source" - | "objects" - | "entities" - | "selection" - | "parts" - | "refs" - | "matches" - | "line" - | "arc" - | "blocks" - ) -} - -/// Collect the handles of `v`, a value under a handle field: a handle string, an array of them, -/// or objects that carry handle fields of their own (`entities`, `parts`). -fn collect_result_handles(s: &Session, v: &Value, depth: usize, out: &mut Vec) { - if depth > RESULT_DEPTH { - return; - } - match v { - Value::String(t) => { - if let Some(h) = Handle::parse_hex(t) - && s.doc().is_ok_and(|d| d.entity(h).is_some()) - { - out.push(h); - } - } - Value::Array(a) => a.iter().for_each(|x| collect_result_handles(s, x, depth + 1, out)), - Value::Object(m) => { - for (k, x) in m { - if handle_field(k) { - collect_result_handles(s, x, depth + 1, out); - } else { - find_result_handles(s, x, depth + 1, out); - } - } - } - _ => {} - } -} - -/// Find handle fields nested in containers that are not handles themselves (`groups` in -/// `groups.list`, whose members are handles): strings here are names, never references. -fn find_result_handles(s: &Session, v: &Value, depth: usize, out: &mut Vec) { - if depth > RESULT_DEPTH { - return; - } - match v { - Value::Array(a) => a.iter().for_each(|x| find_result_handles(s, x, depth + 1, out)), - Value::Object(m) => { - for (k, x) in m { - if handle_field(k) { - collect_result_handles(s, x, depth + 1, out); - } else { - find_result_handles(s, x, depth + 1, out); - } - } - } - _ => {} - } -} - -/// The object handles a command result mentions, in the order it lists them. A handle-only result -/// (a handle string or an array of them) counts as it is; otherwise only handle fields do. -fn result_handles(s: &Session, v: &Value, depth: usize, out: &mut Vec) { - match v { - Value::String(_) => collect_result_handles(s, v, depth, out), - Value::Array(a) if a.iter().all(Value::is_string) => collect_result_handles(s, v, depth, out), - Value::Array(_) | Value::Object(_) => find_result_handles(s, v, depth, out), - _ => {} - } -} - -/// The last handle `r` returned: what a later `{last}` stands for. -fn returned_handle(s: &Session, r: &Value) -> Option { - let mut hs = Vec::new(); - result_handles(s, r, 0, &mut hs); - hs.last().copied() -} - -/// The active drawing's identity ([`cadcraft_engine::DocState::uid`]): a handle is only meaningful -/// in the drawing it came from, and `new`, `open`, `document.switch` and `close` can make another -/// drawing current. -fn active_drawing(s: &Session) -> Option { - s.docs.get(s.active).map(|st| st.uid) -} - -/// Every `{last}` in `p`, at any depth, replaced by `h`. With no handle to fill in it is an -/// error, never a token reaching the command as a (bad) handle. -fn fill_last(p: &Value, h: Option) -> Result { - match p { - Value::String(t) if t.as_str() == LAST_HANDLE => match h { - Some(h) => Ok(Value::String(h.hex())), - None => Err(format!("`{LAST_HANDLE}` needs an earlier --cmd in this run to have returned a handle")), - }, - Value::Array(a) => a.iter().map(|x| fill_last(x, h)).collect::, _>>().map(Value::Array), - Value::Object(m) => { - m.iter().map(|(k, x)| Ok((k.clone(), fill_last(x, h)?))).collect::, _>>().map(Value::Object) - } - other => Ok(other.clone()), - } -} - -fn run(args: &[String]) -> Result<(), String> { - let mut s = Session::empty(); - let mut it = args.iter(); - let mut save = None; - let mut exp: Option = None; - let mut framing = Framing::Auto; - let mut steps: Vec<(String, String)> = Vec::new(); - while let Some(a) = it.next() { - if framing_option(a, &mut it, &mut framing)? { - continue; - } - match a.as_str() { - "--sample" => { - s.open_drawing(cadcraft_engine::sample::default_sample(), "Bracket", None); - } - "--metric" => { - s.new_drawing(true); - } - "--script" => steps.push(("script".into(), it.next().ok_or("--script needs text")?.replace("\\n", "\n"))), - "--script-file" => { - let p = it.next().ok_or("--script-file needs a path")?; - steps.push(("script".into(), std::fs::read_to_string(p).map_err(|e| format!("{p}: {e}"))?)); - } - "--cmd" => steps.push(("cmd".into(), it.next().ok_or("--cmd needs `id {json}`")?.clone())), - "--save" => save = Some(it.next().ok_or("--save needs a path")?.clone()), - "--export" => exp = Some(it.next().ok_or("--export needs a path")?.clone()), - f if !f.starts_with("--") => open(&mut s, f)?, - other => return Err(format!("unknown option {other}")), - } - } - if s.docs.is_empty() { - s.new_drawing(false); - } - check_framed_output(framing, exp.as_deref())?; - let before = model_views(&s); - let mut last_handle: Option = None; - for (kind, body) in steps { - // A handle belongs to the drawing that returned it: if this step makes another drawing - // current (`new`, `open`, `document.switch`, `close`, or a script running one of them), - // the remembered handle is stale. A handle the step itself returns is taken afterwards, - // so it is a handle of the drawing it made current. - let drawing = active_drawing(&s); - match kind.as_str() { - "script" => { - s.script(&body).map_err(|e| e.to_string())?; - if active_drawing(&s) != drawing { - last_handle = None; - } - } - _ => { - let (id, json) = body.split_once(' ').unwrap_or((&body, "{}")); - let params: Value = serde_json::from_str(json).map_err(|e| format!("--cmd {id}: {e}"))?; - let params = fill_last(¶ms, last_handle).map_err(|e| format!("--cmd {id}: {e}"))?; - let r = s.execute(id, ¶ms).map_err(|e| e.to_string())?; - if active_drawing(&s) != drawing { - last_handle = None; - } - if let Some(h) = returned_handle(&s, &r) { - last_handle = Some(h); - } - if !r.is_null() { - outln!("{r}"); - } - } - } - } - for l in &s.log { - eprintln!("{l}"); - } - if let Some(p) = save { - export(&s, &p)?; - } - if let Some(p) = exp { - let window = if cadcraft_io::is_image(&p) { export_window(&s, framing, Some(&before))? } else { None }; - export_framed(&s, &p, window)?; - } - Ok(()) -} - -/// Small deterministic generator (xorshift64*) so perf runs are repeatable without a dependency. -struct Rng(u64); - -impl Rng { - fn next(&mut self) -> f64 { - self.0 ^= self.0 >> 12; - self.0 ^= self.0 << 25; - self.0 ^= self.0 >> 27; - (self.0.wrapping_mul(0x2545_F491_4F6C_DD1D) >> 11) as f64 / (1u64 << 53) as f64 - } - fn range(&mut self, lo: f64, hi: f64) -> f64 { - lo + (hi - lo) * self.next() - } -} - -/// A synthetic drawing with `n` mixed entities (lines, circles, arcs, polylines, text) spread -/// over a square whose side grows with sqrt(n), so density stays constant. -fn synthetic(n: usize, side: f64) -> Result { - use cadcraft_engine::doc::{self as d, Common, EntityKind, Space}; - use cadcraft_engine::geom::{PolyVertex, Vec2, Vec3}; - let mut dr = d::Drawing::new_imperial(); - let mut r = Rng(0x9E37_79B9_7F4A_7C15); - let v3 = |x: f64, y: f64| Vec3::new(x, y, 0.0); - for i in 0..n { - let (x, y) = (r.range(0.0, side), r.range(0.0, side)); - let s = r.range(0.5, 8.0); - let kind = match i % 5 { - 0 => EntityKind::Line(d::Line { a: v3(x, y), b: v3(x + r.range(-s, s), y + r.range(-s, s)) }), - 1 => EntityKind::Circle(d::Circle { center: v3(x, y), radius: s * 0.5 }), - 2 => EntityKind::Arc(d::Arc { center: v3(x, y), radius: s * 0.5, start: r.range(0.0, 3.0), end: r.range(3.2, 6.2) }), - 3 => EntityKind::LwPolyline(d::LwPolyline { - vertices: (0..6) - .map(|k| PolyVertex { - p: Vec2::new(x + f64::from(k) * s * 0.3, y + r.range(-s, s) * 0.3), - bulge: if k == 2 { 0.4 } else { 0.0 }, - start_width: 0.0, - end_width: 0.0, - }) - .collect(), - closed: i % 2 == 0, - const_width: 0.0, - elevation: 0.0, - plinegen: false, - }), - _ => EntityKind::Text(d::Text { - insert: v3(x, y), - align_pt: None, - height: s * 0.2, - value: format!("T{i}"), - rotation: 0.0, - width_factor: 1.0, - oblique: 0.0, - style: "Standard".into(), - halign: d::HAlign::Left, - valign: d::VAlign::Baseline, - }), - }; - dr.add(&Space::Model, Common::default(), kind).map_err(|e| e.to_string())?; - } - Ok(dr) -} - -/// `perf FILE`: the display list built as the canvas builds it (a 1600 x 1000 px view at the -/// drawing's centre: tolerance, dash level of detail and view window from the zoom band), at -/// zoom extents and zoomed in 4x at a time, next to the full-detail build plots use. -fn perf_file(path: &str) -> Result<(), String> { - use cadcraft_engine::geom::{Bounds2, Vec2}; - use cadcraft_engine::render::{Options, build}; - use std::time::Instant; - let ms = |t: Instant| t.elapsed().as_secs_f64() * 1000.0; - let mut s = Session::empty(); - let t = Instant::now(); - open(&mut s, path)?; - let open_ms = ms(t); - let st = s.state().map_err(|e| e.to_string())?; - let (d, space) = (&st.doc, &st.space); - let ext = d.extents(space); - let size = ext.width().max(ext.height()); - if ext.is_empty() || !(size.is_finite() && size > 0.0) { - return Err("perf: the drawing is empty".into()); - } - outln!("open {open_ms:.0} ms, {} entities, extents {:.1} x {:.1}", d.entity_count(), ext.width(), ext.height()); - outln!("{:>8} {:>10} {:>10}", "zoom", "build ms", "prims"); - let mut finest = Options::default(); - for k in 0..5 { - let zoom = 4f64.powi(k); - let h = size / zoom; - let pixel = 2f64.powi((h / 1000.0).max(1e-300).log2().floor() as i32); - let half = Vec2::new(h * 0.8, h * 0.5); - let visible = Bounds2::new(ext.center() - half, ext.center() + half); - let screen = Options { tolerance: pixel * 0.5, min_dash: pixel * 2.0, view: Some(visible.expand(h * 0.8)), ..Default::default() }; - let t = Instant::now(); - let n = build(d, space, &screen).prims.len(); - outln!("{:>7}x {:>10.1} {n:>10}", zoom, ms(t)); - finest = screen; - } - // Plots: every pattern line, everywhere (last, so its large list doesn't weigh on the above). - let t = Instant::now(); - let n = build(d, space, &Options { min_dash: 0.0, view: None, ..finest }).prims.len(); - outln!("{:>8} {:>10.1} {n:>10}", "full", ms(t)); - Ok(()) -} - -fn perf(args: &[String]) -> Result<(), String> { - use cadcraft_engine::doc::Space; - use cadcraft_engine::geom::{Bounds2, Vec2}; - use cadcraft_engine::{select, snap}; - use std::time::Instant; - if let Some(path) = args.first().filter(|a| a.parse::().is_err()) { - return perf_file(path); - } - let n: usize = match args.first() { - Some(a) => a.parse().map_err(|_| format!("perf: bad entity count {a}"))?, - None => 200_000, - }; - let n = n.clamp(1, 20_000_000); - let side = (n as f64).sqrt() * 10.0; - let mut rows: Vec<(String, f64, String)> = Vec::new(); - let ms = |t: Instant| t.elapsed().as_secs_f64() * 1000.0; - - let t = Instant::now(); - let d = synthetic(n, side)?; - rows.push(("build synthetic drawing".into(), ms(t), format!("{n} entities"))); - - // Display list at a 1600 px wide "zoom extents" view (tolerance = half a pixel). - let px = side / 1600.0; - let opts = cadcraft_engine::render::Options { tolerance: px * 0.5, min_dash: px * 2.0, ..Default::default() }; - let t = Instant::now(); - let list = cadcraft_engine::render::build(&d, &Space::Model, &opts); - rows.push(("display list build".into(), ms(t), format!("{} prims, {} segments", list.prims.len(), list.segment_count()))); - - // Hit testing on a zoomed-in view (aperture = 5 px at 0.02 units/px). - let ap = 0.1; - let mut r = Rng(42); - let pts: Vec = (0..1000).map(|_| Vec2::new(r.range(0.0, side), r.range(0.0, side))).collect(); - let t = Instant::now(); - let first = select::pick(&d, &Space::Model, pts.first().copied().unwrap_or(Vec2::ZERO), ap); - rows.push(("first pick (incl. index build)".into(), ms(t), format!("{first:?}"))); - let t = Instant::now(); - let hits = pts.iter().filter(|p| select::pick(&d, &Space::Model, **p, ap).is_some()).count(); - let total = ms(t); - rows.push(("pick x1000".into(), total, format!("{hits} hits, {:.3} ms/pick", total / 1000.0))); - - // One edit, then a pick: only the touched chunk is re-indexed. - let mut edited = d.clone(); - if let Some(h) = edited.model.last().map(|e| e.handle) { - edited.model.modify(h, |e| e.common.layer = "0".into()); - } - let t = Instant::now(); - let _ = select::pick(&edited, &Space::Model, pts.first().copied().unwrap_or(Vec2::ZERO), ap); - rows.push(("pick after one edit (incremental re-index)".into(), ms(t), String::new())); - - let mut sel = 0usize; - let t = Instant::now(); - for k in 0..20 { - let c = Vec2::new(r.range(0.0, side), r.range(0.0, side)); - let half = side * 0.05; - sel += select::select_window(&d, &Space::Model, Bounds2::new(c - Vec2::new(half, half), c + Vec2::new(half, half)), k % 2 == 1).len(); - } - rows.push(("window/crossing select x20 (10% side)".into(), ms(t), format!("{sel} selected"))); - - let t = Instant::now(); - let fence: Vec = (0..4).map(|_| Vec2::new(r.range(0.0, side), r.range(0.0, side))).collect(); - let fsel = select::select_fence(&d, &Space::Model, &fence).len(); - rows.push(("fence select (3 legs)".into(), ms(t), format!("{fsel} selected"))); - - let osmode = snap::mode::END | snap::mode::MID | snap::mode::CEN | snap::mode::QUA | snap::mode::INT; - let t = Instant::now(); - let snaps = pts.iter().filter(|p| snap::osnap(&d, &Space::Model, **p, ap * 2.0, osmode, None, false).is_some()).count(); - let total = ms(t); - rows.push(("osnap x1000".into(), total, format!("{snaps} hits, {:.3} ms/query", total / 1000.0))); - - let t = Instant::now(); - let bytes = cadcraft_io::write(&d, "perf.dxf").map_err(|e| e.to_string())?; - rows.push(("DXF write".into(), ms(t), format!("{:.1} MB", bytes.len() as f64 / 1e6))); - let t = Instant::now(); - let back = cadcraft_io::read(&bytes, "perf.dxf").map_err(|e| e.to_string())?; - rows.push(("DXF read".into(), ms(t), format!("{} entities", back.entity_count()))); - - outln!("{:<40} {:>12} notes", "operation", "ms"); - outln!("{}", "-".repeat(80)); - for (name, t, note) in rows { - outln!("{name:<40} {t:>12.2} {note}"); - } - Ok(()) -} - -/// The backend `cadcraft-cli mcp` serves from. -#[derive(Debug, PartialEq, Eq)] -enum McpTarget { - /// An in-process drawing session (no `--connect`). - Headless, - /// The running app's control channel at `HOST:PORT`; `lazy`: reached at the first call; - /// `launch`: opened then if it isn't running. - Connect { addr: String, lazy: bool, launch: bool }, -} - -/// Parses the arguments after `mcp`. `--connect` must be followed by a `HOST:PORT`; a missing, -/// empty or flag-like value is an error, never a silent fall back to a headless session (#103). -fn parse_mcp_args(args: &[String]) -> Result { - let mut addr: Option = None; - let (mut lazy, mut launch) = (false, false); - let mut it = args.iter(); - while let Some(a) = it.next() { - match a.as_str() { - "--connect" => { - let a = it - .next() - .map(|v| v.trim()) - .filter(|v| !v.is_empty() && !v.starts_with('-')) - .ok_or("--connect needs HOST:PORT (the app's --control port, e.g. 127.0.0.1:7979)")?; - if addr.is_some() { - return Err("--connect given more than once".into()); - } - addr = Some(a.to_string()); - } - "--lazy" => lazy = true, - "--launch" => launch = true, - other => return Err(format!("mcp: unknown argument {other}\n{USAGE}")), - } - } - match addr { - // `--launch` connects at the first call too (the app opens then). - Some(addr) => Ok(McpTarget::Connect { addr, lazy: lazy || launch, launch }), - None if lazy || launch => Err("--lazy and --launch need --connect HOST:PORT".into()), - None => Ok(McpTarget::Headless), - } -} - -fn mcp(args: &[String]) -> Result<(), String> { - let backend: Box = match parse_mcp_args(args)? { - McpTarget::Connect { addr, lazy: true, launch } => Box::new(cadcraft_mcp::Remote::lazy(&addr, launch)), - McpTarget::Connect { addr, .. } => match cadcraft_mcp::Remote::connect(&addr) { - Ok(r) => Box::new(r), - Err(e) => return Err(format!("cadcraft-cli: cannot connect to {addr}: {e}")), - }, - McpTarget::Headless => Box::new(cadcraft_mcp::Headless::default()), - }; - let stdin = std::io::stdin(); - let stdout = std::io::stdout(); - cadcraft_mcp::Server::new(backend).serve(stdin.lock(), stdout.lock()).map_err(|e| e.to_string()) -} - -#[cfg(test)] -mod mcp_args_tests { - use super::*; - - fn args(a: &[&str]) -> Vec { - a.iter().map(|s| s.to_string()).collect() - } - - #[test] - fn mcp_without_connect_is_headless() { - assert_eq!(parse_mcp_args(&args(&[])), Ok(McpTarget::Headless)); - } - - #[test] - fn mcp_connect_with_address_selects_remote() { - let to = |addr: &str, lazy, launch| Ok(McpTarget::Connect { addr: addr.into(), lazy, launch }); - assert_eq!(parse_mcp_args(&args(&["--connect", "127.0.0.1:7979"])), to("127.0.0.1:7979", false, false)); - assert_eq!(parse_mcp_args(&args(&["--connect", "localhost:7979"])), to("localhost:7979", false, false)); - assert_eq!(parse_mcp_args(&args(&["--lazy", "--connect", "localhost:7979"])), to("localhost:7979", true, false)); - assert_eq!(parse_mcp_args(&args(&["--connect", "localhost:7979", "--launch"])), to("localhost:7979", true, true)); - // Without an app to reach they mean nothing: never a headless session. - assert!(parse_mcp_args(&args(&["--lazy"])).is_err()); - assert!(parse_mcp_args(&args(&["--launch"])).is_err()); - } - - #[test] - fn mcp_connect_without_address_is_an_error_not_headless() { - for bad in [&["--connect"][..], &["--connect", ""], &["--connect", " "], &["--connect", "--foo"], &["--connect", "-v"]] { - let r = parse_mcp_args(&args(bad)); - let Err(e) = r else { panic!("{bad:?} should be rejected, got {r:?}") }; - assert!(e.contains("--connect needs HOST:PORT"), "{bad:?}: {e}"); - } - } - - #[test] - fn mcp_rejects_unknown_and_repeated_arguments() { - assert!(parse_mcp_args(&args(&["--conect", "127.0.0.1:7979"])).is_err()); - assert!(parse_mcp_args(&args(&["127.0.0.1:7979"])).is_err()); - assert!(parse_mcp_args(&args(&["--connect", "127.0.0.1:1", "--connect", "127.0.0.1:2"])).is_err()); - } -} - -fn main() -> ExitCode { - let code = cli(); - if STDOUT_ERROR.load(Ordering::Relaxed) { ExitCode::FAILURE } else { code } -} - -fn cli() -> ExitCode { - install_io(); - let args: Vec = std::env::args().skip(1).collect(); - let rest: Vec = args.iter().skip(1).cloned().collect(); - let r = match args.first().map(String::as_str) { - Some("info") => validate_options("info", &rest, NO_OPTIONS).and_then(|_| rest.first().ok_or_else(|| USAGE.to_string())).and_then(|p| info(p)), - Some("convert") => convert(&rest), - Some("run") => run(&rest), - Some("perf") => validate_options("perf", &rest, NO_OPTIONS).and_then(|_| perf(&rest)), - Some("sample") => validate_options("sample", &rest, NO_OPTIONS).and_then(|_| sample(&rest)), - Some("commands") => validate_options("commands", &rest, NO_OPTIONS).map(|_| { - let s = Session::new(); - let f = rest.first().map(|x| x.to_ascii_lowercase()); - let v: Vec = cadcraft_engine::command_specs() - .iter() - .filter(|c| f.as_ref().is_none_or(|f| c.id.contains(f.as_str()) || c.label.to_ascii_lowercase().contains(f.as_str()))) - .map(|c| serde_json::to_value(c.info(&s)).unwrap_or_default()) - .collect(); - outln!("{}", serde_json::to_string_pretty(&v).unwrap_or_default()); - }), - Some("mcp") => mcp(&rest), - Some("--version" | "-V") => { - outln!("cadcraft-cli {}", env!("CARGO_PKG_VERSION")); - Ok(()) - } - Some("--help" | "-h" | "help") => { - outln!("{USAGE}"); - Ok(()) - } - _ => Err(USAGE.into()), - }; - match r { - Ok(()) => ExitCode::SUCCESS, - Err(e) => { - eprintln!("{e}"); - ExitCode::FAILURE - } - } -} - -#[cfg(test)] -mod tests { - use super::*; - - fn scratch_dir(tag: &str) -> std::path::PathBuf { - let dir = std::env::temp_dir().join(format!("cadcraft-cli-{tag}-{}", std::process::id())); - let _ = std::fs::remove_dir_all(&dir); - std::fs::create_dir_all(&dir).expect("create scratch dir"); - dir - } - - #[test] - fn write_atomic_replaces_file_and_leaves_no_staging_files() { - let dir = scratch_dir("replace"); - let out = dir.join("a.dxf"); - let out = out.to_str().expect("utf-8 path"); - write_atomic(out, b"old").expect("create"); - write_atomic(out, b"new").expect("overwrite"); - assert_eq!(std::fs::read(out).expect("read"), b"new"); - assert_eq!(std::fs::read_dir(&dir).expect("list").count(), 1); - let _ = std::fs::remove_dir_all(&dir); - } - - #[test] - fn write_atomic_failure_keeps_destination_and_cleans_up() { - let dir = scratch_dir("fail"); - let out = dir.join("target"); - std::fs::create_dir(&out).expect("dir as destination"); - std::fs::write(out.join("keep"), b"x").expect("seed"); - assert!(write_atomic(out.to_str().expect("utf-8 path"), b"new").is_err()); - assert_eq!(std::fs::read(out.join("keep")).expect("kept"), b"x"); - assert_eq!(std::fs::read_dir(&dir).expect("list").count(), 1); - let _ = std::fs::remove_dir_all(&dir); - } - - fn b(x0: f64, y0: f64, x1: f64, y1: f64) -> Bounds2 { - Bounds2::new(Vec2::new(x0, y0), Vec2::new(x1, y1)) - } - - fn sample_session() -> Session { - let mut s = Session::empty(); - s.open_drawing(cadcraft_engine::sample::default_sample(), "Bracket", None); - s - } - - fn view_box(svg: &str) -> String { - let i = svg.find("viewBox=\"").map(|i| i + 9).unwrap_or(0); - svg[i..].split('"').next().unwrap_or("").to_string() - } - - fn assert_near(a: Bounds2, e: Bounds2) { - let d = (a.min - e.min).len().max((a.max - e.max).len()); - assert!(d < 1e-9, "{a:?} != {e:?}"); - } - - #[test] - fn window_parses() { - assert_eq!(parse_window("0,0,30,20"), Ok(b(0.0, 0.0, 30.0, 20.0))); - assert_eq!(parse_window(" -5.5, -1e3 ,2e3,4 "), Ok(b(-5.5, -1000.0, 2000.0, 4.0))); - } - - #[test] - fn hostile_window_is_an_error() { - for w in [ - "", - "1,2,3", - "1,2,3,4,5", - "a,0,1,1", - "NaN,0,1,1", - "0,0,inf,1", - "0,0,1e400,1", - "0,0,0,1", - "0,0,1,0", - "5,0,1,1", - "0,5,1,1", - "-1e300,-1e300,1e300,1e300", - "0,0,1e-12,1e-12", - ] { - assert!(parse_window(w).is_err(), "`{w}` should be rejected"); - } - } - - #[test] - fn framing_options() { - let parse = |args: &[&str]| -> Result { - let args: Vec = args.iter().map(|a| a.to_string()).collect(); - let mut f = Framing::Auto; - let mut it = args.iter(); - while let Some(a) = it.next() { - assert!(framing_option(a, &mut it, &mut f)?, "{a} is a framing option"); - } - Ok(f) - }; - assert_eq!(parse(&["--view", "extents"]), Ok(Framing::Extents)); - assert_eq!(parse(&["--view", "CURRENT"]), Ok(Framing::Current)); - assert_eq!(parse(&["--window", "0,0,2,1"]), Ok(Framing::Window(b(0.0, 0.0, 2.0, 1.0)))); - assert!(parse(&["--view"]).is_err()); - assert!(parse(&["--view", "selection"]).is_err()); - assert!(parse(&["--window"]).is_err()); - assert!(parse(&["--window", "0,0,2,1", "--view", "extents"]).is_err()); - assert!(check_framed_output(Framing::Extents, Some("a.dxf")).is_err()); - assert!(check_framed_output(Framing::Extents, None).is_err()); - assert!(check_framed_output(Framing::Extents, Some("a.png")).is_ok()); - assert!(check_framed_output(Framing::Auto, Some("a.dxf")).is_ok()); - } - - #[test] - fn last_placeholder_takes_the_previous_handle() { - let mut s = sample_session(); - let r = s.execute("line", &json!({"points": [[0, 0], [10, 0]]})).unwrap(); - let h = returned_handle(&s, &r).expect("LINE returns its handle"); - assert_eq!(fill_last(&json!({"handle": "{last}"}), Some(h)), Ok(json!({"handle": h.hex()}))); - // Nested, as in a selection list. - assert_eq!(fill_last(&json!({"handles": ["{last}", "1"]}), Some(h)), Ok(json!({"handles": [h.hex(), "1"]}))); - // Only the exact token: a name or a sentence that merely contains it stays as written. - for p in [json!("last"), json!("{last} "), json!({"name": "last"})] { - assert_eq!(fill_last(&p, Some(h)), Ok(p.clone())); - } - // Nothing returned yet: an error, not a token passed to the command as a bad handle. - assert!(fill_last(&json!({"handle": "{last}"}), None).unwrap_err().contains("{last}")); - } - - /// Handles are read from a result by looking the strings up in the drawing: counts and names - /// are not mistaken for handles, and `mview`'s `viewports` works like `handle`/`handles`. - #[test] - fn returned_handle_reads_only_real_handles() { - let mut s = Session::empty(); - s.new_drawing(false); - s.execute("layout.set", &json!({"name": "Layout1"})).unwrap(); - let r = s.execute("mview", &json!({"p1": [20, 20], "p2": [200, 150]})).unwrap(); - let h = returned_handle(&s, &r).expect("mview returns its viewport handle"); - assert!(r["viewports"].as_array().is_some_and(|a| a.iter().any(|v| v.as_str() == Some(h.hex().as_str()))), "{r}"); - assert_eq!(returned_handle(&s, &json!({"changed": 3, "name": "A1"})), None); - // The most recent of several. - let a = s.execute("line", &json!({"points": [[0, 0], [1, 0]]})).unwrap(); - let b = s.execute("line", &json!({"points": [[0, 0], [2, 0]]})).unwrap(); - let (ha, hb) = (returned_handle(&s, &a).unwrap(), returned_handle(&s, &b).unwrap()); - assert_eq!(returned_handle(&s, &json!({"handles": [ha.hex(), hb.hex()]})), Some(hb)); - } - - #[test] - fn default_framing_is_extents() { - // convert: nothing ran, always the extents. - let s = sample_session(); - assert_eq!(export_window(&s, Framing::Auto, None), Ok(None)); - // run: commands that leave the view alone keep the extents framing. - let mut s = sample_session(); - let before = model_views(&s); - s.script("LINE 0,0 10,10\n\n").unwrap(); - assert_eq!(export_window(&s, Framing::Auto, Some(&before)), Ok(None)); - // A fresh drawing too. - let mut s = Session::empty(); - s.new_drawing(false); - let before = model_views(&s); - s.execute("circle", &json!({"center": [0, 0], "radius": 5})).unwrap(); - assert_eq!(export_window(&s, Framing::Auto, Some(&before)), Ok(None)); - } - - #[test] - fn zoom_window_frames_export() { - let mut s = sample_session(); - let before = model_views(&s); - s.execute("zoom", &json!({"mode": "window", "p1": [0, 0], "p2": [30, 20]})).unwrap(); - let w = export_window(&s, Framing::Auto, Some(&before)).unwrap().unwrap(); - // The CLI viewport is 3:2, so a 3:2 window is shown exactly. - assert_near(w, b(0.0, 0.0, 30.0, 20.0)); - assert_eq!(export_window(&s, Framing::Current, Some(&before)), Ok(Some(w))); - // --view extents and --window override the zoom. - assert_eq!(export_window(&s, Framing::Extents, Some(&before)), Ok(None)); - let explicit = b(1.0, 1.0, 2.0, 2.0); - assert_eq!(export_window(&s, Framing::Window(explicit), Some(&before)), Ok(Some(explicit))); - // A taller window keeps its height; the 3:2 image adds room left and right. - s.execute("zoom", &json!({"mode": "center", "center": [5, 5], "height": 4})).unwrap(); - assert_near(export_window(&s, Framing::Auto, Some(&before)).unwrap().unwrap(), b(2.0, 3.0, 8.0, 7.0)); - } - - #[test] - fn zoom_object_frames_the_selection() { - let mut s = sample_session(); - let before = model_views(&s); - // The smallest entity with an area, selected then framed with ZOOM Object. - let d = s.doc().unwrap(); - let bounds = |e: &cadcraft_engine::doc::Entity| cadcraft_engine::doc::entity_bounds(d, e, 0); - let e = d - .model - .iter() - .filter(|e| bounds(e).width() > 0.0 && bounds(e).height() > 0.0) - .min_by(|a, b| bounds(a).width().total_cmp(&bounds(b).width())) - .unwrap(); - let (h, eb, ext) = (e.handle, bounds(e), d.extents(&Space::Model)); - s.set_selection(vec![h]); - s.execute("zoom", &json!({"mode": "object"})).unwrap(); - let w = export_window(&s, Framing::Auto, Some(&before)).unwrap().unwrap(); - assert!(w.contains(eb.min) && w.contains(eb.max)); - assert!(w.width() < ext.width() && w.height() < ext.height(), "{w:?} vs extents {ext:?}"); - } - - #[test] - fn run_export_honours_zoom() { - let dir = std::env::temp_dir().join(format!("cadcraft-cli-165-{}", std::process::id())); - std::fs::create_dir_all(&dir).unwrap(); - let path = |n: &str| dir.join(n).to_string_lossy().to_string(); - let run_svg = |extra: &[&str], out: &str| -> String { - let mut args: Vec = ["--sample"].iter().chain(extra).map(|a| a.to_string()).collect(); - args.extend(["--export".to_string(), path(out)]); - run(&args).unwrap(); - std::fs::read_to_string(path(out)).unwrap() - }; - let base = run_svg(&[], "base.svg"); - let zoomed = run_svg(&["--cmd", r#"zoom {"mode":"window","p1":[0,0],"p2":[30,20]}"#], "zoom.svg"); - let window = run_svg(&["--window", "0,0,30,20"], "window.svg"); - let forced = run_svg(&["--cmd", r#"zoom {"mode":"window","p1":[0,0],"p2":[30,20]}"#, "--view", "extents"], "forced.svg"); - assert_ne!(view_box(&zoomed), view_box(&base)); - assert_eq!(view_box(&zoomed), "0 0 30.000000 20.000000"); - assert_eq!(zoomed, window); - assert_eq!(forced, base); - // Hostile --window: a clear error, nothing written. - let bad: Vec = ["--sample", "--window", "0,0,NaN,1", "--export", &path("bad.png")].iter().map(|a| a.to_string()).collect(); - assert!(run(&bad).unwrap_err().contains("--window")); - assert!(!dir.join("bad.png").exists()); - let _ = std::fs::remove_dir_all(&dir); - } - - fn args(values: &[&str]) -> Vec { - values.iter().map(|value| (*value).into()).collect() - } - - #[test] - fn validators_accept_only_the_documented_options() { - assert!(validate_options("info", &args(&["file.dxf"]), NO_OPTIONS).is_ok()); - assert!(validate_options("perf", &args(&["100"]), NO_OPTIONS).is_ok()); - assert!(validate_options("sample", &args(&["bracket", "out.dxf"]), NO_OPTIONS).is_ok()); - assert!(validate_options("commands", &args(&["line"]), NO_OPTIONS).is_ok()); - for (command, specs) in [("info", NO_OPTIONS), ("perf", NO_OPTIONS), ("sample", NO_OPTIONS), ("commands", NO_OPTIONS)] { - assert!(validate_options(command, &args(&["--typo"]), specs).is_err()); - } - } - - #[test] - fn unknown_options_are_rejected_before_side_effects() { - assert_eq!(validate_options("info", &args(&["missing.dxf", "--typo"]), NO_OPTIONS), Err("info: unknown option --typo".into())); - assert_eq!(validate_options("perf", &args(&["1", "--typo"]), NO_OPTIONS), Err("perf: unknown option --typo".into())); - assert_eq!(validate_options("sample", &args(&["bracket", "out.dxf", "--typo"]), NO_OPTIONS), Err("sample: unknown option --typo".into())); - } +fn main() { + // `args_os`, not `args`: a non-Unicode argument (a Latin-1 file name on Linux) must be + // reported as an error, not panic before anything is printed. + let code = cadcraft_cli::run(std::env::args_os().skip(1), &mut std::io::stdout(), &mut std::io::stderr()); + std::process::exit(code); } diff --git a/apps/cadcraft-cli/src/mcp.rs b/apps/cadcraft-cli/src/mcp.rs new file mode 100644 index 000000000..960c80a5e --- /dev/null +++ b/apps/cadcraft-cli/src/mcp.rs @@ -0,0 +1,17 @@ +use super::args::{McpArgs, McpTarget}; +use super::error::{CliError, Result}; + +pub(crate) fn mcp(a: &McpArgs) -> Result { + let backend: Box = match a.target() { + McpTarget::Connect { addr, lazy: true, launch } => Box::new(cadcraft_mcp::Remote::lazy(&addr, launch)), + McpTarget::Connect { addr, .. } => match cadcraft_mcp::Remote::connect(&addr) { + Ok(r) => Box::new(r), + Err(source) => return Err(CliError::McpConnect { addr, source }), + }, + McpTarget::Headless => Box::new(cadcraft_mcp::Headless::default()), + }; + let stdin = std::io::stdin(); + let stdout = std::io::stdout(); + cadcraft_mcp::Server::new(backend).serve(stdin.lock(), stdout.lock())?; + Ok(()) +} diff --git a/apps/cadcraft-cli/src/output.rs b/apps/cadcraft-cli/src/output.rs new file mode 100644 index 000000000..d783267dc --- /dev/null +++ b/apps/cadcraft-cli/src/output.rs @@ -0,0 +1,177 @@ +use super::args::Framing; +use super::error::Result; +use cadcraft_engine::doc::Space; +use cadcraft_engine::geom::{Bounds2, Vec2}; +use cadcraft_engine::{Session, View}; +use std::io::Write; +use std::path::{Path, PathBuf}; + +/// The process's output streams. A write to stdout that fails never stops the program: once +/// stdout has failed, later output is dropped and the work goes on, so the rest of `run` (later +/// `--cmd` results, `--save`, `--export`) still happens and `cadcraft-cli run … --save out.dxf | +/// head` keeps the drawing. A reader that stopped early (a closed pipe, `cadcraft-cli commands | +/// head`) is not an error, as in ripgrep; any other write error is reported once on stderr and +/// makes the exit status 1. +pub(crate) struct Streams<'a> { + out: &'a mut dyn Write, + err: &'a mut dyn Write, + /// Set once a write to `out` has failed; later output is dropped. + gone: bool, + /// Set when `out` failed for a reason other than a closed reader. + failed: bool, +} + +impl<'a> Streams<'a> { + pub(crate) fn new(out: &'a mut dyn Write, err: &'a mut dyn Write) -> Self { + Streams { out, err, gone: false, failed: false } + } + + /// Write a line to stdout. + pub(crate) fn outln(&mut self, args: std::fmt::Arguments) { + if !self.gone + && let Err(e) = writeln!(self.out, "{args}") + { + self.out_failed(e); + } + } + + /// Write `v` to stdout: pretty-printed, or on one line with `compact` (`--compact`). + pub(crate) fn json(&mut self, v: &serde_json::Value, compact: bool) { + if compact { + self.outln(format_args!("{v}")); + } else { + self.outln(format_args!("{v:#}")); + } + } + + /// Write a line to stderr. A failing stderr has nowhere to report to, so it is ignored. + pub(crate) fn errln(&mut self, args: std::fmt::Arguments) { + let _ = writeln!(self.err, "{args}"); + } + + /// Flush stdout (a pipe that closed during buffered output surfaces here). + pub(crate) fn finish(&mut self) { + if !self.gone + && let Err(e) = self.out.flush() + { + self.out_failed(e); + } + } + + /// Whether stdout failed for a reason other than a closed reader: the exit status is 1. + pub(crate) fn stdout_failed(&self) -> bool { + self.failed + } + + fn out_failed(&mut self, e: std::io::Error) { + if std::mem::replace(&mut self.gone, true) || e.kind() == std::io::ErrorKind::BrokenPipe { + return; + } + self.errln(format_args!("cadcraft-cli: can't write to stdout: {e}")); + self.failed = true; + } +} + +/// Why writing or framing an output failed. +#[derive(Debug, thiserror::Error)] +pub(crate) enum OutputError { + #[error("--view current: the drawing has no model-space view")] + NoModelView, + #[error("{}: {source}", path.display())] + Write { path: PathBuf, source: std::io::Error }, +} + +/// The model-space view of every open drawing, by drawing id (to tell whether commands changed it). +pub(crate) fn model_views(s: &Session) -> Vec<(u64, Option)> { + s.docs.iter().map(|st| (st.uid, st.views.iter().find(|(sp, _)| *sp == Space::Model).map(|(_, v)| *v))).collect() +} + +/// The active drawing's current model-space view as a rectangle with the viewport's aspect ratio +/// (the CLI viewport is 3:2 like the PNG export, so the image shows exactly this view). +fn current_window(s: &Session) -> Option { + let st = s.state().ok()?; + let v = st.views.iter().find(|(sp, _)| *sp == Space::Model).map(|(_, v)| *v)?; + let (w, h) = s.viewport_px; + let half = Vec2::new(v.height * w / h.max(1.0), v.height) * 0.5; + Some(Bounds2::new(v.center - half, v.center + half)) +} + +/// The window an image export shows, or `None` to fit the extents. `before` is [`model_views`] +/// taken before the commands ran (`None` for `convert`, where nothing ran). +pub(crate) fn export_window(s: &Session, framing: Framing, before: Option<&[(u64, Option)]>) -> Result, OutputError> { + match framing { + Framing::Window(w) => Ok(Some(w)), + Framing::Extents => Ok(None), + Framing::Current => current_window(s).map(Some).ok_or(OutputError::NoModelView), + Framing::Auto => { + let Some(before) = before else { return Ok(None) }; + let Ok(st) = s.state() else { return Ok(None) }; + let now = model_views(s); + let was = before.iter().find(|(uid, _)| *uid == st.uid); + let is = now.iter().find(|(uid, _)| *uid == st.uid); + // Only a view the commands changed counts; a drawing opened by the commands keeps + // the extents framing. + match (was, is) { + (Some(a), Some(b)) if a.1 != b.1 => Ok(current_window(s)), + _ => Ok(None), + } + } + } +} + +/// Write `bytes` to `out` through the engine's atomic writer (an exclusively created sibling file +/// renamed over `out`), so a failed or interrupted write leaves the previous file untouched. An +/// existing `out` is resolved first: the rename would otherwise replace a symlink with a file and +/// leave the file it points to (`--in-place` through a link) unchanged. +pub(crate) fn write_atomic(out: &Path, bytes: &[u8]) -> Result<(), OutputError> { + let target = std::fs::canonicalize(out).unwrap_or_else(|_| out.to_path_buf()); + cadcraft_engine::atomic_write::write_atomic(&target, bytes).map_err(|source| OutputError::Write { path: out.to_path_buf(), source }) +} + +pub(crate) fn export(s: &Session, out: &Path, io: &mut Streams) -> Result { + export_framed(s, out, None, io) +} + +pub(crate) fn export_framed(s: &Session, out: &Path, window: Option, io: &mut Streams) -> Result { + let d = s.doc()?; + let bytes = cadcraft_io::write_framed(d, out, window)?; + write_atomic(out, &bytes)?; + io.errln(format_args!("wrote {} ({} bytes)", out.display(), bytes.len())); + if cadcraft_engine::cmd::file::drops_unknown(out) { + let lost = cadcraft_engine::cmd::file::not_saved(d); + if let Some(m) = cadcraft_engine::cmd::file::not_saved_message(&lost) { + io.errln(format_args!("{m}")); + } + } + Ok(()) +} + +/// The warning for the model-space entities of `path` an image can't show, by type (those kept +/// as unknown objects, `Proxy` in `info`), or `None` when there are none. +pub(crate) fn undrawn_message(d: &cadcraft_engine::doc::Drawing, path: &str) -> Option { + let mut types: std::collections::BTreeMap<&str, usize> = std::collections::BTreeMap::new(); + for e in d.model.iter() { + if let cadcraft_engine::doc::EntityKind::Unknown(u) = &e.kind { + let n = types.entry(u.dxf_type.as_str()).or_insert(0); + *n = n.saturating_add(1); + } + } + let n = types.values().fold(0usize, |a, n| a.saturating_add(*n)); + if n == 0 { + return None; + } + let list: Vec = types.iter().map(|(t, n)| format!("{t}: {n}")).collect(); + let entities = if n == 1 { "entity" } else { "entities" }; + Some(format!("{path}: {n} {entities} not drawn ({})", list.join(", "))) +} + +/// The warning for the records of `path` the reader could not place, or `None` when there are none. +pub(crate) fn skipped_message(d: &cadcraft_engine::doc::Drawing, path: &str) -> Option { + let n = d.skipped_records.values().fold(0usize, |a, n| a.saturating_add(*n)); + if n == 0 { + return None; + } + let list: Vec = d.skipped_records.iter().map(|(section, n)| format!("{section}: {n}")).collect(); + let records = if n == 1 { "record" } else { "records" }; + Some(format!("{path}: {n} {records} could not be read and are left out ({})", list.join(", "))) +} diff --git a/apps/cadcraft-cli/src/perf.rs b/apps/cadcraft-cli/src/perf.rs new file mode 100644 index 000000000..e52b6107b --- /dev/null +++ b/apps/cadcraft-cli/src/perf.rs @@ -0,0 +1,196 @@ +use super::args::PerfTarget; +use super::error::Result; +use super::open; +use super::output::Streams; +use cadcraft_engine::Session; + +/// Why `perf` cannot run. +#[derive(Debug, thiserror::Error)] +pub(crate) enum PerfError { + #[error("perf: the drawing is empty")] + EmptyDrawing, +} + +/// Small deterministic generator (xorshift64*) so perf runs are repeatable without a dependency. +struct Rng(u64); + +impl Rng { + fn next(&mut self) -> f64 { + self.0 ^= self.0 >> 12; + self.0 ^= self.0 << 25; + self.0 ^= self.0 >> 27; + (self.0.wrapping_mul(0x2545_F491_4F6C_DD1D) >> 11) as f64 / (1u64 << 53) as f64 + } + fn range(&mut self, lo: f64, hi: f64) -> f64 { + lo + (hi - lo) * self.next() + } +} + +/// A synthetic drawing with `n` mixed entities (lines, circles, arcs, polylines, text) spread +/// over a square whose side grows with sqrt(n), so density stays constant. +fn synthetic(n: usize, side: f64) -> Result { + use cadcraft_engine::doc::{self as d, Common, EntityKind, Space}; + use cadcraft_engine::geom::{PolyVertex, Vec2, Vec3}; + let mut dr = d::Drawing::new_imperial(); + let mut r = Rng(0x9E37_79B9_7F4A_7C15); + let v3 = |x: f64, y: f64| Vec3::new(x, y, 0.0); + for i in 0..n { + let (x, y) = (r.range(0.0, side), r.range(0.0, side)); + let s = r.range(0.5, 8.0); + let kind = match i % 5 { + 0 => EntityKind::Line(d::Line { a: v3(x, y), b: v3(x + r.range(-s, s), y + r.range(-s, s)) }), + 1 => EntityKind::Circle(d::Circle { center: v3(x, y), radius: s * 0.5 }), + 2 => EntityKind::Arc(d::Arc { center: v3(x, y), radius: s * 0.5, start: r.range(0.0, 3.0), end: r.range(3.2, 6.2) }), + 3 => EntityKind::LwPolyline(d::LwPolyline { + vertices: (0..6) + .map(|k| PolyVertex { + p: Vec2::new(x + f64::from(k) * s * 0.3, y + r.range(-s, s) * 0.3), + bulge: if k == 2 { 0.4 } else { 0.0 }, + start_width: 0.0, + end_width: 0.0, + }) + .collect(), + closed: i % 2 == 0, + const_width: 0.0, + elevation: 0.0, + plinegen: false, + }), + _ => EntityKind::Text(d::Text { + insert: v3(x, y), + align_pt: None, + height: s * 0.2, + value: format!("T{i}"), + rotation: 0.0, + width_factor: 1.0, + oblique: 0.0, + style: "Standard".into(), + halign: d::HAlign::Left, + valign: d::VAlign::Baseline, + }), + }; + dr.add(&Space::Model, Common::default(), kind)?; + } + Ok(dr) +} + +/// `perf FILE`: the display list built as the canvas builds it (a 1600 x 1000 px view at the +/// drawing's centre: tolerance, dash level of detail and view window from the zoom band), at +/// zoom extents and zoomed in 4x at a time, next to the full-detail build plots use. +fn perf_file(path: &std::path::Path, io: &mut Streams) -> Result { + use cadcraft_engine::geom::{Bounds2, Vec2}; + use cadcraft_engine::render::{Options, build}; + use std::time::Instant; + let ms = |t: Instant| t.elapsed().as_secs_f64() * 1000.0; + let mut s = Session::empty(); + let t = Instant::now(); + open(&mut s, path)?; + let open_ms = ms(t); + let st = s.state()?; + let (d, space) = (&st.doc, &st.space); + let ext = d.extents(space); + let size = ext.width().max(ext.height()); + if ext.is_empty() || !(size.is_finite() && size > 0.0) { + return Err(PerfError::EmptyDrawing.into()); + } + io.outln(format_args!("open {open_ms:.0} ms, {} entities, extents {:.1} x {:.1}", d.entity_count(), ext.width(), ext.height())); + io.outln(format_args!("{:>8} {:>10} {:>10}", "zoom", "build ms", "prims")); + let mut finest = Options::default(); + for k in 0..5 { + let zoom = 4f64.powi(k); + let h = size / zoom; + let pixel = 2f64.powi((h / 1000.0).max(1e-300).log2().floor() as i32); + let half = Vec2::new(h * 0.8, h * 0.5); + let visible = Bounds2::new(ext.center() - half, ext.center() + half); + let screen = Options { tolerance: pixel * 0.5, min_dash: pixel * 2.0, view: Some(visible.expand(h * 0.8)), ..Default::default() }; + let t = Instant::now(); + let n = build(d, space, &screen).prims.len(); + io.outln(format_args!("{:>7}x {:>10.1} {n:>10}", zoom, ms(t))); + finest = screen; + } + // Plots: every pattern line, everywhere (last, so its large list doesn't weigh on the above). + let t = Instant::now(); + let n = build(d, space, &Options { min_dash: 0.0, view: None, ..finest }).prims.len(); + io.outln(format_args!("{:>8} {:>10.1} {n:>10}", "full", ms(t))); + Ok(()) +} + +pub(crate) fn perf(target: Option<&PerfTarget>, io: &mut Streams) -> Result { + use cadcraft_engine::doc::Space; + use cadcraft_engine::geom::{Bounds2, Vec2}; + use cadcraft_engine::{select, snap}; + use std::time::Instant; + let n = match target { + Some(PerfTarget::File(path)) => return perf_file(path, io), + Some(PerfTarget::Count(n)) => *n, + None => 200_000, + }; + let side = (n as f64).sqrt() * 10.0; + let mut rows: Vec<(String, f64, String)> = Vec::new(); + let ms = |t: Instant| t.elapsed().as_secs_f64() * 1000.0; + + let t = Instant::now(); + let d = synthetic(n, side)?; + rows.push(("build synthetic drawing".into(), ms(t), format!("{n} entities"))); + + // Display list at a 1600 px wide "zoom extents" view (tolerance = half a pixel). + let px = side / 1600.0; + let opts = cadcraft_engine::render::Options { tolerance: px * 0.5, min_dash: px * 2.0, ..Default::default() }; + let t = Instant::now(); + let list = cadcraft_engine::render::build(&d, &Space::Model, &opts); + rows.push(("display list build".into(), ms(t), format!("{} prims, {} segments", list.prims.len(), list.segment_count()))); + + // Hit testing on a zoomed-in view (aperture = 5 px at 0.02 units/px). + let ap = 0.1; + let mut r = Rng(42); + let pts: Vec = (0..1000).map(|_| Vec2::new(r.range(0.0, side), r.range(0.0, side))).collect(); + let t = Instant::now(); + let first = select::pick(&d, &Space::Model, pts.first().copied().unwrap_or(Vec2::ZERO), ap); + rows.push(("first pick (incl. index build)".into(), ms(t), format!("{first:?}"))); + let t = Instant::now(); + let hits = pts.iter().filter(|p| select::pick(&d, &Space::Model, **p, ap).is_some()).count(); + let total = ms(t); + rows.push(("pick x1000".into(), total, format!("{hits} hits, {:.3} ms/pick", total / 1000.0))); + + // One edit, then a pick: only the touched chunk is re-indexed. + let mut edited = d.clone(); + if let Some(h) = edited.model.last().map(|e| e.handle) { + edited.model.modify(h, |e| e.common.layer = "0".into()); + } + let t = Instant::now(); + let _ = select::pick(&edited, &Space::Model, pts.first().copied().unwrap_or(Vec2::ZERO), ap); + rows.push(("pick after one edit (incremental re-index)".into(), ms(t), String::new())); + + let mut sel = 0usize; + let t = Instant::now(); + for k in 0..20 { + let c = Vec2::new(r.range(0.0, side), r.range(0.0, side)); + let half = side * 0.05; + sel += select::select_window(&d, &Space::Model, Bounds2::new(c - Vec2::new(half, half), c + Vec2::new(half, half)), k % 2 == 1).len(); + } + rows.push(("window/crossing select x20 (10% side)".into(), ms(t), format!("{sel} selected"))); + + let t = Instant::now(); + let fence: Vec = (0..4).map(|_| Vec2::new(r.range(0.0, side), r.range(0.0, side))).collect(); + let fsel = select::select_fence(&d, &Space::Model, &fence).len(); + rows.push(("fence select (3 legs)".into(), ms(t), format!("{fsel} selected"))); + + let osmode = snap::mode::END | snap::mode::MID | snap::mode::CEN | snap::mode::QUA | snap::mode::INT; + let t = Instant::now(); + let snaps = pts.iter().filter(|p| snap::osnap(&d, &Space::Model, **p, ap * 2.0, osmode, None, false).is_some()).count(); + let total = ms(t); + rows.push(("osnap x1000".into(), total, format!("{snaps} hits, {:.3} ms/query", total / 1000.0))); + + let t = Instant::now(); + let bytes = cadcraft_io::write(&d, "perf.dxf")?; + rows.push(("DXF write".into(), ms(t), format!("{:.1} MB", bytes.len() as f64 / 1e6))); + let t = Instant::now(); + let back = cadcraft_io::read(&bytes, "perf.dxf")?; + rows.push(("DXF read".into(), ms(t), format!("{} entities", back.entity_count()))); + + io.outln(format_args!("{:<40} {:>12} notes", "operation", "ms")); + io.outln(format_args!("{}", "-".repeat(80))); + for (name, t, note) in rows { + io.outln(format_args!("{name:<40} {t:>12.2} {note}")); + } + Ok(()) +} diff --git a/apps/cadcraft-cli/src/run.rs b/apps/cadcraft-cli/src/run.rs new file mode 100644 index 000000000..56b4626e2 --- /dev/null +++ b/apps/cadcraft-cli/src/run.rs @@ -0,0 +1,223 @@ +use super::args::{CmdStep, Drawing, RunArgs, Step}; +use super::error::Result; +use super::open; +use super::output::{Streams, export, export_framed, export_window, model_views}; +use cadcraft_engine::Session; +use cadcraft_engine::doc::Handle; +use serde_json::Value; + +/// A `--cmd` parameter value of exactly `{last}` is filled in with the last object handle an +/// earlier `--cmd` in the same run returned: `mview` answers `{"viewports":["100"]}`, so +/// `viewport.set {"handle":"{last}","scale":1}` changes viewport 100. Any other string is passed +/// through unchanged, and `--script` text is never rewritten. +const LAST_HANDLE: &str = "{last}"; + +/// Why a `run` step fails. +#[derive(Debug, thiserror::Error)] +pub(crate) enum RunError { + #[error("{}: {source}", .path.display())] + ReadScript { path: std::path::PathBuf, source: std::io::Error }, + #[error("--cmd {id}: {source}")] + CmdLast { id: String, source: NoLastHandle }, +} + +/// A `{last}` placeholder with no handle to fill in. +#[derive(Debug, PartialEq, thiserror::Error)] +#[error("`{{last}}` needs an earlier --cmd in this run to have returned a handle")] +pub(crate) struct NoLastHandle; + +/// How deep [`result_handles`] walks a command result (results are the engine's own JSON). +const RESULT_DEPTH: usize = 16; + +/// Result keys whose values are object references: the engine's result convention for handles. +/// A handle can be a string (`handle`, `viewport`, `insert`…) or a list of them (`handles`, +/// `viewports`, `members`…). Every other field may hold a user-defined name, a message or a +/// count, and is never read as a handle — a group named `100` is a name, not object `100`. +fn handle_field(key: &str) -> bool { + matches!( + key, + "handle" + | "handles" + | "viewport" + | "viewports" + | "boundary" + | "clip" + | "insert" + | "members" + | "source" + | "objects" + | "entities" + | "selection" + | "parts" + | "refs" + | "matches" + | "line" + | "arc" + | "blocks" + ) +} + +/// Collect the handles of `v`, a value under a handle field: a handle string, an array of them, +/// or objects that carry handle fields of their own (`entities`, `parts`). +fn collect_result_handles(s: &Session, v: &Value, depth: usize, out: &mut Vec) { + if depth > RESULT_DEPTH { + return; + } + match v { + Value::String(t) => { + if let Some(h) = Handle::parse_hex(t) + && s.doc().is_ok_and(|d| d.entity(h).is_some()) + { + out.push(h); + } + } + Value::Array(a) => a.iter().for_each(|x| collect_result_handles(s, x, depth + 1, out)), + Value::Object(m) => { + for (k, x) in m { + if handle_field(k) { + collect_result_handles(s, x, depth + 1, out); + } else { + find_result_handles(s, x, depth + 1, out); + } + } + } + _ => {} + } +} + +/// Find handle fields nested in containers that are not handles themselves (`groups` in +/// `groups.list`, whose members are handles): strings here are names, never references. +fn find_result_handles(s: &Session, v: &Value, depth: usize, out: &mut Vec) { + if depth > RESULT_DEPTH { + return; + } + match v { + Value::Array(a) => a.iter().for_each(|x| find_result_handles(s, x, depth + 1, out)), + Value::Object(m) => { + for (k, x) in m { + if handle_field(k) { + collect_result_handles(s, x, depth + 1, out); + } else { + find_result_handles(s, x, depth + 1, out); + } + } + } + _ => {} + } +} + +/// The object handles a command result mentions, in the order it lists them. A handle-only result +/// (a handle string or an array of them) counts as it is; otherwise only handle fields do. +fn result_handles(s: &Session, v: &Value, depth: usize, out: &mut Vec) { + match v { + Value::String(_) => collect_result_handles(s, v, depth, out), + Value::Array(a) if a.iter().all(Value::is_string) => collect_result_handles(s, v, depth, out), + Value::Array(_) | Value::Object(_) => find_result_handles(s, v, depth, out), + _ => {} + } +} + +/// The last handle `r` returned: what a later `{last}` stands for. +pub(crate) fn returned_handle(s: &Session, r: &Value) -> Option { + let mut hs = Vec::new(); + result_handles(s, r, 0, &mut hs); + hs.last().copied() +} + +/// The active drawing's identity ([`cadcraft_engine::DocState::uid`]): a handle is only meaningful +/// in the drawing it came from, and `new`, `open`, `document.switch` and `close` can make another +/// drawing current. +fn active_drawing(s: &Session) -> Option { + s.docs.get(s.active).map(|st| st.uid) +} + +/// Every `{last}` in `p`, at any depth, replaced by `h`. With no handle to fill in it is an +/// error, never a token reaching the command as a (bad) handle. +pub(crate) fn fill_last(p: &Value, h: Option) -> Result { + match p { + Value::String(t) if t.as_str() == LAST_HANDLE => match h { + Some(h) => Ok(Value::String(h.hex())), + None => Err(NoLastHandle), + }, + Value::Array(a) => a.iter().map(|x| fill_last(x, h)).collect::, _>>().map(Value::Array), + Value::Object(m) => { + m.iter().map(|(k, x)| Ok((k.clone(), fill_last(x, h)?))).collect::, _>>().map(Value::Object) + } + other => Ok(other.clone()), + } +} + +/// A step ready to run: script text, or a command. +enum Ready<'a> { + Script(String), + Cmd(&'a CmdStep), +} + +pub(crate) fn run_cmds(a: &RunArgs, io: &mut Streams) -> Result { + let framing = a.framing.framing(); + let (save, export_to) = (a.save.as_deref(), a.export.as_deref()); + let mut s = Session::empty(); + for d in &a.drawings { + match d { + Drawing::File(f) => open(&mut s, f)?, + Drawing::Sample => { + s.open_drawing(cadcraft_engine::sample::default_sample(), "Bracket", None); + } + Drawing::Metric => { + s.new_drawing(true); + } + } + } + let mut steps: Vec = Vec::new(); + for step in &a.steps { + steps.push(match step { + Step::Script(text) => Ready::Script(text.replace("\\n", "\n")), + Step::ScriptFile(p) => Ready::Script(std::fs::read_to_string(p).map_err(|source| RunError::ReadScript { path: p.clone(), source })?), + Step::Cmd(c) => Ready::Cmd(c), + }); + } + if s.docs.is_empty() { + s.new_drawing(false); + } + let before = model_views(&s); + let mut last_handle: Option = None; + for step in steps { + // A handle belongs to the drawing that returned it: if this step makes another drawing + // current (`new`, `open`, `document.switch`, `close`, or a script running one of them), + // the remembered handle is stale. A handle the step itself returns is taken afterwards, + // so it is a handle of the drawing it made current. + let drawing = active_drawing(&s); + match step { + Ready::Script(body) => { + s.script(&body)?; + if active_drawing(&s) != drawing { + last_handle = None; + } + } + Ready::Cmd(CmdStep { id, params }) => { + let params = fill_last(params, last_handle).map_err(|source| RunError::CmdLast { id: id.clone(), source })?; + let r = s.execute(id, ¶ms)?; + if active_drawing(&s) != drawing { + last_handle = None; + } + if let Some(h) = returned_handle(&s, &r) { + last_handle = Some(h); + } + if !r.is_null() { + io.outln(format_args!("{r}")); + } + } + } + } + for l in &s.log { + io.errln(format_args!("{l}")); + } + if let Some(p) = save { + export(&s, p, io)?; + } + if let Some(p) = export_to { + let window = if cadcraft_io::is_image(p) { export_window(&s, framing, Some(&before))? } else { None }; + export_framed(&s, p, window, io)?; + } + Ok(()) +} diff --git a/apps/cadcraft-cli/src/sample.rs b/apps/cadcraft-cli/src/sample.rs new file mode 100644 index 000000000..9b6405cb5 --- /dev/null +++ b/apps/cadcraft-cli/src/sample.rs @@ -0,0 +1,14 @@ +use super::args::{SampleArgs, SampleName}; +use super::error::Result; +use super::output::{Streams, write_atomic}; + +pub(crate) fn sample(a: &SampleArgs, io: &mut Streams) -> Result { + let d = match a.name { + SampleName::Bracket => cadcraft_engine::sample::bracket(), + SampleName::Floorplan => cadcraft_engine::sample::floor_plan(), + }; + let bytes = cadcraft_io::write(&d, &a.output)?; + write_atomic(&a.output, &bytes)?; + io.errln(format_args!("wrote {} ({} bytes)", a.output.display(), bytes.len())); + Ok(()) +} diff --git a/apps/cadcraft-cli/tests/it/help.rs b/apps/cadcraft-cli/tests/it/help.rs index 24df988af..65f8bad97 100644 --- a/apps/cadcraft-cli/tests/it/help.rs +++ b/apps/cadcraft-cli/tests/it/help.rs @@ -1,23 +1,23 @@ //! `--help` is a request, not a failure (#1525): it goes to stdout with exit 0, like `--version`. -//! Bare `cadcraft-cli` keeps reporting on stderr with exit 1. +//! Bare `cadcraft-cli` is a usage error: the help on stderr, exit 2. use std::process::Command; #[test] -fn help_flags_print_usage_to_stdout_and_exit_zero() { +fn help_flags_print_help_to_stdout_and_exit_zero() { for args in [&["--help"][..], &["-h"], &["help"]] { let out = Command::new(env!("CARGO_BIN_EXE_cadcraft-cli")).args(args).output().expect("run cadcraft-cli"); assert!(out.status.success(), "{args:?}: {:?}", out.status); let stdout = String::from_utf8_lossy(&out.stdout); - assert!(stdout.starts_with("usage:"), "{args:?}: {stdout:?}"); + assert!(stdout.starts_with("cadcraft-cli: headless CADCraft\n"), "{args:?}: {stdout:?}"); assert!(String::from_utf8_lossy(&out.stderr).is_empty(), "{args:?}: stderr should be empty"); } } #[test] -fn bare_invocation_still_reports_on_stderr() { +fn bare_invocation_reports_on_stderr() { let out = Command::new(env!("CARGO_BIN_EXE_cadcraft-cli")).output().expect("run cadcraft-cli"); - assert_eq!(out.status.code(), Some(1)); - assert!(out.stdout.is_empty(), "bare invocation keeps its usage on stderr"); - assert!(String::from_utf8_lossy(&out.stderr).starts_with("usage:")); + assert_eq!(out.status.code(), Some(2)); + assert!(out.stdout.is_empty(), "bare invocation keeps its help on stderr"); + assert!(String::from_utf8_lossy(&out.stderr).starts_with("cadcraft-cli: headless CADCraft\n")); } diff --git a/apps/cadcraft-cli/tests/it/main.rs b/apps/cadcraft-cli/tests/it/main.rs index efd49c7dd..adb3f3749 100644 --- a/apps/cadcraft-cli/tests/it/main.rs +++ b/apps/cadcraft-cli/tests/it/main.rs @@ -4,3 +4,4 @@ mod help; mod mcp_connect; mod skipped_records; mod undrawn_entities; +mod usage; diff --git a/apps/cadcraft-cli/tests/it/mcp_connect.rs b/apps/cadcraft-cli/tests/it/mcp_connect.rs index c12e71c82..4211f3595 100644 --- a/apps/cadcraft-cli/tests/it/mcp_connect.rs +++ b/apps/cadcraft-cli/tests/it/mcp_connect.rs @@ -33,12 +33,15 @@ fn replies(out: &Output) -> Vec { #[test] fn connect_without_address_fails_before_serving() { let input = format!("{INIT}\n{CIRCLE}\n"); - for args in [&["--connect"][..], &["--connect", ""], &["--connect", "--foo"]] { + // clap names an unknown flag rather than the value it left missing. + for (args, named) in + [(&["--connect"][..], "--connect "), (&["--connect", ""], "--connect "), (&["--connect", "--foo"], "'--foo'")] + { let out = mcp(args, &input); - assert!(!out.status.success(), "{args:?} must exit non-zero"); + assert_eq!(out.status.code(), Some(2), "{args:?} is a usage error"); assert!(out.stdout.is_empty(), "{args:?} must not answer MCP requests: {}", String::from_utf8_lossy(&out.stdout)); let err = String::from_utf8_lossy(&out.stderr); - assert!(err.contains("--connect needs HOST:PORT"), "{args:?}: {err}"); + assert!(err.contains(named), "{args:?}: {err}"); } } diff --git a/apps/cadcraft-cli/tests/it/usage.rs b/apps/cadcraft-cli/tests/it/usage.rs new file mode 100644 index 000000000..2e9f6e907 --- /dev/null +++ b/apps/cadcraft-cli/tests/it/usage.rs @@ -0,0 +1,950 @@ +//! The command line's behaviour: exit codes, streams and messages for help requests, unknown and +//! malformed options, value flags in both spellings, repeats and arity. Every case goes through +//! `invoke`, so the table rows are the record of what each input does. Usage errors are clap's +//! (exit 2, stderr); a subcommand's own failures are `error: …` with exit 1. + +use std::path::{Path, PathBuf}; + +struct Invoke { + code: i32, + stdout: String, + stderr: String, +} + +fn invoke(args: &[&str]) -> Invoke { + let (mut out, mut err) = (Vec::new(), Vec::new()); + let code = cadcraft_cli::run(args, &mut out, &mut err); + Invoke { code, stdout: String::from_utf8_lossy(&out).into_owned(), stderr: String::from_utf8_lossy(&err).into_owned() } +} + +/// What a stream holds. +#[derive(Clone, Copy)] +enum Expect { + Empty, + /// The first line equals this. + Line(&'static str), + /// The first line starts with this. + Starts(&'static str), +} + +use Expect::{Empty, Line, Starts}; + +struct Case { + name: &'static str, + args: &'static [&'static str], + code: i32, + stdout: Expect, + stderr: Expect, +} + +const fn case(name: &'static str, args: &'static [&'static str], code: i32, stdout: Expect, stderr: Expect) -> Case { + Case { name, args, code, stdout, stderr } +} + +/// A scratch directory holding `b.dxf` (the bracket sample) and `s.scr` (a one-line script). +struct Scratch(PathBuf); + +impl Scratch { + fn new(tag: &str) -> Scratch { + let dir = std::env::temp_dir().join(format!("cc-cli-usage-{tag}-{}", std::process::id())); + std::fs::create_dir_all(&dir).expect("create scratch dir"); + let b = dir.join("b.dxf"); + let r = invoke(&["sample", "bracket", b.to_str().expect("utf-8 path")]); + assert_eq!(r.code, 0, "{}", r.stderr); + std::fs::write(dir.join("s.scr"), "LINE 0,0 1,1\n").expect("write script"); + Scratch(dir) + } + + /// Replaces `{dir}` with the scratch directory and `{b}` with the sample drawing. + fn expand(&self, text: &str) -> String { + let dir = self.0.to_str().expect("utf-8 path"); + text.replace("{b}", &Path::new(dir).join("b.dxf").to_string_lossy()).replace("{dir}", dir) + } +} + +impl Drop for Scratch { + fn drop(&mut self) { + let _ = std::fs::remove_dir_all(&self.0); + } +} + +fn check(what: &str, stream: &str, got: &str, expect: Expect, scratch: &Scratch) { + let first = got.lines().next().unwrap_or(""); + match expect { + Empty => assert!(got.is_empty(), "{what}: {stream} should be empty, got {got:?}"), + Line(l) => assert_eq!(first, scratch.expand(l), "{what}: {stream}"), + Starts(p) => assert!(first.starts_with(&scratch.expand(p)), "{what}: {stream} should start with {p:?}, got {first:?}"), + } +} + +fn run_cases(tag: &str, cases: &[Case]) { + let scratch = Scratch::new(tag); + for c in cases { + let args: Vec = c.args.iter().map(|a| scratch.expand(a)).collect(); + let args: Vec<&str> = args.iter().map(String::as_str).collect(); + let what = format!("{}: {args:?}", c.name); + let r = invoke(&args); + assert_eq!(r.code, c.code, "{what}: exit code (stderr {:?})", r.stderr); + check(&what, "stdout", &r.stdout, c.stdout, &scratch); + check(&what, "stderr", &r.stderr, c.stderr, &scratch); + } +} + +#[test] +fn top_level_requests() { + run_cases( + "top", + &[ + case("--help", &["--help"], 0, Line("cadcraft-cli: headless CADCraft"), Empty), + case("-h", &["-h"], 0, Line("cadcraft-cli: headless CADCraft"), Empty), + case("help", &["help"], 0, Line("cadcraft-cli: headless CADCraft"), Empty), + case("--version", &["--version"], 0, Starts("cadcraft-cli "), Empty), + case("-V", &["-V"], 0, Starts("cadcraft-cli "), Empty), + case("version is not a subcommand", &["version"], 2, Empty, Line("error: unrecognized subcommand 'version'")), + case("bare", &[], 2, Empty, Line("cadcraft-cli: headless CADCraft")), + case("unknown subcommand", &["foo"], 2, Empty, Line("error: unrecognized subcommand 'foo'")), + case("unknown top-level flag", &["--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("empty subcommand", &[""], 2, Empty, Line("error: unrecognized subcommand ''")), + ], + ); +} + +/// Each subcommand's help, from `--help`, `-h` or `help `: its first line is the +/// subcommand's summary. +#[test] +fn subcommand_help_requests() { + run_cases( + "subhelp", + &[ + case("info --help", &["info", "--help"], 0, Line("Print a drawing's summary as JSON"), Empty), + case("info -h", &["info", "-h"], 0, Line("Print a drawing's summary as JSON"), Empty), + case( + "convert --help", + &["convert", "--help"], + 0, + Line("Convert a drawing; OUT's extension picks the format (dxf, dwg, dwt, svg, png, pdf)"), + Empty, + ), + case( + "convert -h", + &["convert", "-h"], + 0, + Line("Convert a drawing; OUT's extension picks the format (dxf, dwg, dwt, svg, png, pdf)"), + Empty, + ), + case( + "run --help", + &["run", "--help"], + 0, + Line("Open drawings (or start a new one), run scripts and commands in order, save or export the result"), + Empty, + ), + case( + "run -h", + &["run", "-h"], + 0, + Line("Open drawings (or start a new one), run scripts and commands in order, save or export the result"), + Empty, + ), + case("commands --help", &["commands", "--help"], 0, Line("Print the command catalog as JSON"), Empty), + case( + "mcp --help", + &["mcp", "--help"], + 0, + Line("Run the MCP server on stdio: a headless drawing session, or a bridge to the running app"), + Empty, + ), + case( + "perf --help", + &["perf", "--help"], + 0, + Line( + "Time the engine on a synthetic N-entity drawing (default 200000), or the canvas display-list build of a drawing, zoomed in step by step", + ), + Empty, + ), + case("sample --help", &["sample", "--help"], 0, Line("Write a built-in sample drawing"), Empty), + case( + "help run", + &["help", "run"], + 0, + Line("Open drawings (or start a new one), run scripts and commands in order, save or export the result"), + Empty, + ), + case("help info", &["help", "info"], 0, Line("Print a drawing's summary as JSON"), Empty), + case( + "help after a flag missing its value", + &["run", "--sample", "--script", "--help"], + 0, + Line("Open drawings (or start a new one), run scripts and commands in order, save or export the result"), + Empty, + ), + case( + "help after an unknown flag", + &["run", "--bogus", "--help"], + 0, + Line("Open drawings (or start a new one), run scripts and commands in order, save or export the result"), + Empty, + ), + case("help after an extra argument", &["info", "{b}", "extra", "-h"], 0, Line("Print a drawing's summary as JSON"), Empty), + case("--help after -- is a file name", &["run", "--", "--help"], 1, Empty, Starts("error: invalid parameters for `open`: --help:")), + case("run --version", &["run", "--version"], 2, Empty, Line("error: unexpected argument '--version' found")), + case("info --version", &["info", "--version"], 2, Empty, Line("error: unexpected argument '--version' found")), + ], + ); +} + +#[test] +fn unknown_flags_on_every_subcommand() { + run_cases( + "unknown", + &[ + case("info", &["info", "{b}", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("info, flag first", &["info", "--bogus", "{b}"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("info, short flag", &["info", "-x"], 2, Empty, Line("error: unexpected argument '-x' found")), + case("info, a file name starting with - after --", &["info", "--", "-x"], 1, Empty, Starts("error: invalid parameters for `open`: -x:")), + case("convert", &["convert", "{b}", "{dir}/o.svg", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("run", &["run", "--sample", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("run, flag first", &["run", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("commands", &["commands", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("commands -- ends the options", &["commands", "--"], 0, Line("["), Empty), + case("mcp", &["mcp", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("mcp positional", &["mcp", "extra"], 2, Empty, Line("error: unexpected argument 'extra' found")), + case("perf", &["perf", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("sample", &["sample", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + case("sample after name", &["sample", "bracket", "--bogus"], 2, Empty, Line("error: unexpected argument '--bogus' found")), + ], + ); +} + +/// `--x=v` is a spelling of `--x v`, and the one a value starting with `-` needs. +#[test] +fn value_flags_in_both_forms() { + run_cases( + "forms", + &[ + case("--window v", &["convert", "{b}", "{dir}/w1.svg", "--window", "0,0,100,100"], 0, Empty, Starts("wrote {dir}/w1.svg (")), + case("--window=v", &["convert", "{b}", "{dir}/w2.svg", "--window=0,0,100,100"], 0, Empty, Starts("wrote {dir}/w2.svg (")), + case( + "run --window v", + &["run", "--sample", "--window", "0,0,100,100", "--export", "{dir}/w3.svg"], + 0, + Empty, + Starts("wrote {dir}/w3.svg ("), + ), + case( + "run --window=v", + &["run", "--sample", "--window=0,0,100,100", "--export", "{dir}/w4.svg"], + 0, + Empty, + Starts("wrote {dir}/w4.svg ("), + ), + case("--view v", &["convert", "{b}", "{dir}/v1.svg", "--view", "extents"], 0, Empty, Starts("wrote {dir}/v1.svg (")), + case("--view=v", &["convert", "{b}", "{dir}/v2.svg", "--view=extents"], 0, Empty, Starts("wrote {dir}/v2.svg (")), + case("run --view v", &["run", "--sample", "--view", "current", "--export", "{dir}/v3.svg"], 0, Empty, Starts("wrote {dir}/v3.svg (")), + case("run --view=v", &["run", "--sample", "--view=extents", "--export={dir}/v4.svg"], 0, Empty, Starts("wrote {dir}/v4.svg (")), + case("--script v", &["run", "--sample", "--script", "LINE 0,0 1,1"], 0, Empty, Line("Command: LINE")), + case("--script=v", &["run", "--sample", "--script=LINE 0,0 1,1"], 0, Empty, Line("Command: LINE")), + case("--script-file v", &["run", "--sample", "--script-file", "{dir}/s.scr"], 0, Empty, Starts("Command: LINE")), + case("--script-file=v", &["run", "--sample", "--script-file={dir}/s.scr"], 0, Empty, Starts("Command: LINE")), + case("--cmd v", &["run", "--sample", "--cmd", "nosuch"], 1, Empty, Line("error: unknown command `nosuch`")), + case("--cmd=v", &["run", "--sample", "--cmd=nosuch"], 1, Empty, Line("error: unknown command `nosuch`")), + case("--cmd=-v", &["run", "--sample", "--cmd=-x"], 1, Empty, Line("error: unknown command `-x`")), + case("--save v", &["run", "--sample", "--save", "{dir}/s1.dxf"], 0, Empty, Starts("wrote {dir}/s1.dxf (")), + case("--save=v", &["run", "--sample", "--save={dir}/s2.dxf"], 0, Empty, Starts("wrote {dir}/s2.dxf (")), + case("--export v", &["run", "--sample", "--export", "{dir}/e1.svg"], 0, Empty, Starts("wrote {dir}/e1.svg (")), + case("--export=v", &["run", "--sample", "--export={dir}/e2.svg"], 0, Empty, Starts("wrote {dir}/e2.svg (")), + case( + "--window=-v: negative coordinates need =", + &["convert", "{b}", "{dir}/w5.svg", "--window=-1000,-1000,1000,1000"], + 0, + Empty, + Starts("wrote {dir}/w5.svg ("), + ), + case( + "--window -v: a value starting with - is a flag", + &["convert", "{b}", "{dir}/w6.svg", "--window", "-1000,-1000,1000,1000"], + 2, + Empty, + Line("error: unexpected argument '-1' found"), + ), + case("--connect v", &["mcp", "--connect", "127.0.0.1:1"], 1, Empty, Starts("error: cannot connect to 127.0.0.1:1:")), + case("--connect=v", &["mcp", "--connect=127.0.0.1:1"], 1, Empty, Starts("error: cannot connect to 127.0.0.1:1:")), + ], + ); +} + +/// A value flag at the end of the arguments, or followed by another flag, is missing its value: +/// a flag is never taken as a value. +#[test] +fn flags_missing_their_value() { + run_cases( + "missing", + &[ + case( + "convert --window last", + &["convert", "{b}", "{dir}/o.svg", "--window"], + 2, + Empty, + Line("error: a value is required for '--window ' but none was supplied"), + ), + case( + "convert --view last", + &["convert", "{b}", "{dir}/o.svg", "--view"], + 2, + Empty, + Line("error: a value is required for '--view ' but none was supplied"), + ), + case( + "convert --window then flag", + &["convert", "{b}", "{dir}/o.svg", "--window", "--view", "extents"], + 2, + Empty, + Line("error: a value is required for '--window ' but none was supplied"), + ), + case( + "convert --view then flag", + &["convert", "{b}", "{dir}/o.svg", "--view", "--window", "0,0,1,1"], + 2, + Empty, + Line("error: a value is required for '--view ' but none was supplied"), + ), + case( + "run --window last", + &["run", "--sample", "--window"], + 2, + Empty, + Line("error: a value is required for '--window ' but none was supplied"), + ), + case( + "run --view last", + &["run", "--sample", "--view"], + 2, + Empty, + Line("error: a value is required for '--view ' but none was supplied"), + ), + case( + "run --script last", + &["run", "--sample", "--script"], + 2, + Empty, + Line("error: a value is required for '--script ' but none was supplied"), + ), + case( + "run --script then flag", + &["run", "--sample", "--script", "--sample"], + 2, + Empty, + Line("error: a value is required for '--script ' but none was supplied"), + ), + case( + "run --script-file last", + &["run", "--script-file"], + 2, + Empty, + Line("error: a value is required for '--script-file ' but none was supplied"), + ), + case( + "run --script-file then flag", + &["run", "--sample", "--script-file", "--sample"], + 2, + Empty, + Line("error: a value is required for '--script-file ' but none was supplied"), + ), + case( + "run --cmd last", + &["run", "--sample", "--cmd"], + 2, + Empty, + Line("error: a value is required for '--cmd ' but none was supplied"), + ), + case( + "run --cmd then flag", + &["run", "--sample", "--cmd", "--sample"], + 2, + Empty, + Line("error: a value is required for '--cmd ' but none was supplied"), + ), + case( + "run --save last", + &["run", "--sample", "--save"], + 2, + Empty, + Line("error: a value is required for '--save ' but none was supplied"), + ), + case( + "run --export last", + &["run", "--sample", "--export"], + 2, + Empty, + Line("error: a value is required for '--export ' but none was supplied"), + ), + case( + "mcp --connect last", + &["mcp", "--connect"], + 2, + Empty, + Line("error: a value is required for '--connect ' but none was supplied"), + ), + case( + "mcp --connect then flag", + &["mcp", "--connect", "--lazy"], + 2, + Empty, + Line("error: a value is required for '--connect ' but none was supplied"), + ), + case( + "mcp --connect empty", + &["mcp", "--connect", " "], + 2, + Empty, + Line("error: invalid value ' ' for '--connect ': expected HOST:PORT (the app's --control port, e.g. 127.0.0.1:7979)"), + ), + case( + "mcp --connect without a port", + &["mcp", "--connect", "example.com"], + 2, + Empty, + Line( + "error: invalid value 'example.com' for '--connect ': expected HOST:PORT (the app's --control port, e.g. 127.0.0.1:7979)", + ), + ), + case( + "mcp --connect port out of range", + &["mcp", "--connect", "host:99999"], + 2, + Empty, + Line( + "error: invalid value 'host:99999' for '--connect ': expected HOST:PORT (the app's --control port, e.g. 127.0.0.1:7979)", + ), + ), + case( + "mcp --connect=-v", + &["mcp", "--connect=-v"], + 2, + Empty, + Line("error: invalid value '-v' for '--connect ': expected HOST:PORT (the app's --control port, e.g. 127.0.0.1:7979)"), + ), + ], + ); +} + +#[test] +fn repeated_and_combined_flags() { + run_cases( + "repeat", + &[ + case( + "--save twice", + &["run", "--sample", "--save", "{dir}/a.dxf", "--save", "{dir}/b2.dxf"], + 2, + Empty, + Line("error: the argument '--save ' cannot be used multiple times"), + ), + case( + "--export twice", + &["run", "--sample", "--export", "{dir}/x1.svg", "--export", "{dir}/x2.svg"], + 2, + Empty, + Line("error: the argument '--export ' cannot be used multiple times"), + ), + case( + "--window twice", + &["run", "--sample", "--window", "0,0,1,1", "--window", "0,0,2,2", "--export", "{dir}/ww.svg"], + 2, + Empty, + Line("error: the argument '--window ' cannot be used multiple times"), + ), + case( + "convert --window twice", + &["convert", "{b}", "{dir}/cw.svg", "--window", "0,0,1,1", "--window", "0,0,2,2"], + 2, + Empty, + Line("error: the argument '--window ' cannot be used multiple times"), + ), + case( + "--view twice, different", + &["run", "--sample", "--view", "extents", "--view", "current", "--export", "{dir}/vv.svg"], + 2, + Empty, + Line("error: the argument '--view ' cannot be used multiple times"), + ), + case( + "--view twice, same", + &["run", "--sample", "--view", "extents", "--view", "extents", "--export", "{dir}/vs.svg"], + 2, + Empty, + Line("error: the argument '--view ' cannot be used multiple times"), + ), + case("--sample twice", &["run", "--sample", "--sample"], 2, Empty, Line("error: the argument '--sample' cannot be used multiple times")), + case("--metric twice", &["run", "--metric", "--metric"], 2, Empty, Line("error: the argument '--metric' cannot be used multiple times")), + case( + "--lazy twice", + &["mcp", "--connect", "127.0.0.1:1", "--lazy", "--lazy"], + 2, + Empty, + Line("error: the argument '--lazy' cannot be used multiple times"), + ), + case( + "--launch twice", + &["mcp", "--connect", "127.0.0.1:1", "--launch", "--launch"], + 2, + Empty, + Line("error: the argument '--launch' cannot be used multiple times"), + ), + case( + "--script, --script-file and --cmd repeat", + &[ + "run", + "--sample", + "--script", + "LINE 0,0 1,1", + "--script", + "LINE 0,0 2,2", + "--script-file", + "{dir}/s.scr", + "--script-file", + "{dir}/s.scr", + ], + 0, + Empty, + Starts("Command: LINE"), + ), + case( + "--window and --view", + &["run", "--sample", "--window", "0,0,1,1", "--view", "extents", "--export", "{dir}/wv.svg"], + 2, + Empty, + Line("error: the argument '--window ' cannot be used with '--view '"), + ), + case( + "convert --window and --view", + &["convert", "{b}", "{dir}/cwv.svg", "--window", "0,0,1,1", "--view", "extents"], + 2, + Empty, + Line("error: the argument '--window ' cannot be used with '--view '"), + ), + case( + "--view is case-insensitive", + &["run", "--sample", "--view", "EXTENTS", "--export", "{dir}/vu.svg"], + 0, + Empty, + Starts("wrote {dir}/vu.svg ("), + ), + case( + "--connect twice", + &["mcp", "--connect", "127.0.0.1:1", "--connect", "127.0.0.1:2"], + 2, + Empty, + Line("error: the argument '--connect ' cannot be used multiple times"), + ), + case("--lazy without --connect", &["mcp", "--lazy"], 2, Empty, Line("error: the following required arguments were not provided:")), + case("--launch without --connect", &["mcp", "--launch"], 2, Empty, Line("error: the following required arguments were not provided:")), + case("--sample --metric: both accepted", &["run", "--sample", "--metric"], 0, Empty, Empty), + case("--sample and a file", &["run", "--sample", "{b}"], 0, Empty, Empty), + case("two files", &["run", "{b}", "{b}"], 0, Empty, Empty), + case( + "--window without export", + &["run", "--sample", "--window", "0,0,1,1"], + 2, + Empty, + Line("error: the following required arguments were not provided:"), + ), + case( + "--view without export", + &["run", "--sample", "--view", "current"], + 2, + Empty, + Line("error: the following required arguments were not provided:"), + ), + case( + "--window with a dxf output", + &["convert", "{b}", "{dir}/o.dxf", "--window", "0,0,1,1"], + 2, + Empty, + Line("error: --window only applies to image output (png, svg, pdf), not `{dir}/o.dxf`"), + ), + case( + "--view with a dxf output", + &["convert", "{b}", "{dir}/o.dxf", "--view", "extents"], + 2, + Empty, + Line("error: --view only applies to image output (png, svg, pdf), not `{dir}/o.dxf`"), + ), + case( + "run --window with a dxf export", + &["run", "--sample", "--window", "0,0,1,1", "--export", "{dir}/o.dxf"], + 2, + Empty, + Line("error: --window only applies to image output (png, svg, pdf), not `{dir}/o.dxf`"), + ), + case( + "run --view with a dxf export", + &["run", "--sample", "--view", "current", "--export", "{dir}/o.dxf"], + 2, + Empty, + Line("error: --view only applies to image output (png, svg, pdf), not `{dir}/o.dxf`"), + ), + ], + ); +} + +#[test] +fn arity_and_positional_arguments() { + run_cases( + "arity", + &[ + case("info without a file", &["info"], 2, Empty, Line("error: the following required arguments were not provided:")), + case("info with two files", &["info", "{b}", "extra"], 2, Empty, Line("error: unexpected argument 'extra' found")), + case("info missing file", &["info", "missing.dxf"], 1, Empty, Starts("error: invalid parameters for `open`: missing.dxf:")), + case("convert with no files", &["convert"], 2, Empty, Line("error: the following required arguments were not provided:")), + case("convert with one file", &["convert", "{b}"], 2, Empty, Line("error: the following required arguments were not provided:")), + case( + "convert with three files", + &["convert", "{b}", "{dir}/o.svg", "{dir}/x.svg"], + 2, + Empty, + Line("error: unexpected argument '{dir}/x.svg' found"), + ), + case("run missing file", &["run", "missing.dxf"], 1, Empty, Starts("error: invalid parameters for `open`: missing.dxf:")), + case("commands, no match", &["commands", "zzzznomatch"], 0, Line("[]"), Empty), + case( + "commands with an extra argument", + &["commands", "zzzznomatch", "extra"], + 2, + Empty, + Line("error: unexpected argument 'extra' found"), + ), + case("sample without arguments", &["sample"], 2, Empty, Line("error: the following required arguments were not provided:")), + case("sample without an output", &["sample", "bracket"], 2, Empty, Line("error: the following required arguments were not provided:")), + case( + "sample with a bad name", + &["sample", "nosuch", "{dir}/o.dxf"], + 2, + Empty, + Line("error: invalid value 'nosuch' for ''"), + ), + case( + "sample names are case-sensitive", + &["sample", "Bracket", "{dir}/o.dxf"], + 2, + Empty, + Line("error: invalid value 'Bracket' for ''"), + ), + case( + "sample with an empty output", + &["sample", "bracket", ""], + 2, + Empty, + Line("error: a value is required for '' but none was supplied"), + ), + case("info with an empty file name", &["info", ""], 2, Empty, Line("error: a value is required for '' but none was supplied")), + case("perf with an empty file name", &["perf", ""], 2, Empty, Line("error: a value is required for '[N|FILE]' but none was supplied")), + case( + "sample with an extra argument", + &["sample", "bracket", "{dir}/sx.dxf", "extra"], + 2, + Empty, + Line("error: unexpected argument 'extra' found"), + ), + case("sample floor alias", &["sample", "floor", "{dir}/sf.dxf"], 0, Empty, Starts("wrote {dir}/sf.dxf (")), + case("sample with a bad extension", &["sample", "bracket", "{dir}/o.xyz"], 1, Empty, Line("error: unsupported file type `xyz`")), + case("perf with a word", &["perf", "abc"], 1, Empty, Starts("error: invalid parameters for `open`: abc:")), + case("perf with a negative number", &["perf", "-5"], 2, Empty, Line("error: unexpected argument '-5' found")), + case("perf with a missing file", &["perf", "missing.dxf"], 1, Empty, Starts("error: invalid parameters for `open`: missing.dxf:")), + case("perf 1", &["perf", "1"], 0, Starts("operation"), Empty), + case("perf 0 is raised to 1", &["perf", "0"], 0, Starts("operation"), Empty), + case("perf with two counts", &["perf", "1", "2"], 2, Empty, Line("error: unexpected argument '2' found")), + ], + ); +} + +#[test] +fn bad_values() { + run_cases( + "values", + &[ + case( + "--view sideways", + &["convert", "{b}", "{dir}/o.svg", "--view", "sideways"], + 2, + Empty, + Line("error: invalid value 'sideways' for '--view '"), + ), + case( + "run --view sideways", + &["run", "--sample", "--view", "sideways"], + 2, + Empty, + Line("error: invalid value 'sideways' for '--view '"), + ), + case( + "--view sideways before the output check", + &["convert", "{b}", "{dir}/o.dxf", "--view", "sideways"], + 2, + Empty, + Line("error: invalid value 'sideways' for '--view '"), + ), + case( + "--window 3 numbers", + &["convert", "{b}", "{dir}/o.svg", "--window", "1,2,3"], + 2, + Empty, + Line("error: invalid value '1,2,3' for '--window ': expected four numbers x0,y0,x1,y1"), + ), + case( + "--window 5 numbers", + &["convert", "{b}", "{dir}/o.svg", "--window", "1,2,3,4,5"], + 2, + Empty, + Line("error: invalid value '1,2,3,4,5' for '--window ': expected four numbers x0,y0,x1,y1"), + ), + case( + "--window reversed", + &["convert", "{b}", "{dir}/o.svg", "--window", "3,3,1,1"], + 2, + Empty, + Line("error: invalid value '3,3,1,1' for '--window ': need x0 < x1 and y0 < y1 (lower-left corner first)"), + ), + case( + "--window not numbers", + &["convert", "{b}", "{dir}/o.svg", "--window", "a,b,c,d"], + 2, + Empty, + Line("error: invalid value 'a,b,c,d' for '--window ': x0 must be a finite number, got `a`"), + ), + case( + "--window NaN", + &["convert", "{b}", "{dir}/o.svg", "--window", "NaN,0,1,1"], + 2, + Empty, + Line("error: invalid value 'NaN,0,1,1' for '--window ': x0 must be a finite number, got `NaN`"), + ), + case( + "--window too large", + &["convert", "{b}", "{dir}/o.svg", "--window", "0,0,1e13,1"], + 2, + Empty, + Line("error: invalid value '0,0,1e13,1' for '--window ': export window: coordinates must lie within ±1e12"), + ), + case( + "run --window 3 numbers", + &["run", "--sample", "--window", "1,2,3", "--export", "{dir}/o.svg"], + 2, + Empty, + Line("error: invalid value '1,2,3' for '--window ': expected four numbers x0,y0,x1,y1"), + ), + case( + "run --window reversed", + &["run", "--sample", "--window", "3,3,1,1", "--export", "{dir}/o.svg"], + 2, + Empty, + Line("error: invalid value '3,3,1,1' for '--window ': need x0 < x1 and y0 < y1 (lower-left corner first)"), + ), + case( + "--cmd bad json", + &["run", "--sample", "--cmd", "line {bad json"], + 2, + Empty, + Line("error: invalid value 'line {bad json' for '--cmd ': key must be a string at line 1 column 2"), + ), + case( + "--cmd bad json after a good step: nothing runs", + &["run", "--sample", "--cmd", "line {\"points\":[[0,0],[1,1]]}", "--cmd", "line {"], + 2, + Empty, + Starts("error: invalid value 'line {' for '--cmd ': "), + ), + case( + "--cmd without an id", + &["run", "--sample", "--cmd", " {}"], + 2, + Empty, + Line("error: invalid value ' {}' for '--cmd ': expected a command id, then optionally its JSON parameters"), + ), + case( + "--cmd empty", + &["run", "--sample", "--cmd="], + 2, + Empty, + Line("error: invalid value '' for '--cmd ': expected a command id, then optionally its JSON parameters"), + ), + case("--cmd unknown id", &["run", "--sample", "--cmd", "nosuch"], 1, Empty, Line("error: unknown command `nosuch`")), + case( + "--cmd {last} with no earlier handle", + &["run", "--sample", "--cmd", "erase {\"handles\":[\"{last}\"]}"], + 1, + Empty, + Line("error: --cmd erase: `{last}` needs an earlier --cmd in this run to have returned a handle"), + ), + case("--script-file missing", &["run", "--sample", "--script-file", "missing.scr"], 1, Empty, Starts("error: missing.scr:")), + ], + ); +} + +/// `mcp` serves on the process's real stdin and stdout, so the headless server runs through the +/// binary, with a closed stdin. +#[test] +fn mcp_headless_with_a_closed_stdin() { + let out = std::process::Command::new(env!("CARGO_BIN_EXE_cadcraft-cli")) + .arg("mcp") + .stdin(std::process::Stdio::null()) + .output() + .expect("run cadcraft-cli"); + assert_eq!(out.status.code(), Some(0)); + assert!(out.stdout.is_empty() && out.stderr.is_empty()); +} + +/// A drawing to open whose name isn't valid Unicode reaches the handler as a path; the engine opens +/// files by text name, so it is refused there (exit 1), naming the file. Text that isn't Unicode is +/// a usage error. +#[cfg(unix)] +#[test] +fn non_unicode_arguments() { + use std::ffi::OsString; + use std::os::unix::ffi::OsStringExt; + let invoke_os = |args: Vec| { + let (mut out, mut err) = (Vec::new(), Vec::new()); + let code = cadcraft_cli::run(args, &mut out, &mut err); + assert!(out.is_empty()); + (code, String::from_utf8_lossy(&err).into_owned()) + }; + let latin1 = || OsString::from_vec(b"caf\xe9.dxf".to_vec()); + let (code, err) = invoke_os(vec![OsString::from("info"), latin1()]); + assert_eq!(code, 1); + assert_eq!(err.lines().next(), Some("error: caf\u{FFFD}.dxf: the file name is not valid Unicode")); + let (code, err) = invoke_os(vec![OsString::from("run"), OsString::from("--sample"), OsString::from("--cmd"), latin1()]); + assert_eq!(code, 2); + assert!(err.starts_with("error: invalid UTF-8 was detected"), "{err}"); +} + +/// An output name that isn't valid Unicode is written as given: only its extension picks the format. +#[cfg(unix)] +#[test] +fn non_unicode_output_names() { + use std::ffi::OsString; + use std::os::unix::ffi::OsStringExt; + let s = Scratch::new("nonunicode-out"); + let latin1 = |ext: &str| { + let mut n = b"caf\xe9.".to_vec(); + n.extend_from_slice(ext.as_bytes()); + s.0.join(OsString::from_vec(n)) + }; + let run = |args: Vec| { + let (mut out, mut err) = (Vec::new(), Vec::new()); + let code = cadcraft_cli::run(args, &mut out, &mut err); + (code, String::from_utf8_lossy(&err).into_owned()) + }; + let b = s.0.join("b.dxf"); + let cases: [(Vec, std::path::PathBuf); 3] = [ + (vec!["sample".into(), "bracket".into(), latin1("dxf").into()], latin1("dxf")), + (vec!["convert".into(), b.clone().into(), latin1("svg").into()], latin1("svg")), + (vec!["run".into(), "--sample".into(), "--save".into(), latin1("dwg").into()], latin1("dwg")), + ]; + for (args, path) in cases { + let (code, err) = run(args.clone()); + assert_eq!(code, 0, "{args:?}: {err}"); + assert!(path.exists(), "{path:?}"); + assert!(std::fs::metadata(&path).expect("stat output").len() > 0, "{path:?}"); + } + // An input with such a name is still refused. + let (code, err) = run(vec!["info".into(), latin1("dxf").into()]); + assert_eq!(code, 1); + assert!(err.contains("not valid Unicode"), "{err}"); +} + +/// An output that is an input file is refused before any work (exit 2, the input untouched) unless +/// `--in-place` allows it; the same file under another spelling counts, another existing file doesn't. +#[test] +fn output_that_replaces_an_input() { + let s = Scratch::new("inplace"); + let dir = s.0.to_str().expect("utf-8 path").to_string(); + let b = format!("{dir}/b.dxf"); + let original = std::fs::read(&b).expect("read input"); + std::fs::create_dir_all(format!("{dir}/sub")).expect("create sub"); + let dotted = format!("{dir}/sub/../b.dxf"); + #[allow(unused_mut)] + let mut spellings = vec![b.clone(), dotted]; + #[cfg(unix)] + { + let link = format!("{dir}/link.dxf"); + std::os::unix::fs::symlink(&b, &link).expect("symlink"); + spellings.push(link); + } + for out in &spellings { + for args in [vec!["convert", &b, out], vec!["run", &b, "--save", out], vec!["run", &b, "--export", out]] { + let r = invoke(&args); + assert_eq!(r.code, 2, "{args:?}: {}", r.stderr); + assert!(r.stdout.is_empty(), "{args:?}"); + assert!(r.stderr.starts_with(&format!("error: {out} is an input file")), "{args:?}: {}", r.stderr); + assert!(r.stderr.contains("--in-place"), "{args:?}: {}", r.stderr); + assert_eq!(std::fs::read(&b).expect("read input"), original, "{args:?}: input changed"); + } + } + + // Another existing file is replaced as before. + let other = format!("{dir}/other.dxf"); + std::fs::write(&other, "x").expect("write other"); + let r = invoke(&["convert", &b, &other]); + assert_eq!(r.code, 0, "{}", r.stderr); + assert_ne!(std::fs::read(&other).expect("read other"), b"x"); + + // --in-place allows it, for each spelling and flag: the input itself is rewritten, and a + // symlink stays a link to it. + let line = "line {\"points\":[[0,0],[1,1]]}"; + let lines = |p: &str| std::fs::read_to_string(p).expect("read input").lines().filter(|l| l.trim_end() == "LINE").count(); + let before = lines(&b); + for out in &spellings { + std::fs::write(&b, &original).expect("restore input"); + let r = invoke(&["convert", &b, out, "--in-place"]); + assert_eq!(r.code, 0, "convert {out}: {}", r.stderr); + assert_eq!(lines(&b), before, "convert {out} keeps the drawing"); + for flag in ["--save", "--export"] { + std::fs::write(&b, &original).expect("restore input"); + let r = invoke(&["run", &b, "--cmd", line, "--in-place", flag, out]); + assert_eq!(r.code, 0, "{flag} {out}: {}", r.stderr); + assert_eq!(lines(&b), before + 1, "{flag} {out}: the input gains the line"); + } + } + #[cfg(unix)] + { + let link = format!("{dir}/link.dxf"); + assert!(std::fs::symlink_metadata(&link).expect("stat link").file_type().is_symlink(), "{link} is still a symlink"); + } + + // An output that doesn't exist yet is never an input. + let new = format!("{dir}/new.dxf"); + let r = invoke(&["run", &b, "--save", &new]); + assert_eq!(r.code, 0, "{}", r.stderr); + assert!(std::path::Path::new(&new).is_file(), "{new} written"); +} + +/// JSON results are pretty-printed; `--compact` puts each on one line (RFC-0012 rule 1.3). `run` +/// prints one line per `--cmd` result either way. +#[test] +fn json_output_is_pretty_unless_compact() { + let s = Scratch::new("compact"); + let b = format!("{}/b.dxf", s.0.to_str().expect("utf-8 path")); + for args in [&["info", b.as_str()][..], &["commands", "ellipse"]] { + let help = invoke(&[args[0], "--help"]); + assert!( + help.stdout.contains("--compact") && help.stdout.contains("One line of JSON instead of pretty-printed"), + "{} --help: {}", + args[0], + help.stdout + ); + let pretty = invoke(args); + assert_eq!(pretty.code, 0, "{args:?}: {}", pretty.stderr); + assert!(pretty.stdout.lines().count() > 1, "{args:?} is pretty-printed: {}", pretty.stdout); + let compact = invoke(&[args, &["--compact"]].concat()); + assert_eq!(compact.code, 0, "{args:?} --compact: {}", compact.stderr); + assert_eq!(compact.stdout.lines().count(), 1, "{args:?} --compact is one line: {}", compact.stdout); + let a: serde_json::Value = serde_json::from_str(&pretty.stdout).expect("pretty JSON"); + let c: serde_json::Value = serde_json::from_str(&compact.stdout).expect("compact JSON"); + assert_eq!(a, c, "{args:?}: same JSON either way"); + } + let r = invoke(&["run", "--sample", "--cmd", "drawing.inspect", "--cmd", "drawing.inspect"]); + assert_eq!(r.code, 0, "{}", r.stderr); + assert_eq!(r.stdout.lines().count(), 2, "one line per --cmd result: {}", r.stdout); + assert_eq!(invoke(&["run", "--sample", "--compact"]).code, 2, "run takes no --compact"); +} diff --git a/apps/cadcraft-cli/tests/man_and_completions.rs b/apps/cadcraft-cli/tests/man_and_completions.rs new file mode 100644 index 000000000..df6dea90c --- /dev/null +++ b/apps/cadcraft-cli/tests/man_and_completions.rs @@ -0,0 +1,30 @@ +//! The clap definition is consistent, and `examples/man-and-completions.rs` writes every shell's +//! completions and every man page under the names `packaging/linux/package.sh` installs. + +// The example itself, so the test runs its code; its `main` is unused here. +#[allow(dead_code)] +#[path = "../examples/man-and-completions.rs"] +mod example; + +#[test] +fn command_is_consistent() { + cadcraft_cli::command().debug_assert(); +} + +#[test] +fn the_example_writes_the_files_the_packages_install() { + let dir = std::path::Path::new(env!("CARGO_TARGET_TMPDIR")).join(format!("man-and-completions-{}", std::process::id())); + let _ = std::fs::remove_dir_all(&dir); + example::generate(&dir).unwrap(); + + let mut written: Vec = std::fs::read_dir(&dir).unwrap().map(|e| e.unwrap().file_name().into_string().unwrap()).collect(); + written.sort(); + let completions = ["cadcraft-cli.bash", "_cadcraft-cli", "cadcraft-cli.fish", "cadcraft-cli.elv", "_cadcraft-cli.ps1"]; + let subcommands = ["info", "convert", "run", "commands", "mcp", "perf", "sample"]; + let mut expected: Vec = completions.map(String::from).into(); + expected.push("cadcraft-cli.1".into()); + expected.extend(subcommands.iter().map(|s| format!("cadcraft-cli-{s}.1"))); + expected.sort(); + assert_eq!(written, expected); + std::fs::remove_dir_all(&dir).unwrap(); +} diff --git a/apps/cadcraft/Cargo.toml b/apps/cadcraft/Cargo.toml index 48c2c2d15..d8b4ef4c5 100644 --- a/apps/cadcraft/Cargo.toml +++ b/apps/cadcraft/Cargo.toml @@ -21,6 +21,8 @@ eframe = { workspace = true, features = ["clipboard", "wgpu", "accesskit", "wayl egui = { workspace = true } serde_json = { workspace = true } log = { workspace = true } +clap = { workspace = true } +thiserror = { workspace = true } chrono = { workspace = true } [build-dependencies] diff --git a/apps/cadcraft/src/env.rs b/apps/cadcraft/src/env.rs new file mode 100644 index 000000000..76df8aa15 --- /dev/null +++ b/apps/cadcraft/src/env.rs @@ -0,0 +1,172 @@ +//! The `CADCRAFT_*` variables of the desktop app, read once at startup into [`Env`] and passed on +//! from there; no library crate reads them. `--help` lists them from [`VARS`]. `--control`'s +//! fallback, `CADCRAFT_CONTROL_PORT`, is clap's (see `launch_args`). + +use std::ffi::OsString; +use std::fmt::Write as _; +use std::path::PathBuf; + +use cadcraft_ui_egui::switch::Switch; + +const CONFIG_DIR: &str = "CADCRAFT_CONFIG_DIR"; +const LOCALE: &str = "CADCRAFT_LOCALE"; +const VSYNC: &str = "CADCRAFT_VSYNC"; +const WAYLAND: &str = "CADCRAFT_WAYLAND"; +const NO_NATIVE_MENU: &str = "CADCRAFT_NO_NATIVE_MENU"; +const SYSTEM_CURSOR: &str = "CADCRAFT_SYSTEM_CURSOR"; +const FONTALT: &str = "CADCRAFT_FONTALT"; +const FONTFALLBACK: &str = "CADCRAFT_FONTFALLBACK"; + +/// Every variable [`Env`] reads, with its `--help` line. +pub(crate) const VARS: &[(&str, &str)] = &[ + (CONFIG_DIR, "the settings folder (logs, autosave, workspace, plotters); empty means no settings folder"), + (LOCALE, "the interface language, instead of the system's"), + (VSYNC, "1 presents with vsync, 0 without it (default: without on Linux and BSD)"), + (WAYLAND, "1 keeps the native Wayland backend instead of XWayland; 0 or unset is off"), + (NO_NATIVE_MENU, "macOS: 1 keeps the menus inside the window; 0 or unset is off"), + (SYSTEM_CURSOR, "1 uses the system cursor instead of the drawn crosshair; 0 or unset is off"), + (FONTALT, "the font that replaces a missing one"), + (FONTFALLBACK, "the fonts tried, in order, for characters a font lacks"), +]; + +/// The process environment, read once at startup. A blank variable counts as unset, except +/// `CADCRAFT_CONFIG_DIR`. +#[derive(Debug, PartialEq)] +pub(crate) struct Env { + /// The settings folder (logs, autosave, workspace, plotters): `CADCRAFT_CONFIG_DIR`; else, when + /// that is unset, the platform's (`cadcraft_engine::settings_dir::platform`). `None`: no + /// folder, because the variable is empty or blank (the way to run without one) or the + /// platform has none. + pub(crate) config_dir: Option, + /// The interface language, instead of the system's. + pub(crate) locale: Option, + /// Present with vsync (default: off on Linux and BSD, on elsewhere). + pub(crate) vsync: Switch, + /// Keep the native Wayland backend instead of XWayland. + #[cfg_attr(not(all(unix, not(target_os = "macos"))), allow(dead_code))] + pub(crate) wayland: Switch, + /// macOS: keep the menus inside the window. + #[cfg_attr(not(target_os = "macos"), allow(dead_code))] + pub(crate) no_native_menu: Switch, + /// Use the system cursor instead of the drawn crosshair. + pub(crate) system_cursor: Switch, + /// FONTALT at startup. + pub(crate) font_alt: Option, + /// FONTFALLBACK at startup. + pub(crate) font_fallback: Option, +} + +impl Env { + pub(crate) fn read() -> Env { + Env::from_vars(|k| std::env::var_os(k)) + } + + /// [`Env::read`] with `var` looking a variable up. + pub(crate) fn from_vars(var: impl Fn(&str) -> Option) -> Env { + let text = |k: &str| var(k).and_then(|v| v.into_string().ok()).filter(|v| !v.trim().is_empty()); + let switch = |k: &str| Switch::parse(k, var(k).map(|v| v.to_string_lossy().into_owned()).as_deref()); + Env { + config_dir: match var(CONFIG_DIR) { + Some(dir) if dir.to_str().is_some_and(|d| d.trim().is_empty()) => None, + Some(dir) => Some(PathBuf::from(dir)), + None => cadcraft_engine::settings_dir::platform(&var), + }, + locale: text(LOCALE), + vsync: switch(VSYNC), + wayland: switch(WAYLAND), + no_native_menu: switch(NO_NATIVE_MENU), + system_cursor: switch(SYSTEM_CURSOR), + font_alt: text(FONTALT), + font_fallback: text(FONTFALLBACK), + } + } +} + +/// The `--help` section that lists [`VARS`]. +pub(crate) fn help() -> String { + let width = VARS.iter().map(|(name, _)| name.len()).max().unwrap_or(0) + 3; + VARS.iter().fold(String::from("Environment:"), |mut help, (name, line)| { + let _ = write!(help, "\n {name:(vars: &'a [(&'a str, &'a str)]) -> impl Fn(&str) -> Option + 'a { + move |k| vars.iter().find(|(n, _)| *n == k).map(|(_, v)| OsString::from(v)) + } + + #[test] + fn every_variable_read_is_in_the_help_and_every_listed_one_is_read() { + let asked = RefCell::new(Vec::new()); + Env::from_vars(|k| { + asked.borrow_mut().push(k.to_owned()); + None + }); + let ours: Vec = asked.into_inner().into_iter().filter(|k| k.starts_with("CADCRAFT_")).collect(); + let help = help(); + let unset = Env::from_vars(|_| None); + for k in &ours { + assert!(VARS.iter().any(|(name, _)| name == k), "{k} is read but not in VARS"); + } + for (name, line) in VARS { + assert!(ours.iter().any(|k| k == name), "{name} is in VARS but not read"); + assert_ne!(Env::from_vars(env(&[(name, "1")])), unset, "{name} sets no field"); + assert!(help.lines().any(|l| l.trim_start().starts_with(name) && l.ends_with(line)), "{help}"); + } + } + + #[test] + fn values_are_read_and_blank_ones_are_unset() { + let vars = [ + (CONFIG_DIR, "/private/cc"), + ("HOME", "/home/u"), + ("XDG_CONFIG_HOME", "/x"), + ("APPDATA", "C:\\a"), + (LOCALE, "cs-CZ"), + (VSYNC, " On "), + (WAYLAND, "0"), + (NO_NATIVE_MENU, "yes"), + (SYSTEM_CURSOR, "maybe"), + (FONTALT, "Noto Sans"), + (FONTFALLBACK, "Vazirmatn, msjh.ttc"), + ]; + let read = Env::from_vars(env(&vars)); + assert_eq!( + read, + Env { + config_dir: Some(PathBuf::from("/private/cc")), + locale: Some("cs-CZ".into()), + vsync: Switch::On, + wayland: Switch::Off, + no_native_menu: Switch::On, + system_cursor: Switch::Default, + font_alt: Some("Noto Sans".into()), + font_fallback: Some("Vazirmatn, msjh.ttc".into()), + } + ); + let blank = vars.map(|(k, _)| (k, if k == FONTALT { " " } else { "" })); + let read = Env::from_vars(env(&blank)); + assert_eq!(read.config_dir, None, "an empty variable means no directory, not the working directory"); + assert_eq!((read.locale, read.font_alt, read.font_fallback), (None, None, None)); + assert_eq!([read.vsync, read.wayland, read.no_native_menu, read.system_cursor], [Switch::Default; 4]); + } + + #[test] + fn config_dir_unset_is_the_platform_folder_set_is_that_folder_blank_is_none() { + let platform = [("HOME", "/home/u"), ("XDG_CONFIG_HOME", "/x"), ("APPDATA", "C:\\a")]; + let expected = cadcraft_engine::settings_dir::platform(env(&platform)); + assert!(expected.is_some()); + assert_eq!(Env::from_vars(env(&platform)).config_dir, expected); + let set = [platform.as_slice(), &[(CONFIG_DIR, "/private/cc")]].concat(); + assert_eq!(Env::from_vars(env(&set)).config_dir, Some(PathBuf::from("/private/cc"))); + for blank in ["", " "] { + let vars = [platform.as_slice(), &[(CONFIG_DIR, blank)]].concat(); + assert_eq!(Env::from_vars(env(&vars)).config_dir, None, "{blank:?} means no settings folder, not the platform's"); + } + } +} diff --git a/apps/cadcraft/src/launch_args.rs b/apps/cadcraft/src/launch_args.rs new file mode 100644 index 000000000..c6329907a --- /dev/null +++ b/apps/cadcraft/src/launch_args.rs @@ -0,0 +1,158 @@ +//! The desktop app's command line, as clap types: `cadcraft --help` comes from these doc comments +//! and its Environment section from [`crate::env::VARS`], so the help and the parsers can't disagree. Anything they don't declare is a usage error naming +//! it (exit status 2), so a typo such as `--sampel` doesn't open the window and then fail to open +//! the flag as a file; so is a flag without its value, a repeated flag and a bad port, from the +//! flag or from `CADCRAFT_CONTROL_PORT`. A value never starts with `-`, and a file whose name +//! starts with `-` goes after `--`. + +use std::ffi::OsString; +use std::path::PathBuf; + +use cadcraft_mcp::args::{blank_env_is_unset, name_env_vars}; +use clap::{Command, CommandFactory, FromArgMatches, Parser}; + +/// Opens CADCraft with the given files +#[derive(Parser)] +#[command(name = "cadcraft", version = cadcraft_engine::build_version(), after_help = crate::env::help())] +pub(crate) struct LaunchArgs { + /// Files to open. Put `--` before a name that starts with `-` + pub(crate) files: Vec, + /// Start the localhost JSON-lines control server on this port + // allow_negative_numbers makes `--control -1` a bad value rather than a missing one. + #[arg(long, value_name = "PORT", env = "CADCRAFT_CONTROL_PORT", value_parser = control_port, allow_negative_numbers = true)] + pub(crate) control: Option, + /// Open with the sample drawing + #[arg(long)] + pub(crate) sample: bool, +} + +/// The command line. An empty or blank variable counts as unset. +pub(crate) fn command() -> Command { + LaunchArgs::command().mut_args(|a| blank_env_is_unset(a, |k| std::env::var_os(k))) +} + +/// Parse the launch arguments (without the binary name) with `cmd`, from [`command`]. Old macOS +/// passes a process serial number (`-psn_…`) when launched from Finder: it is dropped first, unless +/// it comes after `--`. A bad value from a variable is a usage error naming the variable. +pub(crate) fn parse(mut cmd: Command, args: impl IntoIterator) -> Result { + let mut options = true; + let args: Vec = args + .into_iter() + .filter(|a| { + options &= a != "--"; + !(options && a.to_str().is_some_and(|s| s.starts_with("-psn_"))) + }) + .collect(); + let argv = std::iter::once(OsString::from("cadcraft")).chain(args.iter().cloned()); + let matches = cmd.try_get_matches_from_mut(argv).map_err(|e| name_env_vars(e, &cmd, &args))?; + LaunchArgs::from_arg_matches(&matches) +} + +/// A control port, for clap's `value_parser`: `--control` and `CADCRAFT_CONTROL_PORT`, which may +/// carry spaces. +fn control_port(s: &str) -> Result { + s.trim().parse().map_err(|_| NotAPort) +} + +/// A [`control_port`] value that isn't a port. +#[derive(Debug, PartialEq, Eq, thiserror::Error)] +#[error("expected a port, 0-65535")] +struct NotAPort; + +#[cfg(test)] +mod tests { + use super::*; + use clap::error::ErrorKind; + + /// Parse without the variables, so one exported where the tests run can't change them. + fn parse_args(args: &[&str]) -> Result { + parse(command().mut_args(|a| a.env(None::<&str>)), args.iter().map(OsString::from)) + } + + fn usage_error(args: &[&str]) -> String { + let Err(e) = parse_args(args) else { panic!("{args:?} parsed") }; + assert_eq!(e.exit_code(), 2, "{args:?}: {e}"); + e.to_string() + } + + #[test] + fn values_are_parsed() { + let parsed = parse_args(&["--control", " 50494 ", "--sample", "a.dxf", "b.dwg"]).unwrap(); + assert_eq!((parsed.control, parsed.sample), (Some(50494), true)); + assert_eq!(parsed.files, [PathBuf::from("a.dxf"), PathBuf::from("b.dwg")]); + let parsed = parse_args(&[]).unwrap(); + assert_eq!((parsed.control, parsed.sample, parsed.files.len()), (None, false, 0)); + } + + #[test] + fn control_port_rejects_unparseable_values_naming_them() { + for bad in ["78787", "-1", "abc", "99999999999999999999"] { + assert!(usage_error(&["--control", bad]).contains(&format!("invalid value '{bad}' for '--control '")), "{bad}"); + } + assert!(usage_error(&["--control="]).contains("invalid value '' for '--control '")); + } + + #[test] + fn usage_errors_exit_2() { + assert!(usage_error(&["--sampel"]).contains("unexpected argument '--sampel'")); + assert!(usage_error(&["--control"]).contains("a value is required for '--control '")); + // A following flag is never taken as the value. + assert!(usage_error(&["--control", "--sample"]).contains("a value is required for '--control '")); + assert!(usage_error(&["--sample", "--sample"]).contains("cannot be used multiple times")); + assert!(usage_error(&["--control", "1", "--control", "2"]).contains("cannot be used multiple times")); + } + + #[test] + fn version_stops_parsing() { + let e = parse_args(&["-V", "--control"]).err().unwrap(); + assert_eq!((e.kind(), e.exit_code()), (ErrorKind::DisplayVersion, 0)); + assert_eq!(e.to_string(), format!("{}\n", crate::version_string())); + let e = parse_args(&["--version", "--bogus"]).err().unwrap(); + assert_eq!(e.kind(), ErrorKind::DisplayVersion); + } + + #[test] + fn help_stops_parsing_and_double_dash_ends_options() { + let e = parse_args(&["-h", "--sampel", "--control"]).err().unwrap(); + assert_eq!((e.kind(), e.exit_code()), (ErrorKind::DisplayHelp, 0)); + let help = parse_args(&["--help"]).err().unwrap().to_string(); + assert!(help.contains("--control ") && help.contains("CADCRAFT_CONFIG_DIR"), "{help}"); + + assert!(usage_error(&["--sampel", "--", "--help"]).contains("unexpected argument '--sampel'")); + let parsed = parse_args(&["a.dxf", "--", "--help", "-x"]).unwrap(); + assert_eq!(parsed.files, ["a.dxf", "--help", "-x"].map(PathBuf::from)); + } + + #[test] + fn a_finder_process_serial_number_is_dropped() { + let parsed = parse_args(&["-psn_0_12345", "a.dxf"]).unwrap(); + assert_eq!(parsed.files, [PathBuf::from("a.dxf")]); + let parsed = parse_args(&["--", "-psn_x.dxf"]).unwrap(); + assert_eq!(parsed.files, [PathBuf::from("-psn_x.dxf")]); + } + + /// A name that isn't valid Unicode is kept as given. + #[cfg(unix)] + #[test] + fn non_unicode_file_names_are_kept() { + use std::os::unix::ffi::OsStringExt as _; + let latin1 = OsString::from_vec(b"caf\xe9.dxf".to_vec()); + let parsed = parse(command().mut_args(|a| a.env(None::<&str>)), [latin1.clone(), OsString::from("b.dxf")]).unwrap(); + assert_eq!(parsed.files, [PathBuf::from(&latin1), PathBuf::from("b.dxf")]); + } + + /// `--control` falls back to `PATH` here instead of `CADCRAFT_CONTROL_PORT`: `PATH` is set + /// wherever the tests run and is never a port, and tests can't set a variable (`set_var` is + /// unsafe). + #[test] + fn the_flag_wins_over_its_variable_and_a_bad_value_names_the_variable() { + let Some(path) = std::env::var_os("PATH").filter(|p| !p.is_empty()) else { return }; + let path_fallback = || command().mut_args(|a| a.env(None::<&str>)).mut_arg("control", |a| a.env("PATH")); + let e = parse(path_fallback(), []).err().unwrap(); + assert_eq!(e.exit_code(), 2); + let text = e.to_string(); + assert!(text.contains(&format!("invalid value '{}' for 'PATH'", path.to_string_lossy())), "{text}"); + assert!(!text.contains("--control '"), "{text}"); + assert_eq!(parse(path_fallback(), ["--control", "7"].map(OsString::from)).unwrap().control, Some(7)); + } +} diff --git a/apps/cadcraft/src/logging.rs b/apps/cadcraft/src/logging.rs index 4113de54f..724d09c1a 100644 --- a/apps/cadcraft/src/logging.rs +++ b/apps/cadcraft/src/logging.rs @@ -3,7 +3,7 @@ //! Without a logger every `log::warn!`/`log::error!`/`log::info!` in the workspace (a broken app //! icon, the GPU canvas set-up, the control server) vanished. A launch from a desktop menu has no //! terminal, so the file is what a bug report can attach: `/logs/cadcraft.log` -//! (`CADCRAFT_CONFIG_DIR`, or the platform settings directory; see `config_dir` in `main.rs`). +//! (`CADCRAFT_CONFIG_DIR`, or the platform settings directory; empty means none; see `env.rs`). //! Each start moves the previous log to `cadcraft.1.log` (and that one to `.2`), so the log of a //! run that crashed survives the next launch. //! diff --git a/apps/cadcraft/src/main.rs b/apps/cadcraft/src/main.rs index 1007fc0c1..19546d6ce 100644 --- a/apps/cadcraft/src/main.rs +++ b/apps/cadcraft/src/main.rs @@ -1,6 +1,6 @@ //! CADCraft desktop app. //! -//! Usage: `cadcraft [--control ] [--sample] [files…]` +//! Usage: `cadcraft [--control ] [--sample] [files…]` (`cadcraft --help` lists the rest; see [`launch_args`]) //! //! `--control ` (or `CADCRAFT_CONTROL_PORT`) starts a localhost JSON-lines control server: //! `{"id":1,"method":"cmdline.input","params":{"text":"circle 0,0 5"}}` → `{"id":1,"ok":true,…}`. @@ -10,14 +10,16 @@ //! present mode (`CADCRAFT_VSYNC=0` selects that elsewhere); see `cadcraft_ui_egui::gpu::surface_config`. //! //! `log` records go to standard error and `/logs/cadcraft.log` (`RUST_LOG` sets the -//! levels); see [`logging`] and [`config_dir`]. +//! levels); see [`logging`]. The `CADCRAFT_*` variables are read once, at startup; see [`env`]. #![cfg_attr(all(target_os = "windows", not(debug_assertions)), windows_subsystem = "windows")] #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)] mod control_server; mod desktop_theme; +mod env; #[cfg(any(target_os = "windows", test))] mod graphics; +mod launch_args; mod logging; #[cfg(target_os = "macos")] mod native_menu; @@ -26,6 +28,7 @@ mod system_animations; mod workspace; use cadcraft_engine::Session; +use cadcraft_ui_egui::switch::Switch; use cadcraft_ui_egui::{CadApp, Services, i18n}; struct App { @@ -39,6 +42,9 @@ struct App { workspace_error: Option, #[cfg(target_os = "macos")] native_menu: Option, + /// `CADCRAFT_NO_NATIVE_MENU`: the menus stay inside the window. + #[cfg(target_os = "macos")] + menus_in_window: bool, /// The `movable` flag last set on the main window. #[cfg(target_os = "macos")] movable: Option, @@ -88,7 +94,7 @@ impl eframe::App for App { if ctx.current_pass_index() == 0 { #[cfg(target_os = "macos")] { - if self.native_menu.is_none() && std::env::var_os("CADCRAFT_NO_NATIVE_MENU").is_none() { + if self.native_menu.is_none() && !self.menus_in_window { self.native_menu = Some(native_menu::NativeMenu::install(&mut self.cad, ctx)); } if let Some(m) = &mut self.native_menu { @@ -188,30 +194,6 @@ fn filters_for_save(name: &str) -> [(&'static str, &'static str); 6] { filters } -/// The per-user settings directory (it holds `logs/` and `autosave/`): `CADCRAFT_CONFIG_DIR` if set, else -/// `$XDG_CONFIG_HOME/cadcraft` or `~/.config/cadcraft` on Linux and the BSDs, -/// `~/Library/Application Support/CADCraft` on macOS, `%APPDATA%\CADCraft` on Windows. -fn config_dir() -> Option { - config_dir_from(|k| std::env::var_os(k)) -} - -/// [`config_dir`] with the environment passed in (`var` looks a variable up). An empty variable -/// counts as unset, so a blank value never means the working directory. -fn config_dir_from(var: impl Fn(&str) -> Option) -> Option { - let set = |k: &str| var(k).filter(|v| !v.is_empty()).map(std::path::PathBuf::from); - if let Some(dir) = set("CADCRAFT_CONFIG_DIR") { - return Some(dir); - } - if cfg!(target_os = "macos") { - set("HOME").map(|h| h.join("Library/Application Support/CADCraft")) - } else if cfg!(windows) { - set("APPDATA").map(|a| a.join("CADCraft")) - } else { - // The XDG spec ignores a relative XDG_CONFIG_HOME. - set("XDG_CONFIG_HOME").filter(|p| p.is_absolute()).or_else(|| set("HOME").map(|h| h.join(".config"))).map(|c| c.join("cadcraft")) - } -} - const APP_ID: &str = "ai.storyteller.cadcraft"; /// Stencil bits of the window's render pass (see `NativeOptions::stencil_buffer`). @@ -227,32 +209,7 @@ fn app_icon() -> Option { } fn version_string() -> String { - let sha = option_env!("CADCRAFT_BUILD_SHA").unwrap_or("dev"); - format!("cadcraft {} ({sha})", env!("CARGO_PKG_VERSION")) -} - -/// The control port from `--control ` or `CADCRAFT_CONTROL_PORT` (`source`); a value that is -/// not a port is logged and ignored instead of silently starting no control channel. -fn control_port_from(source: &str, value: Option) -> Option { - let value = value?; - let port = value.trim().parse().ok(); - if port.is_none() { - log::warn!("{source}: {value:?} is not a port number; the control channel is off"); - } - port -} - -/// `--control` followed by `value`: a bare `--control` (last argument) keeps the port already -/// read from `CADCRAFT_CONTROL_PORT` (`current`) instead of turning the control channel off. -fn control_flag(current: Option, value: Option) -> Option { - if value.is_some() { - return control_port_from("--control", value); - } - match current { - Some(port) => log::warn!("--control: no port given; using CADCRAFT_CONTROL_PORT ({port})"), - None => log::warn!("--control: no port given; the control channel is off"), - } - current + format!("cadcraft {}", cadcraft_engine::build_version()) } /// Parse CLI options (`--control`, `--sample`, files, `--version`), install logging and I/O hooks, build the services and app, and run eframe. @@ -268,37 +225,33 @@ fn main() -> eframe::Result { } return Ok(()); } - // lossy, so a value that is not Unicode is reported like any other bad port instead of ignored - let mut control_port = - control_port_from("CADCRAFT_CONTROL_PORT", std::env::var_os("CADCRAFT_CONTROL_PORT").map(|p| p.to_string_lossy().into_owned())); - let mut files = Vec::new(); - let mut sample = false; - let mut args = std::env::args().skip(1); - while let Some(a) = args.next() { - match a.as_str() { - "--control" => control_port = control_flag(control_port, args.next()), - "--sample" => sample = true, - "--version" | "-V" => { - println!("{}", version_string()); - return Ok(()); - } - _ => files.push(a), - } - } + // `--help` and `--version` print to standard output and exit 0. A usage error (an unknown or + // repeated flag, a missing or bad value, a bad CADCRAFT_CONTROL_PORT) names the argument on + // standard error and exits 2 before the window opens. + let launch = launch_args::parse(launch_args::command(), std::env::args_os().skip(1)).unwrap_or_else(|e| e.exit()); + let vars = env::Env::read(); + let (control_port, sample, files) = (launch.control, launch.sample, launch.files); // The log file lives under the settings directory; opened after the arguments, so `--version` // leaves no file behind. Records logged until now are written to it first. if let Some(logger) = logger { - match config_dir().map(|d| logger.attach_dir(&d.join(logging::LOG_DIR))) { + match vars.config_dir.as_ref().map(|d| logger.attach_dir(&d.join(logging::LOG_DIR))) { Some(Ok(path)) => log::info!("{} ({} {}), log file {}", version_string(), std::env::consts::OS, std::env::consts::ARCH, path.display()), Some(Err(e)) => log::warn!("no log file: {e}"), None => { logger.stderr_only(); - log::warn!("no log file: no settings directory (set CADCRAFT_CONFIG_DIR)"); + log::warn!("no log file: no settings directory (an empty CADCRAFT_CONFIG_DIR turns it off)"); } } } install_io(); - let surface = cadcraft_ui_egui::gpu::surface_config(std::env::var("CADCRAFT_VSYNC").ok().as_deref(), cfg!(all(unix, not(target_os = "macos")))); + cadcraft_engine::settings_dir::set(vars.config_dir.clone()); + if let Some(name) = &vars.font_alt { + cadcraft_engine::fonts::ttf::set_font_alt(name); + } + if let Some(list) = &vars.font_fallback { + cadcraft_engine::fonts::ttf::set_fallback_fonts(list); + } + let surface = cadcraft_ui_egui::gpu::surface_config(vars.vsync, cfg!(all(unix, not(target_os = "macos")))); let mut options = eframe::NativeOptions { // The crosshair is drawn by the app: present without a queue on Linux/BSD, where X11 // swapchains hold two frames back under vsync (`CADCRAFT_VSYNC=1` restores vsync). @@ -341,7 +294,7 @@ fn main() -> eframe::Result { // manager showed a "no" cursor. Run through XWayland when it's there; CADCRAFT_WAYLAND=1 // keeps the native Wayland backend. #[cfg(all(unix, not(target_os = "macos")))] - if std::env::var_os("DISPLAY").is_some() && std::env::var_os("CADCRAFT_WAYLAND").is_none() { + if std::env::var_os("DISPLAY").is_some() && vars.wayland != Switch::On { options.event_loop_builder = Some(Box::new(|b| { use winit::platform::x11::EventLoopBuilderExtX11; b.with_x11(); @@ -352,15 +305,16 @@ fn main() -> eframe::Result { options, Box::new(move |cc| { let mut app = CadApp::new(Session::empty(), services()); - let (workspace, restored, workspace_error) = workspace::Workspace::load(); + let (workspace, restored, workspace_error) = workspace::Workspace::load(vars.config_dir.as_deref()); if let Some(ui) = restored { app.ui = ui; } + app.set_system_cursor_default(vars.system_cursor == Switch::On); if let Some(error) = &workspace_error { eprintln!("CADCraft workspace: {error}"); app.set_status(error); } - app.system_languages = std::env::var("CADCRAFT_LOCALE").map(|s| vec![s]).unwrap_or_else(|_| sys_locale::get_locales().collect()); + app.system_languages = vars.locale.map(|s| vec![s]).unwrap_or_else(|| sys_locale::get_locales().collect()); // The user profile (Options): drafting settings, selection sizes, drawing-area colours. if let Some(profile) = cc.storage.and_then(|s| s.get_string(cadcraft_ui_egui::options::PROFILE_KEY)) { app.load_profile(&profile); @@ -372,7 +326,7 @@ fn main() -> eframe::Result { cadcraft_ui_egui::autosave::load_prefs(&prefs); } // Autosave files (SAVEFILEPATH) default to `/autosave`. - if let Some(dir) = config_dir() { + if let Some(dir) = &vars.config_dir { app.enable_autosave(&dir.join("autosave")); app.enable_update_check(); // Startup LISP (acad.lsp, acaddoc.lsp) is read from `/support`; the @@ -419,6 +373,8 @@ fn main() -> eframe::Result { #[cfg(target_os = "macos")] native_menu: None, #[cfg(target_os = "macos")] + menus_in_window: vars.no_native_menu == Switch::On, + #[cfg(target_os = "macos")] movable: None, })) }), @@ -427,13 +383,7 @@ fn main() -> eframe::Result { #[cfg(test)] mod tests { - use super::{config_dir_from, control_flag, control_port_from, filters_for_save, follow_desktop}; - use std::ffi::OsString; - use std::path::PathBuf; - - fn env<'a>(vars: &'a [(&'a str, &'a str)]) -> impl Fn(&str) -> Option + 'a { - move |k| vars.iter().find(|(n, _)| *n == k).map(|(_, v)| OsString::from(v)) - } + use super::{filters_for_save, follow_desktop}; #[test] fn save_dialog_offers_dwg_with_the_drawing_format_first() { @@ -451,59 +401,6 @@ mod tests { } } - #[test] - fn control_port_values_that_are_not_ports_are_ignored() { - assert_eq!(control_port_from("--control", Some("7979".into())), Some(7979)); - assert_eq!(control_port_from("--control", Some(" 7979 ".into())), Some(7979)); - assert_eq!(control_port_from("--control", None), None); - for bad in ["", "abc", "-1", "65536", "99999999999999999999", "\u{0}"] { - assert_eq!(control_port_from("--control", Some(bad.into())), None, "{bad:?}"); - } - } - - #[test] - fn control_without_a_port_keeps_the_environment_port() { - // `CADCRAFT_CONTROL_PORT=47321 cadcraft --control` (#844) - assert_eq!(control_flag(Some(47321), None), Some(47321)); - assert_eq!(control_flag(None, None), None); - // A port given on the command line still wins over the variable. - assert_eq!(control_flag(Some(47321), Some("7979".into())), Some(7979)); - assert_eq!(control_flag(Some(47321), Some("abc".into())), None); - } - - #[test] - fn the_override_variable_wins_and_empty_values_are_unset() { - let vars = [("CADCRAFT_CONFIG_DIR", "/tmp/cc"), ("HOME", "/home/u"), ("XDG_CONFIG_HOME", "/x"), ("APPDATA", "C:\\a")]; - assert_eq!(config_dir_from(env(&vars)), Some(PathBuf::from("/tmp/cc"))); - let empty = [("CADCRAFT_CONFIG_DIR", ""), ("HOME", ""), ("XDG_CONFIG_HOME", ""), ("APPDATA", "")]; - assert_eq!(config_dir_from(env(&empty)), None, "no usable variable means no directory, not the working directory"); - assert_eq!(config_dir_from(env(&[])), None); - } - - #[cfg(all(unix, not(target_os = "macos")))] - #[test] - fn linux_and_bsd_follow_xdg_config_home() { - assert_eq!(config_dir_from(env(&[("XDG_CONFIG_HOME", "/x"), ("HOME", "/home/u")])), Some(PathBuf::from("/x/cadcraft"))); - assert_eq!(config_dir_from(env(&[("HOME", "/home/u")])), Some(PathBuf::from("/home/u/.config/cadcraft"))); - // The XDG spec says a relative XDG_CONFIG_HOME is ignored. - assert_eq!(config_dir_from(env(&[("XDG_CONFIG_HOME", "rel"), ("HOME", "/home/u")])), Some(PathBuf::from("/home/u/.config/cadcraft"))); - } - - #[cfg(target_os = "macos")] - #[test] - fn macos_uses_application_support() { - assert_eq!(config_dir_from(env(&[("HOME", "/Users/u")])), Some(PathBuf::from("/Users/u/Library/Application Support/CADCraft"))); - } - - #[cfg(windows)] - #[test] - fn windows_uses_appdata() { - assert_eq!( - config_dir_from(env(&[("APPDATA", "C:\\Users\\u\\AppData\\Roaming")])), - Some(PathBuf::from("C:\\Users\\u\\AppData\\Roaming").join("CADCraft")) - ); - } - /// View ▸ Theme ▸ System on Linux: winit reports no theme, so the desktop's answer stands in; /// without one (or where winit answers and the desktop doesn't) the input is left alone. #[test] diff --git a/apps/cadcraft/src/workspace.rs b/apps/cadcraft/src/workspace.rs index b8e541ed3..b75c9bc70 100644 --- a/apps/cadcraft/src/workspace.rs +++ b/apps/cadcraft/src/workspace.rs @@ -1,6 +1,5 @@ //! Native workspace preferences. Drawing data and transient dialogs never enter this file. -use std::ffi::OsString; use std::fs::{self, File, OpenOptions}; use std::io::{Read, Write}; use std::path::{Path, PathBuf}; @@ -24,18 +23,6 @@ pub struct Workspace { last_write: Option, } -fn config_dir_from(platform: &str, get: impl Fn(&str) -> Option) -> Option { - if let Some(root) = get("CADCRAFT_CONFIG_DIR") { - return (!root.is_empty()).then(|| PathBuf::from(root)); - } - let nonempty = |key| get(key).filter(|value| !value.is_empty()).map(PathBuf::from); - match platform { - "macos" => nonempty("HOME").map(|home| home.join("Library/Application Support/CADCraft")), - "windows" => nonempty("APPDATA").map(|root| root.join("CADCraft")), - _ => nonempty("XDG_CONFIG_HOME").map(|root| root.join("cadcraft")).or_else(|| nonempty("HOME").map(|home| home.join(".config/cadcraft"))), - } -} - fn snapshot(ui: &UiState) -> Result { cadcraft_ui_egui::docking::validate(&ui.docking)?; if !matches!(ui.toolset_tab.as_str(), "Drafting" | "Modeling") { @@ -139,8 +126,9 @@ fn write(path: &Path, workspace: &Value) -> Result<(), String> { } impl Workspace { - pub fn load() -> (Self, Option, Option) { - Self::at(config_dir_from(std::env::consts::OS, |key| std::env::var_os(key)).map(|root| root.join("workspace.json"))) + /// The workspace file in the settings directory `config_dir`; without one nothing is kept. + pub fn load(config_dir: Option<&Path>) -> (Self, Option, Option) { + Self::at(config_dir.map(|root| root.join("workspace.json"))) } fn at(path: Option) -> (Self, Option, Option) { @@ -195,6 +183,7 @@ impl Workspace { #[cfg(test)] mod tests { use super::*; + use std::ffi::OsString; fn temp_dir() -> PathBuf { let sequence = TEMP_SEQUENCE.fetch_add(1, Ordering::Relaxed); @@ -205,20 +194,18 @@ mod tests { #[test] fn profile_override_isolated_or_explicitly_disabled() { - let get = |key: &str| match key { - "CADCRAFT_CONFIG_DIR" => Some(OsString::from("/private/test-state")), - "HOME" | "APPDATA" | "XDG_CONFIG_HOME" => Some(OsString::from("/unrelated-user-profile")), - _ => None, + let vars = |config: Option<&'static str>| { + move |key: &str| match key { + "CADCRAFT_CONFIG_DIR" => config.map(OsString::from), + "HOME" | "APPDATA" | "XDG_CONFIG_HOME" => Some(OsString::from("/unrelated-user-profile")), + _ => None, + } }; - for platform in ["macos", "windows", "linux", "freebsd"] { - assert_eq!(config_dir_from(platform, get), Some(PathBuf::from("/private/test-state"))); - assert_eq!(config_dir_from(platform, |key| if key == "CADCRAFT_CONFIG_DIR" { Some(OsString::new()) } else { get(key) }), None); - } - assert_eq!( - config_dir_from("linux", |key| (key == "XDG_CONFIG_HOME").then(|| OsString::from("/config"))), - Some(PathBuf::from("/config/cadcraft")) - ); - assert_eq!(config_dir_from("macos", |_| None), None); + let dir = |config| crate::env::Env::from_vars(vars(config)).config_dir; + assert_eq!(dir(Some("/private/test-state")), Some(PathBuf::from("/private/test-state"))); + assert_eq!(dir(Some("")), None); + let (_, restored, error) = Workspace::load(dir(Some("")).as_deref()); + assert!(restored.is_none() && error.is_none(), "no settings folder, no workspace file"); } #[test] diff --git a/crates/doc/src/format.rs b/crates/doc/src/format.rs new file mode 100644 index 000000000..132a8c1aa --- /dev/null +++ b/crates/doc/src/format.rs @@ -0,0 +1,100 @@ +use std::path::Path; + +/// A file format, chosen by the file name's extension (ASCII case-insensitive). +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum Format { + Dxf, + Dwg, + /// A drawing template: DWG content. + Dwt, + Svg, + /// Gzip-compressed SVG. + Svgz, + Png, + Pdf, +} + +impl Format { + /// The formats a drawing can be read from by name. DXF and DWG are also recognised by content. + pub const READ: &'static [Format] = &[Format::Dxf, Format::Dwg, Format::Svg, Format::Svgz]; + /// The formats a drawing can be written to. + pub const WRITE: &'static [Format] = &[Format::Dxf, Format::Dwg, Format::Dwt, Format::Svg, Format::Png, Format::Pdf]; + + /// The format `path`'s extension names. A name without an extension is DXF; an unknown + /// extension is `None`. + pub fn from_path(p: impl AsRef) -> Option { + let ext = p.as_ref().extension().map(|e| e.to_string_lossy().to_ascii_lowercase()).unwrap_or_default(); + Some(match ext.as_str() { + "dxf" | "" => Format::Dxf, + "dwg" => Format::Dwg, + "dwt" => Format::Dwt, + "svg" => Format::Svg, + "svgz" => Format::Svgz, + "png" => Format::Png, + "pdf" => Format::Pdf, + _ => return None, + }) + } + + /// The extension, lower case and without the dot. + pub fn extension(self) -> &'static str { + match self { + Format::Dxf => "dxf", + Format::Dwg => "dwg", + Format::Dwt => "dwt", + Format::Svg => "svg", + Format::Svgz => "svgz", + Format::Png => "png", + Format::Pdf => "pdf", + } + } + + /// Written as an image (model space fitted to a frame), so framing applies. SVGZ is read only. + pub fn is_image(self) -> bool { + matches!(self, Format::Svg | Format::Png | Format::Pdf) + } + + /// A drawing file (DXF, DWG, template) rather than an image. + pub fn is_drawing(self) -> bool { + matches!(self, Format::Dxf | Format::Dwg | Format::Dwt) + } + + /// Written as DWG, which drops the object types the DWG writer doesn't know. + pub fn drops_unknown(self) -> bool { + matches!(self, Format::Dwg | Format::Dwt) + } + + /// `formats` as "dxf, dwg, svg": the list help text shows. + pub fn list(formats: &[Format]) -> String { + formats.iter().map(|f| f.extension()).collect::>().join(", ") + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn from_path_by_extension() { + for f in [Format::Dxf, Format::Dwg, Format::Dwt, Format::Svg, Format::Svgz, Format::Png, Format::Pdf] { + assert_eq!(Format::from_path(format!("a/b.{}", f.extension())), Some(f)); + assert_eq!(Format::from_path(format!("B.{}", f.extension().to_ascii_uppercase())), Some(f)); + } + assert_eq!(Format::from_path("Drawing1"), Some(Format::Dxf), "no extension is DXF"); + assert_eq!(Format::from_path("dir.dwg/Drawing1"), Some(Format::Dxf)); + assert_eq!(Format::from_path("a."), Some(Format::Dxf)); + assert_eq!(Format::from_path("a.txt"), None); + assert_eq!(Format::from_path("a.dxf.bak"), None); + assert_eq!(Format::from_path(std::path::Path::new("x.PnG")), Some(Format::Png)); + } + + #[test] + fn classes() { + assert!(Format::READ.contains(&Format::Svgz) && !Format::WRITE.contains(&Format::Svgz)); + assert!(Format::WRITE.contains(&Format::Dwt) && !Format::READ.contains(&Format::Dwt)); + assert!(Format::WRITE.iter().filter(|f| f.is_image()).count() == 3 && !Format::Svgz.is_image()); + assert!(Format::Dwt.drops_unknown() && Format::Dwg.drops_unknown() && !Format::Dxf.drops_unknown()); + assert!(Format::Dwt.is_drawing() && !Format::Pdf.is_drawing()); + assert_eq!(Format::list(Format::READ), "dxf, dwg, svg, svgz"); + } +} diff --git a/crates/doc/src/lib.rs b/crates/doc/src/lib.rs index eafea9e27..d970a6a56 100644 --- a/crates/doc/src/lib.rs +++ b/crates/doc/src/lib.rs @@ -10,6 +10,7 @@ mod array; mod constraint; mod entity; mod extents; +mod format; mod gdt; mod header; pub mod library; @@ -27,6 +28,7 @@ pub use cadcraft_geom as geom; pub use constraint::*; pub use entity::*; pub use extents::{MAX_BLOCK_DEPTH, entity_bounds}; +pub use format::Format; pub use gdt::*; pub use header::{HVal, Header}; pub use plotstyle::*; diff --git a/crates/engine/src/cmd/file.rs b/crates/engine/src/cmd/file.rs index 95975a4e2..3a5296e88 100644 --- a/crates/engine/src/cmd/file.rs +++ b/crates/engine/src/cmd/file.rs @@ -7,7 +7,7 @@ mod template; use std::sync::OnceLock; -use cadcraft_doc::Drawing; +use cadcraft_doc::{Drawing, Format}; pub use cadcraft_dxf::Version; use serde_json::{Value, json}; @@ -136,8 +136,7 @@ fn save_options(cmd: &str, p: &Value) -> Result { /// Whether `path` names a DXF file (or has no extension, which saves as DXF). fn is_dxf(path: &str) -> bool { - let ext = std::path::Path::new(path).extension().map(|e| e.to_string_lossy().to_ascii_lowercase()).unwrap_or_default(); - matches!(ext.as_str(), "dxf" | "") + Format::from_path(path) == Some(Format::Dxf) } /// The drawing written to `path` with `opts`: through [`IoHooks::write`] when no option is set, @@ -273,17 +272,21 @@ pub struct ReadFile { } /// Read and decode `path` (the slow half of `OPEN {path}`). Needs no session; runs anywhere. -pub fn read_file(path: &str) -> std::result::Result { +pub fn read_file(path: &std::path::Path) -> std::result::Result { #[cfg(not(target_arch = "wasm32"))] { let r = std::panic::catch_unwind(|| { - let bytes = - crate::capped_read::read_capped(std::path::Path::new(path), MAX_DRAWING_BYTES).map_err(|e| bad("open", format!("{path}: {e}")))?; - read_bytes(&bytes, path, Some(path.to_string())) + let shown = path.display(); + // The session keeps paths as text; a name that isn't Unicode could never be saved back to. + let Some(text_path) = path.to_str() else { + return Err(bad("open", format!("{shown}: the file name is not valid Unicode, so CADCraft can't save back to it"))); + }; + let bytes = crate::capped_read::read_capped(path, MAX_DRAWING_BYTES).map_err(|e| bad("open", format!("{shown}: {e}")))?; + read_bytes(&bytes, text_path, Some(text_path.to_string())) }); match r { Ok(r) => r.map_err(|e| e.to_string()), - Err(_) => Err(bad("open", format!("{path}: the file could not be read")).to_string()), + Err(_) => Err(bad("open", format!("{}: the file could not be read", path.display())).to_string()), } } #[cfg(target_arch = "wasm32")] @@ -515,7 +518,7 @@ fn run_bytes(s: &mut Session, p: &Value) -> Result { let lost = not_saved_as(s.doc()?, version); let bytes = write_bytes(s, "document.bytes", &format!("drawing.{fmt}"), &opts)?; let mut r = json!({ "data": base64_encode(&bytes), "bytes": bytes.len() }); - if drops_unknown(&format!("drawing.{fmt}")) { + if drops_unknown(format!("drawing.{fmt}")) { report_not_saved(s, &mut r, &lost); } Ok(r) @@ -563,15 +566,13 @@ pub fn not_saved_message(lost: &std::collections::BTreeMap) -> Op /// Whether saving to `path` leaves out the entities [`not_saved`] counts: DWG does (the DWG /// bridge drops types it doesn't know); DXF writes them back as read. -pub fn drops_unknown(path: &str) -> bool { - // Templates (.dwt) are written as DWG too. - std::path::Path::new(path).extension().is_some_and(|e| e.eq_ignore_ascii_case("dwg") || e.eq_ignore_ascii_case("dwt")) +pub fn drops_unknown(path: impl AsRef) -> bool { + Format::from_path(path).is_some_and(Format::drops_unknown) } /// Whether `path` is saved as a drawing (DXF, DWG) rather than exported as an image. -fn is_drawing_file(path: &str) -> bool { - let ext = std::path::Path::new(path).extension().map(|e| e.to_string_lossy().to_ascii_lowercase()).unwrap_or_default(); - matches!(ext.as_str(), "dxf" | "dwg" | "dwt" | "") +fn is_drawing_file(path: impl AsRef) -> bool { + Format::from_path(path).is_some_and(Format::is_drawing) } /// Say on the command line what the file couldn't keep, and list it in the result's `notSaved`. diff --git a/crates/engine/src/cmd/plotters.rs b/crates/engine/src/cmd/plotters.rs index 370f03518..903ef1bc4 100644 --- a/crates/engine/src/cmd/plotters.rs +++ b/crates/engine/src/cmd/plotters.rs @@ -61,23 +61,13 @@ impl PlotterStore { } } - /// The `plotters` folder of the CADCraft settings directory (`CADCRAFT_CONFIG_DIR`, else - /// the platform's settings directory). + /// The `plotters` folder of the CADCraft settings directory ([`crate::settings_dir::current`]). #[cfg(not(target_arch = "wasm32"))] pub fn settings_folder() -> PlotterStore { fn dir() -> std::result::Result { - use std::path::PathBuf; - let get = |k: &str| std::env::var_os(k).filter(|v| !v.is_empty()).map(PathBuf::from); - let root = match std::env::var_os("CADCRAFT_CONFIG_DIR") { - Some(r) if !r.is_empty() => Some(PathBuf::from(r)), - Some(_) => None, - None => match std::env::consts::OS { - "macos" => get("HOME").map(|h| h.join("Library/Application Support/CADCraft")), - "windows" => get("APPDATA").map(|r| r.join("CADCraft")), - _ => get("XDG_CONFIG_HOME").map(|r| r.join("cadcraft")).or_else(|| get("HOME").map(|h| h.join(".config/cadcraft"))), - }, - }; - root.map(|r| r.join("plotters")).ok_or_else(|| "there is no settings folder for plotter configurations".to_string()) + crate::settings_dir::current() + .map(|r| r.join("plotters")) + .ok_or_else(|| "there is no settings folder for plotter configurations".to_string()) } /// A plain file name of ours (no separators, no parent references). fn file(n: &str) -> std::result::Result { diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index caeda8d7d..dbb1d0e6b 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -29,6 +29,7 @@ pub mod prompt; mod recent; pub mod sample; pub mod select; +pub mod settings_dir; pub mod snap; pub mod spatial; pub mod sysvars; @@ -43,6 +44,7 @@ use serde::{Deserialize, Serialize}; use serde_json::Value; pub use cadcraft_doc as doc; +pub use cadcraft_fonts as fonts; pub use cadcraft_geom as geom; pub use cadcraft_render as render; pub use cmd::hatch::{HatchPicks, PatternChoice, PickMode, pattern_choices}; @@ -64,6 +66,14 @@ pub use running::{PendingWindow, Running}; pub use settings::Settings; pub use view::{ModelTile, ModelTiles, View}; +/// ` ()`, what `--version` prints after the program name in the app and the CLI. +/// The commit comes from `CADCRAFT_BUILD_SHA` at build time, `dev` without it. +pub fn build_version() -> &'static str { + static VERSION: std::sync::LazyLock = + std::sync::LazyLock::new(|| format!("{} ({})", env!("CARGO_PKG_VERSION"), option_env!("CADCRAFT_BUILD_SHA").unwrap_or("dev"))); + &VERSION +} + /// The editor session: open drawings, settings, the running command and the command log. pub struct Session { pub docs: Vec, diff --git a/crates/engine/src/lisp/builtins/files.rs b/crates/engine/src/lisp/builtins/files.rs index f97045a2b..44452ae89 100644 --- a/crates/engine/src/lisp/builtins/files.rs +++ b/crates/engine/src/lisp/builtins/files.rs @@ -73,17 +73,17 @@ pub(super) fn findfile(a: &[Value]) -> R { /// Read a regular text file up to 64 MiB, replacing invalid UTF-8 and returning `None` on read failure. #[cfg(not(target_arch = "wasm32"))] -pub fn read_text_file(path: &str) -> Option { +pub fn read_text_file(path: impl AsRef) -> Option { // Read through a byte-limited, regular-file-only reader so a path naming an endless device // cannot exhaust memory before the 64 MiB cap is enforced (CWE-400). const MAX: usize = 64 * 1024 * 1024; - let bytes = crate::capped_read::read_capped(std::path::Path::new(path), MAX).ok()?; + let bytes = crate::capped_read::read_capped(path.as_ref(), MAX).ok()?; Some(String::from_utf8_lossy(&bytes).into_owned()) } /// Return `None` on the web, where native filesystem paths are unavailable. #[cfg(target_arch = "wasm32")] -pub fn read_text_file(_path: &str) -> Option { +pub fn read_text_file(_path: impl AsRef) -> Option { None } diff --git a/crates/engine/src/lisp/drawing.rs b/crates/engine/src/lisp/drawing.rs index b4076fce6..0042ea434 100644 --- a/crates/engine/src/lisp/drawing.rs +++ b/crates/engine/src/lisp/drawing.rs @@ -1097,5 +1097,5 @@ pub fn load_source(s: &Session, name: &str) -> Option { // As given (a path, or relative to the working folder), then in the support folder. let support = s.lisp_support_dir().map(|d| candidates.iter().map(|c| d.join(c).to_string_lossy().into_owned()).collect::>()).unwrap_or_default(); - candidates.iter().chain(&support).find_map(|c| super::builtins::read_text_file(c)) + candidates.iter().chain(&support).find_map(super::builtins::read_text_file) } diff --git a/crates/engine/src/lisp/startup.rs b/crates/engine/src/lisp/startup.rs index 118f4e7a1..392f88095 100644 --- a/crates/engine/src/lisp/startup.rs +++ b/crates/engine/src/lisp/startup.rs @@ -42,7 +42,7 @@ impl Session { if once && self.lisp.acad_loaded && !per_drawing { continue; } - let Some(text) = super::builtins::read_text_file(&dir.join(name).to_string_lossy()) else { continue }; + let Some(text) = super::builtins::read_text_file(dir.join(name)) else { continue }; if once { self.lisp.acad_loaded = true; } diff --git a/crates/engine/src/settings_dir.rs b/crates/engine/src/settings_dir.rs new file mode 100644 index 000000000..689a5ade2 --- /dev/null +++ b/crates/engine/src/settings_dir.rs @@ -0,0 +1,82 @@ +//! The per-user CADCraft settings directory (logs, autosave, plotter configurations). The host +//! chooses it ([`set`], possibly to none); without a choice it is the platform's ([`platform`]). + +use std::ffi::OsString; +use std::path::PathBuf; +use std::sync::Mutex; + +/// `None`: no choice yet; `Some(None)`: the host chose to have no settings directory. +static CHOSEN: Mutex>> = Mutex::new(None); + +/// The platform's settings directory, with `var` looking up the OS variables: `$XDG_CONFIG_HOME/cadcraft` +/// or `~/.config/cadcraft` on Linux and the BSDs, `~/Library/Application Support/CADCraft` on +/// macOS, `%APPDATA%\CADCraft` on Windows. An empty variable counts as unset, so a blank value +/// never means the working directory. +pub fn platform(var: impl Fn(&str) -> Option) -> Option { + let set = |k: &str| var(k).filter(|v| !v.is_empty()).map(PathBuf::from); + if cfg!(target_os = "macos") { + set("HOME").map(|h| h.join("Library/Application Support/CADCraft")) + } else if cfg!(windows) { + set("APPDATA").map(|a| a.join("CADCraft")) + } else { + // The XDG spec ignores a relative XDG_CONFIG_HOME. + set("XDG_CONFIG_HOME").filter(|p| p.is_absolute()).or_else(|| set("HOME").map(|h| h.join(".config"))).map(|c| c.join("cadcraft")) + } +} + +/// Use `dir` as the settings directory; `None` means there is none (plotter configurations are +/// neither read nor written). +pub fn set(dir: Option) { + if let Ok(mut chosen) = CHOSEN.lock() { + *chosen = Some(dir); + } +} + +/// The settings directory: the host's choice, else the platform's. +pub fn current() -> Option { + match CHOSEN.lock().ok().and_then(|c| c.clone()) { + Some(choice) => choice, + None => platform(|k| std::env::var_os(k)), + } +} + +#[cfg(test)] +mod tests { + use super::platform; + use std::ffi::OsString; + use std::path::PathBuf; + + fn env<'a>(vars: &'a [(&'a str, &'a str)]) -> impl Fn(&str) -> Option + 'a { + move |k| vars.iter().find(|(n, _)| *n == k).map(|(_, v)| OsString::from(v)) + } + + #[test] + fn empty_values_are_unset() { + assert_eq!(platform(env(&[("HOME", ""), ("XDG_CONFIG_HOME", ""), ("APPDATA", "")])), None, "not the working directory"); + assert_eq!(platform(env(&[])), None); + } + + #[cfg(all(unix, not(target_os = "macos")))] + #[test] + fn linux_and_bsd_follow_xdg_config_home() { + assert_eq!(platform(env(&[("XDG_CONFIG_HOME", "/x"), ("HOME", "/home/u")])), Some(PathBuf::from("/x/cadcraft"))); + assert_eq!(platform(env(&[("HOME", "/home/u")])), Some(PathBuf::from("/home/u/.config/cadcraft"))); + // The XDG spec says a relative XDG_CONFIG_HOME is ignored. + assert_eq!(platform(env(&[("XDG_CONFIG_HOME", "rel"), ("HOME", "/home/u")])), Some(PathBuf::from("/home/u/.config/cadcraft"))); + } + + #[cfg(target_os = "macos")] + #[test] + fn macos_uses_application_support() { + assert_eq!(platform(env(&[("HOME", "/Users/u")])), Some(PathBuf::from("/Users/u/Library/Application Support/CADCraft"))); + } + + #[cfg(windows)] + #[test] + fn windows_uses_appdata() { + assert_eq!( + platform(env(&[("APPDATA", "C:\\Users\\u\\AppData\\Roaming")])), + Some(PathBuf::from("C:\\Users\\u\\AppData\\Roaming").join("CADCraft")) + ); + } +} diff --git a/crates/engine/tests/read_file_unicode.rs b/crates/engine/tests/read_file_unicode.rs new file mode 100644 index 000000000..4c3c520e8 --- /dev/null +++ b/crates/engine/tests/read_file_unicode.rs @@ -0,0 +1,25 @@ +//! A drawing path that isn't valid Unicode is refused: the session keeps paths as text, so it +//! could never be saved back to. + +#![cfg(unix)] + +use std::ffi::OsString; +use std::os::unix::ffi::OsStringExt; + +use cadcraft_doc::Drawing; +use cadcraft_engine::cmd::file::{IoHooks, read_file, set_io}; + +#[test] +fn read_file_refuses_a_name_that_is_not_unicode() { + set_io(IoHooks { read: |_, _| Ok(Drawing::new_metric()), write: |_, _| Ok(Vec::new()), plot: None }); + let dir = std::env::temp_dir().join(format!("cadcraft-nonunicode-{}", std::process::id())); + std::fs::create_dir_all(&dir).unwrap(); + let good = dir.join("good.dxf"); + let bad = dir.join(OsString::from_vec(b"bad-\xff.dxf".to_vec())); + std::fs::write(&good, b"0\nEOF\n").unwrap(); + std::fs::write(&bad, b"0\nEOF\n").unwrap(); + let e = read_file(&bad).err().expect("a non-Unicode name is refused"); + assert!(e.contains("not valid Unicode") && e.contains("bad-"), "{e}"); + assert!(read_file(&good).is_ok()); + let _ = std::fs::remove_dir_all(&dir); +} diff --git a/crates/engine/tests/xref.rs b/crates/engine/tests/xref.rs index 405f71c66..d53e37886 100644 --- a/crates/engine/tests/xref.rs +++ b/crates/engine/tests/xref.rs @@ -29,7 +29,7 @@ fn folder(tag: &str) -> PathBuf { } fn save(d: &Drawing, path: &Path) { - std::fs::write(path, cadcraft_io::write(d, &path.to_string_lossy()).unwrap()).unwrap(); + std::fs::write(path, cadcraft_io::write(d, path).unwrap()).unwrap(); } fn line(d: &mut Drawing, layer: &str, a: (f64, f64), b: (f64, f64)) { diff --git a/crates/fonts/src/ttf.rs b/crates/fonts/src/ttf.rs index 52998900c..6b4c5ebdd 100644 --- a/crates/fonts/src/ttf.rs +++ b/crates/fonts/src/ttf.rs @@ -11,8 +11,7 @@ //! - [`fallback_fonts`] (`FONTFALLBACK`): fonts tried first for characters the text's font //! lacks (CJK in an SHX big font, for example), before the automatic system font search. //! -//! On native builds both start from the `CADCRAFT_FONTALT` / `CADCRAFT_FONTFALLBACK` -//! environment variables. +//! Both start empty; the host sets its starting values ([`set_font_alt`], [`set_fallback_fonts`]). use std::collections::HashMap; use std::path::PathBuf; @@ -524,16 +523,8 @@ struct Prefs { } fn prefs() -> MutexGuard<'static, Prefs> { - static P: OnceLock> = OnceLock::new(); - P.get_or_init(|| { - #[cfg(not(target_arch = "wasm32"))] - let env = |k: &str| std::env::var(k).unwrap_or_default(); - #[cfg(target_arch = "wasm32")] - let env = |_: &str| String::new(); - Mutex::new(Prefs { alt: clean_name(&env("CADCRAFT_FONTALT")), fallback: split_list(&env("CADCRAFT_FONTFALLBACK")) }) - }) - .lock() - .unwrap_or_else(PoisonError::into_inner) + static P: Mutex = Mutex::new(Prefs { alt: String::new(), fallback: Vec::new() }); + P.lock().unwrap_or_else(PoisonError::into_inner) } /// A font name setting: trimmed, capped, "." = none. diff --git a/crates/io/src/lib.rs b/crates/io/src/lib.rs index ef56e6602..8cad3f24f 100644 --- a/crates/io/src/lib.rs +++ b/crates/io/src/lib.rs @@ -22,7 +22,9 @@ mod dxf_mline; use cadcraft_doc::{Drawing, Space}; use cadcraft_geom::Bounds2; +use std::path::{Path, PathBuf}; +pub use cadcraft_doc::Format; pub use cadcraft_dxf::Version; pub use dxf_read::entity_from_groups; pub use dxf_write::entity_groups; @@ -53,40 +55,42 @@ pub enum IoError { pub type Result = std::result::Result; -fn ext(name: &str) -> String { - std::path::Path::new(name).extension().map(|e| e.to_string_lossy().to_ascii_lowercase()).unwrap_or_default() +fn ext(name: impl AsRef) -> String { + name.as_ref().extension().map(|e| e.to_string_lossy().to_ascii_lowercase()).unwrap_or_default() } /// Read a drawing; the format comes from the content (DXF ASCII/binary, DWG) or the name /// (SVG and gzip-compressed SVGZ). -pub fn read(bytes: &[u8], name: &str) -> Result { +pub fn read(bytes: &[u8], name: impl AsRef) -> Result { + let name = name.as_ref(); if cadcraft_dwg::is_dwg(bytes) { let (dxf, notes) = cadcraft_dwg::dwg_to_dxf_noted(bytes, cadcraft_dwg::Limits::DEFAULT).map_err(IoError::Format)?; let mut d = dxf_read::read(&dxf).map_err(|e| IoError::Format(format!("{e} (in the DXF converted from this DWG)")))?; d.read_notes = notes; return Ok(d); } - match ext(name).as_str() { - "svg" | "svgz" => svg_read::read(bytes), - "dxf" | "" => dxf_read::read(bytes), - e if bytes.len() > 4 => dxf_read::read(bytes).map_err(|_| IoError::Unsupported(e.to_string())), - e => Err(IoError::Unsupported(e.to_string())), + match (Format::from_path(name), ext(name).as_str()) { + (Some(Format::Svg | Format::Svgz), _) => svg_read::read(bytes), + (Some(Format::Dxf), _) => dxf_read::read(bytes), + (_, e) if bytes.len() > 4 => dxf_read::read(bytes).map_err(|_| IoError::Unsupported(e.to_string())), + (_, e) => Err(IoError::Unsupported(e.to_string())), } } /// Write a drawing in the format chosen by the name's extension. Images (PNG, SVG, PDF) show /// model space fitted to its extents. DXF and DWG are written in the drawing's version /// ([`save_version`]), DXF as ASCII. -pub fn write(d: &Drawing, name: &str) -> Result> { +pub fn write(d: &Drawing, name: impl AsRef) -> Result> { write_framed(d, name, None) } /// Like [`write`], with the DXF/DWG version and binary DXF chosen by `opts`. Binary applies to /// DXF only; asking for it with another format is an error. -pub fn write_with(d: &Drawing, name: &str, opts: &SaveOptions) -> Result> { +pub fn write_with(d: &Drawing, name: impl AsRef, opts: &SaveOptions) -> Result> { + let name = name.as_ref(); let version = opts.version.unwrap_or_else(|| save_version(d)); - match ext(name).as_str() { - "dxf" | "" => { + match Format::from_path(name) { + Some(Format::Dxf) => { let tags = dxf_write::tags(d, version); Ok(if opts.binary { cadcraft_dxf::write_binary(&tags, version.utf8()) @@ -97,11 +101,11 @@ pub fn write_with(d: &Drawing, name: &str, opts: &SaveOptions) -> Result // The DWG bridge reads our R2000 DXF and writes the DWG at the version asked for. Without // one, at least 2004: R2000 DWG has no true colours, transparency, table styles or // gradients, so a drawing from an R2000 DXF doesn't lose them by default. - "dwg" if !opts.binary => { + Some(Format::Dwg) if !opts.binary => { let version = opts.version.unwrap_or_else(|| version.max(Version::R2004)); cadcraft_dwg::dxf_to_dwg_as(dxf_write::dwg_bridge(d, version).as_bytes(), version.code()).map_err(IoError::Format) } - e if opts.binary => Err(IoError::Format(format!("binary output is for DXF files, not `{e}`"))), + _ if opts.binary => Err(IoError::Format(format!("binary output is for DXF files, not `{}`", ext(name)))), _ => write_framed(d, name, None), } } @@ -110,28 +114,32 @@ pub fn write_with(d: &Drawing, name: &str, opts: &SaveOptions) -> Result /// drawing units, centred and scaled to fit the image without distortion) instead of the /// extents. Formats that are not images (DXF, DWG) ignore the window. The window is checked with /// [`check_window`]. -pub fn write_framed(d: &Drawing, name: &str, window: Option) -> Result> { +pub fn write_framed(d: &Drawing, name: impl AsRef, window: Option) -> Result> { + let name = name.as_ref(); // A drawing template (.dwt) is DWG content. - if ext(name) == "dwt" { - return write_framed(d, &format!("{name}.dwg"), None); + let format = Format::from_path(name); + if format == Some(Format::Dwt) { + let mut dwg = name.as_os_str().to_owned(); + dwg.push(".dwg"); + return write_framed(d, PathBuf::from(dwg), None); } if let Some(w) = &window && is_image(name) { check_window(w)?; } - match ext(name).as_str() { - "dxf" | "" | "dwg" => write_with(d, name, &SaveOptions::default()), - "svg" => Ok(svg::export_window(d, &Space::Model, window).into_bytes()), - "png" => png_framed(d, &Space::Model, 2400, 1600, window), - "pdf" => pdf::pdf(d, &Space::Model, &PdfOptions { compress: true, window, ..PdfOptions::default() }), - e => Err(IoError::Unsupported(e.to_string())), + match format { + Some(Format::Dxf | Format::Dwg) => write_with(d, name, &SaveOptions::default()), + Some(Format::Svg) => Ok(svg::export_window(d, &Space::Model, window).into_bytes()), + Some(Format::Png) => png_framed(d, &Space::Model, 2400, 1600, window), + Some(Format::Pdf) => pdf::pdf(d, &Space::Model, &PdfOptions { compress: true, window, ..PdfOptions::default() }), + _ => Err(IoError::Unsupported(ext(name))), } } /// Whether `name` is written as an image (PNG, SVG, PDF), i.e. whether framing applies to it. -pub fn is_image(name: &str) -> bool { - matches!(ext(name).as_str(), "png" | "svg" | "pdf") +pub fn is_image(name: impl AsRef) -> bool { + Format::from_path(name).is_some_and(Format::is_image) } /// Largest coordinate magnitude accepted in an export window. diff --git a/crates/io/src/tests.rs b/crates/io/src/tests.rs index d5fe5d2f7..977a7c184 100644 --- a/crates/io/src/tests.rs +++ b/crates/io/src/tests.rs @@ -2813,3 +2813,17 @@ fn proxies_keep_their_class_when_classes_are_rewritten() { dxf_records(&pairs, "ACAD_PROXY_OBJECT").iter().map(|r| classes[own_91(r).parse::().unwrap() - 500].clone()).collect(); assert_eq!(names, ["VISUALSTYLE", "WIDGETX"]); } + +/// A name that isn't valid Unicode still picks its format by extension. +#[cfg(unix)] +#[test] +fn non_unicode_names_pick_the_format_by_extension() { + use std::os::unix::ffi::OsStringExt as _; + let name = |ext: &str| std::path::PathBuf::from(std::ffi::OsString::from_vec([b"caf\xe9.".as_slice(), ext.as_bytes()].concat())); + assert!(is_image(name("png")) && !is_image(name("dxf"))); + let d = sample(); + let bytes = write(&d, name("dxf")).unwrap(); + assert!(read(&bytes, name("dxf")).is_ok()); + assert!(write(&d, name("png")).unwrap().starts_with(b"\x89PNG")); + assert!(write(&d, name("dwt")).is_ok(), "a template is written as DWG"); +} diff --git a/crates/mcp/Cargo.toml b/crates/mcp/Cargo.toml index 955a6b6d2..1359fbdda 100644 --- a/crates/mcp/Cargo.toml +++ b/crates/mcp/Cargo.toml @@ -12,6 +12,7 @@ workspace = true cadcraft-engine = { workspace = true } cadcraft-render = { workspace = true } cadcraft-io = { workspace = true } +clap = { workspace = true } serde_json = { workspace = true } log = { workspace = true } # Secure randomness for the per-session control token (MIT OR Apache-2.0). diff --git a/crates/mcp/src/args.rs b/crates/mcp/src/args.rs new file mode 100644 index 000000000..a47a90bdd --- /dev/null +++ b/crates/mcp/src/args.rs @@ -0,0 +1,51 @@ +//! Helpers for clap parsers shared by the apps: environment variables as flag fallbacks. +//! +//! Apply [`blank_env_is_unset`] to the arguments, so an empty variable counts as unset, and pass a +//! parse error through [`name_env_vars`], so a bad value names the variable it came from. + +use std::ffi::{OsStr, OsString}; + +use clap::{Arg, Command}; + +/// For `Command::mut_args`: an empty or blank variable counts as unset, so `CADCRAFT_CONTROL_PORT=` +/// turns a fallback off without `unset`. clap would pass the empty value to the parser. `var` +/// looks the variable up. +pub fn blank_env_is_unset(arg: Arg, var: impl Fn(&OsStr) -> Option) -> Arg { + let blank = arg.get_env().and_then(var).is_some_and(|v| v.to_str().is_some_and(|v| v.trim().is_empty())); + if blank { arg.env(None::<&str>) } else { arg } +} + +/// clap names the flag when a value from its variable is bad or conflicts with another, as if the +/// flag had been given: name the variable instead when the flag isn't among `args` (without the +/// binary name; a first one naming a subcommand selects whose arguments to look in). +pub fn name_env_vars(mut error: clap::Error, cmd: &Command, args: &[OsString]) -> clap::Error { + use clap::error::{ContextKind, ContextValue}; + // `--flag value` or `--flag=value`. + let given = + |long: &str| args.iter().filter_map(|a| a.to_str()?.strip_prefix("--")?.strip_prefix(long)).any(|r| r.is_empty() || r.starts_with('=')); + let sub = args.first().and_then(|name| cmd.find_subcommand(name)).unwrap_or(cmd); + for kind in [ContextKind::InvalidArg, ContextKind::PriorArg] { + let Some(ContextValue::String(shown)) = error.get(kind) else { continue }; + let Some(arg) = sub.get_arguments().find(|a| a.to_string() == *shown) else { continue }; + let (Some(long), Some(var)) = (arg.get_long(), arg.get_env()) else { continue }; + if !given(long) { + error.insert(kind, ContextValue::String(var.to_string_lossy().into_owned())); + } + } + error +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn blank_variables_count_as_unset() { + let arg = || Arg::new("control").long("control").env("CADCRAFT_CONTROL_PORT"); + for value in ["", " "] { + assert_eq!(blank_env_is_unset(arg(), |_| Some(value.into())).get_env(), None, "{value:?}"); + } + assert!(blank_env_is_unset(arg(), |_| Some(" 50494 ".into())).get_env().is_some()); + assert!(blank_env_is_unset(arg(), |_| None).get_env().is_some()); + } +} diff --git a/crates/mcp/src/lib.rs b/crates/mcp/src/lib.rs index 7fcf4849d..932d855e4 100644 --- a/crates/mcp/src/lib.rs +++ b/crates/mcp/src/lib.rs @@ -8,6 +8,7 @@ #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)] #![forbid(unsafe_code)] +pub mod args; mod backend; pub mod control_token; mod server; diff --git a/crates/ui-egui/src/chrome.rs b/crates/ui-egui/src/chrome.rs index b8d9f09a1..7639dbba1 100644 --- a/crates/ui-egui/src/chrome.rs +++ b/crates/ui-egui/src/chrome.rs @@ -575,7 +575,7 @@ pub fn start_page(app: &mut CadApp, ui: &mut egui::Ui) { y += 46.0; } if let Some(path) = recent { - app.open_path(&path); + app.open_path(std::path::Path::new(&path)); } else if app.ui.recent_files.is_empty() { p.text( pos2(main.center().x, main.center().y), diff --git a/crates/ui-egui/src/docking.rs b/crates/ui-egui/src/docking.rs index bbbf08902..50fb52a25 100644 --- a/crates/ui-egui/src/docking.rs +++ b/crates/ui-egui/src/docking.rs @@ -350,9 +350,9 @@ pub fn show(app: &mut crate::CadApp, ui: &mut egui::Ui) { #[cfg(not(target_arch = "wasm32"))] for files in std::mem::take(&mut output.window_files) { for file in files.dropped { - let path = file.path().to_string_lossy().to_string(); - if !path.is_empty() { - app.open_path(&path); + let path = file.path(); + if !path.as_os_str().is_empty() { + app.open_path(path); } } } diff --git a/crates/ui-egui/src/gpu.rs b/crates/ui-egui/src/gpu.rs index 3c0be7611..30f3b0a85 100644 --- a/crates/ui-egui/src/gpu.rs +++ b/crates/ui-egui/src/gpu.rs @@ -23,6 +23,8 @@ use cadcraft_render::{DisplayList, Kind}; use egui_wgpu::wgpu; use egui_wgpu::wgpu::util::DeviceExt; +use crate::switch::Switch; + /// Line/triangle vertex: position (2 × f32, relative to the origin) + sRGB colour (4 × u8, /// premultiplied by its alpha: transparent objects blend with what is under them). const VERTEX_SIZE: usize = 12; @@ -44,12 +46,8 @@ const POINT_SIZE: f32 = 1.5; /// then Mailbox, then falls back to FIFO, so it is valid on every surface; under a compositor the /// compositor still syncs to the display. `vsync` is the `CADCRAFT_VSYNC` override: `1`/`on` /// forces FIFO (tear-free without a compositor), `0`/`off` forces the low-latency mode. -pub fn surface_config(vsync: Option<&str>, low_latency: bool) -> egui_wgpu::SurfaceConfig { - let no_vsync = match vsync.map(|v| v.trim().to_ascii_lowercase()).as_deref() { - Some("1" | "on" | "true" | "yes") => false, - Some("0" | "off" | "false" | "no") => true, - _ => low_latency, - }; +pub fn surface_config(vsync: Switch, low_latency: bool) -> egui_wgpu::SurfaceConfig { + let no_vsync = !vsync.or(!low_latency); egui_wgpu::SurfaceConfig { present_mode: if no_vsync { wgpu::PresentMode::AutoNoVsync } else { wgpu::PresentMode::AutoVsync }, desired_maximum_frame_latency: Some(1), @@ -801,17 +799,11 @@ mod tests { #[test] fn surface_config_prefers_low_latency_where_asked_and_honours_override() { use wgpu::PresentMode::{AutoNoVsync, AutoVsync}; - assert_eq!(surface_config(None, true).present_mode, AutoNoVsync); - assert_eq!(surface_config(None, false).present_mode, AutoVsync); - for on in ["1", "on", " TRUE ", "yes"] { - assert_eq!(surface_config(Some(on), true).present_mode, AutoVsync, "{on}"); - } - for off in ["0", "Off", "false", "no"] { - assert_eq!(surface_config(Some(off), false).present_mode, AutoNoVsync, "{off}"); - } - assert_eq!(surface_config(Some("maybe"), true).present_mode, AutoNoVsync); - assert_eq!(surface_config(Some(""), false).present_mode, AutoVsync); - assert_eq!(surface_config(None, true).desired_maximum_frame_latency, Some(1)); + assert_eq!(surface_config(Switch::Default, true).present_mode, AutoNoVsync); + assert_eq!(surface_config(Switch::Default, false).present_mode, AutoVsync); + assert_eq!(surface_config(Switch::On, true).present_mode, AutoVsync); + assert_eq!(surface_config(Switch::Off, false).present_mode, AutoNoVsync); + assert_eq!(surface_config(Switch::Default, true).desired_maximum_frame_latency, Some(1)); } #[cfg(not(target_arch = "wasm32"))] diff --git a/crates/ui-egui/src/lib.rs b/crates/ui-egui/src/lib.rs index 017cf5a42..22e325cbe 100644 --- a/crates/ui-egui/src/lib.rs +++ b/crates/ui-egui/src/lib.rs @@ -27,6 +27,7 @@ pub mod hatchdlg; mod mtext_editor; mod panel_state; pub mod spacemouse; +pub mod switch; // The External References palette. pub mod xrefs; @@ -55,6 +56,7 @@ pub mod vpscale; pub mod exchange; +use std::path::Path; use std::sync::mpsc::Receiver; use cadcraft_engine::Session; @@ -88,7 +90,7 @@ pub struct UiState { /// Keep the system cursor visible over the drawing area (a small crosshair at the centre of the /// drawn one) instead of hiding it. Screen magnifiers (Windows Magnifier "follow the mouse /// pointer"), screen readers, recorders and remote desktops track the system cursor and lose it - /// when it is hidden. Off by default; `CADCRAFT_SYSTEM_CURSOR=1` turns it on at startup. + /// when it is hidden. Off unless the host defaults to it ([`CadApp::set_system_cursor_default`]). pub system_cursor: bool, /// "Drafting" or "Modeling". pub toolset_tab: String, @@ -173,7 +175,7 @@ impl Default for UiState { show_viewcube: true, show_ucs_icon: true, show_layer_list: false, - system_cursor: std::env::var("CADCRAFT_SYSTEM_CURSOR").is_ok_and(|v| !matches!(v.trim(), "" | "0" | "false" | "off")), + system_cursor: false, toolset_tab: "Drafting".into(), collapsed_groups: Vec::new(), hidden_tools: Vec::new(), @@ -211,6 +213,8 @@ pub struct CadApp { /// Whether the operating system shows animations, as the host reads it; `None` when the OS /// states nothing or the host cannot ask ([`animation`]). pub system_animations: Option, + /// What `ui.system_cursor` goes back to when the interface is reset ([`Self::set_system_cursor_default`]). + pub system_cursor_default: bool, pub session: Session, pub ui: UiState, /// The interface's own preferences from the Options dialog ([`options`]). @@ -296,6 +300,7 @@ impl CadApp { CadApp { system_languages: Vec::new(), system_animations: None, + system_cursor_default: false, session, ui: UiState::default(), options: options::UiOptions::default(), @@ -469,6 +474,15 @@ impl CadApp { } } + /// Make the system cursor the interface default (`on`) and turn it on; saved preferences and + /// resets never turn it off then. + pub fn set_system_cursor_default(&mut self, on: bool) { + self.system_cursor_default = on; + if on { + self.ui.system_cursor = true; + } + } + pub fn set_status(&mut self, s: impl Into) { self.status = Some((s.into(), now_ms())); } @@ -481,12 +495,12 @@ impl CadApp { /// Open the drawing at `path`. Natively the file is read on a worker thread while an /// "Opening ..." card shows ([`opening`]); [`Self::finish_opening`] adds it when ready. On the /// web it opens at once. - pub fn open_path(&mut self, path: &str) { + pub fn open_path(&mut self, path: &Path) { // A LISP file (dropped on the window): loaded as APPLOAD loads it. if is_lisp_file(path) { match cadcraft_engine::lisp::builtins::read_text_file(path) { - Some(text) => self.load_lisp(path, &text), - None => self.open_failed(format!("APPLOAD: can't read {path}")), + Some(text) => self.load_lisp(&path.to_string_lossy(), &text), + None => self.open_failed(format!("APPLOAD: can't read {}", path.display())), } return; } @@ -496,7 +510,10 @@ impl CadApp { } #[cfg(target_arch = "wasm32")] { - let r = self.run("open", json!({ "path": path })); + let r = match path.to_str() { + Some(text) => self.run("open", json!({ "path": text })), + None => Err(format!("open: {}: the path is not valid Unicode", path.display())), + }; self.opened(r); } } @@ -800,9 +817,9 @@ impl CadApp { { let dropped = ctx.input_mut(|input| std::mem::take(&mut input.raw.dropped_files)); for file in dropped { - let path = file.path().to_string_lossy().to_string(); - if !path.is_empty() { - self.open_path(&path); + let path = file.path(); + if !path.as_os_str().is_empty() { + self.open_path(path); } } } @@ -889,8 +906,8 @@ pub fn now_ms() -> f64 { } /// A LISP source file, by its name. -fn is_lisp_file(name: &str) -> bool { - std::path::Path::new(name).extension().is_some_and(|e| e.eq_ignore_ascii_case("lsp")) +fn is_lisp_file(name: impl AsRef) -> bool { + name.as_ref().extension().is_some_and(|e| e.eq_ignore_ascii_case("lsp")) } #[cfg(test)] diff --git a/crates/ui-egui/src/menus.rs b/crates/ui-egui/src/menus.rs index ca287f982..58055542f 100644 --- a/crates/ui-egui/src/menus.rs +++ b/crates/ui-egui/src/menus.rs @@ -128,7 +128,7 @@ fn run_recent_file_command(app: &mut CadApp, id: &str) -> Option().ok()) { let Some(path) = app.ui.recent_files.get(i).cloned() else { return Some(Err(format!("no recent file {i}"))) }; - app.open_path(&path); + app.open_path(std::path::Path::new(&path)); return Some(Ok(Value::Null)); } None @@ -319,7 +319,7 @@ fn run_ui_command_inner(app: &mut CadApp, id: &str, params: &Value) -> Option { let picked = app.services.pick_open.as_ref().and_then(|f| f()); if let Some(p) = picked { - app.open_path(&p); + app.open_path(std::path::Path::new(&p)); } Ok(Value::Null) } @@ -404,7 +404,17 @@ fn run_ui_command_inner(app: &mut CadApp, id: &str, params: &Value) -> Option { let (menu, theme, interface_language, save_format) = (app.ui.in_window_menu, app.ui.theme, app.ui.interface_language, app.ui.save_format); let (animations, save_version) = (app.ui.animations, std::mem::take(&mut app.ui.save_version)); - app.ui = crate::UiState { in_window_menu: menu, theme, animations, interface_language, save_format, save_version, ..Default::default() }; + let system_cursor = app.system_cursor_default; + app.ui = crate::UiState { + in_window_menu: menu, + theme, + animations, + interface_language, + save_format, + save_version, + system_cursor, + ..Default::default() + }; Ok(Value::Null) } "ui.start" => { diff --git a/crates/ui-egui/src/opening.rs b/crates/ui-egui/src/opening.rs index b0b2f8781..d6ae999c8 100644 --- a/crates/ui-egui/src/opening.rs +++ b/crates/ui-egui/src/opening.rs @@ -3,6 +3,7 @@ //! a spinner and the elapsed time and keeps painting. The finished drawing is added to the session //! on the UI thread. The web build has no threads and opens synchronously. +use std::path::{Path, PathBuf}; use std::sync::mpsc::{Receiver, TryRecvError, channel}; use std::time::{Duration, Instant}; @@ -13,7 +14,7 @@ use crate::theme::Tokens; type Outcome = Result; struct Job { - path: String, + path: PathBuf, started: Instant, rx: Receiver, } @@ -26,20 +27,20 @@ pub struct Opening { impl Opening { /// Start reading `path` on a worker thread. - pub fn start(&mut self, path: &str) { + pub fn start(&mut self, path: &Path) { let (tx, rx) = channel(); - let p = path.to_string(); + let p = path.to_path_buf(); let spawned = std::thread::Builder::new().name("cadcraft-open".into()).spawn(move || { let _ = tx.send(read_file(&p)); }); if spawned.is_err() { // No thread to read on: report it like any other failed open. let (tx, rx2) = channel(); - let _ = tx.send(Err(format!("open: {path}: could not start a reader thread"))); - self.jobs.push(Job { path: path.to_string(), started: Instant::now(), rx: rx2 }); + let _ = tx.send(Err(format!("open: {}: could not start a reader thread", path.display()))); + self.jobs.push(Job { path: path.to_path_buf(), started: Instant::now(), rx: rx2 }); return; } - self.jobs.push(Job { path: path.to_string(), started: Instant::now(), rx }); + self.jobs.push(Job { path: path.to_path_buf(), started: Instant::now(), rx }); } /// Whether any file is still being read. @@ -48,7 +49,7 @@ impl Opening { } /// The finished reads, as (path, result). A reader that died without answering is an error. - pub fn poll(&mut self) -> Vec<(String, Outcome)> { + pub fn poll(&mut self) -> Vec<(PathBuf, Outcome)> { let mut done = Vec::new(); self.jobs.retain(|j| match j.rx.try_recv() { Ok(r) => { @@ -57,7 +58,7 @@ impl Opening { } Err(TryRecvError::Empty) => true, Err(TryRecvError::Disconnected) => { - done.push((j.path.clone(), Err(format!("open: {}: the file could not be read", j.path)))); + done.push((j.path.clone(), Err(format!("open: {}: the file could not be read", j.path.display())))); false } }); @@ -67,7 +68,7 @@ impl Opening { /// The text of the card: the file and how long it has taken, or how many files are queued. fn label(&self) -> Option { let first = self.jobs.first()?; - let name = std::path::Path::new(&first.path).file_name().map_or_else(|| first.path.clone(), |n| n.to_string_lossy().to_string()); + let name = first.path.file_name().unwrap_or(first.path.as_os_str()).to_string_lossy(); let secs = first.started.elapsed().as_secs_f32(); let more = self.jobs.len() - 1; Some(if more == 0 { format!("Opening {name}... {secs:.0} s") } else { format!("Opening {name} and {more} more... {secs:.0} s") }) @@ -100,6 +101,7 @@ impl Opening { #[cfg(test)] mod tests { + use std::path::Path; use std::time::{Duration, Instant}; use cadcraft_engine::Session; @@ -114,7 +116,7 @@ mod tests { let before = app.session.docs.len(); let missing = std::env::temp_dir().join(format!("cadcraft-missing-{}.dxf", std::process::id())); let p = missing.to_string_lossy().to_string(); - app.open_path(&p); + app.open_path(&missing); assert!(app.opening.busy() || app.status.is_some(), "the read starts in the background"); let t = Instant::now(); while app.opening.busy() && t.elapsed() < Duration::from_secs(10) { @@ -133,8 +135,8 @@ mod tests { fn card_text_names_the_file_and_counts_queued_ones() { let mut o = super::Opening::default(); assert!(o.label().is_none()); - o.start("/nonexistent/dir/a.dxf"); - o.start("/nonexistent/dir/b.dxf"); + o.start(Path::new("/nonexistent/dir/a.dxf")); + o.start(Path::new("/nonexistent/dir/b.dxf")); let l = o.label().unwrap_or_default(); assert!(l.starts_with("Opening a.dxf and 1 more"), "{l}"); } diff --git a/crates/ui-egui/src/options.rs b/crates/ui-egui/src/options.rs index c8b94c310..8bf147bcf 100644 --- a/crates/ui-egui/src/options.rs +++ b/crates/ui-egui/src/options.rs @@ -310,7 +310,7 @@ fn reset_ui(app: &mut CadApp) { app.ui.animations = d.animations; app.ui.save_format = d.save_format; app.ui.save_version = d.save_version; - app.ui.system_cursor = d.system_cursor; + app.ui.system_cursor = app.system_cursor_default; app.ui.history_lines = d.history_lines; app.options = UiOptions::default(); } @@ -353,7 +353,7 @@ impl CadApp { let _ = parse_ui(key, value, &mut c); } } - // CADCRAFT_SYSTEM_CURSOR=1 turns the system cursor on whatever was saved. + // A saved `false` leaves the host's default (`set_system_cursor_default`) in place. if c.system_cursor == Some(true) { self.ui.system_cursor = true; } diff --git a/crates/ui-egui/src/switch.rs b/crates/ui-egui/src/switch.rs new file mode 100644 index 000000000..0095a14e5 --- /dev/null +++ b/crates/ui-egui/src/switch.rs @@ -0,0 +1,54 @@ +//! Boolean environment switches (`CADCRAFT_VSYNC`, `CADCRAFT_WAYLAND`, ...): one parser, so every +//! variable accepts the same spellings. + +/// `1/on/true/yes` or `0/off/false/no`, case- and space-insensitive. Blank or unset is `Default`; +/// anything else is `Default` and logged. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum Switch { + On, + Off, + Default, +} + +impl Switch { + /// Parse the value of the variable `name`; `name` only appears in the warning. + pub fn parse(name: &str, value: Option<&str>) -> Switch { + let Some(value) = value else { return Switch::Default }; + match value.trim().to_ascii_lowercase().as_str() { + "1" | "on" | "true" | "yes" => Switch::On, + "0" | "off" | "false" | "no" => Switch::Off, + "" => Switch::Default, + _ => { + log::warn!("{name}={value:?} is not 1/on/true/yes or 0/off/false/no; using the default"); + Switch::Default + } + } + } + + /// Whether the switch is on, with `default` for `Default`. + pub fn or(self, default: bool) -> bool { + match self { + Switch::On => true, + Switch::Off => false, + Switch::Default => default, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn parses_every_spelling() { + for v in ["1", "on", "true", "yes", "ON", "True", " Yes ", "\t1\n"] { + assert_eq!(Switch::parse("X", Some(v)), Switch::On, "{v:?}"); + } + for v in ["0", "off", "false", "no", "OFF", "False", " No ", " 0 "] { + assert_eq!(Switch::parse("X", Some(v)), Switch::Off, "{v:?}"); + } + for v in [None, Some(""), Some(" "), Some("maybe"), Some("2"), Some("onn")] { + assert_eq!(Switch::parse("X", v), Switch::Default, "{v:?}"); + } + } +} diff --git a/crates/ui-egui/tests/bedit_dialog.rs b/crates/ui-egui/tests/bedit_dialog.rs index 85367e407..95fdb4adc 100644 --- a/crates/ui-egui/tests/bedit_dialog.rs +++ b/crates/ui-egui/tests/bedit_dialog.rs @@ -133,7 +133,7 @@ fn opening_a_drawing_with_authoring_elements_offers_the_block_editor() { let symbol = dir.join("Symbol.dxf"); std::fs::write(&symbol, "authoring").unwrap(); let mut app = CadApp::new(Session::new(), Services::default()); - app.open_path(&symbol.to_string_lossy()); + app.open_path(&symbol); // The file is read in the background (#797): wait for it to be added. let t = std::time::Instant::now(); while app.opening.busy() && t.elapsed() < std::time::Duration::from_secs(10) { @@ -163,7 +163,7 @@ fn opening_a_drawing_with_authoring_elements_offers_the_block_editor() { let plain = dir.join("Plain.dxf"); std::fs::write(&plain, "plain").unwrap(); let mut app = CadApp::new(Session::new(), Services::default()); - app.open_path(&plain.to_string_lossy()); + app.open_path(&plain); // The file is read in the background (#797): wait for it to be added. let t = std::time::Instant::now(); while app.opening.busy() && t.elapsed() < std::time::Duration::from_secs(10) { diff --git a/crates/ui-egui/tests/it/system_cursor.rs b/crates/ui-egui/tests/it/system_cursor.rs index ff2c8942f..e2067e519 100644 --- a/crates/ui-egui/tests/it/system_cursor.rs +++ b/crates/ui-egui/tests/it/system_cursor.rs @@ -35,3 +35,23 @@ fn system_cursor_stays_visible_over_the_canvas_when_requested() { assert!(app.ui.system_cursor); assert_eq!(canvas_cursor(&mut app), egui::CursorIcon::Crosshair, "systemCursor keeps an OS cursor for magnifiers"); } + +/// The host's default (the desktop app's `CADCRAFT_SYSTEM_CURSOR`) turns it on; a saved `false` +/// and the resets keep it. +#[test] +fn the_host_default_survives_saved_profiles_and_resets() { + let mut app = CadApp::new(Session::new(), Services::default()); + app.run("options", serde_json::json!({ "reset": true })).unwrap(); + assert!(!app.ui.system_cursor, "off without a host default"); + + app.set_system_cursor_default(true); + assert!(app.ui.system_cursor); + app.load_profile(r#"{"systemCursor": false}"#); + assert!(app.ui.system_cursor); + app.ui.system_cursor = false; + app.run("options", serde_json::json!({ "reset": true })).unwrap(); + assert!(app.ui.system_cursor); + app.ui.system_cursor = false; + app.run("ui.resetpalettes", serde_json::json!({})).unwrap(); + assert!(app.ui.system_cursor); +} diff --git a/crates/ui-egui/tests/recent_files.rs b/crates/ui-egui/tests/recent_files.rs index 6211ab899..946a6792a 100644 --- a/crates/ui-egui/tests/recent_files.rs +++ b/crates/ui-egui/tests/recent_files.rs @@ -53,15 +53,15 @@ fn opened_drawings_are_listed_newest_first_and_survive_a_restart() { let mut app = CadApp::new(Session::empty(), Services::default()); assert!(app.ui.recent_files.is_empty()); - app.open_path(&plan); + app.open_path(std::path::Path::new(&plan)); settle(&mut app); - app.open_path(§ion); + app.open_path(std::path::Path::new(§ion)); settle(&mut app); - app.open_path(&plan); + app.open_path(std::path::Path::new(&plan)); settle(&mut app); assert_eq!(app.ui.recent_files, [plan.clone(), section.clone()], "newest first, each file once"); // A file that could not be opened is not listed. - app.open_path("/nonexistent/missing.dxf"); + app.open_path(std::path::Path::new("/nonexistent/missing.dxf")); settle(&mut app); assert_eq!(app.ui.recent_files, [plan.clone(), section.clone()]); diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 000000000..ba68a1d09 --- /dev/null +++ b/docs/cli.md @@ -0,0 +1,58 @@ +# cadcraft-cli + +`cadcraft-cli` is headless CADCraft: it reads, converts and exports drawings, runs scripts and +commands, prints the command catalog and serves MCP. It follows +[RFC-0012: Command-line conventions](https://github.com/storytold/craft-contrib/pull/18). + +`cadcraft-cli --help` and `cadcraft-cli help ` (or ` --help`) are the +reference for every subcommand, flag and value; this page doesn't repeat them. Examples are in the +[README](../README.md#drive-it-from-agents-mcp-and-the-cli), MCP setup in [mcp.md](mcp.md), +scripts and the JSON command forms in [customization.md](customization.md). + +## Conventions + +| | | +|---|---| +| Exit codes | `0` success, `1` the command failed, `2` usage error. | +| Streams | Results on stdout. `info` and `commands` print pretty JSON, or one line with `--compact`; `run` prints one JSON line per `--cmd` result (JSON lines); a command with no result (JSON `null`) prints no line. Errors (`error: …`), warnings and `wrote …` lines on stderr. `mcp` speaks MCP on stdout and writes nothing else there. | +| Usage errors | An unknown or repeated flag, a missing or malformed value (`--window`, `--view`, `--cmd` JSON, a sample name), flags that conflict (`--window` with `--view`) or that need another (`run --window` without `--export`) stop before any work, with exit 2. `--script`, `--script-file`, `--cmd` and `run`'s files repeat and run in command-line order. | +| Outputs that replace an input | `convert IN OUT` and `run FILE… --save OUT` / `--export OUT` refuse an OUT that is the same file as an input (any spelling or symlink of it): usage error, exit 2, nothing opened or written. `--in-place` allows it. A save a script or `--cmd` runs is the engine's. | +| Values starting with `-` | Written with `=`: `--window=-10,-10,10,10`, `--export=-plan.png`. | +| Paths | Read as given, including names that aren't valid Unicode. The engine opens files by text name, so such a name is reported as an error (exit 1) where a drawing is opened; an output takes any name whose extension is ASCII. | +| Completions and man pages | The Linux packages install them. To generate them yourself: `cargo run -p cadcraft-cli --example man-and-completions -- `. | + +## Environment variables + +Variables are fallbacks for flags; `--help` shows each next to its flag. An empty value counts as +unset and the flag wins over the variable, except for `CADCRAFT_CONFIG_DIR` (see below). + +| Variable | Flag | Subcommands | +|---|---|---| +| `CADCRAFT_CONFIG_DIR` | `--config-dir` (the settings folder; plotter configurations are in its `plotters` folder; empty means no settings folder) | `convert`, `run`, `mcp`, `sample` | +| `CADCRAFT_FONTALT` | `--fontalt` (FONTALT) | `convert`, `run`, `mcp`, `sample` | +| `CADCRAFT_FONTFALLBACK` | `--fontfallback` (FONTFALLBACK) | `convert`, `run`, `mcp`, `sample` | + +The desktop app's are listed by `cadcraft --help`; its one flag fallback is +`CADCRAFT_CONTROL_PORT` for `--control`, where a bad value is a usage error that names the +variable. + +## Not followed yet + +- **`CADCRAFT_CONFIG_DIR` is the one flag fallback where an empty variable doesn't count as + unset** (RFC-0012 rule 1.7): empty (or `--config-dir ""`) means no settings folder, as it did + before the port. +- **No variable for `mcp --connect`.** Photocraft's `mcp --bridge` falls back to its + `*_CONTROL_PORT` variable. Here an exported `CADCRAFT_CONTROL_PORT` would silently switch `mcp` + from a headless session to the running app, so `--connect` stays a flag only. +- **The desktop app on Windows** is built without a console, so a usage error in its launch flags + isn't visible there; the app exits with code 2. +- **The `string-error` ast-grep rule** covers the CLI code only. The engine's file hooks + (`cadcraft_engine::cmd::file::IoHooks`) still return `Result<_, String>`, so `install_io` maps + errors to strings at that boundary. +- **No AGENTS.md line for the ast-grep scan.** RFC-0012 asks an app's AGENTS.md to have coding + agents run the scan before pushing (`ast-grep scan -c lint/ast-grep/sgconfig.yml`); CI runs it + on every PR that touches the CLI code. +- **`perf` prints a text table**, with no `--json` (whether text listings get one is an open + question in RFC-0012). +- **Saves a command or script runs** (`--cmd 'saveas {…}'`, a script's `SAVEAS`) are the engine's + and are not checked against the opened drawings; only `--save` and `--export` are. diff --git a/docs/control-protocol.md b/docs/control-protocol.md index 1c3f30626..98db28330 100644 --- a/docs/control-protocol.md +++ b/docs/control-protocol.md @@ -124,7 +124,7 @@ height and related chrome choices. It does not store drawings, command buffers, current Start tab. The default directory is `~/Library/Application Support/CADCraft` on macOS, `%APPDATA%/CADCraft` on Windows, and `$XDG_CONFIG_HOME/cadcraft` or `~/.config/cadcraft` elsewhere. Set `CADCRAFT_CONFIG_DIR` to a private directory for an isolated profile; an explicitly empty -value disables workspace reads and writes. An invalid, oversized or newer-version file is +value disables all settings reads and writes (workspace, logs, autosave, plotters). An invalid, oversized or newer-version file is reported and left untouched, with persistence disabled for that launch. Repair or move that file before restarting to resume saving workspace choices. diff --git a/docs/plotters.md b/docs/plotters.md index 7ca7c785d..92e10afce 100644 --- a/docs/plotters.md +++ b/docs/plotters.md @@ -32,7 +32,8 @@ settings directory: | macOS | `~/Library/Application Support/CADCraft/plotters` | | Windows | `%APPDATA%\CADCraft\plotters` | -`CADCRAFT_CONFIG_DIR` replaces the settings directory. On the web, devices last for the +`CADCRAFT_CONFIG_DIR` replaces the settings directory; empty means none (`cadcraft-cli`: +`--config-dir`, which falls back to the same variable). On the web, devices last for the session unless the host provides storage (`cmd::plotters::set_plotter_store`). Binary `.pc3` files are not read; we haven't found a public specification of that format. diff --git a/lint/ast-grep/rule-tests/args-os-test.yml b/lint/ast-grep/rule-tests/args-os-test.yml new file mode 100644 index 000000000..03ff2c4da --- /dev/null +++ b/lint/ast-grep/rule-tests/args-os-test.yml @@ -0,0 +1,19 @@ +id: args-os +valid: + - let code = photocraft_cli::run(std::env::args_os().skip(1), &mut out, &mut err); + - "let args: Vec = env::args_os().collect();" + - | + use std::env::args_os; + fn main() { let a: Vec<_> = args_os().collect(); } + - | + fn args() -> Vec { Vec::new() } + fn main() { let a = args(); } +invalid: + - "let args: Vec = std::env::args().collect();" + - for a in env::args().skip(1) {} + - | + use std::env::args; + fn main() { let a: Vec = args().collect(); } + - | + use std::env::{args, var}; + fn main() { for a in args() {} } diff --git a/lint/ast-grep/rule-tests/clap-error-message-test.yml b/lint/ast-grep/rule-tests/clap-error-message-test.yml new file mode 100644 index 000000000..385d46e96 --- /dev/null +++ b/lint/ast-grep/rule-tests/clap-error-message-test.yml @@ -0,0 +1,13 @@ +id: clap-error-message +valid: + - cmd.error(ErrorKind::ArgumentConflict, UsageError::BridgeRoots) + - cmd.error(ErrorKind::ArgumentConflict, Conflict { a, b }) + - sub.error(kind, self) + - log.error("not a clap error") +invalid: + - cmd.error(ErrorKind::ArgumentConflict, "configure automation roots on the desktop app") + - sub.error(ErrorKind::MissingRequiredArgument, format!("{flag} requires {transport}")) + - sub.error(ErrorKind::ArgumentConflict, BRIDGE_ROOTS) + - cmd.error(ErrorKind::InvalidValue, e.to_string()) + - cmd.error(ErrorKind::InvalidValue, String::from("bad value")) + - clap::Error::raw(ErrorKind::InvalidValue, "bad value") diff --git a/lint/ast-grep/rule-tests/clap-error-message-variable-test.yml b/lint/ast-grep/rule-tests/clap-error-message-variable-test.yml new file mode 100644 index 000000000..18d6e443a --- /dev/null +++ b/lint/ast-grep/rule-tests/clap-error-message-variable-test.yml @@ -0,0 +1,47 @@ +id: clap-error-message-variable +valid: + - | + fn conflict(cmd: &mut Command, a: String, b: String) -> clap::Error { + cmd.error(ErrorKind::ArgumentConflict, Conflict { a, b }) + } + - | + fn wrap(cmd: &mut Command, e: UsageError) -> clap::Error { + cmd.error(ErrorKind::ValueValidation, e) + } + - | + fn unrelated(cmd: &mut Command, e: UsageError) -> clap::Error { + let shown = format!("{e}"); + eprintln!("{shown}"); + cmd.error(ErrorKind::ValueValidation, e) + } + - | + fn cloned(cmd: &mut Command, e: &UsageError) -> clap::Error { + let owned = e.to_owned(); + cmd.error(ErrorKind::ValueValidation, owned) + } +invalid: + - | + fn conflict(cmd: &mut Command, a: &str, b: &str) -> clap::Error { + let message = format!("the argument '{a}' cannot be used with '{b}'"); + cmd.error(ErrorKind::ArgumentConflict, message) + } + - | + fn bad(cmd: &mut Command, e: UsageError) -> clap::Error { + let message = e.to_string(); + cmd.error(ErrorKind::ValueValidation, message) + } + - | + fn typed(cmd: &mut Command, flag: &str) -> clap::Error { + let message: String = flag.into(); + clap::Error::raw(ErrorKind::InvalidValue, message) + } + - | + fn literal(cmd: &mut Command) -> clap::Error { + let message = "bad value".to_owned(); + cmd.error(ErrorKind::InvalidValue, message) + } + - | + fn from(cmd: &mut Command) -> clap::Error { + let message = String::from("bad value"); + cmd.error(ErrorKind::InvalidValue, message) + } diff --git a/lint/ast-grep/rule-tests/string-error-test.yml b/lint/ast-grep/rule-tests/string-error-test.yml new file mode 100644 index 000000000..4f14197c8 --- /dev/null +++ b/lint/ast-grep/rule-tests/string-error-test.yml @@ -0,0 +1,14 @@ +id: string-error +valid: + - "fn parse(s: &str) -> Result { todo!() }" + - "fn name() -> Option { None }" + - "fn ok() -> Result { Ok(String::new()) }" + - Err(PortError::Range) + - Err(e) +invalid: + - "fn parse(s: &str) -> Result { todo!() }" + - "type R = Result<(), String>;" + - Err(format!("bad port {s}")) + - Err(e.to_string()) + - Err(String::from("bad port")) + - Err("bad port") diff --git a/lint/ast-grep/rules/args-os.yml b/lint/ast-grep/rules/args-os.yml new file mode 100644 index 000000000..ab1916c9e --- /dev/null +++ b/lint/ast-grep/rules/args-os.yml @@ -0,0 +1,21 @@ +id: args-os +language: rust +severity: error +message: std::env::args() panics on an argument that isn't valid Unicode +note: | + Read std::env::args_os() and let clap parse the OsStrings, so a Latin-1 file name reaches the + command (or is a usage error) instead of aborting before anything is printed (photocraft#1108). +rule: + any: + - pattern: std::env::args() + - pattern: env::args() + # A bare args() only where the file imports std::env::args, not any function named args. + - all: + - pattern: args() + - inside: + kind: source_file + stopBy: end + has: + kind: use_declaration + stopBy: end + regex: std::env::(args\b|\{[^}]*\bargs\b) diff --git a/lint/ast-grep/rules/clap-error-message-variable.yml b/lint/ast-grep/rules/clap-error-message-variable.yml new file mode 100644 index 000000000..3f476be4b --- /dev/null +++ b/lint/ast-grep/rules/clap-error-message-variable.yml @@ -0,0 +1,35 @@ +id: clap-error-message-variable +language: rust +severity: error +message: clap error built from a string held in a variable +note: | + The message was built with format!, .to_string(), String::from or a literal's .to_owned() a + few lines up. Give it a variant on a + #[derive(thiserror::Error)] enum instead, with the parts as fields, and pass the variant. +rule: + # In this order: the call binds $MSG, then the function must hold a `let` of that same name. + all: + - any: + - pattern: $CMD.error($KIND, $MSG) + - pattern: Error::raw($KIND, $MSG) + - pattern: clap::Error::raw($KIND, $MSG) + - inside: + kind: function_item + stopBy: end + has: + stopBy: end + any: + - pattern: let $MSG = format!($$$); + - pattern: "let $MSG: String = $VAL;" + - pattern: let $MSG = $SRC.to_string(); + - pattern: let $MSG = String::from($$$); + # .to_owned() only on a string literal: on anything else it may clone a typed error. + - all: + - kind: let_declaration + - regex: '=\s*"(?s:.*)"\s*\.to_owned\(\)\s*;?$' + - has: + field: pattern + pattern: $MSG +constraints: + MSG: + kind: identifier diff --git a/lint/ast-grep/rules/clap-error-message.yml b/lint/ast-grep/rules/clap-error-message.yml new file mode 100644 index 000000000..e18b824b3 --- /dev/null +++ b/lint/ast-grep/rules/clap-error-message.yml @@ -0,0 +1,26 @@ +id: clap-error-message +language: rust +severity: error +message: clap error built from a string +note: | + Give the message a variant on a #[derive(thiserror::Error)] enum and pass the variant, e.g. + `cmd.error(ErrorKind::ArgumentConflict, UsageError::BridgeRoots)`. A string literal, format!, + .to_string() or a SCREAMING_CASE const keeps the message apart from the error's type. +rule: + any: + - pattern: $CMD.error($KIND, $MSG) + - pattern: Error::raw($KIND, $MSG) + - pattern: clap::Error::raw($KIND, $MSG) +constraints: + MSG: + any: + - kind: string_literal + - all: + - kind: macro_invocation + - regex: ^format! + - all: + - kind: identifier + - regex: ^[A-Z][A-Z0-9_]*$ + - all: + - kind: call_expression + - regex: \.(to_string|to_owned)\(\)$|^String::from\( diff --git a/lint/ast-grep/rules/string-error.yml b/lint/ast-grep/rules/string-error.yml new file mode 100644 index 000000000..e79b83d05 --- /dev/null +++ b/lint/ast-grep/rules/string-error.yml @@ -0,0 +1,21 @@ +id: string-error +language: rust +severity: error +message: String as an error type +note: | + Return a #[derive(thiserror::Error)] enum, so a caller can match on what failed and the + messages live with their variants. +rule: + any: + - pattern: + context: type T = Result<$OK, String>; + selector: generic_type + - pattern: Err(format!($$$)) + - pattern: Err($S.to_string()) + - pattern: Err(String::from($$$)) + - all: + - pattern: Err($S) + - has: + kind: arguments + has: + kind: string_literal diff --git a/lint/ast-grep/sgconfig.yml b/lint/ast-grep/sgconfig.yml new file mode 100644 index 000000000..9c94bd0ae --- /dev/null +++ b/lint/ast-grep/sgconfig.yml @@ -0,0 +1,6 @@ +# Structural rules for the command-line code (RFC-0012), run by .github/workflows/ast-grep.yml. +# Each rule in rules/ has its cases in rule-tests/, which CI checks before the scan. +ruleDirs: + - rules +testConfigs: + - testDir: rule-tests diff --git a/packaging/linux/package.sh b/packaging/linux/package.sh index 7ad0c4016..f9146c86a 100755 --- a/packaging/linux/package.sh +++ b/packaging/linux/package.sh @@ -44,11 +44,16 @@ BASENAME="cadcraft-$VERSION-linux-$ARCH" echo "==> CADCraft $VERSION for Linux $ARCH ($FORMATS)" +# The man-and-completions example writes cadcraft-cli's man pages and shell completions below. It +# is built in its own cargo run: built with the binaries, its dev-dependencies' features would be +# unified into them. if [[ "$SKIP_BUILD" = 0 ]]; then if [[ -n "${CROSS_TARGET:-}" ]]; then (cd "$ROOT" && cargo build --release --locked -p cadcraft -p cadcraft-cli --target "$CROSS_TARGET") + (cd "$ROOT" && cargo build --release --locked -p cadcraft-cli --example man-and-completions --target "$CROSS_TARGET") else (cd "$ROOT" && cargo build --release --locked -p cadcraft -p cadcraft-cli) + (cd "$ROOT" && cargo build --release --locked -p cadcraft-cli --example man-and-completions) fi fi BIN="$CARGO_TARGET_DIR/${CROSS_TARGET:+$CROSS_TARGET/}release" @@ -69,6 +74,26 @@ mkdir -p "$STAGE/usr/share/icons" cp -R "$ROOT/assets/app-icon/hicolor" "$STAGE/usr/share/icons/" mkdir -p "$STAGE/usr/share/doc/cadcraft" copy_docs "$STAGE/usr/share/doc/cadcraft" +# cadcraft-cli's man pages and shell completions, from its clap definition, written by the +# example built above. A cross build runs it through $EMULATOR, like the --version check at the +# end, and leaves them out without one, as a --skip-build run whose prebuilt binaries came without +# the example does. zsh reads site-functions on Fedora and openSUSE. +CLI_DOCS="$BIN/examples/man-and-completions" +if [[ -n "${CROSS_TARGET:-}" ]] && [[ -z "${EMULATOR:-}" ]]; then + warn "no EMULATOR to run the $CROSS_TARGET build, so cadcraft-cli's man pages and completions are left out" +elif [[ ! -x "$CLI_DOCS" ]]; then + warn "$CLI_DOCS is not built, so cadcraft-cli's man pages and completions are left out" +else + if [[ -n "${CROSS_TARGET:-}" ]]; then + "$EMULATOR" "$CLI_DOCS" "$WORK/cli-docs" + else + "$CLI_DOCS" "$WORK/cli-docs" + fi + install -Dm644 -t "$STAGE/usr/share/man/man1" "$WORK"/cli-docs/*.1 + install -Dm644 "$WORK/cli-docs/cadcraft-cli.bash" "$STAGE/usr/share/bash-completion/completions/cadcraft-cli" + install -Dm644 "$WORK/cli-docs/_cadcraft-cli" "$STAGE/usr/share/zsh/site-functions/_cadcraft-cli" + install -Dm644 "$WORK/cli-docs/cadcraft-cli.fish" "$STAGE/usr/share/fish/vendor_completions.d/cadcraft-cli.fish" +fi if command -v desktop-file-validate >/dev/null; then desktop-file-validate "$STAGE/usr/share/applications/$APP_ID.desktop" From d9265c924545464a3344e00060d23a34e4eece16 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Wed, 28 Oct 2026 12:09:14 -0400 Subject: [PATCH 02/49] macOS packaging: retry stapler when Apple's CloudKit drops the connection Co-Authored-By: Claude Opus 5.5 --- packaging/macos/package.sh | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/packaging/macos/package.sh b/packaging/macos/package.sh index 014f91bd9..5ecb13b7a 100755 --- a/packaging/macos/package.sh +++ b/packaging/macos/package.sh @@ -80,6 +80,21 @@ sign() { codesign --force --sign "$IDENTITY" ${kc[@]+"${kc[@]}"} "${ts[@]}" "$@" } +# `stapler staple` and `stapler validate` both fetch the ticket from Apple's CloudKit, and a dropped +# connection there (NSURLErrorDomain -1005, "Error 68") fails them although notarization worked. +# Both are idempotent, so retry with a pause; a missing or bad ticket still fails every try. +stapler_retry() { + local try + for try in 1 2 3 4; do + xcrun stapler "$1" "$2" && return 0 + [[ "$try" = 4 ]] && break + echo "stapler $1 failed (try $try of 4); retrying in $((try * 20)) s" >&2 + sleep $((try * 20)) + done + echo "error: stapler $1 $(basename "$2") failed 4 times" >&2 + exit 1 +} + notarize() { local file="$1" out id status echo "==> notarizing $(basename "$file") (this can take a few minutes)" @@ -122,8 +137,8 @@ codesign --verify --strict --deep --verbose=2 "$APP" if [[ "$NOTARIZE" = 1 ]]; then ditto -c -k --keepParent "$APP" "$WORK/CADCraft-notarize.zip" notarize "$WORK/CADCraft-notarize.zip" - xcrun stapler staple "$APP" - xcrun stapler validate "$APP" + stapler_retry staple "$APP" + stapler_retry validate "$APP" spctl --assess --type execute -vvv "$APP" fi @@ -148,8 +163,8 @@ sign "$DMG" codesign --verify --strict --verbose=2 "$DMG" if [[ "$NOTARIZE" = 1 ]]; then notarize "$DMG" - xcrun stapler staple "$DMG" - xcrun stapler validate "$DMG" + stapler_retry staple "$DMG" + stapler_retry validate "$DMG" spctl --assess --type open --context context:primary-signature -vvv "$DMG" fi From fbd97d432cdf36a566c0c53739481bd6f0c32b0d Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Wed, 28 Oct 2026 12:09:15 -0400 Subject: [PATCH 03/49] Release 0.14.0 Co-Authored-By: Claude Opus 5.5 --- Cargo.lock | 32 ++++++++++++++++---------------- Cargo.toml | 2 +- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index ab48c95da..34cfc44cc 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -614,7 +614,7 @@ checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04" [[package]] name = "cadcraft" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-engine", "cadcraft-io", @@ -643,7 +643,7 @@ dependencies = [ [[package]] name = "cadcraft-cli" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-engine", "cadcraft-io", @@ -659,14 +659,14 @@ dependencies = [ [[package]] name = "cadcraft-color" -version = "0.13.0" +version = "0.14.0" dependencies = [ "serde", ] [[package]] name = "cadcraft-constraints" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-doc", "cadcraft-geom", @@ -676,7 +676,7 @@ dependencies = [ [[package]] name = "cadcraft-doc" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-color", "cadcraft-geom", @@ -687,14 +687,14 @@ dependencies = [ [[package]] name = "cadcraft-dwg" -version = "0.13.0" +version = "0.14.0" dependencies = [ "acadrust", ] [[package]] name = "cadcraft-dxf" -version = "0.13.0" +version = "0.14.0" dependencies = [ "encoding_rs", "log", @@ -703,7 +703,7 @@ dependencies = [ [[package]] name = "cadcraft-engine" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-color", "cadcraft-constraints", @@ -724,7 +724,7 @@ dependencies = [ [[package]] name = "cadcraft-fonts" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-geom", "harfrust 0.14.0", @@ -734,14 +734,14 @@ dependencies = [ [[package]] name = "cadcraft-geom" -version = "0.13.0" +version = "0.14.0" dependencies = [ "serde", ] [[package]] name = "cadcraft-io" -version = "0.13.0" +version = "0.14.0" dependencies = [ "acadrust", "cadcraft-color", @@ -762,7 +762,7 @@ dependencies = [ [[package]] name = "cadcraft-mcp" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-engine", "cadcraft-io", @@ -775,7 +775,7 @@ dependencies = [ [[package]] name = "cadcraft-render" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-color", "cadcraft-doc", @@ -789,7 +789,7 @@ dependencies = [ [[package]] name = "cadcraft-ui-egui" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-color", "cadcraft-doc", @@ -815,7 +815,7 @@ dependencies = [ [[package]] name = "cadcraft-web" -version = "0.13.0" +version = "0.14.0" dependencies = [ "cadcraft-engine", "cadcraft-io", @@ -5893,7 +5893,7 @@ checksum = "9440ea3e5aeabb0ac63af70daf835274065238cdd0cec83418f417eae38bacee" [[package]] name = "xtask" -version = "0.13.0" +version = "0.14.0" dependencies = [ "chrono", "serde_json", diff --git a/Cargo.toml b/Cargo.toml index 2b38a218f..1d4d7c530 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ members = ["crates/*", "apps/*", "xtask"] # default-members [workspace.package] -version = "0.13.0" +version = "0.14.0" edition = "2024" license = "MIT OR Apache-2.0" rust-version = "1.95" From 9de2b8bbdc6691830e7c15abe2cbcae45b22bedb Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Wed, 28 Oct 2026 13:23:09 -0400 Subject: [PATCH 04/49] Grant network access so update checks can reach GitHub (#2413) Add --share=network to the finish-args of both Flatpak manifests. Without it the sandbox cannot resolve or reach GitHub, so update checks fail with "Temporary failure in name resolution". The two manifests keep identical finish-args. --- packaging/linux/flatpak/ai.storyteller.cadcraft.bundle.yml | 6 +++--- packaging/linux/flatpak/ai.storyteller.cadcraft.yml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packaging/linux/flatpak/ai.storyteller.cadcraft.bundle.yml b/packaging/linux/flatpak/ai.storyteller.cadcraft.bundle.yml index b6a64d8fb..651b9a358 100644 --- a/packaging/linux/flatpak/ai.storyteller.cadcraft.bundle.yml +++ b/packaging/linux/flatpak/ai.storyteller.cadcraft.bundle.yml @@ -24,15 +24,15 @@ finish-args: - --share=ipc # GPU access for the wgpu canvas (Vulkan, or GL as a fallback). - --device=dri + # Outbound network access (HTTPS). + - --share=network # Open/Save dialogs go through the file-chooser portal (rfd) and drag-and-drop through the # document portal, so picked files work anywhere without broad filesystem access. Documents # and Pictures are granted so drawings passed by path (the command line, Open Recent, xrefs # and images next to a DXF) work in the usual places. - --filesystem=xdg-documents - --filesystem=xdg-pictures - # Deliberately not granted: network (the optional --control server listens on 127.0.0.1 in - # the sandbox; `flatpak override --user --share=network ai.storyteller.cadcraft` exposes it to - # host agents) and home/host filesystem access. + # Deliberately not granted: home/host filesystem access. modules: - name: cadcraft buildsystem: simple diff --git a/packaging/linux/flatpak/ai.storyteller.cadcraft.yml b/packaging/linux/flatpak/ai.storyteller.cadcraft.yml index 75a6ff690..88a49e136 100644 --- a/packaging/linux/flatpak/ai.storyteller.cadcraft.yml +++ b/packaging/linux/flatpak/ai.storyteller.cadcraft.yml @@ -25,15 +25,15 @@ finish-args: - --share=ipc # GPU access for the wgpu canvas (Vulkan, or GL as a fallback). - --device=dri + # Outbound network access (HTTPS). + - --share=network # Open/Save dialogs go through the file-chooser portal (rfd) and drag-and-drop through the # document portal, so picked files work anywhere without broad filesystem access. Documents # and Pictures are granted so drawings passed by path (the command line, Open Recent, xrefs # and images next to a DXF) work in the usual places. - --filesystem=xdg-documents - --filesystem=xdg-pictures - # Deliberately not granted: network (the optional --control server listens on 127.0.0.1 in - # the sandbox; `flatpak override --user --share=network ai.storyteller.cadcraft` exposes it to - # host agents) and home/host filesystem access. + # Deliberately not granted: home/host filesystem access. build-options: append-path: /usr/lib/sdk/rust-stable/bin modules: From 336243e0afb3019feee58d0d4fc0d218f25530e7 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Wed, 28 Oct 2026 15:53:50 -0400 Subject: [PATCH 05/49] Honor CARGO_BUILD_TARGET in FreeBSD packaging for aarch64 release builds (#2425) Add packaging/freebsd/package.sh, matching the other craft apps: an optional CARGO_BUILD_TARGET (x86_64 or aarch64 FreeBSD) names the archive and reads the cross-built binaries; unset means native. --skip-build and --dry-run supported. --- packaging/freebsd/package.sh | 130 +++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100755 packaging/freebsd/package.sh diff --git a/packaging/freebsd/package.sh b/packaging/freebsd/package.sh new file mode 100755 index 000000000..e1718648f --- /dev/null +++ b/packaging/freebsd/package.sh @@ -0,0 +1,130 @@ +#!/usr/bin/env bash +# Build and package CADCraft for FreeBSD: +# +# $DIST/cadcraft--freebsd-.tar.gz a /usr/local-style tree ( is x86_64, or +# aarch64 when CARGO_BUILD_TARGET=aarch64-unknown-freebsd): +# cadcraft--freebsd-/{bin, man/man1, share/applications, share/icons, +# share/mime, share/metainfo, share/doc/cadcraft, share/{bash-completion,zsh,fish}} +# +# Install by copying the tree's contents into /usr/local, e.g. +# tar -xzf cadcraft-*-freebsd-x86_64.tar.gz --strip-components 1 -C /usr/local +# +# Usage: packaging/freebsd/package.sh [--skip-build] [--dry-run] +# --dry-run print the resolved target, archive and cargo commands, then exit without building +# +# Needs: bash, cargo and the build dependencies listed in .github/workflows/freebsd.yml. FreeBSD's +# install(1) has no -D, so directories are created first. +set -euo pipefail +# shellcheck source=../env.sh +. "$(dirname "${BASH_SOURCE[0]}")/../env.sh" +LINUX="$ROOT/packaging/linux" +APP_ID=ai.storyteller.cadcraft + +SKIP_BUILD=0 +DRY_RUN=0 +while [[ $# -gt 0 ]]; do + case "$1" in + --skip-build) SKIP_BUILD=1; shift ;; + --dry-run) DRY_RUN=1; shift ;; + -h | --help) sed -n '2,12p' "$0"; exit 0 ;; + *) echo "unknown argument: $1" >&2; exit 2 ;; + esac +done + +# FreeBSD calls x86_64 "amd64"; release names use the Rust/Linux spelling. +release_arch() { + case "$1" in + amd64 | x86_64) echo x86_64 ;; + arm64 | aarch64) echo aarch64 ;; + *) echo "unsupported architecture $1" >&2; return 2 ;; + esac +} +# The release workflow cross-compiles aarch64 in an x86_64 VM with CARGO_BUILD_TARGET set to +# aarch64-unknown-freebsd (craft-common-actions#39): name the archive after the target. +# host-tuple means the build host's triple, as rustc names it. +if [[ "${CARGO_BUILD_TARGET:-}" == host-tuple ]]; then + CARGO_BUILD_TARGET="$(rustc -vV | sed -n 's/^host: //p')" +fi +case "${CARGO_BUILD_TARGET:-}" in + "") ARCH="$(release_arch "$(uname -m)")" ;; + aarch64-unknown-freebsd | x86_64-unknown-freebsd) ARCH="$(release_arch "${CARGO_BUILD_TARGET%%-*}")" ;; + *) echo "CARGO_BUILD_TARGET=$CARGO_BUILD_TARGET is not a supported FreeBSD target" >&2; exit 2 ;; +esac +# Only binaries for this machine run here (the --version check at the end); a FreeBSD target built +# on another OS never does. +HOST_ARCH="$(release_arch "$(uname -m)" 2>/dev/null)" || HOST_ARCH="$(uname -m)" +if [[ -n "${CARGO_BUILD_TARGET:-}" ]] && [[ "$(uname -s)" != FreeBSD ]]; then + HOST_ARCH="$(uname -s) $HOST_ARCH" +fi +BASENAME="cadcraft-$VERSION-freebsd-$ARCH" + +echo "==> CADCraft $VERSION for FreeBSD $ARCH" + +# cadcraft-cli's man-and-completions example is built on its own, not with the binaries: its +# dev-dependencies would otherwise be unified into them (packaging/linux/package.sh). It runs on +# this machine, so a cross build builds it without the target. +CARGO_BUILD_FLAGS=(--release --locked ${CARGO_BUILD_TARGET:+--target "$CARGO_BUILD_TARGET"}) +if [[ "$DRY_RUN" = 1 ]]; then + echo "dry run: archive $DIST/$BASENAME.tar.gz" + echo "dry run: (cd $ROOT && cargo build ${CARGO_BUILD_FLAGS[*]} -p cadcraft -p cadcraft-cli)" + echo "dry run: (cd $ROOT && env -u CARGO_BUILD_TARGET cargo build --release --locked -p cadcraft-cli --example man-and-completions)" + exit 0 +fi +if [[ "$SKIP_BUILD" = 0 ]]; then + (cd "$ROOT" && cargo build "${CARGO_BUILD_FLAGS[@]}" -p cadcraft -p cadcraft-cli) + (cd "$ROOT" && env -u CARGO_BUILD_TARGET cargo build --release --locked -p cadcraft-cli --example man-and-completions) +fi +# Cargo puts a cross build under target//release. +BIN="$CARGO_TARGET_DIR/${CARGO_BUILD_TARGET:+$CARGO_BUILD_TARGET/}release" +WORK="$CARGO_TARGET_DIR/freebsd-package" +STAGE="$WORK/$BASENAME" +rm -rf "$WORK" + +# ---- stage a /usr/local-style tree --------------------------------------------------------------- +mkdir -p "$STAGE/bin" "$STAGE/share/applications" "$STAGE/share/mime/packages" "$STAGE/share/metainfo" \ + "$STAGE/share/icons" "$STAGE/share/doc/cadcraft" +install -m 755 "$BIN/cadcraft" "$BIN/cadcraft-cli" "$STAGE/bin/" +strip "$STAGE/bin/cadcraft" "$STAGE/bin/cadcraft-cli" 2>/dev/null || true +# The desktop entry, MIME type and metainfo are the freedesktop files the Linux packages use. +install -m 644 "$LINUX/$APP_ID.desktop" "$STAGE/share/applications/$APP_ID.desktop" +install -m 644 "$LINUX/$APP_ID.mime.xml" "$STAGE/share/mime/packages/$APP_ID.xml" +sed -e "s/@VERSION@/$VERSION/g" -e "s/@DATE@/$CADCRAFT_BUILD_DATE/g" \ + "$LINUX/$APP_ID.metainfo.xml.in" >"$STAGE/share/metainfo/$APP_ID.metainfo.xml" +cp -R "$ROOT/assets/app-icon/hicolor" "$STAGE/share/icons/" +copy_docs "$STAGE/share/doc/cadcraft" +# cadcraft-cli's man pages and shell completions, from its clap definition, written by the +# example built above. +CLI_DOCS="$CARGO_TARGET_DIR/release/examples/man-and-completions" +if [[ ! -x "$CLI_DOCS" ]]; then + echo "error: $CLI_DOCS is missing: build it with the binaries (without --skip-build)" >&2 + exit 1 +fi +"$CLI_DOCS" "$WORK/cli-docs" +mkdir -p "$STAGE/man/man1" "$STAGE/share/bash-completion/completions" \ + "$STAGE/share/zsh/site-functions" "$STAGE/share/fish/vendor_completions.d" +install -m 644 "$WORK"/cli-docs/*.1 "$STAGE/man/man1/" +install -m 644 "$WORK/cli-docs/cadcraft-cli.bash" "$STAGE/share/bash-completion/completions/cadcraft-cli" +install -m 644 "$WORK/cli-docs/_cadcraft-cli" "$STAGE/share/zsh/site-functions/_cadcraft-cli" +install -m 644 "$WORK/cli-docs/cadcraft-cli.fish" "$STAGE/share/fish/vendor_completions.d/cadcraft-cli.fish" + +# ---- .tar.gz ------------------------------------------------------------------------------------- +mkdir -p "$DIST" +tar -C "$WORK" -czf "$DIST/$BASENAME.tar.gz" "$BASENAME" +echo "wrote $DIST/$BASENAME.tar.gz" + +if [[ -z "${CARGO_BUILD_TARGET:-}" ]] && [[ "$ARCH" = "$HOST_ARCH" ]]; then + "$STAGE/bin/cadcraft-cli" --version +else + # They cannot run here, so check what they are instead: executables, not libraries or objects. + # An older file(1) calls a PIE a shared object; its interpreter still marks it as a program. + want="$ARCH"; [[ "$ARCH" != x86_64 ]] || want=x86-64 + for b in "$STAGE"/bin/*; do + case "$(file -b "$b")" in + ELF*" executable, "*"$want"*FreeBSD* | ELF*"$want"*FreeBSD*interpreter*) ;; + *) echo "error: $b is not a FreeBSD $ARCH executable: $(file -b "$b")" >&2; exit 1 ;; + esac + done + echo "skipping --version: a CARGO_BUILD_TARGET=$CARGO_BUILD_TARGET build does not run on this $HOST_ARCH machine" +fi +echo "==> done" +ls -lh "$DIST" From afc12e4dce92a07921a3e2391f5508e5b3483278 Mon Sep 17 00:00:00 2001 From: aldozar Date: Thu, 29 Oct 2026 19:20:58 -0600 Subject: [PATCH 06/49] PEDIT Multiple at the command line (#2225) * PEDIT Multiple at the command line (#2182) `M` at "Select polyline" answered that Multiple was only available through the JSON form. It now works as in AutoCAD: select objects (polylines, lines and arcs), turn the lines and arcs into polylines on Yes (left out on No), then each option applies to all of them: Close, Open, Width, Fit, Spline, Decurve, Ltype gen and Reverse. Join joins the selected objects with each other, ends within a fuzz distance, and reports how many it added. Undo takes the last option back. Co-Authored-By: Claude Opus 5.5 * Geometry parity status line for PEDIT Multiple Co-Authored-By: Claude Opus 5.5 * PEDIT Multiple: objects selected first, and Decurve after Fit or Spline Several objects selected before PEDIT go straight into Multiple, as in AutoCAD, and M keeps a selection made first. Decurve gives back each polyline's vertices from before its first Fit or Spline, as single-polyline PEDIT does; a Join drops that record for the joined polylines. Co-Authored-By: Claude Opus 5.5 * PEDIT Multiple: the Decurve record follows Undo and survives a Join that joins nothing Each Undo step keeps the record of the vertices from before Fit or Spline, so Fit, Join, Undo, Decurve gives them back; a Join drops the record only for a polyline that took on segments. Co-Authored-By: Claude Opus 5.5 * PEDIT: Yes/No asked again on another answer; Decurve keeps a later Width The convert questions (single and Multiple) take Y/Yes, N/No or Enter and ask again for any other answer instead of treating it as Yes. Width clears the per-vertex widths of the vertices kept for Decurve too, so Decurve after Fit or Spline and Width keeps the new width. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/modify2.rs | 1 + crates/engine/src/cmd/modify2/pedit.rs | 52 +++- crates/engine/src/cmd/modify2/pedit_multi.rs | 235 +++++++++++++++++++ crates/engine/tests/it/main.rs | 1 + crates/engine/tests/it/pedit_multiple.rs | 197 ++++++++++++++++ docs/geometry-parity.md | 3 +- 6 files changed, 484 insertions(+), 5 deletions(-) create mode 100644 crates/engine/src/cmd/modify2/pedit_multi.rs create mode 100644 crates/engine/tests/it/pedit_multiple.rs diff --git a/crates/engine/src/cmd/modify2.rs b/crates/engine/src/cmd/modify2.rs index 8d814ebe0..0198a962d 100644 --- a/crates/engine/src/cmd/modify2.rs +++ b/crates/engine/src/cmd/modify2.rs @@ -122,6 +122,7 @@ pub(crate) fn as_lwpoly(k: &EntityKind) -> Option { } } +mod pedit_multi; mod pedit_vertex; // ===================================================================================== diff --git a/crates/engine/src/cmd/modify2/pedit.rs b/crates/engine/src/cmd/modify2/pedit.rs index ae9110e48..0c1b64879 100644 --- a/crates/engine/src/cmd/modify2/pedit.rs +++ b/crates/engine/src/cmd/modify2/pedit.rs @@ -164,7 +164,7 @@ pub(crate) fn pedit_join(s: &mut Session, h: Handle, others: &[Handle], fuzz: f6 Ok(joined.len()) } -fn pedit_apply(s: &mut Session, h: Handle, opt: &str, p: &Value) -> Result { +pub(super) fn pedit_apply(s: &mut Session, h: Handle, opt: &str, p: &Value) -> Result { let e = curves::entity(s, h)?; if curves::is_locked(s, h) { return Err(other("The object is on a locked layer.")); @@ -287,6 +287,13 @@ pub(super) enum PPhase { /// The second marker of Break / Straighten. VMark, VTangent, + /// Multiple ([`super::pedit_multi`]): selecting the objects, converting lines and arcs, the + /// options, the width for all, Join's fuzz distance. + MSelect, + MConvert, + MMain, + MWidth, + MFuzz, } #[derive(Default)] @@ -305,6 +312,34 @@ pub(super) struct PeditM { pub(super) tangents: Vec<(Vec2, Vec2)>, /// Pieces split off by Break, with the history length after it (erased again by Undo). pub(super) split_off: Vec<(usize, Vec)>, + /// Multiple: the polylines being edited, their selection, and the drawing before each option + /// (with those polylines and their Decurve record) for Undo. + pub(super) multi: Vec, + pub(super) msel: SelectPhase, + pub(super) mundo: Vec<(cadcraft_doc::Drawing, Vec, std::collections::HashMap>)>, + /// Multiple: each polyline's vertices before its first Fit or Spline, which Decurve restores. + pub(super) morig: std::collections::HashMap>, +} + +/// A Yes/No answer: Enter is Yes, anything but Y/Yes/N/No is refused so the question is asked again. +pub(super) fn yes_no(i: &Input) -> Result { + match i { + Input::Enter => Ok(true), + Input::Keyword(k) | Input::Text(k) => match k.trim().to_ascii_lowercase().as_str() { + "y" | "yes" => Ok(true), + "n" | "no" => Ok(false), + _ => Err(other("Enter Yes or No.")), + }, + _ => Err(other("Enter Yes or No.")), + } +} + +/// Width sets one width for the whole polyline, so the vertices Decurve gives back take it too. +pub(super) fn clear_widths(vs: &mut [PolyVertex]) { + for v in vs { + v.start_width = 0.0; + v.end_width = 0.0; + } } impl PeditM { @@ -339,6 +374,10 @@ impl Interactive for PeditM { } fn begin(&mut self, s: &mut Session) -> Result { let sel = s.selection(); + // Several objects selected first: straight into Multiple, as in AutoCAD. + if sel.len() > 1 && s.settings.pickfirst { + return self.start_multi(s); + } if let [h] = sel.as_slice() { let k = curves::entity(s, *h)?.kind; match k { @@ -358,6 +397,7 @@ impl Interactive for PeditM { } fn prompt(&self, s: &Session) -> Prompt { match self.phase { + PPhase::MSelect | PPhase::MConvert | PPhase::MMain | PPhase::MWidth | PPhase::MFuzz => self.multi_prompt(), PPhase::Select => Prompt::new("Select polyline or", Accept::POINT).kw(&["Multiple"]), PPhase::Convert => { Prompt::new("Object selected is not a polyline. Do you want to turn it into one?", curves::KW).kw(&["Yes", "No"]).default("Y") @@ -398,6 +438,7 @@ impl Interactive for PeditM { _ => None, }; match self.phase { + PPhase::MSelect | PPhase::MConvert | PPhase::MMain | PPhase::MWidth | PPhase::MFuzz => self.multi_input(s, i), PPhase::Select => match i { Input::Point(p) => { let h = curves::pick_at(s, p).ok_or_else(|| other("*Invalid selection*"))?; @@ -417,13 +458,13 @@ impl Interactive for PeditM { s.set_selection(vec![h]); Ok(Step::Continue) } - Input::Keyword(_) => Err(other("Select one polyline (Multiple is available through the JSON form).")), + Input::Keyword(k) if k.eq_ignore_ascii_case("multiple") || k.eq_ignore_ascii_case("m") => self.start_multi(s), + Input::Keyword(_) => Err(other("Invalid option keyword.")), Input::Enter => Ok(Step::Cancel), _ => Ok(Step::Continue), }, PPhase::Convert => { - let no = kw(&i).is_some_and(|k| k.starts_with('n')); - if no { + if !yes_no(&i)? { return Ok(Step::Done); } let h = self.h.ok_or_else(|| other("No object."))?; @@ -487,6 +528,9 @@ impl Interactive for PeditM { if let Input::Text(t) = &i { let w = number(t).filter(|w| *w >= 0.0).ok_or_else(|| other("Requires a non-negative width."))?; self.apply(s, "width", json!({ "width": w }))?; + if let Some(o) = &mut self.original { + clear_widths(o); + } } self.phase = PPhase::Main; Ok(Step::Continue) diff --git a/crates/engine/src/cmd/modify2/pedit_multi.rs b/crates/engine/src/cmd/modify2/pedit_multi.rs new file mode 100644 index 000000000..5a599cb1b --- /dev/null +++ b/crates/engine/src/cmd/modify2/pedit_multi.rs @@ -0,0 +1,235 @@ +//! PEDIT Multiple: edit several polylines (and lines and arcs turned into polylines) at once, as +//! AutoCAD does after `M` at "Select polyline". Join joins the selected objects with each other. + +use cadcraft_doc::{Drawing, EntityKind, Handle}; +use cadcraft_geom::PolyVertex; +use serde_json::json; + +use super::super::curves; +use super::super::machines::{SelOutcome, SelectPhase, number}; +use super::pedit::{PPhase, PeditM, clear_widths, pedit_apply, pedit_join, yes_no}; +use super::{as_lwpoly, other, set_kind}; +use crate::{Accept, Input, Prompt, Result, Session, Step}; + +/// Most option steps Undo can take back. +const MAX_UNDO: usize = 64; + +/// The options of the Multiple menu. +const OPTIONS: [&str; 10] = ["Close", "Open", "Join", "Width", "Fit", "Spline", "Decurve", "Ltype gen", "Reverse", "Undo"]; + +impl PeditM { + /// Start Multiple: select the objects to edit, or take the ones selected first. + pub(super) fn start_multi(&mut self, s: &mut Session) -> Result { + self.phase = PPhase::MSelect; + self.msel = SelectPhase::begin(s); + if self.msel.done { + let hs = std::mem::take(&mut self.msel.picked); + return self.take_multi(s, hs); + } + s.set_selection(Vec::new()); + Ok(Step::Continue) + } + + /// The objects selected for Multiple: polylines, lines and arcs not on locked layers. + fn take_multi(&mut self, s: &mut Session, hs: Vec) -> Result { + let d = s.doc()?; + let kinds = |h: &Handle| d.entity(*h).map(|e| e.kind.clone()); + let editable: Vec = hs + .iter() + .copied() + .filter(|h| matches!(kinds(h), Some(EntityKind::LwPolyline(_) | EntityKind::Line(_) | EntityKind::Arc(_)))) + .filter(|h| !curves::is_locked(s, *h)) + .collect(); + let convert = editable.iter().any(|h| matches!(kinds(h), Some(EntityKind::Line(_) | EntityKind::Arc(_)))); + self.multi = editable; + if self.multi.is_empty() { + s.echo("No polylines, lines or arcs selected."); + return Ok(Step::Done); + } + self.phase = if convert { PPhase::MConvert } else { PPhase::MMain }; + s.set_selection(self.multi.clone()); + Ok(Step::Continue) + } + + /// The prompt of a Multiple phase. + pub(super) fn multi_prompt(&self) -> Prompt { + match self.phase { + PPhase::MConvert => Prompt::new("Convert Lines and Arcs to polylines", curves::KW).kw(&["Yes", "No"]).default("Y"), + PPhase::MMain => Prompt::new("Enter an option", curves::KW).kw(&OPTIONS), + PPhase::MWidth => Prompt::new("Specify new width for all segments", Accept::NUMBER), + PPhase::MFuzz => Prompt::new("Enter fuzz distance", Accept::NUMBER).default("0.0000"), + _ => self.msel.prompt(), + } + } + + /// Input in a Multiple phase. + pub(super) fn multi_input(&mut self, s: &mut Session, i: Input) -> Result { + let kw = |i: &Input| match i { + Input::Keyword(k) | Input::Text(k) => Some(k.trim().to_ascii_lowercase()), + _ => None, + }; + match self.phase { + PPhase::MSelect => match self.msel.feed(s, &i)? { + SelOutcome::More => Ok(Step::Continue), + SelOutcome::Empty => Ok(Step::Done), + SelOutcome::Done(hs) => self.take_multi(s, hs), + }, + PPhase::MConvert => { + let no = !yes_no(&i)?; + let mut kept = Vec::new(); + for h in std::mem::take(&mut self.multi) { + let kind = curves::entity(s, h)?.kind; + match kind { + EntityKind::LwPolyline(_) => kept.push(h), + _ if no => {} + k => { + if let Some(pl) = as_lwpoly(&k) { + set_kind(s, h, EntityKind::LwPolyline(pl))?; + kept.push(h); + } + } + } + } + self.multi = kept; + if self.multi.is_empty() { + s.echo("No polylines to edit."); + return Ok(Step::Done); + } + s.set_selection(self.multi.clone()); + self.phase = PPhase::MMain; + Ok(Step::Continue) + } + PPhase::MMain => { + let Some(k) = kw(&i) else { + if i == Input::Enter { + s.set_selection(Vec::new()); + return Ok(Step::Done); + } + return Ok(Step::Continue); + }; + match k.as_str() { + "close" | "c" => self.apply_all(s, "close", &json!({}))?, + "open" | "o" => self.apply_all(s, "open", &json!({}))?, + "join" | "j" => self.phase = PPhase::MFuzz, + "width" | "w" => self.phase = PPhase::MWidth, + "fit" | "f" => self.curve_all(s, "fit")?, + "spline" | "s" => self.curve_all(s, "spline")?, + "decurve" | "d" => self.decurve_all(s)?, + "ltype gen" | "l" => { + // One setting for all: the opposite of the first one's. + let on = self.multi.first().and_then(|h| curves::entity(s, *h).ok()).is_some_and(|e| match e.kind { + EntityKind::LwPolyline(p) => !p.plinegen, + _ => true, + }); + self.apply_all(s, "ltypegen", &json!({ "on": on }))?; + } + "reverse" | "r" => self.apply_all(s, "reverse", &json!({}))?, + "undo" | "u" => match self.mundo.pop() { + Some((d, multi, morig)) => { + *s.doc_mut()? = d; + self.multi = multi; + self.morig = morig; + s.set_selection(self.multi.clone()); + } + None => s.echo("Nothing to undo."), + }, + _ => return Err(other("Invalid option keyword.")), + } + Ok(Step::Continue) + } + PPhase::MWidth => { + if let Input::Text(t) = &i { + let w = number(t).filter(|w| *w >= 0.0).ok_or_else(|| other("Requires a non-negative width."))?; + self.apply_all(s, "width", &json!({ "width": w }))?; + self.morig.values_mut().for_each(|o| clear_widths(o)); + } + self.phase = PPhase::MMain; + Ok(Step::Continue) + } + PPhase::MFuzz => { + let fuzz = match &i { + Input::Text(t) => number(t).filter(|f| *f >= 0.0 && f.is_finite()).ok_or_else(|| other("Requires a non-negative distance."))?, + _ => 0.0, + }; + self.join_all(s, fuzz)?; + self.phase = PPhase::MMain; + Ok(Step::Continue) + } + _ => Ok(Step::Continue), + } + } + + /// Keep the drawing as it is for Undo (and the polylines being edited, with their Decurve + /// record). + fn remember(&mut self, s: &Session) -> Result<()> { + let d: Drawing = s.doc()?.clone(); + if self.mundo.len() >= MAX_UNDO { + self.mundo.remove(0); + } + self.mundo.push((d, self.multi.clone(), self.morig.clone())); + Ok(()) + } + + /// Apply option `opt` to every polyline being edited. + fn apply_all(&mut self, s: &mut Session, opt: &str, p: &serde_json::Value) -> Result<()> { + self.remember(s)?; + self.multi.retain(|h| s.doc().is_ok_and(|d| d.entity(*h).is_some())); + for h in self.multi.clone() { + pedit_apply(s, h, opt, p)?; + } + Ok(()) + } + + /// Fit or Spline all of them, first keeping each one's vertices for Decurve. + fn curve_all(&mut self, s: &mut Session, opt: &str) -> Result<()> { + for h in &self.multi { + if !self.morig.contains_key(h) + && let Ok(EntityKind::LwPolyline(p)) = curves::entity(s, *h).map(|e| e.kind) + { + self.morig.insert(*h, p.vertices); + } + } + self.apply_all(s, opt, &json!({})) + } + + /// Decurve all of them: one fitted or splined here gets back its vertices from before (as + /// single-polyline PEDIT does), the others lose their arcs. + fn decurve_all(&mut self, s: &mut Session) -> Result<()> { + self.apply_all(s, "decurve", &json!({}))?; + for h in self.multi.clone() { + if let Some(orig) = self.morig.get(&h) + && let Ok(EntityKind::LwPolyline(mut p)) = curves::entity(s, h).map(|e| e.kind) + { + p.vertices = orig.iter().map(|v| PolyVertex { bulge: 0.0, ..*v }).collect(); + set_kind(s, h, EntityKind::LwPolyline(p))?; + } + } + Ok(()) + } + + /// Join the polylines being edited with each other, ends within `fuzz`: each one still open + /// takes the others that meet it, and those go into it. + fn join_all(&mut self, s: &mut Session, fuzz: f64) -> Result<()> { + self.remember(s)?; + let mut rest: Vec = self.multi.iter().copied().filter(|h| s.doc().is_ok_and(|d| d.entity(*h).is_some())).collect(); + let before = rest.len(); + let mut kept = Vec::new(); + while !rest.is_empty() { + let h = rest.remove(0); + let open = matches!(curves::entity(s, h)?.kind, EntityKind::LwPolyline(p) if !p.closed); + if open { + // A polyline that took on segments no longer goes back past the Join on Decurve. + if pedit_join(s, h, &rest, fuzz)? > 0 { + self.morig.remove(&h); + } + rest.retain(|o| s.doc().is_ok_and(|d| d.entity(*o).is_some())); + } + kept.push(h); + } + let added = before - kept.len(); + s.echo(format!("{added} segments added to polyline")); + self.multi = kept; + s.set_selection(self.multi.clone()); + Ok(()) + } +} diff --git a/crates/engine/tests/it/main.rs b/crates/engine/tests/it/main.rs index c4c4a1ce6..4a2a829a7 100644 --- a/crates/engine/tests/it/main.rs +++ b/crates/engine/tests/it/main.rs @@ -85,6 +85,7 @@ mod offset_move; mod options_profile; mod overkill; mod parallel_display_list; +mod pedit_multiple; mod pedit_splinedit; mod pick_text; mod pickdrag; diff --git a/crates/engine/tests/it/pedit_multiple.rs b/crates/engine/tests/it/pedit_multiple.rs new file mode 100644 index 000000000..70a1a8bec --- /dev/null +++ b/crates/engine/tests/it/pedit_multiple.rs @@ -0,0 +1,197 @@ +//! #2182: PEDIT Multiple at the command line, as AutoCAD: select several objects, turn lines and +//! arcs into polylines, then each option applies to all of them; Join joins them with each other. + +use cadcraft_engine::Session; +use cadcraft_engine::doc::EntityKind; +use serde_json::json; + +fn polylines(s: &Session) -> Vec<(usize, bool, f64)> { + s.doc() + .unwrap() + .model + .iter() + .filter_map(|e| if let EntityKind::LwPolyline(p) = &e.kind { Some((p.vertices.len(), p.closed, p.const_width)) } else { None }) + .collect() +} + +fn count(s: &Session) -> usize { + s.doc().unwrap().model.len() +} + +fn lines(s: &mut Session, pts: &[[f64; 4]]) { + for p in pts { + s.execute("line", &json!({ "points": [[p[0], p[1]], [p[2], p[3]]] })).unwrap(); + } +} + +#[test] +fn join_turns_four_lines_into_one_closed_polyline() { + let mut s = Session::new(); + lines(&mut s, &[[0.0, 0.0, 10.0, 0.0], [10.0, 0.0, 10.0, 5.0], [10.0, 5.0, 0.0, 5.0], [0.0, 5.0, 0.0, 0.0]]); + for t in ["PEDIT", "M", "ALL", "", "Y", "J", "", ""] { + s.cmdline(t).unwrap(); + } + assert!(s.running.is_none(), "{}", s.prompt_text()); + assert_eq!(polylines(&s), vec![(4, true, 0.0)]); + assert_eq!(count(&s), 1); + assert!(s.log.iter().any(|l| l.contains("3 segments added to polyline")), "{:?}", s.log); +} + +#[test] +fn join_bridges_gaps_within_the_fuzz_distance_only() { + // Two chains with a 0.5 gap between them. + let gap = |s: &mut Session| lines(s, &[[0.0, 0.0, 10.0, 0.0], [10.5, 0.0, 20.0, 0.0]]); + let mut s = Session::new(); + gap(&mut s); + for t in ["PE", "M", "ALL", "", "Y", "J", "0", ""] { + s.cmdline(t).unwrap(); + } + assert_eq!(polylines(&s).len(), 2, "no fuzz: still two"); + let mut s = Session::new(); + gap(&mut s); + for t in ["PE", "M", "ALL", "", "Y", "J", "1", ""] { + s.cmdline(t).unwrap(); + } + assert_eq!(polylines(&s).len(), 1, "a fuzz of 1 joins them"); +} + +#[test] +fn options_apply_to_all_and_undo_takes_one_back() { + let mut s = Session::new(); + s.cmdline("pline 0,0 10,0 10,10").unwrap(); + s.cmdline("").unwrap(); + s.cmdline("pline 20,0 30,0 30,10").unwrap(); + s.cmdline("").unwrap(); + for t in ["PEDIT", "M", "ALL", "", "W", "0.5", "C"] { + s.cmdline(t).unwrap(); + } + assert_eq!(polylines(&s), vec![(3, true, 0.5), (3, true, 0.5)], "width and close on both"); + s.cmdline("U").unwrap(); + assert_eq!(polylines(&s), vec![(3, false, 0.5), (3, false, 0.5)], "Undo opens them again"); + s.cmdline("").unwrap(); + assert!(s.running.is_none()); +} + +#[test] +fn lines_left_out_when_not_converted() { + let mut s = Session::new(); + s.cmdline("pline 0,0 10,0 10,10").unwrap(); + s.cmdline("").unwrap(); + lines(&mut s, &[[20.0, 0.0, 30.0, 0.0]]); + for t in ["PEDIT", "M", "ALL", "", "N", "C", ""] { + s.cmdline(t).unwrap(); + } + assert_eq!(polylines(&s), vec![(3, true, 0.0)], "only the polyline is edited"); + assert!(s.doc().unwrap().model.iter().any(|e| matches!(e.kind, EntityKind::Line(_))), "the line stays a line"); +} + +#[test] +fn objects_selected_first_go_straight_to_multiple() { + let mut s = Session::new(); + s.cmdline("pline 0,0 10,0 10,10").unwrap(); + s.cmdline("").unwrap(); + s.cmdline("pline 20,0 30,0 30,10").unwrap(); + s.cmdline("").unwrap(); + let all: Vec<_> = s.doc().unwrap().model.iter().map(|e| e.handle).collect(); + s.set_selection(all); + for t in ["PEDIT", "W", "0.5", ""] { + s.cmdline(t).unwrap(); + } + assert_eq!(polylines(&s), vec![(3, false, 0.5), (3, false, 0.5)], "no second selection asked for"); + assert!(s.running.is_none()); +} + +#[test] +fn decurve_after_fit_gives_back_the_vertices() { + let mut s = Session::new(); + s.cmdline("pline 0,0 10,0 10,10 20,10").unwrap(); + s.cmdline("").unwrap(); + s.cmdline("pline 0,20 10,20 10,30").unwrap(); + s.cmdline("").unwrap(); + for t in ["PEDIT", "M", "ALL", "", "S"] { + s.cmdline(t).unwrap(); + } + assert!(polylines(&s).iter().all(|p| p.0 > 4), "Spline adds vertices: {:?}", polylines(&s)); + s.cmdline("D").unwrap(); + assert_eq!(polylines(&s), vec![(4, false, 0.0), (3, false, 0.0)], "Decurve gives back each one's vertices"); + s.cmdline("").unwrap(); +} + +#[test] +fn decurve_still_gives_back_the_vertices_after_a_join_that_joins_nothing_or_is_undone() { + let mut s = Session::new(); + s.cmdline("pline 0,0 10,0 10,10 20,10").unwrap(); + s.cmdline("").unwrap(); + s.cmdline("pline 0,20 10,20 10,30").unwrap(); + s.cmdline("").unwrap(); + // Join with nothing in reach joins nothing: Decurve still gives back the vertices. + for t in ["PEDIT", "M", "ALL", "", "S", "J", "0", "D"] { + s.cmdline(t).unwrap(); + } + assert_eq!(polylines(&s), vec![(4, false, 0.0), (3, false, 0.0)], "after a Join that joined nothing"); + // Spline, a Join that joins them, Undo: Decurve gives back the vertices again. + for t in ["S", "J", "100", "U", "D"] { + s.cmdline(t).unwrap(); + } + assert_eq!(polylines(&s), vec![(4, false, 0.0), (3, false, 0.0)], "after an undone Join"); + s.cmdline("").unwrap(); +} + +fn widths(s: &Session) -> Vec { + s.doc() + .unwrap() + .model + .iter() + .filter_map(|e| if let EntityKind::LwPolyline(p) = &e.kind { Some(p) } else { None }) + .flat_map(|p| p.vertices.iter().flat_map(|v| [v.start_width, v.end_width])) + .collect() +} + +#[test] +fn convert_asks_again_for_an_answer_that_is_not_yes_or_no() { + let mut s = Session::new(); + lines(&mut s, &[[0.0, 0.0, 10.0, 0.0]]); + for t in ["PEDIT", "M", "ALL", ""] { + s.cmdline(t).unwrap(); + } + s.cmdline("foo").unwrap(); + assert!(s.prompt_text().contains("Convert"), "{}", s.prompt_text()); + assert_eq!(polylines(&s), vec![], "nothing converted on a wrong answer"); + s.cmdline("Y").unwrap(); + assert_eq!(polylines(&s).len(), 1); + s.cmdline("").unwrap(); + + // Single-polyline PEDIT asks again too. + lines(&mut s, &[[0.0, 5.0, 10.0, 5.0]]); + let l = s.doc().unwrap().model.last().unwrap().handle; + s.set_selection(vec![l]); + s.cmdline("PEDIT").unwrap(); + s.cmdline("foo").unwrap(); + assert!(s.prompt_text().contains("turn it into one"), "{}", s.prompt_text()); + s.cmdline("N").unwrap(); + assert!(s.running.is_none()); +} + +#[test] +fn decurve_after_width_keeps_the_new_width() { + let mut s = Session::new(); + for t in ["PLINE", "0,0", "W", "0", "2", "10,0", "10,10", "20,10", ""] { + s.cmdline(t).unwrap(); + } + assert!(widths(&s).iter().any(|w| *w > 0.0), "{:?}", widths(&s)); + for t in ["PEDIT", "M", "ALL", "", "S", "W", "0", "D", ""] { + s.cmdline(t).unwrap(); + } + assert!(widths(&s).iter().all(|w| *w == 0.0), "Multiple: {:?}", widths(&s)); + + let mut s = Session::new(); + for t in ["PLINE", "0,0", "W", "0", "2", "10,0", "10,10", "20,10", ""] { + s.cmdline(t).unwrap(); + } + let h = s.doc().unwrap().model.last().unwrap().handle; + s.set_selection(vec![h]); + for t in ["PEDIT", "S", "W", "0", "D", ""] { + s.cmdline(t).unwrap(); + } + assert!(widths(&s).iter().all(|w| *w == 0.0), "single: {:?}", widths(&s)); +} diff --git a/docs/geometry-parity.md b/docs/geometry-parity.md index 74dfc1585..3809c637f 100644 --- a/docs/geometry-parity.md +++ b/docs/geometry-parity.md @@ -1,6 +1,6 @@ # Geometry parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-22 · **Change:** minor (bounded constraint expression and parameter depth) · **Target:** Autodesk AutoCAD 2027 +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-26 · **Change:** minor (PEDIT Multiple at the command line) · **Target:** Autodesk AutoCAD 2027 CAD users trust numbers: a trimmed endpoint, an offset, an intersection or an area is either right to the last displayed digit or the tool is unusable for production drawings. This document @@ -157,6 +157,7 @@ Total ≈ 90–140 h; items 1–6 parallelise across two or three agents. | Date | Change | Summary | |---|---|---| +| 2026-10-26 | minor | PEDIT Multiple at the command line (#2182): select objects, lines and arcs turned into polylines on Yes, then Close/Open/Join/Width/Fit/Spline/Decurve/Ltype gen/Reverse/Undo apply to all; Join joins the selected objects with each other within a fuzz distance | | 2026-10-22 | minor | Constraint expressions count operator chains toward the syntax-tree depth limit; evaluation shares one depth limit across operators and parameter references, with a 1 MiB-stack regression (#1936) | | 2026-10-14 | trivial | JOIN Close: a single arc becomes its circle, a single elliptical arc its full ellipse (#1175) | | 2026-10-12 | trivial | TRIM on a closed polyline keeps only the complementary run when the pick lies past the last cut (#726) | From ab8953067a05025f0ac6b5498ca2ab3ca0b182ea Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:21:02 +0100 Subject: [PATCH 07/49] Reject out-of-range LUNITS, LUPREC, AUNITS and AUPREC in SETVAR (#2269) Found while testing crates/engine/src/sysvars.rs:379-420 (generic fallthrough in set); the valid ranges are enforced only in crates/engine/src/cmd/props.rs:611-616 (run_units) Co-authored-by: Claude Haiku 5.5 --- crates/engine/src/cmd.rs | 1 + crates/engine/src/cmd/props.rs | 5 ++++- crates/engine/src/sysvars.rs | 9 +++++++++ crates/engine/src/tests.rs | 11 +++++++++++ 4 files changed, 25 insertions(+), 1 deletion(-) diff --git a/crates/engine/src/cmd.rs b/crates/engine/src/cmd.rs index 1856c6a15..172e416d1 100644 --- a/crates/engine/src/cmd.rs +++ b/crates/engine/src/cmd.rs @@ -33,6 +33,7 @@ pub mod plotters; mod props; pub use draw2::breakline::BreaklineOptions; pub use props::MatchProps; +pub(crate) use props::UNIT_RANGES; pub(crate) use props::{current_color_value, set_current_color_value}; mod qselect; mod selecttools; diff --git a/crates/engine/src/cmd/props.rs b/crates/engine/src/cmd/props.rs index 817ff77a2..617d29756 100644 --- a/crates/engine/src/cmd/props.rs +++ b/crates/engine/src/cmd/props.rs @@ -645,9 +645,12 @@ impl Interactive for ThicknessM { } } +/// The unit variables (lower-case name, lowest, highest value) shared by UNITS and SETVAR. +pub(crate) const UNIT_RANGES: [(&str, i64, i64); 5] = [("lunits", 1, 5), ("luprec", 0, 8), ("aunits", 0, 4), ("auprec", 0, 8), ("insunits", 0, 24)]; + fn run_units(s: &mut Session, p: &Value) -> Result { let d = s.doc_mut()?; - for (k, lo, hi) in [("lunits", 1, 5), ("luprec", 0, 8), ("aunits", 0, 4), ("auprec", 0, 8), ("insunits", 0, 24)] { + for (k, lo, hi) in UNIT_RANGES { if let Some(v) = p.get(k).and_then(Value::as_i64) { d.header.set_i64(&k.to_ascii_uppercase(), v.clamp(lo, hi)); } diff --git a/crates/engine/src/sysvars.rs b/crates/engine/src/sysvars.rs index e22529aac..945a694bc 100644 --- a/crates/engine/src/sysvars.rs +++ b/crates/engine/src/sysvars.rs @@ -375,6 +375,15 @@ pub fn set(s: &mut Session, name: &str, v: &Value) -> Result<()> { let a = a.filter(|a| a.is_finite()).ok_or_else(bad)?; s.doc_mut()?.header.set_f64("ANGBASE", cadcraft_geom::norm_angle(a)); } + // Whole numbers inside the range UNITS clamps to. + "LUNITS" | "LUPREC" | "AUNITS" | "AUPREC" => { + let (_, lo, hi) = crate::cmd::UNIT_RANGES.iter().find(|(k, ..)| k.eq_ignore_ascii_case(&n)).copied().ok_or_else(bad)?; + let i = as_i(v) + .or_else(|| as_f64(v).filter(|f| f.fract() == 0.0 && f.abs() < 1e15).map(|f| f as i64)) + .filter(|i| (lo..=hi).contains(i)) + .ok_or_else(bad)?; + s.doc_mut()?.header.set_i64(&n, i); + } "CONSTRAINTINFER" => s.doc_mut()?.parametric.settings.infer = as_bool(v).ok_or_else(bad)?, _ => { if let Some(r) = table::set(s, &n, v) { diff --git a/crates/engine/src/tests.rs b/crates/engine/src/tests.rs index 8c590dd97..066df250b 100644 --- a/crates/engine/src/tests.rs +++ b/crates/engine/src/tests.rs @@ -633,6 +633,17 @@ fn setvar_keeps_header_types() { assert_eq!(s.doc().unwrap().header.f64("LTSCALE", 0.0), 1.0); } +#[test] +fn setvar_rejects_out_of_range_units() { + let mut s = Session::new(); + for (name, v) in [("LUPREC", 100), ("LUNITS", 9), ("LUNITS", 0), ("AUPREC", -5), ("AUNITS", 5)] { + assert!(s.execute("setvar", &json!({"name": name, "value": v})).is_err(), "{name} {v}"); + } + s.execute("setvar", &json!({"name": "LUPREC", "value": 8})).unwrap(); + assert_eq!(s.doc().unwrap().header.i64("LUPREC", 0), 8); + assert_ne!(s.doc().unwrap().header.i64("LUNITS", 2), 9); +} + #[test] fn dynamic_input_pointer_settings() { let mut s = Session::new(); From 7efb32b455017318c368f11cd2e91e4725e41044 Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:21:06 +0100 Subject: [PATCH 08/49] Cap autosave file names at 255 bytes for multibyte titles (#2289) Found while testing crates/engine/src/autosave.rs:61-66 (file_name) Co-authored-by: Claude Haiku 5.5 --- crates/engine/src/autosave.rs | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/crates/engine/src/autosave.rs b/crates/engine/src/autosave.rs index 14b363996..480d14c3b 100644 --- a/crates/engine/src/autosave.rs +++ b/crates/engine/src/autosave.rs @@ -59,10 +59,22 @@ pub fn set_savefilepath(path: &str) { /// The autosave file name for drawing `uid` titled `title`, written by app instance `instance`. pub fn file_name(title: &str, instance: &str, uid: u64) -> String { - let stem: String = title.chars().map(|c| if c.is_alphanumeric() || " .-_()".contains(c) { c } else { '-' }).take(80).collect(); + // File systems limit a name to 255 bytes, so the stem gets what the suffix leaves, cut at a character boundary. + let suffix = format!("_{instance}_{uid}.{EXT}"); + let budget = 255usize.saturating_sub(suffix.len()); + let mut used = 0; + let stem: String = title + .chars() + .map(|c| if c.is_alphanumeric() || " .-_()".contains(c) { c } else { '-' }) + .take(80) + .take_while(|c| { + used += c.len_utf8(); + used <= budget + }) + .collect(); let stem = stem.trim().trim_matches('.'); let stem = if stem.is_empty() { "Drawing" } else { stem }; - format!("{stem}_{instance}_{uid}.{EXT}") + format!("{stem}{suffix}") } /// Whether `s` has the form of an app instance id (`-`, see @@ -478,3 +490,20 @@ mod native { } } } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn file_name_fits_255_bytes_for_multibyte_titles() { + let instance = "12345-abcdef0123456789"; + for title in ["图".repeat(100), "😀".repeat(100), "aé图😀".repeat(40), "a".repeat(300)] { + let name = file_name(&title, instance, u64::MAX); + assert!(name.len() <= 255, "{} bytes", name.len()); + let (t, i, u) = parse_file_name(&name).expect("round trips"); + assert_eq!((i, u), (instance, u64::MAX)); + assert!(!t.is_empty()); + } + } +} From c2695f6ab0ecbb8e566bbb154b3d8bac4871c754 Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:21:10 +0100 Subject: [PATCH 09/49] Refuse invalid counts in JSON arraypolar and arrayrect (#2399) Found while testing crates/engine/src/cmd/array.rs:332-334 (count_or, used by run_arrayrect at 338-340 and run_arraypolar at 363-365) Co-authored-by: Claude Haiku 5.5 --- crates/engine/src/cmd/array.rs | 21 ++++++++++++--------- crates/engine/src/tests.rs | 19 +++++++++++++++++++ 2 files changed, 31 insertions(+), 9 deletions(-) diff --git a/crates/engine/src/cmd/array.rs b/crates/engine/src/cmd/array.rs index 479b7873a..9d4a2fd9c 100644 --- a/crates/engine/src/cmd/array.rs +++ b/crates/engine/src/cmd/array.rs @@ -328,16 +328,19 @@ fn run_array(s: &mut Session, p: &Value) -> Result { (spec.run)(s, p) } -/// A count parameter (at least 1). -fn count_or(p: &Value, key: &str, default: u64) -> u64 { - p.get(key).and_then(Value::as_u64).unwrap_or(default).max(1) +/// A count parameter (at least 1); a missing key gives the default, an invalid value is refused. +fn count_or(cmd: &str, p: &Value, key: &str, default: u64) -> Result { + match p.get(key) { + None | Some(Value::Null) => Ok(default), + Some(v) => v.as_u64().filter(|n| *n >= 1).ok_or_else(|| bad(cmd, format!("`{key}` must be a whole number of at least 1"))), + } } fn run_arrayrect(s: &mut Session, p: &Value) -> Result { let hs = targets(s, p)?; - let rows = count_or(p, "rows", 3); - let cols = count_or(p, "cols", 4); - let levels = count_or(p, "levels", 1); + let rows = count_or("arrayrect", p, "rows", 3)?; + let cols = count_or("arrayrect", p, "cols", 4)?; + let levels = count_or("arrayrect", p, "levels", 1)?; check_size(s, rows.saturating_mul(cols).saturating_mul(levels), hs.len())?; let kind = ArrayKind::Rect(RectArray { cols: count32(cols), @@ -360,9 +363,9 @@ fn run_arrayrect(s: &mut Session, p: &Value) -> Result { fn run_arraypolar(s: &mut Session, p: &Value) -> Result { let hs = targets(s, p)?; let c = point_req("arraypolar", p, "center")?; - let n = count_or(p, "count", 6); - let rows = count_or(p, "rows", 1); - let levels = count_or(p, "levels", 1); + let n = count_or("arraypolar", p, "count", 6)?; + let rows = count_or("arraypolar", p, "rows", 1)?; + let levels = count_or("arraypolar", p, "levels", 1)?; check_size(s, n.saturating_mul(rows).saturating_mul(levels), hs.len())?; let base = point_param(p, "base").or_else(|| s.doc().ok().and_then(|d| first_center(d, &hs))).unwrap_or(c); let row_spacing = f64_or(p, "rowSpacing", 1.0); diff --git a/crates/engine/src/tests.rs b/crates/engine/src/tests.rs index 066df250b..b06641fbb 100644 --- a/crates/engine/src/tests.rs +++ b/crates/engine/src/tests.rs @@ -1444,3 +1444,22 @@ fn hostile_variable_like_input_never_panics() { s.cmdline("pickadd").unwrap(); assert!(setvar_prompt_open(&s)); } + +#[test] +fn array_counts_reject_invalid_values() { + let mut s = Session::new(); + s.execute("line", &json!({"points": [[0, 0], [1, 0]]})).unwrap(); + for bad in [json!(-3), json!(0), json!(2.5)] { + for key in ["count", "rows", "levels"] { + let mut p = json!({"center": [0, 0], "associative": false}); + p[key] = bad.clone(); + assert!(s.execute("arraypolar", &p).is_err(), "arraypolar {key}={bad}"); + } + for key in ["rows", "cols", "levels"] { + let mut p = json!({"associative": false}); + p[key] = bad.clone(); + assert!(s.execute("arrayrect", &p).is_err(), "arrayrect {key}={bad}"); + } + } + s.execute("arraypolar", &json!({"center": [0, 0], "count": 1, "associative": false})).unwrap(); +} From bcf0dbc5e8bfba025fb46344b826d2b8da9c960d Mon Sep 17 00:00:00 2001 From: Books Date: Fri, 30 Oct 2026 12:21:15 +1100 Subject: [PATCH 10/49] DWG: keep the current layer (CLAYER) through a save and reopen (#2252) (#2407) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * DWG: keep the current layer (CLAYER) through a save and reopen (#2252) The DWG header stores the current layer as a handle, and the one read from the DXF needn't be the layer's in the document, so the drawing reopened on layer 0. The bridge now resolves CLAYER by name to the layer's handle before writing, like the current text and dimension styles. Test: the_current_layer_round_trips_through_dwg. * Parity checklist: regenerated after merging main * DWG: resolve $CLAYER through the layer table's Unicode-aware lookup (#2252) eq_ignore_ascii_case missed non-ASCII case differences such as Survey_Ä / Survey_ä, leaving layer 0 current. acadrust's Table::get normalises names with to_uppercase. * DWG: test a current layer named in other letter case (#2252) --- crates/dwg/src/lib.rs | 12 ++++++++++++ crates/io/tests/it/dwg_header_vars.rs | 28 +++++++++++++++++++++++++++ docs/parity-checklist.md | 4 ++-- 3 files changed, 42 insertions(+), 2 deletions(-) diff --git a/crates/dwg/src/lib.rs b/crates/dwg/src/lib.rs index b81bd00d1..8abb696b5 100644 --- a/crates/dwg/src/lib.rs +++ b/crates/dwg/src/lib.rs @@ -512,6 +512,17 @@ mod native { } } + /// The current layer (`$CLAYER`) by its name, the same way as [`current_dimstyle`]: a DWG + /// stores the handle of the layer, and the one read with the DXF needn't be the layer's in + /// the document, so the drawing reopened with layer "0" current (#2252). + fn current_layer(doc: &mut acadrust::CadDocument) { + let name = doc.header.current_layer_name.clone(); + // The table's own lookup compares Unicode case-insensitively ("Survey_Ä" = "Survey_ä"). + if let Some(layer) = doc.layers.get(&name) { + doc.header.current_layer_handle = layer.handle; + } + } + fn convert(dxf: &[u8], version: Option) -> Result, String> { // Reject a pathologically large DXF before handing it to the third-party decoder, which // allocates tables and section buffers from the input's declared sizes and cannot be @@ -543,6 +554,7 @@ mod native { current_dimstyle(&mut doc); add_variable_dictionary(&mut doc); current_text_style(&mut doc); + current_layer(&mut doc); std::panic::catch_unwind(AssertUnwindSafe(|| acadrust::DwgWriter::write_to_vec(&doc))) .map_err(|_| "the DWG writer failed on this drawing".to_string())? .map_err(|e| format!("DWG write: {e}")) diff --git a/crates/io/tests/it/dwg_header_vars.rs b/crates/io/tests/it/dwg_header_vars.rs index d1850278f..1bebee75e 100644 --- a/crates/io/tests/it/dwg_header_vars.rs +++ b/crates/io/tests/it/dwg_header_vars.rs @@ -59,3 +59,31 @@ fn header_settings_round_trip_through_dwg() { let r = cadcraft_io::read(&dwg, "x.dwg").unwrap(); check("DWG", &r); } + +/// The current layer (`$CLAYER`) survives a DWG save and reopen, ASCII or not. A DWG stores a +/// handle to the layer, and the writer used the null handle, so the drawing came back on "0" (#2252). +#[test] +fn the_current_layer_round_trips_through_dwg() { + for name in ["Survey_B", "Survey_\u{c4}"] { + let mut d = Drawing::new_metric(); + d.layers.push(cadcraft_doc::Layer::new(name)); + d.header.set_str("CLAYER", name); + let dxf = cadcraft_io::read_dxf(cadcraft_io::write_dxf(&d).as_bytes()).unwrap(); + assert_eq!(dxf.header.str("CLAYER", "?"), name, "DXF keeps it"); + let dwg = cadcraft_io::write(&d, "x.dwg").unwrap(); + let r = cadcraft_io::read(&dwg, "x.dwg").unwrap(); + assert_eq!(r.header.str("CLAYER", "?"), name, "DWG"); + } +} + +/// `$CLAYER` naming the layer in other letter case still finds it: the DWG comes back on the +/// layer, under the layer's own spelling, not on "0" (#2252). +#[test] +fn a_current_layer_in_other_case_resolves_to_the_layer() { + let mut d = Drawing::new_metric(); + d.layers.push(cadcraft_doc::Layer::new("Survey_\u{c4}")); + d.header.set_str("CLAYER", "Survey_\u{e4}"); + let dwg = cadcraft_io::write(&d, "x.dwg").unwrap(); + let r = cadcraft_io::read(&dwg, "x.dwg").unwrap(); + assert_eq!(r.header.str("CLAYER", "?"), "Survey_\u{c4}"); +} diff --git a/docs/parity-checklist.md b/docs/parity-checklist.md index a6250d5dc..ee0358f9e 100644 --- a/docs/parity-checklist.md +++ b/docs/parity-checklist.md @@ -1,10 +1,10 @@ # Parity checklist -> **Generated:** 2026-10-25 by `cargo xtask parity`. Do not edit by hand. +> **Generated:** 2026-10-28 by `cargo xtask parity`. Do not edit by hand. Menu-breadth parity: a reference menu item counts as covered when a CADCraft command is registered under the same menu label. It measures breadth, not depth; see [target-app-parity.md](target-app-parity.md) for the weighted assessment. -**Menu breadth: 297 / 491 items (60%)** · 442 registered commands. +**Menu breadth: 298 / 491 items (61%)** · 444 registered commands. | Menu | Items | Covered | % | |---|---|---|---| From 9a1f200795f9b2618cf197b2bb2e8c6acbb833ea Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Fri, 30 Oct 2026 08:21:20 +0700 Subject: [PATCH 11/49] xtask: the test suite and clippy pass on Windows (#2198) * xtask: the test suite and clippy pass on Windows Two Windows-only failures stopped `cargo xtask ci` before it got going on a Windows checkout (CI runs the gate on Linux only, so neither showed): - parity::tests::civil_dates built a SystemTime 115,740,740 days after the epoch (year 318857). Windows' SystemTime ends in the year 30828, so the addition panicked ("overflow when adding duration to `SystemTime`"). That case now checks `civil_from_days` on the day count, which is what it was about, on every platform. - stats.rs imported `walk` for a test that only exists on Unix, so the import was unused on Windows and `clippy -D warnings` refused it. The Unix test calls `super::walk`, as its neighbour calls `super::walk_inner`. Checked on Windows 11 x64: `cargo test --workspace` and `cargo clippy --workspace --all-targets -- -D warnings` both pass. Co-Authored-By: Claude Opus 5.5 * Contributors: add 2ez4gcx (Doan Huynh Huu Khuong) Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- contributors/people.toml | 5 +++++ xtask/src/parity.rs | 4 +++- xtask/src/stats.rs | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/contributors/people.toml b/contributors/people.toml index 40d6ba823..101a329ac 100644 --- a/contributors/people.toml +++ b/contributors/people.toml @@ -91,3 +91,8 @@ sync_github_name = false real_name = "Robert Lee" sync_github_name = true +[people.2ez4gcx] +real_name = "Doan Huynh Huu Khuong" +display_name = "Doan Huynh Huu Khuong" +sync_github_name = false + diff --git a/xtask/src/parity.rs b/xtask/src/parity.rs index 39f8e8713..8c174d290 100644 --- a/xtask/src/parity.rs +++ b/xtask/src/parity.rs @@ -136,7 +136,9 @@ mod tests { assert_eq!(day(20_736), "2026-10-10"); assert_eq!(date(std::time::UNIX_EPOCH - std::time::Duration::from_secs(86_400)), "1970-01-01"); // Past chrono's range keeps the proleptic Gregorian date, not the epoch (old `civil_from_days`). - assert_eq!(day(115_740_740), "318857-05-20"); + // Checked on the day count: Windows' SystemTime ends in the year 30828, so building that + // SystemTime panics there. + assert_eq!(civil_from_days(115_740_740), (318_857, 5, 20)); // Windows' SystemTime can't hold u64::MAX / 2 seconds, so it is only checked where it exists. if let Some(far) = std::time::UNIX_EPOCH.checked_add(std::time::Duration::from_secs(u64::MAX / 2)) { assert_eq!(date(far), "292277026596-12-04"); diff --git a/xtask/src/stats.rs b/xtask/src/stats.rs index c2c6de3d2..6136de15a 100644 --- a/xtask/src/stats.rs +++ b/xtask/src/stats.rs @@ -134,7 +134,7 @@ pub fn run(_root: &Path, exact: bool) -> Result<(), String> { #[cfg(test)] mod tests { - use super::{Counts, count_tests, walk}; + use super::{Counts, count_tests}; #[test] fn counts_attributes_and_proptest_blocks() { @@ -155,7 +155,7 @@ mod tests { // A directory symlink pointing back at `real` would be re-scanned if followed. symlink(&real, base.join("alias")).unwrap(); let mut c = Counts::default(); - walk(&base, &mut c).unwrap(); + super::walk(&base, &mut c).unwrap(); assert_eq!(c.files, 1, "the aliased directory was followed and counted twice"); std::fs::remove_dir_all(&base).ok(); } From 35b4332ee2968de75e7da2ec0a8661338acb77a7 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Fri, 30 Oct 2026 08:21:24 +0700 Subject: [PATCH 12/49] MEASURE picks its starting end by the curve's parameter, as AutoCAD does (#2207) * MEASURE picks its starting end by the curve's parameter, as AutoCAD does MEASURE started from whichever end was nearer the pick in a straight line, and a closed curve always ran forwards from its first vertex. AutoCAD (2024, black-box: synthetic objects in accoreconsole, every POINT read back with entget) decides by the curve parameter of the pick, the segment index plus the fraction along it: - an open curve is measured from its end once the pick is halfway or further: an L-shaped polyline picked at (10, 30) on its long leg (parameter 1.3 of 2) runs from the end, although that end is the farther one; a U-shape picked at (90, 0) (parameter 0.9 of 3) runs from the start, although the end is nearer; - a closed polyline runs from its first vertex, forwards before half its parameter and backwards from then on; - a circle always runs counterclockwise from angle 0. Chain::param_of gives that parameter. The new test divide_and_measure_match_autocad pins nine measured DIVIDE and MEASURE cases (lines, arcs, circles, open and closed polylines with an arc segment), every point to 1e-9. Co-Authored-By: Claude Opus 5.5 * MEASURE: a spline's starting end comes from its own parameter A spline's chain is a tessellation with zero-length pieces dropped, so its segment count is not the spline's parameter range: a degree-1 spline whose first span has zero length spends half its parameter there, and a pick at x = 3 on its 10-unit run (parameter 1.3 of 0..2, past the middle) was measured from the start because it is short of the drawn middle. Splines now compare spline_param_of with the middle of their domain; other curves keep Chain::param_of. Pointed out in review. Co-Authored-By: Claude Opus 5.5 * MEASURE: polylines count coincident vertices in their parameter; ellipses pinned AutoCAD's polyline parameter is the vertex index, so a coincident vertex still takes one unit of the range. The chain drops zero-length spans, so its segment index and count shifted the middle: (0,0) (1,0) (101,0) (101,0) picked at x = 1.1 (parameter 1.001 of 3) was measured from the end, and (0,0) (0,0) (10,0) (20,0) picked at x = 7 (1.7 of 3) from the start. LWPOLYLINEs and 3D polylines now take the parameter from their source vertices (curves::vertex_param_of). Pointed out in review. Ellipses keep the parameter rule, which AutoCAD follows for them too: a full ellipse picked at t = pi and an elliptical arc picked past its middle both run from the end in AutoCAD 2024 (MEASURE-032 and -033 of the measured set; the other direction is 200 and 4 units off). The new test pins both, within the 1e-4 tessellation CADCraft measures along. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/curves.rs | 36 ++++ crates/engine/src/cmd/draw2/divide.rs | 40 +++- crates/engine/src/cmd/draw2/tests.rs | 273 ++++++++++++++++++++++++++ 3 files changed, 343 insertions(+), 6 deletions(-) diff --git a/crates/engine/src/cmd/curves.rs b/crates/engine/src/cmd/curves.rs index 7fe05239d..2ef2e24f2 100644 --- a/crates/engine/src/cmd/curves.rs +++ b/crates/engine/src/cmd/curves.rs @@ -479,6 +479,19 @@ impl Chain { } best.1 } + /// The curve parameter of the point on the chain nearest `p`: the index of its segment plus + /// the fraction along it (AutoCAD's polyline parameter; 0..1 along a line or an arc). + pub fn param_of(&self, p: Vec2) -> f64 { + let mut best = (f64::INFINITY, 0.0); + for (i, s) in self.segs.iter().enumerate() { + let c = s.closest(p); + let dd = c.dist(p); + if dd < best.0 { + best = (dd, i as f64 + seg_param(s, c)); + } + } + best.1 + } /// Reversed copy. pub fn reversed(&self) -> Chain { Chain { segs: self.segs.iter().rev().map(Segment::reversed).collect(), closed: self.closed } @@ -506,6 +519,29 @@ impl Chain { } } +/// The polyline parameter of the point nearest `p` on spans `(start, end, bulge)` taken from the +/// source vertices: the span's index plus the fraction along it. Unlike [`Chain::param_of`] it +/// counts zero-length spans, which a polyline's parameter range includes (one per vertex) but its +/// chain drops. +pub fn vertex_param_of(spans: &[(Vec2, Vec2, f64)], p: Vec2) -> f64 { + let mut best = (f64::INFINITY, 0.0); + for (i, &(a, b, bulge)) in spans.iter().enumerate() { + if a.near(b, EPS) { + continue; + } + let seg = match cadcraft_geom::bulge_to_arc(a, b, bulge) { + Some((arc, ccw)) => Segment::Arc { arc, ccw }, + None => Segment::Line(Line::new(a, b)), + }; + let c = seg.closest(p); + let dd = c.dist(p); + if dd < best.0 { + best = (dd, i as f64 + seg_param(&seg, c)); + } + } + best.1 +} + /// Parameter (0..1 along travel) of a point on a segment. pub fn seg_param(s: &Segment, p: Vec2) -> f64 { match s { diff --git a/crates/engine/src/cmd/draw2/divide.rs b/crates/engine/src/cmd/draw2/divide.rs index 6b6ea28e3..65e7ab06c 100644 --- a/crates/engine/src/cmd/draw2/divide.rs +++ b/crates/engine/src/cmd/draw2/divide.rs @@ -74,12 +74,40 @@ pub(super) fn run_measure(s: &mut Session, p: &Value) -> Result { } let block = str_param(p, "block").map(str::to_string); check_block(s, block.as_deref())?; - if let Some(from) = point_param(p, "from") - && !c.closed - && let (Some(a), Some(b)) = (c.start(), c.end()) - && from.dist(b) < from.dist(a) - { - c = c.reversed(); + // AutoCAD measures from the end the pick is nearer by the curve's parameter (segment index + // plus the fraction along it), not by distance: an open curve from its end once the pick is + // halfway or further, a closed one from its first vertex, backwards from halfway on. A + // circle always runs counterclockwise from angle 0. + if let Some(from) = point_param(p, "from") { + let past_half = match curves::entity(s, h)?.kind { + EntityKind::Circle(_) => false, + // A spline by its own parameter: its tessellation drops zero-length pieces, so the + // segment count is not the spline's parameter range. + EntityKind::Spline(sp) => { + let (lo, hi) = sp.domain(); + curves::spline_param_of(&sp, from) >= (lo + hi) / 2.0 + } + // Polylines by their vertices, coincident ones included (one parameter unit each, + // as in AutoCAD), which the chain drops. + EntityKind::LwPolyline(pl) => { + let n = pl.vertices.len(); + let spans: Vec<_> = (0..if pl.closed { n } else { n.saturating_sub(1) }) + .filter_map(|i| Some((pl.vertices.get(i)?.p, pl.vertices.get((i + 1) % n)?.p, pl.vertices.get(i)?.bulge))) + .collect(); + curves::vertex_param_of(&spans, from) >= spans.len() as f64 / 2.0 + } + EntityKind::Polyline3d(pl) => { + let n = pl.points.len(); + let spans: Vec<_> = (0..if pl.closed { n } else { n.saturating_sub(1) }) + .filter_map(|i| Some((pl.points.get(i)?.xy(), pl.points.get((i + 1) % n)?.xy(), 0.0))) + .collect(); + curves::vertex_param_of(&spans, from) >= spans.len() as f64 / 2.0 + } + _ => c.param_of(from) >= c.segs.len() as f64 / 2.0, + }; + if past_half { + c = c.reversed(); + } } let pts = measure_points(&c, step); let hs = place_markers(s, &pts, block.as_deref(), bool_or(p, "align", true))?; diff --git a/crates/engine/src/cmd/draw2/tests.rs b/crates/engine/src/cmd/draw2/tests.rs index a28d92b4d..b5585e381 100644 --- a/crates/engine/src/cmd/draw2/tests.rs +++ b/crates/engine/src/cmd/draw2/tests.rs @@ -302,6 +302,279 @@ fn divide_and_measure_json() { assert!(s.execute("measure", &json!({"handle": l, "length": 1e-300})).is_err()); } +/// DIVIDE and MEASURE against the points AutoCAD 2024 places for the same object and pick +/// (black-box: synthetic objects in accoreconsole, `(command "_.MEASURE" (list ename point) …)`, +/// every POINT read back with `entget`). The pick chooses the end by the curve's parameter, not +/// by distance; a closed polyline runs from its first vertex, a circle from angle 0. +#[test] +fn divide_and_measure_match_autocad() { + type Case = ((&'static str, serde_json::Value), &'static str, f64, [f64; 2], usize, &'static [[f64; 2]]); + // ((seed command, params), command, segments or length, pick, POINT count, AutoCAD points) + let cases: Vec = vec![ + // DIVIDE-001: (list ename point). + ( + ("arc", json!({"center": [0.0, 0.0], "radius": 20.0, "start": 30.0, "end": 250.0})), + "divide", + 5.0, + [-2.090569265353071, 19.890437907365467], + 4, + &[ + [-19.021130325903, 6.180339887499], + [-17.975880925983, -8.767422935782], + [-9.389431255718, 17.658951857179], + [5.51274711634, 19.225233918766], + ], + ), + // DIVIDE-002: (list ename point). + ( + ("circle", json!({"center": [0.0, 0.0], "radius": 15.0})), + "divide", + 5.0, + [-4.63525491562421, 14.265847744427305], + 5, + &[ + [-12.135254915624, -8.816778784387], + [-12.135254915624, 8.816778784387], + [4.635254915624, -14.265847744427], + [4.635254915624, 14.265847744427], + [15.0, 0.0], + ], + ), + // MEASURE-016: (list ename point). + ( + ("line", json!({"points": [[0.0, 0.0], [37.0, 13.0]]})), + "measure", + 7.688652713279647, + [25.9, 9.1], + 5, + &[ + [0.730313187001, 0.256596525162], + [7.984250549601, 2.80527722013], + [15.2381879122, 5.353957915097], + [22.4921252748, 7.902638610065], + [29.7460626374, 10.451319305032], + ], + ), + // MEASURE-024: (list ename point). + ( + ( + "pline", + json!({"vertices": [{"p": [0.0, 0.0], "bulge": 0.0}, {"p": [100.0, 0.0], "bulge": 0.0}, {"p": [100.0, 10.0], "bulge": 0.0}, {"p": [5.0, 10.0], "bulge": 0.0}], "closed": false}), + ), + "measure", + 7.0, + [90.0, 0.0], + 29, + &[[7.0, 0.0], [7.0, 10.0], [14.0, 0.0], [98.0, 0.0], [98.0, 10.0], [100.0, 5.0]], + ), + // MEASURE-026: (list ename point). + ( + ( + "pline", + json!({"vertices": [{"p": [0.0, 0.0], "bulge": 0.0}, {"p": [10.0, 0.0], "bulge": 0.0}, {"p": [10.0, 100.0], "bulge": 0.0}], "closed": false}), + ), + "measure", + 7.0, + [10.0, 30.0], + 15, + &[[5.0, 0.0], [10.0, 2.0], [10.0, 9.0], [10.0, 79.0], [10.0, 86.0], [10.0, 93.0]], + ), + // MEASURE-030: (list ename point). + ( + ( + "pline", + json!({"vertices": [{"p": [0.0, 0.0], "bulge": 0.0}, {"p": [30.0, 0.0], "bulge": 0.5}, {"p": [45.0, 20.0], "bulge": 0.0}, {"p": [10.0, 35.0], "bulge": 0.0}], "closed": true}), + ), + "measure", + 7.5, + [5.0, 17.5], + 17, + &[ + [2.06040845923, 7.211429607306], + [4.120816918461, 14.422859214612], + [5.957390538273, 0.0], + [41.854257779673, 5.445746712402], + [45.137412221497, 19.497902817843], + [45.215233654661, 12.07010340037], + ], + ), + // DIVIDE-028: (list ename point). + ( + ( + "pline", + json!({"vertices": [{"p": [0.0, 0.0], "bulge": 0.0}, {"p": [30.0, 0.0], "bulge": 0.5}, {"p": [45.0, 20.0], "bulge": 0.0}, {"p": [10.0, 35.0], "bulge": 0.0}], "closed": true}), + ), + "divide", + 5.0, + [37.5, 10.0], + 5, + &[ + [0.0, 0.0], + [7.332712970983, 25.664495398441], + [25.609294779385, 28.310302237406], + [26.691478107655, 0.0], + [45.58190593662, 14.465330916891], + ], + ), + // MEASURE-041: (list ename point). + ( + ( + "pline", + json!({"vertices": [{"p": [0.0, 0.0], "bulge": 0.0}, {"p": [30.0, 0.0], "bulge": 0.5}, {"p": [45.0, 20.0], "bulge": 0.0}, {"p": [10.0, 35.0], "bulge": 0.0}], "closed": true}), + ), + "measure", + 7.5, + [45.54951565955276, 17.15901034980981], + 17, + &[ + [1.636621047999, 5.728173667998], + [3.69702950723, 12.939603275304], + [5.75743796646, 20.15103288261], + [42.799868254703, 6.663750217618], + [44.060611317761, 20.402595149531], + [45.491536690495, 13.587129550966], + ], + ), + // MEASURE-042: (list ename point). + ( + ( + "pline", + json!({"vertices": [{"p": [0.0, 0.0], "bulge": 0.0}, {"p": [30.0, 0.0], "bulge": 0.5}, {"p": [45.0, 20.0], "bulge": 0.0}, {"p": [10.0, 35.0], "bulge": 0.0}], "closed": true}), + ), + "measure", + 7.5, + [44.0, 20.5], + 17, + &[ + [2.06040845923, 7.211429607306], + [4.120816918461, 14.422859214612], + [5.957390538273, 0.0], + [41.854257779673, 5.445746712402], + [45.137412221497, 19.497902817843], + [45.215233654661, 12.07010340037], + ], + ), + ]; + for ((seed, params), what, value, pick, count, want) in cases { + let mut s = Session::new(); + let r = s.execute(seed, ¶ms).unwrap(); + let handle = r.get("handle").or_else(|| r["handles"].get(0)).and_then(serde_json::Value::as_str).unwrap().to_string(); + // AutoLISP's (list ename point): the object and where it was picked. + let params = if what == "divide" { + json!({"handle": handle, "segments": value as u64, "from": pick}) + } else { + json!({"handle": handle, "length": value, "from": pick}) + }; + s.execute(what, ¶ms).unwrap(); + let pts: Vec = + s.doc().unwrap().model.iter().filter_map(|e| if let EntityKind::Point(p) = &e.kind { Some(p.p.xy()) } else { None }).collect(); + assert_eq!(pts.len(), count, "{what} {pick:?}: {pts:?}"); + for w in want { + let tol = 1e-9 * w[0].abs().max(w[1].abs()).max(1.0); + assert!(pts.iter().any(|p| p.near(Vec2::new(w[0], w[1]), tol)), "{what} {pick:?}: no point at {w:?} in {pts:?}"); + } + } +} + +/// A spline's end is chosen by its own parameter: this one spends half its parameter range on a +/// zero-length first span, so a pick at x = 3 is already past its middle (parameter 1.3 of 0..2) and +/// MEASURE runs from the end, though x = 3 is short of the middle of the drawn length. +#[test] +fn measure_spline_by_its_own_parameter() { + let mut s = Session::new(); + let sp = h(&s.execute("spline", &json!({"control": [[0, 0], [0, 0], [10, 0]], "degree": 1})).unwrap()); + s.execute("measure", &json!({"handle": sp, "length": 3, "from": [3, 0]})).unwrap(); + let pts: Vec = + s.doc().unwrap().model.iter().filter_map(|e| if let EntityKind::Point(p) = &e.kind { Some(p.p.xy()) } else { None }).collect(); + assert!(pts.len() == 3 && [7.0, 4.0, 1.0].iter().all(|x| pts.iter().any(|p| near(*p, *x, 0.0))), "{pts:?}"); +} + +/// MEASURE counts every vertex in a polyline's parameter, coincident ones too (AutoCAD's polyline +/// parameter is the vertex index; the chain drops zero-length spans), and picks an ellipse's end +/// by the ellipse parameter like any other curve: AutoCAD 2024 runs both measured cases below from +/// the end (black-box, accoreconsole, POINTs read back with `entget`). +#[test] +fn measure_counts_coincident_vertices_and_runs_ellipses_by_parameter() { + let pts = |s: &Session| -> Vec { + s.doc().unwrap().model.iter().filter_map(|e| if let EntityKind::Point(p) = &e.kind { Some(p.p.xy()) } else { None }).collect() + }; + // (0,0) (1,0) (101,0) (101,0) picked at x = 1.1: parameter 1.001 of 3, before the middle, so + // from the start (the chain alone, 1.001 of 2, ran it from the end). + let mut s = Session::new(); + let pl = h(&s.execute("pline", &json!({"vertices": [[0, 0], [1, 0], [101, 0], [101, 0]]})).unwrap()); + s.execute("measure", &json!({"handle": pl, "length": 30, "from": [1.1, 0]})).unwrap(); + assert!(pts(&s).iter().any(|p| near(*p, 30.0, 0.0)), "{:?}", pts(&s)); + // (0,0) (0,0) (10,0) (20,0) picked at x = 7: parameter 1.7 of 3, past the middle, so from the + // end; the same as a 3D polyline. + for (cmd, params) in [ + ("pline", json!({"vertices": [[0, 0], [0, 0], [10, 0], [20, 0]]})), + ("3dpoly", json!({"points": [[0, 0, 0], [0, 0, 0], [10, 0, 0], [20, 0, 0]]})), + ] { + let mut s = Session::new(); + let pl = h(&s.execute(cmd, ¶ms).unwrap()); + s.execute("measure", &json!({"handle": pl, "length": 3, "from": [7, 0]})).unwrap(); + assert!(pts(&s).iter().any(|p| near(*p, 17.0, 0.0)), "{cmd}: {:?}", pts(&s)); + } + // AutoCAD's points. CADCraft measures along a tessellation (1e-4 of the major axis), so its + // points sit within 2e-4 of the axis of AutoCAD's; the other end is 4 to 200 units away. + type Ellipse = ([f64; 2], [f64; 2], f64, f64, f64); + let cases: [((Ellipse, f64, [f64; 2]), &[[f64; 2]]); 2] = [ + // MEASURE-032-TO: a full ellipse picked at t = pi. + ( + (([-35000.0, 81000.0], [1000.0, 250.0], 0.5, 0.0, std::f64::consts::TAU), 325.0, [-36000.0, 80750.0]), + &[ + [-36005.13895764338, 80852.59066530415], + [-35871.99367437639, 80574.74515309861], + [-35846.48143804769, 81129.79467385833], + [-35585.0606965763, 81321.20806711384], + [-35570.69066464184, 80460.16118260568], + [-35288.01208649818, 81451.990340526], + [-35246.80459288685, 80443.34080344986], + [-34973.3365764063, 81531.8855660685], + [-34925.28109250207, 80488.09750605426], + [-34649.89308676404, 81558.94977503068], + [-34615.08169799787, 80583.88008545575], + [-34328.55263503237, 81517.06267451325], + [-34326.49236487653, 80732.20222770158], + [-34085.24055588816, 80947.67206458953], + [-34052.78599900089, 81354.8654746607], + ], + ), + // MEASURE-033: an elliptical arc picked past its middle. + ( + (([0.0, 0.0], [20.0, 5.0], 0.5, 0.5, 4.0), 4.25, [-14.28970951093154, -10.073417468999274]), + &[ + [-20.14815072114992, -3.432193431111516], + [-18.74987859459168, -7.329883069345779], + [-18.68559214389327, 0.5029121733397516], + [-15.81338990685036, 3.617741906558092], + [-15.26656288688172, -9.70206428611582], + [-12.33992351852055, 6.057945492888583], + [-8.547503008323163, 7.9699830580747], + [-4.557798848614094, 9.428419587410612], + [-0.4368018715850841, 10.45983604769949], + [3.769519107506058, 11.05284388252232], + [8.015496424961295, 11.15319778065308], + [12.22912105170455, 10.6383262710487], + [16.23125506912425, 9.247174221779819], + ], + ), + ]; + for (((center, major, ratio, t0, t1), length, from), want) in cases { + let mut s = Session::new(); + let e = h(&s + .execute("ellipse", &json!({"center": center, "major": major, "ratio": ratio, "start": t0.to_degrees(), "end": t1.to_degrees()})) + .unwrap()); + s.execute("measure", &json!({"handle": e, "length": length, "from": from})).unwrap(); + let got = pts(&s); + let tol = 2e-4 * major[0].hypot(major[1]); + assert_eq!(got.len(), want.len(), "{got:?}"); + for w in want { + assert!(got.iter().any(|p| p.dist(Vec2::new(w[0], w[1])) < tol), "no point near {w:?} in {got:?}"); + } + } +} + #[test] fn divide_and_measure_command_line() { let mut s = Session::new(); From 3ccfad60dca364fd9d44c0daf5168b66143263a9 Mon Sep 17 00:00:00 2001 From: Coast Date: Thu, 29 Oct 2026 19:21:27 -0600 Subject: [PATCH 13/49] Block Editor: BEDIT inside it switches to another block, asking to save first (#2219) * Block Editor: BEDIT inside it switches to another block, asking to save first BEDIT (typed, Edit Block, Tools > Block Editor) no longer refuses while the Block Editor is open: the Edit Block Definition dialog opens on the block being edited, and choosing another block switches to it. With changes not saved yet it first asks whether to save them (Yes saves, No discards, Cancel stays), at the command line as BCLOSE does and in the dialog. The JSON form takes `save: true|false` and refuses to switch away from unsaved changes without it; the block to switch to is checked before anything is saved or closed. Co-Authored-By: Claude Opus 5.5 * Block Editor: the save question is one translatable sentence The block name and punctuation were added around a translated fragment, so a translation couldn't place the name or use its own quotation marks. Co-Authored-By: Claude Opus 5.5 * BEDIT: a block the Block Editor can't switch to is refused before the save question --------- Co-authored-by: Cody Vogt <18035288+codyvogt@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/blocks/bedit.rs | 122 +++++++++++++++++++----- crates/engine/tests/block_editor.rs | 129 +++++++++++++++++++++++++- crates/ui-egui/src/bedit.rs | 81 ++++++++++++++-- crates/ui-egui/src/i18n/uk.tsv | 1 + crates/ui-egui/tests/bedit_dialog.rs | 67 ++++++++++++- docs/gaps.md | 5 +- 6 files changed, 370 insertions(+), 35 deletions(-) diff --git a/crates/engine/src/cmd/blocks/bedit.rs b/crates/engine/src/cmd/blocks/bedit.rs index 5b5d0b1cc..c570fa107 100644 --- a/crates/engine/src/cmd/blocks/bedit.rs +++ b/crates/engine/src/cmd/blocks/bedit.rs @@ -2,6 +2,8 @@ //! drawing's own tab, its base point at the origin; the block's objects are edited with the //! ordinary commands; BSAVE saves them into the definition, so every reference to the block in the //! drawing shows the change; BCLOSE goes back to the drawing, saving or discarding what isn't saved. +//! BEDIT while the Block Editor is open switches it to another block: changes not saved yet are +//! saved or discarded first (asked at the command line; `save` in JSON). //! The state is [`crate::blockedit`]. use cadcraft_doc::{Drawing, EntityKind, Handle}; @@ -16,10 +18,9 @@ pub(super) fn specs() -> Vec { CommandSpec::new("bedit", "Block Editor", run_bedit) .menu(&["Tools", "Block Editor"]) .alias(&["be", "-bedit"]) - .params("{name? (\"\": the drawing itself, a dynamic block's own drawing) | handle? (a block reference: edits its block); default the one selected block reference, create?: bool (a name no block has yet starts a new block; BSAVE creates it)} → {block, new}") - .enabled(not_editing) + .params("{name? (\"\": the drawing itself, a dynamic block's own drawing) | handle? (a block reference: edits its block); default the one selected block reference, create?: bool (a name no block has yet starts a new block; BSAVE creates it), save?: bool (in the Block Editor, switching to another block: save (true) or discard (false) the changes not saved yet; required when there are some), check?: bool (in the Block Editor: only check that the block can be switched to)} → {block, new, saved?}") .noundo() - .interactive(|_| Ok(Box::new(BeditM))), + .interactive(|_| Ok(Box::new(BeditM::default()))), CommandSpec::new("bsave", "Save Block", run_bsave).params("{} → {block}").enabled(editing).noundo(), CommandSpec::new("bsaveas", "Save Block As", run_bsaveas) .params("{name, replace?: bool (redefine an existing block of that name)} → {block}") @@ -53,16 +54,6 @@ fn editing_a_block(s: &Session) -> std::result::Result<(), String> { } } -fn not_editing(s: &Session) -> std::result::Result<(), String> { - match s.state() { - Ok(st) => match st.block_editor() { - Some(name) => Err(format!("The Block Editor is already open on \"{name}\"; close it first (BCLOSE).")), - None => Ok(()), - }, - Err(e) => Err(e.to_string()), - } -} - /// Commands that leave model space, which the Block Editor is: not available while it is open. const NOT_IN_EDITOR: &[&str] = &[ "layout", @@ -106,8 +97,53 @@ fn dynamic_definition(d: &Drawing, name: &str) -> Option { (kind == "BLOCK_RECORD").then(|| d.block(block).map(|b| b.name.clone())).flatten() } -/// Open the Block Editor on block `name` and frame its objects. -fn open(s: &mut Session, name: &str, create: bool) -> Result { +/// Whether the open Block Editor can switch to block `name`: the block is there (or `create` makes +/// it) and isn't one the editor refuses. Checked before anything is saved or closed, or asked. +fn check_target(s: &Session, name: &str, create: bool) -> Result<()> { + let host = s.state()?.block_edit.as_ref().map(|b| b.host.doc.clone()).ok_or_else(|| bad("bedit", "the Block Editor is not open"))?; + if name.trim().eq_ignore_ascii_case(crate::blockedit::CURRENT_DRAWING) { + return Ok(()); + } + match host.block(name) { + None if !create => Err(bad("bedit", format!("Block \"{name}\" not found."))), + None => Ok(()), + Some(_) => crate::blockedit::refusal(&host, name).map_or(Ok(()), |why| Err(bad("bedit", why))), + } +} + +/// Open the Block Editor on block `name` and frame its objects. While it is open on another +/// block it switches: the changes not saved yet are saved first with `save` Some(true), +/// discarded with Some(false); with None there must be none. The block to switch to is checked +/// before anything is saved or closed, so a refused switch leaves the editor as it was. +fn open(s: &mut Session, name: &str, create: bool, save: Option) -> Result { + let mut saved = None; + if let Some(current) = s.state()?.block_editor().map(str::to_string) { + if current.eq_ignore_ascii_case(name.trim()) { + s.echo(format!("The Block Editor is already editing \"{current}\".")); + return Ok(json!({ "block": current, "new": false })); + } + check_target(s, name, create)?; + let save = match (s.state()?.block_unsaved(), save) { + (false, _) => false, + (true, Some(save)) => save, + (true, None) => { + return Err(bad( + "bedit", + format!("Block \"{current}\" has changes not saved; pass `save: true` to save them or `save: false` to discard them"), + )); + } + }; + saved = close(s, save)?.get("saved").cloned(); + } + let mut r = open_closed(s, name, create)?; + if let (Some(v), Some(o)) = (saved, r.as_object_mut()) { + o.insert("saved".into(), v); + } + Ok(r) +} + +/// [`open`] with the Block Editor closed. +fn open_closed(s: &mut Session, name: &str, create: bool) -> Result { let new = create && !name.eq_ignore_ascii_case(crate::blockedit::CURRENT_DRAWING) && s.doc()?.block(name).is_none(); s.state_mut()?.open_block_editor(name, create)?; let name = s.state()?.block_editor().unwrap_or(name).to_string(); @@ -153,7 +189,15 @@ fn run_bedit(s: &mut Session, p: &Value) -> Result { if create && !current && s.doc()?.block(name).is_none() && !super::valid_block_name(name) { return Err(bad("bedit", format!("\"{name}\" is not a valid block name"))); } - open(s, name, create) + if p.get("save").is_some_and(|v| !v.is_null() && !v.is_boolean()) { + return Err(bad("bedit", "`save` must be true or false")); + } + // Only whether the Block Editor, when open, can switch to the block: nothing opens or closes. + if bool_or(p, "check", false) && s.state()?.block_editor().is_some() { + check_target(s, name, create)?; + return Ok(json!({ "block": name, "checked": true })); + } + open(s, name, create, p.get("save").and_then(Value::as_bool)) } fn run_bsave(s: &mut Session, _p: &Value) -> Result { @@ -206,7 +250,27 @@ fn run_bclose(s: &mut Session, p: &Value) -> Result { // ---------------- interactive ---------------- /// BEDIT: the selected block reference's block, else a block name typed or a reference picked. -struct BeditM; +/// In the Block Editor with changes not saved yet, it asks whether to save them before switching. +#[derive(Default)] +struct BeditM { + /// The block to switch to, waiting for the answer to "Save changes?". + pending: Option, +} + +impl BeditM { + /// Go to block `name`: at once, or after asking about the changes not saved yet. + fn go(&mut self, s: &mut Session, name: &str) -> Result { + let st = s.state()?; + let other = st.block_editor().is_some_and(|b| !b.eq_ignore_ascii_case(name.trim())); + if other && st.block_unsaved() { + // A block it can't switch to is refused before the question, which would trap the user. + check_target(s, name.trim(), false)?; + self.pending = Some(name.trim().to_string()); + return Ok(Step::Continue); + } + open(s, name, false, Some(false)).map(|_| Step::Done) + } +} impl Interactive for BeditM { fn name(&self) -> &'static str { @@ -214,14 +278,30 @@ impl Interactive for BeditM { } fn begin(&mut self, s: &mut Session) -> Result { match selected_reference(s) { - Some(name) => open(s, &name, false).map(|_| Step::Done), + Some(name) => self.go(s, &name), None => Ok(Step::Continue), } } - fn prompt(&self, _s: &Session) -> Prompt { + fn prompt(&self, s: &Session) -> Prompt { + if self.pending.is_some() { + let name = s.state().ok().and_then(|st| st.block_editor().map(str::to_string)).unwrap_or_default(); + return Prompt::new(format!("Save changes to block \"{name}\"?"), KW).kw(&["Yes", "No"]).default("Y"); + } Prompt::new("Enter block name or select a block reference [?]", Accept { point: true, number: false, text: true, select: true, enter: true }) } fn input(&mut self, s: &mut Session, i: Input) -> Result { + if let Some(name) = self.pending.clone() { + let answer = match i { + Input::Enter => "Y".to_string(), + Input::Keyword(k) | Input::Text(k) => k, + _ => return Ok(Step::Continue), + }; + return match answer.trim().chars().next().map(|c| c.to_ascii_uppercase()) { + Some('Y') => open(s, &name, false, Some(true)).map(|_| Step::Done), + Some('N') => open(s, &name, false, Some(false)).map(|_| Step::Done), + _ => Err(EngineError::Other("Enter Yes or No.".into())), + }; + } match i { Input::Text(t) if t.trim() == "?" => { let names: Vec = { @@ -231,14 +311,14 @@ impl Interactive for BeditM { s.echo(if names.is_empty() { "No blocks to edit.".to_string() } else { names.join(", ") }); Ok(Step::Continue) } - Input::Text(t) | Input::Keyword(t) => open(s, t.trim(), false).map(|_| Step::Done), + Input::Text(t) | Input::Keyword(t) => self.go(s, t.trim()), Input::Pick(hs) => { let name = { let d = s.doc()?; hs.iter().find_map(|h| block_of(d, *h)) }; match name { - Some(n) => open(s, &n, false).map(|_| Step::Done), + Some(n) => self.go(s, &n), None => Err(EngineError::Other("Select a block reference.".into())), } } diff --git a/crates/engine/tests/block_editor.rs b/crates/engine/tests/block_editor.rs index 711bcd796..4eb8a2a2f 100644 --- a/crates/engine/tests/block_editor.rs +++ b/crates/engine/tests/block_editor.rs @@ -140,7 +140,8 @@ fn what_the_block_editor_refuses() { assert!(s.execute("bclose", &json!({})).is_err(), "not open"); s.execute("bedit", &json!({ "name": "Door" })).unwrap(); - assert!(s.execute("bedit", &json!({ "name": "Door" })).is_err(), "already open"); + s.execute("bedit", &json!({ "name": "DOOR" })).unwrap(); + assert_eq!(editor(&s).as_deref(), Some("Door"), "the block already open stays open"); let r = s.execute("layout.set", &json!({ "name": "Layout1" })); assert!(r.is_err_and(|e| e.to_string().contains("Block Editor"))); assert_eq!(s.layout_space(), cadcraft_engine::doc::Space::Model); @@ -370,3 +371,129 @@ fn the_current_drawing_opens_in_the_block_editor() { s.undo().unwrap(); assert_eq!(s.doc().unwrap().model.len(), 1); } + +/// BEDIT in the Block Editor switches to another block, as AutoCAD's does: changes not saved yet +/// are saved or discarded first (`save`), and a block it can't open leaves the editor as it was. +#[test] +fn bedit_in_the_block_editor_switches_blocks() { + let mut s = Session::new(); + door(&mut s); + let l = line(&mut s, [0.0, 50.0], [5.0, 50.0]); + s.execute("block", &json!({ "name": "Frame", "base": [0, 50], "handles": [l] })).unwrap(); + let model = s.doc().unwrap().model.len(); + + s.execute("bedit", &json!({ "name": "Door" })).unwrap(); + line(&mut s, [0.0, 0.0], [0.0, 3.0]); + // Changes not saved: JSON must say what to do with them. + let e = s.execute("bedit", &json!({ "name": "Frame" })).unwrap_err().to_string(); + assert!(e.contains("save"), "{e}"); + assert_eq!(editor(&s).as_deref(), Some("Door")); + assert!(s.state().unwrap().block_unsaved(), "nothing was lost"); + // A block that isn't there, or `save` that isn't a bool: refused, nothing changes. + assert!(s.execute("bedit", &json!({ "name": "Nope", "save": true })).is_err()); + assert!(s.execute("bedit", &json!({ "name": "Frame", "save": "yes" })).is_err()); + assert_eq!(editor(&s).as_deref(), Some("Door")); + assert!(s.state().unwrap().block_unsaved()); + + // Saved, then switched. + let r = s.execute("bedit", &json!({ "name": "frame", "save": true })).unwrap(); + assert_eq!((r["block"].as_str(), r["saved"].as_bool()), (Some("Frame"), Some(true))); + assert_eq!(editor(&s).as_deref(), Some("Frame")); + assert_eq!(lines_of(&s, "Door").len(), 2, "Door keeps the new line"); + + // Discarded, then switched; with nothing to save `save` isn't needed. + line(&mut s, [1.0, 1.0], [2.0, 2.0]); + s.execute("bedit", &json!({ "name": "Door", "save": false })).unwrap(); + assert_eq!(lines_of(&s, "Frame").len(), 1, "Frame's change was discarded"); + s.execute("bedit", &json!({ "name": "Frame" })).unwrap(); + assert_eq!(editor(&s).as_deref(), Some("Frame")); + // A new block, and the drawing itself. + s.execute("bedit", &json!({ "name": "Gate", "create": true })).unwrap(); + assert_eq!(editor(&s).as_deref(), Some("Gate")); + s.execute("bedit", &json!({ "name": "" })).unwrap(); + s.execute("bclose", &json!({ "save": false })).unwrap(); + assert!(editor(&s).is_none()); + assert_eq!(s.doc().unwrap().model.len(), model, "the drawing as it was"); +} + +/// A block BEDIT can't switch to is refused before it asks about the changes not saved, so the +/// question never traps the user; `check` asks the same of JSON callers. +#[test] +fn bedit_refuses_a_bad_target_before_asking_to_save() { + let mut s = Session::new(); + door(&mut s); + s.execute("bedit", &json!({ "name": "Door" })).unwrap(); + line(&mut s, [1.0, 1.0], [2.0, 2.0]); + assert!(s.state().unwrap().block_unsaved()); + s.script( + "BEDIT +Nope +", + ) + .unwrap(); + let message = s.current_prompt().map(|p| p.message).unwrap_or_default(); + assert!(!message.contains("Save changes"), "no question for a block it can't open: {message}"); + s.input(cadcraft_engine::Input::Cancel).unwrap(); + assert_eq!(editor(&s).as_deref(), Some("Door")); + assert!(s.state().unwrap().block_unsaved(), "nothing lost"); + // The check, without switching or saving. + assert!(s.execute("bedit", &json!({ "name": "Nope", "check": true })).is_err()); + assert!(s.execute("bedit", &json!({ "name": "Nope", "create": true, "check": true })).is_ok(), "a new name is fine"); + assert_eq!(editor(&s).as_deref(), Some("Door")); + assert!(s.state().unwrap().block_unsaved()); +} + +/// Typed, BEDIT in the Block Editor asks whether to save the changes before it switches. +#[test] +fn bedit_typed_in_the_block_editor_asks_to_save_first() { + let mut s = Session::new(); + door(&mut s); + let l = line(&mut s, [0.0, 50.0], [5.0, 50.0]); + s.execute("block", &json!({ "name": "Frame", "base": [0, 50], "handles": [l] })).unwrap(); + s.execute("bedit", &json!({ "name": "Door" })).unwrap(); + + // Nothing changed: it switches at once. + s.script( + "BEDIT +Frame +", + ) + .unwrap(); + assert!(s.running.is_none()); + assert_eq!(editor(&s).as_deref(), Some("Frame")); + + line(&mut s, [1.0, 1.0], [2.0, 2.0]); + s.script( + "BEDIT +Door +", + ) + .unwrap(); + assert_eq!(s.current_prompt().unwrap().message, "Save changes to block \"Frame\"?"); + // Escape keeps the editor on Frame with its change. + s.input(cadcraft_engine::Input::Cancel).unwrap(); + assert_eq!(editor(&s).as_deref(), Some("Frame")); + assert!(s.state().unwrap().block_unsaved()); + + s.script( + "BEDIT +Door +Y +", + ) + .unwrap(); + assert!(s.running.is_none()); + assert_eq!(editor(&s).as_deref(), Some("Door")); + assert_eq!(lines_of(&s, "Frame").len(), 2, "saved before switching"); + + line(&mut s, [3.0, 3.0], [4.0, 4.0]); + s.script( + "BEDIT +Frame +N +", + ) + .unwrap(); + assert_eq!(editor(&s).as_deref(), Some("Frame")); + assert_eq!(lines_of(&s, "Door").len(), 1, "discarded"); +} diff --git a/crates/ui-egui/src/bedit.rs b/crates/ui-egui/src/bedit.rs index 6137d5ccc..fa51656ac 100644 --- a/crates/ui-egui/src/bedit.rs +++ b/crates/ui-egui/src/bedit.rs @@ -1,7 +1,9 @@ //! The Edit Block Definition dialog: BEDIT typed or started from a menu or the Tool Sets with no //! block reference selected. It lists the drawing's blocks with a preview and description; a name //! no block has yet starts a new block. OK runs BEDIT with that name; the dialog itself never -//! changes the drawing. JSON calls (`bedit {name}`) and a selected block reference skip it. +//! changes the drawing. In the Block Editor it switches to the block chosen, first asking whether +//! to save the changes not saved yet. JSON calls (`bedit {name}`) and a selected block reference +//! skip it. use std::sync::Arc; @@ -24,6 +26,8 @@ pub struct State { pub name: String, /// Why the last OK failed, shown until the name changes. pub error: Option, + /// OK in the Block Editor with changes not saved: asking whether to save them first. + pub ask_save: bool, /// The preview of the block named, for (drawing uid, revision, block name). preview: Option<((u64, u64, String), Arc)>, } @@ -86,22 +90,19 @@ pub fn authoring_dialog(app: &mut CadApp, ctx: &egui::Context, open: &mut bool) } /// BEDIT typed or from a menu without parameters opens the dialog, unless exactly one block -/// reference is selected (it opens at once) or the Block Editor is open (BEDIT says why not). +/// reference is selected (it opens at once). In the Block Editor it starts on the block edited. pub fn route(app: &mut CadApp, id: &str, params: &Value) -> Option> { if !matches!(id, "bedit" | "be") || !params.is_null() { return None; } let st = app.session.state().ok()?; - if st.block_edit.is_some() { - return None; - } let refs = st.selection.iter().filter(|h| st.doc.entity(**h).is_some_and(|e| matches!(e.kind, EntityKind::Insert(_)))).count(); if refs == 1 && st.selection.len() == 1 { return None; } // Start on the block last edited if it is still there, else the first one. let names = editable_blocks(&st.doc); - let last = app.bedit.name.clone(); + let last = st.block_editor().map(str::to_string).unwrap_or_else(|| app.bedit.name.clone()); let name = if names.iter().any(|n| n.eq_ignore_ascii_case(&last)) { last } else { names.first().cloned().unwrap_or_default() }; app.bedit = State { name, ..State::default() }; app.ui.dialog = Some("bedit".into()); @@ -164,6 +165,10 @@ pub fn dialog(app: &mut CadApp, ctx: &egui::Context, open: &mut bool) { let list = existing.as_deref().and_then(|n| preview(app, n)); let description = existing.as_deref().and_then(|n| d.block(n)).map(|b| b.description.clone()).unwrap_or_default(); let (mut ok, mut cancel) = (false, false); + if app.bedit.ask_save { + save_question(app, ctx, open); + return; + } egui::Window::new(crate::tl!("Edit Block Definition")) .id(egui::Id::unique("Edit Block Definition")) .open(open) @@ -236,14 +241,72 @@ pub fn dialog(app: &mut CadApp, ctx: &egui::Context, open: &mut bool) { } } -/// OK: open the Block Editor on the name given (a new name starts a new block). Returns whether -/// it opened; if not, the dialog shows why and stays open. +/// In the Block Editor with changes not saved: whether to save them before switching to the +/// block chosen. Yes saves, No discards, Cancel goes back to the list. +fn save_question(app: &mut CadApp, ctx: &egui::Context, open: &mut bool) { + let current = app.session.state().ok().and_then(|st| st.block_editor().map(str::to_string)).unwrap_or_default(); + let mut answer: Option> = None; + egui::Window::new(crate::tl!("Edit Block Definition")) + .id(egui::Id::unique("Edit Block Definition")) + .collapsible(false) + .resizable(false) + .pivot(egui::Align2::CENTER_CENTER) + .default_pos(ctx.content_rect().center()) + .show(ctx, |ui| { + ui.set_max_width(420.0); + ui.label(crate::tf!("Save changes to block \"{name}\"?", name = current)); + ui.add_space(8.0); + ui.horizontal(|ui| { + if ui.button(crate::tl!("Yes")).clicked() { + answer = Some(Some(true)); + } + if ui.button(crate::tl!("No")).clicked() { + answer = Some(Some(false)); + } + if ui.button(crate::tl!("Cancel")).clicked() { + answer = Some(None); + } + }); + }); + let Some(answer) = answer else { return }; + app.bedit.ask_save = false; + if let Some(save) = answer + && run(app, Some(save)) + { + *open = false; + } +} + +/// OK: open the Block Editor on the name given (a new name starts a new block). In the Block +/// Editor with changes not saved, it asks first whether to save them. Returns whether it opened; +/// if not, the dialog shows why (or asks) and stays open. pub fn confirm(app: &mut CadApp) -> bool { let name = app.bedit.name.trim().to_string(); if name.is_empty() { return false; } - match app.run("bedit", json!({ "name": name, "create": true })) { + let ask = app.session.state().is_ok_and(|st| st.block_unsaved() && st.block_editor().is_some_and(|b| !b.eq_ignore_ascii_case(&name))); + if ask { + // A block it can't switch to is refused before the question, which would trap the user. + if let Err(e) = app.run("bedit", json!({ "name": name, "create": true, "check": true })) { + app.bedit.error = Some(e); + return false; + } + app.bedit.ask_save = true; + return false; + } + run(app, None) +} + +/// Run BEDIT on the name given, saving (`Some(true)`) or discarding (`Some(false)`) the Block +/// Editor's changes not saved yet. Returns whether it went through; if not, the dialog shows why. +fn run(app: &mut CadApp, save: Option) -> bool { + let name = app.bedit.name.trim().to_string(); + let mut p = json!({ "name": name, "create": true }); + if let (Some(save), Some(o)) = (save, p.as_object_mut()) { + o.insert("save".into(), json!(save)); + } + match app.run("bedit", p) { Ok(_) => true, Err(e) => { app.bedit.error = Some(e); diff --git a/crates/ui-egui/src/i18n/uk.tsv b/crates/ui-egui/src/i18n/uk.tsv index d71b3ccd7..3f2de02df 100644 --- a/crates/ui-egui/src/i18n/uk.tsv +++ b/crates/ui-egui/src/i18n/uk.tsv @@ -1373,3 +1373,4 @@ Check for Updates… Перевірити оновлення… CADCraft is up to date. Встановлено найновішу версію CADCraft. Could not check for updates. Не вдалося перевірити оновлення. + Save changes to block "{name}"? Зберегти зміни в блоці «{name}»? diff --git a/crates/ui-egui/tests/bedit_dialog.rs b/crates/ui-egui/tests/bedit_dialog.rs index 95fdb4adc..21cd32155 100644 --- a/crates/ui-egui/tests/bedit_dialog.rs +++ b/crates/ui-egui/tests/bedit_dialog.rs @@ -95,9 +95,10 @@ fn a_selected_reference_and_json_calls_skip_the_dialog() { app.start("bedit"); assert!(app.ui.dialog.is_none()); assert_eq!(app.session.state().unwrap().block_editor(), Some("Window")); - // In the editor BEDIT says why it can't run instead of opening the dialog. + // In the editor BEDIT opens the dialog, to switch to another block. app.start("bedit"); - assert!(app.ui.dialog.is_none()); + assert_eq!(app.ui.dialog.as_deref(), Some("bedit")); + app.ui.dialog = None; app.run("bclose", json!({})).unwrap(); app.run("bedit", json!({ "name": "door" })).unwrap(); @@ -175,3 +176,65 @@ fn opening_a_drawing_with_authoring_elements_offers_the_block_editor() { assert!(app.ui.dialog.is_none()); let _ = std::fs::remove_dir_all(&dir); } + +/// A name the Block Editor can't switch to is refused before the dialog asks about the changes not +/// saved, so the question never traps the user. +#[test] +fn a_bad_name_is_refused_before_the_dialog_asks_to_save() { + let mut app = app_with_blocks(); + app.run("bedit", json!({ "name": "door" })).unwrap(); + app.run("line", json!({ "points": [[0, 0], [0, 4]] })).unwrap(); + app.start("bedit"); + app.bedit.name = "*U1".into(); + assert!(!bedit::confirm(&mut app)); + assert!(!app.bedit.ask_save, "no question"); + assert!(app.bedit.error.is_some(), "the dialog says why"); + assert!(app.session.state().unwrap().block_unsaved(), "nothing lost"); +} + +/// In the Block Editor, BEDIT opens the dialog on the block being edited; OK on another block +/// switches to it, first asking whether to save the changes not saved yet (Cancel goes back). +#[test] +fn in_the_block_editor_the_dialog_switches_blocks_asking_to_save_first() { + use egui_kittest::Harness; + use egui_kittest::kittest::Queryable; + + let mut app = app_with_blocks(); + app.run("bedit", json!({ "name": "door" })).unwrap(); + app.start("bedit"); + assert_eq!((app.ui.dialog.as_deref(), app.bedit.name.as_str()), (Some("bedit"), "door"), "starts on the block edited"); + // Nothing changed: OK switches at once. + app.bedit.name = "Window".into(); + assert!(bedit::confirm(&mut app)); + assert_eq!(app.session.state().unwrap().block_editor(), Some("Window")); + + app.run("line", json!({ "points": [[0, 0], [0, 4]] })).unwrap(); + app.start("bedit"); + app.bedit.name = "door".into(); + assert!(!bedit::confirm(&mut app), "asks first"); + assert!(app.bedit.ask_save); + let mut h = Harness::builder().with_size(egui::vec2(1600.0, 1000.0)).build_ui_state( + |ui, app: &mut CadApp| { + app.logic(ui.ctx()); + app.ui(ui); + }, + app, + ); + h.run_steps(2); + assert!(h.query_by_label_contains("Save changes to block \"Window\"").is_some()); + h.get_by_label("Cancel").click(); + h.run_steps(2); + assert!(!h.state().bedit.ask_save, "back to the list"); + assert_eq!(h.state().session.state().unwrap().block_editor(), Some("Window")); + assert!(h.state().session.state().unwrap().block_unsaved(), "nothing lost"); + + assert!(!bedit::confirm(h.state_mut())); + h.run_steps(2); + h.get_by_label("Yes").click(); + h.run_steps(2); + let st = h.state().session.state().unwrap(); + assert_eq!(st.block_editor(), Some("door")); + assert!(h.state().ui.dialog.is_none(), "the dialog closed"); + let window = h.state().session.doc().unwrap().block("Window").map(|b| b.entities.len()); + assert_eq!(window, Some(2), "Window saved with its new line before switching"); +} diff --git a/docs/gaps.md b/docs/gaps.md index 9c0bf3630..b270525d6 100644 --- a/docs/gaps.md +++ b/docs/gaps.md @@ -1,6 +1,6 @@ # Where CADCraft falls short of AutoCAD -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-25 · **Change:** minor (Named Viewports dialog: U11 narrowed; MVIEW Restore and PURGE of multiline styles had landed: F15 and F21 corrected) · **Target:** Autodesk AutoCAD 2027 +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-28 · **Change:** minor (BEDIT in the Block Editor switches blocks: F3 updated) · **Target:** Autodesk AutoCAD 2027 Every known shortfall, one row each, ranked within each section by user impact. This is the work list: agents pick from here (top of a section first), and remove or update a row in the same PR @@ -26,7 +26,7 @@ do them first. |---|---|---|---|---| | F1 | **[alpha blocker]** Prompt options that still print "not available yet": -ATTEDIT one-at-a-time Position, Height, Angle and Style, colour books in -ATTEDIT Color, -RENAME of materials, plot styles and viewport configurations. SPLINEDIT Join, Edit vertex Add and Elevate order (#559), PEDIT Edit vertex and the other SPLINEDIT options (#558) done: Edit vertex Tangent directions last for the PEDIT session only (LWPOLYLINE stores none). MTEXT Dynamic/Static columns done (#547). SPLINE, MTEXT and MLEADER options done (#408): SPLINE Object fits the polyline's vertices (no spline frame is kept) (STRETCH polygon, CP and WP, and fence selection done; TRIM/EXTEND, PLINE arc mode and Length, XLINE done (#397); OFFSET, ROTATE and FILLET options done earlier) | `cmd/blocks/attedit.rs`, `cmd/props/rename.rs` | Low: the most-used commands are done | 1–3 | | F2 | XREF editing in place and clipping: XCLIP is missing. REFEDIT, REFSET and REFCLOSE edit a block reference in place (working set, faded rest of the block, everything else locked, save or discard; #813); left: editing an xref in place (its source drawing is not written back; XOPEN opens it), picking nested references, a dimmed look for the locked drawing and a banner with Save and Discard, attribute sync of other references (ATTSYNC). XATTACH, the External References palette, -XREF (Bind/Detach/Path/Unload/Reload/Overlay), XBIND, XOPEN, overlays, relative paths and loading at open are done (#525). Unloaded state and xref-layer overrides last only for the session | `cmd/blocks/xref.rs` | Medium: xrefs can't be edited in place or clipped | 15–25 | -| F3 | **[alpha blocker]** (dynamic-block authoring is beta) No dynamic-block authoring: parameters and actions can't be added in the Block Editor. Dynamic blocks from other files are read and their references edited (visibility, distances, stretch and move, lookups, grips). BEDIT (with the Edit Block Definition dialog, which also starts new blocks), BSAVE, BSAVEAS and BCLOSE edit a static block definition, and every reference updates; REFEDIT edits a reference in place; no authoring palettes yet | issue #185 offers help | High: standard libraries are dynamic | 40–65 | +| F3 | **[alpha blocker]** (dynamic-block authoring is beta) No dynamic-block authoring: parameters and actions can't be added in the Block Editor. Dynamic blocks from other files are read and their references edited (visibility, distances, stretch and move, lookups, grips). BEDIT (with the Edit Block Definition dialog, which also starts new blocks and, in the Block Editor, switches to another block after asking to save), BSAVE, BSAVEAS and BCLOSE edit a static block definition, and every reference updates; REFEDIT edits a reference in place; no authoring palettes yet | issue #185 offers help | High: standard libraries are dynamic | 40–65 | | F4 | Autosave leftovers: no autosave in the web build (browser storage); autosave files are DXF, not DWG; no separate RECOVER mode in the file readers (SAVETIME, Drawing Recovery, AUDIT and RECOVER landed with #406; AUDITCTL `.adt` log landed) | `engine/src/autosave.rs`, `engine/src/audit.rs` | Low-medium (web users) | 2–4 | | F5 | Associative arrays (ASsociative, Levels, polar ROWs, ARRAYEDIT, ARRAYCLOSE) landed (#448); left: grip editing of arrays (count/spacing grips), ARRAYPATH is not associative, ARRAYEDIT has no item deletion (CTRL+click) and no Key point base points, levels only shift Z (no 3D view) | `cmd/array.rs`, `cmd/array/edit.rs` | Medium | 4–6 | | F7 | Dimensions: no DIMSTYLE manager dialog; no smart DIM; DIMALTTD/DIMALTTZ, DIMUPT and DIMTXTDIRECTION not modelled; jog height and break size not style settings; DIMBREAK breaks don't follow moved objects; with DIMTFILL 1 the written `*D` block and EXPLODE keep no background mask (a WIPEOUT over the text box would), and a true-color DIMTFILLCLR is written to DXF as the nearest ACI (style variables, DIMJOGGED, DIMJOGLINE, DIMBREAK, DIMEDIT, DIMINSPECT and QDIM modes done, #507; the DIMTFILL/DIMTFILLCLR text background done) | `doc/src/tables.rs`, `cmd/annotate_dimedit.rs`, `cmd/annotate_qdim.rs` | Medium | 10–15 | @@ -152,6 +152,7 @@ Detail: [localization-parity.md](localization-parity.md). |---|---|---| | 2026-10-25 | minor | Named Viewports (View ▸ Viewports ▸ Named Viewports..., `vports.named`) lists the saved viewport configurations with a preview and the current one's name, and restores or deletes one; in a layout Restore places it as MVIEW Restore does: U11 narrowed. F15 and U11 no longer list MVIEW Restore (#633), and F21 no longer says PURGE skips multiline styles | | 2026-10-25 | minor | DIMTFILL limits: with DIMTFILL 1 (the drawing's background color) the written `*D` block and EXPLODE keep no background mask (a WIPEOUT over the text box would), and a true-color DIMTFILLCLR is written to DXF as the nearest ACI: F7 updated | +| 2026-10-26 | minor | BEDIT in the Block Editor (typed, Edit Block, or the Edit Block Definition dialog) switches to another block as AutoCAD's does, asking whether to save the changes not saved yet; the JSON form takes `save`: F3 evidence | | 2026-10-24 | minor | COMPAREEXPORT (typed, or Export on the comparison bar) opens the comparison as a new untitled drawing, `compare_ vs .dwg`: this drawing's objects in one group and the other drawing's differing objects in a second group, in the comparison colors (green, red, gray for objects in both), block contents and style colors included: F22 narrowed | | 2026-10-24 | minor | DIMTFILL and DIMTFILLCLR: a dimension's text background (none, the drawing's background color, or a color) hides what is drawn under the text; SETVAR, DIMOVERRIDE and style fields, DIMSTYLE groups 69 and 70 in DXF from R2007 (CADCraft xdata before), and a SOLID in the `*D` block and from EXPLODE for DIMTFILL 2: F7 narrowed | | 2026-10-22 | minor | APPLOAD typed or from Tools ▸ Load Application opens a `.lsp` file browser starting in the last-used folder (kept in the preferences); a picked file loads interactively like a typed name (routines that ask for input wait), the web says to drop the file (no file system), and the JSON form `{path}` reads the path as given and returns the commands the file defined, never opening a dialog (#1820): E1 narrowed | From 58687dda2dc904ce0c1572a1d0b58a7ee2dffc01 Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:21:31 +0100 Subject: [PATCH 14/49] Reject out-of-range numeric colours in properties.set (#2286) Found while testing crates/engine/src/cmd/props.rs:155-157 (parse_color), with crates/color/src/lib.rs:60-66 (Color::from_aci) Co-authored-by: Claude Haiku 5.5 --- crates/engine/src/cmd/props.rs | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/crates/engine/src/cmd/props.rs b/crates/engine/src/cmd/props.rs index 617d29756..dfe69fd8f 100644 --- a/crates/engine/src/cmd/props.rs +++ b/crates/engine/src/cmd/props.rs @@ -153,7 +153,9 @@ fn run_get(s: &mut Session, p: &Value) -> Result { } fn parse_color(v: &Value) -> Option { - v.as_str().and_then(Color::parse).or_else(|| v.as_i64().and_then(|i| i16::try_from(i).ok()).map(Color::from_aci)) + v.as_str() + .and_then(Color::parse) + .or_else(|| v.as_i64().filter(|i| (0..=256).contains(i)).and_then(|i| i16::try_from(i).ok()).map(Color::from_aci)) } /// A transparency as JSON, in the form `properties.set` takes: "ByLayer", "ByBlock" or a percentage. @@ -1221,6 +1223,24 @@ mod tests { use super::*; use serde_json::json; + #[test] + fn properties_set_rejects_out_of_range_colour() { + let mut s = Session::new(); + s.execute("line", &json!({ "points": [[0, 0], [50, 0]] })).unwrap(); + let h = s.doc().unwrap().model.last().unwrap().handle.hex(); + s.execute("properties.set", &json!({ "handles": [h], "color": 1 })).unwrap(); + let col = |s: &Session| s.doc().unwrap().model.last().unwrap().common.color; + for bad in [300, -5, 257] { + let e = s.execute("properties.set", &json!({ "handles": [h], "color": bad })).unwrap_err(); + assert!(e.to_string().contains("bad colour"), "{e}"); + assert_eq!(col(&s), Color::Index(1)); + } + s.execute("properties.set", &json!({ "handles": [h], "color": 256 })).unwrap(); + assert_eq!(col(&s), Color::ByLayer); + s.execute("properties.set", &json!({ "handles": [h], "color": 0 })).unwrap(); + assert_eq!(col(&s), Color::ByBlock); + } + #[test] fn properties_set_rejects_unloaded_linetype() { let mut s = Session::new(); From 31dba6e7a77d94b218e0e3c63e605adbd2f18df8 Mon Sep 17 00:00:00 2001 From: Ayoze Torres <53948812+ayozetr@users.noreply.github.com> Date: Fri, 30 Oct 2026 01:21:35 +0000 Subject: [PATCH 15/49] Command line: a LISP value at a prompt is the answer, not another expression (#1920) (#2338) An expression typed at a command's prompt is evaluated, and its value answers the prompt. That value went back through typed(), which treated it as typed text and evaluated it again when it looked like LISP. So `circle (setq q "!q")` returned "!q", which evaluated to "!q" again, forever, until the native stack overflowed and the process aborted (a stack overflow is not a panic, so the catch_unwind guards cannot help), losing unsaved work in every open drawing. It is reachable from the command line, .scr scripts, the control channel and MCP. The value now goes back with LISP evaluation off: a string that looks like an expression is taken as text, as AutoCAD does. --- crates/engine/src/lisp/tests.rs | 25 +++++++++++++++++++++++++ crates/engine/src/session/cmdline.rs | 15 +++++++++++---- 2 files changed, 36 insertions(+), 4 deletions(-) diff --git a/crates/engine/src/lisp/tests.rs b/crates/engine/src/lisp/tests.rs index d65795631..58f421765 100644 --- a/crates/engine/src/lisp/tests.rs +++ b/crates/engine/src/lisp/tests.rs @@ -876,3 +876,28 @@ fn angtof_reads_the_string_in_the_given_units() { assert_eq!(ok(&mut s, "(angtof \"180\" 7)"), "nil"); assert_eq!(ok(&mut s, "(angtof \"180\" \"x\")"), "nil"); } + +/// #1920: the value of an expression typed at a prompt is the answer, not another expression. +/// `(setq q "!q")` returned `"!q"`, which was evaluated again as `!q`, forever, until the stack +/// overflowed and the process aborted (no `catch_unwind` catches that). +#[test] +fn a_lisp_value_at_a_prompt_is_not_evaluated_again() { + let mut s = session(); + s.cmdline("circle (setq q \"!q\")").unwrap(); + assert_eq!(ok(&mut s, "q"), "\"!q\""); + // "!q" is no centre point, so CIRCLE still asks for one; the session carries on. + assert!(s.running.is_some()); + s.cancel(); + // A value that is itself an expression stays text too: `(+ 1 2)` is not evaluated to 3. + s.cmdline("circle 0,0 (setq r \"(+ 1 2)\")").unwrap(); + assert!(s.running.is_some(), "\"(+ 1 2)\" is no radius"); + s.cancel(); + // Values that answer the prompt still do. + s.cmdline("(setq r \"4\")").unwrap(); + s.cmdline("circle 0,0 !r").unwrap(); + let r = s.doc().unwrap().model.iter().find_map(|e| match &e.kind { + cadcraft_doc::EntityKind::Circle(c) => Some(c.radius), + _ => None, + }); + assert_eq!(r, Some(4.0)); +} diff --git a/crates/engine/src/session/cmdline.rs b/crates/engine/src/session/cmdline.rs index 7b9bd53a2..2a1b45836 100644 --- a/crates/engine/src/session/cmdline.rs +++ b/crates/engine/src/session/cmdline.rs @@ -69,6 +69,13 @@ impl Session { /// One token typed while a command runs. pub(crate) fn typed(&mut self, t: &str) -> Result<()> { + self.typed_token(t, true) + } + + /// One token typed while a command runs; `lisp` evaluates a LISP expression first. The value + /// of that expression is the answer, so it comes back with `lisp` off: re-evaluating it would + /// let `(setq q "!q")` evaluate itself forever and overflow the stack (#1920). + fn typed_token(&mut self, t: &str, lisp: bool) -> Result<()> { let Some(prompt) = self.current_prompt() else { return Ok(()) }; let tt = t.trim(); if tt.is_empty() { @@ -84,7 +91,7 @@ impl Session { } // A LISP expression typed at a command's prompt: its value is the answer. // Not at a free-text prompt: there the text is the answer (CAL takes "(3+4)*2"). - if lisp_expression(tt) && !prompt.accept.text && self.lisp_prompt().is_none() && !self.lisp_groups_undo() { + if lisp && lisp_expression(tt) && !prompt.accept.text && self.lisp_prompt().is_none() && !self.lisp_groups_undo() { let src = tt.strip_prefix('!').unwrap_or(tt).to_string(); let v = match self.lisp_eval(&src, false, true, Vec::new()) { Ok(Some(Ok(v))) => v, @@ -96,9 +103,9 @@ impl Session { }; return match v { lisp::value::Value::Nil => Ok(()), - lisp::value::Value::Int(i) => self.typed(&i.to_string()), - lisp::value::Value::Real(r) => self.typed(&format!("{r}")), - lisp::value::Value::Str(s) => self.typed(&s), + lisp::value::Value::Int(i) => self.typed_token(&i.to_string(), false), + lisp::value::Value::Real(r) => self.typed_token(&format!("{r}"), false), + lisp::value::Value::Str(s) => self.typed_token(&s, false), other => match other.as_point() { Some(p) => self.input(Input::Point(Vec2::new(p[0], p[1]))), None => { From f817ea9a3a14be5ac582fa176f921d6ddf9a02e1 Mon Sep 17 00:00:00 2001 From: heejunB <125256444+heejunB@users.noreply.github.com> Date: Fri, 30 Oct 2026 10:21:38 +0900 Subject: [PATCH 16/49] fix(render): fill font glyphs with the nonzero winding rule (#2189) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit TrueType and OpenType outlines are defined with the nonzero rule, but glyph meshes were tessellated even-odd, so any area covered by two contours came out empty. Arial Unicode (the macOS fallback CADCraft picks for Hangul) builds 진 (U+C9C4) from a component that already contains the final ㄴ plus a second copy of that ㄴ; even-odd cancelled the pair and 진 rendered as 지. Overlapping contours in other fonts lost their overlaps the same way. Tessellate glyph outlines with FillOptions::non_zero(). Outlines placed in drawing coordinates without a TextGlyph (complex-script runs) go through the same tessellator, offset to their first point to keep f32 precision, instead of the even-odd slab filler. --- crates/render/src/lib.rs | 2 +- crates/render/src/text.rs | 79 +++++++++++++++++++++++++++++++++++++-- 2 files changed, 77 insertions(+), 4 deletions(-) diff --git a/crates/render/src/lib.rs b/crates/render/src/lib.rs index 5b9dc83a1..6fa236e4c 100644 --- a/crates/render/src/lib.rs +++ b/crates/render/src/lib.rs @@ -235,7 +235,7 @@ impl Builder<'_> { self.tris_at(ctx, color, &mesh.triangles, xf); mesh.triangles.len() } else { - let tris = fill::triangulate_evenodd(g); + let tris = crate::text::triangulate_placed(g); self.tris(ctx, color, &tris); tris.len() }; diff --git a/crates/render/src/text.rs b/crates/render/src/text.rs index 6595e145f..1f80d7af4 100644 --- a/crates/render/src/text.rs +++ b/crates/render/src/text.rs @@ -163,8 +163,10 @@ fn simplify(contour: &[Vec2], tolerance: f64) -> Vec { if result.len() >= 4 { result } else { contour.to_vec() } } -/// Monotone tessellation with even-odd holes and intersections. Work in font units so f32 -/// precision is independent of drawing coordinates; the placement stays f64. The existing +/// Monotone tessellation with the nonzero winding rule that TrueType and OpenType outlines are +/// defined with: overlapping contours stay filled (Arial Unicode's 진 draws its final ㄴ twice, +/// which even-odd cancelled out) and holes are contours wound the other way. Work in font units +/// so f32 precision is independent of drawing coordinates; the placement stays f64. The existing /// slab filler remains the fallback when tessellation fails (including its u16 vertex limit). fn triangulate(contours: &[Vec]) -> Vec { let mut path = Path::builder(); @@ -179,7 +181,7 @@ fn triangulate(contours: &[Vec]) -> Vec { let mut buffers: VertexBuffers = VertexBuffers::new(); let result = FillTessellator::new().tessellate_path( &path.build(), - &FillOptions::even_odd(), + &FillOptions::non_zero(), &mut BuffersBuilder::new(&mut buffers, |v: FillVertex<'_>| { let p = v.position(); Vec2::new(f64::from(p.x), f64::from(p.y)) @@ -190,3 +192,74 @@ fn triangulate(contours: &[Vec]) -> Vec { } buffers.indices.into_iter().filter_map(|i| buffers.vertices.get(usize::from(i)).copied()).collect() } + +/// [`triangulate`] for a glyph outline already placed in drawing coordinates (complex-script +/// runs carry no [`TextGlyph`]): tessellated relative to its first point so f32 keeps the +/// precision. Outlines past the limits [`mesh`] applies keep the slab filler. +pub(super) fn triangulate_placed(contours: &[Vec]) -> Vec { + let Some(&origin) = contours.iter().flatten().next() else { return Vec::new() }; + let points = contours.iter().map(Vec::len).try_fold(0usize, usize::checked_add); + let out_of_range = |p: &Vec2| { + let d = *p - origin; + !p.is_finite() || d.x.abs().max(d.y.abs()) > 1.0e6 + }; + if !points.is_some_and(|n| n <= MAX_POINTS) || contours.iter().flatten().any(out_of_range) { + return crate::fill::triangulate_evenodd(contours); + } + let local: Vec> = contours.iter().map(|c| c.iter().map(|&p| p - origin).collect()).collect(); + triangulate(&local).into_iter().map(|p| p + origin).collect() +} + +#[cfg(test)] +mod tests { + use super::*; + + fn square(x: f64, y: f64, s: f64) -> Vec { + // Clockwise, as TrueType draws outer contours. + vec![Vec2::new(x, y), Vec2::new(x, y + s), Vec2::new(x + s, y + s), Vec2::new(x + s, y), Vec2::new(x, y)] + } + + fn area(tris: &[Vec2]) -> f64 { + tris.chunks(3) + .filter_map(|t| match t { + [a, b, c] => Some(((*b - *a).x * (*c - *a).y - (*b - *a).y * (*c - *a).x).abs() / 2.0), + _ => None, + }) + .sum() + } + + #[test] + fn duplicated_contour_stays_filled() { + // A composite glyph that draws one component twice (Arial Unicode's 진 and its ㄴ). + let s = square(0.0, 0.0, 10.0); + assert!((area(&triangulate(&[s.clone(), s])) - 100.0).abs() < 1e-6); + } + + #[test] + fn overlapping_contours_fill_their_union() { + let tris = triangulate(&[square(0.0, 0.0, 10.0), square(5.0, 5.0, 10.0)]); + assert!((area(&tris) - 175.0).abs() < 1e-6); + } + + #[test] + fn counter_wound_contour_is_still_a_hole() { + let mut hole = square(4.0, 4.0, 2.0); + hole.reverse(); + assert!((area(&triangulate(&[square(0.0, 0.0, 10.0), hole])) - 96.0).abs() < 1e-6); + } + + #[test] + fn placed_outline_far_from_the_origin_keeps_its_place_and_fill() { + let s = square(5.0e5, -3.0e5, 2.0); + let tris = triangulate_placed(&[s.clone(), s]); + assert!((area(&tris) - 4.0).abs() < 1e-6); + assert!(tris.iter().all(|p| (5.0e5..=5.0e5 + 2.0).contains(&p.x) && (-3.0e5..=-3.0e5 + 2.0).contains(&p.y))); + } + + #[test] + fn hostile_placed_outline_never_panics() { + assert!(triangulate_placed(&[]).is_empty()); + let _ = triangulate_placed(&[vec![Vec2::new(f64::NAN, 0.0), Vec2::X, Vec2::Y]]); + let _ = triangulate_placed(&[vec![Vec2::ZERO, Vec2::new(1.0e300, 0.0), Vec2::Y]]); + } +} From 74e77f8a929e43e5d5bb0af57da34c0cb0bbe777 Mon Sep 17 00:00:00 2001 From: smacdmac101 <152641296+smacdmac101@users.noreply.github.com> Date: Thu, 29 Oct 2026 21:21:42 -0400 Subject: [PATCH 17/49] feat(web): persist validated browser panel layouts (#2258) * xtask: the test suite and clippy pass on Windows Two Windows-only failures stopped `cargo xtask ci` before it got going on a Windows checkout (CI runs the gate on Linux only, so neither showed): - parity::tests::civil_dates built a SystemTime 115,740,740 days after the epoch (year 318857). Windows' SystemTime ends in the year 30828, so the addition panicked ("overflow when adding duration to `SystemTime`"). That case now checks `civil_from_days` on the day count, which is what it was about, on every platform. - stats.rs imported `walk` for a test that only exists on Unix, so the import was unused on Windows and `clippy -D warnings` refused it. The Unix test calls `super::walk`, as its neighbour calls `super::walk_inner`. Checked on Windows 11 x64: `cargo test --workspace` and `cargo clippy --workspace --all-targets -- -D warnings` both pass. Co-Authored-By: Claude Opus 5.5 * feat(web): persist validated browser panel layouts CC-053: keep embedded floating, docked and hidden panels across reloads through the existing host save cycle. Reject malformed/versioned records atomically; native workspaces and drawings remain unchanged. Validation: all seven cargo xtask ci gates passed (2558 pass, 0 fail, 1 ignored) on a2dd814 plus this exact change. Actual release Trunk bundle and Edge floating/close/reload/reset/reload passed. Forced WebGL startup, render and recovered layout passed; full edit cycle used default mode. Dependency: original #2198 Windows test prerequisite. No #2226 dependency. Revert this commit independently to stop using the optional storage key. Upstream c3b8e7b adds nextest minimum configuration only; no runtime overlap. --------- Co-authored-by: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 --- apps/cadcraft-web/src/main.rs | 14 +++- apps/cadcraft-web/src/panel_layout.rs | 104 ++++++++++++++++++++++++++ docs/ui-parity.md | 4 +- packaging/web/README.md | 12 +++ 4 files changed, 132 insertions(+), 2 deletions(-) create mode 100644 apps/cadcraft-web/src/panel_layout.rs diff --git a/apps/cadcraft-web/src/main.rs b/apps/cadcraft-web/src/main.rs index f69e02d8a..a25782d6e 100644 --- a/apps/cadcraft-web/src/main.rs +++ b/apps/cadcraft-web/src/main.rs @@ -14,6 +14,9 @@ pub mod download; #[cfg(target_arch = "wasm32")] mod host; +#[cfg(any(target_arch = "wasm32", test))] +mod panel_layout; + #[cfg(target_arch = "wasm32")] mod web { use cadcraft_engine::Session; @@ -59,10 +62,14 @@ mod web { self.0.raw_input_hook(ctx, raw); cadcraft_ui_egui::cmdline::capture_tab(ctx, raw); } - /// Preferences (interface theme and language) survive reloads; egui state is not kept. + /// Preferences and validated panel placement survive reloads; egui memory is not kept. fn save(&mut self, storage: &mut dyn eframe::Storage) { storage.set_string(cadcraft_ui_egui::options::PROFILE_KEY, self.0.profile_json()); storage.set_string(cadcraft_ui_egui::PREFS_KEY, self.0.prefs_json()); + match crate::panel_layout::save(&self.0.ui) { + Ok(layout) => storage.set_string(crate::panel_layout::KEY, layout), + Err(error) => log::warn!("panel layout was not saved: {error}"), + } } fn persist_egui_memory(&self) -> bool { false @@ -160,6 +167,11 @@ mod web { if let Some(prefs) = cc.storage.and_then(|s| s.get_string(cadcraft_ui_egui::PREFS_KEY)) { app.load_prefs(&prefs); } + if let Some(layout) = cc.storage.and_then(|s| s.get_string(crate::panel_layout::KEY)) + && let Err(error) = crate::panel_layout::restore(&mut app.ui, &layout) + { + log::warn!("panel layout was not restored: {error}"); + } // `?cpu`: no render state for the app, so the canvas draws with egui shapes. if !crate::wants_cpu(&query()) && let Some(rs) = &cc.wgpu_render_state diff --git a/apps/cadcraft-web/src/panel_layout.rs b/apps/cadcraft-web/src/panel_layout.rs new file mode 100644 index 000000000..766879c83 --- /dev/null +++ b/apps/cadcraft-web/src/panel_layout.rs @@ -0,0 +1,104 @@ +//! Browser panel layout storage, independent of drawings and native workspace files. + +use cadcraft_ui_egui::{UiState, docking}; +use serde_json::{Value, json}; + +#[cfg(target_arch = "wasm32")] +pub const KEY: &str = "cadcraft.panel-layout"; +const MAX_BYTES: usize = 64 * 1024; + +/// Serialize only validated panel placement and visibility, with a bounded record size. +pub fn save(ui: &UiState) -> Result { + docking::validate(&ui.docking)?; + let saved = json!({ + "version": docking::LAYOUT_VERSION, + "docking": ui.docking, + "showToolsets": ui.show_toolsets, + "showPalettes": ui.show_palettes, + }) + .to_string(); + if saved.len() > MAX_BYTES { + return Err("panel layout exceeds 64 KiB".into()); + } + Ok(saved) +} + +/// Validate the entire optional record before changing any UI field. +pub fn restore(ui: &mut UiState, saved: &str) -> Result<(), String> { + if saved.len() > MAX_BYTES { + return Err("panel layout exceeds 64 KiB".into()); + } + let value: Value = serde_json::from_str(saved).map_err(|error| error.to_string())?; + if value.get("version").and_then(Value::as_u64) != Some(u64::from(docking::LAYOUT_VERSION)) { + return Err("unsupported panel layout version".into()); + } + let workspace: docking::Workspace = + serde_json::from_value(value.get("docking").cloned().ok_or("missing panel layout")?).map_err(|error| error.to_string())?; + docking::validate(&workspace)?; + let tools = value.get("showToolsets").and_then(Value::as_bool).ok_or("invalid Tool Sets visibility")?; + let palettes = value.get("showPalettes").and_then(Value::as_bool).ok_or("invalid palette visibility")?; + ui.docking = workspace; + ui.show_toolsets = tools; + ui.show_palettes = palettes; + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use cadcraft_engine::Session; + use cadcraft_ui_egui::{CadApp, Services}; + + #[test] + fn floating_and_hidden_panels_survive_storage_without_replacing_drawing_state() { + let mut source = CadApp::new(Session::default(), Services::default()); + source.run("ui.dock", json!({"operation":"float","panel":"toolSets","rect":[120,90,340,410]})).unwrap(); + source.run("ui.dock", json!({"operation":"close","panel":"properties"})).unwrap(); + let saved = save(&source.ui).unwrap(); + let mut destination = CadApp::new(Session::default(), Services::default()); + destination.session.start("line").unwrap(); + let before = destination.session.doc().unwrap().clone(); + restore(&mut destination.ui, &saved).unwrap(); + assert_eq!(destination.ui.docking, source.ui.docking); + assert_eq!(destination.ui.show_toolsets, source.ui.show_toolsets); + assert_eq!(destination.ui.show_palettes, source.ui.show_palettes); + assert_eq!(destination.session.running.as_ref().map(|command| command.id.as_str()), Some("line")); + assert_eq!(destination.session.doc().unwrap(), &before); + } + + #[test] + fn malformed_or_unsupported_storage_is_rejected_atomically() { + let mut ui = UiState::default(); + let before = serde_json::to_value(&ui).unwrap(); + let valid: Value = serde_json::from_str(&save(&ui).unwrap()).unwrap(); + for (field, bad) in [ + ("version", json!(0)), + ("version", json!(docking::LAYOUT_VERSION + 1)), + ("docking", json!({})), + ("showToolsets", json!("false")), + ("showPalettes", Value::Null), + ] { + let mut invalid = valid.clone(); + invalid[field] = bad; + assert!(restore(&mut ui, &invalid.to_string()).is_err()); + assert_eq!(serde_json::to_value(&ui).unwrap(), before); + } + for invalid in ["not json".to_string(), " ".repeat(MAX_BYTES + 1)] { + assert!(restore(&mut ui, &invalid).is_err()); + assert_eq!(serde_json::to_value(&ui).unwrap(), before); + } + } + + #[test] + fn storage_cannot_remove_the_document_view() { + let mut ui = UiState::default(); + let before = serde_json::to_value(&ui).unwrap(); + let mut invalid = ui.clone(); + invalid.docking.layout.root = None; + assert!(save(&invalid).is_err()); + let mut record: Value = serde_json::from_str(&save(&ui).unwrap()).unwrap(); + record["docking"] = serde_json::to_value(&invalid.docking).unwrap(); + assert!(restore(&mut ui, &record.to_string()).is_err()); + assert_eq!(serde_json::to_value(&ui).unwrap(), before); + } +} diff --git a/docs/ui-parity.md b/docs/ui-parity.md index c06e8f242..6bf0c20f8 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -1,6 +1,6 @@ # UI parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-22 · **Change:** minor (distinct polyline midpoint grips) · **Target:** Autodesk AutoCAD 2027 for Mac (26.0) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-26 · **Change:** minor (browser panel layout storage) · **Target:** Autodesk AutoCAD 2027 for Mac (26.0) How CADCraft's interaction compares with AutoCAD's: point entry, object snaps, tracking, dynamic input, grips, selection, the command line, chrome and navigation. A drafter's speed in AutoCAD @@ -166,6 +166,7 @@ down-arrow options menu (DYNPROMPT), and DYNDIM. | ViewCube | interactive 3D | clickable for 2D (Top/Home → extents); dragging does nothing (#7) | | Navigation bar, SteeringWheels | yes | no | | Workspaces | Drafting & Annotation, 3D Modeling | no | +| Browser panel layout storage | not applicable | Versioned, validated panel placement and visibility saved through the browser host; floating palettes remain embedded. Requires available browser storage and a completed host save; named workspaces and drawing persistence are separate. | | Options / Preferences dialog | many tabs | **no** (issue #23) | | Customisation (CUI, aliases editor, tool palettes) | yes | Command Aliases dialog (ALIASEDIT, #1381); no CUI or tool palettes | | Themes | Dark, Light | Dark, Light, System (#179) | @@ -203,6 +204,7 @@ down-arrow options menu (DYNPROMPT), and DYNDIM. | Date | Change | Summary | |---|---|---| +| 2026-10-26 | minor | Browser host stores bounded, validated panel layout separately from drawing state; malformed or unsupported records retain defaults. Native workspace storage is unchanged. | | 2026-10-22 | minor | Polyline segment midpoint grips use rectangles, distinct from square vertex grips, with matching hover and pick bounds (#1950) | | 2026-10-13 | minor | Filled-region highlight boundaries are traversed in deterministic coordinate order, fixing dash-phase jumps on CPU hover/selection redraws and GPU highlight rebuilds; CPU dash-position, pixel and GPU mesh regressions | | 2026-10-14 | minor | Selection cycling (#1143): the list and badge of SELECTIONCYCLING, Shift+Space through overlapping objects (#1145) | diff --git a/packaging/web/README.md b/packaging/web/README.md index 024e00c01..73a74f493 100644 --- a/packaging/web/README.md +++ b/packaging/web/README.md @@ -50,6 +50,18 @@ location /cadcraft/ { Local test: `python3 -m http.server 8765` inside the folder, then open http://localhost:8765/. +## Panel layout storage + +The browser host saves docked, floating and hidden palette arrangements alongside interface +preferences in its local storage. Floating palettes remain embedded in the browser canvas; +they do not become native operating-system windows. Window > Reset Palettes restores the +default arrangement. This record contains panel placement and visibility, not drawing data. + +The optional `cadcraft.panel-layout` record uses the shared docking layout version and is +limited to 64 KiB. Malformed, incompatible or invalid arrangements are ignored atomically, +leaving the startup defaults usable. Storage availability and autosave follow the browser +host's existing eframe persistence; clearing site data removes the saved layout. + ## Embedding in a page (iframe) ```html From 61fefc3ed931fe645432da8fb694409d881009bd Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:21:46 +0100 Subject: [PATCH 18/49] Skip a leading UTF-8 BOM when parsing ASCII DXF (#2287) Found while testing crates/dxf/src/lib.rs:189 and 267-274 (parse_with_limit via decode_ascii_file, then parse_ascii_with_limit) Co-authored-by: Claude Haiku 5.5 --- crates/dxf/src/lib.rs | 2 +- crates/dxf/tests/ascii_bom.rs | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 crates/dxf/tests/ascii_bom.rs diff --git a/crates/dxf/src/lib.rs b/crates/dxf/src/lib.rs index 907c5abf7..4e888bdc0 100644 --- a/crates/dxf/src/lib.rs +++ b/crates/dxf/src/lib.rs @@ -264,7 +264,7 @@ pub fn parse_ascii(text: &str) -> Result> { #[allow(clippy::while_let_loop)] fn parse_ascii_with_limit(text: &str, max_tags: usize) -> Result> { let mut tags = Vec::new(); - let mut lines = text.lines().enumerate(); + let mut lines = text.strip_prefix('\u{feff}').unwrap_or(text).lines().enumerate(); loop { let Some((ln, code_line)) = lines.next() else { break }; let ct = code_line.trim(); diff --git a/crates/dxf/tests/ascii_bom.rs b/crates/dxf/tests/ascii_bom.rs new file mode 100644 index 000000000..e39b9b84c --- /dev/null +++ b/crates/dxf/tests/ascii_bom.rs @@ -0,0 +1,19 @@ +//! A UTF-8 byte order mark at the start of an ASCII DXF is skipped. + +const BODY: &str = " 0\r\nSECTION\r\n 2\r\nENTITIES\r\n 0\r\nENDSEC\r\n 0\r\nEOF\r\n"; + +#[test] +fn utf8_bom_bytes_are_skipped() { + let plain = cadcraft_dxf::parse(BODY.as_bytes()).expect("plain parses"); + let mut bytes = vec![0xEF, 0xBB, 0xBF]; + bytes.extend_from_slice(BODY.as_bytes()); + let with_bom = cadcraft_dxf::parse(&bytes); + assert!(with_bom.is_ok(), "{with_bom:?}"); + assert_eq!(with_bom.map(|t| t.len()).unwrap_or(0), plain.len()); +} + +#[test] +fn bom_text_is_skipped() { + let text = format!("\u{feff}{BODY}"); + assert!(cadcraft_dxf::parse_ascii(&text).is_ok()); +} From 1d6c72db119382214b55e06a84db541b0d71df53 Mon Sep 17 00:00:00 2001 From: Books Date: Fri, 30 Oct 2026 12:21:50 +1100 Subject: [PATCH 19/49] Bound the MCP client's reply read and the control server's total buffered bytes (#1925) (#2398) * Bound the MCP client's reply read and the control server's total buffered bytes (#1925) The MCP client read replies with an unbounded read_line; a process squatting on the control port could make it allocate without limit. It now reads through take() with a 256 MiB cap (the server's own request cap) and fails with a clear error. The control server allowed max_clients x max_line (16 x 256 MiB) buffered at once. Request-line bytes are now charged against a shared 512 MiB budget; a request that would pass it gets an error reply and the connection closes. * Parity checklist: regenerated after merging main * control_server: drop unused Read import (#1925) * control_server: tests import Read themselves (#1925) The unused-import cleanup removed std::io::Read from the module, but a test still calls read_to_end, so the test build failed on CI. --- apps/cadcraft/src/control_server.rs | 171 +++++++++++++++++++++++----- crates/mcp/src/backend.rs | 60 +++++++++- 2 files changed, 196 insertions(+), 35 deletions(-) diff --git a/apps/cadcraft/src/control_server.rs b/apps/cadcraft/src/control_server.rs index 14283e6fd..d502e1408 100644 --- a/apps/cadcraft/src/control_server.rs +++ b/apps/cadcraft/src/control_server.rs @@ -7,7 +7,7 @@ //! ([`Limits`]): simultaneous connections, request line length, queued requests, and how long a //! socket may sit idle or blocked on a write. -use std::io::{BufRead, BufReader, ErrorKind, Read, Write}; +use std::io::{BufRead, BufReader, ErrorKind, Write}; use std::net::{TcpListener, TcpStream}; use std::sync::Arc; use std::sync::atomic::{AtomicUsize, Ordering}; @@ -24,6 +24,9 @@ struct Limits { max_clients: usize, /// Longest request line in bytes (newline excluded); a longer one closes the connection. max_line: usize, + /// Request-line bytes buffered at once across all connections; a request that would pass it + /// is refused with an error reply. + total_bytes: usize, /// Requests waiting for the app at once; more are answered `busy`. queue: usize, /// How long a connection may go without sending a byte before it is closed. @@ -40,6 +43,8 @@ impl Default for Limits { max_clients: 16, // Generous, so requests that carry whole drawings or images as base64 still fit. max_line: 256 * 1024 * 1024, + // Room for one maximal request plus smaller ones, not `max_clients` maximal ones. + total_bytes: 512 * 1024 * 1024, queue: 64, idle_timeout: Duration::from_secs(600), write_timeout: Duration::from_secs(30), @@ -106,6 +111,7 @@ impl Drop for Slot { /// Accept clients within the connection limit and give each worker the same session token. fn accept_loop(listener: TcpListener, tx: SyncSender, ctx: egui::Context, limits: Limits, token: Arc) { let open = Arc::new(AtomicUsize::new(0)); + let budget = Budget::new(limits.total_bytes); for mut stream in accepted(listener.incoming(), || std::thread::sleep(ACCEPT_RETRY)) { let _ = stream.set_write_timeout(Some(limits.write_timeout)); if open.fetch_add(1, Ordering::SeqCst) >= limits.max_clients { @@ -117,39 +123,102 @@ fn accept_loop(listener: TcpListener, tx: SyncSender, ctx: egui: let tx = tx.clone(); let ctx = ctx.clone(); let token = Arc::clone(&token); + let budget = budget.clone(); let _ = std::thread::Builder::new().spawn(move || { let _slot = slot; - serve(stream, &tx, &ctx, limits, &token); + serve(stream, &tx, &ctx, limits, &token, budget); }); } } -/// Read one `\n`-terminated line of at most `max` bytes into `buf` (newline stripped). -/// `Ok(false)` at end of stream; `Err` when the line is too long or the read fails. -fn read_bounded_line(reader: &mut impl BufRead, buf: &mut Vec, max: usize) -> Result { +/// A total-bytes budget for request lines buffered across all connections, so +/// [`Limits::max_clients`] peers can't each hold a [`Limits::max_line`] line at once (#1925). +#[derive(Clone, Debug)] +struct Budget { + used: Arc, + total: usize, +} + +impl Budget { + fn new(total: usize) -> Self { + Self { used: Arc::new(AtomicUsize::new(0)), total } + } + + /// Reserve `n` more bytes, or `false` (nothing reserved) when that would pass the total. + fn reserve(&self, n: usize) -> bool { + self.used.try_update(Ordering::SeqCst, Ordering::SeqCst, |u| u.checked_add(n).filter(|&t| t <= self.total)).is_ok() + } +} + +/// Bytes a connection holds from the [`Budget`] for its current request line; given back when the +/// next line starts or the connection ends. +struct Held { + budget: Budget, + bytes: usize, +} + +impl Held { + fn new(budget: Budget) -> Self { + Self { budget, bytes: 0 } + } + + fn release(&mut self) { + self.budget.used.fetch_sub(self.bytes, Ordering::SeqCst); + self.bytes = 0; + } +} + +impl Drop for Held { + fn drop(&mut self) { + self.release(); + } +} + +/// Read one `\n`-terminated line of at most `max` bytes into `buf` (newline stripped), charging +/// the bytes buffered to `held`. `Ok(false)` at end of stream; `Err` when the line is too long, +/// the shared budget is used up, or the read fails. +fn read_bounded_line(reader: &mut impl BufRead, buf: &mut Vec, max: usize, held: &mut Held) -> Result { buf.clear(); - // `take` bounds the bytes buffered for one line: a peer can't make us allocate more than `max`. - let limit = u64::try_from(max).unwrap_or(u64::MAX).saturating_add(1); - let n = reader.take(limit).read_until(b'\n', buf).map_err(|e| match e.kind() { - // The idle timeout ran out (Windows reports it as TimedOut, Unix as WouldBlock). - ErrorKind::TimedOut | ErrorKind::WouldBlock => "request line not completed in time; closing the connection".to_string(), - _ => e.to_string(), - })?; - if n == 0 { - return Ok(false); - } - if buf.last() == Some(&b'\n') { - buf.pop(); - if buf.last() == Some(&b'\r') { + held.release(); + // A line is at most `max` bytes plus its newline; never buffer more than that. + let cap = max.saturating_add(1); + loop { + let chunk = match reader.fill_buf() { + Ok(c) => c, + Err(e) if e.kind() == ErrorKind::Interrupted => continue, + Err(e) => { + return Err(match e.kind() { + // The idle timeout ran out (Windows reports it as TimedOut, Unix as WouldBlock). + ErrorKind::TimedOut | ErrorKind::WouldBlock => "request line not completed in time; closing the connection".to_string(), + _ => e.to_string(), + }); + } + }; + if chunk.is_empty() { + // End of stream: nothing read, or a last line without a newline. + return Ok(!buf.is_empty()); + } + let line_end = chunk.iter().position(|&b| b == b'\n').map(|i| i + 1); + let n = line_end.unwrap_or(chunk.len()).min(cap.saturating_sub(buf.len())); + buf.extend_from_slice(chunk.get(..n).unwrap_or(chunk)); + reader.consume(n); + // The chunk is already buffered (a few KiB), so it is added before it is charged: a + // refusal still leaves `buf` non-empty and the connection gets an error reply. + if !held.budget.reserve(n) { + return Err("too many large requests in flight; try again later".to_string()); + } + held.bytes += n; + if buf.last() == Some(&b'\n') { buf.pop(); + if buf.last() == Some(&b'\r') { + buf.pop(); + } + return Ok(true); + } + if buf.len() > max { + return Err(format!("request line longer than {max} bytes; closing the connection")); } - return Ok(true); } - if buf.len() > max { - return Err(format!("request line longer than {max} bytes; closing the connection")); - } - // Last line without a newline, then end of stream. - Ok(true) } /// One request line, parsed. @@ -204,7 +273,7 @@ fn is_http_request_line(text: &str) -> bool { /// Serve bounded JSON lines, authenticating each request before enqueueing it for the UI. /// Invalid credentials close the connection; queue and reply limits report whether a request ran. -fn serve(stream: TcpStream, tx: &SyncSender, ctx: &egui::Context, limits: Limits, token: &str) { +fn serve(stream: TcpStream, tx: &SyncSender, ctx: &egui::Context, limits: Limits, token: &str, budget: Budget) { if stream.set_read_timeout(Some(limits.idle_timeout)).is_err() || stream.set_write_timeout(Some(limits.write_timeout)).is_err() { return; } @@ -212,8 +281,9 @@ fn serve(stream: TcpStream, tx: &SyncSender, ctx: &egui::Context let mut out = stream; let mut reader = BufReader::new(read); let mut buf = Vec::new(); + let mut held = Held::new(budget); loop { - let reject = match read_bounded_line(&mut reader, &mut buf, limits.max_line) { + let reject = match read_bounded_line(&mut reader, &mut buf, limits.max_line, &mut held) { Ok(false) => break, // Nothing of a line arrived (idle timeout, or the peer is gone): close without a word. // A line nobody asked for would be read as the reply to the client's next request. @@ -264,6 +334,7 @@ fn serve(stream: TcpStream, tx: &SyncSender, ctx: &egui::Context #[cfg(test)] mod tests { use super::*; + use std::io::Read; /// A failed accept is followed by a wait before the next one, so a listener that keeps /// failing does not spin, and the connections around the failures still come through. @@ -281,13 +352,13 @@ mod tests { fn lines_are_read_up_to_the_limit() { let mut buf = Vec::new(); let mut input: &[u8] = b"aaaaaaaaaa\nbb\r\ncc"; - assert_eq!(read_bounded_line(&mut input, &mut buf, 10), Ok(true)); + assert_eq!(read_bounded_line(&mut input, &mut buf, 10, &mut held()), Ok(true)); assert_eq!(buf, b"aaaaaaaaaa", "a line exactly at the limit is accepted"); - assert_eq!(read_bounded_line(&mut input, &mut buf, 10), Ok(true)); + assert_eq!(read_bounded_line(&mut input, &mut buf, 10, &mut held()), Ok(true)); assert_eq!(buf, b"bb", "CRLF is stripped"); - assert_eq!(read_bounded_line(&mut input, &mut buf, 10), Ok(true)); + assert_eq!(read_bounded_line(&mut input, &mut buf, 10, &mut held()), Ok(true)); assert_eq!(buf, b"cc", "a last line without a newline is still read"); - assert_eq!(read_bounded_line(&mut input, &mut buf, 10), Ok(false), "then end of stream"); + assert_eq!(read_bounded_line(&mut input, &mut buf, 10, &mut held()), Ok(false), "then end of stream"); } #[test] @@ -295,11 +366,15 @@ mod tests { let mut buf = Vec::new(); let long = [b'x'; 100]; let mut input: &[u8] = &long; - assert!(read_bounded_line(&mut input, &mut buf, 10).is_err()); + assert!(read_bounded_line(&mut input, &mut buf, 10, &mut held()).is_err()); assert!(buf.len() <= 11, "at most limit + 1 bytes are buffered, got {}", buf.len()); assert_eq!(input.len(), 100 - 11, "the rest of the line is left unread"); } + fn held() -> Held { + Held::new(Budget::new(usize::MAX)) + } + fn short() -> Limits { Limits { queue: 1, @@ -414,6 +489,40 @@ mod tests { drop(rx); } + /// Connections can't together buffer more request-line bytes than the budget: a second large + /// request is refused with an error reply while the first still holds its bytes (#1925). + #[test] + fn requests_past_the_total_budget_are_refused() { + let (addr, _rx) = serve_with(Limits { max_line: 1000, total_bytes: 300, idle_timeout: Duration::from_secs(5), ..short() }); + // The first peer sends 200 bytes of an unfinished line and keeps the connection open. + let mut first = TcpStream::connect(addr).unwrap(); + first.write_all(&[b'a'; 200]).unwrap(); + std::thread::sleep(Duration::from_millis(200)); + // The second would take 200 more, past the 300 byte total. + let mut second = TcpStream::connect(addr).unwrap(); + second.set_read_timeout(Some(Duration::from_secs(5))).unwrap(); + second.write_all(&[b'b'; 200]).unwrap(); + let mut line = String::new(); + BufReader::new(second).read_line(&mut line).unwrap(); + let v: Value = serde_json::from_str(&line).unwrap(); + assert_eq!(v["ok"], json!(false)); + assert!(v["error"].as_str().unwrap_or("").contains("too many large requests"), "{line}"); + drop(first); + } + + #[test] + fn the_budget_is_given_back_when_the_connection_ends() { + let budget = Budget::new(100); + { + let mut h = Held::new(budget.clone()); + let mut buf = Vec::new(); + let mut input: &[u8] = &[b'x'; 80]; + assert_eq!(read_bounded_line(&mut input, &mut buf, 1000, &mut h), Ok(true)); + assert!(!budget.reserve(30), "80 of 100 bytes are held"); + } + assert!(budget.reserve(100), "all given back on drop"); + } + /// Replies on one authenticated connection preserve the ID of each request. #[test] fn requests_are_answered_with_their_ids() { diff --git a/crates/mcp/src/backend.rs b/crates/mcp/src/backend.rs index 9d012076a..20a86fce7 100644 --- a/crates/mcp/src/backend.rs +++ b/crates/mcp/src/backend.rs @@ -1,6 +1,6 @@ //! Where MCP tool calls end up: a control-channel method call. -use std::io::{BufRead, BufReader, Write}; +use std::io::{BufRead, BufReader, Read, Write}; use std::net::{TcpStream, ToSocketAddrs}; use std::time::Duration; @@ -28,6 +28,8 @@ pub struct Remote { /// The per-session control token for this port, read from the owner-only token file on first /// use so requests can authenticate (CWE-306). token: Option, + /// Longest reply line accepted (`MAX_REPLY_LINE`; smaller in tests). + max_reply: usize, } /// The port component of a `HOST:PORT` address, for locating the token file. @@ -38,10 +40,29 @@ fn port_of(addr: &str) -> Option { /// How long a launched app has to open its control port. const LAUNCH_WAIT: Duration = Duration::from_secs(30); +/// Longest reply line in bytes the client will buffer. It matches the control server's request +/// cap (256 MiB, room for whole drawings and images as base64), so a peer squatting on the port +/// can't make the client allocate without bound (#1925). +const MAX_REPLY_LINE: usize = 256 * 1024 * 1024; + +/// Read one `\n`-terminated reply of at most `max` bytes (newline excluded). `Ok(0)` is end of +/// stream; a longer line is an `InvalidData` error and the rest of it stays unread. +fn read_reply_line(reader: &mut impl BufRead, reply: &mut String, max: usize) -> std::io::Result { + let limit = u64::try_from(max).unwrap_or(u64::MAX).saturating_add(1); + let n = reader.take(limit).read_line(reply)?; + if n > max && !reply.ends_with('\n') { + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidData, + format!("reply from the control port is longer than {max} bytes; is that CADCraft's control server?"), + )); + } + Ok(n) +} + impl Remote { /// Connect to a running control server; its session token is read lazily when the first request is sent. pub fn connect(addr: &str) -> std::io::Result { - let mut r = Self { addr: addr.to_string(), conn: None, next_id: 1, launch: false, token: None }; + let mut r = Self { addr: addr.to_string(), conn: None, next_id: 1, launch: false, token: None, max_reply: MAX_REPLY_LINE }; r.reconnect()?; Ok(r) } @@ -49,7 +70,7 @@ impl Remote { /// the server before the app is open. With `launch`, a call that finds nothing at `addr` /// opens the app with that control port first (macOS) and waits for it. pub fn lazy(addr: &str, launch: bool) -> Self { - Self { addr: addr.to_string(), conn: None, next_id: 1, launch, token: None } + Self { addr: addr.to_string(), conn: None, next_id: 1, launch, token: None, max_reply: MAX_REPLY_LINE } } /// The per-session token for this port, read (and cached) from the owner-only token file. A @@ -120,7 +141,7 @@ impl Remote { return Err((e, true)); } let mut reply = String::new(); - match reader.read_line(&mut reply) { + match read_reply_line(reader, &mut reply, self.max_reply) { Ok(0) => { self.conn = None; Err((std::io::Error::new(std::io::ErrorKind::UnexpectedEof, "connection closed"), true)) @@ -430,6 +451,37 @@ mod tests { use std::net::TcpListener; use std::sync::Arc; + /// A peer squatting on the control port can't make the client buffer an endless reply line (#1925). + #[test] + fn an_overlong_reply_is_refused_without_buffering_it() { + let listener = TcpListener::bind("127.0.0.1:0").unwrap(); + let addr = listener.local_addr().unwrap().to_string(); + let server = std::thread::spawn(move || { + let (mut conn, _) = listener.accept().unwrap(); + let mut line = String::new(); + BufReader::new(conn.try_clone().unwrap()).read_line(&mut line).unwrap(); + // No newline: the reply never ends. A bounded client gives up after the limit. + let _ = conn.write_all(&[b'x'; 4096]); + let _ = conn.flush(); + std::thread::sleep(Duration::from_millis(500)); + }); + let mut remote = Remote::connect(&addr).unwrap(); + remote.max_reply = 100; + let err = remote.roundtrip("{}").unwrap_err().0; + assert_eq!(err.kind(), std::io::ErrorKind::InvalidData, "{err}"); + assert!(err.to_string().contains("longer than 100 bytes"), "{err}"); + assert!(remote.conn.is_none()); + server.join().unwrap(); + } + + #[test] + fn replies_up_to_the_limit_are_read() { + let mut input: &[u8] = b"0123456789\nrest\n"; + let mut reply = String::new(); + assert_eq!(read_reply_line(&mut input, &mut reply, 10).unwrap(), 11); + assert_eq!(reply, "0123456789\n"); + } + /// A server that reads one request per connection and closes without replying must not see the request twice. #[test] fn lost_reply_to_a_mutation_is_not_resent() { From 1d987904f9064b8e712a4abbd4e065f3a238c1fa Mon Sep 17 00:00:00 2001 From: bmh129 Date: Thu, 29 Oct 2026 20:21:54 -0500 Subject: [PATCH 20/49] Tests remove the temp files they write (#2232) * Tests remove the temp files they write Every test run left about 22 folders and files in the system temp directory: xref, alias, template, insert, linetype, script and recent-file fixtures, plus the pathless screenshot folder. The PDFBOOK test also wrote its second book to `$TMPDIR/b.pdf`, because `a^b.pdf` splits into `-a.pdf` and `b.pdf`, and then removed a file that was never written. Tests that write files now use a `TempDir` guard (`tests/support/temp_dir.rs`, shared by the engine's unit and integration tests and copied for the UI crate). It gives each test its own folder and removes it on drop, even when an assertion fails. The PDFBOOK test also checks that both books land in its folder. The five tests that write pathless screenshots hold a test-only lock, so the shared screenshot folder can be removed once empty without racing another test's write. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_012FFPi6hJVyaEKV4PyE2fKq * Pathless screenshot cleanup survives failed tests and writes The test lock's guard now empties and removes the per-process screenshot directory when dropped, so a test that panics no longer leaves files behind, and the per-test remove calls are gone. A failed PNG write or flush removes the partial file, since the reply carries no path for anyone else to clean up. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: bmh129 <11478682+bmh129@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/exchange.rs | 9 ++--- crates/engine/src/cmd/file.rs | 18 +++++----- crates/engine/src/lib.rs | 4 +++ crates/engine/tests/aliases.rs | 11 +++--- crates/engine/tests/insert_file.rs | 22 ++++++------ crates/engine/tests/lin_pat_files.rs | 25 +++++++------ crates/engine/tests/support/temp_dir.rs | 46 ++++++++++++++++++++++++ crates/engine/tests/templates.rs | 37 ++++++++++--------- crates/engine/tests/xref.rs | 16 +++++---- crates/ui-egui/src/capture/tests.rs | 12 +++---- crates/ui-egui/src/control.rs | 42 +++++++++++++++++++--- crates/ui-egui/tests/recent_files.rs | 25 ++++++------- crates/ui-egui/tests/support/temp_dir.rs | 46 ++++++++++++++++++++++++ crates/ui-egui/tests/xref_palette.rs | 16 ++++----- 14 files changed, 230 insertions(+), 99 deletions(-) create mode 100644 crates/engine/tests/support/temp_dir.rs create mode 100644 crates/ui-egui/tests/support/temp_dir.rs diff --git a/crates/engine/src/cmd/exchange.rs b/crates/engine/src/cmd/exchange.rs index f9acc909e..e28de89fc 100644 --- a/crates/engine/src/cmd/exchange.rs +++ b/crates/engine/src/cmd/exchange.rs @@ -754,19 +754,20 @@ mod tests { s.cmdline("").unwrap(); s.cmdline("pline 0,900 50,900 50,950 0,950 c").unwrap(); s.cmdline("").unwrap(); - let r = s.execute("pdfbook", &json!({ "path": temp("a^b.pdf").to_string_lossy() })); + // `a^b.pdf` names one book per row, both in the folder of the path. + let dir = crate::temp_dir::TempDir::new("pdfbook"); + let r = s.execute("pdfbook", &json!({ "path": dir.path_str("a^b.pdf") })); let r = r.unwrap(); let books = r["books"].as_array().unwrap(); assert_eq!(books.len(), 2); assert_eq!(books[0]["pages"], 3); assert_eq!(books[1]["pages"], 1); - let first = temp("a.pdf"); + let first = dir.join("a.pdf"); let text = String::from_utf8(std::fs::read(&first).unwrap()).unwrap(); let (a4, a3) = (text.find("ISO A4").unwrap(), text.find("ISO A3").unwrap()); assert!(a4 < a3, "frames go left to right: {text}"); assert!(text.contains("\"landscape\":true")); - let _ = std::fs::remove_file(first); - let _ = std::fs::remove_file(temp("b.pdf")); + assert!(dir.join("b.pdf").is_file(), "the second row's book is written beside the first"); // No frames: an error, not a panic. assert!(Session::new().execute("pdfbook", &json!({})).is_err()); } diff --git a/crates/engine/src/cmd/file.rs b/crates/engine/src/cmd/file.rs index 3a5296e88..7c26a71f9 100644 --- a/crates/engine/src/cmd/file.rs +++ b/crates/engine/src/cmd/file.rs @@ -652,20 +652,16 @@ mod tests { use serde_json::json; use crate::Session; + use crate::temp_dir::TempDir; fn active_title(s: &Session) -> String { s.state().unwrap().title.clone() } - fn temp_script(name: &str, text: &str) -> String { - let path = std::env::temp_dir().join(format!("cadcraft-script-{}-{name}", std::process::id())); - std::fs::write(&path, text).unwrap(); - path.to_string_lossy().into_owned() - } - #[test] fn script_command_runs_a_scr_file() { - let path = temp_script("run.scr", "; a comment\ncircle 50,25 20\nrectang 0,0 100,60\n"); + let dir = TempDir::new("script"); + let path = dir.file("run.scr", "; a comment\ncircle 50,25 20\nrectang 0,0 100,60\n"); let mut s = Session::new(); let r = s.execute("script", &json!({ "path": path })).unwrap(); assert_eq!(r["lines"], 3); @@ -683,8 +679,9 @@ mod tests { /// A script that runs itself must be refused, not recurse until the stack dies. #[test] fn a_script_cannot_start_a_script() { - let inner = temp_script("inner.scr", "circle 0,0 1\n"); - let outer = temp_script("outer.scr", &format!("script {}\ncircle 0,0 2\n", json!({ "path": inner }))); + let dir = TempDir::new("script"); + let inner = dir.file("inner.scr", "circle 0,0 1\n"); + let outer = dir.file("outer.scr", format!("script {}\ncircle 0,0 2\n", json!({ "path": inner }))); let mut s = Session::new(); let e = s.execute("script", &json!({ "path": outer })).unwrap_err().to_string(); assert!(e.contains("already running"), "{e}"); @@ -692,7 +689,8 @@ mod tests { #[test] fn typed_script_prompts_for_the_file_then_runs_or_reports_it() { - let good = temp_script("typed.scr", "circle 0,0 1\n"); + let dir = TempDir::new("script"); + let good = dir.file("typed.scr", "circle 0,0 1\n"); let mut s = Session::new(); s.cmdline("script").unwrap(); assert!(s.running.is_some(), "SCRIPT asks for the file name"); diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index dbb1d0e6b..2dea12394 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -324,3 +324,7 @@ impl Session { #[cfg(test)] mod tests; + +#[cfg(test)] +#[path = "../tests/support/temp_dir.rs"] +mod temp_dir; diff --git a/crates/engine/tests/aliases.rs b/crates/engine/tests/aliases.rs index 7587a9ffb..d1b39bb81 100644 --- a/crates/engine/tests/aliases.rs +++ b/crates/engine/tests/aliases.rs @@ -8,6 +8,11 @@ use cadcraft_engine::Session; use cadcraft_engine::cmd::resolve_alias; use serde_json::json; +#[path = "support/temp_dir.rs"] +mod temp_dir; + +use temp_dir::TempDir; + static ONE_AT_A_TIME: Mutex<()> = Mutex::new(()); const PGP: &str = "\ @@ -55,10 +60,8 @@ fn an_alias_file_adds_and_overrides_aliases() { #[test] fn reinit_reads_the_alias_file_again() { let _one = ONE_AT_A_TIME.lock().unwrap_or_else(|e| e.into_inner()); - let dir = std::env::temp_dir().join(format!("cadcraft-aliases-{}", std::process::id())); - std::fs::create_dir_all(&dir).unwrap(); - let file = dir.join("mine.pgp").to_string_lossy().into_owned(); - std::fs::write(&file, "ZZR, *RECTANG\n").unwrap(); + let dir = TempDir::new("aliases"); + let file = dir.file("mine.pgp", "ZZR, *RECTANG\n"); let mut s = Session::new(); s.execute("aliasedit", &json!({ "file": file })).unwrap(); assert_eq!(resolve_alias("zzr"), "rectang"); diff --git a/crates/engine/tests/insert_file.rs b/crates/engine/tests/insert_file.rs index 77bfd9d85..41f7a92a7 100644 --- a/crates/engine/tests/insert_file.rs +++ b/crates/engine/tests/insert_file.rs @@ -8,6 +8,11 @@ use cadcraft_engine::doc::geom::Vec3; use cadcraft_engine::doc::{Block, Circle, Drawing, Entity, EntityKind, HVal, Handle, Insert, Layer, Line}; use serde_json::json; +#[path = "support/temp_dir.rs"] +mod temp_dir; + +use temp_dir::TempDir; + /// A drawing file in a test format: its bytes are "x,y", the $INSBASE. Model space: a line from /// 10,10 to 20,10 on layer PARTS (colour 1), and a reference to block NUT (a circle) at 10,10. fn read(bytes: &[u8], _name: &str) -> Result { @@ -44,15 +49,6 @@ fn hooks() { set_io(IoHooks { read, write: |_, _| Err("no writer in this test".into()), plot: None }); } -/// Write a test drawing file with $INSBASE `base`; returns its path. -fn file(name: &str, base: &str) -> String { - let dir = std::env::temp_dir().join(format!("cadcraft-insert-file-{}", std::process::id())); - std::fs::create_dir_all(&dir).unwrap(); - let p = dir.join(name); - std::fs::write(&p, base).unwrap(); - p.to_string_lossy().into_owned() -} - /// Lines in model space as (ax, ay, bx, by), rounded. fn lines(s: &Session) -> Vec<(f64, f64, f64, f64)> { let r = |v: f64| (v * 1e6).round() / 1e6; @@ -105,7 +101,9 @@ fn star_name_inserts_the_blocks_objects_with_one_scale_factor() { #[test] fn a_drawing_file_becomes_a_block_with_its_insbase_and_tables() { hooks(); - let bolt = file("bolt.dxf", "10,10"); + // Test drawing files hold their $INSBASE. + let dir = TempDir::new("insert-file"); + let bolt = dir.file("bolt.dxf", "10,10"); let mut s = Session::new(); // This drawing's own layer PARTS keeps its colour. s.execute("layer.new", &json!({ "name": "PARTS", "color": 3 })).unwrap(); @@ -128,7 +126,7 @@ fn a_drawing_file_becomes_a_block_with_its_insbase_and_tables() { assert_eq!(inserts(&s).len(), 2); // NAME=path defines the block under that name without asking; *path inserts the file's objects. - let pin = file("pin.dxf", "10,10"); + let pin = dir.file("pin.dxf", "10,10"); s.script(&format!("-INSERT M8={bolt} 0,0 1 1 0\n-INSERT *{pin} 50,0 1 0\n")).unwrap(); assert!(s.running.is_none(), "INSERT finished: {}", s.prompt_text()); assert!(s.doc().unwrap().block("M8").is_some()); @@ -138,7 +136,7 @@ fn a_drawing_file_becomes_a_block_with_its_insbase_and_tables() { assert!(inserts(&s).iter().any(|i| i.0 == "NUT" && i.1 == 50.0 && i.2 == 0.0)); // JSON: `file` with an optional block name, never a dialog. - let r = s.execute("insert", &json!({ "file": file("washer.dxf", "0,0"), "at": [5, 5] })).unwrap(); + let r = s.execute("insert", &json!({ "file": dir.file("washer.dxf", "0,0"), "at": [5, 5] })).unwrap(); assert!(r["handle"].is_string(), "{r}"); assert!(inserts(&s).iter().any(|i| i.0 == "washer")); diff --git a/crates/engine/tests/lin_pat_files.rs b/crates/engine/tests/lin_pat_files.rs index 1c57d9f25..b09b504d4 100644 --- a/crates/engine/tests/lin_pat_files.rs +++ b/crates/engine/tests/lin_pat_files.rs @@ -6,16 +6,12 @@ use cadcraft_engine::Session; use cadcraft_engine::doc::{EntityKind, Hatch}; use serde_json::json; -const LIN: &str = "*MYDASH,My dash __ __\nA,.5,-.25\n*MYTEXT,My text --MY--\nA,.5,-.2,[\"MY\",Standard,S=.1,X=-.1,Y=-.05],-.2\n"; +#[path = "support/temp_dir.rs"] +mod temp_dir; -/// A user file in the test's temp folder; returns its path. -fn file(name: &str, text: &str) -> String { - let dir = std::env::temp_dir().join(format!("cadcraft-lin-pat-{}", std::process::id())); - std::fs::create_dir_all(&dir).unwrap(); - let p = dir.join(name); - std::fs::write(&p, text).unwrap(); - p.to_string_lossy().into_owned() -} +use temp_dir::TempDir; + +const LIN: &str = "*MYDASH,My dash __ __\nA,.5,-.25\n*MYTEXT,My text --MY--\nA,.5,-.2,[\"MY\",Standard,S=.1,X=-.1,Y=-.05],-.2\n"; fn linetype_pattern(s: &Session, name: &str) -> Option> { s.doc().unwrap().linetype(name).map(|l| l.pattern.iter().map(|e| e.length).collect()) @@ -46,7 +42,8 @@ fn linetype_json_loads_named_linetypes_from_file_text() { #[test] fn linetype_json_reads_a_lin_file_by_path() { - let path = file("mine.lin", LIN); + let dir = TempDir::new("lin-pat"); + let path = dir.file("mine.lin", LIN); let mut s = Session::new(); s.execute("linetype", &json!({ "load": "MYTEXT", "file": path })).unwrap(); assert!(linetype_pattern(&s, "MYTEXT").is_some()); @@ -58,7 +55,8 @@ fn linetype_json_reads_a_lin_file_by_path() { #[test] fn dash_linetype_loads_from_a_file_and_the_library_at_the_command_line() { - let path = file("cmdline.lin", LIN); + let dir = TempDir::new("lin-pat"); + let path = dir.file("cmdline.lin", LIN); let mut s = Session::new(); s.cmdline("-linetype").unwrap(); for line in ["l", "MYDASH,MYTEXT", path.as_str(), "s", "MYTEXT"] { @@ -72,7 +70,7 @@ fn dash_linetype_loads_from_a_file_and_the_library_at_the_command_line() { assert!(s.log.iter().any(|l| l.contains("Linetype MYDASH loaded")), "{:?}", s.log); // Already loaded: asked whether to reload, in the file's order. - let changed = file("changed.lin", &LIN.replace(".5,-.25", "2,-2")); + let changed = dir.file("changed.lin", LIN.replace(".5,-.25", "2,-2")); s.cmdline("-linetype").unwrap(); for line in ["l", "*", changed.as_str()] { s.cmdline(line).unwrap(); @@ -132,7 +130,8 @@ fn hatch_uses_a_pattern_from_a_pat_file_and_keeps_its_definition() { #[test] fn hatch_pattern_prompt_takes_a_pat_file_name() { - let path = file("MYSTAIRS.pat", "*MYOTHER\n0,0,0,0,1\n*MYSTAIRS,Stairs\n0,0,0,.5,.5,.5,-.5\n90,.5,0,.5,.5,.5,-.5\n"); + let dir = TempDir::new("lin-pat"); + let path = dir.file("MYSTAIRS.pat", "*MYOTHER\n0,0,0,0,1\n*MYSTAIRS,Stairs\n0,0,0,.5,.5,.5,-.5\n90,.5,0,.5,.5,.5,-.5\n"); let mut s = Session::new(); s.execute("rectang", &json!({ "p1": [0, 0], "p2": [10, 10] })).unwrap(); s.cmdline("hatch").unwrap(); diff --git a/crates/engine/tests/support/temp_dir.rs b/crates/engine/tests/support/temp_dir.rs new file mode 100644 index 000000000..3b4662e0d --- /dev/null +++ b/crates/engine/tests/support/temp_dir.rs @@ -0,0 +1,46 @@ +//! A test's own folder in the system temp directory, removed when the test ends, even when an +//! assertion fails. Shared by the integration tests (`#[path]`) and the crate's unit tests. +#![allow(dead_code)] + +use std::path::{Path, PathBuf}; +use std::sync::atomic::{AtomicU64, Ordering}; + +/// `cadcraft---`: the process id keeps parallel test binaries apart and the counter +/// keeps the tests of one binary apart, so no two tests ever share (or delete) one folder. +pub struct TempDir(PathBuf); + +impl TempDir { + pub fn new(tag: &str) -> Self { + static NEXT: AtomicU64 = AtomicU64::new(0); + let n = NEXT.fetch_add(1, Ordering::Relaxed); + let dir = std::env::temp_dir().join(format!("cadcraft-{tag}-{}-{n}", std::process::id())); + let _ = std::fs::remove_dir_all(&dir); + std::fs::create_dir_all(&dir).expect("create the test's temp folder"); + Self(dir) + } + + /// Write `contents` to `name` in the folder; returns the file's path as text. + pub fn file(&self, name: &str, contents: impl AsRef<[u8]>) -> String { + let p = self.0.join(name); + std::fs::write(&p, contents).expect("write a test file"); + p.to_string_lossy().into_owned() + } + + /// The path of `name` in the folder as text, without creating it. + pub fn path_str(&self, name: &str) -> String { + self.0.join(name).to_string_lossy().into_owned() + } +} + +impl std::ops::Deref for TempDir { + type Target = Path; + fn deref(&self) -> &Path { + &self.0 + } +} + +impl Drop for TempDir { + fn drop(&mut self) { + let _ = std::fs::remove_dir_all(&self.0); + } +} diff --git a/crates/engine/tests/templates.rs b/crates/engine/tests/templates.rs index c518e3b06..cb8636061 100644 --- a/crates/engine/tests/templates.rs +++ b/crates/engine/tests/templates.rs @@ -9,6 +9,11 @@ use cadcraft_engine::cmd::file::{IoHooks, set_io}; use cadcraft_engine::doc::Drawing; use serde_json::json; +#[path = "support/temp_dir.rs"] +mod temp_dir; + +use temp_dir::TempDir; + static FILES: Mutex> = Mutex::new(Vec::new()); fn write(d: &Drawing, name: &str) -> Result, String> { @@ -27,17 +32,11 @@ fn hooks() { set_io(IoHooks { read, write, plot: None }); } -fn path(name: &str) -> String { - let dir = std::env::temp_dir().join(format!("cadcraft-templates-{}", std::process::id())); - std::fs::create_dir_all(&dir).unwrap(); - dir.join(name).to_string_lossy().into_owned() -} - /// A drawing with an office layer and a title block circle, saved as a template. -fn office_template(s: &mut Session, name: &str) -> String { +fn office_template(s: &mut Session, dir: &TempDir, name: &str) -> String { s.execute("layer.new", &json!({ "name": "A-WALL", "color": 3 })).unwrap(); s.execute("circle", &json!({ "center": [5, 5], "radius": 2 })).unwrap(); - let p = path(name); + let p = dir.path_str(name); s.execute("saveas", &json!({ "path": p })).unwrap(); p } @@ -46,7 +45,8 @@ fn office_template(s: &mut Session, name: &str) -> String { fn saveas_dwt_then_new_from_the_template() { hooks(); let mut s = Session::new(); - let dwt = office_template(&mut s, "office.dwt"); + let dir = TempDir::new("templates"); + let dwt = office_template(&mut s, &dir, "office.dwt"); // A template is saved like a drawing: the format sees the .dwt name, the drawing is saved. assert!(FILES.lock().unwrap().iter().any(|(n, _)| n.ends_with("office.dwt"))); let st = s.state().unwrap(); @@ -68,7 +68,8 @@ fn saveas_dwt_then_new_from_the_template() { fn qnewtemplate_is_the_default_for_new_and_qnew() { hooks(); let mut s = Session::new(); - let dwt = office_template(&mut s, "default.dwt"); + let dir = TempDir::new("templates"); + let dwt = office_template(&mut s, &dir, "default.dwt"); let docs = s.docs.len(); s.execute("setvar", &json!({ "name": "QNEWTEMPLATE", "value": dwt })).unwrap(); @@ -99,8 +100,8 @@ fn a_template_that_cannot_be_read_makes_no_drawing() { let docs = s.docs.len(); let err = s.execute("new", &json!({ "template": "/no/such/folder/office.dwt" })).unwrap_err().to_string(); assert!(err.contains("office.dwt"), "{err}"); - let junk = path("junk.dwt"); - std::fs::write(&junk, b"not a drawing at all").unwrap(); + let dir = TempDir::new("templates"); + let junk = dir.file("junk.dwt", b"not a drawing at all"); assert!(s.execute("new", &json!({ "template": junk })).is_err()); assert!(s.execute("new", &json!({ "template": 42 })).is_err()); assert_eq!(s.docs.len(), docs); @@ -121,6 +122,7 @@ fn layout_names(d: &Drawing) -> Vec { fn layout_saveas_writes_the_layout_and_the_named_objects_it_uses() { hooks(); let mut s = Session::new(); + let dir = TempDir::new("templates"); for name in ["TITLE", "PARTS-LAYER", "UNUSED", "WALLS", "NOTES"] { s.execute("layer.new", &json!({ "name": name })).unwrap(); } @@ -138,7 +140,7 @@ fn layout_saveas_writes_the_layout_and_the_named_objects_it_uses() { s.execute("layer.current", &json!({ "name": "0" })).unwrap(); let sheet_objects = s.doc().unwrap().layout("Sheet").unwrap().entities.iter().count(); - let p = path("sheet.dwt"); + let p = dir.path_str("sheet.dwt"); let r = s.execute("layout.saveas", &json!({ "path": p })).unwrap(); assert_eq!(r["name"], json!("Sheet"), "the current layout by default"); assert_eq!(r["path"], json!(p)); @@ -175,13 +177,14 @@ fn layout_saveas_writes_the_layout_and_the_named_objects_it_uses() { fn typed_layout_saveas_asks_for_the_layout_and_the_template_file() { hooks(); let mut s = Session::new(); + let dir = TempDir::new("templates"); s.cmdline("LAYOUT").unwrap(); s.cmdline("sa").unwrap(); assert_eq!(s.current_prompt().unwrap().display(), "Enter layout to save to template :"); s.cmdline("Layout2").unwrap(); assert_eq!(s.current_prompt().unwrap().display(), "Enter template file name :"); // No extension: the template is a .dwt. - let p = path("typed"); + let p = dir.path_str("typed"); s.cmdline(&p).unwrap(); assert!(s.current_prompt().is_none()); let saved = format!("{p}.dwt"); @@ -189,11 +192,11 @@ fn typed_layout_saveas_asks_for_the_layout_and_the_template_file() { assert_eq!(layout_names(&written("typed.dwt")), ["Layout2"]); // The JSON form of LAYOUT, other file types, a missing path and an unknown layout. - let dxf = path("sheet1.dxf"); + let dxf = dir.path_str("sheet1.dxf"); let r = s.execute("layout", &json!({ "option": "saveas", "name": "layout1", "path": dxf })).unwrap(); assert_eq!(r["name"], json!("Layout1")); assert_eq!(layout_names(&written("sheet1.dxf")), ["Layout1"]); - assert!(s.execute("layout.saveas", &json!({ "path": path("sheet.png") })).is_err()); + assert!(s.execute("layout.saveas", &json!({ "path": dir.path_str("sheet.png") })).is_err()); assert!(s.execute("layout.saveas", &json!({})).is_err()); - assert!(s.execute("layout.saveas", &json!({ "name": "Nope", "path": path("nope.dwt") })).is_err()); + assert!(s.execute("layout.saveas", &json!({ "name": "Nope", "path": dir.path_str("nope.dwt") })).is_err()); } diff --git a/crates/engine/tests/xref.rs b/crates/engine/tests/xref.rs index d53e37886..c67c627b2 100644 --- a/crates/engine/tests/xref.rs +++ b/crates/engine/tests/xref.rs @@ -2,7 +2,7 @@ //! loading with `xref|name` symbols, saving only the reference, reopening, Reload/Unload/Detach/ //! Path, Bind and XBIND, overlays, missing files, circular and deeply nested references. -use std::path::{Path, PathBuf}; +use std::path::Path; use std::sync::Arc; use cadcraft_engine::Session; @@ -12,6 +12,11 @@ use cadcraft_engine::doc::geom::Vec3; use cadcraft_engine::doc::{Block, Circle, Drawing, Entity, EntityKind, Handle, Insert, Layer, Line, Linetype, MAX_BLOCK_DEPTH, XrefStatus}; use serde_json::json; +#[path = "support/temp_dir.rs"] +mod temp_dir; + +use temp_dir::TempDir; + fn hooks() { set_io(IoHooks { read: |b, name| cadcraft_io::read(b, name).map_err(|e| e.to_string()), @@ -20,12 +25,9 @@ fn hooks() { }); } -/// A fresh folder for one test. -fn folder(tag: &str) -> PathBuf { - let dir = std::env::temp_dir().join(format!("cadcraft-xref-{}-{tag}", std::process::id())); - let _ = std::fs::remove_dir_all(&dir); - std::fs::create_dir_all(&dir).unwrap(); - dir +/// A fresh folder for one test, removed when the test ends. +fn folder(tag: &str) -> TempDir { + TempDir::new(&format!("xref-{tag}")) } fn save(d: &Drawing, path: &Path) { diff --git a/crates/ui-egui/src/capture/tests.rs b/crates/ui-egui/src/capture/tests.rs index 6e70aea7b..b85961c44 100644 --- a/crates/ui-egui/src/capture/tests.rs +++ b/crates/ui-egui/src/capture/tests.rs @@ -168,6 +168,7 @@ fn focus_change_cancels_an_unissued_capture() { /// Two requests issue from one settled frame; each reply carries its own token and a distinct, readable file with a PNG signature. #[test] fn issued_callbacks_reply_once_with_matching_tokens_and_distinct_pathless_files() { + let _shots = crate::control::lock_pathless_shots(); let ctx = egui::Context::default(); let mut app = app(); set_geometry(&mut app, &ctx, egui::vec2(800.0, 600.0)); @@ -190,7 +191,6 @@ fn issued_callbacks_reply_once_with_matching_tokens_and_distinct_pathless_files( assert_ne!(a, b, "one file per request"); for path in [&a, &b] { assert!(std::fs::read(path).is_ok_and(|bytes| bytes.starts_with(b"\x89PNG\r\n\x1a\n")), "{path}"); - let _ = std::fs::remove_file(path); } assert!(app.shots.is_empty()); } @@ -342,6 +342,7 @@ fn raw_geometry_uses_screen_rect_when_inner_rect_is_absent() { /// not issue, and the settled second pass must issue exactly once. #[test] fn a_discarded_pass_does_not_issue_and_the_settled_pass_does_once() { + let _shots = crate::control::lock_pathless_shots(); let ctx = egui::Context::default(); let mut app = app(); let (rx, _) = admit_one(&mut app, &ctx); @@ -365,13 +366,15 @@ fn a_discarded_pass_does_not_issue_and_the_settled_pass_does_once() { assert_eq!(app.ui_frames, 1, "one settled frame, not one per pass"); complete(callbacks, [800, 600]); drain(&mut app, &ctx); - assert_eq!(rx.recv().expect("a reply")["ok"], true); + let reply = rx.recv().expect("a reply"); + assert_eq!(reply["ok"], true, "{reply}"); } /// Issuance re-bases the expected image on the settled pass, so the saved interface zoom /// (applied by egui at the start of a later pass) cannot leave a stale admission estimate. #[test] fn issuance_uses_the_settled_interface_scale_not_the_admission_estimate() { + let _shots = crate::control::lock_pathless_shots(); let ctx = egui::Context::default(); let mut app = app(); app.options.interface_scale = 2.0; @@ -387,8 +390,6 @@ fn issuance_uses_the_settled_interface_scale_not_the_admission_estimate() { drain(&mut app, &ctx); let reply = rx.recv().expect("a reply"); assert_eq!(reply["ok"], true, "{reply}"); - let path = reply["result"]["path"].as_str().expect("a file").to_string(); - let _ = std::fs::remove_file(path); } /// A→B→A: a switch that returns to the same drawing still invalidates the queued request. @@ -447,6 +448,7 @@ fn a_settled_window_does_not_keep_changing_the_surface_epoch() { /// A window resized while the request is still settling is issued against the new size. #[test] fn a_resize_while_settling_is_absorbed_at_issue() { + let _shots = crate::control::lock_pathless_shots(); let ctx = egui::Context::default(); let mut app = app(); let (rx, _) = admit_one(&mut app, &ctx); @@ -464,6 +466,4 @@ fn a_resize_while_settling_is_absorbed_at_issue() { drain(&mut app, &ctx); let reply = rx.recv().expect("a reply"); assert_eq!(reply["ok"], true, "{reply}"); - let path = reply["result"]["path"].as_str().expect("a file").to_string(); - let _ = std::fs::remove_file(path); } diff --git a/crates/ui-egui/src/control.rs b/crates/ui-egui/src/control.rs index 2dc1f898a..7330681db 100644 --- a/crates/ui-egui/src/control.rs +++ b/crates/ui-egui/src/control.rs @@ -619,6 +619,35 @@ fn is_private_shot_dir(meta: &std::fs::Metadata) -> bool { } } +/// Pathless screenshots share one directory per process. Tests that write them hold this guard, +/// so no other test writes while it is cleaned up. Dropping it, even while a failed test unwinds, +/// removes every screenshot file in the directory and then the directory itself. +#[cfg(test)] +pub(crate) struct PathlessShots { + _lock: std::sync::MutexGuard<'static, ()>, +} + +#[cfg(test)] +pub(crate) fn lock_pathless_shots() -> PathlessShots { + static LOCK: std::sync::Mutex<()> = std::sync::Mutex::new(()); + PathlessShots { _lock: LOCK.lock().unwrap_or_else(std::sync::PoisonError::into_inner) } +} + +#[cfg(test)] +impl Drop for PathlessShots { + fn drop(&mut self) { + let Ok(dir) = private_shot_dir() else { return }; + if let Ok(entries) = std::fs::read_dir(&dir) { + for entry in entries.flatten() { + if entry.file_name().to_string_lossy().starts_with("cadcraft-shot-") { + let _ = std::fs::remove_file(entry.path()); + } + } + } + let _ = std::fs::remove_dir(&dir); + } +} + /// Save a pathless screenshot into the private per-process directory: re-validate or recreate it as an owner-only real directory (0700 on Unix; plain create elsewhere), then create up to 64 exclusive files (0600 on Unix) and write a PNG. fn save_pathless_screenshot(img: &image::RgbaImage, token: u64) -> std::io::Result { use std::io::Write as _; @@ -641,8 +670,13 @@ fn save_pathless_screenshot(img: &image::RgbaImage, token: u64) -> std::io::Resu let path = dir.join(format!("cadcraft-shot-{token}-{}.png", next_pathless_nonce())); match create_private_file(&path) { Ok(mut file) => { - img.write_to(&mut file, image::ImageFormat::Png).map_err(std::io::Error::other)?; - file.flush()?; + let written = img.write_to(&mut file, image::ImageFormat::Png).map_err(std::io::Error::other).and_then(|()| file.flush()); + if let Err(e) = written { + // The reply carries no path on failure, so nobody else could remove the partial file. + drop(file); + let _ = std::fs::remove_file(&path); + return Err(e); + } return Ok(path); } Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => continue, @@ -735,6 +769,7 @@ mod tests { /// Two pathless saves with the same token produce distinct, decodable PNGs; on Unix the files are 0600 and their directory 0700. #[test] fn pathless_screenshots_are_unique_private_png_files() { + let _shots = lock_pathless_shots(); let img = egui::ColorImage::filled([4, 3], egui::Color32::RED); let first = save_screenshot(&img, None, 1); let second = save_screenshot(&img, None, 1); @@ -759,9 +794,6 @@ mod tests { let dir_mode = std::fs::metadata(dir).expect("directory metadata").permissions().mode() & 0o777; assert_eq!(dir_mode, 0o700, "the screenshot directory is owner-only"); } - for path in [&a, &b] { - let _ = std::fs::remove_file(path); - } } /// `create_new` refuses a pre-existing symlink with `AlreadyExists` and leaves the link target unchanged. diff --git a/crates/ui-egui/tests/recent_files.rs b/crates/ui-egui/tests/recent_files.rs index 946a6792a..34d460255 100644 --- a/crates/ui-egui/tests/recent_files.rs +++ b/crates/ui-egui/tests/recent_files.rs @@ -9,17 +9,18 @@ use cadcraft_ui_egui::{CadApp, Services}; use egui::{Rect, Shape, vec2}; use egui_kittest::Harness; -/// Two drawing files on disk (the reader below accepts anything, so their contents don't matter). -fn drawings(test: &str) -> (String, String) { +#[path = "support/temp_dir.rs"] +mod temp_dir; + +use temp_dir::TempDir; + +/// Two drawing files on disk (the reader below accepts anything, so their contents don't matter), +/// in a folder that is removed when the returned guard is dropped. +fn drawings(test: &str) -> (TempDir, String, String) { set_io(IoHooks { read: |_, _| Ok(Drawing::new_metric()), write: |_, _| Ok(Vec::new()), plot: None }); - let dir = std::env::temp_dir().join(format!("cadcraft-recent-{test}-{}", std::process::id())); - std::fs::create_dir_all(&dir).unwrap(); - let path = |name: &str| { - let p = dir.join(name); - std::fs::write(&p, b"0\nEOF\n").unwrap(); - p.to_string_lossy().to_string() - }; - (path("plan.dxf"), path("section.dwg")) + let dir = TempDir::new(&format!("recent-{test}")); + let (plan, section) = (dir.file("plan.dxf", b"0\nEOF\n"), dir.file("section.dwg", b"0\nEOF\n")); + (dir, plan, section) } /// Wait for the drawings being read in the background to be added (or reported). @@ -49,7 +50,7 @@ fn open_recent(app: &CadApp) -> Vec<(String, String)> { #[test] fn opened_drawings_are_listed_newest_first_and_survive_a_restart() { - let (plan, section) = drawings("menu"); + let (_dir, plan, section) = drawings("menu"); let mut app = CadApp::new(Session::empty(), Services::default()); assert!(app.ui.recent_files.is_empty()); @@ -99,7 +100,7 @@ fn texts(shape: &Shape, out: &mut Vec<(String, Rect)>) { #[test] fn start_page_lists_recent_files_and_opens_one_on_click() { - let (plan, section) = drawings("start"); + let (_dir, plan, section) = drawings("start"); let mut app = CadApp::new(Session::empty(), Services::default()); app.ui.recent_files = vec![section.clone(), plan.clone()]; let mut h = Harness::builder().with_size(vec2(1200.0, 760.0)).build_ui_state( diff --git a/crates/ui-egui/tests/support/temp_dir.rs b/crates/ui-egui/tests/support/temp_dir.rs new file mode 100644 index 000000000..e1f16b8c1 --- /dev/null +++ b/crates/ui-egui/tests/support/temp_dir.rs @@ -0,0 +1,46 @@ +//! A test's own folder in the system temp directory, removed when the test ends, even when an +//! assertion fails. Shared by the integration tests through `#[path]`. +#![allow(dead_code)] + +use std::path::{Path, PathBuf}; +use std::sync::atomic::{AtomicU64, Ordering}; + +/// `cadcraft---`: the process id keeps parallel test binaries apart and the counter +/// keeps the tests of one binary apart, so no two tests ever share (or delete) one folder. +pub struct TempDir(PathBuf); + +impl TempDir { + pub fn new(tag: &str) -> Self { + static NEXT: AtomicU64 = AtomicU64::new(0); + let n = NEXT.fetch_add(1, Ordering::Relaxed); + let dir = std::env::temp_dir().join(format!("cadcraft-{tag}-{}-{n}", std::process::id())); + let _ = std::fs::remove_dir_all(&dir); + std::fs::create_dir_all(&dir).expect("create the test's temp folder"); + Self(dir) + } + + /// Write `contents` to `name` in the folder; returns the file's path as text. + pub fn file(&self, name: &str, contents: impl AsRef<[u8]>) -> String { + let p = self.0.join(name); + std::fs::write(&p, contents).expect("write a test file"); + p.to_string_lossy().into_owned() + } + + /// The path of `name` in the folder as text, without creating it. + pub fn path_str(&self, name: &str) -> String { + self.0.join(name).to_string_lossy().into_owned() + } +} + +impl std::ops::Deref for TempDir { + type Target = Path; + fn deref(&self) -> &Path { + &self.0 + } +} + +impl Drop for TempDir { + fn drop(&mut self) { + let _ = std::fs::remove_dir_all(&self.0); + } +} diff --git a/crates/ui-egui/tests/xref_palette.rs b/crates/ui-egui/tests/xref_palette.rs index 2f242b277..f950427c4 100644 --- a/crates/ui-egui/tests/xref_palette.rs +++ b/crates/ui-egui/tests/xref_palette.rs @@ -11,6 +11,11 @@ use egui_kittest::Harness; use egui_kittest::kittest::Queryable; use serde_json::json; +#[path = "support/temp_dir.rs"] +mod temp_dir; + +use temp_dir::TempDir; + /// Test drawings: any file holds one line on layer Walls. fn read(_bytes: &[u8], _name: &str) -> Result { let mut d = Drawing::new_metric(); @@ -21,14 +26,6 @@ fn read(_bytes: &[u8], _name: &str) -> Result { Ok(d) } -fn site_file() -> String { - let dir = std::env::temp_dir().join(format!("cadcraft-xref-palette-{}", std::process::id())); - std::fs::create_dir_all(&dir).unwrap(); - let p = dir.join("site.dxf"); - std::fs::write(&p, "site").unwrap(); - p.to_string_lossy().into_owned() -} - fn status(app: &CadApp) -> Option { app.session.doc().ok()?.block("site").map(|b| b.xref_status) } @@ -37,7 +34,8 @@ fn status(app: &CadApp) -> Option { fn xref_opens_the_palette_and_its_buttons_manage_the_xref() { set_io(IoHooks { read, write: |_, _| Err("no writer in this test".into()), plot: None }); let mut app = CadApp::new(Session::default(), Services::default()); - app.run("xattach", json!({ "path": site_file(), "at": [10, 10] })).unwrap(); + let dir = TempDir::new("xref-palette"); + app.run("xattach", json!({ "path": dir.file("site.dxf", "site"), "at": [10, 10] })).unwrap(); assert_eq!(status(&app), Some(XrefStatus::Loaded)); // Typed (by its alias) it opens the palette instead of listing. assert!(app.cmdline("XR").is_none()); From b9b7b3d439d0ff889475116a1a145b3f2e65f9c8 Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:21:58 +0100 Subject: [PATCH 21/49] Refuse invalid count in JSON copy instead of clamping it (#2294) Found while testing crates/engine/src/cmd/modify/transform.rs:69 (run_copy) Co-authored-by: Claude Haiku 5.5 --- crates/engine/src/cmd/modify/transform.rs | 5 ++++- crates/engine/tests/it/copy_count.rs | 24 +++++++++++++++++++++++ crates/engine/tests/it/main.rs | 1 + 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 crates/engine/tests/it/copy_count.rs diff --git a/crates/engine/src/cmd/modify/transform.rs b/crates/engine/src/cmd/modify/transform.rs index 5474dde16..5a86d9e07 100644 --- a/crates/engine/src/cmd/modify/transform.rs +++ b/crates/engine/src/cmd/modify/transform.rs @@ -66,7 +66,10 @@ pub(super) fn run_move(s: &mut Session, p: &Value) -> Result { pub(super) fn run_copy(s: &mut Session, p: &Value) -> Result { let hs = targets(s, p)?; let d = delta_of("copy", p)?; - let n = p.get("count").and_then(Value::as_u64).unwrap_or(1).clamp(1, 10_000); + let n = match p.get("count") { + None => 1, + Some(v) => v.as_u64().filter(|n| (1..=10_000).contains(n)).ok_or_else(|| bad("copy", "`count` must be an integer from 1 to 10000"))?, + }; let mut out = Vec::new(); for k in 1..=n { out.extend(transform_entities(s, &hs, &Mat3::translate(d * k as f64), true)?.into_iter().map(|h| h.hex())); diff --git a/crates/engine/tests/it/copy_count.rs b/crates/engine/tests/it/copy_count.rs new file mode 100644 index 000000000..64deab8f0 --- /dev/null +++ b/crates/engine/tests/it/copy_count.rs @@ -0,0 +1,24 @@ +//! JSON COPY refuses a `count` that is not an integer from 1 to 10000 instead of clamping it. + +use cadcraft_engine::Session; +use serde_json::{Value, json}; + +fn entities(s: &Session) -> usize { + s.doc().map(|d| d.model.iter().count()).unwrap_or(0) +} + +#[test] +fn invalid_copy_count_is_refused() { + let mut s = Session::new(); + let r = s.execute("line", &json!({"points": [[0, 0], [10, 0]]})).unwrap(); + let h = r["handles"][0].clone(); + let before = entities(&s); + let bad: [Value; 7] = [json!(0), json!(-3), json!(2.5), json!("abc"), json!(null), json!(10001), json!(50000)]; + for c in bad { + let r = s.execute("copy", &json!({"handles": [h], "delta": [0, 5], "count": c})); + assert!(r.is_err(), "count {c} should be refused"); + assert_eq!(entities(&s), before, "count {c} changed the drawing"); + } + s.execute("copy", &json!({"handles": [h], "delta": [0, 5], "count": 3})).unwrap(); + assert_eq!(entities(&s), before + 3); +} diff --git a/crates/engine/tests/it/main.rs b/crates/engine/tests/it/main.rs index 4a2a829a7..51cec4590 100644 --- a/crates/engine/tests/it/main.rs +++ b/crates/engine/tests/it/main.rs @@ -21,6 +21,7 @@ mod burst; mod compare_export; mod constraint_geometry; mod constraint_infer; +mod copy_count; mod count; mod dash_block; mod data_extraction; From 303bc97f9aa9dfb541548ba99f2a1cadf09f3d34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20Mittelst=C3=A4dt?= <62167861+TheGalitube@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:22:01 +0100 Subject: [PATCH 22/49] Count DXF group codes correctly when enforcing limits (#2408) Found while testing crates/dxf/src/lib.rs:185 Co-authored-by: GPT-6-Luna --- crates/dxf/src/lib.rs | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/crates/dxf/src/lib.rs b/crates/dxf/src/lib.rs index 4e888bdc0..b9e394766 100644 --- a/crates/dxf/src/lib.rs +++ b/crates/dxf/src/lib.rs @@ -181,8 +181,20 @@ pub fn parse_with_limit(bytes: &[u8], max_tags: usize) -> Result> { if let Some(body) = bytes.strip_prefix(BINARY_SENTINEL) { return parse_binary_with_limit(body, max_tags); } - // Every group code takes two lines (code, value). - let tags = bytes.iter().filter(|&&b| b == b'\n').count().div_ceil(2); + // Count nonblank group-code/value pairs, stopping at EOF just as the parser does. + let mut lines = bytes.split(|&b| b == b'\n'); + let mut tags = 0; + while let Some(code) = lines.next() { + let code = code.trim_ascii(); + if code.is_empty() { + continue; + } + let Some(value) = lines.next() else { break }; + tags += 1; + if code == b"0" && value.trim_ascii() == b"EOF" { + break; + } + } if tags > max_tags { return Err(DxfError::TooLarge { tags, limit: max_tags }); } @@ -581,6 +593,12 @@ mod tests { } } + #[test] + fn blank_lines_do_not_consume_group_code_limit() { + let tags = parse_with_limit(b"0\nEOF\n\n\n", 1).expect("one group code should fit a limit of one"); + assert_eq!(tags, vec![Tag::s(0, "EOF")]); + } + #[test] fn ascii_roundtrip() { let tags = vec![ From 3243271d4eea800a02cf532b202d833429dc631c Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:31:09 +0100 Subject: [PATCH 23/49] Reject zero distance in JSON offset command (#2190) Found while testing crates/engine/src/cmd/modify.rs:791 (run_offset) Co-authored-by: Claude Haiku 5.5 Co-authored-by: Brandon Thomas --- crates/engine/src/cmd/modify/offset.rs | 3 +++ crates/engine/src/tests.rs | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/crates/engine/src/cmd/modify/offset.rs b/crates/engine/src/cmd/modify/offset.rs index 01ca46c04..20e6ba58e 100644 --- a/crates/engine/src/cmd/modify/offset.rs +++ b/crates/engine/src/cmd/modify/offset.rs @@ -197,6 +197,9 @@ fn join_point(a: &Segment, b: &Segment) -> Option { pub(super) fn run_offset(s: &mut Session, p: &Value) -> Result { let h = targets(s, p)?.first().copied().ok_or_else(|| bad("offset", "`handle` is required"))?; let dist = f64_req("offset", p, "distance")?; + if dist == 0.0 { + return Err(bad("offset", "Requires a positive distance.")); + } let side = point_req("offset", p, "side")?; let e = s.doc()?.entity(h).map(|e| (**e).clone()).ok_or_else(|| bad("offset", "no such object"))?; let k = offset_kind(&e.kind, dist.abs(), side).ok_or_else(|| bad("offset", "cannot offset that object"))?; diff --git a/crates/engine/src/tests.rs b/crates/engine/src/tests.rs index b06641fbb..be6246824 100644 --- a/crates/engine/src/tests.rs +++ b/crates/engine/src/tests.rs @@ -344,6 +344,15 @@ fn fillet_two_lines() { assert!(g.iter().any(|p| p.near(Vec2::new(2.0, 0.0), 1e-9))); } +#[test] +fn offset_zero_distance_is_rejected() { + let mut s = Session::new(); + s.execute("line", &json!({"points": [[0, 0], [10, 0]]})).unwrap(); + let r = s.execute("offset", &json!({"handle": "100", "distance": 0, "side": [1, 1]})); + assert!(r.is_err(), "offset distance 0 made a coincident copy: {r:?}"); + assert_eq!(s.doc().unwrap().model.len(), 1); +} + #[test] fn offset_circle_and_polyline() { let mut s = Session::new(); From 0d9e62bc9aa55356f65310417fd80602f2b4db7e Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:31:13 +0100 Subject: [PATCH 24/49] Stop DIMTMOVE 2 text taking the DIMTAD 1 clearance twice (#2302) Fixes #2222 Co-authored-by: Claude Opus 5.5 Co-authored-by: Brandon Thomas --- crates/render/src/dim/linear.rs | 16 ++++++++++------ crates/render/src/dim/tests.rs | 23 +++++++++++++++++++++++ 2 files changed, 33 insertions(+), 6 deletions(-) diff --git a/crates/render/src/dim/linear.rs b/crates/render/src/dim/linear.rs index 40b684832..8127aef8f 100644 --- a/crates/render/src/dim/linear.rs +++ b/crates/render/src/dim/linear.rs @@ -150,11 +150,13 @@ fn position_linear_text(config: &DimConfig<'_>, state: &mut LinearDimState) { }; state.side_out = if (config.dimension.defpt.xy() - state.p1).dot(state.n) >= 0.0 { state.n } else { -state.n }; state.text_axis = Vec2::from_angle(state.angle); - let off_along = |axis: Vec2| { - let glyph_extent = state.text_width * state.text_axis.dot(axis).abs() / 2.0 - + state.text_height * state.text_axis.perp().dot(axis).abs() * if st.text_above == 1 { 0.6 } else { 0.5 }; - config.gap + glyph_extent + let clearance = |axis: Vec2, across: f64| { + config.gap + + state.text_width * state.text_axis.dot(axis).abs() / 2.0 + + state.text_height * state.text_axis.perp().dot(axis).abs() * across }; + // Empirical #2004 match: 0.595× height with SHX and 0.601× with TrueType. + let off_along = |axis: Vec2| clearance(axis, if st.text_above == 1 { 0.6 } else { 0.5 }); let above = if state.angle.abs() < 1e-12 && state.n.y.abs() > 1e-9 { if state.n.y > 0.0 { state.n } else { -state.n } } else if state.angle.abs() < 1e-12 { @@ -181,11 +183,13 @@ fn position_linear_text(config: &DimConfig<'_>, state: &mut LinearDimState) { + outward * (config.gap + state.text_height / 2.0); } else if state.moved { let mid = state.f1.mid(state.f2); - let lift = off_along(state.side_out) + 2.0 * config.arrow_size.max(config.tick_size); + // Half the text height either way, whatever DIMTAD says (#2222). + let clear = clearance(state.side_out, 0.5); + let lift = clear + 2.0 * config.arrow_size.max(config.tick_size); state.text_mid = if st.text_move == 1 { mid + state.side_out * lift + state.u * state.half_extent } else { - mid + state.side_out * (lift + off_along(state.side_out)) + mid + state.side_out * (lift + clear) }; } else if !config.dimension.user_text_pos { state.text_mid = state.along_center + state.offset; diff --git a/crates/render/src/dim/tests.rs b/crates/render/src/dim/tests.rs index fd439097c..fe3b3c74e 100644 --- a/crates/render/src/dim/tests.rs +++ b/crates/render/src/dim/tests.rs @@ -233,6 +233,29 @@ fn text_that_does_not_fit_follows_dimtmove_2() { assert!(g.lines_of(LineRole::Dim).flatten().all(|p| p.x <= 0.5 + 1e-9 && p.y >= 5.0 - 1e-9), "no leader, no line out to the text"); } +#[test] +fn dimtmove_2_text_clearance_matches_autocad() { + // #2222: the 0.10 dimension of #1998 in the #2004 1:50 style. AutoCAD 2026 recomputes the + // moved text at about 0.358 from the dimension line (0.658214, 0.05). + let st = st_with(|s| { + s.scale = 50.0; + s.text_height = 0.0025; + s.text_gap = 0.0008; + s.arrow_size = 0.0015; + s.text_above = 1; + s.text_inside_horizontal = false; + s.text_outside_horizontal = false; + s.decimals = 2; + s.text_move = 2; + }); + let d = lin((0.0, 0.0), (0.0, 0.10), (0.30, 0.0), std::f64::consts::FRAC_PI_2); + let g = dimension_geometry(&d, &st, 50.0); + assert!(g.text_pos.dist(Vec2::new(0.658214, 0.05)) < 0.005, "vertical: {:?}", g.text_pos); + let d = lin((0.0, 0.0), (0.10, 0.0), (0.0, -0.30), 0.0); + let g = dimension_geometry(&d, &st, 50.0); + assert!(g.text_pos.dist(Vec2::new(0.05, -0.658214)) < 0.005, "horizontal: {:?}", g.text_pos); +} + #[test] fn text_that_does_not_fit_follows_dimtmove_1() { // Moved off the line with a leader from the middle of the dimension line. From dcbcb6ab32fc13a043a58d3e0d020029b7aa7d17 Mon Sep 17 00:00:00 2001 From: Jonas <80707953+jonascloud@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:31:17 +0100 Subject: [PATCH 25/49] fix: keep WIPEOUT closure coherent across grips and outlines (#2284) * fix: keep WIPEOUT closure coherent across grips and outlines Treat WIPEOUT as a closed polygon with an optional exact terminal closure marker, not as an open polyline. Centralize logical vertices, explicit outlines and closure-preserving vertex edits in the document type. Reuse this contract in grips, geometric primitives, rendering and DXF export without changing the stored schema or writer closure convention. Add six-version DXF ASCII/binary and DWG regressions for implicit/explicit closure, both windings, all corners, API/interactive edits, undo/redo and repeated saves. Keep open/closed polylines and their coincident endpoints distinct. Cover multiple hot grips, hostile inputs and equivalent mask/frame output. Validation: cargo xtask ci, all seven stages passed (2571 tests passed, one pre-existing skip). Two unrelated network tests failed transiently in earlier runs; each passed in isolation and the complete final run passed without exclusions. Direct and reopened grip edits produce byte-identical CLI PNG output. Fixes #2256; related test-only matrix PR #2237 and tracker #2238 B3. * fix(doc): keep coincident WIPEOUT endpoints separately editable When an edit makes the endpoints of an implicit boundary coincide, add a separate closing marker rather than reclassifying the edited corner as that marker. Retain the logical vertex count and allow either coincident corner to move independently afterwards. The document regression fails before the fix. Add API/interactive coverage for both endpoint directions and both closure forms, undo/redo, and subsequent separate edits across all six DXF/DWG versions including binary DXF and save-after-edit. Update the documented editing contract. Validation: cargo xtask ci passed all seven stages; 2573 tests passed, one pre-existing skip. Addresses the coincident-endpoint review on PR #2284; related #2256. --------- Co-authored-by: cloudj Co-authored-by: Brandon Thomas --- crates/doc/src/entity.rs | 12 +- crates/doc/src/entity/fill.rs | 5 - crates/doc/src/entity/wipeout.rs | 162 +++++++++++++++++ crates/engine/src/grips.rs | 2 +- crates/engine/src/grips/tests.rs | 15 ++ crates/engine/tests/it/main.rs | 1 + crates/engine/tests/it/wipeout_grips.rs | 227 ++++++++++++++++++++++++ crates/io/src/dxf_write/entity.rs | 9 +- crates/render/src/draw.rs | 6 +- crates/render/tests/it/wipeout_mask.rs | 37 ++++ docs/file-format-parity.md | 2 +- docs/ui-parity.md | 5 +- 12 files changed, 455 insertions(+), 28 deletions(-) create mode 100644 crates/doc/src/entity/wipeout.rs create mode 100644 crates/engine/tests/it/wipeout_grips.rs diff --git a/crates/doc/src/entity.rs b/crates/doc/src/entity.rs index 089904109..d13b82722 100644 --- a/crates/doc/src/entity.rs +++ b/crates/doc/src/entity.rs @@ -44,14 +44,16 @@ mod dim; mod fill; mod layout; mod text; +mod wipeout; pub use block::{Attrib, AttribModes, AttribProps, Insert, MultilineAttrib, mtext_literal}; pub use common::{Common, Handle, Lineweight, RawTag, Transparency}; pub use curves::{Arc, Circle, Ellipse, Face3d, Line, LwPolyline, Point, Polyline3d, RayLine, Solid}; pub use dim::{AssocSnap, DimAssoc, DimBreak, DimKind, DimMarks, Dimension, Inspection, JoggedRadius, Leader, MLeader}; -pub use fill::{Gradient, Hatch, HatchLoop, Wipeout}; +pub use fill::{Gradient, Hatch, HatchLoop}; pub use layout::{Image, Table, TableCell, Viewport}; pub use text::{HAlign, MText, MTextColumnType, MTextColumns, Text, VAlign}; +pub use wipeout::Wipeout; #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] pub struct Unknown { pub dxf_type: String, @@ -226,11 +228,7 @@ impl EntityKind { h.loops.iter().flat_map(|l| Polyline { vertices: l.vertices.clone(), closed: true }.segments()).map(Prim::Seg).collect() } EntityKind::Wipeout(w) => { - let mut pts = w.boundary.clone(); - if let Some(f) = pts.first().copied() { - pts.push(f); - } - pts.windows(2).filter_map(|w| Some(Prim::Seg(Segment::Line(GLine::new(*w.first()?, *w.get(1)?))))).collect() + w.closed_boundary().windows(2).filter_map(|w| Some(Prim::Seg(Segment::Line(GLine::new(*w.first()?, *w.get(1)?))))).collect() } EntityKind::Viewport(v) => { let c = v.center.xy(); @@ -535,7 +533,7 @@ impl EntityKind { Bounds2::new(c - h, c + h).corners().to_vec() } EntityKind::Image(i) => vec![i.insert.xy()], - EntityKind::Wipeout(w) => w.boundary.clone(), + EntityKind::Wipeout(w) => w.vertices().to_vec(), EntityKind::Table(t) => vec![t.insert.xy()], EntityKind::Tolerance(t) => vec![t.insert.xy()], EntityKind::Unknown(_) => Vec::new(), diff --git a/crates/doc/src/entity/fill.rs b/crates/doc/src/entity/fill.rs index 6790b0a7c..cff172a71 100644 --- a/crates/doc/src/entity/fill.rs +++ b/crates/doc/src/entity/fill.rs @@ -54,8 +54,3 @@ pub struct Gradient { #[serde(default)] pub centered: bool, } - -#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] -pub struct Wipeout { - pub boundary: Vec, -} diff --git a/crates/doc/src/entity/wipeout.rs b/crates/doc/src/entity/wipeout.rs new file mode 100644 index 000000000..c79e93275 --- /dev/null +++ b/crates/doc/src/entity/wipeout.rs @@ -0,0 +1,162 @@ +//! WIPEOUT is always a closed masking polygon, unlike a polyline with an open/closed flag. +//! One exact terminal copy of the first point is a closure marker, not an editable corner. +//! Preserve logical corners when editing, adding a separate marker if the endpoints meet. +//! Grips, edits and explicit outlines share this rule; other duplicates are not simplified. + +use std::borrow::Cow; + +use cadcraft_geom::Vec2; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +pub struct Wipeout { + /// Ordered boundary, implicitly closed or ending in a repeated first point. + pub boundary: Vec, +} + +impl Wipeout { + /// Editable vertices, excluding one exactly repeated closing point, without changing storage. + pub fn vertices(&self) -> &[Vec2] { + match self.boundary.split_last() { + Some((last, vertices)) if vertices.first() == Some(last) => vertices, + _ => &self.boundary, + } + } + + /// An explicitly closed outline for geometry, rendering and export. Already closed or + /// empty/single-point boundaries are borrowed; otherwise one closing point is appended. + pub fn closed_boundary(&self) -> Cow<'_, [Vec2]> { + if self.vertices().len() < self.boundary.len() || self.boundary.len() < 2 { + Cow::Borrowed(&self.boundary) + } else { + let mut points = self.boundary.clone(); + points.extend(self.boundary.first()); + Cow::Owned(points) + } + } + + /// Move an editable vertex, carrying an existing closing marker with vertex zero. If an + /// implicit boundary's endpoints meet, add a marker so both corners remain addressable. + /// Invalid indices/non-finite points leave the boundary unchanged. + pub fn set_vertex(&mut self, index: usize, to: Vec2) -> Option<()> { + let count = self.vertices().len(); + if index >= count || !to.is_finite() { + return None; + } + let explicit = count < self.boundary.len(); + *self.boundary.get_mut(index)? = to; + if explicit + && index == 0 + && let Some(last) = self.boundary.last_mut() + { + *last = to; + } + if !explicit && self.vertices().len() < count { + // The moved endpoint is a logical corner, not the newly implied closing marker. + if let Some(first) = self.boundary.first().copied() { + self.boundary.push(first); + } + } + Some(()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::EntityKind; + + #[test] + fn vertices_and_grips_exclude_only_the_exact_closing_point() { + let (a, b, c) = (Vec2::ZERO, Vec2::new(7.0, 1.0), Vec2::new(3.0, 7.0)); + let near_a = Vec2::new(1e-13, 0.0); + for (boundary, expected) in [ + (vec![], vec![]), + (vec![a], vec![a]), + (vec![a, a], vec![a]), + (vec![a, b, c], vec![a, b, c]), + (vec![a, b, c, a], vec![a, b, c]), + (vec![a, b, a, c, a], vec![a, b, a, c]), + (vec![a, b, c, a, a], vec![a, b, c, a]), + (vec![a, b, c, near_a], vec![a, b, c, near_a]), + ] { + let wipeout = Wipeout { boundary: boundary.clone() }; + assert_eq!(wipeout.vertices(), expected); + assert_eq!(EntityKind::Wipeout(wipeout.clone()).grips(), expected); + assert_eq!(wipeout.boundary, boundary); + } + } + + #[test] + fn explicit_outline_is_stable_and_does_not_add_zero_length_closing_edges() { + let points = vec![Vec2::ZERO, Vec2::new(7.0, 1.0), Vec2::new(3.0, 7.0)]; + let implicit = Wipeout { boundary: points.clone() }; + let mut expected = points.clone(); + expected.push(points[0]); + assert!(matches!(implicit.closed_boundary(), Cow::Owned(_))); + assert_eq!(implicit.closed_boundary().as_ref(), expected); + assert_eq!(implicit.boundary, points); + let explicit = Wipeout { boundary: expected.clone() }; + assert!(matches!(explicit.closed_boundary(), Cow::Borrowed(_))); + assert_eq!(explicit.closed_boundary().as_ref(), expected); + let a = EntityKind::Wipeout(implicit).prims(); + let b = EntityKind::Wipeout(explicit).prims(); + assert_eq!(a, b); + assert_eq!(a.len(), 3); + for boundary in [vec![], vec![Vec2::ZERO]] { + let wipeout = Wipeout { boundary: boundary.clone() }; + assert!(matches!(wipeout.closed_boundary(), Cow::Borrowed(_))); + assert_eq!(wipeout.closed_boundary().as_ref(), boundary); + assert!(EntityKind::Wipeout(wipeout).prims().is_empty()); + } + } + + #[test] + fn moving_endpoints_together_keeps_both_corners_editable() { + let points = [Vec2::ZERO, Vec2::new(8.0, 0.0), Vec2::new(8.0, 6.0), Vec2::new(0.0, 6.0)]; + for explicit in [false, true] { + for index in [0, 3] { + let other = 3 - index; + let mut boundary = points.to_vec(); + if explicit { + boundary.push(points[0]); + } + let mut wipeout = Wipeout { boundary }; + let mut expected = points; + expected[index] = points[other]; + for _ in 0..2 { + assert_eq!(wipeout.set_vertex(index, points[other]), Some(())); + assert_eq!(wipeout.vertices(), expected); + assert_eq!(wipeout.boundary.len(), 5, "one separate closing marker, no growth"); + } + expected[other] = Vec2::new(-2.0, 4.0); + assert_eq!(wipeout.set_vertex(other, expected[other]), Some(())); + assert_eq!(wipeout.vertices(), expected); + assert_eq!(wipeout.boundary.len(), 5); + assert_eq!(wipeout.boundary.first(), wipeout.boundary.last()); + } + } + } + + #[test] + fn editing_keeps_the_closure_but_not_other_coincident_vertices_attached() { + let (a, b, c, to) = (Vec2::ZERO, Vec2::new(7.0, 1.0), Vec2::new(3.0, 7.0), Vec2::new(2.0, 3.0)); + for explicit in [false, true] { + let mut boundary = vec![a, b, a, c]; + if explicit { + boundary.push(a); + } + let mut wipeout = Wipeout { boundary }; + assert_eq!(wipeout.set_vertex(0, to), Some(())); + let mut expected = vec![to, b, a, c]; + if explicit { + expected.push(to); + } + assert_eq!(wipeout.boundary, expected); + for (index, point) in [(4, a), (usize::MAX, a), (0, Vec2::new(f64::NAN, 0.0)), (0, Vec2::new(0.0, f64::INFINITY))] { + assert_eq!(wipeout.set_vertex(index, point), None); + assert_eq!(wipeout.boundary, expected); + } + } + } +} diff --git a/crates/engine/src/grips.rs b/crates/engine/src/grips.rs index a3b8921aa..8c58e30b5 100644 --- a/crates/engine/src/grips.rs +++ b/crates/engine/src/grips.rs @@ -239,7 +239,7 @@ pub fn stretch_grip(kind: &EntityKind, index: usize, to: Vec2) -> Option *w.boundary.get_mut(index)? = to, + EntityKind::Wipeout(w) => w.set_vertex(index, to)?, EntityKind::Unknown(_) => return None, } Some(k) diff --git a/crates/engine/src/grips/tests.rs b/crates/engine/src/grips/tests.rs index 971937704..2fc4502b6 100644 --- a/crates/engine/src/grips/tests.rs +++ b/crates/engine/src/grips/tests.rs @@ -169,6 +169,21 @@ fn other_entity_grips() { assert!(matches!(kind(&s, pt), EntityKind::Point(p) if near(p.p.xy(), 2.0, 2.0))); } +#[test] +fn wipeout_grips_reject_the_closing_marker_and_hostile_input() { + let kind = EntityKind::Wipeout(cadcraft_doc::Wipeout { boundary: vec![v(0.0, 0.0), v(7.0, 1.0), v(3.0, 7.0), v(0.0, 0.0)] }); + for (index, to) in [(3, v(2.0, 2.0)), (usize::MAX, v(2.0, 2.0)), (0, v(f64::NAN, 0.0)), (0, v(0.0, f64::INFINITY))] { + assert!(stretch_grip(&kind, index, to).is_none()); + } + for boundary in [vec![], vec![v(0.0, 0.0)], vec![v(0.0, 0.0), v(0.0, 0.0)]] { + let kind = EntityKind::Wipeout(cadcraft_doc::Wipeout { boundary }); + for index in [0, 1, usize::MAX] { + let result = stretch_grip(&kind, index, v(2.0, 2.0)); + assert_eq!(result.is_some(), index < kind.grips().len()); + } + } +} + #[test] fn grip_modes() { let mut s = Session::new(); diff --git a/crates/engine/tests/it/main.rs b/crates/engine/tests/it/main.rs index 51cec4590..8e20e6fa8 100644 --- a/crates/engine/tests/it/main.rs +++ b/crates/engine/tests/it/main.rs @@ -144,6 +144,7 @@ mod undo_layout_tab; mod viewport_clip; mod vplayer_prompts; mod vports; +mod wipeout_grips; mod xdata_follows_entity; mod zoom_keywords; mod zoom_viewport; diff --git a/crates/engine/tests/it/wipeout_grips.rs b/crates/engine/tests/it/wipeout_grips.rs new file mode 100644 index 000000000..e34620089 --- /dev/null +++ b/crates/engine/tests/it/wipeout_grips.rs @@ -0,0 +1,227 @@ +//! WIPEOUT's optional repeated closing point is not a second editable corner (#2256). +//! Authored contours keep their grips and edit results through DXF/DWG saves, both via the +//! command API and the interactive grip machine, without changing the file's explicit closure. + +use cadcraft_doc::{Drawing, EntityKind, Handle, LwPolyline, Space}; +use cadcraft_engine::{ + Input, Session, + grips::{GripMode, stretch_grip}, +}; +use cadcraft_geom::{PolyVertex, Vec2}; +use cadcraft_io::{SaveOptions, Version}; +use serde_json::json; + +fn fixture(explicit: bool, reversed: bool) -> (Drawing, Handle, Vec) { + let mut points = vec![Vec2::new(1.0, 2.0), Vec2::new(7.0, 3.0), Vec2::new(4.0, 9.0)]; + if reversed { + points.reverse(); + } + let mut input = points.clone(); + if explicit { + input.push(points[0]); + } + let mut session = Session::new(); + let input: Vec<_> = input.iter().map(|p| [p.x, p.y]).collect(); + let reply = session.execute("wipeout", &json!({"points": input})).unwrap(); + let handle = Handle::parse_hex(reply["handle"].as_str().unwrap()).unwrap(); + (session.doc().unwrap().clone(), handle, points) +} + +fn points_equal(actual: &[Vec2], expected: &[Vec2]) { + assert_eq!(actual.len(), expected.len(), "{actual:?} != {expected:?}"); + for (a, b) in actual.iter().zip(expected) { + assert!(a.near(*b, 1e-12), "{actual:?} != {expected:?}"); + } +} + +fn assert_boundary(drawing: &Drawing, handle: Handle, points: &[Vec2], explicit: bool) { + let EntityKind::Wipeout(w) = &drawing.entity(handle).unwrap().kind else { panic!("WIPEOUT lost") }; + let mut expected = points.to_vec(); + if explicit { + expected.push(points[0]); + } + points_equal(&w.boundary, &expected); +} + +fn move_grip(session: &mut Session, handle: Handle, index: usize, to: Vec2, interactive: bool) { + session.set_selection(vec![handle]); + if interactive { + session.start_grip_edit(&[(handle, index)]).unwrap(); + session.input(Input::Point(to)).unwrap(); + assert!(!session.prompting()); + } else { + session.grip_edit(handle, index, to, GripMode::Stretch).unwrap(); + } +} + +fn edit(drawing: Drawing, handle: Handle, points: &[Vec2], explicit: bool, index: usize, interactive: bool) -> Drawing { + let mut session = Session::new(); + session.open_drawing(drawing, "wipeout", None); + points_equal(&session.grips_of(handle).unwrap(), points); + let to = points[index] + Vec2::new(2.0, 1.0); + let mut expected = points.to_vec(); + expected[index] = to; + move_grip(&mut session, handle, index, to, interactive); + assert_boundary(session.doc().unwrap(), handle, &expected, explicit); + points_equal(&session.grips_of(handle).unwrap(), &expected); + session.execute("undo", &json!({})).unwrap(); + assert_boundary(session.doc().unwrap(), handle, points, explicit); + session.execute("redo", &json!({})).unwrap(); + assert_boundary(session.doc().unwrap(), handle, &expected, explicit); + session.doc().unwrap().clone() +} + +fn check(format: &str, interactive: bool) { + for explicit in [false, true] { + for reversed in [false, true] { + let (drawing, handle, points) = fixture(explicit, reversed); + for index in 0..points.len() { + edit(drawing.clone(), handle, &points, explicit, index, interactive); + } + for version in Version::ALL { + for binary in [false, true].into_iter().filter(|binary| !*binary || format == "wipeout.dxf") { + let options = SaveOptions { version: Some(version), binary }; + let mut current = drawing.clone(); + for _pass in 0..2 { + let bytes = cadcraft_io::write_with(¤t, format, &options).unwrap(); + current = cadcraft_io::read(&bytes, format).unwrap(); + assert!(current.read_notes.is_empty() && current.skipped_records.is_empty()); + assert_boundary(¤t, handle, &points, true); + for index in 0..points.len() { + let edited = edit(current.clone(), handle, &points, true, index, interactive); + let mut expected = points.clone(); + expected[index] += Vec2::new(2.0, 1.0); + let bytes = cadcraft_io::write_with(&edited, format, &options).unwrap(); + let back = cadcraft_io::read(&bytes, format).unwrap(); + assert_boundary(&back, handle, &expected, true); + } + } + } + } + } + } +} + +#[test] +fn dxf_api_grips_survive_roundtrip() { + check("wipeout.dxf", false); +} + +#[test] +fn dxf_interactive_grips_survive_roundtrip() { + check("wipeout.dxf", true); +} + +#[test] +fn dwg_api_grips_survive_roundtrip() { + check("wipeout.dwg", false); +} + +#[test] +fn dwg_interactive_grips_survive_roundtrip() { + check("wipeout.dwg", true); +} + +#[test] +fn polyline_closedness_is_not_inferred_from_coincident_endpoints() { + for closed in [false, true] { + for repeated in [false, true] { + let mut points = vec![Vec2::ZERO, Vec2::new(7.0, 1.0), Vec2::new(3.0, 7.0)]; + if repeated { + points.push(points[0]); + } + let polyline = LwPolyline { + vertices: points.iter().copied().map(PolyVertex::new).collect(), + closed, + const_width: 0.0, + elevation: 0.0, + plinegen: false, + }; + let kind = EntityKind::LwPolyline(polyline); + let segments = if repeated || closed { 3 } else { 2 }; + assert_eq!(kind.prims().len(), segments); + assert_eq!(kind.grips().len(), points.len() + segments); + let to = Vec2::new(2.0, 3.0); + let EntityKind::LwPolyline(edited) = stretch_grip(&kind, 0, to).unwrap() else { panic!("polyline") }; + assert_eq!(edited.closed, closed); + let mut expected = points.clone(); + expected[0] = to; + assert_eq!(edited.vertices.iter().map(|v| v.p).collect::>(), expected); + + // WIPEOUT conversion requires the closed flag, even with coincident endpoints. + let mut session = Session::new(); + let handle = session.doc_mut().unwrap().add(&Space::Model, Default::default(), kind).unwrap(); + let result = session.execute("wipeout", &json!({"handle": handle.hex()})); + assert_eq!(result.is_ok(), closed); + if let Ok(result) = result { + let wipeout = Handle::parse_hex(result["handle"].as_str().unwrap()).unwrap(); + assert_boundary(session.doc().unwrap(), wipeout, &points[..3], repeated); + points_equal(&session.grips_of(wipeout).unwrap(), &points[..3]); + } else { + assert_eq!(session.doc().unwrap().model.len(), 1); + } + } + } +} + +#[test] +fn coincident_endpoints_remain_separately_editable_after_save() { + let original = [Vec2::ZERO, Vec2::new(8.0, 0.0), Vec2::new(8.0, 6.0), Vec2::new(0.0, 6.0)]; + for explicit in [false, true] { + for interactive in [false, true] { + for index in [0, 3] { + let other = 3 - index; + let mut input: Vec<_> = original.iter().map(|p| [p.x, p.y]).collect(); + if explicit { + input.push(input[0]); + } + let mut session = Session::new(); + let reply = session.execute("wipeout", &json!({"points": input})).unwrap(); + let handle = Handle::parse_hex(reply["handle"].as_str().unwrap()).unwrap(); + let mut coincident = original; + coincident[index] = original[other]; + move_grip(&mut session, handle, index, coincident[index], interactive); + points_equal(&session.grips_of(handle).unwrap(), &coincident); + assert_boundary(session.doc().unwrap(), handle, &coincident, true); + session.undo().unwrap(); + assert_boundary(session.doc().unwrap(), handle, &original, explicit); + session.execute("redo", &json!({})).unwrap(); + points_equal(&session.grips_of(handle).unwrap(), &coincident); + let collapsed = session.doc().unwrap().clone(); + for version in Version::ALL { + for (format, binary) in [("wipeout.dxf", false), ("wipeout.dxf", true), ("wipeout.dwg", false)] { + let options = SaveOptions { version: Some(version), binary }; + let bytes = cadcraft_io::write_with(&collapsed, format, &options).unwrap(); + let back = cadcraft_io::read(&bytes, format).unwrap(); + session.open_drawing(back, "coincident corners", None); + points_equal(&session.grips_of(handle).unwrap(), &coincident); + assert_boundary(session.doc().unwrap(), handle, &coincident, true); + let mut separated = coincident; + separated[other] = Vec2::new(-2.0, 4.0); + move_grip(&mut session, handle, other, separated[other], interactive); + points_equal(&session.grips_of(handle).unwrap(), &separated); + assert_boundary(session.doc().unwrap(), handle, &separated, true); + let bytes = cadcraft_io::write_with(session.doc().unwrap(), format, &options).unwrap(); + let back = cadcraft_io::read(&bytes, format).unwrap(); + assert_boundary(&back, handle, &separated, true); + } + } + } + } + } +} + +#[test] +fn multiple_hot_grips_keep_the_closing_point_attached() { + let (drawing, handle, mut points) = fixture(true, false); + let mut session = Session::new(); + session.open_drawing(drawing, "wipeout", None); + session.set_selection(vec![handle]); + session.start_grip_edit(&[(handle, 0), (handle, 1)]).unwrap(); + let delta = Vec2::new(2.0, 1.0); + session.input(Input::Point(points[0] + delta)).unwrap(); + points[0] += delta; + points[1] += delta; + assert_boundary(session.doc().unwrap(), handle, &points, true); + points_equal(&session.grips_of(handle).unwrap(), &points); +} diff --git a/crates/io/src/dxf_write/entity.rs b/crates/io/src/dxf_write/entity.rs index cd41cdf91..9c2f12896 100644 --- a/crates/io/src/dxf_write/entity.rs +++ b/crates/io/src/dxf_write/entity.rs @@ -665,14 +665,9 @@ fn write_wipeout_entity(w: &mut W, _d: &Drawing, e: &Entity, owner: &str, paper: w.i(282, 50); w.i(283, 0); w.i(71, 2); - let mut pts = wo.boundary.clone(); - if let (Some(first), Some(last)) = (pts.first().copied(), pts.last().copied()) - && first != last - { - pts.push(first); - } + let pts = wo.closed_boundary(); w.i(91, pts.len() as i64); - for q in pts { + for q in pts.iter() { w.p2(14, Vec2::new((q.x - o.x) / sx - 0.5, 0.5 - (q.y - o.y) / sy)); } } diff --git a/crates/render/src/draw.rs b/crates/render/src/draw.rs index 04e2651c5..cf37e28f7 100644 --- a/crates/render/src/draw.rs +++ b/crates/render/src/draw.rs @@ -294,11 +294,7 @@ fn draw_wipeout(b: &mut Builder, ctx: &Ctx, w: &cadcraft_doc::Wipeout, rgb: Ink, _ => true, }; if frame { - let mut pts = w.boundary.clone(); - if let Some(f) = pts.first().copied() { - pts.push(f); - } - b.polyline(ctx, rgb, lw, &pts); + b.polyline(ctx, rgb, lw, &w.closed_boundary()); } } diff --git a/crates/render/tests/it/wipeout_mask.rs b/crates/render/tests/it/wipeout_mask.rs index 508b052b6..6c9531988 100644 --- a/crates/render/tests/it/wipeout_mask.rs +++ b/crates/render/tests/it/wipeout_mask.rs @@ -59,6 +59,43 @@ fn wipeout_hides_what_is_drawn_before_it() { assert!(inside > 0); } +#[test] +fn implicit_and_explicit_closure_draw_the_same_mask_and_frame() { + for reversed in [false, true] { + let mut implicit = drawing(false); + let handle = implicit.model.iter().find(|e| matches!(e.kind, EntityKind::Wipeout(_))).unwrap().handle; + if reversed { + implicit.model.modify(handle, |e| { + let EntityKind::Wipeout(w) = &mut e.kind else { panic!("wipeout") }; + w.boundary.reverse(); + }); + } + let mut explicit = implicit.clone(); + explicit.model.modify(handle, |e| { + let EntityKind::Wipeout(w) = &mut e.kind else { panic!("wipeout") }; + w.boundary.push(w.boundary[0]); + }); + for frame in [0, 1, 2] { + implicit.header.set_i64("WIPEOUTFRAME", frame); + explicit.header.set_i64("WIPEOUTFRAME", frame); + for plot in [false, true] { + let draw = if plot { build_plot } else { build }; + let a = draw(&implicit, &Space::Model, &Options::default()); + let b = draw(&explicit, &Space::Model, &Options::default()); + assert_eq!(a.prims, b.prims); + assert_eq!(a.verts, b.verts); + assert_eq!(a.tris, b.tris); + for primitive in b.prims.iter().filter(|p| p.handle == handle && p.kind == Kind::Polyline) { + let points = b.points(primitive); + assert_eq!(points.len(), 5, "four corners and exactly one closing point"); + assert_eq!(points.first(), points.last()); + } + assert_eq!(dark_pixels(&a), dark_pixels(&b)); + } + } + } +} + #[test] fn wipeoutframe_controls_the_frame() { // Polylines in the list: the line, plus the frame when it is drawn. diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index 2bfea4a51..291c9b202 100644 --- a/docs/file-format-parity.md +++ b/docs/file-format-parity.md @@ -87,7 +87,7 @@ on read with a note, so such files no longer exceed the DXF limit (#1482). **DWG | ACAD_TABLE | yes | yes (entity + block) | | | VIEWPORT | yes | yes; frozen-layer lists kept (#150), also as standard group 341 layer handles that other programs read | DWG: the DXF→DWG converter does not yet write group 341 (frozen layers survive a CADCraft round trip via xdata); VP layer colour overrides lost (#99, PR #197) | | IMAGE | yes, with IMAGEDEF | yes, with IMAGEDEF and IMAGEDEF_REACTOR | no attach command or display of the picture yet (FF10) | -| WIPEOUT | yes | yes (#147, fixes #79) | | +| WIPEOUT | yes | yes (#147, fixes #79) | Implicit or explicit closure in memory; explicit closing point on save. Same logical grips and edit results before/after DXF/DWG round trips (#2256). | | MLINE (+ MLINESTYLE), HELIX, TOLERANCE | yes (#510, #420) | yes | | | REGION | other programs' REGIONs (ACIS data) kept as Unknown | our regions are written as closed polylines tagged with CADCraft xdata (#510; ACIS has no public spec) | | | 3DSOLID, BODY, SURFACE, MESH, SHAPE, UNDERLAY, OLE2FRAME, LIGHT, CAMERA, SECTION, POINTCLOUD, proxy entities | kept as Unknown (raw tags) | written back as read, with their CLASS records (#528); a proxy entity's class number (group 91) is renumbered to its class's place in the written CLASSES (#1812); **dropped by DWG save** (acadrust) | only their layer follows edits | diff --git a/docs/ui-parity.md b/docs/ui-parity.md index 6bf0c20f8..3522b5091 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -1,6 +1,6 @@ # UI parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-26 · **Change:** minor (browser panel layout storage) · **Target:** Autodesk AutoCAD 2027 for Mac (26.0) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-27 · **Change:** minor (WIPEOUT closure-aware grips) · **Target:** Autodesk AutoCAD 2027 for Mac (26.0) How CADCraft's interaction compares with AutoCAD's: point entry, object snaps, tracking, dynamic input, grips, selection, the command line, chrome and navigation. A drafter's speed in AutoCAD @@ -111,7 +111,7 @@ down-arrow options menu (DYNPROMPT), and DYNDIM. | Feature | AutoCAD | CADCraft | |---|---|---| -| Stretch grips per object type | yes | lines (midpoint moves), arcs (start/mid/end), ellipses (axes), polylines (vertices; segment midpoints move or reshape the bulge), dimensions (text and definition points), MLEADER, viewport, wipeout, spline (`grips.rs:79-270`) | +| Stretch grips per object type | yes | lines (midpoint moves), arcs (start/mid/end), ellipses (axes), polylines (vertices; segment midpoints move or reshape the bulge), dimensions (text and definition points), MLEADER, viewport, wipeout (one grip per logical corner, including coincident corners; an explicit closing marker follows the first vertex), spline (`grips.rs`) | | Text/MText grips | position, width, column grips | move the whole object | | Hot-grip modes with Space/Enter cycling | Stretch, Move, Rotate, Scale, Mirror | yes (`canvas.rs:58-67`) | | Hot-grip options: Base point, Copy, Undo, Reference, eXit | yes | **advertised in the prompt but not parsed**; the engine's JSON grip commands accept `copy`, the UI never passes it | @@ -204,6 +204,7 @@ down-arrow options menu (DYNPROMPT), and DYNDIM. | Date | Change | Summary | |---|---|---| +| 2026-10-27 | minor | WIPEOUT grips treat implicit and explicit closure alike; moving the first vertex carries the closing marker, and moving endpoints together keeps both corners editable. Open/closed polyline flags and coincident polyline vertices remain independent (#2256) | | 2026-10-26 | minor | Browser host stores bounded, validated panel layout separately from drawing state; malformed or unsupported records retain defaults. Native workspace storage is unchanged. | | 2026-10-22 | minor | Polyline segment midpoint grips use rectangles, distinct from square vertex grips, with matching hover and pick bounds (#1950) | | 2026-10-13 | minor | Filled-region highlight boundaries are traversed in deterministic coordinate order, fixing dash-phase jumps on CPU hover/selection redraws and GPU highlight rebuilds; CPU dash-position, pixel and GPU mesh regressions | From d15de754069bac149f2fe199310299752ebbcd0f Mon Sep 17 00:00:00 2001 From: Books Date: Fri, 30 Oct 2026 12:31:22 +1100 Subject: [PATCH 26/49] Dimensions: report the measurement as soon as one is created (#2421) (#2438) * Dimensions: fill in the measurement when one is created (#2421) A dimension made in the session kept measurement 0.0 until it was saved and reopened. add_dim now sets it with the geometry call the DXF/DWG writer uses for group 42. Block names are still assigned at save time. Test: a_new_dimension_reports_its_measurement. * Parity checklist: regenerated after merging main * Dimensions: a jogged radius dimension stores its radius as the measurement (#2421) draw_jogged_radius set the text but not DimGeometry.measurement, so DIMJOGGED dimensions kept measurement 0 (and the DXF/DWG group 42 was 0). It now sets the radius. Test: jogged_radius asserts the stored measurement. * Parity checklist: regenerated after merging main * Dimensions: fill in a new dimension's text position when it is created (#2421) A dimension made in the session kept text_mid (0,0) until it was saved and reopened. add_dim now sets it from the same dimension_geometry result as the measurement, the position the writer puts in group 11, unless the user placed the text. Test: a_new_dimension_reports_its_text_position. --------- Co-authored-by: Brandon Thomas --- crates/engine/src/cmd/annotate/common.rs | 13 ++++++++++++ crates/engine/tests/it/dim_commands.rs | 27 ++++++++++++++++++++++++ crates/render/src/dim/variants.rs | 1 + docs/parity-checklist.md | 1 + 4 files changed, 42 insertions(+) diff --git a/crates/engine/src/cmd/annotate/common.rs b/crates/engine/src/cmd/annotate/common.rs index 2267f16bf..419723288 100644 --- a/crates/engine/src/cmd/annotate/common.rs +++ b/crates/engine/src/cmd/annotate/common.rs @@ -48,6 +48,19 @@ pub(super) fn add_dim(s: &mut Session, k: EntityKind) -> Result { { dm.assoc = crate::assoc::reassociate(s.doc()?, &s.space(), dm); } + // The measurement is what the DXF/DWG writer computes from the geometry (group 42); filling it + // in now means queries show it before the drawing is saved and reopened (#2421). + if let EntityKind::Dimension(dm) = &mut k + && let Ok(d) = s.doc() + { + let style = d.dim_style(&dm.style).cloned().unwrap_or_default(); + let g = cadcraft_render::dimension_geometry(dm, &style, d.header.f64("DIMSCALE", 1.0)); + dm.measurement = g.measurement; + // The text position the writer puts in group 11 when the user has not placed the text. + if !dm.user_text_pos { + dm.text_mid = g.text_pos.to3(0.0); + } + } let h = s.add_entity(k)?; s.last_dim = Some(h); Ok(h) diff --git a/crates/engine/tests/it/dim_commands.rs b/crates/engine/tests/it/dim_commands.rs index 8e67b1039..3c5b5c90a 100644 --- a/crates/engine/tests/it/dim_commands.rs +++ b/crates/engine/tests/it/dim_commands.rs @@ -99,6 +99,7 @@ fn jogged_radius() { let (dm, g) = dim_of(&s, &h); let j = dm.marks.jogged.clone().unwrap(); assert_eq!(g.value, "R50.0000", "the true radius"); + assert!((dm.measurement - 50.0).abs() < 1e-9, "the stored measurement is the radius, got {} (#2421)", dm.measurement); assert!(j.center.xy().dist(Vec2::new(20.0, -10.0)) < 1e-9); // The line runs from the arrowhead on the circle to the override, with a 45° jog (DIMJOGANG). let tip = Vec2::new(1.0, 1.0).normalized() * 50.0; @@ -257,3 +258,29 @@ fn marks_follow_move_and_rotate_and_hostile_values_do_not_panic() { .unwrap(); let _ = dim_of(&s, &h); } + +/// A dimension made in the session reports its measurement at once, not 0.0 until it is saved +/// and reopened (#2421). +#[test] +fn a_new_dimension_reports_its_measurement() { + let mut s = Session::new(); + let measurement = |s: &Session, h: &str| dim_of(s, h).0.measurement; + let horizontal = handle(&s.execute("dimlinear", &json!({ "p1": [0, 0], "p2": [100, 0], "at": [50, 20] })).unwrap()); + assert!((measurement(&s, &horizontal) - 100.0).abs() < 1e-9, "{}", measurement(&s, &horizontal)); + let vertical = handle(&s.execute("dimlinear", &json!({ "p1": [0, 0], "p2": [0, 37.5], "at": [-10, 20] })).unwrap()); + assert!((measurement(&s, &vertical) - 37.5).abs() < 1e-9, "{}", measurement(&s, &vertical)); +} + +/// A new dimension's text position is known at once, as it is after save and reopen (#2421). +#[test] +fn a_new_dimension_reports_its_text_position() { + let mut s = Session::new(); + let horizontal = handle(&s.execute("dimlinear", &json!({ "p1": [0, 0], "p2": [100, 0], "at": [50, 20] })).unwrap()); + let vertical = handle(&s.execute("dimlinear", &json!({ "p1": [0, 0], "p2": [0, 37.5], "at": [-20, 18] })).unwrap()); + for h in [&horizontal, &vertical] { + let (dm, g) = dim_of(&s, h); + assert!(dm.text_mid.xy().dist(g.text_pos) < 1e-9, "stored {:?}, drawn at {:?}", dm.text_mid, g.text_pos); + assert!(dm.text_mid.xy().dist(Vec2::ZERO) > 1.0, "still at the origin: {:?}", dm.text_mid); + } + assert!((dim_of(&s, &horizontal).0.text_mid.x - 50.0).abs() < 1e-9); +} diff --git a/crates/render/src/dim/variants.rs b/crates/render/src/dim/variants.rs index 240b5e88d..948483a54 100644 --- a/crates/render/src/dim/variants.rs +++ b/crates/render/src/dim/variants.rs @@ -27,6 +27,7 @@ pub(super) fn draw_jogged_radius(config: &DimConfig<'_>, g: &mut DimGeometry, te if !r.is_finite() { break 'jogged; } + g.measurement = r; let (tw, _) = measure(&g.mtext); let u = (tip - center).normalized(); let u = if u == Vec2::ZERO || !u.is_finite() { Vec2::X } else { u }; diff --git a/docs/parity-checklist.md b/docs/parity-checklist.md index ee0358f9e..d0bd6f967 100644 --- a/docs/parity-checklist.md +++ b/docs/parity-checklist.md @@ -1,5 +1,6 @@ # Parity checklist +> **Generated:** 2026-10-29 by `cargo xtask parity`. Do not edit by hand. > **Generated:** 2026-10-28 by `cargo xtask parity`. Do not edit by hand. Menu-breadth parity: a reference menu item counts as covered when a CADCraft command is registered under the same menu label. It measures breadth, not depth; see [target-app-parity.md](target-app-parity.md) for the weighted assessment. From 42667d1332ce9e9922771b8599caee796106190c Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Fri, 30 Oct 2026 08:31:26 +0700 Subject: [PATCH 27/49] ELLIPSE from axis endpoints matches what AutoCAD stores (#2197) * ELLIPSE from axis endpoints matches what AutoCAD stores Typed ELLIPSE input was checked against AutoCAD 2024 black-box (synthetic input in accoreconsole, read back with entget); three rules differed: - The major axis pointed at the second axis endpoint; AutoCAD points it at the first. A full ellipse looks the same, but an elliptical arc's angles are measured from that axis, so the arc was drawn on the opposite side of the center, and the stored major vector, start point and quadrant order all differed. - A point at "Specify distance to other axis" gave its distance from the first axis; AutoCAD takes its distance from the center (the rubber band), then swaps the axes when it is the longer one. - The end-angle prompt had no Included angle option, so `_I` was rejected and the next number became an absolute end angle. AutoCAD adds the included angle (default 180) to the start angle. The JSON form (ellipse.axis / ellipse.arc with p1, p2, p3) follows the same rules. The regression test pins ten AutoCAD-measured cases, among them survey (VN-2000) coordinates, a near-millimetre ellipse and both Included angle cases. Co-Authored-By: Claude Opus 5.5 * docs: geometry parity says which part was measured against AutoCAD The "How this was measured" section still said no numeric comparison against AutoCAD had been run, next to the new ELLIPSE revision row that reports one. It now names the 11 measured ELLIPSE cases and the test that pins them, and keeps the rest of the document marked as read from the source. Pointed out in review. Co-Authored-By: Claude Opus 5.5 * ellipse: drop the import the axis-endpoint change left unused --------- Co-authored-by: Claude Opus 5.5 Co-authored-by: Brandon Thomas --- crates/engine/src/cmd/draw/ellipse.rs | 47 +++++++++-- crates/engine/src/cmd/draw2.rs | 2 +- crates/engine/src/cmd/draw2/ellipse.rs | 11 ++- crates/engine/src/cmd/draw2/tests.rs | 112 +++++++++++++++++++++++++ docs/geometry-parity.md | 14 ++-- 5 files changed, 165 insertions(+), 21 deletions(-) diff --git a/crates/engine/src/cmd/draw/ellipse.rs b/crates/engine/src/cmd/draw/ellipse.rs index c1e7967d9..b1cd56927 100644 --- a/crates/engine/src/cmd/draw/ellipse.rs +++ b/crates/engine/src/cmd/draw/ellipse.rs @@ -34,19 +34,24 @@ pub(super) struct EllipseM { /// The `Parameter` option: arc start/end values are ellipse parameters, not true angles. param: bool, start: Option, + /// The `Included angle` option: the next value is the arc's angle from its start angle. + included: bool, /// The Isocircle option (isometric snap style) in progress. iso: Option, } impl EllipseM { fn axis(&self) -> Option<(Vec2, Vec2)> { - // (center, major vector) + // (center, major vector): towards the first axis endpoint, as AutoCAD stores it. match (self.center_mode, self.pts.as_slice()) { (true, [c, e, ..]) => Some((*c, *e - *c)), - (false, [a, b, ..]) => Some((a.mid(*b), *b - a.mid(*b))), + (false, [a, b, ..]) => Some((a.mid(*b), *a - a.mid(*b))), _ => None, } } + /// The other half axis reaches as far as `other` is from the center (AutoCAD measures the + /// picked point's distance from the center, not from the first axis). Longer than the + /// first half axis, it becomes the major axis: the first axis turned 90° counterclockwise. fn build(&self, other: Vec2) -> Option { let (c, m) = self.axis()?; let ml = m.len(); @@ -54,7 +59,7 @@ impl EllipseM { return None; } let u = m / ml; - let minor = ((other - c).dot(u.perp())).abs(); + let minor = (other - c).len(); let (major, ratio) = if minor > ml { (u.perp() * minor, ml / minor) } else { (m, minor / ml) }; (ratio > 1e-9).then_some(Ellipse::full(c, major, ratio.min(1.0))) } @@ -88,13 +93,16 @@ impl Interactive for EllipseM { } fn prompt(&self, s: &Session) -> Prompt { if let Some(e) = &self.ellipse { - let msg = match (self.start.is_none(), self.param) { - (true, false) => "Specify start angle", - (false, false) => "Specify end angle", - (true, true) => "Specify start parameter", - (false, true) => "Specify end parameter", + if self.included { + return Prompt::new("Specify included angle for arc", Accept::POINT_OR_NUMBER).default("180").base(e.center); + } + let (msg, kw): (&str, &[&str]) = match (self.start.is_none(), self.param) { + (true, false) => ("Specify start angle", &["Parameter"]), + (false, false) => ("Specify end angle", &["Parameter", "Included angle"]), + (true, true) => ("Specify start parameter", &["Angle"]), + (false, true) => ("Specify end parameter", &["Angle"]), }; - return Prompt::new(msg, Accept::POINT_OR_NUMBER).kw(if self.param { &["Angle"] } else { &["Parameter"] }).base(e.center); + return Prompt::new(msg, Accept::POINT_OR_NUMBER).kw(kw).base(e.center); } if let Some(iso) = &self.iso { return iso.prompt(); @@ -112,11 +120,32 @@ impl Interactive for EllipseM { fn input(&mut self, s: &mut Session, i: Input) -> Result { if let Some(e) = self.ellipse { let ge = Ellipse { start: 0.0, end: cadcraft_geom::TAU, ..e }; + if self.included { + let incl = match i { + Input::Point(p) => (p - e.center).angle(), + Input::Text(t) => s.angle_settings().amount(&t).ok_or_else(|| crate::EngineError::Other("Requires an angle.".into()))?, + Input::Enter => std::f64::consts::PI, + _ => return Ok(Step::Continue), + }; + // A true angle added to the start angle (AutoCAD: start 214.659°, included + // 232.716° ends the arc at 87.375° from the major axis). + let st = self.start.unwrap_or(0.0); + let end = ge.param_of(e.center + Vec2::from_angle((ge.at_param(st) - e.center).angle() + incl)); + s.add_entity(EntityKind::Ellipse(cadcraft_doc::Ellipse { + center: v3(e.center), + major: v3(e.major), + ratio: e.ratio, + start: st, + end, + }))?; + return Ok(Step::Done); + } let ang = match i { Input::Keyword(k) => { match k.as_str() { "Parameter" => self.param = true, "Angle" => self.param = false, + "Included angle" if self.start.is_some() && !self.param => self.included = true, _ => {} } return Ok(Step::Continue); diff --git a/crates/engine/src/cmd/draw2.rs b/crates/engine/src/cmd/draw2.rs index b37ebbc68..003edf2a8 100644 --- a/crates/engine/src/cmd/draw2.rs +++ b/crates/engine/src/cmd/draw2.rs @@ -105,7 +105,7 @@ pub fn specs() -> Vec { .interactive(|_| Ok(Box::new(TanCircleM::new(false)))), CommandSpec::new("ellipse.axis", "Axis, End", run_ellipse_axis) .menu(&["Draw", "Ellipse", "Axis, End"]) - .params("{p1, p2, distance} | {p1, p2, p3} (axis endpoints, then half the other axis)") + .params("{p1, p2, distance} | {p1, p2, p3} (axis endpoints, then half the other axis: a distance, or a point that far from the center)") .interactive(|_| Ok(super::draw::ellipse_machine(false, false))), CommandSpec::new("ellipse.arc", "Elliptical Arc", run_ellipse_arc) .menu(&["Draw", "Ellipse", "Arc"]) diff --git a/crates/engine/src/cmd/draw2/ellipse.rs b/crates/engine/src/cmd/draw2/ellipse.rs index e699eac58..430effa6b 100644 --- a/crates/engine/src/cmd/draw2/ellipse.rs +++ b/crates/engine/src/cmd/draw2/ellipse.rs @@ -1,10 +1,11 @@ -use super::{Ellipse, EntityKind, Line, Result, Session, TAU, Value, Vec2, added, bad, f64_req, point_param, point_req, v3}; +use super::{Ellipse, EntityKind, Result, Session, TAU, Value, Vec2, added, bad, f64_req, point_param, point_req, v3}; // ---------------- ellipse entries ---------------- fn ellipse_from_axis(p1: Vec2, p2: Vec2, half: f64) -> Option { let c = p1.mid(p2); - let m = p2 - c; + // The major axis points at the first endpoint, as AutoCAD stores it. + let m = p1 - c; let ml = m.len(); let half = half.abs(); if ml < 1e-12 || half < 1e-12 || !half.is_finite() { @@ -17,10 +18,8 @@ fn axis_ellipse_params(cmd: &str, p: &Value) -> Result { let p1 = point_req(cmd, p, "p1")?; let p2 = point_req(cmd, p, "p2")?; let half = match point_param(p, "p3") { - Some(p3) => { - let ax = Line::new(p1, p2); - ax.project(p3).dist(p3) - } + // As at the prompt: the point's distance from the center, not from the first axis. + Some(p3) => p3.dist(p1.mid(p2)), None => f64_req(cmd, p, "distance")?, }; ellipse_from_axis(p1, p2, half).ok_or_else(|| bad(cmd, "degenerate ellipse")) diff --git a/crates/engine/src/cmd/draw2/tests.rs b/crates/engine/src/cmd/draw2/tests.rs index b5585e381..8eedd3772 100644 --- a/crates/engine/src/cmd/draw2/tests.rs +++ b/crates/engine/src/cmd/draw2/tests.rs @@ -270,6 +270,118 @@ fn ellipse_arc_typed_angles_are_true_angles() { } } +/// Typed ELLIPSE input against what AutoCAD 2024 stores for the same input (black-box: synthetic +/// input in accoreconsole, read back with `entget`). The major axis points at the first axis +/// endpoint; a point at the distance prompt gives its distance from the center; an other axis +/// longer than the first becomes the major axis, the first turned 90° counterclockwise; the +/// Included angle is added to the start angle. +#[test] +fn ellipse_axis_endpoints_match_autocad() { + type Case = (&'static str, [f64; 2], [f64; 2], f64, Option<[f64; 2]>); + // (input after ELLIPSE, center, major axis, ratio, arc start/end parameters) + let cases: [Case; 10] = [ + // The other axis (27.02) is longer than the first half axis (26.42). + ( + "16.459468652708743,28.120073391143574 -5.034438825478263,-20.14843889196848 27.021868057769268", + [5.712514913615239, 3.985817249587547], + [-24.6850622596004, 10.99222700689644], + 0.9776866627982613, + None, + ), + ( + "33.45015752893423,-27.997665254733153 1.0902141405158297,-9.876490849047837 _R 36.361957504949", + [17.27018583472502, -18.93707805189049], + [16.1799716942092, -9.060587202842658], + 0.8052876303433125, + None, + ), + ( + "0.5161247992610992,0.27380397971284964 0.49874786589184156,0.23294359917255586 0.0026647279687818256", + [0.5074363325764704, 0.2533737894427027], + [0.00868846668462886, 0.02043019027014691], + 0.1200276615332929, + None, + ), + // Arcs: the angles are taken from the major axis, so a reversed axis draws the arc + // on the opposite side of the center. + ( + "_A 612354.66928411,2398796.595432055 612364.9910379789,2398751.70959102 3.5361631006792016 259.40675054209663 162.0895061623204", + [612359.8301610444, 2398774.152511537], + [-5.160876934416592, 22.44292051764205], + 0.1535548572193783, + Some([4.683678586016272, 2.014340486820176]), + ), + ( + "_A -32.49789607178266,25.826299666765127 16.360636510348964,-6.670894598441254 9.326202777586586 _P 235.35128996877393 341.0349294763654", + [-8.068629780716847, 9.577702534161936], + [-24.42926629106581, 16.24859713260318], + 0.317871961092373, + Some([4.107654908771007, 5.952182383669234]), + ), + ( + "_A _C 15.895131938563559,-16.135236520373613 1.9672122380661037,-18.61293795336168 14.456880177932417 214.65903577683966 _I 232.7163597705933", + [15.89513193856356, -16.13523652037361], + [2.53204749973717, -14.23341561039267], + 0.9785367111972643, + Some([3.756694588158375, 1.5259701966906878]), + ), + ( + "_A _C 1.8822645373261935,-7.920292708078534 28.89115893105938,-23.280023918605742 38.7551404612689 136.20071263173944 _I 129.90755425686075", + [1.882264537326193, -7.920292708078534], + [19.15838502833398, 33.68853210335513], + 0.8017236937148501, + Some([2.267136066480607, 4.657903136501946]), + ), + // The other axis given by a point. + ( + "-16.377480557612035,55.44699770062272 -15.579405511585826,-24.406726331471475 -4.27081078679767,42.69814401696656", + [-15.97844303459893, 15.52013568457562], + [-0.3990375230131046, 39.92686201604709], + 0.7411292927991227, + None, + ), + ( + "8.137326847228081,16.045209411091605 -2.4500932561568627,22.585405165312338 -2.4956573993017335,12.374292543621266", + [2.843616795535609, 19.31530728820197], + [4.602217644463162, 7.450176331143755], + 0.7105482899194384, + None, + ), + ( + "_C 15.418189586495892,-18.741133769301225 43.29367724019212,5.337090633133826 12.043993630141971,-7.0535727363182446", + [15.41818958649589, -18.74113376930122], + [27.87548765369622, 24.07822440243505], + 0.3302549104883693, + None, + ), + ]; + use std::f64::consts::{PI, TAU}; + let same = |a: f64, b: f64| (a - b).abs() <= 1e-9 * a.abs().max(b.abs()).max(1.0); + let same_angle = |a: f64, b: f64| { + let d = (a - b).rem_euclid(TAU); + d < 1e-9 || TAU - d < 1e-9 + }; + for (input, center, major, ratio, arc) in cases { + let mut s = Session::new(); + s.cmdline(&format!("ellipse {input}")).unwrap(); + assert!(s.running.is_none(), "{input}: {}", s.prompt_text()); + let EntityKind::Ellipse(e) = last(&s) else { panic!("{input}: no ellipse") }; + assert!(same(e.center.x, center[0]) && same(e.center.y, center[1]), "{input}: center {:?}", e.center); + assert!(same(e.major.x, major[0]) && same(e.major.y, major[1]), "{input}: major {:?}", e.major); + assert!(same(e.ratio, ratio), "{input}: ratio {}", e.ratio); + let [start, end] = arc.unwrap_or([0.0, TAU]); + assert!(same_angle(e.start, start) && same_angle(e.end, end), "{input}: {} {}", e.start, e.end); + } + // Enter takes the default included angle, 180°: half the ellipse. + let mut s = Session::new(); + s.cmdline("ellipse _A 10,0 -10,0 5 30 _I").unwrap(); + assert!(s.prompt_text().contains("included angle"), "{}", s.prompt_text()); + s.input(Input::Enter).unwrap(); + assert!(s.running.is_none(), "{}", s.prompt_text()); + let EntityKind::Ellipse(e) = last(&s) else { panic!("no ellipse") }; + assert!(same_angle(e.end, e.start + PI), "{} {}", e.start, e.end); +} + // ---------------- DIVIDE / MEASURE ---------------- #[test] diff --git a/docs/geometry-parity.md b/docs/geometry-parity.md index 3809c637f..6c11686a6 100644 --- a/docs/geometry-parity.md +++ b/docs/geometry-parity.md @@ -1,6 +1,6 @@ # Geometry parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-26 · **Change:** minor (PEDIT Multiple at the command line) · **Target:** Autodesk AutoCAD 2027 +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-26 · **Change:** minor (ELLIPSE axis endpoints, other-axis point and Included angle as AutoCAD stores them) · **Target:** Autodesk AutoCAD 2027 CAD users trust numbers: a trimmed endpoint, an offset, an intersection or an area is either right to the last displayed digit or the tool is unusable for production drawings. This document @@ -18,10 +18,13 @@ drawings behave differently from mid-sized ones. 3D geometry doesn't exist. Rema ## How this was measured -Read from the source on 2026-10-10 (main at bd2412f), with file:line evidence in the tables. No -numeric comparison against AutoCAD has been run yet: the plan is a set of synthetic drawings whose -exact answers are known analytically, measured in both apps black-box (LIST, ID, AREA results) -and in CADCraft headless. Until then the percentages are judgements. +Read from the source on 2026-10-10 (main at bd2412f), with file:line evidence in the tables. The +one numeric comparison against AutoCAD so far is ELLIPSE from axis endpoints (2026-10-26): 11 +typed inputs measured black-box in AutoCAD 2024 (accoreconsole, read back with `entget`) and +pinned by `ellipse_axis_endpoints_match_autocad`. Everything else is still to be measured: the +plan is a set of synthetic drawings whose exact answers are known analytically, measured in both +apps black-box (LIST, ID, AREA results) and in CADCraft headless. Until then the percentages are +judgements. Weights (how much AutoCAD users lean on each area in 2D drafting): numeric robustness 15%, curve representation 10%, intersections 15%, offsets 15%, trim/extend/fillet/chamfer/break/join @@ -157,6 +160,7 @@ Total ≈ 90–140 h; items 1–6 parallelise across two or three agents. | Date | Change | Summary | |---|---|---| +| 2026-10-26 | minor | ELLIPSE from axis endpoints matches AutoCAD's stored geometry: the major axis points at the first endpoint (arcs drew on the opposite side of the center), a point at the other-axis prompt gives its distance from the center, and the end-angle prompt offers Included angle | | 2026-10-26 | minor | PEDIT Multiple at the command line (#2182): select objects, lines and arcs turned into polylines on Yes, then Close/Open/Join/Width/Fit/Spline/Decurve/Ltype gen/Reverse/Undo apply to all; Join joins the selected objects with each other within a fuzz distance | | 2026-10-22 | minor | Constraint expressions count operator chains toward the syntax-tree depth limit; evaluation shares one depth limit across operators and parameter references, with a 1 MiB-stack regression (#1936) | | 2026-10-14 | trivial | JOIN Close: a single arc becomes its circle, a single elliptical arc its full ellipse (#1175) | From 912558635e40d252c95c2dcc0b429c49b9bd1e1d Mon Sep 17 00:00:00 2001 From: Books Date: Fri, 30 Oct 2026 12:31:29 +1100 Subject: [PATCH 28/49] DWG: keep block draw-order sort handles through the DXF bridge (#2410) (#2439) * DWG: keep block draw-order sort handles through the DXF bridge (#2410) acadrust's DXF writer renumbers SORTENTSTABLE sort handles past every entity handle, so an entity left out of a table (sorted by its own handle) drew below every listed one. The table now carries its codes verbatim before writing. Tests in io/tests/it/sortents.rs; the bridge test fails without the fix. * Parity checklist: regenerated after merging main * DXF: a block/space sort handle of 0 draws last (#2439) A SORTENTSTABLE sort handle of 0 means the entity is drawn after every other (ezdxf reorder.py, which notes AutoCAD defines it). apply_sortents sorted it first; key it after all nonzero handles. Test: a_zero_sort_handle_draws_last (DXF and DWG bridge). * Parity checklist: regenerated after merging main * Draw order: test two block entities left out of a SORTENTSTABLE (#2439) Each unlisted entity must sort by its own handle, landing between the listed ones. A single fallback key for all of them would put them side by side. Checked in a DXF and across the DWG bridge; test-only. --------- Co-authored-by: Brandon Thomas --- crates/dwg/src/lib.rs | 22 +++++++ crates/io/src/dxf_read/document.rs | 6 +- crates/io/tests/it/sortents.rs | 93 ++++++++++++++++++++++++++++++ 3 files changed, 120 insertions(+), 1 deletion(-) diff --git a/crates/dwg/src/lib.rs b/crates/dwg/src/lib.rs index 8abb696b5..7e4a88fee 100644 --- a/crates/dwg/src/lib.rs +++ b/crates/dwg/src/lib.rs @@ -107,6 +107,7 @@ mod native { current_style_names(&mut doc); table_merges(&mut doc); table_style_rows(&mut doc, false); + keep_sort_handles(&mut doc); let orphans = drop_orphaned_dgn_components(&mut doc); if orphans > 0 { let (s, were) = if orphans == 1 { ("", "was") } else { ("s", "were") }; @@ -265,6 +266,27 @@ mod native { } } + /// Draw-order tables (SORTENTSTABLE) keep the sort handles the file gave them. acadrust's DXF + /// writer renumbers them past every entity handle, but an entity left out of a table sorts by + /// its own handle, so after renumbering it would draw below every listed entity (#2410). Giving + /// the table its codes verbatim makes the writer emit them unchanged. + fn keep_sort_handles(doc: &mut acadrust::CadDocument) { + use acadrust::objects::ObjectType; + let version = doc.version; + for o in doc.objects.values_mut() { + let ObjectType::SortEntitiesTable(t) = o else { continue }; + let hex = |h: acadrust::types::Handle| format!("{:X}", h.value()); + let mut codes = + vec![(5, hex(t.handle)), (330, hex(t.owner_handle)), (100, "AcDbSortentsTable".to_string()), (330, hex(t.block_owner_handle))]; + for e in t.entries() { + codes.push((331, hex(e.entity_handle))); + codes.push((5, hex(e.sort_handle))); + } + t.raw_dxf_codes = Some(codes); + t.raw_dxf_version = Some(version); + } + } + /// Table styles' title and header suppression between the two places acadrust 0.6.3 keeps /// it. 2010+ (AC1024+) DWG stores it only in the style's flags (title 1, header 2), while /// acadrust's DXF reader and writer use the `title_suppressed`/`header_suppressed` fields diff --git a/crates/io/src/dxf_read/document.rs b/crates/io/src/dxf_read/document.rs index 2e16afbf3..02ea0f532 100644 --- a/crates/io/src/dxf_read/document.rs +++ b/crates/io/src/dxf_read/document.rs @@ -311,7 +311,11 @@ pub(super) fn apply_sortents( for (owner, map) in tables { let Some(name) = brs.get(owner) else { continue }; let up = name.to_ascii_uppercase(); - let key = |e: &Entity| map.get(&e.handle).copied().unwrap_or(e.handle.0); + // A sort handle of 0 draws last (ezdxf `reorder`, which notes AutoCAD defines it, undocumented). + let key = |e: &Entity| { + let k = map.get(&e.handle).copied().unwrap_or(e.handle.0); + (k == 0, k) + }; if up == "*MODEL_SPACE" { d.model.sort_by_key(key); } else if up.starts_with("*PAPER_SPACE") { diff --git a/crates/io/tests/it/sortents.rs b/crates/io/tests/it/sortents.rs index 0be17e910..35b3e0dab 100644 --- a/crates/io/tests/it/sortents.rs +++ b/crates/io/tests/it/sortents.rs @@ -46,3 +46,96 @@ fn broken_sortentstables_are_ignored() { assert_eq!(order(&d), ["A1", "A2", "A3"], "{table:?}"); } } + +/// A block whose SORTENTSTABLE leaves out the circle (it sorts by its own handle) draws the +/// wipeout, the circle, then the two lines (#2410). +fn block_dxf() -> String { + block_dxf_with("331\n25B\n5\n25D\n331\n25D\n5\n25E\n331\n25E\n5\n25B\n") +} + +fn block_dxf_with(entries: &str) -> String { + let rec = |h: &str, n: &str| format!("0\nBLOCK_RECORD\n5\n{h}\n2\n{n}\n"); + let mut s = String::from("0\nSECTION\n2\nTABLES\n0\nTABLE\n2\nBLOCK_RECORD\n"); + s.push_str(&rec("1F", "*Model_Space")); + s.push_str(&rec("2A", "MASKED_B")); + s.push_str("0\nENDTAB\n0\nENDSEC\n0\nSECTION\n2\nBLOCKS\n0\nBLOCK\n5\n2B\n330\n2A\n8\n0\n2\nMASKED_B\n70\n0\n10\n0\n20\n0\n30\n0\n"); + let ent = |kind: &str, h: &str, body: &str| format!("0\n{kind}\n5\n{h}\n330\n2A\n8\n0\n{body}"); + s.push_str(&ent("LINE", "25B", "10\n0\n20\n0\n30\n0\n11\n10\n21\n0\n31\n0\n")); + s.push_str(&ent("CIRCLE", "25C", "10\n5\n20\n5\n30\n0\n40\n2\n")); + s.push_str(&ent("LINE", "25D", "10\n5\n20\n-5\n30\n0\n11\n5\n21\n5\n31\n0\n")); + s.push_str(&ent( + "WIPEOUT", + "25E", + "10\n0\n20\n0\n30\n0\n11\n1\n21\n0\n31\n0\n12\n0\n22\n1\n32\n0\n14\n-0.5\n24\n-0.5\n14\n9.5\n24\n-0.5\n14\n9.5\n24\n9.5\n14\n-0.5\n24\n9.5\n", + )); + s.push_str("0\nENDBLK\n5\n2C\n330\n2A\n8\n0\n0\nENDSEC\n0\nSECTION\n2\nENTITIES\n0\nENDSEC\n0\nSECTION\n2\nOBJECTS\n"); + s.push_str("0\nSORTENTSTABLE\n5\nB0\n330\nB1\n100\nAcDbSortentsTable\n330\n2A\n"); + s.push_str(entries); + s.push_str("0\nENDSEC\n0\nEOF\n"); + s +} + +fn block_kinds(d: &Drawing) -> Vec<&'static str> { + let b = d.block("MASKED_B").unwrap(); + b.entities + .iter() + .map(|e| match &e.kind { + EntityKind::Wipeout(_) => "wipeout", + EntityKind::Circle(_) => "circle", + EntityKind::Line(l) if l.b.y == l.a.y => "hline", + EntityKind::Line(_) => "vline", + _ => "other", + }) + .collect() +} + +#[test] +fn a_block_entity_left_out_of_the_table_sorts_by_its_own_handle() { + let d = cadcraft_io::read_dxf(block_dxf().as_bytes()).unwrap(); + assert_eq!(block_kinds(&d), ["wipeout", "circle", "hline", "vline"]); +} + +#[test] +fn the_block_draw_order_survives_dxf_and_dwg() { + let d = cadcraft_io::read_dxf(block_dxf().as_bytes()).unwrap(); + let dxf = cadcraft_io::read_dxf(cadcraft_io::write_dxf(&d).as_bytes()).unwrap(); + assert_eq!(block_kinds(&dxf), ["wipeout", "circle", "hline", "vline"], "DXF"); + let dwg = cadcraft_io::read(&cadcraft_io::write(&d, "t.dwg").unwrap(), "t.dwg").unwrap(); + assert_eq!(block_kinds(&dwg), ["wipeout", "circle", "hline", "vline"], "DWG"); +} + +/// The table itself (not CADCraft's reordered records) goes through the DWG bridge (#2410). +#[test] +fn a_partial_block_table_survives_the_dwg_bridge() { + let dwg = cadcraft_dwg::dxf_to_dwg(block_dxf().as_bytes()).unwrap(); + let dxf = cadcraft_dwg::dwg_to_dxf(&dwg).unwrap(); + let d = cadcraft_io::read_dxf(&dxf).unwrap(); + assert_eq!(block_kinds(&d), ["wipeout", "circle", "hline", "vline"]); +} + +/// A sort handle of 0 draws the entity last, in a DXF and across the DWG bridge (#2439). +#[test] +fn a_zero_sort_handle_draws_last() { + // The horizontal line is keyed 0 (last); the vertical line 25E; the wipeout 25B; the circle its own 25C. + let dxf = block_dxf_with("331\n25B\n5\n0\n331\n25D\n5\n25E\n331\n25E\n5\n25B\n"); + let want = ["wipeout", "circle", "vline", "hline"]; + assert_eq!(block_kinds(&cadcraft_io::read_dxf(dxf.as_bytes()).unwrap()), want, "DXF"); + let dwg = cadcraft_dwg::dxf_to_dwg(dxf.as_bytes()).unwrap(); + let back = cadcraft_io::read_dxf(&cadcraft_dwg::dwg_to_dxf(&dwg).unwrap()).unwrap(); + assert_eq!(block_kinds(&back), want, "DWG"); +} + +/// Two entities left out of the table each sort by their own handle, so they land between the +/// listed ones (a single fallback key for every unlisted entity would put them side by side) +/// in a DXF and across the DWG bridge (#2439). +#[test] +fn two_unlisted_block_entities_each_sort_by_their_own_handle() { + // Listed: the horizontal line 25B and the vertical line 25D, each under its own handle. + // Unlisted: the circle 25C and the wipeout 25E. + let dxf = block_dxf_with("331\n25B\n5\n25B\n331\n25D\n5\n25D\n"); + let want = ["hline", "circle", "vline", "wipeout"]; + assert_eq!(block_kinds(&cadcraft_io::read_dxf(dxf.as_bytes()).unwrap()), want, "DXF"); + let dwg = cadcraft_dwg::dxf_to_dwg(dxf.as_bytes()).unwrap(); + let back = cadcraft_io::read_dxf(&cadcraft_dwg::dwg_to_dxf(&dwg).unwrap()).unwrap(); + assert_eq!(block_kinds(&back), want, "DWG"); +} From 9b4c1fb840b3bd6720e09a38e2a4ff89196a5185 Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Fri, 30 Oct 2026 02:31:33 +0100 Subject: [PATCH 29/49] Reject negative or non-finite JSON chamfer distances (#2406) Found while testing crates/engine/src/cmd/modify/fillet.rs:120-121 (run_chamfer) and 53-54 (fillet_lines) Co-authored-by: Claude Haiku 5.5 Co-authored-by: Brandon Thomas --- crates/engine/src/cmd/modify/fillet.rs | 6 +++++- crates/engine/src/tests.rs | 12 ++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/crates/engine/src/cmd/modify/fillet.rs b/crates/engine/src/cmd/modify/fillet.rs index 963de2607..2a75b22e7 100644 --- a/crates/engine/src/cmd/modify/fillet.rs +++ b/crates/engine/src/cmd/modify/fillet.rs @@ -118,7 +118,11 @@ pub(super) fn run_chamfer(s: &mut Session, p: &Value) -> Result { } (None, None) => { let d1 = f64_or(p, "d1", s.doc()?.header.f64("CHAMFERA", 0.0)); - ChamferCut::Dist(d1, f64_or(p, "d2", d1)) + let d2 = f64_or(p, "d2", d1); + if !(d1.is_finite() && d1 >= 0.0 && d2.is_finite() && d2 >= 0.0) { + return Err(bad("chamfer", "`d1` and `d2` must be >= 0")); + } + ChamferCut::Dist(d1, d2) } _ => return Err(bad("chamfer", "`length` (>= 0) and `angle` (degrees, 0 to 180) go together")), }; diff --git a/crates/engine/src/tests.rs b/crates/engine/src/tests.rs index be6246824..427bfe8d4 100644 --- a/crates/engine/src/tests.rs +++ b/crates/engine/src/tests.rs @@ -1454,6 +1454,18 @@ fn hostile_variable_like_input_never_panics() { assert!(setvar_prompt_open(&s)); } +#[test] +fn chamfer_rejects_negative_distances() { + let mut s = Session::new(); + let h1 = s.execute("line", &json!({"points": [[0, 0], [10, 0]]})).unwrap(); + let h2 = s.execute("line", &json!({"points": [[0, 0], [0, 10]]})).unwrap(); + let before = format!("{:?}", s.doc().unwrap().model.iter().map(|e| e.kind.clone()).collect::>()); + let r = s.execute("chamfer", &json!({"h1": h1["handles"][0], "h2": h2["handles"][0], "p1": [5, 0], "p2": [0, 5], "d1": -3, "d2": 2})); + assert!(r.is_err(), "negative chamfer distance accepted: {r:?}"); + let after = format!("{:?}", s.doc().unwrap().model.iter().map(|e| e.kind.clone()).collect::>()); + assert_eq!(before, after); +} + #[test] fn array_counts_reject_invalid_values() { let mut s = Session::new(); From f883454d7dd4e1016a100fed90968e6825953d9d Mon Sep 17 00:00:00 2001 From: Books Date: Fri, 30 Oct 2026 12:37:44 +1100 Subject: [PATCH 30/49] DWG: post-read fix-ups run under catch_unwind; merge work is bounded (#1934) (#2402) * DWG: post-read fix-ups run under catch_unwind; merge work is bounded (#1934) table_merges and the other fix-ups on the acadrust document ran outside the panic guard, and each merge range could visit rows x cols cells with no total limit. They now run in one guarded post_process, and table_merges stops at MAX_MERGE_CELLS cells in all. Tests: merge_work_is_bounded_by_the_cell_budget, a_panic_in_post_processing_is_an_error. * Parity checklist: regenerated after merging main * DWG: test that the read and convert guards catch a panic through the public API (#2402) The existing test only exercised guarded() itself. A test-only hook now makes post_process or convert panic on entry, and tests go through dwg_to_dxf and dxf_to_dwg: both fail if their guard is removed. convert()'s fix-ups, which run on the third-party reader's document, are now under guarded() too, with their own error. * Parity checklist: regenerated after merging main * DWG: build the panic-test helpers only on native targets, like the tests that use them (#2402) PanicIn and MINIMAL_DXF referenced the native-only PANIC_IN, so the dwg tests did not compile for wasm32 (cargo check -p cadcraft-dwg --tests --target wasm32-unknown-unknown). --------- Co-authored-by: Brandon Thomas --- crates/dwg/src/lib.rs | 153 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 140 insertions(+), 13 deletions(-) diff --git a/crates/dwg/src/lib.rs b/crates/dwg/src/lib.rs index 7e4a88fee..f7bf13dd6 100644 --- a/crates/dwg/src/lib.rs +++ b/crates/dwg/src/lib.rs @@ -104,11 +104,7 @@ mod native { } let mut notes = read_notes(&outcome.stats); let mut doc = outcome.document; - current_style_names(&mut doc); - table_merges(&mut doc); - table_style_rows(&mut doc, false); - keep_sort_handles(&mut doc); - let orphans = drop_orphaned_dgn_components(&mut doc); + let orphans = guarded(AssertUnwindSafe(|| post_process(&mut doc))).map_err(|_| "the DWG post-processing failed on this file".to_string())?; if orphans > 0 { let (s, were) = if orphans == 1 { ("", "was") } else { ("s", "were") }; notes.push(format!("DWG: {orphans} DGN line style component{s} that no line style definition uses {were} left out")); @@ -238,6 +234,33 @@ mod native { /// cells already carry merges are left alone. Each range's first cell gets the span; the /// cells it covers are marked merged with no span of their own, as CADCraft's DXF writer does. fn table_merges(doc: &mut acadrust::CadDocument) { + table_merges_within(doc, MAX_MERGE_CELLS); + } + + /// The most table cells [`table_merges`] visits in one document: each range is capped, but + /// can cover rows × cols cells, so the total is bounded too. + const MAX_MERGE_CELLS: usize = 1 << 24; + + /// The fix-ups made to a document after the DWG read, returning how many orphaned DGN + /// components were dropped. The document comes from a third-party reader and is hostile. + fn post_process(doc: &mut acadrust::CadDocument) -> usize { + super::fail_in_test("post_process"); + current_style_names(doc); + table_merges(doc); + table_style_rows(doc, false); + keep_sort_handles(doc); + drop_orphaned_dgn_components(doc) + } + + /// Runs `f`, turning a panic into an error (the reader and writer are guarded the same way). + fn guarded(f: impl FnOnce() -> R + std::panic::UnwindSafe) -> Result { + std::panic::catch_unwind(f).map_err(|_| ()) + } + + /// [`table_merges`] visiting at most `budget` cells in all; a range that would pass it is + /// left unmerged. Returns the cells visited. + fn table_merges_within(doc: &mut acadrust::CadDocument, budget: usize) -> usize { + let mut left = budget; for e in doc.entities_mut() { let acadrust::entities::EntityType::Table(t) = e else { continue }; if t.merged_ranges.is_empty() || t.rows.iter().flat_map(|r| &r.cells).any(|c| c.merge_width > 1 || c.merge_height > 1) { @@ -253,6 +276,11 @@ mod native { if r.top_row > bottom || r.left_col > right || rows == 0 || cols == 0 || (r.top_row, r.left_col) == (bottom, right) { continue; } + let area = (bottom - r.top_row + 1).saturating_mul(right - r.left_col + 1); + if area > left { + continue; + } + left -= area; let span = |n: usize| i32::try_from(n + 1).unwrap_or(i32::MAX); for (ri, row) in t.rows.iter_mut().enumerate().take(bottom + 1).skip(r.top_row) { for (ci, cell) in row.cells.iter_mut().enumerate().take(right + 1).skip(r.left_col) { @@ -264,6 +292,7 @@ mod native { } } } + budget - left } /// Draw-order tables (SORTENTSTABLE) keep the sort handles the file gave them. acadrust's DXF @@ -569,14 +598,19 @@ mod native { None if doc.version < MIN_DWG_VERSION => doc.version = MIN_DWG_VERSION, None => {} } - other_layout_owners(&mut doc); - table_style_rows(&mut doc, true); - dimension_flags(&mut doc); - drop_unwritable(&mut doc); - current_dimstyle(&mut doc); - add_variable_dictionary(&mut doc); - current_text_style(&mut doc); - current_layer(&mut doc); + // The fix-ups run on the third-party reader's document, so a panic in one is an error, not a crash. + guarded(AssertUnwindSafe(|| { + super::fail_in_test("convert"); + other_layout_owners(&mut doc); + table_style_rows(&mut doc, true); + dimension_flags(&mut doc); + drop_unwritable(&mut doc); + current_dimstyle(&mut doc); + add_variable_dictionary(&mut doc); + current_text_style(&mut doc); + current_layer(&mut doc); + })) + .map_err(|_| "the DXF to DWG conversion failed on this file".to_string())?; std::panic::catch_unwind(AssertUnwindSafe(|| acadrust::DwgWriter::write_to_vec(&doc))) .map_err(|_| "the DWG writer failed on this drawing".to_string())? .map_err(|e| format!("DWG write: {e}")) @@ -673,11 +707,60 @@ mod native { } } } + + #[cfg(test)] + mod post_tests { + use super::*; + use acadrust::entities::{CellRange, EntityType, Table}; + + fn doc_with_table(rows: usize, cols: usize, ranges: usize) -> acadrust::CadDocument { + let mut t = Table::new(acadrust::types::Vector3::new(0.0, 0.0, 0.0), rows, cols); + t.merged_ranges = (0..ranges).map(|_| CellRange::new(0, 0, rows - 1, cols - 1)).collect(); + let mut doc = acadrust::CadDocument::new(); + assert!(doc.add_entity(EntityType::Table(Box::new(t))).is_ok()); + doc + } + + /// Overlapping whole-table ranges can't make the merge pass visit more than its budget (#1934). + #[test] + fn merge_work_is_bounded_by_the_cell_budget() { + let mut doc = doc_with_table(10, 10, 50); + assert_eq!(table_merges_within(&mut doc, 250), 200, "two whole-table ranges fit, the rest are skipped"); + let mut doc = doc_with_table(10, 10, 1); + assert_eq!(table_merges_within(&mut doc, usize::MAX), 100); + } + + /// A panic in the post-read fix-ups is an error, not a crash (#1934). + #[test] + fn a_panic_in_post_processing_is_an_error() { + #[allow(clippy::panic)] + let r = guarded(AssertUnwindSafe(|| -> usize { panic!("boom") })); + assert!(r.is_err()); + assert_eq!(guarded(|| 3), Ok(3)); + } + } } #[cfg(not(target_arch = "wasm32"))] pub use native::{dwg_to_dxf, dwg_to_dxf_noted, dwg_to_dxf_with, dxf_to_dwg, dxf_to_dwg_as}; +// Test-only: the stage ("post_process" or "convert") whose guard the current test checks. The +// stage then panics on entry, so a test through the public API shows whether it is guarded. +#[cfg(all(test, not(target_arch = "wasm32")))] +thread_local! { + static PANIC_IN: std::cell::Cell> = const { std::cell::Cell::new(None) }; +} + +/// Panics when a test asked for `stage` to fail (see [`PANIC_IN`]); does nothing otherwise. +#[cfg(not(target_arch = "wasm32"))] +#[allow(clippy::panic)] +fn fail_in_test(_stage: &str) { + #[cfg(test)] + if PANIC_IN.with(|p| p.get()) == Some(_stage) { + panic!("test-forced panic in {_stage}"); + } +} + /// The error for a DWG version CADCraft can't write. #[cfg_attr(target_arch = "wasm32", allow(dead_code))] fn unsupported(version: &str) -> String { @@ -710,6 +793,50 @@ pub fn dxf_to_dwg_as(_dxf: &[u8], _version: &str) -> Result, String> { mod tests { use super::*; + /// The DXF of an empty drawing, enough for the bridge to make a small DWG. + #[cfg(not(target_arch = "wasm32"))] + const MINIMAL_DXF: &str = " 0\nSECTION\n 2\nHEADER\n 9\n$ACADVER\n 1\nAC1032\n 0\nENDSEC\n 0\nEOF\n"; + + /// Makes `stage` panic on the current thread until dropped. + #[cfg(not(target_arch = "wasm32"))] + struct PanicIn; + + #[cfg(not(target_arch = "wasm32"))] + impl PanicIn { + fn at(stage: &'static str) -> Self { + PANIC_IN.with(|p| p.set(Some(stage))); + Self + } + } + + #[cfg(not(target_arch = "wasm32"))] + impl Drop for PanicIn { + fn drop(&mut self) { + PANIC_IN.with(|p| p.set(None)); + } + } + + /// The public read reports a panic in the post-read fix-ups as an error: this fails if the + /// `guarded` call around `post_process` is taken out (#2402). + #[cfg(not(target_arch = "wasm32"))] + #[test] + fn reading_a_dwg_survives_a_panic_in_post_processing() { + let dwg = dxf_to_dwg(MINIMAL_DXF.as_bytes()).unwrap(); + assert!(dwg_to_dxf(&dwg).is_ok(), "the DWG reads without the forced panic"); + let _panic = PanicIn::at("post_process"); + let err = dwg_to_dxf(&dwg).unwrap_err(); + assert!(err.contains("the DWG post-processing failed on this file"), "{err}"); + } + + /// The DXF to DWG conversion reports a panic in its fix-ups as an error, not a crash (#2402). + #[cfg(not(target_arch = "wasm32"))] + #[test] + fn converting_to_dwg_survives_a_panic_in_the_fix_ups() { + let _panic = PanicIn::at("convert"); + let err = dxf_to_dwg(MINIMAL_DXF.as_bytes()).unwrap_err(); + assert!(err.contains("the DXF to DWG conversion failed on this file"), "{err}"); + } + #[test] fn detects_magic() { assert!(is_dwg(b"AC1032\0\0\0\0")); From 2d2be155dd97212ecc3bb81dec0fe31bcb15d123 Mon Sep 17 00:00:00 2001 From: smacdmac101 <152641296+smacdmac101@users.noreply.github.com> Date: Thu, 29 Oct 2026 21:38:15 -0400 Subject: [PATCH 31/49] fix(engine): refresh attribute baselines after value changes (#2214) * xtask: the test suite and clippy pass on Windows Two Windows-only failures stopped `cargo xtask ci` before it got going on a Windows checkout (CI runs the gate on Linux only, so neither showed): - parity::tests::civil_dates built a SystemTime 115,740,740 days after the epoch (year 318857). Windows' SystemTime ends in the year 30828, so the addition panicked ("overflow when adding duration to `SystemTime`"). That case now checks `civil_from_days` on the day count, which is what it was about, on every platform. - stats.rs imported `walk` for a test that only exists on Unix, so the import was unused on Windows and `clippy -D warnings` refused it. The Unix test calls `super::walk`, as its neighbour calls `super::walk_inner`. Checked on Windows 11 x64: `cargo test --workspace` and `cargo clippy --workspace --all-targets -- -D warnings` both pass. Co-Authored-By: Claude Opus 5.5 * fix(engine): refresh attribute baselines after value changes CC-046: invalidate the derived XY baseline for changed justified attribute values, including small changes inside the writer's imported-font tolerance. Preserve no-op placement, alignment anchors and Aligned/Fit endpoints. Regression reproduced on current upstream; all three focused tests pass. Full cargo xtask ci passed all seven stages on Windows (2558 passing test executions, zero failures, one ignored). Release Trunk web build passed. Browser interaction verification is pending user dismissal of a Windows Security prompt; do not treat the build as a runtime pass. Windows validation prerequisite: original upstream PR #2198 commit a2dd814. Independent of editor/ribbon changes; reverting restores only this setter, its regression tests and corresponding file-format parity record. * fix(io): preserve insertion elevation when refreshing text baselines CC-046 review follow-up to PR #2214 comment 4377706777. Regression reproduced insertion Z 9 becoming 7. Preserve group 10 Z; test DXF independent elevations and document the DWG bridge shared elevation. Full cargo xtask ci passes all seven gates. This separate commit is reversible; reverting it restores elevation loss during baseline recomputation. Existing browser UI verification predates this writer correction. * test(engine): cover global attribute no-ops and two-point exports CC-046 review 5653054817: verify equal-value global JSON and scripted -ATTEDIT preserve imported placement, and Aligned/Fit DXF save/reopen retain both placement points and justification. Validation: cargo xtask ci passed all seven gates on this branch; git diff --check passed. Test-only follow-up, no application change. Depends on CC-046 and unchanged Windows prerequisite #2198. Revert this commit independently to remove only these assertions. Runtime evidence remains separately recorded for the production commits. --------- Co-authored-by: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/blocks/attedit.rs | 22 +- .../tests/it/attribute_value_baseline.rs | 203 ++++++++++++++++++ crates/engine/tests/it/main.rs | 1 + crates/io/src/dxf_write/common.rs | 3 +- docs/file-format-parity.md | 5 +- 5 files changed, 228 insertions(+), 6 deletions(-) create mode 100644 crates/engine/tests/it/attribute_value_baseline.rs diff --git a/crates/engine/src/cmd/blocks/attedit.rs b/crates/engine/src/cmd/blocks/attedit.rs index ad123f0b3..be59474c5 100644 --- a/crates/engine/src/cmd/blocks/attedit.rs +++ b/crates/engine/src/cmd/blocks/attedit.rs @@ -3,7 +3,7 @@ //! time or by replacing a string in all of them. Attribute tags match in any case, as in AutoCAD. use cadcraft_doc::color::Color; -use cadcraft_doc::{AttribProps, Common, EntityKind, Handle}; +use cadcraft_doc::{AttribProps, Common, EntityKind, HAlign, Handle, Text, VAlign}; use serde_json::{Map, Value, json}; use crate::cmd::curves::KW; @@ -67,7 +67,7 @@ fn run(s: &mut Session, p: &Value) -> Result { if let EntityKind::Insert(i) = &mut e.kind { for a in &mut i.attribs { if let Some(v) = value_for(&vals, &a.tag) { - a.text.value = v; + set_value(&mut a.text, v); n += 1; } } @@ -130,13 +130,29 @@ fn edit(s: &mut Session, (h, k): (Handle, usize), f: impl FnOnce(&str) -> Option && let Some(a) = ins.attribs.get_mut(k) && let Some(v) = f(&a.text.value).filter(|v| *v != a.text.value) { - a.text.value = v; + set_value(&mut a.text, v); changed = true; } })?; Ok(changed) } +/// Refresh the derived baseline after a value change, even one within the writer's +/// imported-font tolerance. Equal XY points request recomputation on export; retain +/// both elevations and the independent endpoints used by Aligned/Fit text. +fn set_value(text: &mut Text, value: String) { + if text.value == value { + return; + } + text.value = value; + if !matches!((text.halign, text.valign), (HAlign::Left, VAlign::Baseline) | (HAlign::Aligned | HAlign::Fit, _)) + && let Some(anchor) = text.align_pt + { + text.insert.x = anchor.x; + text.insert.y = anchor.y; + } +} + /// Change the properties set on attribute `k` of block reference `h`. fn set_props(s: &mut Session, (h, k): (Handle, usize), f: impl FnOnce(&mut AttribProps)) -> Result<()> { s.doc_mut()?.modify_entity(h, |e| { diff --git a/crates/engine/tests/it/attribute_value_baseline.rs b/crates/engine/tests/it/attribute_value_baseline.rs new file mode 100644 index 000000000..8f7523e0b --- /dev/null +++ b/crates/engine/tests/it/attribute_value_baseline.rs @@ -0,0 +1,203 @@ +//! Small value changes must not export an imported justified attribute's old baseline. +use cadcraft_doc::{Attrib, Drawing, EntityKind, HAlign, Handle, Text, VAlign}; +use cadcraft_engine::{Input, Session}; +use cadcraft_geom::Vec3; +use serde_json::json; + +const BEFORE: &str = "POWER ADAPTER"; +const AFTER: &str = "POWER ADAPTER."; + +fn fixture() -> (Session, Handle, Handle) { + let mut s = Session::new(); + for (tag, value, y) in [("T", BEFORE, 15), ("U", "ADPT-01", 0)] { + s.execute("attdef", &json!({"tag":tag,"default":value,"at":[0,y],"height":3})).unwrap(); + } + s.execute("line", &json!({"points":[[0,-5],[40,-5]]})).unwrap(); + let handles: Vec<_> = s.doc().unwrap().model.iter().map(|e| e.handle.hex()).collect(); + s.execute("block", &json!({"name":"Equipment","handles":handles,"base":[0,0],"keep":"delete"})).unwrap(); + let a = s.execute("insert", &json!({"name":"Equipment","at":[100,200],"scale":2,"rotation":30})).unwrap(); + let b = s.execute("insert", &json!({"name":"Equipment","at":[300,200],"attribs":{"T":"Other"}})).unwrap(); + let a = Handle::parse_hex(a["handle"].as_str().unwrap()).unwrap(); + let b = Handle::parse_hex(b["handle"].as_str().unwrap()).unwrap(); + // Set existing document fields directly: this regression does not require Text Options. + s.doc_mut() + .unwrap() + .modify_entity(a, |e| { + let EntityKind::Insert(i) = &mut e.kind else { panic!("insert") }; + let t = &mut i.attribs[0].text; + t.insert.z = 7.0; + t.align_pt = Some(t.insert); + t.halign = HAlign::Center; + t.valign = VAlign::Top; + }) + .unwrap(); + let imported = cadcraft_io::read_dxf(cadcraft_io::write_dxf(s.doc().unwrap()).as_bytes()).unwrap(); + let mut s = Session::empty(); + s.open_drawing(imported, "Imported", None); + (s, a, b) +} + +fn attributes(d: &Drawing, h: Handle) -> Vec { + let EntityKind::Insert(i) = &d.entity(h).unwrap().kind else { panic!("insert") }; + i.attribs.clone() +} + +fn baseline(d: &Drawing, t: &Text) -> cadcraft_geom::Vec2 { + let style = d.text_style(&t.style).unwrap(); + let (h, v) = cadcraft_render::text_align(t.halign, t.valign); + cadcraft_fonts::baseline_start( + &cadcraft_fonts::TextFont::resolve(&style.font), + &t.value, + &cadcraft_fonts::TextParams { + insert: t.insert.xy(), + align_pt: t.align_pt.map(|p| p.xy()), + height: t.height, + rotation: t.rotation, + width_factor: t.width_factor, + oblique: t.oblique, + h, + v, + backwards: style.backwards, + upside_down: style.upside_down, + }, + ) +} + +#[test] +fn all_attribute_value_paths_refresh_small_justified_export_changes() { + for path in ["json", "interactive", "global-json", "global-interactive"] { + let (mut s, a, b) = fixture(); + let before = attributes(s.doc().unwrap(), a); + let other = attributes(s.doc().unwrap(), b); + let definition = s.doc().unwrap().block("Equipment").unwrap().clone(); + match path { + "json" => { + s.execute("attedit", &json!({"handle":a.hex(),"values":{"t":AFTER}})).unwrap(); + } + "interactive" => { + s.start("attedit").unwrap(); + s.input(Input::Pick(vec![a])).unwrap(); + s.input(Input::Text(AFTER.into())).unwrap(); + s.input(Input::Enter).unwrap(); + assert!(s.running.is_none()); + } + "global-json" => { + s.execute("-attedit", &json!({"handles":[a.hex()],"tag":"T","find":"ADAPTER","replace":"ADAPTER."})).unwrap(); + } + "global-interactive" => { + s.script("-attedit\nn\nn\nEquipment\nT\n\nADAPTER\nADAPTER.\n").unwrap(); + assert!(s.running.is_none(), "{}", s.prompt_text()); + } + _ => panic!("path"), + } + let edited = attributes(s.doc().unwrap(), a); + assert_eq!(edited[0].text.value, AFTER, "{path}"); + assert_eq!(edited[0].text.align_pt, before[0].text.align_pt); + assert_eq!(edited[0].text.insert.z, 7.0); + assert_eq!(edited[1], before[1]); + assert_eq!(attributes(s.doc().unwrap(), b), other); + assert_eq!(s.doc().unwrap().block("Equipment").unwrap(), &definition); + let expected = baseline(s.doc().unwrap(), &edited[0].text); + assert!(expected.dist(before[0].text.insert.xy()) > 0.01, "fixture must change width"); + for name in ["edited.dxf", "edited.dwg"] { + let reopened = cadcraft_io::read(&cadcraft_io::write(s.doc().unwrap(), name).unwrap(), name).unwrap(); + let restored = attributes(&reopened, a); + assert!( + restored[0].text.insert.xy().dist(expected) < 1e-8, + "{path} {name}: stale {:?}, expected {expected:?}", + restored[0].text.insert.xy() + ); + assert_eq!(restored[0].text.align_pt, before[0].text.align_pt); + assert_eq!(restored[0].text.value, AFTER); + assert_eq!(restored[0].text.insert.z, 7.0); + } + s.undo().unwrap(); + assert_eq!(attributes(s.doc().unwrap(), a), before, "{path} undo"); + s.redo().unwrap(); + assert_eq!(attributes(s.doc().unwrap(), a), edited, "{path} redo"); + } +} + +#[test] +fn equal_attribute_values_preserve_an_imported_font_baseline() { + let (mut s, a, _) = fixture(); + // A small imported-font offset must survive a no-op edit (writer tolerance is deliberate). + s.doc_mut() + .unwrap() + .modify_entity(a, |e| { + let EntityKind::Insert(i) = &mut e.kind else { panic!("insert") }; + i.attribs[0].text.insert.x += 0.1; + }) + .unwrap(); + let before = attributes(s.doc().unwrap(), a); + s.execute("attedit", &json!({"handle":a.hex(),"values":{"T":BEFORE}})).unwrap(); + assert_eq!(attributes(s.doc().unwrap(), a), before); + s.start("attedit").unwrap(); + s.input(Input::Pick(vec![a])).unwrap(); + s.input(Input::Enter).unwrap(); + s.input(Input::Enter).unwrap(); + assert_eq!(attributes(s.doc().unwrap(), a), before); + s.execute("-attedit", &json!({"handles":[a.hex()],"tag":"T","find":"ADAPTER","replace":"ADAPTER"})).unwrap(); + assert_eq!(attributes(s.doc().unwrap(), a), before, "global JSON no-op"); + s.script("-attedit\nn\nn\nEquipment\nT\n\nADAPTER\nADAPTER\n").unwrap(); + assert!(s.running.is_none(), "{}", s.prompt_text()); + assert_eq!(attributes(s.doc().unwrap(), a), before, "global interactive no-op"); +} + +/// Recomputing a justified baseline must not replace its independent insertion elevation. +#[test] +fn value_edits_preserve_distinct_insertion_and_alignment_elevations_on_export() { + let (mut s, a, _) = fixture(); + s.doc_mut() + .unwrap() + .modify_entity(a, |e| { + let EntityKind::Insert(i) = &mut e.kind else { panic!("insert") }; + i.attribs[0].text.insert.z = 9.0; + }) + .unwrap(); + let anchor = attributes(s.doc().unwrap(), a)[0].text.align_pt; + s.execute("attedit", &json!({"handle":a.hex(),"values":{"T":AFTER}})).unwrap(); + for name in ["elevations.dxf", "elevations.dwg"] { + let reopened = cadcraft_io::read(&cadcraft_io::write(s.doc().unwrap(), name).unwrap(), name).unwrap(); + let restored = attributes(&reopened, a); + assert_eq!(restored[0].text.insert.z, 9.0, "{name}: insertion elevation"); + assert_eq!(restored[0].text.align_pt.map(|p| p.xy()), anchor.map(|p| p.xy()), "{name}: alignment XY"); + if name.ends_with(".dxf") { + assert_eq!(restored[0].text.align_pt, anchor, "DXF retains independent alignment elevation"); + } else { + // The DWG bridge uses one text elevation for both points. + assert_eq!(restored[0].text.align_pt.unwrap().z, 9.0); + } + } +} + +#[test] +fn value_edits_preserve_left_baseline_and_two_point_placements() { + for horizontal in [HAlign::Left, HAlign::Aligned, HAlign::Fit] { + let (mut s, a, _) = fixture(); + s.doc_mut() + .unwrap() + .modify_entity(a, |e| { + let EntityKind::Insert(i) = &mut e.kind else { panic!("insert") }; + let t = &mut i.attribs[0].text; + t.halign = horizontal; + t.valign = VAlign::Baseline; + t.insert = Vec3::new(10.0, 20.0, 7.0); + t.align_pt = (horizontal != HAlign::Left).then_some(Vec3::new(40.0, 30.0, 9.0)); + }) + .unwrap(); + let before = attributes(s.doc().unwrap(), a); + s.execute("attedit", &json!({"handle":a.hex(),"values":{"T":AFTER}})).unwrap(); + let mut expected = before; + expected[0].text.value = AFTER.into(); + assert_eq!(attributes(s.doc().unwrap(), a), expected); + if horizontal != HAlign::Left { + let reopened = cadcraft_io::read_dxf(cadcraft_io::write_dxf(s.doc().unwrap()).as_bytes()).unwrap(); + let restored = attributes(&reopened, a); + assert_eq!(restored[0].text.insert, expected[0].text.insert); + assert_eq!(restored[0].text.align_pt, expected[0].text.align_pt); + assert_eq!(restored[0].text.halign, horizontal); + assert_eq!(restored[0].text.value, AFTER); + } + } +} diff --git a/crates/engine/tests/it/main.rs b/crates/engine/tests/it/main.rs index 8e20e6fa8..ed88a2316 100644 --- a/crates/engine/tests/it/main.rs +++ b/crates/engine/tests/it/main.rs @@ -10,6 +10,7 @@ mod attedit_prompts; mod attrib_modes; mod attrib_props; mod attribute_tools; +mod attribute_value_baseline; mod block_description; mod block_keep; mod block_redefine; diff --git a/crates/io/src/dxf_write/common.rs b/crates/io/src/dxf_write/common.rs index bf8fad449..6ba3ce8ef 100644 --- a/crates/io/src/dxf_write/common.rs +++ b/crates/io/src/dxf_write/common.rs @@ -237,7 +237,8 @@ fn computed_text_insert(d: &Drawing, t: &Text) -> Vec3 { upside_down: ts.upside_down, }; let q = cadcraft_fonts::baseline_start(&cadcraft_fonts::TextFont::resolve(&ts.font), &t.value, &p); - if q.is_finite() { Vec3::new(q.x, q.y, a.z) } else { t.insert } + // Justification recalculates the baseline in XY; group 10 keeps its own elevation. + if q.is_finite() { Vec3::new(q.x, q.y, t.insert.z) } else { t.insert } } pub(super) fn text_tags(w: &mut W, d: &Drawing, t: &Text, attrib: Option<(&Attrib, Version)>, attdef_prompt: Option<&str>) { diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index 291c9b202..d2af85803 100644 --- a/docs/file-format-parity.md +++ b/docs/file-format-parity.md @@ -1,6 +1,6 @@ # File-format parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-25 · **Change:** minor (LAYOUT SAveas writes a layout as a DWT template) · **Target:** Autodesk AutoCAD 2027 +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-28 · **Change:** minor (attribute value edits refresh exported baselines) · **Target:** Autodesk AutoCAD 2027 Every format AutoCAD 2027 reads or writes, with CADCraft's support, fidelity and tests. Work items are in [gaps.md](gaps.md#file-formats); the weighted score feeds @@ -75,7 +75,7 @@ on read with a note, so such files no longer exceed the DXF limit (#1482). **DWG |---|---|---|---| | LINE, POINT, CIRCLE, ARC, ELLIPSE, LWPOLYLINE (widths, bulges, elevation), SPLINE, RAY, XLINE | yes | yes | round-trip tests | | POLYLINE 2D/3D | yes | yes (as LWPOLYLINE / 3D POLYLINE) | polyface and polygon meshes flattened: lossy | -| TEXT, MTEXT, ATTDEF, INSERT + ATTRIB | yes; multiline attributes (embedded MTEXT) read and drawn | yes; multiline attributes written as embedded MTEXT (DXF 2007 and later; older versions: one line) | ATTDEF prompt kept (#137) | +| TEXT, MTEXT, ATTDEF, INSERT + ATTRIB | yes; multiline attributes (embedded MTEXT) read and drawn | yes; multiline attributes written as embedded MTEXT (DXF 2007 and later; older versions: one line); changed attribute values refresh justified baselines, including small width changes | ATTDEF prompt kept (#137); unchanged values retain imported-font placement | | DIMENSION (all 7 kinds) | yes | yes, with anonymous `*D` blocks | a reopened dimension's `*D` block is regenerated under its name, unreferenced ones dropped (#495); DIMASSOC objects written for every associated kind — linear/aligned, angular, radial/diametric, ordinate and arc length — and read back without CADCraft's xdata (#1651) | | DIMENSION (all 7 kinds) | yes | yes, with anonymous `*D` blocks | a reopened dimension's `*D` block is regenerated under its name, unreferenced ones dropped (#495); DIMASSOC objects written; angular block text honors DIMDSEP, including per-dimension overrides (#1646) | | DIMENSION (all 7 kinds) | yes | yes, with anonymous `*D` blocks; their text keeps the diameter sign as `%%c`, so SHX styles plot it (#1645) | a reopened dimension's `*D` block is regenerated under its name, unreferenced ones dropped (#495); DIMASSOC objects written | @@ -140,6 +140,7 @@ our output in AutoCAD black-box. | Date | Change | Summary | |---|---|---| +| 2026-10-26 | minor | CC-046: ATTEDIT and -ATTEDIT value changes invalidate derived justified baselines before DXF/DWG export; preserve alignment anchors, unchanged values and Aligned/Fit endpoints. Review follow-up: baseline recomputation preserves insertion elevation independently of alignment elevation. The shared writer correction also applies to justified TEXT. Independent of attribute editor UI; reverting the follow-up restores elevation loss on recomputation, while reverting the value setter restores stale XY baselines. | | 2026-10-25 | minor | LAYOUT SAveas (`layout.saveas`) writes a layout as a drawing template: its page setup and paper space objects, no model space objects or other layouts, and only the named objects they use | | 2026-10-22 | minor | DXF/DWG save: angular, diametric and radial dimensions get standard DIMASSOC objects (one centre reference to the circle for radial/diametric, the definition points for angular), so AutoCAD follows their geometry; the standard objects of those kinds are read back too, without CADCraft's xdata (#1651) | | 2026-10-19 | minor | DXF/DWG save: angular dimension block text honors DIMDSEP, including per-dimension overrides (#1646) | From 7546277128b82ce3c89f0fdf6a663bbea2ad6bc4 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Thu, 29 Oct 2026 21:39:34 -0400 Subject: [PATCH 32/49] fmt: rustfmt the DIMTMOVE 2 clearance port (#2302) Co-Authored-By: Claude Opus 5.5 --- crates/render/src/dim/linear.rs | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/crates/render/src/dim/linear.rs b/crates/render/src/dim/linear.rs index 8127aef8f..da1b2a746 100644 --- a/crates/render/src/dim/linear.rs +++ b/crates/render/src/dim/linear.rs @@ -151,9 +151,7 @@ fn position_linear_text(config: &DimConfig<'_>, state: &mut LinearDimState) { state.side_out = if (config.dimension.defpt.xy() - state.p1).dot(state.n) >= 0.0 { state.n } else { -state.n }; state.text_axis = Vec2::from_angle(state.angle); let clearance = |axis: Vec2, across: f64| { - config.gap - + state.text_width * state.text_axis.dot(axis).abs() / 2.0 - + state.text_height * state.text_axis.perp().dot(axis).abs() * across + config.gap + state.text_width * state.text_axis.dot(axis).abs() / 2.0 + state.text_height * state.text_axis.perp().dot(axis).abs() * across }; // Empirical #2004 match: 0.595× height with SHX and 0.601× with TrueType. let off_along = |axis: Vec2| clearance(axis, if st.text_above == 1 { 0.6 } else { 0.5 }); @@ -186,11 +184,8 @@ fn position_linear_text(config: &DimConfig<'_>, state: &mut LinearDimState) { // Half the text height either way, whatever DIMTAD says (#2222). let clear = clearance(state.side_out, 0.5); let lift = clear + 2.0 * config.arrow_size.max(config.tick_size); - state.text_mid = if st.text_move == 1 { - mid + state.side_out * lift + state.u * state.half_extent - } else { - mid + state.side_out * (lift + clear) - }; + state.text_mid = + if st.text_move == 1 { mid + state.side_out * lift + state.u * state.half_extent } else { mid + state.side_out * (lift + clear) }; } else if !config.dimension.user_text_pos { state.text_mid = state.along_center + state.offset; } From b3158b56a8a2024681b33ad1a7655cc94bf82484 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Thu, 29 Oct 2026 22:14:18 -0400 Subject: [PATCH 33/49] CI: workflows only call craft-common-actions at @main (#2473) AGENTS.md (and CLAUDE.md where present) gets a CI workflows section: workflows only call craft-common-actions at @main, with no other jobs; feature and fix PRs don't touch CI and link or open a craft-common-actions issue (a PR only for a small fix that is safe for every app and does not increase CI time); legacy jobs aren't added to and move only as their own task, staying until a shared workflow runs them. windows-arm64.yml moves from its SHA pin to @main. The pinned revision is on craft-common-actions main and the workflow (and the actions it calls) is identical there, so nothing changes in behaviour. --- .github/workflows/windows-arm64.yml | 4 ++-- AGENTS.md | 5 +++++ CLAUDE.md | 5 +++++ 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.github/workflows/windows-arm64.yml b/.github/workflows/windows-arm64.yml index a671ff2f2..167839e9e 100644 --- a/.github/workflows/windows-arm64.yml +++ b/.github/workflows/windows-arm64.yml @@ -25,8 +25,8 @@ permissions: jobs: windows-arm64: - # Immutable supporting workflow revision until the new install contract lands upstream. - uses: storytold/craft-common-actions/.github/workflows/windows-arm64.yml@8bb4e5ab95443171104ad88113fe1ef9b0e5ce3f + # 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/windows-arm64.yml@main with: app-name: cadcraft app-dir: CADCraft diff --git a/AGENTS.md b/AGENTS.md index e436894b2..e3d7418d7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -66,3 +66,8 @@ People trust CADCraft with their drawings; a crash loses their work. **This outr GitHub profiles). Never hand-edit `contributors.json`. - Maintainers refresh the stats with `python3 ../../craftrules/scripts/contributors.py .` (it also re-verifies who wrote each `people.toml` entry; `--check` only verifies). + +## CI workflows +- Workflows in `.github/workflows/` call the shared workflows in [`storytold/craft-common-actions`](https://github.com/storytold/craft-common-actions) at `@main`, with their inputs and secrets. No other jobs: if no shared workflow does what's needed, it doesn't go here. +- Don't add or change CI in a feature or fix PR. If the existing workflows can't build or test a change, link an existing craft-common-actions issue or PR, or open a new issue, or a PR only for a small fix that is safe for every app and does not increase CI time. +- Some workflow files here still run their own jobs. Don't add to them. Moving a job into craft-common-actions is its own task, never part of another PR, and the job stays here until a shared workflow runs it. diff --git a/CLAUDE.md b/CLAUDE.md index 33e6a2121..8e4a1fdfa 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -47,3 +47,8 @@ People trust CADCraft with their drawings; a crash loses their work. **This outr ## Roadmap `ROADMAP.md` (committed) is the one-page summary: stage, parity numbers, estimates. It follows craftrules' `standards/progress-docs.md`: the assessment is `docs/target-app-parity.md`, the work list `docs/gaps.md` (pick work from its top rows), milestones `docs/roadmap.md`, deep checklists `docs/geometry-parity.md`, `docs/ui-parity.md`, `docs/file-format-parity.md`, `docs/hardware-parity.md`, `docs/localization-parity.md`. When work lands, update the affected rows and the docs' status lines and revision history. `cargo xtask parity` regenerates the menu-breadth checklist in `docs/parity-checklist.md`. + +## CI workflows +- Workflows in `.github/workflows/` call the shared workflows in [`storytold/craft-common-actions`](https://github.com/storytold/craft-common-actions) at `@main`, with their inputs and secrets. No other jobs: if no shared workflow does what's needed, it doesn't go here. +- Don't add or change CI in a feature or fix PR. If the existing workflows can't build or test a change, link an existing craft-common-actions issue or PR, or open a new issue, or a PR only for a small fix that is safe for every app and does not increase CI time. +- Some workflow files here still run their own jobs. Don't add to them. Moving a job into craft-common-actions is its own task, never part of another PR, and the job stays here until a shared workflow runs it. From f8b09e92e55e869a0c5199f9f447e487fde0aeda Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Thu, 29 Oct 2026 22:22:29 -0400 Subject: [PATCH 34/49] deps: bump tar, zip, roxmltree, rustls-webpki and symphonia to their latest versions (#2475) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - `zip`: 9.1.1 → 9.1.3 Lockfile only. --- Cargo.lock | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 34cfc44cc..1159481f5 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -268,7 +268,7 @@ dependencies = [ "objc2-foundation 0.3.2", "parking_lot", "percent-encoding", - "windows-sys 0.61.2", + "windows-sys 0.59.0", "wl-clipboard-rs", "x11rb", ] @@ -1642,7 +1642,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb" dependencies = [ "libc", - "windows-sys 0.61.2", + "windows-sys 0.59.0", ] [[package]] @@ -3434,7 +3434,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7d8fae84b431384b68627d0f9b3b1245fcf9f46f6c0e3dc902e9dce64edd1967" dependencies = [ "libc", - "windows-sys 0.61.2", + "windows-sys 0.59.0", ] [[package]] @@ -4029,7 +4029,7 @@ dependencies = [ "errno", "libc", "linux-raw-sys 0.12.1", - "windows-sys 0.61.2", + "windows-sys 0.59.0", ] [[package]] @@ -4086,7 +4086,7 @@ dependencies = [ "security-framework", "security-framework-sys", "webpki-root-certs", - "windows-sys 0.61.2", + "windows-sys 0.59.0", ] [[package]] @@ -4561,10 +4561,10 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" dependencies = [ "fastrand", - "getrandom 0.4.3", + "getrandom 0.3.4", "once_cell", "rustix 1.1.5", - "windows-sys 0.61.2", + "windows-sys 0.59.0", ] [[package]] @@ -5470,7 +5470,7 @@ version = "0.1.11" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22" dependencies = [ - "windows-sys 0.61.2", + "windows-sys 0.59.0", ] [[package]] @@ -6114,9 +6114,9 @@ dependencies = [ [[package]] name = "zip" -version = "9.1.1" +version = "9.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "518b847fd864440c379748ad684c449f293af68978a485a4ff16f7c901c1f7c4" +checksum = "1156b39d142a34b999c2310a50455e0cb3760bf7efad0122f796d813bee26ccb" dependencies = [ "crc32fast", "flate2", From d6de2db6dbf5ae39ae9f78a54c0e0cd481d67239 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Fri, 30 Oct 2026 01:28:46 -0400 Subject: [PATCH 35/49] Update prompt shows the app icon and accent color instead of a letter (#2479) UPDATE_APP (native builds; craft-update is a native-only dependency) carries our 128 px icon and accent (#3ea6e8, its colour in ArtCraft Launcher). The updater, the self-update helper and craft-update's startup prompt all get them through crate::UPDATE_APP; the prompt draws the icon, the accent and "by ArtCraft" (craft-update's default developer). craft-update is pinned to storytold/craft-libs main at 1065653e7 (#434). Clippy fixes for Rust 1.99 in untouched code (same logic): - crates/constraints/src/auto.rs - crates/engine/src/audit.rs - crates/engine/src/cmd/inquiry.rs - crates/engine/src/mtext_edit.rs - crates/geom/src/nurbs.rs - crates/io/src/dxf_raw.rs - crates/io/src/dxf_read/document.rs - crates/render/src/text.rs - crates/ui-egui/src/cmdline.rs - xtask/src/layers.rs --- Cargo.lock | 3 ++- Cargo.toml | 3 ++- apps/cadcraft/src/main.rs | 2 +- crates/constraints/src/auto.rs | 12 ++++-------- crates/engine/src/audit.rs | 16 ++++++---------- crates/engine/src/cmd/inquiry.rs | 14 +++++--------- crates/engine/src/mtext_edit.rs | 8 +++----- crates/geom/src/nurbs.rs | 2 +- crates/io/src/dxf_raw.rs | 6 ++---- crates/io/src/dxf_read/document.rs | 12 +++++------- crates/render/src/text.rs | 2 +- crates/ui-egui/src/cmdline.rs | 12 +++++------- crates/ui-egui/src/lib.rs | 9 +++++++++ crates/ui-egui/src/updates_ui.rs | 3 +-- xtask/src/layers.rs | 6 ++---- 15 files changed, 49 insertions(+), 61 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 1159481f5..fd4345fb1 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1191,13 +1191,14 @@ dependencies = [ [[package]] name = "craft-update" version = "0.1.0" -source = "git+https://github.com/storytold/craft-libs?rev=92d392cff132eaf53e13afff77f38b5c11b73aa0#92d392cff132eaf53e13afff77f38b5c11b73aa0" +source = "git+https://github.com/storytold/craft-libs?rev=1065653e75854e9c17e1ff563acdd344c1b185f0#1065653e75854e9c17e1ff563acdd344c1b185f0" dependencies = [ "chrono", "dunce", "egui", "flate2", "getrandom 0.3.4", + "image", "log", "plist", "semver", diff --git a/Cargo.toml b/Cargo.toml index 1d4d7c530..220f29403 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -65,7 +65,8 @@ eframe = { version = "0.37", default-features = false } egui-wgpu = "0.37" # Monotonic time on native and web (performance.now on wasm). web-time = "1.1" -craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "92d392cff132eaf53e13afff77f38b5c11b73aa0", features = ["egui"] } +# craft-update with storytold/craft-libs#434: the update prompt shows the app's icon, accent and developer. +craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "1065653e75854e9c17e1ff563acdd344c1b185f0", features = ["egui"] } rfd = "0.17" arboard = { version = "3.6", default-features = false } diff --git a/apps/cadcraft/src/main.rs b/apps/cadcraft/src/main.rs index 19546d6ce..4d7bdc39b 100644 --- a/apps/cadcraft/src/main.rs +++ b/apps/cadcraft/src/main.rs @@ -218,7 +218,7 @@ fn main() -> eframe::Result { let logger = logging::install(); // The update helper relaunches this binary after a self-update; it runs and exits here. #[cfg(not(target_arch = "wasm32"))] - if let Some(done) = craft_update::self_update::finish(&craft_update::suite::CADCRAFT, &std::env::args_os().skip(1).collect::>()) { + if let Some(done) = craft_update::self_update::finish(&cadcraft_ui_egui::UPDATE_APP, &std::env::args_os().skip(1).collect::>()) { if let Err(e) = done { eprintln!("CADCraft update helper failed: {e}"); std::process::exit(1); diff --git a/crates/constraints/src/auto.rs b/crates/constraints/src/auto.rs index fe7764205..211be6b93 100644 --- a/crates/constraints/src/auto.rs +++ b/crates/constraints/src/auto.rs @@ -52,15 +52,11 @@ fn collect(d: &Drawing, handles: &[Handle]) -> Geo { g.curves.push((GeomRef::whole(h), ga.center, a.radius)); } } - EntityKind::Circle(c) => { - if c.center.is_finite() && c.radius.is_finite() { - g.curves.push((GeomRef::whole(h), c.center.xy(), c.radius)); - } + EntityKind::Circle(c) if c.center.is_finite() && c.radius.is_finite() => { + g.curves.push((GeomRef::whole(h), c.center.xy(), c.radius)); } - EntityKind::Point(p) => { - if p.p.is_finite() { - g.points.push((GeomRef::whole(h), p.p.xy())); - } + EntityKind::Point(p) if p.p.is_finite() => { + g.points.push((GeomRef::whole(h), p.p.xy())); } EntityKind::LwPolyline(p) => { let n = p.vertices.len(); diff --git a/crates/engine/src/audit.rs b/crates/engine/src/audit.rs index f78de7efe..c055bff25 100644 --- a/crates/engine/src/audit.rs +++ b/crates/engine/src/audit.rs @@ -460,17 +460,13 @@ fn references(d: &mut Drawing, out: &mut Vec) { m.style = "Standard".into(); } } - EntityKind::Table(t) => { - if !has_name(&d.table_styles, &t.style, |s| &s.name) { - note("table style", &t.style); - t.style = "Standard".into(); - } + EntityKind::Table(t) if !has_name(&d.table_styles, &t.style, |s| &s.name) => { + note("table style", &t.style); + t.style = "Standard".into(); } - EntityKind::Leader(l) => { - if !ok_dim(d, &l.style) { - note("dimension style", &l.style); - l.style = "Standard".into(); - } + EntityKind::Leader(l) if !ok_dim(d, &l.style) => { + note("dimension style", &l.style); + l.style = "Standard".into(); } EntityKind::Dimension(dim) => { if !ok_dim(d, &dim.style) { diff --git a/crates/engine/src/cmd/inquiry.rs b/crates/engine/src/cmd/inquiry.rs index c7f59a0cf..0fa342e23 100644 --- a/crates/engine/src/cmd/inquiry.rs +++ b/crates/engine/src/cmd/inquiry.rs @@ -840,11 +840,9 @@ impl Interactive for DistM { let model = model_points(&self.sources); s.echo(format!("Distance = {}", fmt_d(s, path_len(model.as_deref().unwrap_or(pts), &self.bulges)))); } - Input::Keyword(k) if k == "Undo" => { - if pts.len() > 1 { - self.arcs.undo(pts, &mut self.bulges); - self.sources.pop(); - } + Input::Keyword(k) if k == "Undo" && pts.len() > 1 => { + self.arcs.undo(pts, &mut self.bulges); + self.sources.pop(); } Input::Keyword(k) if k == "Length" => self.length = true, Input::Keyword(k) if k == "Total" => return self.total(s, false), @@ -852,10 +850,8 @@ impl Interactive for DistM { self.arcs.close(pts, &mut self.bulges)?; return self.total(s, true); } - Input::Keyword(k) => { - if !self.arcs.keyword(&k, pts) { - s.echo(format!("{k}: not available yet")); - } + Input::Keyword(k) if !self.arcs.keyword(&k, pts) => { + s.echo(format!("{k}: not available yet")); } Input::Enter => return self.total(s, false), _ => {} diff --git a/crates/engine/src/mtext_edit.rs b/crates/engine/src/mtext_edit.rs index 30da0b897..97ecede6f 100644 --- a/crates/engine/src/mtext_edit.rs +++ b/crates/engine/src/mtext_edit.rs @@ -136,11 +136,9 @@ impl Formatted { i += 2; match code { None => {} - Some('P') => { - if f.paras.len() < MAX_PARAS { - f.push_char('\n', &cur); - f.paras.push(props.clone()); - } + Some('P') if f.paras.len() < MAX_PARAS => { + f.push_char('\n', &cur); + f.paras.push(props.clone()); } Some(c @ ('\\' | '{' | '}')) => f.push_char(c, &cur), Some('L') => cur.underline = true, diff --git a/crates/geom/src/nurbs.rs b/crates/geom/src/nurbs.rs index 5268203b1..104ba8d3c 100644 --- a/crates/geom/src/nurbs.rs +++ b/crates/geom/src/nurbs.rs @@ -487,7 +487,7 @@ impl Spline { /// Arc length between parameters `a` and `b` (adaptive Gauss–Legendre over each knot span). pub fn length_between(&self, a: f64, b: f64) -> f64 { - if !self.is_valid() || !(a.is_finite() && b.is_finite()) { + if !(self.is_valid() && a.is_finite() && b.is_finite()) { return 0.0; } let (lo, hi) = self.domain(); diff --git a/crates/io/src/dxf_raw.rs b/crates/io/src/dxf_raw.rs index 0154b01d3..9b755f80f 100644 --- a/crates/io/src/dxf_raw.rs +++ b/crates/io/src/dxf_raw.rs @@ -135,10 +135,8 @@ fn head(tags: &[Tag]) -> Head { h.has_reactors |= group.as_deref() == Some("ACAD_REACTORS"); } (_, Some("ACAD_REACTORS")) => h.reactors.push(norm(&t.str())), - (_, Some("ACAD_XDICTIONARY")) => { - if h.xdict.is_none() { - h.xdict = Some(norm(&t.str())); - } + (_, Some("ACAD_XDICTIONARY")) if h.xdict.is_none() => { + h.xdict = Some(norm(&t.str())); } (_, Some(_)) => {} (5 | 105, None) if h.handle.is_none() => h.handle = Some(norm(&t.str())), diff --git a/crates/io/src/dxf_read/document.rs b/crates/io/src/dxf_read/document.rs index 02ea0f532..d732f4450 100644 --- a/crates/io/src/dxf_read/document.rs +++ b/crates/io/src/dxf_read/document.rs @@ -35,13 +35,11 @@ pub(super) fn parse_entities( extra = more; kindent = Some((c, k)); } - "INSERT" => { - if t.i(66) == Some(1) { - let ins_layer = kindent.as_ref().map(|(c, _)| c.layer.clone()).unwrap_or_default(); - let attribs = insert_attribs(recs, &mut i, &ins_layer); - if let Some((_, EntityKind::Insert(ins))) = kindent.as_mut() { - ins.attribs = attribs; - } + "INSERT" if t.i(66) == Some(1) => { + let ins_layer = kindent.as_ref().map(|(c, _)| c.layer.clone()).unwrap_or_default(); + let attribs = insert_attribs(recs, &mut i, &ins_layer); + if let Some((_, EntityKind::Insert(ins))) = kindent.as_mut() { + ins.attribs = attribs; } } // A VERTEX or ATTRIB with no POLYLINE or INSERT before it; a stray SEQEND holds nothing. diff --git a/crates/render/src/text.rs b/crates/render/src/text.rs index 1f80d7af4..8e692facd 100644 --- a/crates/render/src/text.rs +++ b/crates/render/src/text.rs @@ -77,7 +77,7 @@ pub(super) fn mesh(g: &TextGlyph, xf: Mat3, pixel: f64) -> Arc { let contours = ttf::glyph_contours(&g.face, g.gid); let points = contours.iter().map(Vec::len).try_fold(0usize, usize::checked_add); // Font data is untrusted; don't hand unbounded or invalid paths to the tessellator. - if !points.is_some_and(|n| n <= MAX_POINTS) || contours.iter().flatten().any(|p| !p.is_finite() || p.x.abs().max(p.y.abs()) > 1.0e6) { + if points.is_none_or(|n| n > MAX_POINTS) || contours.iter().flatten().any(|p| !p.is_finite() || p.x.abs().max(p.y.abs()) > 1.0e6) { return Arc::new(Mesh { contours: Arc::default(), triangles: Vec::new() }); } let contours = match detail { diff --git a/crates/ui-egui/src/cmdline.rs b/crates/ui-egui/src/cmdline.rs index d78561551..9d8bd9821 100644 --- a/crates/ui-egui/src/cmdline.rs +++ b/crates/ui-egui/src/cmdline.rs @@ -379,13 +379,11 @@ pub fn keyboard(app: &mut CadApp, ctx: &egui::Context) { app.cmd.buffer.pop(); } } - Key::ArrowUp if !modifiers.any() => { - if !app.cmd.history.is_empty() { - let n = app.cmd.history.len(); - let pos = app.cmd.history_pos.map(|p| p.saturating_sub(1)).unwrap_or(n - 1); - app.cmd.history_pos = Some(pos); - app.cmd.buffer = app.cmd.history.get(pos).cloned().unwrap_or_default(); - } + Key::ArrowUp if !modifiers.any() && !app.cmd.history.is_empty() => { + let n = app.cmd.history.len(); + let pos = app.cmd.history_pos.map(|p| p.saturating_sub(1)).unwrap_or(n - 1); + app.cmd.history_pos = Some(pos); + app.cmd.buffer = app.cmd.history.get(pos).cloned().unwrap_or_default(); } Key::ArrowDown if !modifiers.any() => { if !options_key(app, 1) diff --git a/crates/ui-egui/src/lib.rs b/crates/ui-egui/src/lib.rs index 22e325cbe..311dd4cbf 100644 --- a/crates/ui-egui/src/lib.rs +++ b/crates/ui-egui/src/lib.rs @@ -8,6 +8,15 @@ #![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)] #![forbid(unsafe_code)] +/// CADCraft as craft-update knows it, with its 128 px icon and accent colour: the update +/// prompt shows both, and an AppImage's menu entry gets the icon. +#[cfg(not(target_arch = "wasm32"))] +pub const UPDATE_APP: craft_update::app::App = craft_update::app::App { + icon_png: Some(include_bytes!("../../../assets/app-icon/hicolor/128x128/apps/ai.storyteller.cadcraft.png")), + accent: Some([0x3e, 0xa6, 0xe8]), + ..craft_update::suite::CADCRAFT +}; + pub mod aliasdlg; pub mod animation; pub mod autosave; diff --git a/crates/ui-egui/src/updates_ui.rs b/crates/ui-egui/src/updates_ui.rs index 1bd05c6f8..ffc625767 100644 --- a/crates/ui-egui/src/updates_ui.rs +++ b/crates/ui-egui/src/updates_ui.rs @@ -2,7 +2,6 @@ //! Updates… (desktop only; the web build is always the latest). The flow itself is //! `craft_update::updater::Updater`. -use craft_update::suite::CADCRAFT; use craft_update::updater::{Action, Status, Updater}; use crate::CadApp; @@ -21,7 +20,7 @@ pub struct Runtime { impl Default for Runtime { fn default() -> Self { - Self { updater: Updater::new(&CADCRAFT, VERSION), enabled: false, check_requested: false } + Self { updater: Updater::new(&crate::UPDATE_APP, VERSION), enabled: false, check_requested: false } } } diff --git a/xtask/src/layers.rs b/xtask/src/layers.rs index aab245784..c23825d11 100644 --- a/xtask/src/layers.rs +++ b/xtask/src/layers.rs @@ -167,10 +167,8 @@ pub fn check(crates: &[Crate]) -> Vec { match classify(&d.name) { // Unregistered deps are reported on their own entry. None => {} - Some(Class::Testkit) => { - if d.kind != DepKind::Dev { - out.push(Violation::TestkitAsNormalDep { krate: c.name.clone() }); - } + Some(Class::Testkit) if d.kind != DepKind::Dev => { + out.push(Violation::TestkitAsNormalDep { krate: c.name.clone() }); } Some(dc) => { let to = dc.layer().unwrap_or(u8::MAX); From f536bf406f01541006c81deec47ec842acc83158 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Fri, 30 Oct 2026 02:35:23 -0400 Subject: [PATCH 36/49] UPD.1: honor pretend versions and restore dev-testkit checks (#2486) --- Cargo.lock | 2 +- Cargo.toml | 4 ++-- contributors/people.toml | 3 +++ xtask/src/layers.rs | 2 ++ 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index fd4345fb1..51693203d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1191,7 +1191,7 @@ dependencies = [ [[package]] name = "craft-update" version = "0.1.0" -source = "git+https://github.com/storytold/craft-libs?rev=1065653e75854e9c17e1ff563acdd344c1b185f0#1065653e75854e9c17e1ff563acdd344c1b185f0" +source = "git+https://github.com/storytold/craft-libs?rev=04aa1703b32d299e54f78fcde4182f2b393a9116#04aa1703b32d299e54f78fcde4182f2b393a9116" dependencies = [ "chrono", "dunce", diff --git a/Cargo.toml b/Cargo.toml index 220f29403..da6bca3b4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -65,8 +65,8 @@ eframe = { version = "0.37", default-features = false } egui-wgpu = "0.37" # Monotonic time on native and web (performance.now on wasm). web-time = "1.1" -# craft-update with storytold/craft-libs#434: the update prompt shows the app's icon, accent and developer. -craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "1065653e75854e9c17e1ff563acdd344c1b185f0", features = ["egui"] } +# craft-update: app-specific pretend versions apply to startup and manual checks. +craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "04aa1703b32d299e54f78fcde4182f2b393a9116", features = ["egui"] } rfd = "0.17" arboard = { version = "3.6", default-features = false } diff --git a/contributors/people.toml b/contributors/people.toml index 101a329ac..28564415e 100644 --- a/contributors/people.toml +++ b/contributors/people.toml @@ -96,3 +96,6 @@ real_name = "Doan Huynh Huu Khuong" display_name = "Doan Huynh Huu Khuong" sync_github_name = false + +[people.dylanmtaylor] +sync_github_name = true diff --git a/xtask/src/layers.rs b/xtask/src/layers.rs index c23825d11..d8db1c526 100644 --- a/xtask/src/layers.rs +++ b/xtask/src/layers.rs @@ -170,6 +170,8 @@ pub fn check(crates: &[Crate]) -> Vec { Some(Class::Testkit) if d.kind != DepKind::Dev => { out.push(Violation::TestkitAsNormalDep { krate: c.name.clone() }); } + // Test support is allowed as a dev-dependency, regardless of its layer. + Some(Class::Testkit) => {} Some(dc) => { let to = dc.layer().unwrap_or(u8::MAX); if to >= layer && !(to == layer && intra_layer_allowed(&c.name, &d.name)) { From 3ba2362ec912e7483e1a30d4320c32107660ba13 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:45:50 +0700 Subject: [PATCH 37/49] LISP: entity names answer prompts that pick one object (#2477) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * LISP: entity names answer prompts that pick one object `command` fed an entity name, alone or as `entsel` returns it (name and point), to the running command as a pick. Prompts that pick a single object with a point (MEASURE, DIVIDE, LENGTHEN, PEDIT, BREAK, TRIM and EXTEND in Standard mode, FILLET, OFFSET, REVCLOUD Object, dimensions…) only take points, so routines got "Invalid input" or nothing at all. At such a prompt the name is now entered as its point, and a pick at exactly that point finds the named object (Session::pick_object), so the point says where on it, as in AutoCAD. A bare name stands at the object's DXF group 10 point, the point AutoCAD picks it at: a line's start, a circle's or an arc's centre, a polyline's first vertex. At an arc's centre MEASURE runs from the arc's end, as AutoCAD does. Co-Authored-By: Claude Opus 5.5 * Keep a named object for its own input and its own space A name given at a prompt picking one object now holds only while that input is taken: a later pick at the same point finds what lies there. A name for an object in another space picks nothing, instead of the object under its point in the current space. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/annotate/common.rs | 2 +- crates/engine/src/cmd/constraints.rs | 6 +- crates/engine/src/cmd/curves.rs | 5 +- crates/engine/src/cmd/draw2/divide.rs | 3 + crates/engine/src/cmd/modify/break_join.rs | 2 +- crates/engine/src/cmd/modify/fillet.rs | 2 +- crates/engine/src/cmd/modify/offset.rs | 2 +- crates/engine/src/cmd/trimextend.rs | 2 +- crates/engine/src/lib.rs | 5 + crates/engine/src/lisp/drawing.rs | 18 +++- crates/engine/src/lisp/tests.rs | 105 +++++++++++++++++++++ crates/engine/src/session/interactive.rs | 1 + crates/engine/src/session/picking.rs | 45 ++++++++- docs/autolisp.md | 5 +- 14 files changed, 185 insertions(+), 18 deletions(-) diff --git a/crates/engine/src/cmd/annotate/common.rs b/crates/engine/src/cmd/annotate/common.rs index 419723288..398102797 100644 --- a/crates/engine/src/cmd/annotate/common.rs +++ b/crates/engine/src/cmd/annotate/common.rs @@ -107,7 +107,7 @@ pub(super) fn hex_param(p: &Value, key: &str) -> Option { pub(super) fn pick_at(s: &Session, p: Vec2) -> Option { let ap = s.pixel_size() * s.settings.pickbox.max(1.0) * 1.5; - crate::select::pick(s.doc().ok()?, &s.space(), p, ap) + s.pick_object(&s.space(), p, ap).ok().flatten() } /// The straight or curved piece of `h` picked at `p`: a line, an arc, or the polyline segment nearest `p`. diff --git a/crates/engine/src/cmd/constraints.rs b/crates/engine/src/cmd/constraints.rs index 5b685dd45..9f21dca6a 100644 --- a/crates/engine/src/cmd/constraints.rs +++ b/crates/engine/src/cmd/constraints.rs @@ -461,7 +461,7 @@ impl Interactive for GcM { } Input::Point(p) => { let space = s.space(); - let Some(h) = crate::select::pick(s.doc()?, &space, p, aperture(s)) else { + let Some(h) = s.pick_object(&space, p, aperture(s))? else { s.echo("*Invalid selection*"); return Ok(Step::Continue); }; @@ -706,11 +706,11 @@ impl Interactive for DcM { Input::Point(p) => { let space = s.space(); let ap = aperture(s); - let d = s.doc()?; - let Some(h) = crate::select::pick(d, &space, p, ap) else { + let Some(h) = s.pick_object(&space, p, ap)? else { s.echo("*Invalid selection*"); return Ok(Step::Continue); }; + let d = s.doc()?; let want = match dc { Dc::Radius | Dc::Diameter => Want::Curve, Dc::Angular if self.refs.is_empty() => { diff --git a/crates/engine/src/cmd/curves.rs b/crates/engine/src/cmd/curves.rs index 2ef2e24f2..ca918834a 100644 --- a/crates/engine/src/cmd/curves.rs +++ b/crates/engine/src/cmd/curves.rs @@ -18,10 +18,9 @@ pub fn pick_aperture(s: &Session) -> f64 { s.pixel_size() * s.settings.pickbox.max(1.0) * 1.5 } -/// The object under `p` in the current space. +/// The object under `p` in the current space (or the one named for `p`: [`Session::pick_object`]). pub fn pick_at(s: &Session, p: Vec2) -> Option { - let space = s.space(); - crate::select::pick(s.doc().ok()?, &space, p, pick_aperture(s)) + s.pick_object(&s.space(), p, pick_aperture(s)).ok().flatten() } pub fn entity(s: &Session, h: Handle) -> Result { diff --git a/crates/engine/src/cmd/draw2/divide.rs b/crates/engine/src/cmd/draw2/divide.rs index 65e7ab06c..4e92f561f 100644 --- a/crates/engine/src/cmd/draw2/divide.rs +++ b/crates/engine/src/cmd/draw2/divide.rs @@ -81,6 +81,9 @@ pub(super) fn run_measure(s: &mut Session, p: &Value) -> Result { if let Some(from) = point_param(p, "from") { let past_half = match curves::entity(s, h)?.kind { EntityKind::Circle(_) => false, + // At an arc's centre, where a bare name given from AutoLISP stands (its DXF group 10 + // point), every point of it is as near: AutoCAD measures from its end. + EntityKind::Arc(a) if from.dist(a.center.xy()) <= a.radius * 1e-9 => true, // A spline by its own parameter: its tessellation drops zero-length pieces, so the // segment count is not the spline's parameter range. EntityKind::Spline(sp) => { diff --git a/crates/engine/src/cmd/modify/break_join.rs b/crates/engine/src/cmd/modify/break_join.rs index c7432e223..74fd482a2 100644 --- a/crates/engine/src/cmd/modify/break_join.rs +++ b/crates/engine/src/cmd/modify/break_join.rs @@ -250,7 +250,7 @@ impl Interactive for BreakM { (None, Input::Point(p)) => { let ap = s.pixel_size() * s.settings.pickbox.max(1.0) * 1.5; let space = s.space(); - match crate::select::pick(s.doc()?, &space, p, ap) { + match s.pick_object(&space, p, ap)? { Some(h) => { self.obj = Some((h, p)); s.set_selection(vec![h]); diff --git a/crates/engine/src/cmd/modify/fillet.rs b/crates/engine/src/cmd/modify/fillet.rs index 2a75b22e7..b0cb32174 100644 --- a/crates/engine/src/cmd/modify/fillet.rs +++ b/crates/engine/src/cmd/modify/fillet.rs @@ -342,7 +342,7 @@ impl Interactive for FilletM { Input::Point(p) => { let ap = s.pixel_size() * s.settings.pickbox.max(1.0) * 1.5; let space = s.space(); - let Some(h) = crate::select::pick(s.doc()?, &space, p, ap) else { + let Some(h) = s.pick_object(&space, p, ap)? else { s.echo("*Invalid selection*"); return Ok(Step::Continue); }; diff --git a/crates/engine/src/cmd/modify/offset.rs b/crates/engine/src/cmd/modify/offset.rs index 20e6ba58e..17cd15b09 100644 --- a/crates/engine/src/cmd/modify/offset.rs +++ b/crates/engine/src/cmd/modify/offset.rs @@ -445,7 +445,7 @@ impl Interactive for OffsetM { (None, Input::Point(p)) => { let ap = s.pixel_size() * s.settings.pickbox.max(1.0) * 1.5; let space = s.space(); - match crate::select::pick(s.doc()?, &space, p, ap) { + match s.pick_object(&space, p, ap)? { Some(h) => { self.picked = Some(h); s.set_selection(vec![h]); diff --git a/crates/engine/src/cmd/trimextend.rs b/crates/engine/src/cmd/trimextend.rs index 4640c58ac..ab03d5c31 100644 --- a/crates/engine/src/cmd/trimextend.rs +++ b/crates/engine/src/cmd/trimextend.rs @@ -474,7 +474,7 @@ impl Interactive for TrimM { Input::Point(p) => { let ap = s.pixel_size() * s.settings.pickbox.max(1.0) * 1.5; let space = s.space(); - let Some(h) = crate::select::pick(s.doc()?, &space, p, ap) else { + let Some(h) = s.pick_object(&space, p, ap)? else { // A pick in empty space opens a crossing window there. self.stage = Stage::Crossing(Some(p)); return Ok(Step::Continue); diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index 2dea12394..8f84b35d7 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -142,6 +142,10 @@ pub struct Session { lisp_last: Option>, /// What the last HATCHPICK kept (the Hatch and Gradient dialog's picks). pub hatch_picks: Option, + /// The object named with a point for the input a prompt picking one object is taking + /// ([`Session::input_object`]): a pick at exactly that point picks that object + /// ([`Session::pick_object`]). + pick_hint: Option<(Handle, Vec2)>, } impl Default for Session { @@ -192,6 +196,7 @@ impl Session { lisp: lisp::LispState::default(), lisp_last: None, hatch_picks: None, + pick_hint: None, } } diff --git a/crates/engine/src/lisp/drawing.rs b/crates/engine/src/lisp/drawing.rs index 0042ea434..4db7d0c20 100644 --- a/crates/engine/src/lisp/drawing.rs +++ b/crates/engine/src/lisp/drawing.rs @@ -64,8 +64,10 @@ fn items(p: &PickSet) -> Vec { /// `(command arg…)`: arguments go to the command line as typed input: a string starts a command /// or answers a prompt ("" is Enter), a number or a point is entered, an entity name or a -/// selection set picks objects, and `pause` waits for the user. A command not finished by the -/// arguments stays active for the next `command` call. No arguments: cancel the active command. +/// selection set picks objects (a name, alone or with a point as `entsel` gives it, also answers +/// a prompt picking one object: [`Session::input_object`]), and `pause` waits for the user. A +/// command not finished by the arguments stays active for the next `command` call. No +/// arguments: cancel the active command. pub fn command(ctx: &mut Ctx<'_>, a: Vec) -> Result { if a.is_empty() { if ctx.s.running.is_some() { @@ -108,14 +110,14 @@ pub fn command(ctx: &mut Ctx<'_>, a: Vec) -> Result { } } } - Value::Ename(h) => feed(ctx.s, Input::Pick(vec![*h])), + Value::Ename(h) => named(ctx.s, *h, None), Value::PickSet(p) => feed(ctx.s, Input::Pick(items(p))), Value::Cons(_) => { if let Some(p) = arg.as_point() { feed(ctx.s, Input::Point(Vec2::new(p[0], p[1]))); } else if let Value::Ename(h) = arg.car() { // An `entsel` result: (ename point). - feed(ctx.s, Input::Pick(vec![h])); + named(ctx.s, h, arg.cdr().car().as_point().map(|p| Vec2::new(p[0], p[1]))); } else { return Err(LispError::bad_arg("command argument", arg)); } @@ -134,6 +136,14 @@ fn feed(s: &mut Session, input: Input) { } } +fn named(s: &mut Session, h: Handle, at: Option) { + if s.running.is_some() + && let Err(e) = s.input_object(h, at) + { + s.echo(e.to_string()); + } +} + // ---------------- system variables ---------------- /// A JSON value as LISP: integers, reals, strings, lists (points). diff --git a/crates/engine/src/lisp/tests.rs b/crates/engine/src/lisp/tests.rs index 58f421765..ca492e409 100644 --- a/crates/engine/src/lisp/tests.rs +++ b/crates/engine/src/lisp/tests.rs @@ -563,6 +563,111 @@ fn appload_and_load() { assert!(r["error"].as_str().is_some_and(|e| e.contains("bad argument type"))); } +/// `command` gives an entity name, alone or as `entsel` returns it (name and point), to a prompt +/// picking one object: the point picks that object, and a bare name stands at its DXF group 10 +/// point. Each call and its numbers are AutoCAD 2024's (accoreconsole, read back with `entget`); +/// AutoCAD ran TRIM and EXTEND in Standard mode there. +#[test] +fn command_names_objects_at_prompts_picking_one() { + use cadcraft_doc::EntityKind; + let near = |a: [f64; 2], b: [f64; 2]| (0..2).all(|i| (a[i] - b[i]).abs() <= 1e-9 * a[i].abs().max(1.0)); + // The drawing's points, lines and polyline widths after `forms`, each evaluated on its own. + let run = |forms: &[&str]| { + let mut s = session(); + ok(&mut s, "(setvar \"TRIMEXTENDMODE\" 0)"); + for f in forms { + ok(&mut s, f); + } + assert!(s.running.is_none(), "{forms:?}: a command is still running"); + let (mut points, mut lines, mut widths) = (Vec::new(), Vec::new(), Vec::new()); + for e in s.doc().unwrap().model.iter() { + match &e.kind { + EntityKind::Point(p) => points.push([p.p.x, p.p.y]), + EntityKind::Line(l) => lines.push(([l.a.x, l.a.y], [l.b.x, l.b.y])), + EntityKind::LwPolyline(pl) => widths.push(pl.const_width), + _ => {} + } + } + (points, lines, widths) + }; + let has_point = |points: &[[f64; 2]], p: [f64; 2]| points.iter().any(|q| near(*q, p)); + let has_line = |lines: &[([f64; 2], [f64; 2])], a: [f64; 2], b: [f64; 2]| lines.iter().any(|(p, q)| near(*p, a) && near(*q, b)); + let line = |name: &str, a: [f64; 2], b: [f64; 2]| { + format!("(setq {name} (progn (entmake '((0 . \"LINE\") (10 {} {} 0.0) (11 {} {} 0.0))) (entlast)))", a[0], a[1], b[0], b[1]) + }; + + // A circle named alone stands at its centre, where nothing is drawn. + let (points, ..) = run(&[ + "(setq a (progn (entmake '((0 . \"CIRCLE\") (10 0.0 0.0 0.0) (40 . 15.0))) (entlast)))", + "(command \"_.MEASURE\" a 10.275598705220492)", + ]); + assert!(points.len() == 9 && has_point(&points, [14.89599800946832, -1.763304653744166]), "{points:?}"); + // An arc named alone stands at its centre too, as near to either end: MEASURE runs from its + // end (250°), so its points run from 233.4° down to 34.4°, not from 46.6° up. + let (points, ..) = run(&[ + "(setq a (progn (entmake '((0 . \"ARC\") (10 -35000.0 81000.0 0.0) (40 . 1000.0) (50 . 0.5235987755982988) (51 . 4.363323129985824))) (entlast)))", + "(command \"_.MEASURE\" a 289.4960530820059)", + ]); + assert!(points.len() == 13 && has_point(&points, [-35596.04133310627, 80197.0462471419]), "{points:?}"); + assert!(has_point(&points, [-34174.59349504207, 81564.53883973838]), "{points:?}"); + // PEDIT takes a polyline by name. + let (_, _, widths) = run(&[ + "(setq a (progn (entmake '((0 . \"LWPOLYLINE\") (100 . \"AcDbEntity\") (100 . \"AcDbPolyline\") (90 . 3) (70 . 0) (10 0.0 0.0) (10 30.0 0.0) (42 . 0.4) (10 40.0 20.0))) (entlast)))", + "(command \"_.PEDIT\" a \"_W\" 1.25 \"\")", + ]); + assert_eq!(widths, [1.25]); + // `entsel` lists: the point picks the end LENGTHEN moves, BREAK's first point, the piece + // TRIM removes and the end EXTEND moves. + let (_, lines, _) = run(&[ + &line("a", [0.0, 0.0], [-11.745250375031729, -27.60523670660726]), + "(command \"_.LENGTHEN\" \"_DE\" 5.0 (list a '(-10.962233683362948 -25.764887592833446)) \"\")", + ]); + assert!(has_line(&lines, [0.0, 0.0], [-13.70279210420368, -32.2061094910418]), "{lines:?}"); + let (_, lines, _) = run(&[ + &line("a", [0.0, 0.0], [-97.11873949964188, 23.831710765295487]), + "(command \"_.BREAK\" (list a '(-19.77309329359773 4.852067095763353)) '(-77.20177993977879 18.94434070674469))", + ]); + assert!(lines.len() == 2 && has_line(&lines, [0.0, 0.0], [-19.77309329359773, 4.852067095763352]), "{lines:?}"); + assert!(has_line(&lines, [-77.20177993977879, 18.94434070674469], [-97.11873949964188, 23.83171076529548]), "{lines:?}"); + let (_, lines, _) = run(&[ + &line("a", [-38.39479850296135, -32.02872847799295], [38.39479850296135, 32.02872847799295]), + &line("b", [-9.422796057479543, -30.193534825244917], [-15.589739201426854, 9.328216303207391]), + &line("c", [35.428336962443794, 7.710053620262788], [-2.7893410422311042, 19.517216189270982]), + "(command \"_.TRIM\" a b c \"\" (list a '(1.9066151653265737 1.5904878218740615)) \"\")", + ]); + assert!(lines.len() == 4 && has_line(&lines, [-38.39479850296135, -32.02872847799294], [-12.50626762945319, -10.43265926101876]), "{lines:?}"); + assert!(has_line(&lines, [16.31949796010634, 13.61363490476688], [38.39479850296135, 32.02872847799294]), "{lines:?}"); + let (_, lines, _) = run(&[ + &line("a", [0.0, 0.0], [18.819750237318146, -6.7688256739971955]), + &line("b", [17.056820153998288, -35.36317014637398], [58.2221807952743, 8.2878674503852]), + "(command \"_.EXTEND\" a b \"\" (list a '(14.11481267798861 -5.076619255497897)) \"\")", + ]); + assert!(has_line(&lines, [0.0, 0.0], [37.63950047463629, -13.53765134799439]), "{lines:?}"); +} + +#[test] +fn a_named_object_holds_for_its_own_input_in_its_own_space() { + use cadcraft_doc::Space; + let mut s = session(); + ok(&mut s, "(setq a (progn (entmake '((0 . \"LINE\") (10 0.0 0.0 0.0) (11 10.0 0.0 0.0))) (entlast)))"); + // BREAK takes A at (5,3), off the line; a later pick there finds nothing. + ok(&mut s, "(command \"_.BREAK\" (list a '(5.0 3.0)))"); + assert!(s.prompt_text().contains("Specify second break point"), "{}", s.prompt_text()); + let model = s.space(); + assert_eq!(s.pick_object(&model, cadcraft_geom::Vec2::new(5.0, 3.0), 0.5).unwrap(), None); + s.cancel(); + // A paper-space copy of A named in model space picks nothing, not A under its start. + let p = { + let d = s.doc_mut().unwrap(); + let e = d.model.iter().next().unwrap(); + let (common, kind) = (e.common.clone(), e.kind.clone()); + d.add(&Space::Paper("Layout1".into()), common, kind).unwrap() + }; + ok(&mut s, &format!("(command \"_.BREAK\" (handent \"{}\"))", p.hex())); + assert!(s.prompt_text().contains("Select object"), "{}", s.prompt_text()); + s.cancel(); +} + #[test] fn appload_reads_a_lsp_path_and_reports_its_commands() { let dir = std::env::temp_dir().join(format!("cadcraft-appload-lisp-{}", std::process::id())); diff --git a/crates/engine/src/session/interactive.rs b/crates/engine/src/session/interactive.rs index e7cb07450..13d944d63 100644 --- a/crates/engine/src/session/interactive.rs +++ b/crates/engine/src/session/interactive.rs @@ -9,6 +9,7 @@ impl Session { /// Start a command by name or alias as if typed at the command line. pub fn start(&mut self, name: &str) -> Result<()> { self.last_polar = None; + self.pick_hint = None; let name = name.trim(); let (transparent, name) = match name.strip_prefix('\'') { Some(n) => (true, n), diff --git a/crates/engine/src/session/picking.rs b/crates/engine/src/session/picking.rs index 5646e8569..a9d146571 100644 --- a/crates/engine/src/session/picking.rs +++ b/crates/engine/src/session/picking.rs @@ -1,4 +1,4 @@ -use super::{Bounds2, Handle, Input, PendingWindow, Result, Session, Vec2, cmd, select}; +use super::{Bounds2, Drawing, Entity, Handle, Input, PendingWindow, Result, Session, Space, Vec2, cmd, select}; impl Session { // ---------------- picking without a command ---------------- @@ -125,4 +125,47 @@ impl Session { st.previous_selection = sel.to_vec(); } } + + // ---------------- one object by name ---------------- + + /// Give the running command an object by name, as AutoLISP's `command` does with an entity + /// name or an `entsel` list (name and point). A prompt picking one object with a point + /// (BREAK's "Select object", MEASURE's "Select object to measure"…) takes the point, and a + /// pick there finds that object ([`Session::pick_object`]) wherever it lies. A bare name + /// stands at the object's DXF group 10 point (a line's start, a circle's centre, a + /// polyline's first vertex), the point AutoCAD picks it at. The name holds for that input + /// only: a later pick at the same point finds what lies there. Other prompts take the object + /// as a pick. + pub fn input_object(&mut self, h: Handle, at: Option) -> Result<()> { + let one = self.current_prompt().is_some_and(|p| p.accept.point && !p.accept.select && p.picks_objects()); + let p = if one { at.or_else(|| self.doc().ok().and_then(|d| group_10(d, d.entity(h)?))) } else { None }; + let Some(p) = p.filter(|p| p.is_finite()) else { return self.input(Input::Pick(vec![h])) }; + self.pick_hint = Some((h, p)); + let r = self.input(Input::Point(p)); + self.pick_hint = None; + r + } + + /// The object a prompt picking one object finds at `p` in `space`: the one named for that + /// point ([`Session::input_object`]), which is none when it lies in another space, else the + /// object under `p` within `aperture`. + pub fn pick_object(&self, space: &Space, p: Vec2, aperture: f64) -> Result> { + let d = self.doc()?; + if let Some((h, q)) = self.pick_hint + && q == p + { + return Ok((d.space_of(h).as_ref() == Some(space)).then_some(h)); + } + Ok(select::pick(d, space, p, aperture)) + } +} + +/// An object's DXF group 10 point: the first point of its entity list, or its first grip where +/// entity lists are not built in. +fn group_10(d: &Drawing, e: &Entity) -> Option { + let Some(codec) = cmd::file::entity_codec() else { return e.kind.grips().first().copied() }; + let (_, tags) = (codec.groups)(d, e); + let i = tags.iter().position(|t| t.code == 10)?; + let y = tags.get(i + 1).filter(|t| t.code == 20)?; + Some(Vec2::new(tags[i].value.as_f64(), y.value.as_f64())) } diff --git a/docs/autolisp.md b/docs/autolisp.md index 8dd79129a..91a55c101 100644 --- a/docs/autolisp.md +++ b/docs/autolisp.md @@ -73,8 +73,9 @@ reached", malformed source is a reader error, and every built-in checks its argu - **Output and files:** `princ prin1 print prompt terpri alert open close read-line write-line findfile` - **Errors:** `*error*`, `vl-catch-all-apply vl-catch-all-error-p vl-catch-all-error-message` -- **Drawing:** `command` (also `command-s`, `vl-cmdf`) with `pause`, a command left open for the - next call, and `(command)` to cancel; `getvar setvar`; `entget entmake entmod entdel entlast +- **Drawing:** `command` (also `command-s`, `vl-cmdf`) with `pause`, entity names and `entsel` + lists at prompts picking one object (a bare name picks at its DXF group 10 point, as in AutoCAD), + a command left open for the next call, and `(command)` to cancel; `getvar setvar`; `entget entmake entmod entdel entlast entnext entupd handent`; `ssget` (modes X, L, P, I, W, C, F, WP, CP, a point, or the user selecting; filters with wildcards and `-4` operators) `ssadd ssdel sslength ssname ssmemb sssetfirst ssgetfirst`; `tblsearch tblnext` (LAYER, LTYPE, STYLE, BLOCK, DIMSTYLE, APPID) From 6ec6d97ea012c108f6ba0e9d571493a0670f945a Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:45:53 +0700 Subject: [PATCH 38/49] LISP: getvar and setvar take angle variables in radians (#2482) * LISP: getvar and setvar take angle variables in radians CADCraft keeps ANGBASE, SNAPANG, POLARANG, HPANG, CHAMFERD and DIMJOGANG in degrees as far as sysvars::get/set go, which is right for the SETVAR command, but AutoLISP's getvar returned those degrees and setvar took them: (getvar "DIMJOGANG") gave 45.0, and (setvar "ANGBASE" (/ pi 2)) set 1.57 degrees. AutoCAD 2024 gives and takes them in radians from AutoLISP: each set to 30 by SETVAR, or to (/ pi 6) by setvar, reads 0.5235987755982987. The LISP bridge now converts these six; the SETVAR command is unchanged. getangle_is_relative_to_angbase sets ANGBASE in radians accordingly. Co-Authored-By: Claude Opus 5.5 * SETVAR: keep real dimension variables real A dimension variable whose style field is a real (DIMJOGANG, DIMSCALE and the other real DIM* fields) is now stored as a real header value, even when the first value set is a whole number. SETVAR DIMJOGANG 45 followed by (setvar "DIMJOGANG" 0.5) no longer rejects the fractional degrees the radian value gives. Co-Authored-By: Claude Opus 5.5 * SETVAR: store the value the dimension style took A real dimension variable now stores the value its style field took after validation, so any input the style accepts (true for DIMSCALE gives 1) is stored as it was before. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/engine/src/lisp/drawing.rs | 18 +++++++++++++++- crates/engine/src/lisp/tests.rs | 35 ++++++++++++++++++++++++++++++- crates/engine/src/sysvars.rs | 7 +++++++ docs/autolisp.md | 2 ++ 4 files changed, 60 insertions(+), 2 deletions(-) diff --git a/crates/engine/src/lisp/drawing.rs b/crates/engine/src/lisp/drawing.rs index 4db7d0c20..88da7fd85 100644 --- a/crates/engine/src/lisp/drawing.rs +++ b/crates/engine/src/lisp/drawing.rs @@ -191,10 +191,22 @@ fn to_json_bounded(v: &Value, depth: usize, budget: &mut u64) -> Option bool { + RADIAN_VARS.iter().any(|v| v.eq_ignore_ascii_case(name.trim())) +} + pub fn getvar(ctx: &mut Ctx<'_>, a: Vec) -> Result { arity(&a, 1, 1)?; let name = string(&a[0])?; - Ok(Flow::Value(crate::sysvars::get(ctx.s, &name).map(|v| from_json(&v)).unwrap_or_default())) + Ok(Flow::Value(match crate::sysvars::get(ctx.s, &name) { + Some(serde_json::Value::Number(n)) if in_radians(&name) => Value::Real(n.as_f64().unwrap_or(0.0).to_radians()), + v => v.map(|v| from_json(&v)).unwrap_or_default(), + })) } /// Set a system variable after bounded JSON conversion, reporting invalid or oversized values as LISP errors. @@ -205,6 +217,10 @@ pub fn setvar(ctx: &mut Ctx<'_>, a: Vec) -> Result { let Some(json) = to_json_bounded(&a[1], 0, &mut budget) else { return Err(LispError::new(format!("AutoCAD variable setting rejected: {} value too large", to_text(&a[0], true)))); }; + let json = match json { + serde_json::Value::Number(n) if in_radians(&name) => serde_json::json!(n.as_f64().unwrap_or(0.0).to_degrees()), + other => other, + }; match crate::sysvars::set(ctx.s, &name, &json) { Ok(()) => Ok(Flow::Value(a[1].clone())), Err(_) => Err(LispError::new(format!("AutoCAD variable setting rejected: {} {}", to_text(&a[0], true), to_text(&a[1], true)))), diff --git a/crates/engine/src/lisp/tests.rs b/crates/engine/src/lisp/tests.rs index ca492e409..31e78bd15 100644 --- a/crates/engine/src/lisp/tests.rs +++ b/crates/engine/src/lisp/tests.rs @@ -528,7 +528,8 @@ fn interactive_routine_waits_for_the_user() { #[test] fn getangle_is_relative_to_angbase() { let mut s = session(); - s.cmdline("(setvar \"ANGBASE\" 90)").unwrap(); + // AutoLISP sets angle variables in radians: ANGBASE 90 degrees. + s.cmdline("(setvar \"ANGBASE\" (/ pi 2))").unwrap(); // A picked point at 180° in world terms is 90° from ANGBASE. s.cmdline("(setq a (getangle '(0 0)))").unwrap(); s.input(crate::Input::Point(cadcraft_geom::Vec2::new(-1.0, 0.0))).unwrap(); @@ -543,6 +544,38 @@ fn getangle_is_relative_to_angbase() { assert_eq!(to_text(&s.lisp_var("T2"), true), "3.14159"); } +/// `getvar` and `setvar` take angle variables in radians, as AutoCAD 2024's do (each set to 30 by +/// SETVAR, or to `(/ pi 6)` by `setvar`, reads 0.5235987755982987; DIMJOGANG's 45 degrees reads +/// 0.785398), while the SETVAR command keeps degrees. +#[test] +fn getvar_and_setvar_take_angle_variables_in_radians() { + let mut s = session(); + let degrees = |s: &Session, name: &str| crate::sysvars::get(s, name).and_then(|v| v.as_f64()).unwrap(); + // The defaults: polar tracking every 90 degrees, a 45-degree jog. + assert_eq!(ok(&mut s, "(list (equal (getvar \"POLARANG\") (/ pi 2) 1e-12) (equal (getvar \"DIMJOGANG\") (/ pi 4) 1e-12))"), "(T T)"); + // Set from LISP in radians, shown by SETVAR in degrees. + for (name, radians, deg) in + [("SNAPANG", "(/ pi 6)", 30.0), ("CHAMFERD", "0.95993108859688", 55.0), ("ANGBASE", "(/ pi 2)", 90.0), ("POLARANG", "(/ pi 4)", 45.0)] + { + ok(&mut s, &format!("(setvar \"{name}\" {radians})")); + assert!((degrees(&s, name) - deg).abs() < 1e-9, "{name}: {}", degrees(&s, name)); + assert_eq!(ok(&mut s, &format!("(equal (getvar \"{name}\") {radians} 1e-12)")), "T", "{name}"); + } + // Set by the SETVAR command in degrees, read by LISP in radians. + s.cmdline("SETVAR HPANG 45").unwrap(); + assert!((degrees(&s, "HPANG") - 45.0).abs() < 1e-9); + assert_eq!(ok(&mut s, "(equal (getvar \"HPANG\") 0.7853981633974482 1e-12)"), "T"); + // DIMJOGANG set to a whole number of degrees still takes a fraction of one from LISP. + s.cmdline("SETVAR DIMJOGANG 45").unwrap(); + ok(&mut s, "(setvar \"DIMJOGANG\" 0.5)"); + assert!((degrees(&s, "DIMJOGANG") - 0.5_f64.to_degrees()).abs() < 1e-9, "{}", degrees(&s, "DIMJOGANG")); + // It takes the value the dimension style takes: `true` is a DIMSCALE of 1. + crate::sysvars::set(&mut s, "DIMSCALE", &serde_json::json!(true)).unwrap(); + assert_eq!(crate::sysvars::get(&s, "DIMSCALE").and_then(|v| v.as_f64()), Some(1.0)); + // Other variables are as they were. + assert_eq!(ok(&mut s, "(getvar \"ANGDIR\")"), "0"); +} + #[test] fn appload_and_load() { let mut s = session(); diff --git a/crates/engine/src/sysvars.rs b/crates/engine/src/sysvars.rs index 945a694bc..5c0f3951c 100644 --- a/crates/engine/src/sysvars.rs +++ b/crates/engine/src/sysvars.rs @@ -396,6 +396,13 @@ pub fn set(s: &mut Session, name: &str, v: &Value) -> Result<()> { if !st.apply_fields(&serde_json::Map::from_iter([((*field).to_string(), v.clone())])).is_empty() { return Err(bad()); } + // A real style field (DIMJOGANG, DIMSCALE...) is a real variable, even set to a + // whole number first, so a later fraction still fits. It takes the value the style + // took. + if let Some(f) = serde_json::to_value(&st).ok().and_then(|j| j.get(*field).filter(|f| f.is_f64()).and_then(|f| f.as_f64())) { + d.header.set_f64(&n, f); + return Ok(()); + } } let val = match v { Value::Number(x) if x.is_i64() => cadcraft_doc::HVal::Int(x.as_i64().unwrap_or(0)), diff --git a/docs/autolisp.md b/docs/autolisp.md index 91a55c101..d89684d00 100644 --- a/docs/autolisp.md +++ b/docs/autolisp.md @@ -82,6 +82,8 @@ reached", malformed source is a reader error, and every built-in checks its argu - **Input:** `initget getpoint getcorner getdist getangle getorient getreal getint getstring getkword entsel nentsel` - **Units:** `rtos angtos distof angtof` +- **Angle variables:** `getvar` and `setvar` give and take ANGBASE, SNAPANG, POLARANG, HPANG, + CHAMFERD and DIMJOGANG in radians, as in AutoCAD; the SETVAR command shows them in degrees. - **No-ops:** `vl-load-com gc redraw`; `ver` Entity lists use the DXF group codes of CADCraft's DXF files: what `entget` returns is what a From 2be869a154e11026fb68e6c3bd1e6e8c44e8a6c0 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:45:57 +0700 Subject: [PATCH 39/49] Units and rtos: round a half away from zero, at 15 significant digits (#2484) Decimal and scientific numbers went through Rust's formatting, which rounds the exact binary value and a half to even: (rtos 1500.5 2 0) gave 1500, (rtos 0.125 2 2) 0.12 and (rtos 1.005 2 2) 1.00. AutoCAD 2024 gives 1501, 0.13 and 1.01: it rounds at 15 significant digits, with a half away from zero, for scientific notation too (2.5 to none is 3E+00). units::fixed does that on the decimal digits; format_distance's decimal and scientific forms and rtos use it. Co-authored-by: Claude Opus 5.5 --- crates/engine/src/lisp/drawing.rs | 2 +- crates/engine/src/units.rs | 94 ++++++++++++++++++++++++++----- 2 files changed, 81 insertions(+), 15 deletions(-) diff --git a/crates/engine/src/lisp/drawing.rs b/crates/engine/src/lisp/drawing.rs index 88da7fd85..238551094 100644 --- a/crates/engine/src/lisp/drawing.rs +++ b/crates/engine/src/lisp/drawing.rs @@ -1055,7 +1055,7 @@ pub fn rtos(ctx: &mut Ctx<'_>, a: Vec) -> Result { } fn decimal(v: f64, prec: usize, dimzin: i64) -> String { - let mut s = format!("{v:.prec$}"); + let mut s = crate::units::fixed(v, prec); if s.starts_with("-0") && s.trim_start_matches(['-', '0', '.']).is_empty() { s = s.trim_start_matches('-').to_string(); } diff --git a/crates/engine/src/units.rs b/crates/engine/src/units.rs index 0a18a0039..3c6f3456e 100644 --- a/crates/engine/src/units.rs +++ b/crates/engine/src/units.rs @@ -68,23 +68,62 @@ pub fn format_distance(v: f64, lunits: i64, luprec: i64) -> String { }; format!("{}{}{}", if neg { "-" } else { "" }, whole, fs) } - _ => format!("{:.*}", prec, v), + _ => fixed(v, prec), } } -/// Scientific notation with a signed exponent of at least two digits (`1.7500E+01`, `1.00E-05`). -fn scientific(v: f64, prec: usize) -> String { - let s = format!("{:.*E}", prec, v); - match s.split_once('E') { - Some((mantissa, exp)) => { - let (sign, digits) = match exp.strip_prefix('-') { - Some(d) => ('-', d), - None => ('+', exp), - }; - format!("{mantissa}E{sign}{digits:0>2}") - } - None => s, +/// `v` with `prec` decimals, rounded as AutoCAD rounds a number it shows (RTOS, LUNITS): at 15 +/// significant digits, with a half rounded away from zero. AutoCAD 2024 gives 1.01 for 1.005 to two +/// places (its binary value is just below 1.005), 3 for 2.5 and -0.13 for -0.125, where Rust's +/// formatting rounds the binary value and a half to even (1.00, 2 and -0.12). +pub fn fixed(v: f64, prec: usize) -> String { + let plain = || format!("{v:.prec$}"); + if !v.is_finite() { + return plain(); } + let sci = format!("{:.14e}", v.abs()); + let Some((mantissa, exp)) = sci.split_once('e') else { return plain() }; + let Ok(exp) = exp.parse::() else { return plain() }; + let sig: Vec = mantissa.bytes().filter(u8::is_ascii_digit).map(|b| b - b'0').collect(); + // Digit `k` of `sig` is worth 10^(exp - k); keep those down to 10^-prec, in units of 10^-prec. + let digit = |k: i64| usize::try_from(k).ok().and_then(|k| sig.get(k)).copied().unwrap_or(0); + let keep = exp + 1 + prec as i64; + let mut units: Vec = (0..keep).map(digit).collect(); + if keep >= 0 && digit(keep) >= 5 { + let mut carry = true; + for d in units.iter_mut().rev() { + if *d == 9 { + *d = 0; + } else { + *d += 1; + carry = false; + break; + } + } + if carry { + units.insert(0, 1); + } + } + let n: String = units.iter().map(|d| char::from(b'0' + d)).collect(); + let n = format!("{:0>width$}", n.trim_start_matches('0'), width = prec + 1); + let (int, frac) = n.split_at(n.len() - prec); + let body = if prec == 0 { int.to_string() } else { format!("{int}.{frac}") }; + if v < 0.0 && n.bytes().any(|b| b != b'0') { format!("-{body}") } else { body } +} + +/// Scientific notation with a signed exponent of at least two digits (`1.7500E+01`, `1.00E-05`), +/// the mantissa rounded as [`fixed`] rounds. +fn scientific(v: f64, prec: usize) -> String { + let s = format!("{:.14e}", v); + let Some((m, e)) = s.split_once('e') else { return s }; + let (Ok(m), Ok(mut e)) = (m.parse::(), e.parse::()) else { return s }; + let mut mantissa = fixed(m, prec); + // 9.99… rounded up to 10: one more power of ten. + if mantissa.trim_start_matches('-').starts_with("10") { + e += 1; + mantissa = fixed(m / 10.0, prec); + } + format!("{mantissa}E{}{:0>2}", if e < 0 { '-' } else { '+' }, e.abs()) } fn gcd(a: i64, b: i64) -> i64 { @@ -435,11 +474,38 @@ mod tests { assert_eq!(format_distance(11.6, 3, 0), "1'-0\""); } + /// RTOS in AutoCAD 2024 (accoreconsole, DIMZIN 0): a half rounds away from zero, at 15 + /// significant digits. + #[test] + fn numbers_round_as_autocad_rounds_them() { + for (v, prec, want) in [ + (1500.5, 0, "1501"), + (2.5, 0, "3"), + (-2.5, 0, "-3"), + (0.125, 2, "0.13"), + (0.5, 0, "1"), + (1.005, 2, "1.01"), + (3.5, 0, "4"), + (0.0625, 3, "0.063"), + (-0.125, 2, "-0.13"), + (1234.5678, 3, "1234.568"), + ] { + assert_eq!(format_distance(v, 2, prec), want, "{v} to {prec}"); + } + assert_eq!(format_distance(2.5, 1, 0), "3E+00"); + assert_eq!(format_distance(0.125, 1, 1), "1.3E-01"); + assert_eq!(format_distance(9.96, 1, 1), "1.0E+01"); + assert_eq!(fixed(-0.004, 2), "0.00"); + assert_eq!(fixed(1e-20, 3), "0.000"); + assert_eq!(fixed(123456789012.0, 1), "123456789012.0"); + } + #[test] fn scientific_exponent_is_signed_and_padded() { assert_eq!(format_distance(17.5, 1, 4), "1.7500E+01"); assert_eq!(format_distance(0.00001, 1, 2), "1.00E-05"); - assert_eq!(format_distance(1234.5, 1, 3), "1.234E+03"); + // 1.2345 is halfway: away from zero, as AutoCAD rounds 2.5 to 3E+00. + assert_eq!(format_distance(1234.5, 1, 3), "1.235E+03"); assert_eq!(format_distance(12345678.0, 1, 3), "1.235E+07"); assert_eq!(format_distance(-17.5, 1, 4), "-1.7500E+01"); assert_eq!(format_distance(0.0, 1, 2), "0.00E+00"); From dda6562a97bb96e60da37278a9b04e79a96246d7 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:46:01 +0700 Subject: [PATCH 40/49] Pick the object drawn last, not the nearest one (#2488) select::pick said it returns the topmost entity within the aperture, but it returned the nearest, using the draw order only to break ties. AutoCAD 2024 picks the object drawn last among those under the pickbox, and DRAWORDER changes which: a circle and a line drawn after it, 0.05 and 0.45 from the pick, give the line. Candidates already come topmost first, so pick_with returns the first within the aperture; pick_all keeps that order for selection cycling. Co-authored-by: Claude Opus 5.5 --- crates/engine/src/select.rs | 50 ++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 17 deletions(-) diff --git a/crates/engine/src/select.rs b/crates/engine/src/select.rs index d3db01c9b..6c70bee37 100644 --- a/crates/engine/src/select.rs +++ b/crates/engine/src/select.rs @@ -181,7 +181,9 @@ pub(crate) fn candidates<'a>( } } -/// The topmost entity within `aperture` of `p`. +/// The topmost entity within `aperture` of `p`: the one drawn last (on top in the draw order), not +/// the nearest, as AutoCAD 2024 picks (two objects under the pickbox: the one drawn later is +/// picked, and DRAWORDER changes which). pub fn pick(d: &Drawing, space: &Space, p: Vec2, aperture: f64) -> Option { let ix = spatial::index(d, space); pick_with(d, space, &ix, p, aperture) @@ -189,7 +191,7 @@ pub fn pick(d: &Drawing, space: &Space, p: Vec2, aperture: f64) -> Option>, p: Vec2, aperture: f64) -> Option { let probe = Bounds2::new(p, p).expand(aperture); - let mut best: Option<(f64, Handle)> = None; + // Candidates come topmost first: the first within the aperture is the one. for (e, known) in candidates(d, space, ix, &probe.expand(aperture), true, true)? { if !selectable(d, e) { continue; @@ -198,30 +200,24 @@ pub(crate) fn pick_with(d: &Drawing, space: &Space, ix: &Option Vec { let ix = spatial::index(d, space); let probe = Bounds2::new(p, p).expand(aperture); let Some(cands) = candidates(d, space, &ix, &probe.expand(aperture), true, true) else { return Vec::new() }; - let mut hits: Vec<(f64, Handle)> = cands + cands .filter(|(e, known)| selectable(d, e) && (is_infinite(e) || bounds_of(d, e, *known).expand(aperture).intersects(&probe))) - .map(|(e, _)| (entity_distance(d, e, p, aperture / 4.0), e.handle)) - .filter(|(dist, _)| *dist <= aperture) - .collect(); - hits.sort_by(|a, b| a.0.total_cmp(&b.0)); - hits.into_iter().map(|(_, h)| h).collect() + .filter(|(e, _)| entity_distance(d, e, p, aperture / 4.0) <= aperture) + .map(|(e, _)| e.handle) + .collect() } /// Whether PREVIEWFILTER keeps `e` from being highlighted under the cursor: bits 1 objects on @@ -486,6 +482,26 @@ mod tests { assert_eq!(fence_hits(EntityKind::XLine(line.clone()), [(0.0, 1.0), (0.0, 5.0)]), 0); assert_eq!(fence_hits(EntityKind::Ray(line), [(5.0, 1.0), (5.0, 5.0)]), 0); } + + /// Two objects under the pickbox: AutoCAD 2024 picks the one drawn last, not the nearer one, + /// and DRAWORDER changes which (`(ssget pt)` in accoreconsole). + #[test] + fn a_pick_takes_the_object_drawn_last() { + let mut d = Drawing::new_metric(); + let circle = d + .add(&Space::Model, Common::default(), EntityKind::Circle(cadcraft_doc::Circle { center: Vec3::new(50.0, 50.0, 0.0), radius: 10.0 })) + .unwrap(); + let line = EntityKind::Line(cadcraft_doc::Line { a: Vec3::new(40.5, 45.0, 0.0), b: Vec3::new(40.5, 55.0, 0.0) }); + let line = d.add(&Space::Model, Common::default(), line).unwrap(); + // 0.05 from the circle and 0.45 from the line, both inside an aperture of 1. + let p = Vec2::new(40.05, 50.0); + assert_eq!(pick(&d, &Space::Model, p, 1.0), Some(line)); + assert_eq!(pick_all(&d, &Space::Model, p, 1.0), vec![line, circle]); + d.model.send_to_back(line); + assert_eq!(pick(&d, &Space::Model, p, 1.0), Some(circle)); + // Only one within reach: that one, whatever the order. + assert_eq!(pick(&d, &Space::Model, Vec2::new(41.3, 50.0), 1.0), Some(line)); + } } #[cfg(test)] From 16ae23424d4c2e89c075eb653159322559d7b8cb Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:46:05 +0700 Subject: [PATCH 41/49] -INSERT: X, Y and Z presets, XYZ, and the Z factor AutoCAD stores (#2480) * -INSERT: X, Y and Z presets, XYZ, and the Z factor AutoCAD stores The insertion point prompt offers X, Y and Z: the factor for that axis alone, the others 1, and no scale prompts after the point. The X scale prompt offers XYZ, which asks X, Y and Z in turn. A Z factor not asked is the size of the X factor: X -1 with Y as X stored Z -1, where AutoCAD stores +1. Basepoint picks on the block dropped at the cursor, as AutoCAD drops it where it is being dragged (the origin in a script), instead of at its definition position. Each was measured in AutoCAD 2024 from AutoLISP's command and is pinned in insert_options_match_autocad. Co-Authored-By: Claude Opus 5.5 * -INSERT: store the Z factor as AutoCAD does after Scale, Z and XYZ Measured in AutoCAD 2024: Scale -2 gives X and Y -2 and Z 2; a Z preset of -3 gives Z 3; XYZ with X -2 and Enter at Y and Z gives Z 2; a Z typed at XYZ's Z prompt (-4) stays as typed. XYZ followed by a corner, with Corner or a point straight away, still asks for Z, which defaults to the size of the corner's X factor. Co-Authored-By: Claude Opus 5.5 * -INSERT: an axis preset after Scale changes that axis alone Measured in AutoCAD 2024: Scale -3 then X 2 gives 2/-3/3; X 2 then Scale -3 gives -3/-3/3; Scale 2 then Z -5 gives 2/2/5. Scale now sets all three presets, so a later X, Y or Z keeps the other two. Co-Authored-By: Claude Opus 5.5 * -INSERT test: Basepoint with the cursor away from the origin Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/blocks.rs | 121 ++++++++++++++++++++--- crates/engine/tests/it/insert_prompts.rs | 78 ++++++++++++++- 2 files changed, 182 insertions(+), 17 deletions(-) diff --git a/crates/engine/src/cmd/blocks.rs b/crates/engine/src/cmd/blocks.rs index ca4cfffec..8cc248685 100644 --- a/crates/engine/src/cmd/blocks.rs +++ b/crates/engine/src/cmd/blocks.rs @@ -202,13 +202,13 @@ pub(crate) fn insert(s: &mut Session, name: &str, at: Vec2, scale: f64, rotation insert_with(s, name, at, Vec2::new(scale, scale), rotation, None, values) } -/// The block reference INSERT places: X/Y scale factors, and an optional base point (in block +/// The block reference INSERT places: X/Y/Z scale factors, and an optional base point (in block /// coordinates) that lands on `at` instead of the block's own base point. -fn insert_entity(blk: &Block, at: Vec2, scale: Vec2, rotation: f64, base: Option) -> Insert { +fn insert_entity(blk: &Block, at: Vec2, scale: Vec3, rotation: f64, base: Option) -> Insert { let mut ins = Insert { block: blk.name.clone(), insert: v3(at), - scale: Vec3::new(scale.x, scale.y, scale.x), + scale, rotation, attribs: Vec::new(), cols: 1, @@ -223,7 +223,8 @@ fn insert_entity(blk: &Block, at: Vec2, scale: Vec2, rotation: f64, base: Option ins } -/// [`insert`] with separate X/Y scale factors and an optional base point (see [`insert_entity`]). +/// [`insert`] with separate X/Y scale factors (Z as X) and an optional base point (see +/// [`insert_entity`]). pub(crate) fn insert_with( s: &mut Session, name: &str, @@ -232,6 +233,19 @@ pub(crate) fn insert_with( rotation: f64, base: Option, values: &serde_json::Map, +) -> Result { + insert_scaled(s, name, at, Vec3::new(scale.x, scale.y, scale.x), rotation, base, values) +} + +/// [`insert_with`] with a Z scale factor of its own. +fn insert_scaled( + s: &mut Session, + name: &str, + at: Vec2, + scale: Vec3, + rotation: f64, + base: Option, + values: &serde_json::Map, ) -> Result { let blk = s.doc()?.block(name).cloned().ok_or_else(|| EngineError::Other(format!("Block \"{name}\" not found.")))?; let mut ins = insert_entity(&blk, at, scale, rotation, base); @@ -566,15 +580,19 @@ enum InsStage { /// A file whose block already exists: redefine it from the file? Redefine, Point, - /// Basepoint: a new base point, picked on the block shown at its definition position. + /// Basepoint: a new base point, picked on the block dropped where it was (at the cursor). BasePoint, /// Scale preset before the insertion point. PresetScale, + /// X, Y or Z scale preset (0, 1, 2) before the insertion point: that axis alone. + PresetAxis(usize), /// Rotate preset before the insertion point. PresetRotation, XScale, Corner, YScale, + /// XYZ: the Z scale factor, after X and Y. + ZScale, Rotation, Attribs, } @@ -587,6 +605,15 @@ struct InsertM { base: Option, x_scale: Option, scale: Option, + /// The Z scale factor when given (a preset or XYZ); otherwise the X factor's size. AutoCAD + /// keeps a Z factor typed at XYZ's Z prompt as given, and stores the size of any other. + z_scale: Option, + /// X/Y/Z presets given so far. + axes: [Option; 3], + /// XYZ at the X scale prompt: X, Y and Z are asked in turn. + xyz: bool, + /// Where the block was dropped to pick a Basepoint on it. + dropped: Option, rotation: Option, attdefs: Vec<(String, String, String)>, values: serde_json::Map, @@ -610,7 +637,7 @@ impl InsertM { && self.values.len() >= self.attdefs.len() && let (Some(n), Some(a), Some(sc), Some(r)) = (self.name.clone(), self.at, self.scale, self.rotation) { - let h = insert_with(s, &n, a, sc, r, self.base, &self.values)?; + let h = insert_scaled(s, &n, a, self.scale3(sc), r, self.base, &self.values)?; if self.explode { insert_file::explode_insert(s, h)?; } @@ -656,6 +683,23 @@ impl InsertM { } } + /// X/Y scale factors with Z: as given, else the X factor's size (AutoCAD 2024: X -1 with Y + /// as X stores Z +1). + /// X and Y from a corner: XYZ still asks Z, which defaults to the size of X. + fn corner_scale(&mut self, s: &mut Session, sc: Vec2) -> Result { + self.scale = Some(sc); + if self.xyz { + self.x_scale = Some(sc.x); + self.stage = InsStage::ZScale; + return Ok(Step::Continue); + } + self.advance(s) + } + + fn scale3(&self, sc: Vec2) -> Vec3 { + Vec3::new(sc.x, sc.y, self.z_scale.unwrap_or(sc.x.abs())) + } + /// Scale factors from an opposite corner: the X and Y distances from the insertion point. fn corner(a: Vec2, p: Vec2) -> Result { let d = p - a; @@ -686,15 +730,18 @@ impl Interactive for InsertM { let name = self.file.as_ref().map(|f| f.name.clone()).unwrap_or_default(); Prompt::new(format!("Block \"{name}\" already exists. Redefine it?"), super::curves::KW).kw(&["Yes", "No"]).default("N") } - InsStage::Point => Prompt::new("Specify insertion point", Accept::POINT).kw(&["Basepoint", "Scale", "Rotate"]), + InsStage::Point => Prompt::new("Specify insertion point", Accept::POINT).kw(&["Basepoint", "Scale", "X", "Y", "Z", "Rotate"]), InsStage::BasePoint => Prompt::new("Specify base point", Accept::POINT), InsStage::PresetScale => Prompt::new("Specify scale factor for XYZ axes", Accept::NUMBER).default("1"), + InsStage::PresetAxis(i) => Prompt::new(format!("Specify {} scale factor", ["X", "Y", "Z"][i.min(2)]), Accept::NUMBER).default("1"), InsStage::PresetRotation => Prompt::new("Specify rotation angle", Accept::NUMBER).default("0"), + InsStage::XScale if self.xyz => Prompt::new("Specify X scale factor", Accept::POINT_OR_NUMBER).kw(&["Corner"]).default("1").base(at), InsStage::XScale => { - Prompt::new("Enter X scale factor, specify opposite corner", Accept::POINT_OR_NUMBER).kw(&["Corner"]).default("1").base(at) + Prompt::new("Enter X scale factor, specify opposite corner", Accept::POINT_OR_NUMBER).kw(&["Corner", "XYZ"]).default("1").base(at) } InsStage::Corner => Prompt::new("Specify opposite corner", Accept::POINT).base(at), InsStage::YScale => Prompt::new("Enter Y scale factor", Accept::NUMBER).default("use X scale factor"), + InsStage::ZScale => Prompt::new("Specify Z scale factor or", Accept::NUMBER).default("use X scale factor"), InsStage::Rotation => Prompt::new("Specify rotation angle", Accept::POINT_OR_NUMBER).default("0").base(at), InsStage::Attribs => { let (_, prompt, default) = self.attdefs.get(self.values.len()).cloned().unwrap_or_default(); @@ -742,14 +789,25 @@ impl Interactive for InsertM { self.at = Some(p); return self.advance(s); } - Input::Keyword(k) if k == "Basepoint" => self.stage = InsStage::BasePoint, + Input::Keyword(k) if k == "Basepoint" => { + // AutoCAD drops the block where it is being dragged, at the cursor (the origin + // in a script: 2024 inserted (15, 5) for base point (612350.678, 2398770.432) + // and insertion point (612365.678, 2398775.432)). + self.dropped = Some(s.cursor); + self.stage = InsStage::BasePoint; + } Input::Keyword(k) if k == "Scale" => self.stage = InsStage::PresetScale, + Input::Keyword(k) if k == "X" => self.stage = InsStage::PresetAxis(0), + Input::Keyword(k) if k == "Y" => self.stage = InsStage::PresetAxis(1), + Input::Keyword(k) if k == "Z" => self.stage = InsStage::PresetAxis(2), Input::Keyword(k) if k == "Rotate" => self.stage = InsStage::PresetRotation, _ => {} }, InsStage::BasePoint => { if let Input::Point(p) = i { - self.base = Some(p); + // From the dropped block to its own coordinates. + let def = s.doc()?.block(self.name.as_deref().unwrap_or_default()).map_or(Vec2::ZERO, |b| b.base.xy()); + self.base = Some(def + (p - self.dropped.unwrap_or(def))); self.stage = InsStage::Point; } } @@ -760,12 +818,30 @@ impl Interactive for InsertM { _ => return Ok(Step::Continue), }; self.scale = Some(Vec2::new(f, f)); + self.z_scale = Some(f.abs()); + // An axis preset after it changes that axis alone (Scale -3 then X 2: 2/-3/3). + self.axes = [Some(f), Some(f), Some(f.abs())]; // Exploded insertion asks its one scale factor after the insertion point. if self.at.is_some() { return self.advance(s); } self.stage = InsStage::Point; } + // One axis preset: the others are 1, and no scale factors are asked after the point. + InsStage::PresetAxis(ax) => { + let f = match i { + Input::Text(t) => nonzero(&t)?, + Input::Enter => 1.0, + _ => return Ok(Step::Continue), + }; + if let Some(a) = self.axes.get_mut(ax) { + *a = Some(f); + } + let [x, y, z] = self.axes.map(|a| a.unwrap_or(1.0)); + self.scale = Some(Vec2::new(x, y)); + self.z_scale = Some(z.abs()); + self.stage = InsStage::Point; + } InsStage::PresetRotation => { self.rotation = Some(match i { Input::Text(t) => s.angle_settings().direction(&t).ok_or_else(|| EngineError::Other("Requires an angle.".into()))?, @@ -776,9 +852,10 @@ impl Interactive for InsertM { } InsStage::XScale => match i { Input::Keyword(k) if k == "Corner" => self.stage = InsStage::Corner, + Input::Keyword(k) if k == "XYZ" => self.xyz = true, Input::Point(p) => { - self.scale = Some(Self::corner(self.at.unwrap_or_default(), p)?); - return self.advance(s); + let sc = Self::corner(self.at.unwrap_or_default(), p)?; + return self.corner_scale(s, sc); } Input::Text(t) => { self.x_scale = Some(nonzero(&t)?); @@ -792,8 +869,8 @@ impl Interactive for InsertM { }, InsStage::Corner => { if let Input::Point(p) = i { - self.scale = Some(Self::corner(self.at.unwrap_or_default(), p)?); - return self.advance(s); + let sc = Self::corner(self.at.unwrap_or_default(), p)?; + return self.corner_scale(s, sc); } } InsStage::YScale => { @@ -804,6 +881,18 @@ impl Interactive for InsertM { _ => return Ok(Step::Continue), }; self.scale = Some(Vec2::new(x, y)); + if self.xyz { + self.stage = InsStage::ZScale; + return Ok(Step::Continue); + } + return self.advance(s); + } + InsStage::ZScale => { + self.z_scale = Some(match i { + Input::Text(t) => nonzero(&t)?, + Input::Enter => self.x_scale.unwrap_or(1.0).abs(), + _ => return Ok(Step::Continue), + }); return self.advance(s); } InsStage::Rotation => { @@ -832,7 +921,7 @@ impl Interactive for InsertM { let Some(b) = d.block(n) else { return Vec::new() }; // Picking a new base point: the block sits at its definition position. if self.stage == InsStage::BasePoint { - return vec![EntityKind::Insert(insert_entity(b, b.base.xy(), Vec2::new(1.0, 1.0), 0.0, None))]; + return vec![EntityKind::Insert(insert_entity(b, self.dropped.unwrap_or(b.base.xy()), Vec3::new(1.0, 1.0, 1.0), 0.0, None))]; } let at = self.at.unwrap_or(c); let scale = self.scale.unwrap_or_else(|| match (self.stage, self.x_scale) { @@ -841,7 +930,7 @@ impl Interactive for InsertM { _ => Vec2::new(1.0, 1.0), }); let rot = self.rotation.unwrap_or(if self.stage == InsStage::Rotation { at.angle_to(c) } else { 0.0 }); - vec![EntityKind::Insert(insert_entity(b, at, scale, rot, self.base))] + vec![EntityKind::Insert(insert_entity(b, at, self.scale3(scale), rot, self.base))] } } diff --git a/crates/engine/tests/it/insert_prompts.rs b/crates/engine/tests/it/insert_prompts.rs index 89ea729d3..00c5b8e41 100644 --- a/crates/engine/tests/it/insert_prompts.rs +++ b/crates/engine/tests/it/insert_prompts.rs @@ -1,4 +1,4 @@ -//! Command-line INSERT: X/Y scale prompts and the Basepoint/Scale/Rotate options (#245). +//! Command-line INSERT: X/Y/Z scale prompts and the Basepoint/Scale/X/Y/Z/Rotate options (#245). use cadcraft_engine::Session; use cadcraft_engine::doc::EntityKind; @@ -53,3 +53,79 @@ fn script_insert_reads_x_and_y_scale_then_rotation_and_honours_its_options() { s.execute("insert", &json!({ "name": "B1", "at": [0, 80], "scale": [2, 3], "basePoint": [10, 0] })).unwrap(); assert_eq!(inserts(&s).last(), Some(&(-20.0, 80.0, 2.0, 3.0, 0.0))); } + +/// (x, y, x scale, y scale, z scale, rotation in degrees) of the last block reference. +fn last_insert(s: &Session) -> (f64, f64, f64, f64, f64, f64) { + let r = |v: f64| (v * 1e9).round() / 1e9; + s.doc() + .unwrap() + .model + .iter() + .filter_map(|e| match &e.kind { + EntityKind::Insert(i) => Some((r(i.insert.x), r(i.insert.y), r(i.scale.x), r(i.scale.y), r(i.scale.z), r(i.rotation.to_degrees()))), + _ => None, + }) + .last() + .unwrap() +} + +/// The options of AutoCAD 2024's -INSERT, each run as AutoLISP's `command` gives it (accoreconsole, +/// the block reference read back with `entget`): X/Y/Z presets set that axis alone and skip the +/// scale prompts, XYZ asks Z too, a Z factor not asked is the X factor's size, and a Basepoint is +/// picked on the block dropped at the cursor (the origin in a script). +#[test] +fn insert_options_match_autocad() { + // A line (0,0)-(10,0) and a circle at (5,5) r 3, around `base`, as block `name`. + let block = |s: &mut Session, name: &str, base: [f64; 2], unit: f64| { + let at = |x: f64, y: f64| [base[0] + x * unit, base[1] + y * unit]; + s.execute("line", &json!({ "points": [at(0.0, 0.0), at(10.0, 0.0)] })).unwrap(); + s.execute("circle", &json!({ "center": at(5.0, 5.0), "radius": 3.0 * unit })).unwrap(); + let hs: Vec = s.doc().unwrap().model.handles().iter().map(|h| h.hex()).collect(); + s.execute("block", &json!({ "name": name, "base": base, "keep": "delete", "handles": hs })).unwrap(); + }; + let cases: [(&str, [f64; 2], f64, &str, (f64, f64, f64, f64, f64, f64)); 17] = [ + // X -1, Y as X: Z +1. + ("B3", [612345.678, 2398765.432], 1.0, "\"B3\" '(612365.678 2398775.432) -1 \"\" 0", (612365.678, 2398775.432, -1.0, -1.0, 1.0, 0.0)), + ("B4", [0.0, 0.0], 1.0, "\"B4\" \"_S\" 2.5 '(20.0 10.0) 45", (20.0, 10.0, 2.5, 2.5, 2.5, 45.0)), + ("B5", [0.0, 0.0], 1.0, "\"B5\" \"_R\" 60 '(20.0 10.0) 2 \"\"", (20.0, 10.0, 2.0, 2.0, 2.0, 60.0)), + // X alone: the next number is the rotation. + ("B6", [0.5, 0.25], 0.001, "\"B6\" \"_X\" 2 '(0.52 0.26) 3", (0.52, 0.26, 2.0, 1.0, 1.0, 3.0)), + ( + "B7", + [612345.678, 2398765.432], + 1.0, + "\"B7\" \"_B\" '(612350.678 2398770.432) '(612365.678 2398775.432) 1 \"\" 0", + (15.0, 5.0, 1.0, 1.0, 1.0, 0.0), + ), + ("B8", [0.0, 0.0], 1.0, "\"B8\" '(20.0 10.0) \"_XYZ\" 2 3 4 0", (20.0, 10.0, 2.0, 3.0, 4.0, 0.0)), + ("B9", [0.0, 0.0], 1.0, "\"B9\" '(20.0 10.0) \"_C\" '(26.0 14.0) 0", (20.0, 10.0, 6.0, 4.0, 6.0, 0.0)), + // Z is stored as a size unless typed at XYZ's Z prompt: Scale -2, XYZ -2 with Enter at Y + // and Z, and a Z preset of -3 all give +; XYZ's -4 stays. + ("C1", [0.0, 0.0], 1.0, "\"C1\" \"_S\" -2 '(20.0 10.0) 0", (20.0, 10.0, -2.0, -2.0, 2.0, 0.0)), + ("C2", [0.0, 0.0], 1.0, "\"C2\" '(20.0 10.0) \"_XYZ\" -2 \"\" \"\" 0", (20.0, 10.0, -2.0, -2.0, 2.0, 0.0)), + ("C5", [0.0, 0.0], 1.0, "\"C5\" \"_Z\" -3 '(20.0 10.0) 0", (20.0, 10.0, 1.0, 1.0, 3.0, 0.0)), + ("C6", [0.0, 0.0], 1.0, "\"C6\" '(20.0 10.0) \"_XYZ\" 2 3 -4 0", (20.0, 10.0, 2.0, 3.0, -4.0, 0.0)), + ("C7", [0.0, 0.0], 1.0, "\"C7\" \"_X\" -2 '(20.0 10.0) 0", (20.0, 10.0, -2.0, 1.0, 1.0, 0.0)), + // Scale and the axis presets in turn: the later one wins for its axes. + ("C8", [0.0, 0.0], 1.0, "\"C8\" \"_S\" -3 \"_X\" 2 '(20.0 10.0) 0", (20.0, 10.0, 2.0, -3.0, 3.0, 0.0)), + ("C9", [0.0, 0.0], 1.0, "\"C9\" \"_X\" 2 \"_S\" -3 '(20.0 10.0) 0", (20.0, 10.0, -3.0, -3.0, 3.0, 0.0)), + ("CA", [0.0, 0.0], 1.0, "\"CA\" \"_S\" 2 \"_Z\" -5 '(20.0 10.0) 0", (20.0, 10.0, 2.0, 2.0, 5.0, 0.0)), + // XYZ then a corner (by Corner or straight away) still asks Z, which defaults to X's size. + ("C3", [0.0, 0.0], 1.0, "\"C3\" '(20.0 10.0) \"_XYZ\" \"_C\" '(26.0 14.0) \"\" 0", (20.0, 10.0, 6.0, 4.0, 6.0, 0.0)), + ("C4", [0.0, 0.0], 1.0, "\"C4\" '(20.0 10.0) \"_XYZ\" '(14.0 14.0) \"\" 0", (20.0, 10.0, -6.0, 4.0, 6.0, 0.0)), + ]; + for (name, base, unit, args, want) in cases { + let mut s = Session::new(); + block(&mut s, name, base, unit); + s.cmdline(&format!("(command \"_.-INSERT\" {args})")).unwrap(); + assert!(s.running.is_none(), "{name}: {}", s.prompt_text()); + assert_eq!(last_insert(&s), want, "{name}"); + } + // Basepoint is picked on the block dropped at the cursor: with the cursor at (100, 50) + // instead of the origin, B7's call inserts 100 and 50 further on. + let mut s = Session::new(); + block(&mut s, "B7", [612345.678, 2398765.432], 1.0); + s.cursor = cadcraft_engine::geom::Vec2::new(100.0, 50.0); + s.cmdline("(command \"_.-INSERT\" \"B7\" \"_B\" '(612350.678 2398770.432) '(612365.678 2398775.432) 1 \"\" 0)").unwrap(); + assert_eq!(last_insert(&s), (115.0, 55.0, 1.0, 1.0, 1.0, 0.0)); +} From 50df1284a3feaabd28302536ba8642e0e80c0324 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:46:08 +0700 Subject: [PATCH 42/49] -HATCH: Properties asks the pattern's scale and angle, and takes Solid (#2481) * -HATCH: Properties asks the pattern's scale and angle, and takes Solid The pattern option asked only for a name, so a script answering it as AutoCAD asks (`_P ANSI31 2 45`) got "Unknown pattern 2" and "Unknown pattern 45" and a hatch at scale 1, angle 0, and `_P _S` reported "Unknown pattern _S". As AutoCAD 2024's -HATCH Properties does, the pattern name is now followed by its scale and then its angle (Enter keeps them), Solid (S, _S or SOLID) sets a solid fill and asks neither, and an unknown name or a refused value is asked again. The sCale and Angle options and the pattern picker are unchanged. Co-Authored-By: Claude Opus 5.5 * -HATCH: ask for the pattern again when a .pat file loads nothing A .pat file that cannot be read, or holds no pattern, now repeats the pattern prompt instead of going on to Scale and Angle with the previous pattern. Co-Authored-By: Claude Opus 5.5 * -HATCH: a pick at a Properties prompt asks again Enter keeps the current pattern, scale or angle; a point or an object (an entity name from LISP) answers none of those prompts, so the prompt comes again instead of going on with the value unchanged. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/hatch.rs | 118 +++++++++++++++++++++++---- crates/engine/tests/lin_pat_files.rs | 15 ++++ 2 files changed, 115 insertions(+), 18 deletions(-) diff --git a/crates/engine/src/cmd/hatch.rs b/crates/engine/src/cmd/hatch.rs index df0fef550..ca7defed8 100644 --- a/crates/engine/src/cmd/hatch.rs +++ b/crates/engine/src/cmd/hatch.rs @@ -550,6 +550,9 @@ struct HatchM { /// Loops by pick (one hatch each when separate). loops: Vec>, asking: Option, + /// The pattern was asked by the Pattern option: its scale and angle follow, as at AutoCAD's + /// -HATCH Properties. + properties: bool, /// "Select objects" mode instead of "Pick internal point"; the next HATCH starts in it again. selecting: bool, } @@ -561,6 +564,7 @@ impl HatchM { settings: HatchSettings::from(s, &Value::Null, gradient), loops: Vec::new(), asking: None, + properties: false, selecting: s.last_used.hatch_select, } } @@ -582,11 +586,13 @@ impl HatchM { h.set_i64("HPORIGINMODE", mode.index()); Ok(()) } - fn answer(&mut self, s: &mut Session, a: HatchAsk, t: &str) -> Result<()> { + /// Take an answer to sub-prompt `a`; false when it was refused. + fn answer(&mut self, s: &mut Session, a: HatchAsk, t: &str) -> Result { match a { HatchAsk::Pattern => { let up = match patfile::typed_file(s, t.trim()) { - Some(n) if n.is_empty() => return Ok(()), + // Nothing loaded from it: the pattern is asked again. + Some(n) if n.is_empty() => return Ok(false), Some(n) => n, None => t.trim().to_ascii_uppercase(), }; @@ -595,20 +601,19 @@ impl HatchM { s.doc_mut()?.header.set_str("HPNAME", &up); } else { s.echo(format!("Unknown pattern {up}. Available: {}", patfile::names().join(", "))); + return Ok(false); } } HatchAsk::Scale => { - if let Some(v) = super::machines::number(t).filter(|v| v.is_finite() && *v > 0.0) { - self.settings.scale = v; - s.doc_mut()?.header.set_f64("HPSCALE", v); - } + let Some(v) = super::machines::number(t).filter(|v| v.is_finite() && *v > 0.0) else { return Ok(false) }; + self.settings.scale = v; + s.doc_mut()?.header.set_f64("HPSCALE", v); } HatchAsk::Angle => { // Turns the pattern from the X axis (not from ANGBASE), clockwise when ANGDIR is 1. - if let Some(a) = s.angle_settings().rotation(t).filter(|a| a.is_finite()) { - self.settings.angle = a; - s.doc_mut()?.header.set_f64("HPANG", a); - } + let Some(a) = s.angle_settings().rotation(t).filter(|a| a.is_finite()) else { return Ok(false) }; + self.settings.angle = a; + s.doc_mut()?.header.set_f64("HPANG", a); } HatchAsk::Origin => { let mode = match t { @@ -622,7 +627,22 @@ impl HatchM { self.set_origin(s, None, mode)?; } } - Ok(()) + Ok(true) + } + + /// The sub-prompt that follows `a` (`taken`: its answer was taken). The Pattern option goes + /// on, as AutoCAD 2024's -HATCH Properties does, from the pattern name to its scale and then + /// its angle (a solid fill has neither), and asks again for a pattern or a value it refused. + fn after(&self, a: HatchAsk, taken: bool) -> Option { + if !self.properties { + return None; + } + match a { + _ if !taken => Some(a), + HatchAsk::Pattern if self.settings.pattern != "SOLID" => Some(HatchAsk::Scale), + HatchAsk::Scale => Some(HatchAsk::Angle), + _ => None, + } } } @@ -643,9 +663,10 @@ impl Interactive for HatchM { // The sub-prompts offer the current value: Enter keeps it. match self.asking { Some(HatchAsk::Pattern) => { - return Prompt::new("Enter a pattern name", Accept::TEXT) + let p = Prompt::new("Enter a pattern name", Accept::TEXT) .default(self.settings.pattern.clone()) .picker(Picker::HatchPattern(self.settings.pattern.clone())); + return if self.gradient { p } else { p.kw(&["Solid"]) }; } Some(HatchAsk::Scale) => { return Prompt::new("Specify a scale for the hatch pattern", Accept::NUMBER).default(format!("{:.4}", self.settings.scale)); @@ -686,11 +707,19 @@ impl Interactive for HatchM { } fn input(&mut self, s: &mut Session, i: Input) -> Result { if let Some(a) = self.asking.take() { - match &i { - Input::Point(p) if a == HatchAsk::Origin => self.set_origin(s, Some(*p), OriginMode::Current)?, + let taken = match &i { + Input::Point(p) if a == HatchAsk::Origin => { + self.set_origin(s, Some(*p), OriginMode::Current)?; + true + } + Input::Keyword(k) if a == HatchAsk::Pattern && k == "Solid" => self.answer(s, a, "SOLID")?, Input::Text(t) | Input::Keyword(t) => self.answer(s, a, t)?, - _ => {} - } + // Enter keeps the current value; a point or a pick answers none of these prompts. + Input::Enter => true, + _ => false, + }; + self.asking = self.after(a, taken); + self.properties &= self.asking.is_some(); return Ok(Step::Continue); } match i { @@ -723,7 +752,10 @@ impl Interactive for HatchM { "Select objects" => self.set_mode(s, true), "picK internal point" => self.set_mode(s, false), "Undo" => self.loops.clear(), - "Pattern" | "seTtings" => self.asking = Some(HatchAsk::Pattern), + "Pattern" | "seTtings" => { + self.asking = Some(HatchAsk::Pattern); + self.properties = !self.gradient; + } "sCale" => self.asking = Some(HatchAsk::Scale), "Angle" => self.asking = Some(HatchAsk::Angle), "Origin" => self.asking = Some(HatchAsk::Origin), @@ -738,7 +770,7 @@ impl Interactive for HatchM { } // A pattern chosen in the picker while boundaries are picked. Input::Text(t) if !self.gradient => { - self.answer(s, HatchAsk::Pattern, &t)?; + let _ = self.answer(s, HatchAsk::Pattern, &t)?; Ok(Step::Continue) } // Enter ends boundary picking in either mode and creates the hatch. @@ -838,6 +870,9 @@ mod tests { s.input(Input::Keyword("Pattern".into())).unwrap(); assert!(s.current_prompt().unwrap().picker.is_some()); s.input(Input::Text("BRICK".into())).unwrap(); + // Its scale and angle follow; Enter keeps them. + s.input(Input::Enter).unwrap(); + s.input(Input::Enter).unwrap(); s.input(Input::Point(Vec2::new(5.0, 5.0))).unwrap(); s.input(Input::Enter).unwrap(); assert_eq!(only_hatch(&s).1.pattern, "BRICK"); @@ -851,6 +886,53 @@ mod tests { assert!(s.current_prompt().unwrap().picker.is_none()); } + /// -HATCH's Properties as AutoCAD 2024 takes them from AutoLISP's `command` (accoreconsole, the + /// hatch read back with `entget`): a pattern name, then its scale and angle (Enter keeps them); + /// Solid (`S`, `_S` or SOLID) asks neither; an unknown name is asked again. + #[test] + fn hatch_properties_ask_pattern_scale_and_angle_as_autocad() { + // (properties given, pattern, solid, scale, angle in degrees) + let cases: [(&str, &str, bool, f64, f64); 7] = [ + ("\"ANSI31\" 2 45 \"_S\" (entlast) \"\"", "ANSI31", false, 2.0, 45.0), + ("\"_S\" \"_S\" (entlast) \"\"", "SOLID", true, 1.0, 0.0), + ("\"ANSI37\" 0.5 30 '(5.0 5.0)", "ANSI37", false, 0.5, 30.0), + ("\"ANSI31\" \"\" \"\" '(5.0 5.0)", "ANSI31", false, 1.0, 0.0), + ("\"S\" '(5.0 5.0)", "SOLID", true, 1.0, 0.0), + ("\"SOLID\" '(5.0 5.0)", "SOLID", true, 1.0, 0.0), + ("\"XYZ\" \"ANSI31\" 1 0 '(5.0 5.0)", "ANSI31", false, 1.0, 0.0), + ]; + for (props, pattern, solid, scale, angle) in cases { + let mut s = Session::new(); + s.execute("circle", &json!({ "center": [20, 15], "radius": 8 })).unwrap(); + s.execute("rectang", &json!({ "p1": [0, 0], "p2": [40, 30] })).unwrap(); + s.cmdline("(setvar \"HPNAME\" \"ANSI31\")").unwrap(); + s.cmdline("(setvar \"HPSCALE\" 1.0)").unwrap(); + s.cmdline("(setvar \"HPANG\" 0.0)").unwrap(); + s.cmdline(&format!("(command \"_.-HATCH\" \"_P\" {props} \"\")")).unwrap(); + assert!(s.running.is_none(), "{props}: {}", s.prompt_text()); + let h = only_hatch(&s).1; + assert!( + h.pattern == pattern && h.solid == solid && (h.scale - scale).abs() < 1e-12 && (h.angle - angle.to_radians()).abs() < 1e-12, + "{props}: {} {} {} {}", + h.pattern, + h.solid, + h.scale, + h.angle.to_degrees() + ); + } + // An object (an entity name from LISP) answers none of these prompts: each is asked again. + let mut s = Session::new(); + s.execute("rectang", &json!({ "p1": [0, 0], "p2": [40, 30] })).unwrap(); + let h = s.doc().unwrap().model.handles()[0]; + s.cmdline("(command \"_.-HATCH\" \"_P\")").unwrap(); + s.input(crate::Input::Pick(vec![h])).unwrap(); + assert!(s.prompt_text().contains("Enter a pattern name"), "{}", s.prompt_text()); + s.cmdline("ANSI31").unwrap(); + s.input(crate::Input::Pick(vec![h])).unwrap(); + assert!(s.prompt_text().contains("Specify a scale for the hatch pattern"), "{}", s.prompt_text()); + s.cancel(); + } + #[test] fn unknown_pattern_error_and_catalog_name_the_pat_file_route() { let mut s = Session::new(); diff --git a/crates/engine/tests/lin_pat_files.rs b/crates/engine/tests/lin_pat_files.rs index b09b504d4..91f99062e 100644 --- a/crates/engine/tests/lin_pat_files.rs +++ b/crates/engine/tests/lin_pat_files.rs @@ -137,6 +137,9 @@ fn hatch_pattern_prompt_takes_a_pat_file_name() { s.cmdline("hatch").unwrap(); s.cmdline("p").unwrap(); s.cmdline(&path).unwrap(); + // Its scale and angle follow; Enter keeps them. + s.cmdline("").unwrap(); + s.cmdline("").unwrap(); // The pattern named like the file is the one used. s.cmdline("5,5").unwrap(); s.cmdline("").unwrap(); @@ -148,9 +151,21 @@ fn hatch_pattern_prompt_takes_a_pat_file_name() { s.cmdline("hatch").unwrap(); s.cmdline("p").unwrap(); s.cmdline("myother").unwrap(); + s.cmdline("").unwrap(); + s.cmdline("").unwrap(); s.cmdline("5,5").unwrap(); s.cmdline("").unwrap(); assert_eq!(hatches(&s).iter().filter(|h| h.pattern == "MYOTHER").count(), 1); + + // A file with no pattern in it, or none at all, asks for the pattern again. + let empty = dir.file("EMPTY.pat", ";; no patterns\n"); + for file in [empty, dir.path_str("MISSING.pat")] { + s.cmdline("hatch").unwrap(); + s.cmdline("p").unwrap(); + s.cmdline(&file).unwrap(); + assert!(s.prompt_text().contains("Enter a pattern name"), "{file}: {}", s.prompt_text()); + s.cancel(); + } } #[test] From 6350c5b14569288f23bb9bc709efce56c6ed5547 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:46:12 +0700 Subject: [PATCH 43/49] Extents: count layers that are turned off, as AutoCAD does (#2485) * Extents: count layers that are turned off, as AutoCAD does Drawing::extents (ZOOM Extents, EXTMIN/EXTMAX, $EXTMIN/$EXTMAX, Extents plots) left out layers turned off as well as frozen ones. AutoCAD 2024 leaves out only frozen layers: lines from the origin to (10, 10) on layer 0, (100, 0) on a layer turned off and (0, 200) on a frozen one give EXTMAX (100.03, 10.01); inside a block too, and a reference on a frozen layer counts for nothing. Drawing::in_extents keeps a layer turned off, and extent_bounds counts block contents on one. entity_bounds, which the spatial index and selection use, still measures only what is drawn. Co-Authored-By: Claude Opus 5.5 * Extents: leave out attributes on frozen layers An insert's attribute lies on its own layer, else on its definition's, as the renderer draws it. One on a frozen layer no longer stretches the extents; one on a layer turned off still counts, as other objects do. Co-Authored-By: Claude Opus 5.5 * Extents test: build the attribute without an unreachable arm Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/doc/src/extents.rs | 52 +++++++++++---- crates/doc/src/lib.rs | 14 ++-- crates/doc/src/tests.rs | 131 ++++++++++++++++++++++++++++++++------ 3 files changed, 159 insertions(+), 38 deletions(-) diff --git a/crates/doc/src/extents.rs b/crates/doc/src/extents.rs index d7c7c7a8a..1971acadd 100644 --- a/crates/doc/src/extents.rs +++ b/crates/doc/src/extents.rs @@ -36,11 +36,26 @@ fn text_box(t: &crate::Text, len: usize) -> Bounds2 { /// as when drawing. Dimensional constraints of dynamic blocks (layer `*ADSK_CONSTRAINTS`) and the /// entities a visibility state hides are invisible this way, and they sit far from the block's /// geometry in real drawings. Layer "0" takes the insert's layer, which the caller has checked. -fn in_block_visible(d: &Drawing, e: &Entity) -> bool { +/// `off_counts`: a layer turned off counts too, as in the drawing's extents ([`extent_bounds`]). +fn in_block_visible(d: &Drawing, e: &Entity, off_counts: bool) -> bool { // Attribute definitions are not drawn in an insert (its attribs are, see below). - !matches!(e.kind, EntityKind::AttDef(_)) - && e.common.visible - && (e.common.layer == "0" || d.layer(&e.common.layer).is_none_or(crate::Layer::visible)) + !matches!(e.kind, EntityKind::AttDef(_)) && e.common.visible && layer_counts(d, &e.common.layer, off_counts) +} + +/// Whether what lies on `layer` inside an insert counts: layer "0" takes the insert's layer, which +/// the caller has checked; a frozen layer never counts, one turned off only with `off_counts`. +fn layer_counts(d: &Drawing, layer: &str, off_counts: bool) -> bool { + layer == "0" || d.layer(layer).is_none_or(|l| !l.frozen && (l.on || off_counts)) +} + +/// The layer an insert's attribute draws on, as the renderer takes it: its own, else its +/// definition's (layer "0" being the insert's). +fn attrib_layer<'a>(d: &'a Drawing, ins: &crate::Insert, a: &'a crate::Attrib) -> &'a str { + a.props.layer.as_deref().unwrap_or_else(|| { + d.block(&ins.block) + .and_then(|blk| blk.entities.iter().find(|be| matches!(&be.kind, EntityKind::AttDef(ad) if ad.tag.eq_ignore_ascii_case(&a.tag)))) + .map_or("0", |be| be.common.layer.as_str()) + }) } /// A text that draws no glyph (empty, or only blanks and non-breaking spaces) takes no room. @@ -75,16 +90,27 @@ fn mtext_box(t: &crate::MText) -> Bounds2 { Bounds2::from_points(pts) } +/// The box of what `e` draws (block contents on layers turned off left out). pub fn entity_bounds(d: &Drawing, e: &Entity, depth: usize) -> Bounds2 { + bounds_of(d, e, depth, false) +} + +/// The box `e` takes in the drawing's extents: as [`entity_bounds`], but block contents on a layer +/// turned off count, as AutoCAD 2024's ZOOM Extents counts them (a frozen layer's do not). +pub fn extent_bounds(d: &Drawing, e: &Entity) -> Bounds2 { + bounds_of(d, e, 0, true) +} + +fn bounds_of(d: &Drawing, e: &Entity, depth: usize, off_counts: bool) -> Bounds2 { // A top-level annotative object measures as it draws at the current annotation scale. if depth == 0 { match d.anno_draw(e) { crate::AnnoDraw::Plain => {} crate::AnnoDraw::Hidden => return Bounds2::EMPTY, - crate::AnnoDraw::Scaled(f) => return bounds_in(d, &crate::anno_scaled(e, f), 0, &mut HashMap::new()), + crate::AnnoDraw::Scaled(f) => return bounds_in(d, &crate::anno_scaled(e, f), 0, &mut HashMap::new(), off_counts), } } - bounds_in(d, e, depth, &mut HashMap::new()) + bounds_in(d, e, depth, &mut HashMap::new(), off_counts) } /// [`entity_bounds`] with the bounds of block contents (in block coordinates) already computed, @@ -93,7 +119,7 @@ pub fn entity_bounds(d: &Drawing, e: &Entity, depth: usize) -> Bounds2 { /// definition per depth instead of one per reference (which grows exponentially with the nesting /// depth). The depth is part of the key because [`MAX_BLOCK_DEPTH`] cuts a deep visit short: its /// bounds must not stand in for a shallower reference to the same block (#706). -fn bounds_in<'a>(d: &'a Drawing, e: &Entity, depth: usize, blocks: &mut HashMap<(&'a str, usize), Bounds2>) -> Bounds2 { +fn bounds_in<'a>(d: &'a Drawing, e: &Entity, depth: usize, blocks: &mut HashMap<(&'a str, usize), Bounds2>, off_counts: bool) -> Bounds2 { match &e.kind { EntityKind::Table(t) if t.is_broken() => t.bounds(), EntityKind::Text(t) if blank(&t.value) => Bounds2::EMPTY, @@ -115,8 +141,8 @@ fn bounds_in<'a>(d: &'a Drawing, e: &Entity, depth: usize, blocks: &mut HashMap< Some(b) => *b, None => { let mut inner = Bounds2::EMPTY; - for be in blk.entities.iter().filter(|be| in_block_visible(d, be)) { - inner = inner.union(&bounds_in(d, be, depth + 1, blocks)); + for be in blk.entities.iter().filter(|be| in_block_visible(d, be, off_counts)) { + inner = inner.union(&bounds_in(d, be, depth + 1, blocks, off_counts)); } blocks.insert((blk.name.as_str(), depth), inner); inner @@ -131,7 +157,7 @@ fn bounds_in<'a>(d: &'a Drawing, e: &Entity, depth: usize, blocks: &mut HashMap< } } for a in &ins.attribs { - if !a.invisible { + if !a.invisible && layer_counts(d, attrib_layer(d, ins, a), off_counts) { b = b.union(&match a.multiline_text() { Some(m) => mtext_box(&m), None => text_box(&a.text, a.text.value.chars().count()), @@ -172,8 +198,8 @@ fn bounds_in<'a>(d: &'a Drawing, e: &Entity, depth: usize, blocks: &mut HashMap< Some(cached) => *cached, None => { let mut inner = Bounds2::EMPTY; - for be in blk.entities.iter().filter(|be| in_block_visible(d, be)) { - inner = inner.union(&bounds_in(d, be, depth + 1, blocks)); + for be in blk.entities.iter().filter(|be| in_block_visible(d, be, off_counts)) { + inner = inner.union(&bounds_in(d, be, depth + 1, blocks, off_counts)); } blocks.insert((blk.name.as_str(), depth), inner); inner @@ -193,7 +219,7 @@ fn bounds_in<'a>(d: &'a Drawing, e: &Entity, depth: usize, blocks: &mut HashMap< } if let Some(ins) = &m.block { let be = Entity { handle: e.handle, common: e.common.clone(), kind: EntityKind::Insert(ins.clone()) }; - b = b.union(&bounds_in(d, &be, depth, blocks)); + b = b.union(&bounds_in(d, &be, depth, blocks, off_counts)); } b } diff --git a/crates/doc/src/lib.rs b/crates/doc/src/lib.rs index d970a6a56..e07a08609 100644 --- a/crates/doc/src/lib.rs +++ b/crates/doc/src/lib.rs @@ -27,7 +27,7 @@ pub use cadcraft_color as color; pub use cadcraft_geom as geom; pub use constraint::*; pub use entity::*; -pub use extents::{MAX_BLOCK_DEPTH, entity_bounds}; +pub use extents::{MAX_BLOCK_DEPTH, entity_bounds, extent_bounds}; pub use format::Format; pub use gdt::*; pub use header::{HVal, Header}; @@ -369,13 +369,19 @@ impl Drawing { !self.hidden_objects.is_empty() && self.hidden_objects.contains(&h) } - /// Bounds of all visible entities in a space. + /// Whether an entity counts in the extents: as AutoCAD 2024 counts it for ZOOM Extents and + /// EXTMIN/EXTMAX, on a layer that is off too, but not on a frozen one. + pub fn in_extents(&self, e: &Entity) -> bool { + e.common.visible && self.layer(&e.common.layer).is_none_or(|l| !l.frozen) && !self.is_hidden_object(e.handle) + } + + /// Bounds of the entities in a space that count in its extents ([`Drawing::in_extents`]). pub fn extents(&self, space: &Space) -> cadcraft_geom::Bounds2 { let mut b = cadcraft_geom::Bounds2::EMPTY; if let Some(store) = self.space(space) { for e in store.iter() { - if self.is_visible(e) { - b = b.union(&entity_bounds(self, e, 0)); + if self.in_extents(e) { + b = b.union(&extent_bounds(self, e)); } } } diff --git a/crates/doc/src/tests.rs b/crates/doc/src/tests.rs index 067d42ac0..f0f979f12 100644 --- a/crates/doc/src/tests.rs +++ b/crates/doc/src/tests.rs @@ -44,15 +44,85 @@ fn add_and_extents() { } #[test] -fn hidden_layers_excluded_from_extents() { +fn frozen_layers_are_left_out_of_extents_and_layers_turned_off_are_not() { let mut d = Drawing::new_imperial(); let c = Common { layer: "Hidden".into(), ..Default::default() }; d.add(&Space::Model, c, line((100.0, 100.0), (200.0, 200.0))).unwrap(); d.add(&Space::Model, Common::default(), line((0.0, 0.0), (1.0, 1.0))).unwrap(); d.layer_mut("Hidden").unwrap().on = false; + assert_eq!(d.extents(&Space::Model).max, Vec2::new(200.0, 200.0)); + d.layer_mut("Hidden").unwrap().frozen = true; assert_eq!(d.extents(&Space::Model).max, Vec2::new(1.0, 1.0)); } +/// ZOOM Extents in AutoCAD 2024 (accoreconsole, EXTMIN/EXTMAX read back; AutoCAD pads them by a +/// few hundredths): a layer turned off counts and a frozen one does not, for an entity, for an +/// entity inside a block, and for a block reference itself. +#[test] +fn extents_count_layers_turned_off_as_autocad() { + let mut d = Drawing::new_imperial(); + for (name, on, frozen) in [("OFFL", false, false), ("FRZ", true, true), ("BOFF", false, false), ("BFRZ", true, true)] { + let mut l = Layer::new(name); + (l.on, l.frozen) = (on, frozen); + d.layers.push(l); + } + for (layer, b) in [("0", (10.0, 10.0)), ("OFFL", (100.0, 0.0)), ("FRZ", (0.0, 200.0))] { + d.add(&Space::Model, Common { layer: layer.into(), ..Default::default() }, line((0.0, 0.0), b)).unwrap(); + } + // AutoCAD: (-0.013, -0.009)…(100.027, 10.006). + assert_eq!(extents_pair(&d), (Vec2::ZERO, Vec2::new(100.0, 10.0))); + + let mut d = Drawing::new_imperial(); + for (name, on, frozen) in [("FRZ", true, true), ("BOFF", false, false), ("BFRZ", true, true)] { + let mut l = Layer::new(name); + (l.on, l.frozen) = (on, frozen); + d.layers.push(l); + } + let mut blk = Block::new("BX"); + blk.entities.push(on_layer("0", line((0.0, 0.0), (1.0, 1.0)), 1)); + blk.entities.push(on_layer("BOFF", line((0.0, 0.0), (50.0, 0.0)), 2)); + blk.entities.push(on_layer("BFRZ", line((0.0, 0.0), (0.0, 70.0)), 3)); + d.blocks.insert("BX".into(), std::sync::Arc::new(blk)); + let at = |x: f64| match plain_insert("BX") { + EntityKind::Insert(i) => EntityKind::Insert(Insert { insert: Vec3::new(x, x, 0.0), ..i }), + k => k, + }; + d.add(&Space::Model, Common::default(), at(1000.0)).unwrap(); + d.add(&Space::Model, Common { layer: "FRZ".into(), ..Default::default() }, at(-500.0)).unwrap(); + // AutoCAD: (1000, 1000)…(1050, 1001). + assert_eq!(extents_pair(&d), (Vec2::new(1000.0, 1000.0), Vec2::new(1050.0, 1001.0))); + + // An insert's attributes lie on their own layer, else on their definition's: one on a frozen + // layer either way does not count, one on a layer turned off does. + let mut d = Drawing::new_imperial(); + for (name, on, frozen) in [("IOFF", false, false), ("AOFF", false, false), ("AFRZ", true, true)] { + let mut l = Layer::new(name); + (l.on, l.frozen) = (on, frozen); + d.layers.push(l); + } + let attrib = |tag: &str, at: (f64, f64), layer: Option<&str>| { + let mut a = plain_attrib(tag); + a.text.insert = Vec3::new(at.0, at.1, 0.0); + a.props.layer = layer.map(str::to_string); + a + }; + let mut blk = Block::new("BA"); + blk.entities.push(on_layer("0", line((0.0, 0.0), (1.0, 1.0)), 1)); + blk.entities.push(on_layer("AFRZ", EntityKind::AttDef(plain_attrib("DEF")), 2)); + d.blocks.insert("BA".into(), std::sync::Arc::new(blk)); + let ins = match plain_insert("BA") { + EntityKind::Insert(i) => { + let attribs = + vec![attrib("OWN", (0.0, 300.0), Some("AFRZ")), attrib("DEF", (0.0, -400.0), None), attrib("OFF", (40.0, 0.0), Some("AOFF"))]; + EntityKind::Insert(Insert { attribs, ..i }) + } + k => k, + }; + d.add(&Space::Model, Common { layer: "IOFF".into(), ..Default::default() }, ins).unwrap(); + let (min, max) = extents_pair(&d); + assert!(min.y > -1.0 && max.y < 50.0 && max.x > 40.0, "{min:?} {max:?}"); +} + #[test] fn rays_and_xlines_do_not_stretch_extents() { // ZOOM Extents ignores infinite lines; real drawings carry stray rays millions of units away. @@ -315,6 +385,31 @@ fn plain_insert(block: &str) -> EntityKind { }) } +/// An attribute (or its definition) `tag` at the origin, one unit high, reading "x". +fn plain_attrib(tag: &str) -> Attrib { + Attrib { + tag: tag.into(), + text: Text { + insert: Vec3::ZERO, + align_pt: None, + height: 1.0, + value: "x".into(), + rotation: 0.0, + width_factor: 1.0, + oblique: 0.0, + style: "Standard".into(), + halign: HAlign::Left, + valign: VAlign::Baseline, + }, + invisible: false, + constant: false, + prompt: String::new(), + props: Default::default(), + multiline: None, + modes: Default::default(), + } +} + fn on_layer(layer: &str, kind: EntityKind, h: u64) -> Entity { Entity { handle: Handle(h), common: Common { layer: layer.into(), ..Default::default() }, kind } } @@ -383,24 +478,18 @@ fn block_entity_with_invisible_flag_is_ignored_in_insert_extents() { } #[test] -fn block_entity_on_off_or_frozen_layer_is_ignored() { - for frozen in [false, true] { - let mut d = drawing_with_block(far_line("Hidden")); - assert!(d.layer("Hidden").is_none(), "block contents do not create layers"); - let mut layer = Layer::new("Hidden"); - if frozen { - layer.frozen = true; - } else { - layer.on = false; - } - d.layers.push(layer); - assert_eq!(extents_pair(&d), (Vec2::ZERO, Vec2::new(1.0, 1.0)), "frozen = {frozen}"); - // Turned back on, it counts again. - let l = d.layer_mut("Hidden").unwrap(); - l.on = true; - l.frozen = false; - assert_eq!(d.extents(&Space::Model).max, Vec2::new(6000.0, 6000.0)); - } +fn block_entity_on_frozen_layer_is_ignored_and_on_a_layer_turned_off_counts() { + let mut d = drawing_with_block(far_line("Hidden")); + assert!(d.layer("Hidden").is_none(), "block contents do not create layers"); + let mut layer = Layer::new("Hidden"); + layer.frozen = true; + d.layers.push(layer); + assert_eq!(extents_pair(&d), (Vec2::ZERO, Vec2::new(1.0, 1.0))); + // Thawed but turned off, it counts. + let l = d.layer_mut("Hidden").unwrap(); + l.frozen = false; + l.on = false; + assert_eq!(d.extents(&Space::Model).max, Vec2::new(6000.0, 6000.0)); } #[test] @@ -558,10 +647,10 @@ fn invisible_dimblock_entity_is_ignored_in_dimension_extents() { hidden.common.visible = false; dim(&mut d, hidden); assert!(d.extents(&Space::Model).max.x < 100.0); - // Hidden by its layer state. + // Hidden by its layer state (frozen; a layer turned off still counts). let mut d = Drawing::new_imperial(); let mut l = Layer::new("*ADSK_CONSTRAINTS"); - l.on = false; + l.frozen = true; d.layers.push(l); dim(&mut d, on_layer("*ADSK_CONSTRAINTS", line((5000.0, 5000.0), (6000.0, 6000.0)), 2)); assert!(d.extents(&Space::Model).max.x < 100.0); From 29584fa4c415a2df989697091621f0acf9e1e112 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:46:16 +0700 Subject: [PATCH 44/49] SOLID: draw 2D solids, chained as AutoCAD chains them (#2489) * SOLID: draw 2D solids, chained as AutoCAD chains them CADCraft had the SOLID entity but no command to draw it. As AutoCAD 2024 asks from AutoLISP: first, second, third point, then "fourth point or " (Enter makes a triangle); further solids take the previous one's last two corners and ask their third and fourth points until Enter. Corners stay in the order given. The command (alias SO) has a JSON form taking the points chained the same way. solid_chains_its_corners_as_autocad pins seven measured calls to 1e-9. Co-Authored-By: Claude Opus 5.5 * SOLID: offer it in the Draw menu Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/engine/src/cmd/draw.rs | 9 +- crates/engine/src/cmd/draw/solid.rs | 79 ++++++++++++++++ crates/engine/tests/it/main.rs | 1 + crates/engine/tests/it/solid_command.rs | 115 ++++++++++++++++++++++++ 4 files changed, 203 insertions(+), 1 deletion(-) create mode 100644 crates/engine/src/cmd/draw/solid.rs create mode 100644 crates/engine/tests/it/solid_command.rs diff --git a/crates/engine/src/cmd/draw.rs b/crates/engine/src/cmd/draw.rs index 52bf23ace..1b0e0c1cf 100644 --- a/crates/engine/src/cmd/draw.rs +++ b/crates/engine/src/cmd/draw.rs @@ -1,5 +1,5 @@ //! Draw commands: LINE, PLINE, CIRCLE, ARC, RECTANG, POLYGON, ELLIPSE, POINT, XLINE, RAY, -//! SPLINE, DONUT, TEXT, MTEXT. Each has a JSON form and an interactive prompt sequence. +//! SPLINE, DONUT, SOLID, TEXT, MTEXT. Each has a JSON form and an interactive prompt sequence. use cadcraft_doc::{EntityKind, HAlign, MText, Point, RayLine, Text, VAlign}; use cadcraft_geom::{Arc, Circle, Ellipse, PolyVertex, Polyline, Spline, Vec2, arc_to_bulge, bulge_to_arc}; @@ -21,6 +21,7 @@ mod ellipse; mod line_pline; mod point; mod polygon; +mod solid; mod spline; mod text; @@ -30,6 +31,7 @@ use ellipse::{EllipseM, run_ellipse}; use line_pline::{LineM, PlineM, run_line, run_pline}; use point::{DonutM, PointM, RayM, run_donut, run_point, run_ray}; use polygon::{PolygonM, run_polygon}; +use solid::{SolidM, run_solid}; use spline::{SplineM, run_spline}; use text::{MTextM, TextM, run_mtext, run_text}; @@ -100,6 +102,11 @@ pub fn specs() -> Vec { .alias(&["do", "doughnut"]) .params("{center, inside, outside}") .interactive(|_| Ok(Box::new(DonutM::default()))), + CommandSpec::new("solid", "2D Solid", run_solid) + .menu(&["Draw", "2D Solid"]) + .alias(&["so"]) + .params("{points: [[x,y],...]} (three or four for the first solid, two more for each next one, chained on its last two corners)") + .interactive(|_| Ok(Box::new(SolidM::default()))), CommandSpec::new("text", "Single Line Text", run_text) .menu(&["Draw", "Text", "Single Line Text"]) .alias(&["dt", "dtext"]) diff --git a/crates/engine/src/cmd/draw/solid.rs b/crates/engine/src/cmd/draw/solid.rs new file mode 100644 index 000000000..835772a45 --- /dev/null +++ b/crates/engine/src/cmd/draw/solid.rs @@ -0,0 +1,79 @@ +//! SOLID: filled triangles and quadrilaterals (2D solids), chained as AutoCAD 2024 chains them. +//! +//! The prompts are "Specify first point", "Specify second point", "Specify third point" and +//! "Specify fourth point or "; Enter there makes a triangle (the fourth corner repeats the +//! third). Then "Specify third point" and "Specify fourth point or " come again for the next +//! solid, whose first two corners are the previous one's last two, until Enter at "Specify third +//! point". Enter there right after the second point makes nothing. + +use cadcraft_doc::Solid; + +use super::{Accept, EntityKind, Input, Interactive, Prompt, Result, Session, Step, Value, Vec2, bad, json, points_param, v3}; + +/// A 2D solid from its corners in AutoCAD's order (the fourth is drawn opposite the first). +fn solid(c: [Vec2; 4]) -> EntityKind { + EntityKind::Solid(Solid { corners: c.map(v3) }) +} + +/// `{points}`: the first solid takes three or four points, each further one two more, its first +/// two corners being the previous one's last two; a solid given three points is a triangle. +pub(super) fn run_solid(s: &mut Session, p: &Value) -> Result { + let pts = points_param(p, "points").ok_or_else(|| bad("solid", "`points` is required"))?; + let mut it = pts.into_iter(); + let (Some(mut a), Some(mut b), Some(_)) = (it.next(), it.next(), it.clone().next()) else { + return Err(bad("solid", "`points` needs at least three points")); + }; + let mut hs = Vec::new(); + while let Some(c) = it.next() { + let d = it.next().unwrap_or(c); + hs.push(s.add_entity(solid([a, b, c, d]))?.hex()); + (a, b) = (c, d); + } + Ok(json!({ "handles": hs })) +} + +#[derive(Default)] +pub(super) struct SolidM { + /// The corners of the solid being drawn (the first two from the previous one after it). + pts: Vec, +} + +impl Interactive for SolidM { + fn name(&self) -> &'static str { + "SOLID" + } + fn prompt(&self, _s: &Session) -> Prompt { + let last = self.pts.last().copied(); + match self.pts.len() { + 0 => Prompt::new("Specify first point", Accept::POINT), + 1 => Prompt::new("Specify second point", Accept::POINT).base_opt(last), + 2 => Prompt::new("Specify third point", Accept::POINT).base_opt(last), + _ => Prompt::new("Specify fourth point or", Accept::POINT).default("exit").base_opt(last), + } + } + fn input(&mut self, s: &mut Session, i: Input) -> Result { + match (i, self.pts.as_slice()) { + (Input::Point(p), &[a, b, c]) => self.make(s, [a, b, c, p])?, + (Input::Point(p), _) => self.pts.push(p), + (Input::Enter, &[a, b, c]) => self.make(s, [a, b, c, c])?, + (Input::Enter, _) => return Ok(Step::Done), + _ => {} + } + Ok(Step::Continue) + } + fn preview(&self, _s: &Session, cursor: Vec2) -> Vec { + match *self.pts.as_slice() { + [a, b] => vec![solid([a, b, cursor, cursor])], + [a, b, c] => vec![solid([a, b, c, cursor])], + _ => Vec::new(), + } + } +} + +impl SolidM { + fn make(&mut self, s: &mut Session, c: [Vec2; 4]) -> Result<()> { + s.add_entity(solid(c))?; + self.pts = vec![c[2], c[3]]; + Ok(()) + } +} diff --git a/crates/engine/tests/it/main.rs b/crates/engine/tests/it/main.rs index ed88a2316..d0d3aedc8 100644 --- a/crates/engine/tests/it/main.rs +++ b/crates/engine/tests/it/main.rs @@ -126,6 +126,7 @@ mod snap_nearest; mod snap_overrides; mod snap_tracking; mod snaps_more; +mod solid_command; mod space_is_enter; mod spline_degree; mod spline_options; diff --git a/crates/engine/tests/it/solid_command.rs b/crates/engine/tests/it/solid_command.rs new file mode 100644 index 000000000..4e92f38e9 --- /dev/null +++ b/crates/engine/tests/it/solid_command.rs @@ -0,0 +1,115 @@ +//! SOLID (2D solids) as AutoCAD 2024 draws them from AutoLISP's `command` (accoreconsole, every +//! solid read back with `entget`). + +use cadcraft_engine::Session; +use cadcraft_engine::doc::EntityKind; +use cadcraft_engine::geom::Vec2; +use serde_json::json; + +/// The corners of every solid, in drawing order. +fn solids(s: &Session) -> Vec<[Vec2; 4]> { + s.doc() + .unwrap() + .model + .iter() + .filter_map(|e| match &e.kind { + EntityKind::Solid(so) => Some(so.corners.map(|c| Vec2::new(c.x, c.y))), + _ => None, + }) + .collect() +} + +#[test] +fn solid_chains_its_corners_as_autocad() { + let p = |x: f64, y: f64| (x, y); + // (points, Enters after them, each solid as indexes into the points) + let cases: [(Vec<(f64, f64)>, usize, Vec<[usize; 4]>); 7] = [ + // Enter at the fourth point: a triangle repeating its third corner. + ( + vec![p(19.451648928934738, -21.25585202371201), p(34.61693931374715, -3.839951210926415), p(14.55170247613551, -36.00688291519149)], + 1, + vec![[0, 1, 2, 2]], + ), + // Two solids, the second on the first one's last two corners. + ( + vec![ + p(612336.9748522255, 2398742.6897319513), + p(612351.3507889743, 2398794.3456611084), + p(612371.7043989347, 2398771.9517326546), + p(612379.1755178814, 2398787.9912080113), + p(612308.5250187548, 2398780.014694856), + p(612356.1118879627, 2398726.474738389), + ], + 1, + vec![[0, 1, 2, 3], [2, 3, 4, 5]], + ), + // A solid, then a triangle. + ( + vec![ + p(15.962585354071173, 3.3526103822549587), + p(-0.8095657933516947, 13.123790321338404), + p(-19.412229808271626, -27.60123059493223), + p(-33.66123919971652, 12.18177290955613), + p(14.002713873827737, -8.925735622823005), + ], + 1, + vec![[0, 1, 2, 3], [2, 3, 4, 4]], + ), + // Three solids, the last a triangle. + ( + vec![ + p(29.3005193409103, -24.874809106460187), + p(-21.460879071052776, 35.356609837704795), + p(-31.347336242570112, -21.756568658673665), + p(-39.08169761088666, 23.588062542950155), + p(23.0763904721503, 10.219805555956789), + p(-22.701751810515756, 22.76615204356692), + p(4.338066830902321, -37.50391578060281), + ], + 1, + vec![[0, 1, 2, 3], [2, 3, 4, 5], [4, 5, 6, 6]], + ), + // Enter twice: the triangle, then Enter at the third point ends the command. + ( + vec![p(612325.6793323631, 2398757.396299568), p(612370.1009101832, 2398796.2224137546), p(612378.8199480829, 2398804.1981022176)], + 2, + vec![[0, 1, 2, 2]], + ), + // Corners stay in the order given (a "Z" order makes a rectangle). + (vec![p(0.0, 0.0), p(30.0, 0.0), p(0.0, 20.0), p(30.0, 20.0)], 1, vec![[0, 1, 2, 3]]), + // Enter after two points: nothing. + (vec![p(-34769.59558954922, 81960.0236700466), p(-35927.22173307072, 79264.64372697374)], 1, vec![]), + ]; + let same = |a: Vec2, b: (f64, f64)| (a.x - b.0).abs() <= 1e-9 * b.0.abs().max(1.0) && (a.y - b.1).abs() <= 1e-9 * b.1.abs().max(1.0); + for (pts, enters, want) in cases { + let mut s = Session::new(); + let args: Vec = pts.iter().map(|(x, y)| format!("'({x:?} {y:?})")).chain(std::iter::repeat_n("\"\"".to_string(), enters)).collect(); + s.cmdline(&format!("(command \"_.SOLID\" {})", args.join(" "))).unwrap(); + // One Enter leaves the command at "Specify third point", as AutoCAD's does (its log then + // shows the measuring routine ending it). + if s.running.is_some() { + assert!(s.prompt_text().contains("Specify third point"), "{pts:?}: {}", s.prompt_text()); + s.cancel(); + } + let got = solids(&s); + assert_eq!(got.len(), want.len(), "{pts:?}: {got:?}"); + for (g, w) in got.iter().zip(&want) { + assert!(g.iter().zip(w).all(|(c, &i)| same(*c, pts[i])), "{pts:?}: {got:?}"); + } + } +} + +#[test] +fn solid_json_chains_the_same_way() { + let mut s = Session::new(); + s.execute("solid", &json!({ "points": [[0, 0], [10, 0], [0, 5], [10, 5], [0, 10]] })).unwrap(); + let got = solids(&s); + let v = |x: f64, y: f64| Vec2::new(x, y); + assert_eq!(got, vec![[v(0.0, 0.0), v(10.0, 0.0), v(0.0, 5.0), v(10.0, 5.0)], [v(0.0, 5.0), v(10.0, 5.0), v(0.0, 10.0), v(0.0, 10.0)]]); + assert!(s.execute("solid", &json!({ "points": [[0, 0], [1, 0]] })).is_err()); + // The alias. + s.cmdline("so 20,0 30,0 20,5").unwrap(); + s.cmdline("").unwrap(); + s.cmdline("").unwrap(); + assert_eq!(solids(&s).len(), 3); +} From 8252d0e9bd94652a968bf57e634f137573d8dc24 Mon Sep 17 00:00:00 2001 From: Books Date: Sat, 31 Oct 2026 06:46:20 +1100 Subject: [PATCH 45/49] Extents: an MTEXT's wrap width only narrows its box (#2465) (#2491) * Extents: an MTEXT's wrap width only narrows its box (#2465) A garbage group 41 width (3e14) became the box width, so the drawing extents were 3e14 wide. The width is now capped at the longest line's estimate. The width 0 branch is unchanged. Tests: a_huge_mtext_wrap_width_does_not_inflate_the_extents and a_narrow_mtext_wrap_width_still_sets_the_box_width. * Parity checklist: regenerated after merging main * Parity checklist: regenerated after merging main --- crates/doc/src/extents.rs | 35 ++++++++++++++++++++++++++++++++++- docs/parity-checklist.md | 3 +-- 2 files changed, 35 insertions(+), 3 deletions(-) diff --git a/crates/doc/src/extents.rs b/crates/doc/src/extents.rs index 1971acadd..72742dbe7 100644 --- a/crates/doc/src/extents.rs +++ b/crates/doc/src/extents.rs @@ -67,7 +67,9 @@ fn blank(s: &str) -> bool { fn mtext_box(t: &crate::MText) -> Bounds2 { let lines = t.contents.split("\\P").count().max(1); let longest = t.contents.split("\\P").map(|l| l.chars().count()).max().unwrap_or(1); - let mut w = if t.width > 0.0 { t.width } else { t.height * 0.8 * longest as f64 }; + let estimate = t.height * 0.8 * longest as f64; + // The wrap width only narrows the box: a garbage width must not stretch the drawing extents (#2465). + let mut w = if t.width > 0.0 { t.width.min(estimate) } else { estimate }; let mut h = t.height * 1.66 * lines as f64; if let Some(c) = t.columns.as_ref().filter(|_| t.width > 0.0) { // Columns side by side, the text flowing down each in turn. @@ -335,6 +337,37 @@ mod tests { entity_bounds(&Drawing::default(), &Entity::new(crate::Handle(1), kind), 0) } + fn mtext(contents: &str, width: f64) -> crate::MText { + crate::MText { + insert: Vec3::new(10.0, 10.0, 0.0), + height: 2.5, + width, + attach: 1, + rotation: 0.0, + style: "Standard".into(), + contents: contents.into(), + line_spacing: 1.0, + line_spacing_exact: false, + columns: None, + } + } + + /// A garbage wrap width only narrows an MTEXT's box, never widens it: a huge group 41 must not + /// stretch the drawing extents (#2465). + #[test] + fn a_huge_mtext_wrap_width_does_not_inflate_the_extents() { + let b = bounds(EntityKind::MText(mtext("AB", 300_000_009_519_104.0))); + // "AB" at height 2.5 is 2 chars * 0.8 * 2.5 = 4 wide. + assert!(b.max.x <= 10.0 + 4.0 + 1e-9, "box ends at x = {}", b.max.x); + assert!(b.min.x >= 10.0 - 1e-9); + } + + /// A wrap width narrower than the text still bounds the box to that width. + #[test] + fn a_narrow_mtext_wrap_width_still_sets_the_box_width() { + let b = bounds(EntityKind::MText(mtext("A LONG LINE OF WRAPPING TEXT", 5.0))); + assert!((b.max.x - b.min.x - 5.0).abs() < 1e-9, "width {}", b.max.x - b.min.x); + } #[test] fn right_justified_text_is_left_of_alignment_point() { let b = bounds(EntityKind::Text(text(HAlign::Right, VAlign::Baseline))); diff --git a/docs/parity-checklist.md b/docs/parity-checklist.md index d0bd6f967..53ffffc96 100644 --- a/docs/parity-checklist.md +++ b/docs/parity-checklist.md @@ -1,7 +1,6 @@ # Parity checklist -> **Generated:** 2026-10-29 by `cargo xtask parity`. Do not edit by hand. -> **Generated:** 2026-10-28 by `cargo xtask parity`. Do not edit by hand. +> **Generated:** 2026-10-30 by `cargo xtask parity`. Do not edit by hand. Menu-breadth parity: a reference menu item counts as covered when a CADCraft command is registered under the same menu label. It measures breadth, not depth; see [target-app-parity.md](target-app-parity.md) for the weighted assessment. From 189bfcbf08c47bd777c7ba5e8ee0fe84c9805ddc Mon Sep 17 00:00:00 2001 From: MarekSpodBiedry <73122968+MarekSpodBiedry@users.noreply.github.com> Date: Fri, 30 Oct 2026 20:46:24 +0100 Subject: [PATCH 46/49] Draw annotative text with Match orientation to layout upright, ignoring its stored rotation (#2498) (#2504) --- crates/doc/src/entity/common.rs | 17 +++++ crates/doc/src/extents.rs | 5 ++ crates/io/tests/it/annotative_orientation.rs | 45 +++++++++++++ crates/io/tests/it/main.rs | 1 + crates/render/src/draw.rs | 13 +++- .../render/tests/it/annotative_orientation.rs | 66 +++++++++++++++++++ crates/render/tests/it/main.rs | 1 + 7 files changed, 147 insertions(+), 1 deletion(-) create mode 100644 crates/io/tests/it/annotative_orientation.rs create mode 100644 crates/render/tests/it/annotative_orientation.rs diff --git a/crates/doc/src/entity/common.rs b/crates/doc/src/entity/common.rs index 17fc43c75..45cf04e12 100644 --- a/crates/doc/src/entity/common.rs +++ b/crates/doc/src/entity/common.rs @@ -130,3 +130,20 @@ pub struct RawTag { pub code: i32, pub value: String, } + +impl Common { + /// Whether "Match orientation to layout" is on for this annotative object (AutoCAD's + /// `AcadAnnoPO` xdata = 1). AutoCAD draws such text upright and ignores its stored rotation. + /// The object's own `AcadAnnotative` xdata never reaches [`Common::xdata`] (the reader drops + /// it), so the `AcadAnnoPO` flag alone decides. + pub fn matches_layout_orientation(&self) -> bool { + let app = self.xdata.iter().position(|t| t.code == 1001 && t.value.trim().eq_ignore_ascii_case("AcadAnnoPO")); + let Some(at) = app else { return false }; + self.xdata + .iter() + .skip(at + 1) + .take_while(|t| t.code != 1001) + .find(|t| t.code == 1070) + .is_some_and(|t| t.value.trim().parse::().is_ok_and(|v| v != 0)) + } +} diff --git a/crates/doc/src/extents.rs b/crates/doc/src/extents.rs index 72742dbe7..353a42b53 100644 --- a/crates/doc/src/extents.rs +++ b/crates/doc/src/extents.rs @@ -126,6 +126,11 @@ fn bounds_in<'a>(d: &'a Drawing, e: &Entity, depth: usize, blocks: &mut HashMap< EntityKind::Table(t) if t.is_broken() => t.bounds(), EntityKind::Text(t) if blank(&t.value) => Bounds2::EMPTY, EntityKind::MText(t) if blank(&t.contents) => Bounds2::EMPTY, + // Text that matches the layout's orientation is drawn upright (#2498). + EntityKind::Text(t) if e.common.matches_layout_orientation() => { + text_box(&crate::Text { rotation: 0.0, ..t.clone() }, t.value.chars().count()) + } + EntityKind::MText(t) if e.common.matches_layout_orientation() => mtext_box(&crate::MText { rotation: 0.0, ..t.clone() }), EntityKind::Text(t) => text_box(t, t.value.chars().count()), EntityKind::AttDef(a) => text_box(&a.text, a.tag.chars().count()), EntityKind::MText(t) => mtext_box(t), diff --git a/crates/io/tests/it/annotative_orientation.rs b/crates/io/tests/it/annotative_orientation.rs new file mode 100644 index 000000000..c11688de6 --- /dev/null +++ b/crates/io/tests/it/annotative_orientation.rs @@ -0,0 +1,45 @@ +//! Annotative TEXT read from a file with "Match orientation to layout" on (`AcadAnnoPO` xdata = 1) +//! is drawn and measured upright, ignoring its stored rotation, as AutoCAD shows it (#2498). + +use cadcraft_doc::{EntityKind, Space, entity_bounds}; + +/// The xdata AutoCAD writes on such text: the `AcadAnnotative` data, then `AcadAnnoPO`. +const ANNO_PO: &str = "1001\nAcadAnnotative\n1000\nAnnotativeData\n1002\n{\n1070\n1\n1070\n1\n1002\n}\n1001\nAcadAnnoPO\n1070\n1\n"; + +/// One TEXT "TITLE" at 10,5, height 2.5, rotated `deg` degrees, followed by `xdata`. +fn dxf(deg: f64, xdata: &str) -> String { + format!("0\nSECTION\n2\nENTITIES\n0\nTEXT\n5\n2A\n8\n0\n10\n10\n20\n5\n40\n2.5\n1\nTITLE\n50\n{deg}\n{xdata}0\nENDSEC\n0\nEOF\n") +} + +/// (rendered box, extents box) of the drawing's only object, as (min x, min y, max x, max y). +fn boxes(text: &str) -> ([f64; 4], [f64; 4]) { + let d = cadcraft_io::read(text.as_bytes(), "t.dxf").unwrap(); + let r = cadcraft_render::build(&d, &Space::Model, &cadcraft_render::Options::default()).bounds; + let e = d.model.iter().find(|e| matches!(e.kind, EntityKind::Text(_))).map(|e| entity_bounds(&d, e, 0)).unwrap(); + ([r.min.x, r.min.y, r.max.x, r.max.y], [e.min.x, e.min.y, e.max.x, e.max.y]) +} + +fn same(a: [f64; 4], b: [f64; 4]) -> bool { + a.iter().zip(b).all(|(x, y)| (x - y).abs() < 1e-6) +} + +#[test] +fn match_orientation_to_layout_draws_the_text_upright() { + let d = cadcraft_io::read(dxf(180.0, ANNO_PO).as_bytes(), "t.dxf").unwrap(); + assert!(d.model.iter().any(|e| e.common.matches_layout_orientation()), "the AcadAnnoPO flag is read"); + let (upright_r, upright_e) = boxes(&dxf(0.0, "")); + let (r, e) = boxes(&dxf(180.0, ANNO_PO)); + assert!(same(r, upright_r), "drawn at {r:?}, upright at {upright_r:?}"); + assert!(same(e, upright_e), "extents {e:?}, upright {upright_e:?}"); +} + +#[test] +fn without_the_flag_the_stored_rotation_applies() { + let (upright_r, upright_e) = boxes(&dxf(0.0, "")); + let off = ANNO_PO.replace("AcadAnnoPO\n1070\n1\n", "AcadAnnoPO\n1070\n0\n"); + for xdata in ["", off.as_str()] { + let (r, e) = boxes(&dxf(180.0, xdata)); + assert!(!same(r, upright_r), "drawn at {r:?}"); + assert!(!same(e, upright_e), "extents {e:?}"); + } +} diff --git a/crates/io/tests/it/main.rs b/crates/io/tests/it/main.rs index 51e7f1965..07b1e8c2e 100644 --- a/crates/io/tests/it/main.rs +++ b/crates/io/tests/it/main.rs @@ -2,6 +2,7 @@ mod acad_interop; #[cfg(not(target_arch = "wasm32"))] mod acis_data_store; mod angle_header; +mod annotative_orientation; mod annotative_roundtrip; mod assoc_array_roundtrip; mod attrib_modes; diff --git a/crates/render/src/draw.rs b/crates/render/src/draw.rs index cf37e28f7..7e00b4c8c 100644 --- a/crates/render/src/draw.rs +++ b/crates/render/src/draw.rs @@ -103,6 +103,13 @@ fn entity_parts(b: &mut Builder, ctx: &Ctx, e: &Entity) { if !b.opts.text { return; } + let upright; + let t = if e.common.matches_layout_orientation() && t.rotation != 0.0 { + upright = cadcraft_doc::Text { rotation: 0.0, ..t.clone() }; + &upright + } else { + t + }; let (sh, _) = place_text_entity(ctx.d, t, &t.value); b.shaped(ctx, rgb, lw, &sh); } @@ -114,7 +121,11 @@ fn entity_parts(b: &mut Builder, ctx: &Ctx, e: &Entity) { if !b.opts.text { return; } - mtext(b, ctx, t, rgb, lw); + if e.common.matches_layout_orientation() && t.rotation != 0.0 { + mtext(b, ctx, &cadcraft_doc::MText { rotation: 0.0, ..t.clone() }, rgb, lw); + } else { + mtext(b, ctx, t, rgb, lw); + } } EntityKind::Insert(ins) => insert(b, ctx, e, ins, rgb), EntityKind::Dimension(dm) => draw_dimension(b, ctx, e, dm, lw, lt.as_ref(), ltscale), diff --git a/crates/render/tests/it/annotative_orientation.rs b/crates/render/tests/it/annotative_orientation.rs new file mode 100644 index 000000000..ee28b0624 --- /dev/null +++ b/crates/render/tests/it/annotative_orientation.rs @@ -0,0 +1,66 @@ +//! Annotative text with "Match orientation to layout" (`AcadAnnoPO` xdata = 1) draws upright, +//! ignoring its stored rotation (#2498). + +use cadcraft_doc::{Common, Drawing, EntityKind, RawTag, Space, Text}; +use cadcraft_geom::{Bounds2, Vec3}; +use cadcraft_render::{Options, build}; + +fn tag(code: i32, value: &str) -> RawTag { + RawTag { code, value: value.into() } +} + +fn bounds(rotation: f64, match_orientation: Option<&str>) -> Bounds2 { + let mut d = Drawing::new_metric(); + let mut common = Common::default(); + if let Some(flag) = match_orientation { + common.xdata = vec![ + tag(1001, "AcadAnnotative"), + tag(1000, "AnnotativeData"), + tag(1002, "{"), + tag(1070, "1"), + tag(1070, "1"), + tag(1002, "}"), + tag(1001, "AcadAnnoPO"), + tag(1070, flag), + ]; + } + let text = Text { + insert: Vec3::new(10.0, 5.0, 0.0), + align_pt: None, + height: 2.5, + value: "TITLE".into(), + rotation, + width_factor: 1.0, + oblique: 0.0, + style: "Standard".into(), + halign: Default::default(), + valign: Default::default(), + }; + d.add(&Space::Model, common, EntityKind::Text(text)).unwrap(); + let l = build(&d, &Space::Model, &Options::default()); + let mut b = Bounds2::EMPTY; + for p in &l.prims { + for q in l.points(p) { + b.add(*q); + } + } + b +} + +fn same(a: &Bounds2, b: &Bounds2) -> bool { + (a.min.x - b.min.x).abs() < 1e-9 && (a.min.y - b.min.y).abs() < 1e-9 && (a.max.x - b.max.x).abs() < 1e-9 && (a.max.y - b.max.y).abs() < 1e-9 +} + +#[test] +fn match_orientation_ignores_the_stored_rotation() { + let upright = bounds(0.0, None); + assert!(!upright.is_empty()); + assert!(same(&bounds(std::f64::consts::PI, Some("1")), &upright)); +} + +#[test] +fn stored_rotation_applies_without_the_flag() { + let upright = bounds(0.0, None); + assert!(!same(&bounds(std::f64::consts::PI, None), &upright)); + assert!(!same(&bounds(std::f64::consts::PI, Some("0")), &upright)); +} diff --git a/crates/render/tests/it/main.rs b/crates/render/tests/it/main.rs index 5f0005496..fbeede7f8 100644 --- a/crates/render/tests/it/main.rs +++ b/crates/render/tests/it/main.rs @@ -1,4 +1,5 @@ mod aci7_display; +mod annotative_orientation; mod annotative_viewport; mod dim_angular_centre; mod dim_post_tolerance; From 18d3aa4ed805ea5a7b9546b62f53013608909466 Mon Sep 17 00:00:00 2001 From: 2ez4gcx <108074836+2ez4gcx@users.noreply.github.com> Date: Sat, 31 Oct 2026 02:46:27 +0700 Subject: [PATCH 47/49] CHPROP: change properties at the command line, as AutoCAD asks for them (#2497) * Add CHPROP, asking for properties as AutoCAD does CHPROP selects objects, then asks "Enter property to change [Color/LAyer/LType/ltScale/LWeight/Thickness/TRansparency]" until Enter, applying each value through properties.set. Measured from AutoCAD 2024 through AutoLISP's command: colours 1-255, names, BYLAYER, BYBLOCK or Truecolor; 0, 256 and 300 refused; a layer must exist; a linetype not loaded is loaded from the standard file; a lineweight goes to the nearest standard one with a note. Keyword prefixes now have to reach past the keyword's last capital, so "L" alone matches none of LAyer, LType, ltScale and LWeight, as in AutoCAD. Co-Authored-By: Claude Opus 5.5 * CHPROP tests: transparency, and refused true colours and transparencies Co-Authored-By: Claude Opus 5.5 * CHPROP leaves objects on locked layers out, as AutoCAD does Each pick and the pickfirst selection lose the objects on locked layers, followed by "1 was on a locked layer." or "N were on a locked layer."; with none of the pickfirst selection left, CHPROP asks for objects. The JSON chprop leaves them out too and returns {changed, locked}. The keywords test also pins QDIM's DA and PEDIT's vertex E, which AutoCAD 2024 refuses although only one keyword starts with them. Co-Authored-By: Claude Opus 5.5 * chprop: look up locked handles in a set, and always report "locked" (CodeRabbit) --------- Co-authored-by: Claude Opus 5.5 Co-authored-by: Brandon Thomas --- crates/engine/src/cmd/props.rs | 7 +- crates/engine/src/cmd/props/chprop.rs | 338 +++++++++++++++++++++++ crates/engine/src/prompt.rs | 34 ++- crates/engine/tests/it/chprop_command.rs | 149 ++++++++++ crates/engine/tests/it/main.rs | 1 + 5 files changed, 526 insertions(+), 3 deletions(-) create mode 100644 crates/engine/src/cmd/props/chprop.rs create mode 100644 crates/engine/tests/it/chprop_command.rs diff --git a/crates/engine/src/cmd/props.rs b/crates/engine/src/cmd/props.rs index dfe69fd8f..daf963f67 100644 --- a/crates/engine/src/cmd/props.rs +++ b/crates/engine/src/cmd/props.rs @@ -1,5 +1,7 @@ -//! Properties: per-object property edits, current properties, MATCHPROP, linetypes, units, RENAME. +//! Properties: per-object property edits, current properties, CHPROP, MATCHPROP, linetypes, units, +//! RENAME. +mod chprop; mod matchprop; mod rename; @@ -18,6 +20,9 @@ pub fn specs() -> Vec { vec![ CommandSpec::new("properties", "Properties", run_get).menu(&["Modify", "Properties"]).alias(&["pr", "props", "ch"]).params("{handles?} → properties of the selection").noundo(), CommandSpec::new("properties.set", "Set Properties", run_set).params("{handles?, layer?, color?, linetype?, lineweight?, ltscale?, thickness?, transparency?: \"ByLayer\" | \"ByBlock\" | 0..90, visible?, ; dimensions: textOverride, dimStyle, textHeight, arrowSize, dimScale, precision (per-dimension overrides)}"), + CommandSpec::new("chprop", "Change Properties", chprop::run_chprop) + .params("as properties.set, leaving out objects on locked layers → {changed, locked} (the command line asks Color, LAyer, LType, ltScale, LWeight, Thickness and TRansparency in turn)") + .interactive(|_| Ok(Box::new(chprop::ChpropM::new()))), CommandSpec::new("matchprop", "Match Properties", matchprop::run_matchprop) .menu(&["Modify", "Match Properties"]) .alias(&["ma", "painter"]) diff --git a/crates/engine/src/cmd/props/chprop.rs b/crates/engine/src/cmd/props/chprop.rs new file mode 100644 index 000000000..0949abee9 --- /dev/null +++ b/crates/engine/src/cmd/props/chprop.rs @@ -0,0 +1,338 @@ +//! CHPROP: change object properties at the command line, as AutoCAD 2024 asks for them. +//! +//! "Enter property to change [Color/LAyer/LType/ltScale/LWeight/Thickness/TRansparency]" comes +//! back after each answer until Enter; each property asks for its value and applies it at once +//! (through `properties.set`). Measured from AutoLISP's `command` (accoreconsole, every object read +//! back with `entget`): +//! - a colour is 1–255, a name (red … white), BYLAYER or BYBLOCK, or Truecolor and then "r,g,b"; +//! 0, 256 and 300 are refused with "Invalid color number."; +//! - a layer must exist: `Cannot find layer "KHONGCO".`; +//! - a linetype not loaded yet is loaded from the standard ones (PHANTOM2); +//! - a lineweight goes to the nearest standard one, with a note: 0.33 gives "Lineweight rounded to +//! nearest valid value of 0.35 mm"; +//! - `L` alone is "Ambiguous response, please clarify..."; +//! - objects on locked layers are left out at "Select objects", which says how many after what was +//! found ("1 was on a locked layer.", "2 were on a locked layer."); with none left, Enter ends +//! the command. + +use std::collections::HashSet; + +use cadcraft_color::Color; +use cadcraft_doc::{Entity, Handle, Lineweight}; +use serde_json::{Value, json}; + +use super::super::curves::{KW, is_locked}; +use super::super::machines::{SelOutcome, SelectPhase, number}; +use super::super::targets; +use crate::{Accept, Input, Interactive, Prompt, Result, Session, Step}; + +const PROPERTIES: [&str; 7] = ["Color", "LAyer", "LType", "ltScale", "LWeight", "Thickness", "TRansparency"]; + +/// What CHPROP asks for. +#[derive(Clone, Copy, Debug, PartialEq)] +enum Ask { + Property, + Color, + TrueColor, + Layer, + Linetype, + LtScale, + Lineweight, + Thickness, + Transparency, +} + +pub(super) struct ChpropM { + select: SelectPhase, + handles: Vec, + /// `None` while objects are selected. + ask: Option, +} + +impl ChpropM { + pub(super) fn new() -> Self { + ChpropM { select: SelectPhase::default(), handles: Vec::new(), ask: None } + } + + /// The selection's common value of a property, or "varies". + fn current(&self, s: &Session, f: impl Fn(&Entity) -> String) -> String { + let Ok(d) = s.doc() else { return String::new() }; + let mut vals = self.handles.iter().filter_map(|h| d.entity(*h)).map(|e| f(e)); + let first = vals.next().unwrap_or_default(); + if vals.all(|v| v == first) { first } else { "varies".into() } + } + + /// Apply `props` to the selection through `properties.set`. + fn apply(&self, s: &mut Session, props: Value) -> Result<()> { + let mut p = json!({ "handles": self.handles.iter().map(|h| h.hex()).collect::>() }); + if let (Some(p), Value::Object(props)) = (p.as_object_mut(), props) { + p.extend(props); + } + super::run_set(s, &p).map(|_| ()) + } + + /// Take an answer to `ask`; `false` when it was refused (the prompt comes again). + fn answer(&mut self, s: &mut Session, ask: Ask, t: &str) -> Result { + let t = t.trim(); + let word = t.strip_prefix('_').unwrap_or(t); + match ask { + Ask::Color => match color(word) { + Some(c) => self.apply(s, json!({ "color": color_json(c) }))?, + None => { + s.echo("Invalid color number."); + return Ok(false); + } + }, + Ask::TrueColor => match Color::parse(word) { + Some(c @ Color::True(_)) => self.apply(s, json!({ "color": color_json(c) }))?, + _ => { + s.echo("Requires three integers from 0 to 255, separated by commas."); + return Ok(false); + } + }, + Ask::Layer => match s.doc()?.layer(word).map(|l| l.name.clone()) { + Some(name) => self.apply(s, json!({ "layer": name }))?, + None => { + s.echo(format!("Cannot find layer \"{word}\".")); + return Ok(false); + } + }, + Ask::Linetype => { + let by = ["ByLayer", "ByBlock"].into_iter().find(|b| b.eq_ignore_ascii_case(word)); + let name = match by { + Some(b) => Some(b.to_string()), + None => { + // Not loaded yet: load it from the standard linetypes, as AutoCAD does. + if s.doc()?.linetype(word).is_none() { + let _ = super::run_linetype(s, &json!({ "load": word })); + } + s.doc()?.linetype(word).map(|l| l.name.clone()) + } + }; + match name { + Some(n) => self.apply(s, json!({ "linetype": n }))?, + None => { + s.echo(format!("Cannot find linetype \"{word}\".")); + return Ok(false); + } + } + } + Ask::LtScale | Ask::Thickness => { + let v = number(word).filter(|v| v.is_finite() && (ask == Ask::Thickness || *v > 0.0)); + match v { + Some(v) => self.apply(s, if ask == Ask::LtScale { json!({ "ltscale": v }) } else { json!({ "thickness": v }) })?, + None => { + s.echo(if ask == Ask::LtScale { "Requires a positive number." } else { "Requires a number." }); + return Ok(false); + } + } + } + Ask::Lineweight => match lineweight(word) { + Some((lw, rounded)) => { + if let (true, Lineweight::Mm100(v)) = (rounded, lw) { + s.echo(format!("Lineweight rounded to nearest valid value of {:.2} mm", f64::from(v) / 100.0)); + } + let v = match lw { + Lineweight::Mm100(v) => json!(f64::from(v) / 100.0), + Lineweight::ByLayer => json!("ByLayer"), + Lineweight::ByBlock => json!("ByBlock"), + Lineweight::Default => json!("Default"), + }; + self.apply(s, json!({ "lineweight": v }))?; + } + None => { + s.echo("Invalid lineweight."); + return Ok(false); + } + }, + Ask::Transparency => { + if self.apply(s, json!({ "transparency": word })).is_err() { + s.echo("Requires ByLayer, ByBlock or an integer from 0 to 90."); + return Ok(false); + } + } + Ask::Property => {} + } + Ok(true) + } +} + +/// The objects among `hs` on locked layers. +fn locked(s: &Session, hs: &[Handle]) -> HashSet { + hs.iter().copied().filter(|h| is_locked(s, *h)).collect() +} + +fn say_locked(s: &mut Session, n: usize) { + match n { + 0 => {} + 1 => s.echo("1 was on a locked layer."), + n => s.echo(format!("{n} were on a locked layer.")), + } +} + +/// CHPROP's JSON form: `properties.set` on the objects that are not on locked layers, which the +/// command leaves out too; "locked" says how many were. +pub(super) fn run_chprop(s: &mut Session, p: &Value) -> Result { + let hs = targets(s, p)?; + let locked = locked(s, &hs); + if locked.is_empty() { + return super::run_set(s, p).map(|r| with_locked(r, 0)); + } + let free: Vec = hs.into_iter().filter(|h| !locked.contains(h)).collect(); + let r = if free.is_empty() { + json!({ "changed": 0 }) + } else { + let mut q = p.as_object().cloned().unwrap_or_default(); + q.insert("handles".into(), json!(free.iter().map(|h| h.hex()).collect::>())); + super::run_set(s, &Value::Object(q))? + }; + Ok(with_locked(r, locked.len())) +} + +/// `r` with how many objects were left out on locked layers. +fn with_locked(mut r: Value, n: usize) -> Value { + if let Some(o) = r.as_object_mut() { + o.insert("locked".into(), json!(n)); + } + r +} + +/// A colour typed at CHPROP: 1–255, a name, BYLAYER or BYBLOCK (not 0 or 256, which COLOR takes). +fn color(t: &str) -> Option { + if t.bytes().all(|b| b.is_ascii_digit()) { + return t.parse::().ok().filter(|i| (1..=255).contains(i)).and_then(|i| u8::try_from(i).ok()).map(Color::Index); + } + Color::parse(t).filter(|c| !matches!(c, Color::True(_))) +} + +fn color_json(c: Color) -> Value { + match c { + Color::Index(i) => json!(i), + Color::True(rgb) => json!(format!("{},{},{}", rgb.0, rgb.1, rgb.2)), + other => json!(other.name()), + } +} + +fn lineweight_name(lw: Lineweight) -> String { + match lw { + Lineweight::Mm100(v) => format!("{:.2} mm", f64::from(v) / 100.0), + Lineweight::ByLayer => "ByLayer".into(), + Lineweight::ByBlock => "ByBlock".into(), + Lineweight::Default => "Default".into(), + } +} + +/// A lineweight typed in millimetres (the nearest standard one, and whether that rounded it), or +/// ByLayer, ByBlock or Default. +fn lineweight(t: &str) -> Option<(Lineweight, bool)> { + match t.to_ascii_lowercase().as_str() { + "bylayer" => return Some((Lineweight::ByLayer, false)), + "byblock" => return Some((Lineweight::ByBlock, false)), + "default" => return Some((Lineweight::Default, false)), + _ => {} + } + let mm = number(t).filter(|v| v.is_finite() && *v >= 0.0)?; + let want = mm * 100.0; + let near = Lineweight::STANDARD.iter().copied().min_by(|a, b| (f64::from(*a) - want).abs().total_cmp(&(f64::from(*b) - want).abs()))?; + Some((Lineweight::Mm100(near), (f64::from(near) - want).abs() > 1e-9)) +} + +impl Interactive for ChpropM { + fn name(&self) -> &'static str { + "CHPROP" + } + fn begin(&mut self, s: &mut Session) -> Result { + self.select = SelectPhase::begin(s); + if self.select.done { + let locked = locked(s, &self.select.picked); + if !locked.is_empty() { + self.select.picked.retain(|h| !locked.contains(h)); + say_locked(s, locked.len()); + s.set_selection(self.select.picked.clone()); + // Nothing left of the pickfirst selection: ask for objects instead. + self.select.done = !self.select.picked.is_empty(); + } + } + if self.select.done { + self.handles = self.select.picked.clone(); + self.ask = Some(Ask::Property); + } + Ok(Step::Continue) + } + fn prompt(&self, s: &Session) -> Prompt { + let Some(ask) = self.ask else { return self.select.prompt() }; + match ask { + Ask::Property => Prompt::new("Enter property to change", Accept::TEXT).kw(&PROPERTIES), + Ask::Color => { + Prompt::new("New color", Accept::TEXT).kw(&["Truecolor"]).default(self.current(s, |e| e.common.color.name().to_ascii_uppercase())) + } + Ask::TrueColor => Prompt::new("Red,Green,Blue", Accept::TEXT), + Ask::Layer => Prompt::new("Enter new layer name", Accept::TEXT).default(self.current(s, |e| e.common.layer.clone())), + Ask::Linetype => Prompt::new("Enter new linetype name", Accept::TEXT).default(self.current(s, |e| e.common.linetype.clone())), + Ask::LtScale => { + Prompt::new("Specify new linetype scale", Accept::NUMBER).default(self.current(s, |e| format!("{:.4}", e.common.ltscale))) + } + Ask::Lineweight => Prompt::new("Enter new lineweight", Accept::TEXT).default(self.current(s, |e| lineweight_name(e.common.lineweight))), + Ask::Thickness => Prompt::new("Specify new thickness", Accept::NUMBER).default(self.current(s, |e| format!("{:.4}", e.common.thickness))), + Ask::Transparency => Prompt::new("Enter transparency value", KW).default(self.current(s, |e| e.common.transparency.name())), + } + } + fn input(&mut self, s: &mut Session, i: Input) -> Result { + let Some(ask) = self.ask else { + // Objects on locked layers are left out, and said after what was found. + let (i, n) = match i { + Input::Pick(hs) if !self.select.removing => { + let locked = locked(s, &hs); + (Input::Pick(hs.into_iter().filter(|h| !locked.contains(h)).collect()), locked.len()) + } + i => (i, 0), + }; + let outcome = self.select.feed(s, &i)?; + say_locked(s, n); + return Ok(match outcome { + SelOutcome::More => Step::Continue, + SelOutcome::Done(hs) => { + self.handles = hs; + self.ask = Some(Ask::Property); + Step::Continue + } + SelOutcome::Empty => { + s.set_selection(Vec::new()); + Step::Done + } + }); + }; + match (ask, i) { + (Ask::Property, Input::Enter) => { + s.set_selection(Vec::new()); + return Ok(Step::Done); + } + (Ask::Property, Input::Keyword(k)) => { + self.ask = Some(match k.as_str() { + "Color" => Ask::Color, + "LAyer" => Ask::Layer, + "LType" => Ask::Linetype, + "ltScale" => Ask::LtScale, + "LWeight" => Ask::Lineweight, + "Thickness" => Ask::Thickness, + _ => Ask::Transparency, + }); + } + (Ask::Property, Input::Text(t)) => { + let t = t.trim().trim_start_matches('_').to_ascii_lowercase(); + let n = PROPERTIES.iter().filter(|k| k.to_ascii_lowercase().starts_with(&t)).count(); + s.echo(if n > 1 { "Ambiguous response, please clarify..." } else { "Invalid option keyword." }); + } + (Ask::Color, Input::Keyword(k)) if k == "Truecolor" => self.ask = Some(Ask::TrueColor), + // Enter keeps the value. + (_, Input::Enter) => self.ask = Some(Ask::Property), + (ask, Input::Text(t) | Input::Keyword(t)) => { + // A refused answer asks again. + let taken = self.answer(s, ask, &t)?; + self.ask = Some(if taken { Ask::Property } else { ask }); + } + _ => {} + } + Ok(Step::Continue) + } +} diff --git a/crates/engine/src/prompt.rs b/crates/engine/src/prompt.rs index c02551b80..1563be702 100644 --- a/crates/engine/src/prompt.rs +++ b/crates/engine/src/prompt.rs @@ -180,10 +180,13 @@ impl Prompt { (k, k.to_ascii_lowercase(), shortcut) }); // A whole keyword or its capital-letter shortcut wins over a prefix of another keyword - // (`M` is Multiple, not a prefix of mEthod). + // (`M` is Multiple, not a prefix of mEthod). A prefix reaches past the keyword's last + // capital, as in AutoCAD: `L` is none of LAyer, LType, ltScale or LWeight (AutoCAD 2024's + // CHPROP: "Ambiguous response, please clarify..."), `LTS` is ltScale. + let past_capitals = |k: &str| k.char_indices().rfind(|(_, c)| c.is_ascii_uppercase() || c.is_ascii_digit()).map_or(1, |(i, _)| i + 1); keys.clone() .find(|(_, kl, sc)| tl == *kl || tl == *sc) - .or_else(|| keys.clone().find(|(_, kl, sc)| tl.len() >= sc.len() && kl.starts_with(&tl))) + .or_else(|| keys.clone().find(|(k, kl, _)| tl.len() >= past_capitals(k) && kl.starts_with(&tl))) .map(|(k, _, _)| k.clone()) } } @@ -341,5 +344,32 @@ mod tests { let q = Prompt::new("", Accept::POINT).kw(&["3P", "2P", "Ttr"]); assert_eq!(q.match_keyword("3p").as_deref(), Some("3P")); assert_eq!(q.match_keyword("t").as_deref(), Some("Ttr")); + // A prefix reaches past the last capital (AutoCAD 2024's CHPROP: `L` is ambiguous). + let c = + Prompt::new("Enter property to change", Accept::TEXT).kw(&["Color", "LAyer", "LType", "ltScale", "LWeight", "Thickness", "TRansparency"]); + assert_eq!(c.match_keyword("l"), None); + assert_eq!(c.match_keyword("la").as_deref(), Some("LAyer")); + assert_eq!(c.match_keyword("lts").as_deref(), Some("ltScale")); + assert_eq!(c.match_keyword("s").as_deref(), Some("ltScale")); + assert_eq!(c.match_keyword("tr").as_deref(), Some("TRansparency")); + // Even when no other keyword starts with it: AutoCAD 2024 answers QDIM's `DA` with "Point or + // option keyword required." and PEDIT's vertex `E` with "Invalid option keyword.". + let q = Prompt::new("", Accept::POINT).kw(&[ + "Continuous", + "Staggered", + "Baseline", + "Ordinate", + "Radius", + "Diameter", + "datumPoint", + "Edit", + "seTtings", + ]); + assert_eq!(q.match_keyword("da"), None); + assert_eq!(q.match_keyword("datump").as_deref(), Some("datumPoint")); + assert_eq!(q.match_keyword("p").as_deref(), Some("datumPoint")); + let v = Prompt::new("", Accept::TEXT).kw(&["Next", "Previous", "Break", "Insert", "Move", "Regen", "Straighten", "Tangent", "Width", "eXit"]); + assert_eq!(v.match_keyword("e"), None); + assert_eq!(v.match_keyword("ex").as_deref(), Some("eXit")); } } diff --git a/crates/engine/tests/it/chprop_command.rs b/crates/engine/tests/it/chprop_command.rs new file mode 100644 index 000000000..8e22c90af --- /dev/null +++ b/crates/engine/tests/it/chprop_command.rs @@ -0,0 +1,149 @@ +//! CHPROP as AutoCAD 2024 runs it from AutoLISP's `command` (accoreconsole, every object read back +//! with `entget`). + +use cadcraft_engine::Session; +use cadcraft_engine::doc::color::{Color, Rgb}; +use cadcraft_engine::doc::{Handle, Lineweight, Transparency}; +use serde_json::json; + +/// A session with line A (0,0)-(50,0) on layer 0 and line B (0,20)-(50,30) on layer L1, as `a` and +/// `b` in LISP, after `code`; the properties of A then B. +fn run(code: &str) -> (Session, [cadcraft_engine::doc::Common; 2]) { + let mut s = Session::new(); + s.doc_mut().unwrap().ensure_layer("L1"); + s.execute("line", &json!({ "points": [[0, 0], [50, 0]] })).unwrap(); + s.cmdline("(setq a (entlast))").unwrap(); + s.execute("line", &json!({ "points": [[0, 20], [50, 30]] })).unwrap(); + s.cmdline("(setq b (entlast))").unwrap(); + s.cmdline("(command \"_.CHPROP\" b \"\" \"_LA\" \"L1\" \"\")").unwrap(); + s.cmdline(&format!("(progn {code})")).unwrap(); + if s.running.is_some() { + s.cancel(); + } + let common = { + let d = s.doc().unwrap(); + let mut it = d.model.iter().map(|e| e.common.clone()); + [it.next().unwrap(), it.next().unwrap()] + }; + (s, common) +} + +#[test] +fn chprop_sets_each_property_as_autocad() { + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_C\" 1 \"\")"); + assert_eq!(a.color, Color::Index(1)); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_C\" \"blue\" \"\")"); + assert_eq!(a.color, Color::Index(5)); + let (_, [_, b]) = run("(command \"_.CHPROP\" b \"\" \"_C\" \"_BYBLOCK\" \"\")"); + assert_eq!(b.color, Color::ByBlock); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_C\" 3 \"\") (command \"_.CHPROP\" a \"\" \"_C\" \"_BYLAYER\" \"\")"); + assert_eq!(a.color, Color::ByLayer); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_C\" \"_T\" \"255,128,0\" \"\")"); + assert_eq!(a.color, Color::True(Rgb(255, 128, 0))); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_LA\" \"L1\" \"\")"); + assert_eq!(a.layer, "L1"); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_LT\" \"DASHED\" \"\")"); + assert_eq!(a.linetype, "DASHED"); + // Not loaded yet: loaded and given, as AutoCAD loads it from acadiso.lin. + let (s, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_LT\" \"PHANTOM2\" \"\")"); + assert_eq!(a.linetype, "PHANTOM2"); + assert!(s.doc().unwrap().linetype("PHANTOM2").is_some()); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_S\" 2.5 \"\")"); + assert_eq!(a.ltscale, 2.5); + let (s, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_LW\" 0.33 \"\")"); + assert_eq!(a.lineweight, Lineweight::Mm100(35)); + assert!(s.log.iter().any(|l| l == "Lineweight rounded to nearest valid value of 0.35 mm"), "{:?}", s.log); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_T\" 5.0 \"\")"); + assert_eq!(a.thickness, 5.0); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_TR\" 50 \"\")"); + assert_eq!(a.transparency, Transparency::Percent(50)); + let (_, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_TR\" \"_BYBLOCK\" \"\")"); + assert_eq!(a.transparency, Transparency::ByBlock); + // Several objects and several properties in one go. + let (_, [a, b]) = run("(command \"_.CHPROP\" a b \"\" \"_C\" 3 \"_LA\" \"L1\" \"_LW\" 0.5 \"\")"); + for c in [a, b] { + assert_eq!((c.color, c.layer.as_str(), c.lineweight), (Color::Index(3), "L1", Lineweight::Mm100(50))); + } + let (_, [a, _]) = run( + "(command \"_.CHPROP\" a \"\" \"_C\" 3 \"\") (command \"_.CHPROP\" a \"\" \"_C\" \"_BYLAYER\" \"_LT\" \"_BYBLOCK\" \"_LW\" \"_BYLAYER\" \"\")", + ); + assert_eq!((a.color, a.linetype.as_str(), a.lineweight), (Color::ByLayer, "ByBlock", Lineweight::ByLayer)); +} + +#[test] +fn chprop_refuses_what_autocad_refuses() { + let (s, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_LA\" \"KHONGCO\" \"\")"); + assert_eq!(a.layer, "0"); + assert!(s.log.iter().any(|l| l == "Cannot find layer \"KHONGCO\"."), "{:?}", s.log); + for n in [0, 256, 300] { + let (s, [a, _]) = run(&format!("(command \"_.CHPROP\" a \"\" \"_C\" {n} \"\")")); + assert_eq!(a.color, Color::ByLayer, "{n}"); + assert!(s.log.iter().any(|l| l == "Invalid color number."), "{n}: {:?}", s.log); + } + let (s, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_C\" \"_T\" \"300,0,0\" \"\")"); + assert_eq!(a.color, Color::ByLayer); + assert!(s.log.iter().any(|l| l == "Requires three integers from 0 to 255, separated by commas."), "{:?}", s.log); + let (s, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_TR\" 95 \"\")"); + assert_eq!(a.transparency, Transparency::ByLayer); + assert!(s.log.iter().any(|l| l == "Requires ByLayer, ByBlock or an integer from 0 to 90."), "{:?}", s.log); + // `L` is LAyer, LType, ltScale or LWeight: none of them. + let (s, [a, _]) = run("(command \"_.CHPROP\" a \"\" \"_L\")"); + assert_eq!(a.layer, "0"); + assert!(s.log.iter().any(|l| l == "Ambiguous response, please clarify..."), "{:?}", s.log); +} + +/// Line a on layer 0 and lines b and c on the locked layer L1 (`a`, `b` and `c` in LISP); their +/// handles. +fn locked_drawing() -> (Session, Vec) { + let mut s = Session::new(); + s.doc_mut().unwrap().ensure_layer("L1"); + for (v, y) in [("a", 0), ("b", 20), ("c", 40)] { + s.execute("line", &json!({ "points": [[0, y], [50, y]] })).unwrap(); + s.cmdline(&format!("(setq {v} (entlast))")).unwrap(); + } + s.cmdline("(command \"_.CHPROP\" b c \"\" \"_LA\" \"L1\" \"\")").unwrap(); + s.execute("layer.set", &json!({ "name": "L1", "locked": true })).unwrap(); + s.log.clear(); + let hs = s.doc().unwrap().model.iter().map(|e| e.handle).collect(); + (s, hs) +} + +fn colors(s: &Session) -> Vec { + s.doc().unwrap().model.iter().map(|e| e.common.color).collect() +} + +/// AutoCAD 2024 leaves objects on locked layers out at "Select objects" and says how many after +/// what was found; with none left, Enter ends the command. +#[test] +fn chprop_leaves_objects_on_locked_layers_alone() { + // The colours of a, b and c after `code`, run with `pickfirst` selected. + let after = |code: &str, pickfirst: &[usize]| { + let (mut s, hs) = locked_drawing(); + s.set_selection(pickfirst.iter().map(|i| hs[*i]).collect()); + s.cmdline(code).unwrap(); + (colors(&s), s.log.clone(), s.running.is_some()) + }; + let (c, log, _) = after("(command \"_.CHPROP\" (ssadd b (ssadd a)) \"\" \"_C\" 3 \"\")", &[]); + assert_eq!(c, [Color::Index(3), Color::ByLayer, Color::ByLayer]); + assert!(log.iter().any(|l| l == "1 was on a locked layer."), "{log:?}"); + let (c, log, _) = after("(command \"_.CHPROP\" (ssadd c (ssadd b (ssadd a))) \"\" \"_C\" 4 \"\")", &[]); + assert_eq!(c, [Color::Index(4), Color::ByLayer, Color::ByLayer]); + assert!(log.iter().any(|l| l == "2 were on a locked layer."), "{log:?}"); + // Nothing left: Enter ends the command. + let (_, log, running) = after("(command \"_.CHPROP\" b \"\")", &[]); + assert!(log.iter().any(|l| l == "1 was on a locked layer."), "{log:?}"); + assert!(!running); + // The pickfirst selection loses them too; with none of it left, CHPROP asks for objects. + let (c, log, _) = after("(command \"_.CHPROP\" \"_C\" 5 \"\")", &[0, 1]); + assert_eq!(c, [Color::Index(5), Color::ByLayer, Color::ByLayer]); + assert!(log.iter().any(|l| l == "1 was on a locked layer."), "{log:?}"); + let (c, _, _) = after("(command \"_.CHPROP\" a \"\" \"_C\" 6 \"\")", &[1]); + assert_eq!(c, [Color::Index(6), Color::ByLayer, Color::ByLayer]); + // The JSON form leaves them out as well, and says how many. + let (mut s, hs) = locked_drawing(); + let r = s.execute("chprop", &json!({ "handles": [hs[0].hex(), hs[1].hex()], "color": 3 })).unwrap(); + assert_eq!((r["changed"].as_u64(), r["locked"].as_u64()), (Some(1), Some(1)), "{r}"); + let r = s.execute("chprop", &json!({ "handles": [hs[2].hex()], "color": 4 })).unwrap(); + assert_eq!((r["changed"].as_u64(), r["locked"].as_u64()), (Some(0), Some(1)), "{r}"); + assert_eq!(colors(&s), [Color::Index(3), Color::ByLayer, Color::ByLayer]); +} diff --git a/crates/engine/tests/it/main.rs b/crates/engine/tests/it/main.rs index d0d3aedc8..5c0a37f45 100644 --- a/crates/engine/tests/it/main.rs +++ b/crates/engine/tests/it/main.rs @@ -19,6 +19,7 @@ mod break_closed_polyline; mod break_join_locked_layers; mod break_keeps_z; mod burst; +mod chprop_command; mod compare_export; mod constraint_geometry; mod constraint_infer; From 43c41b8e684ce5a7eaf5dc9d2d72aa0c43bfd0dd Mon Sep 17 00:00:00 2001 From: Nine <136345161+nine-codes@users.noreply.github.com> Date: Fri, 30 Oct 2026 20:46:30 +0100 Subject: [PATCH 48/49] bs: Add Bosnian (bs) to the interface languages (#2502) * Add Bosnian (bs) to the interface languages bs.tsv: Bosnian (Latin script, Ijekavian) catalog covering every key of CADCraft's other catalogs, its wording shared with storytold/craft-i18n locales/bs/ and the strings craft-i18n lacks translated new. Every bs-* locale selects it; counts use one/few/other. Locale and plural tests, localization docs and an attribution entry (AI-assisted, not yet reviewed by a native speaker). Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_013Tayw8nmxoLLmKv13jK93z * docs(localization-parity): Bosnian in the Languages table (CodeRabbit) --------- Co-authored-by: Claude Co-authored-by: Brandon Thomas --- ATTRIBUTION.md | 1 + crates/ui-egui/src/i18n.rs | 14 +- crates/ui-egui/src/i18n/bs.tsv | 1449 ++++++++++++++++++++++++++++++ crates/ui-egui/src/i18n/tests.rs | 10 + crates/ui-egui/src/options.rs | 2 +- docs/localization-parity.md | 8 +- 6 files changed, 1478 insertions(+), 6 deletions(-) create mode 100644 crates/ui-egui/src/i18n/bs.tsv diff --git a/ATTRIBUTION.md b/ATTRIBUTION.md index e124d102a..31ea4b474 100644 --- a/ATTRIBUTION.md +++ b/ATTRIBUTION.md @@ -65,6 +65,7 @@ Generated-in-code assets are original and have no file to list: | `crates/ui-egui/src/i18n/de.tsv` | the CADCraft contributors | Original German translations of CADCraft English strings | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | No proprietary localization resources copied | | `crates/ui-egui/src/i18n/es.tsv` | @PedroGuille | Original Spanish translations of CADCraft English strings | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | No proprietary localization resources copied | | `crates/ui-egui/src/i18n/pt_br.tsv` | @WladmirJunior | Original Brazilian Portuguese translations of CADCraft English strings | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | No proprietary localization resources copied | +| `crates/ui-egui/src/i18n/bs.tsv` | Nine (@nine-codes) with Claude Code (AI-assisted) | Original Bosnian translations of CADCraft English strings, shared with storytold/craft-i18n `locales/bs/` | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | No proprietary localization resources copied; not yet reviewed by a native speaker | | `crates/ui-egui/src/i18n/cs.tsv` | @Losminek (AI-assisted) | Original Czech translations of CADCraft English strings | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | No proprietary localization resources copied | | `crates/ui-egui/src/i18n/ru.tsv` | @pechnikov2026-star | Original Russian translations of CADCraft English strings | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | No proprietary localization resources copied | | `crates/ui-egui/src/i18n/fr.tsv` | @pechnikov2026-star | Original French translations of CADCraft English strings | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) | No proprietary localization resources copied | diff --git a/crates/ui-egui/src/i18n.rs b/crates/ui-egui/src/i18n.rs index ed252f88b..7bb00ec17 100644 --- a/crates/ui-egui/src/i18n.rs +++ b/crates/ui-egui/src/i18n.rs @@ -45,10 +45,12 @@ pub enum Preference { Hungarian, #[serde(rename = "tr")] Turkish, + #[serde(rename = "bs")] + Bosnian, } impl Preference { - pub const ALL: [Self; 17] = [ + pub const ALL: [Self; 18] = [ Self::Auto, Self::English, Self::Greek, @@ -66,6 +68,7 @@ impl Preference { Self::Arabic, Self::Hungarian, Self::Turkish, + Self::Bosnian, ]; /// Every preference in the order the Interface Language dialog lists them: Auto, then English @@ -113,6 +116,7 @@ impl Preference { Self::Arabic => "ar", Self::Hungarian => "hu", Self::Turkish => "tr", + Self::Bosnian => "bs", } } @@ -141,6 +145,7 @@ impl Preference { Self::Arabic => "العربية", Self::Hungarian => "Magyar", Self::Turkish => "Türkçe", + Self::Bosnian => "Bosanski", } } @@ -171,6 +176,7 @@ impl Preference { Self::Arabic => "ar", Self::Hungarian => "hu", Self::Turkish => "tr", + Self::Bosnian => "bs", Self::Auto => locales.iter().find_map(|s| locale_language(s)).unwrap_or("en"), } } @@ -187,7 +193,7 @@ pub struct Language { catalog: OnceLock>, } -pub static LANGUAGES: [Language; 16] = [ +pub static LANGUAGES: [Language; 17] = [ Language { code: "en", name: "English", source: "", plural: plural_en, plural_forms: 2, catalog: OnceLock::new() }, // Greek: one for exactly 1; other for zero and all other integer counts. Language { @@ -234,6 +240,9 @@ pub static LANGUAGES: [Language; 16] = [ Language { code: "hu", name: "Magyar", source: include_str!("i18n/hu.tsv"), plural: plural_ko, plural_forms: 1, catalog: OnceLock::new() }, // Turkish keeps a noun singular after a number ("3 commit"), so like Korean it has one form. Language { code: "tr", name: "Türkçe", source: include_str!("i18n/tr.tsv"), plural: plural_ko, plural_forms: 1, catalog: OnceLock::new() }, + // Bosnian (Latin script, Ijekavian): one (1, 21), few (2–4, 22–24, not 12–14), other — the + // Ukrainian rule for integer counts. + Language { code: "bs", name: "Bosanski", source: include_str!("i18n/bs.tsv"), plural: plural_uk, plural_forms: 3, catalog: OnceLock::new() }, ]; /// BCP 47 and POSIX locale tags, including `uk-UA`, `uk_UA.UTF-8` and `pt_BR.UTF-8`. @@ -437,6 +446,7 @@ mod picker_order_tests { assert!(pos(Preference::Czech) < pos(Preference::German), "Čeština sorts under C"); assert!(pos(Preference::Italian) < pos(Preference::Hungarian), "Magyar sorts under M"); assert!(pos(Preference::Turkish) < pos(Preference::Greek), "Latin names come before Greek"); + assert!(pos(Preference::Bosnian) < pos(Preference::Czech), "Bosanski sorts under B"); assert_eq!(name_sort_key("Türkçe"), "turkce"); } } diff --git a/crates/ui-egui/src/i18n/bs.tsv b/crates/ui-egui/src/i18n/bs.tsv new file mode 100644 index 000000000..14565ce2f --- /dev/null +++ b/crates/ui-egui/src/i18n/bs.tsv @@ -0,0 +1,1449 @@ +# CADCraft Bosnian interface catalog — original translations by Nine (@nine-codes) with Claude Code (AI-assisted). +# SPDX-License-Identifier: MIT OR Apache-2.0 +# Written from the meaning of CADCraft English strings; no proprietary translations copied. +# Latin script, Ijekavian; the wording is shared with storytold/craft-i18n (locales/bs/cadcraft.tsv +# and common.tsv). Not yet reviewed by a native speaker. +# UTF-8: contextEnglish sourceBosnian translation. +# @plural = one|few|other forms for integer counts. + Apply Primijeni + Attach DWG... Priloži DWG... + Bind Veži + Detach Odvoji + Loaded Učitano + Make it a block of this drawing, keeping its layer names Pretvori u blok ovog crteža, zadržavajući nazive slojeva + Make it a block of this drawing; its layers become NAME$0$LAYER Pretvori u blok ovog crteža; slojevi postaju NAZIV$0$SLOJ + No external references are attached. Nisu priložene vanjske reference. + Not Found Nije pronađeno + Not loaded Nije učitano + Open Otvori + Overlay Prekrivanje + Reference Manager Upravitelj referenci + Reference Name Naziv reference + References: {n} Reference: {n} + Reload Ponovo učitaj + Reload All Ponovo učitaj sve + Saved Path Sačuvana putanja + Unload Isprazni iz memorije + Unloaded Ispražnjeno iz memorije + Unreferenced Nereferencirano + Unresolved Neriješeno + Cancel Otkaži + OK U redu + or [ ili [ + % of all commits % svih commitova + * Wildcard Match * Podudaranje zamjenskim znakom + *VARIES* *RAZLIČITO* + + | Top | 2D Wireframe + | Vrh | 2D žičani model + +Bin +Bin + +LOC +LOC + 1 Viewport 1 prozor prikaza + 2 Points 2 tačke + 2 Viewports 2 prozora prikaza + 2D Solid 2D puno tijelo + 3 Points 3 tačke + 3 Viewports 3 prozora prikaza + 3D Face 3D lice + 3D Operations 3D operacije + 3D Polyline 3D polilinija + 4 Viewports 4 prozora prikaza + < Less than < Manje od + <> Not Equal <> Nije jednako + = Equals = Jednako + > Greater than > Veće od + A variable name starts with a letter and has only letters, digits and _ Naziv varijable počinje slovom i sadrži samo slova, cifre i _ + About O programu + About CADCraft O CADCraftu + Absolute Apsolutno + Add Leader Dodaj pokaznu liniju + Additional angles Dodatni uglovi + Align Poravnaj + Align Text Poravnaj tekst + Aligned Poravnato + All Sve + All Annotation Objects Svi objekti napomena + All Used Layers Svi korišteni slojevi + All files Sve datoteke + Angle Ugao + Angular Ugaono + Annotation Visibility Vidljivost napomena + Annotation scale Skala napomena + Apparent Intersection Prividni presjek + Append to current selection set Dodaj trenutnom skupu odabira + Apply to: Primijeni na: + Apply true color Primijeni pravu boju + Arc Luk + Arc Length Dužina luka + Area Područje + Arrange Panel Panel rasporeda + Array Niz + Attach Priloži + Attribute Atribut + Attribute Definition Definicija atributa + Attribute Display Prikaz atributa + Audit Revizija + Auto (system language) Automatski (jezik sistema) + Auto Constrain Automatska ograničenja + AutoConstrain Automatska ograničenja + Axis, End Osa, kraj + Base Baza + Baseline Osnovna linija + Batch Publish Paketno objavljivanje + Binary assets added Dodani binarni resursi + Binary assets removed Uklonjeni binarni resursi + Bind... Veži... + Blend Prelaz + Block Blok + Block Attribute Manager... Upravitelj atributa blokova... + Block Description... Opis bloka... + Block Editor Uređivač blokova + Block Reference Referenca bloka + Block... Blok... + Blocks Blokovi + Blue Plava + Bold Podebljano + Boolean Booleova operacija + Boundary Granica + Boundary... Granica... + Box Kvadar + Break Prekini + Break At Point Prekini u tački + Bring Above Objects Postavi iznad objekata + Bring Annotations to Front Postavi napomene na vrh + Bring to Front Postavi na vrh + Bulleted list Lista s oznakama + ByBlock PoBloku + ByColor PoBoji + ByLayer PoSloju + CADCraft Help Pomoć za CADCraft + Cancel Otkaži + Cartesian (x, y) Kartezijske (x, y) + Center Sredina + Center Line Središnja linija + Center Mark Oznaka središta + Center X Središte X + Center Y Središte Y + Center Z Središte Z + Center, Diameter Središte, prečnik + Center, Radius Središte, poluprečnik + Center, Start, Angle Središte, početak, ugao + Center, Start, End Središte, početak, kraj + Center, Start, Length Središte, početak, dužina + Chamfer Zakošenje + Change Space Promijeni prostor + Change to Current Layer Promijeni u trenutni sloj + Changed: {n} Promijenjeno: {n} + Circle Krug + Circumference Obim kruga + Clear History Očisti historiju + Clear Očisti + Clip Odsijeci + Clip Viewport Odsijeci prozor prikaza + Clipboard Međuspremnik + Close Zatvori + Close All Zatvori sve + Close All Other Drawings Zatvori sve ostale crteže + Closed Zatvoreno + Close Comparison Zatvori poređenje + Export Comparison Izvezi poređenje + Coincident Podudarno + Collapse Tool Sets Skupi skupove alata + Collinear Kolinearno + Color Boja + Color 8 Boja 8 + Color 9 Boja 9 + Color Index Indeks boje + Color... Boja... + Command Aliases Pseudonimi naredbi + Command History Historija naredbi + Clear Command History Očisti historiju naredbi + Command Line Komandna linija + Command Line History Lines Redovi historije komandne linije + Command Reference Referenca naredbi + Commits Commitovi + Company Firma + Compare Drawings... Uporedi crteže... + Computer-aided design and drafting: an open-source, clean-room CAD application written in pure Rust. Računarski potpomognuto projektovanje i crtanje: CAD aplikacija otvorenog koda, napisana od nule u čistom Rustu. + Concentric Koncentrično + Cone Kupa + Constraint Bars Trake ograničenja + Constraint Settings Postavke ograničenja + Construction Line Konstrukcijska linija + Contents Sadržaj + Continue Nastavi + Contributors Saradnici + Control Vertices Kontrolna tjemena + Convert Pretvori + Copy Kopiraj + Copy Full File Path Kopiraj punu putanju datoteke + Copy History Kopiraj historiju + Copy Layout Kopiraj raspored + Copy Nested Objects Kopiraj ugniježđene objekte + Copy Selection Kopiraj odabir + Copy with Base Point Kopiraj s baznom tačkom + Count Broj + Count List Lista brojanja + Count Table Tabela brojanja + Create Block Kreiraj blok + Creates a user parameter Kreira korisnički parametar + Ctrl+Enter to finish Ctrl+Enter za završetak + Current layer Trenutni sloj + Current selection Trenutni odabir + Current: {color} Trenutno: {color} + Cut Izreži + Cut with Base Point Izreži s baznom tačkom + Cyan Cijan + Cylinder Valjak + DWG DWG + DWG Reference... DWG referenca... + DXF DXF + Dark Tamno + Data Extraction... Izdvajanje podataka... + Default Zadano + Data Link... Veza s podacima... + Default Save Format Zadani format čuvanja + Default Save Version Zadana verzija čuvanja + Define Attributes Definiši atribute + Define Attributes... Definiši atribute... + Defined width Definisana širina + Degree Stepen + Degrees of Freedom Stepeni slobode + Degrees of freedom: {n} Stepeni slobode: {n} + Delete Izbriši + Delete Column Izbriši kolonu + Delete Constraints Izbriši ograničenja + Delete Dimension Style Izbriši stil kotiranja + Delete Duplicate Objects Izbriši duplikate objekata + Delete Layer Izbriši sloj + Delete Layer State Izbriši stanje slojeva + Delete Layout Izbriši raspored + Delete Row Izbriši red + Delete Text Style Izbriši stil teksta + Delta X Delta X + Delta Y Delta Y + Description Opis + Deselect All Poništi sav odabir + Diameter Prečnik + Dim style Stil kote + Dimension Break Prekid kote + Dimension Edit Uređivanje kote + Dimension Kota + Dimension Objects Only Samo objekti kota + Dimension Space Razmak kota + Dimension Style Override Zamjena stila kotiranja + Dimension Style... Stil kotiranja... + Dimension Text Edit Uređivanje teksta kote + Dimension style Stil kotiranja + Dimensional Constraint Dimenzionalno ograničenje + Dimensional Constraint Parameters Parametri dimenzionalnih ograničenja + Dimensional Constraints Dimenzionalna ograničenja + Disassociate Dimensions Razdruži kote + Display name Ime za prikaz + Distance Udaljenost + Divide Podijeli + Do not plot (click: plot) Ne iscrtavaj (klik: iscrtaj) + Donut Prsten + Double-click to edit the description Dvostruki klik za uređivanje opisa + Down Dolje + Drafting Crtanje + Drafting Settings Postavke crtanja + Drafting Settings... Postavke crtanja... + Draw Crtaj + Draw Order Redoslijed crtanja + Drawing (DWG) Crtež (DWG) + Drawing (DXF) Crtež (DXF) + Drawing Limits Granice crteža + Drawing Template (DWT) Predložak crteža (DWT) + Drawing Utilities Uslužni programi za crteže + Drawings (DWG, DXF) Crteži (DWG, DXF) + Dynamic Dinamično + Dynamic Dimensions Dinamičke kote + Dynamic Input Dinamički unos + Dynamic Input (F12) Dinamički unos (F12) + E E + Edit Uredi + Edit Attributes... Uredi atribute... + Edit Text... Uredi tekst... + Edit Table Cell Uredi ćeliju tabele + Elevation Elevacija + Ellipse Elipsa + Elliptical Arc Eliptični luk + Enable Dynamic Input (F12) Omogući dinamički unos (F12) + End Object Isolation Završi izolaciju objekata + End Width Krajnja širina + End X Kraj X + End Y Kraj Y + End angle Krajnji ugao + Endpoint Krajnja tačka + Enter Enter + Enter Top, Zero or Bottom. Unesite Vrh, Nula ili Dno. + Enter a fit data option Unesite opciju podataka uklapanja + Enter a pattern name Unesite naziv uzorka + Enter a vertex editing option Unesite opciju uređivanja tjemena + Enter an option Unesite opciju + Enter angle of xline Unesite ugao konstrukcijske linije + Enter angle of xline (0) or Unesite ugao konstrukcijske linije (0) ili + Enter area of rectangle in current units Unesite površinu pravougaonika u trenutnim jedinicama + Enter attribute prompt Unesite upit atributa + Enter attribute tag name Unesite naziv oznake atributa + Enter attribute value Unesite vrijednost atributa + Enter block name Unesite naziv bloka + Enter constraint type Unesite vrstu ograničenja + Enter continuity Unesite kontinuitet + Enter default attribute value Unesite zadanu vrijednost atributa + Enter degree of spline Unesite stepen splajna + Enter delta angle Unesite delta ugao + Enter delta length or Unesite delta dužinu ili + Enter dimension text Unesite tekst kote + Enter dimension text (<> = measurement) Unesite tekst kote (<> = mjera) + Enter dimension value or [name=expression] Unesite vrijednost kote ili [naziv=izraz] + Enter dimension variable name to override Unesite naziv varijable kotiranja za zamjenu + Enter justification type Unesite vrstu poravnanja + Enter leader text Unesite tekst pokazne linije + Enter mline scale Unesite skalu višestruke linije + Enter mode Unesite način + Enter name of block to insert Unesite naziv bloka za umetanje + Enter new text Unesite novi tekst + Enter next point Unesite sljedeću tačku + Enter number of columns Unesite broj kolona + Enter number of data rows Unesite broj redova podataka + Enter number of items Unesite broj stavki + Enter number of items along path Unesite broj stavki duž putanje + Enter number of sides Unesite broj stranica + Enter number of turns Unesite broj zavoja + Enter percentage length Unesite postotak dužine + Enter rectangle length Unesite dužinu pravougaonika + Enter rectangle width Unesite širinu pravougaonika + Enter scale factor Unesite faktor skale + Enter text Unesite tekst + Enter text (use \P for new paragraphs) Unesite tekst (koristite \P za nove pasuse) + Enter the number of segments Unesite broj segmenata + Enter twist direction of helix Unesite smjer uvijanja spirale + Entire drawing Cijeli crtež + Equal Jednako + Erase Briši + Evaluate Izračunaj + Exclude from new selection set Isključi iz novog skupa odabira + Explode Rastavi + Export Izvezi + Export Table Izvezi tabelu + Export to PDF... Izvezi u PDF... + Expression Izraz + Extend Produži + Extension Produžetak + Extents Opseg + External Reference Vanjska referenca + External References Vanjske reference + Extrude Istisni + File Datoteka + File Tab Kartica datoteke + Fillet Zaobljenje + Filter Filter + Filters Filteri + Find and Replace Pronađi i zamijeni + Find... Pronađi... + First Prvo + First commit Prvi commit + Fit Points Tačke uklapanja + Fix Fiksiraj + Flatten Objects Spljošti objekte + Format Format + Freehand Prostoručno + Freeze Zamrzni + Freeze Layer Zamrzni sloj + Freeze in new viewports Zamrzni u novim prozorima prikaza + Freeze/Thaw Zamrzni/odmrzni + Freeze/Thaw in all viewports Zamrzni/odmrzni u svim prozorima prikaza + Freeze/Thaw in the current viewport Zamrzni/odmrzni u trenutnom prozoru prikaza + From Od + From Template... Iz predloška... + General Općenito + Geometric Center Geometrijsko središte + Geometric Constraint Geometrijsko ograničenje + Geometric Constraints Geometrijska ograničenja + Geometry Geometrija + Get from the Drawing Preuzmi iz crteža + Get Variable Preuzmi varijablu + Get View Preuzmi pogled + Global Globalno + Global width Globalna širina + Grab bag Svaštara + Gradient Gradijent + Gradient... Gradijent... + Green Zelena + Grid (F7) Mreža (F7) + Grid Display Prikaz mreže + Grid On (F7) Mreža uključena (F7) + Grid snap Hvatanje mreže + Grid spacing Razmak mreže + Grip Edit Uređivanje hvataljkama + Grip Mirror Zrcaljenje hvataljkom + Grip Option Opcija hvataljke + Grip Rotate Rotacija hvataljkom + Grip Scale Skaliranje hvataljkom + Grip Stretch Razvlačenje hvataljkom + Group Grupiši + Group Edit Uređivanje grupe + Group Options Opcije grupe + Group Selection Odabir grupe + Hatch Šrafura + Hatch Edit Uređivanje šrafure + Hatch Patterns Uzorci šrafure + Hatch... Šrafura... + Height Visina + Height: {height} Visina: {height} + Helix Spirala + Help Pomoć + Hide All Sakrij sve + Hide All Constraint Bars Sakrij sve trake ograničenja + Hide All Dynamic Dimensions Sakrij sve dinamičke kote + Hide Layer List Sakrij listu slojeva + Hide Objects Sakrij objekte + Hide Palettes Sakrij palete + History Historija + Home Početna + Horizontal Vodoravno + HorizontalDistance Vodoravna udaljenost + How to apply: Kako primijeniti: + ID Point Identifikuj tačku + Import Uvezi + In In + In-window Menu Bar Traka menija u prozoru + Include in new selection set Uključi u novi skup odabira + Increment angle Ugao koraka + Index Color Indeksna boja + Index color: {index} Indeksna boja: {index} + Infer Constraints Zaključi ograničenja + Inquiry Upit + Insert Umetni + Insert Block Umetni blok + Insert Column Umetni kolonu + Insert Row Umetni red + Insert tab Umetni tabulator + Insert this block Umetni ovaj blok + Insert Table Formula Umetni formulu tabele + Insertion Umetanje + Insertion X Umetanje X + Insertion Y Umetanje Y + Insertion Z Umetanje Z + Inspect Constraints Pregledaj ograničenja + Inspect Drawing Pregledaj crtež + Inspection Inspekcija + Interface Language Jezik interfejsa + Interface Theme Tema interfejsa + Intersect Presijeci + Intersection Presjek + Isolate Izoliraj + Isolate Layer Izoliraj sloj + Isolate Objects Izoliraj objekte + Isometric Drafting Izometrijsko crtanje + Jogged Prelomljeno + Jogged Linear Prelomljeno linearno + Join Spoji + Join the ArtCraft Discord… Pridružite se ArtCraft Discordu… + Join us on Discord Pridružite nam se na Discordu + Isometric Plane Izometrijska ravan + Isometric snap Izometrijsko hvatanje + Language Jezik + Last Posljednje + Last commit Posljednji commit + Layer Sloj + Layer Delete Brisanje sloja + Layer Match Uskladi sloj + Layer Merge Spoji slojeve + Layer Off Isključi sloj + Layer Properties Svojstva sloja + Layer Properties Manager Upravitelj svojstava slojeva + Layer Properties Manager — current viewport Upravitelj svojstava slojeva — trenutni prozor prikaza + Layer State Stanje slojeva + Layer States Manager... Upravitelj stanja slojeva... + Layer Tools Alati za slojeve + Layer contains objects (double-click to make current) Sloj sadrži objekte (dvostruki klik da postane trenutni) + Layer is empty (double-click to make current) Sloj je prazan (dvostruki klik da postane trenutni) + Layers Slojevi + Layers Palette Paleta slojeva + Hide Palette Sakrij paletu + Layers displayed: {shown} of {total}. Current layer: {layer} Prikazani slojevi: {shown} od {total}. Trenutni sloj: {layer} + Layout Raspored + Layout list Lista rasporeda + Leader Pokazna linija + Leaders Only Samo pokazne linije + Left Lijevo + Length Dužina + Length X Dužina X + Length Y Dužina Y + Lengthen Produlji + Light Svijetlo + Line Linija + Line delta Razlika u linijama + Linear Linearno + Lines +/− Linije +/− + Lines added Dodane linije + Lines deleted Izbrisane linije + Lines of Command History Redovi historije naredbi + Linetype Vrsta linije + Linetype Scale Skala vrste linije + Linetype scale Skala vrste linije + Ltscale Ltscale + Linetype... Vrsta linije... + Lineweight Debljina linije + Lineweight... Debljina linije... + List Lista + List Blocks Izlistaj blokove + List Dimension Styles Izlistaj stilove kotiranja + List Groups Izlistaj grupe + List Layer States Izlistaj stanja slojeva + List Layouts Izlistaj rasporede + List System Variables Izlistaj sistemske varijable + List Text Styles Izlistaj stilove teksta + Load all Učitaj sve + Load... Učitaj... + Loaded linetypes Učitane vrste linija + Lock Zaključaj + Lock Layer Zaključaj sloj + Lock viewport Zaključaj prozor prikaza + Lock/Unlock Zaključaj/otključaj + Loft Prelazno tijelo + MIT OR Apache-2.0. Not affiliated with Autodesk, Inc. MIT OR Apache-2.0. Nije povezano s Autodesk, Inc. + MODEL MODEL + MText MText + Magenta Magenta + Major line every Glavna linija svakih + Make Current Postavi kao trenutno + Make Object's Layer Current Postavi sloj objekta kao trenutni + Make... Napravi... + Match Layer Uskladi sloj + Match Properties Uskladi svojstva + Measure Mjeri + Measure Distance Izmjeri udaljenost + Measure Geometry Izmjeri geometriju + Merge Cells Spoji ćelije + Merged PRs Spojeni PR-ovi + Mid Between 2 Points Sredina između 2 tačke + Midpoint Srednja tačka + Mirror Zrcali + Model Model + Model Space (in viewport) Prostor modela (u prozoru prikaza) + Modeling Modeliranje + Models Modeli + Modify Izmijeni + Move Pomakni + Multileader Višestruka pokazna linija + Multileader Style... Stil višestruke pokazne linije... + Multileader style Stil višestruke pokazne linije + Multiline Višestruka linija + Multiline Text Višeredni tekst + Multiline Text... Višeredni tekst... + Multiple Višestruko + Multiple Point Višestruka tačka + My Moje + My properties: not available yet Moja svojstva: još nisu dostupna + N N + Name Naziv + Name (A–Z) Naziv (A–Z) + Named Viewports... Imenovani prozori prikaza... + Named Views... Imenovani pogledi... + Nearest Najbliže + New Novo + New (metric) Novo (metrički) + New Drawing Novi crtež + New Drawing (⌘N) Novi crtež (⌘N) + New Drawing... Novi crtež... + New Layer Novi sloj + New Layout Novi raspored + New VP Freeze Zamrzni u novom PP + New Viewports... Novi prozori prikaza... + New from Template... Novo iz predloška... + New layout Novi raspored + New state name Naziv novog stanja + Next Change Sljedeća promjena + No Ne + No blocks defined in this drawing. U ovom crtežu nisu definisani blokovi. + No contributor data was built into this copy. U ovu kopiju nisu ugrađeni podaci o saradnicima. + No model credits were built into this copy. U ovu kopiju nisu ugrađene zasluge za modele. + No saved layer states Nema sačuvanih stanja slojeva + No selection Nema odabira + Node Čvor + None Ništa + Normal Normalno + Not available Nije dostupno + Not available yet Još nije dostupno + Numbered list Numerisana lista + OK U redu + Object Objekat + Object Snap Hvatanje objekata + Object Snap (F3) Hvatanje objekata (F3) + Object Snap On (F3) Hvatanje objekata uključeno (F3) + Object Snap Tracking Praćenje hvatanja objekata + Object Snap Tracking (F11) Praćenje hvatanja objekata (F11) + Object Snap Tracking Settings Postavke praćenja hvatanja objekata + Object type: Vrsta objekta: + Oblique Koso + Off Isključeno + Offset Pomak + On Uključeno + On/Off Uključi/isključi + One of the Crafting Apps by the ArtCraft team and community. Jedna od Crafting aplikacija ArtCraft tima i zajednice. + Only in this drawing: {n} Samo u ovom crtežu: {n} + Only in {name}: {n} Samo u {name}: {n} + Open (⌘O) Otvori (⌘O) + Open Sample Drawing Otvori primjer crteža + Open sample drawing Otvori primjer crteža + Open Xref Otvori vanjsku referencu + Open... Otvori... + Operator: Operator: + Orbit Orbita + Ordinate Ordinata + Ortho (F8) Orto (F8) + Ortho Mode Orto način + Ortho Mode (F8) Orto način (F8) + Osnap Settings... Postavke hvatanja objekata... + Out Out + Over-constrained Previše ograničeno + Override Zamjena + PAPER PAPIR + Percent Postotak + Polar (distance < angle) Polarne (udaljenost < ugao) + PRs PR-ovi + Page Setup Manager Upravitelj postavki stranice + Page Setup Manager... Upravitelj postavki stranice... + Pan Pomicanje pogleda + Pan Down Pomakni pogled dolje + Pan Left Pomakni pogled lijevo + Pan Right Pomakni pogled desno + Pan Up Pomakni pogled gore + Paper Space Prostor papira + Parallel Paralelno + Parameters Manager Upravitelj parametara + Parametric Parametarsko + Paste Zalijepi + Paste as Block Zalijepi kao blok + Paste to Command Line Zalijepi u komandnu liniju + Paste to Original Coordinates Zalijepi na originalne koordinate + Path Array Niz po putanji + Pattern Uzorak + Perpendicular Okomito + Plot Iscrtaj + Plot (click: do not plot) Iscrtaj (klik: ne iscrtavaj) + Plot Preview Pregled iscrtavanja + Plot Window Prozor iscrtavanja + Plot style Stil iscrtavanja + Plot style attached to Stil iscrtavanja priložen uz + Plot style table Tabela stilova iscrtavanja + Plot Style... Stil iscrtavanja... + Plot Style Manager Upravitelj stilova iscrtavanja + Plot Style Manager... Upravitelj stilova iscrtavanja... + Plot Styles... Stilovi iscrtavanja... + Plotter Manager Upravitelj plotera + Plotter Manager... Upravitelj plotera... + New CTB Novi CTB + New STB Novi STB + New style Novi stil + Reset Panel Layout Vrati raspored panela na početno + Send Hatches to Back Postavi šrafure na dno + Send Under Objects Postavi ispod objekata + Text Objects Only Samo tekstualni objekti + Use for this layout Koristi za ovaj raspored + Display plot styles Prikaži stilove iscrtavanja + No plot style tables. Nema tabela stilova iscrtavanja. + A built-in table: editing it keeps an edited copy in the drawing. Ugrađena tabela: njeno uređivanje čuva uređenu kopiju u crtežu. + Keep an editable copy of this table in the drawing Zadrži kopiju ove tabele za uređivanje u crtežu + Layout {name}: {table} Raspored {name}: {table} + Grayscale Nijanse sive + Screening Prigušenje + Use object linetype Koristi vrstu linije objekta + Use object lineweight Koristi debljinu linije objekta + Remove Ukloni + Add Dodaj + Open a drawing first. Prvo otvorite crtež. + Plot table type Vrsta tabele iscrtavanja + Color-dependent Zavisno od boje + Named Imenovano + Plus/minus Plus/minus + Point Tačka + Point Filters Filteri tačaka + Point Style... Stil tačke... + Polar Array Polarni niz + Polar Tracking Polarno praćenje + Polar Tracking (F10) Polarno praćenje (F10) + Polar Tracking On (F10) Polarno praćenje uključeno (F10) + Polar angle measurement Mjerenje polarnog ugla + Polar distance Polarna udaljenost + Polar: {distance} < {angle}° Polarno: {distance} < {angle}° + PolarSnap Polarno hvatanje + Polygon Mnogougao + Polygonal Mnogougaono + Polygonal Viewport Mnogougaoni prozor prikaza + Polyline Izlomljena linija + Polyline Edit Uređivanje polilinije + Position X Položaj X + Position Y Položaj Y + Position Z Položaj Z + Previous Prethodno + Previous Change Prethodna promjena + Previous Layer Prethodni sloj + Primitives Primitivi + Print Štampaj + Print... Štampaj... + Properties Svojstva + Properties Inspector Inspektor svojstava + Properties: Svojstva: + Proxy Proksi + Purge Očisti neiskorišteno + Pyramid Piramida + Quadrant Kvadrant + Query Entities Upit o entitetima + Quick Brzo + Quick Dimension Brza kota + Quick Properties Brza svojstva + Quick Select Brzi odabir + Quick Select Properties Svojstva brzog odabira + Quick Select... Brzi odabir... + QuickCalc Brzi kalkulator + QuickCalc Pick Odabir za brzi kalkulator + Quit CADCraft Zatvori CADCraft + Radius Poluprečnik + Raster Image Rasterska slika + Ray Zraka + Read-only Samo za čitanje + Real name Pravo ime + Realtime U stvarnom vremenu + Reassociate Dimensions Ponovo poveži kote + Recent Nedavno + Recent Commands Nedavne naredbe + Recent Input Nedavni unos + Recover... Oporavi... + Rectangle Pravougaonik + Recalculate Table Formulas Ponovo izračunaj formule tabele + Rectangular Pravougaono + Rectangular snap Pravougaono hvatanje + Rectangular Array Pravougaoni niz + Red Crvena + Redo Ponovi + Redo (⇧⌘Z) Ponovi (⇧⌘Z) + Redraw Ponovo iscrtaj + Regen Regeneriši + Regen All Regeneriši sve + Region Regija + Region/Mass Properties Svojstva regije/mase + Reinitialize Ponovo inicijaliziraj + Relative Relativno + Relative to last segment U odnosu na posljednji segment + Remove Leader Ukloni pokaznu liniju + Remove the viewport override Ukloni zamjenu za prozor prikaza + Rename Dimension Style Preimenuj stil kotiranja + Rename Layer Preimenuj sloj + Rename Layer State Preimenuj stanje slojeva + Rename Layout Preimenuj raspored + Rename Text Style Preimenuj stil teksta + Rename... Preimenuj... + Repeat {command} Ponovi {command} + Replace Block... Zamijeni blok... + Requires a point (x,y, @dx,dy or @d Navedite drugu tačku ili + Specify second source point Navedite drugu izvornu tačku + Specify side to offset Navedite stranu za odmak + Specify start angle Navedite početni ugao + Specify start point Navedite početnu tačku + Specify start point of arc Navedite početnu tačku luka + Specify start point of polyline Navedite početnu tačku polilinije + Specify start point of text Navedite početnu tačku teksta + Specify starting width Navedite početnu širinu + Specify starting width for next segment Navedite početnu širinu za sljedeći segment + Specify tangent direction for the start point of arc Navedite smjer tangente za početnu tačku luka + Specify the elevation for rectangles Navedite elevaciju za pravougaonike + Specify thickness for rectangles Navedite debljinu za pravougaonike + Specify third point on circle Navedite treću tačku na krugu + Specify third point on circle: _tan to Navedite treću tačku na krugu: _tan na + Specify third source point or Navedite treću izvornu tačku ili + Specify through point Navedite tačku kroz koju prolazi + Specify top diameter Navedite gornji prečnik + Specify top radius or Navedite gornji poluprečnik ili + Specify total angle Navedite ukupni ugao + Specify total length or Navedite ukupnu dužinu ili + Specify width for rectangles Navedite širinu za pravougaonike + Sphere Sfera + Spline Splajn + Spline Edit Uređivanje splajna + Stack (type 1/2 then select) Složi (upišite 1/2 pa odaberite) + Standard Standardno + Start Početak + Start Width Početna širina + Start X Početak X + Start Y Početak Y + Start angle Početni ugao + Start, Center, Angle Početak, središte, ugao + Start, Center, End Početak, središte, kraj + Start, Center, Length Početak, središte, dužina + Start, End, Angle Početak, kraj, ugao + Start, End, Direction Početak, kraj, smjer + Start, End, Radius Početak, kraj, poluprečnik + Status Status + Status Bar Statusna traka + Stretch Razvuci + Style: Standard Stil: Standard + Subtract Oduzmi + Sweep Izvlačenje po putanji + Switch Drawing Promijeni crtež + Switch Layout Promijeni raspored + Switch between model space in a viewport and paper space Prebacuj između prostora modela u prozoru prikaza i prostora papira + Symmetric Simetrično + Synchronize Attributes Sinhronizuj atribute + To Do + Toggle PICKADD (off: each pick replaces the selection) Uključi/isključi PICKADD (isključeno: svaki odabir zamjenjuje odabir) + Toggle PICKADD (on: picks add to the selection) Uključi/isključi PICKADD (uključeno: odabiri se dodaju u odabir) + TOP VRH + Table Tabela + Table Breaks Prelomi tabele + Table Cell Style Stil ćelije tabele + Table Style... Stil tabele... + Table style Stil tabele + Table... Tabela... + Tan, Tan, Radius Tan, tan, poluprečnik + Tan, Tan, Tan Tan, tan, tan + Tangent Tangenta + Temporary track point Privremena tačka praćenja + Text Tekst + Text Editor Uređivač teksta + Text Height Visina teksta + Text Style... Stil teksta... + Text height Visina teksta + Text override Zamjena teksta + Text style Stil teksta + Thaw All Layers Odmrzni sve slojeve + Thaw Layer Odmrzni sloj + There is nothing here yet. Ovdje još nema ničega. + Thickness Debljina + Time Vrijeme + To get started, create or open a drawing. Za početak kreirajte ili otvorite crtež. + Tool Bar Traka s alatima + Tool Sets Skupovi alata + Tools Alati + Torus Torus + Trace Trag + Track orthogonally only Prati samo pravougaono + Track using all polar angle settings Prati koristeći sve postavke polarnih uglova + Transparency Prozirnost + Trim Odsijeci + True Color Prava boja + Turn All Layers On Uključi sve slojeve + Turn Off Layer Isključi sloj + Turn On Layer Uključi sloj + Turn Quick Properties off (QPMODE) Isključi brza svojstva (QPMODE) + Type Vrsta + Type a command Upišite naredbu + Type text; Enter starts a new paragraph Upišite tekst; Enter započinje novi pasus + UCS Icon Ikona KKS + Undo Poništi + Undo (⌘Z) Poništi (⌘Z) + Ungroup Razgrupiši + Union Unija + Unisolate Layer Prekini izolaciju sloja + Units Conversion Pretvaranje jedinica + Units... Jedinice... + Unlock Layer Otključaj sloj + Unlock viewport Otključaj prozor prikaza + Unmerge Cells Razdvoji spojene ćelije + Unsaved Layer State Nesačuvano stanje slojeva + Up Gore + Update Data Links Ažuriraj veze s podacima + Update Ažuriraj + Use System Setting Koristi sistemsku postavku + User Korisnik + User Parameters Korisnički parametri + Username Korisničko ime + Volume Zapremina + VP Color Boja u PP + VP Freeze Zamrzni u PP + Value Vrijednost + Value: Vrijednost: + Variables Varijable + Version Verzija + Version 2000 Verzija 2000 + Version 2004 Verzija 2004 + Version 2007 Verzija 2007 + Version 2010 Verzija 2010 + Version 2013 Verzija 2013 + Version 2018 Verzija 2018 + Version {version} Verzija {version} + Vertical Okomito + VerticalDistance Okomita udaljenost + View Prikaz + ViewCube ViewCube + Viewport Prozor prikaza + Viewport Layer Freeze Zamrzavanje slojeva u prozoru prikaza + Viewport Properties Svojstva prozora prikaza + Viewport is locked Prozor prikaza je zaključan + Viewport scale Skala prozora prikaza + Viewport {id} Prozor prikaza {id} + Viewports Prozori prikaza + W W + WCS WCS + White Bijela + Width factor Faktor širine + Window Prozor + Wipeout Prekrivanje + Workspace Switching Promjena radnog prostora + Write Block Zapiši blok + Xline Konstrukcijska linija + Yellow Žuta + Yes Da + Zoom Zumiranje + Zoom All Zumiraj sve + Zoom Dynamic Dinamičko zumiranje + Zoom Extents Zumiraj na opseg + Zoom In Uvećaj + Zoom Object Zumiraj objekat + Zoom Out Umanji + Zoom Previous Prethodno zumiranje + Zoom Realtime Zumiranje u stvarnom vremenu + Zoom Window Zumiraj prozor + error greška + {contributors} · {commits} {contributors} · {commits} + {kind} (constraint {id}) {kind} (ograničenje {id}) + {kind} constraint {name} = {expression} (double-click to edit) {kind} ograničenje {name} = {expression} (dvostruki klik za uređivanje) + {name}: {distance} < {angle}° {name}: {distance} < {angle}° + ƒx New User Parameter ƒx Novi korisnički parametar + ΔLOC ΔLOC + −Bin −Bin + −LOC −LOC + ⌘↩ to finish ⌘↩ za završetak +@plural {n} commit {n} commit|{n} commita|{n} commitova +@plural {n} contributor {n} saradnik|{n} saradnika|{n} saradnika + Drawing as bytes Crtež kao bajtovi + Services Usluge + Hide CADCraft Sakrij CADCraft + Hide Others Sakrij ostale + Accessibility Pristupačnost + Show System Cursor Prikaži sistemski kursor + Animation Effects Animacijski efekti + Animation effects Animacijski efekti + Import... Uvezi... + Export... Izvezi... + Batch Publish... Paketno objavljivanje... + Scale List... Lista skala... + Annotative Object Scale Skala objekta napomene + Add Current Scale Dodaj trenutnu skalu + Delete Current Scale Izbriši trenutnu skalu + Add/Delete Scales... Dodaj/izbriši skale... + Synchronize Multiple-scale Positions Sinhronizuj položaje za više skala + Annotative Update Ažuriranje napomena + Show Annotative Objects Prikaži objekte napomena + Current Scale Only Samo trenutna skala + All Scales Sve skale + Drawing Recovery Manager... Upravitelj oporavka crteža... + Tolerance... Tolerancija... + Add Vertex Dodaj tjeme + Remove Vertex Ukloni tjeme + Convert to Arc Pretvori u luk + Convert to Line Pretvori u liniju + Stretch Vertex Razvuci tjeme + Edit Array Uredi niz + Close Array Editing Zatvori uređivanje niza + Multiline... Višestruka linija... + Multiline Style... Stil višestruke linije... + Solid Editing Uređivanje punih tijela + X X + Y Y + B B + CADCraft CADCraft + More toolbar commands Više naredbi trake s alatima +menu View Prikaz +menu Draw Crtaj +menu Dimension Kotiranje +menu Modify Izmijeni + Hatch Pattern Uzorak šrafure + Search for pattern Traži uzorak + Not a number or distance: {text} Nije broj ili udaljenost: {text} + Query Texts Upit o tekstovima + Analyze Shapes Analiziraj oblike + Check for Updates… Provjeri ažuriranja… + CADCraft is up to date. CADCraft je ažuran. + Could not check for updates. Nije moguće provjeriti ažuriranja. + 3D Mouse 3D miš + 3D Mouse Navigation Navigacija 3D mišem + 3D Mouse... 3D miš... + 3D mouse busy, possibly 3DxWare or missing device permissions 3D miš je zauzet, možda zbog 3DxWare ili nedostajućih dozvola za uređaj + 3D mouse connected 3D miš je povezan + 3D mouse disconnected 3D miš je isključen + 3D mouse input could not be started Unos 3D mišem nije moguće pokrenuti + 3D mouse input is unavailable on this platform Unos 3D mišem nije dostupan na ovoj platformi + Automatic save every Automatsko čuvanje svakih + Automatic save file location Lokacija datoteke automatskog čuvanja + Calibrate Kalibriraj + Calibrate 3D Mouse Kalibriraj 3D miš + Collapse Palettes Skupi palete + Default save version Zadana verzija čuvanja + Drawings with no file yet are saved in the default version. 0 minutes turns automatic save off. Crteži koji još nemaju datoteku čuvaju se u zadanoj verziji. 0 minuta isključuje automatsko čuvanje. + Enable 3D mouse navigation Omogući navigaciju 3D mišem + Left device button: zoom extents. Right device button: calibrate. Lijevo dugme uređaja: zumiraj na opseg. Desno dugme uređaja: kalibriraj. + Move sideways to pan; push/pull or twist to zoom. Pomjerite postrance za pomicanje pogleda; gurnite/povucite ili zakrenite za zumiranje. + No supported 3D mouse found Nije pronađen podržani 3D miš + Pan sensitivity Osjetljivost pomicanja pogleda + Release the 3D mouse to calibrate its resting position Pustite 3D miš da kalibrirate njegov položaj mirovanja + Reverse zoom direction Obrni smjer zumiranja + Run Script... Pokreni skriptu... + SVG drawings (SVG, SVGZ) SVG crteži (SVG, SVGZ) + Show and hide the tools of this category Prikaži i sakrij alate ove kategorije + Show in Tool Sets Prikaži u skupovima alata + Time-sensitive right-click: a quick click is Enter, holding opens the menu Desni klik osjetljiv na vrijeme: brzi klik je Enter, držanje otvara meni + Turned off, a right-click while a command runs always opens the shortcut menu. Kad je isključeno, desni klik dok se naredba izvršava uvijek otvara kontekstni meni. + Zoom sensitivity Osjetljivost zumiranja + min min + Align Multileaders Poravnaj višestruke pokazne linije + Collect Prikupi + Collect Multileaders Prikupi višestruke pokazne linije + Edit Multileader Uredi višestruku pokaznu liniju + Italic Kurziv + Underline Podvučeno + Overline Nadvučeno + Justify Poravnaj obostrano + Text color Boja teksta + Click the ruler to add a tab stop, right-click to remove one Kliknite ravnalo da dodate tabulator, desni klik da ga uklonite + Add: Pick points Dodaj: odaberi tačke + Add: Select objects Dodaj: odaberi objekte + Associative Asocijativno + Block to create or edit Blok za kreiranje ili uređivanje + Bottom left Dolje lijevo + Bottom right Dolje desno + Boundaries Granice + Boundaries picked: {n} Odabrane granice: {n} + Centered Centrirano + Clear Recent Files Očisti nedavne datoteke + Click to set new origin Kliknite da postavite novo ishodište + Close Block Editor Zatvori uređivač blokova + Color 1 Boja 1 + Color 2 Boja 2 + contains authoring elements. Open in Block Editor? sadrži elemente za izradu. Otvoriti u uređivaču blokova? + Create separate hatches Kreiraj zasebne šrafure + Crossing selection color: Boja odabira presijecanjem: + Curved Zakrivljeno + Custom Prilagođeno + Default to boundary extents Zadano na opseg granice + Drag Dynamic Grip Prevuci dinamičku hvataljku + Dynamic Block Data Podaci dinamičkog bloka + Dynamic Block Grips Hvataljke dinamičkog bloka + Dynamic Block Reference Referenca dinamičkog bloka + Edit Block Definition Uredi definiciju bloka + Evaluate LISP Izračunaj LISP + Exclude: Isključi: + Grips Hvataljke + Groups Grupe + Hatch and Gradient Šrafura i gradijent + Hatch origin Ishodište šrafure + Hatch Pick Odabir šrafure + Hatches Šrafure + Hemispherical Polusferno + Ignore Zanemari + Indicate selection area Označite područje odabira + Inverted Obrnuto + Island detection Otkrivanje ostrva + Load Application... Učitaj aplikaciju... + Multiline text Višeredni tekst + New block Novi blok + Object grouping Grupisanje objekata + Object selection limit for display of grips Ograničenje odabira objekata za prikaz hvataljki + Objects on locked layers Objekti na zaključanim slojevima + Open in Block Editor Otvori u uređivaču blokova + Open Recent Otvori nedavno + Origin: {x}, {y} Ishodište: {x}, {y} + Outer Vanjsko + Preview Pregled + Save Block Sačuvaj blok + Save Block As Sačuvaj blok kao + Selection Area Effect Efekat područja odabira + Selection area opacity: Neprozirnost područja odabira: + Selection effect color Boja efekta odabira + Selection modes Načini odabira + Selection preview Pregled odabira + Selection Preview Filter Filter pregleda odabira + Set Dynamic Property Postavi dinamičko svojstvo + Shape Oblik + Sheet Books to PDF... Knjige listova u PDF... + Show grips Prikaži hvataljke + Specified origin Navedeno ishodište + Spherical Sferno + Tables Tabele + This drawing Ovaj crtež + Top left Gore lijevo + Top right Gore desno + Unsaved changes Nesačuvane promjene + Use current origin Koristi trenutno ishodište + Visual Effect Settings Postavke vizuelnih efekata + Visual Effect Settings... Postavke vizuelnih efekata... + When a command is active Kad je naredba aktivna + When no command is active Kad nijedna naredba nije aktivna + Window selection color: Boja odabira prozorom: + Xrefs Vanjske reference + Arrow size Veličina strelice + Dim scale overall Ukupna skala kote + Precision Preciznost + Break-line Symbol Simbol linije prekida + Convert Text to Mtext Pretvori tekst u višeredni tekst + Explode Attributes to Text Rastavi atribute u tekst + Express Tools Express alati + Move/Copy/Rotate Pomjeri/kopiraj/rotiraj + Type an alias name. Unesite naziv aliasa. + Choose the command the alias starts. Odaberite naredbu koju alias pokreće. + {command} is an unknown command. {command} je nepoznata naredba. + {alias} is already defined; select it and use Edit. {alias} je već definisan; odaberite ga i koristite Uredi. + More than {n} aliases. Više od {n} aliasa. + Alias file: {file} Datoteka aliasa: {file} + No alias file loaded. REINIT replaces these aliases with a file's. Nije učitana datoteka aliasa. REINIT zamjenjuje ove aliase onima iz datoteke. + Alias Alias + Command Naredba + overrides built-in zamjenjuje ugrađeni + built-in ugrađeni + Add… Dodaj… + Edit… Uredi… + Save alias Sačuvaj alias + Discard Odbaci + Customize Prilagodi + Edit Command Aliases (PGP)... Uredi aliase naredbi (PGP)... + Interface scale Skala interfejsa + Select boundaries to remove Odaberite granice za uklanjanje + Island Ostrvo + Select using two clicks only Odabir samo s dva klika + Define each corner of the selection window with a separate click. Definišite svaki ugao prozora za odabir posebnim klikom. + Apply to Layout Primijeni na raspored + Center the plot Centriraj iscrtavanje + Enter block names to extract Unesite nazive blokova za izdvajanje + Enter geometric characteristic Unesite geometrijsku karakteristiku + Enter name of LISP file to load Unesite naziv LISP datoteke za učitavanje + First corner Prvi ugao + Fit to paper Uklopi na papir + Landscape Položeno + Limits Granice + Opposite corner Suprotni ugao + Orientation Orijentacija + Paper size Veličina papira + Plot area Oblast iscrtavanja + Plot object lineweights Iscrtaj debljine linija objekata + Plot offset Pomak iscrtavanja + Plot transparency Iscrtaj prozirnost + Portrait Uspravno + Printer/plotter Štampač/ploter + Window < Prozor < + X offset (mm) X pomak (mm) + Y offset (mm) Y pomak (mm) + AutoLISP (LSP) AutoLISP (LSP) + Units of new drawings Jedinice novih crteža + Imperial (inches) Imperijalne (inči) + Metric (millimetres) Metričke (milimetri) + New and the first drawing at startup use these units unless a default template is set (QNEWTEMPLATE). Novi i prvi crtež pri pokretanju koriste ove jedinice osim ako je postavljen zadani šablon (QNEWTEMPLATE). + Analyze Usage Analiziraj upotrebu + Implied Loops Implicirane petlje + Angstroms Angstremi + Architectural Arhitektonske + Astronomical Units Astronomske jedinice + Centimeters Centimetri + Decameters Dekametri + Decimal Decimalne + Decimal Degrees Decimalni stepeni + Decimeters Decimetri + Deg/Min/Sec Step/Min/Sek + Don't Save Nemoj sačuvati + Drawing Units Jedinice crteža + Engineering Inženjerske + Feet Stope + Fractional Razlomačke + Gigameters Gigametri + Grads Gradi + Hectometers Hektometri + Inches Inči + Insertion scale Skala umetanja + Kilometers Kilometri + Light Years Svjetlosne godine + Meters Metri + Microinches Mikroinči + Microns Mikroni + Miles Milje + Millimeters Milimetri + Mils Milsi + Nanometers Nanometri + Parsecs Parseci + Radians Radijani + Sample output Primjer izlaza + Save changes to {name}? Sačuvati promjene u {name}? + Scientific Naučne + Surveyor's Units Geodetske jedinice + Unitless Bez jedinica + Units to scale inserted content Jedinice za skaliranje umetnutog sadržaja + US Survey Feet Američke geodetske stope + US Survey Inch Američki geodetski inč + US Survey Mile Američka geodetska milja + US Survey Yard Američki geodetski jard + Yards Jardi + Your changes will be lost if you don't save them. Vaše promjene će biti izgubljene ako ih ne sačuvate. + Save changes to block "{name}"? Sačuvati promjene u bloku „{name}”? + Layouts Rasporedi + Associate Poveži diff --git a/crates/ui-egui/src/i18n/tests.rs b/crates/ui-egui/src/i18n/tests.rs index 0e1e23e19..6bf85f2c3 100644 --- a/crates/ui-egui/src/i18n/tests.rs +++ b/crates/ui-egui/src/i18n/tests.rs @@ -186,6 +186,7 @@ fn assert_additional_locale_aliases() { ("sv", &["sv", "sv-SE", "sv_SE.UTF-8", "SV-se", " sv-SE ", "sv-FI"]), ("hu", &["hu", "hu-HU", "hu_HU.UTF-8", "HU-hu", " hu-HU "]), ("tr", &["tr", "tr-TR", "tr_TR.UTF-8", "TR-tr", " tr-TR ", "tr-CY"]), + ("bs", &["bs", "bs-BA", "bs_BA.UTF-8", "BS-ba", " bs-BA ", "bs-Latn-BA"]), ("el", &["el", "el-GR", "el_GR.UTF-8", "EL-cy"]), ("zh", &["zh", "zh-CN"]), ] { @@ -556,3 +557,12 @@ fn production_font_chain_covers_latin_and_shortcut_symbols() { assert!(view.has_glyph(&egui::FontId::monospace(12.0), '\u{21e7}'), "U+21E7 shift symbol missing in Monospace"); }); } + +/// Bosnian counts: 1, 21 `one`; 2–4, 22–24 (not 12–14) `few`; everything else `other`. +#[test] +fn bosnian_counts_take_one_few_other() { + let forms: Vec = [0, 1, 2, 4, 5, 11, 12, 14, 21, 22, 25, 111].into_iter().map(plural_uk).collect(); + assert_eq!(forms, [2, 0, 1, 1, 2, 2, 2, 2, 0, 1, 2, 2]); + assert_eq!(Preference::parse("bs"), Some(Preference::Bosnian)); + assert_eq!(Preference::Bosnian.native_name(), "Bosanski"); +} diff --git a/crates/ui-egui/src/options.rs b/crates/ui-egui/src/options.rs index 8bf147bcf..4c7cf6b1f 100644 --- a/crates/ui-egui/src/options.rs +++ b/crates/ui-egui/src/options.rs @@ -10,7 +10,7 @@ //! |---|---| //! | `theme` | `"system"`, `"light"` or `"dark"` | //! | `animations` | `"system"`, `"on"` or `"off"`: dialog and menu fades and smoothed scrolling | -//! | `interfaceLanguage` | `"auto"`, `"en"`, `"uk"`, `"pt-BR"`, `"de"`, `"es"`, `"cs"`, `"ru"`, `"fr"`, `"zh"`, `"it"`, `"ko"`, `"sv"`, `"ar"`, `"hu"`, `"tr"` or `"el"` | +//! | `interfaceLanguage` | `"auto"`, `"en"`, `"uk"`, `"pt-BR"`, `"de"`, `"es"`, `"cs"`, `"ru"`, `"fr"`, `"zh"`, `"it"`, `"ko"`, `"sv"`, `"ar"`, `"hu"`, `"tr"`, `"bs"` or `"el"` | //! | `saveFormat` | `"dxf"` or `"dwg"`: the format Save As suggests for new drawings | //! | `saveVersion` | `"2000"` … `"2018"`: the version drawings with no file yet are saved in | //! | `SAVETIME` | minutes between automatic saves, 0–600 (0: off) | diff --git a/docs/localization-parity.md b/docs/localization-parity.md index b4ff05f68..ff44de470 100644 --- a/docs/localization-parity.md +++ b/docs/localization-parity.md @@ -1,6 +1,6 @@ # Localization parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-22 · **Change:** minor (the command line enables the OS IME and handles composition/commit, so single-line TEXT edits accept CJK input; previously: Brazilian Portuguese row updated and terminology reviewed; previously: Swedish catalog completed with the 95 strings added since; previously: Swedish catalog added: complete catalog, menu headings, native-speaker terminology review; previously: complete current Korean catalog with Hangul font coverage) · **Target:** Autodesk AutoCAD 2027 for Mac (26.0) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-30 · **Change:** minor (Bosnian added; previously minor: the command line enables the OS IME and handles composition/commit, so single-line TEXT edits accept CJK input; previously: Brazilian Portuguese row updated and terminology reviewed; previously: Swedish catalog completed with the 95 strings added since; previously: Swedish catalog added: complete catalog, menu headings, native-speaker terminology review; previously: complete current Korean catalog with Hangul font coverage) · **Target:** Autodesk AutoCAD 2027 for Mac (26.0) How far CADCraft's interface and drawing text are from AutoCAD's languages. Summarised in [ROADMAP.md](../ROADMAP.md#languages); work items in [gaps.md](gaps.md#localization). @@ -74,9 +74,10 @@ plus native review by a human; extending the catalog to the remaining English-on | Italian | it | 1,227 catalog rows; reference catalog and marked UI literals covered | dialogs and tooltips yes; contextual menu headings (Visualizza / Vista, Edita / Modifica); command reference searchable in Italian | Latin: yes (bundled egui fonts; accented letters tested) | AI-assisted by Emanuele Bottelli (Claude), written from the English strings with Italian desktop-CAD vocabulary; no native proofreading pass yet | complete current catalog; English-only interface gaps remain | native review + shared English-only UI work | | Hungarian | hu | 1,326 catalog rows; reference catalog, marked UI literals and menu headings covered (no gaps reported) | dialogs and tooltips yes; contextual menu headings; command reference searchable in Hungarian | Latin: yes (bundled egui proportional and monospace fonts; ő ű Ő Ű and the other accented letters tested) | translated by @Skaywalker from the English strings; independent native proofreading pending | complete current catalog; English-only interface gaps remain | native proofreading + shared English-only UI work | | Turkish | tr | 1,330 catalog rows; reference catalog, marked UI literals and menu headings covered (no gaps reported) | dialogs and tooltips yes; contextual menu headings (Ölçülendirme / Ölçü); command reference searchable in Turkish | Latin: yes (bundled egui proportional and monospace fonts; Ç Ğ İ Ö Ş Ü ç ğ ı ö ş ü tested) | AI-assisted by @ogzhnklvz, written from the English strings with Turkish desktop-CAD vocabulary; the running app reviewed by a native speaker | complete current catalog; English-only interface gaps remain | line-by-line proofreading + shared English-only UI work | +| Bosnian | bs | 1,442 catalog rows; reference catalog and marked UI literals covered | dialogs and tooltips yes | Latin: yes (bundled egui fonts) | AI-assisted; independent native proofreading pending | complete current catalog; English-only interface gaps remain | native proofreading + shared English-only UI work | -Other languages shipped: Ukrainian, Brazilian Portuguese, German, Czech, Russian, French, Italian, Korean, Swedish, Hungarian and Turkish. -Czech, Swedish, Hungarian and Brazilian Portuguese cover the reference catalog and every marked UI literal; engine diagnostics and uncatalogued text +Other languages shipped: Ukrainian, Brazilian Portuguese, German, Czech, Russian, French, Italian, Korean, Swedish, Hungarian, Turkish and Bosnian. +Czech, Swedish, Hungarian, Brazilian Portuguese and Bosnian (1,442 rows, AI-assisted, not yet native-reviewed) cover the reference catalog and every marked UI literal; engine diagnostics and uncatalogued text remain English. AutoCAD for Mac ships 7 non-English languages (zh-Hans, es, fr, ja, de, ko, it); of those, CADCraft now ships German and Korean, and additionally Ukrainian, which AutoCAD for Mac doesn't ship. @@ -89,6 +90,7 @@ each language, which needs humans. Translations parallelise fully once the catal | Date | Change | Summary | |---|---|---| +| 2026-10-30 | minor | Bosnian (`bs`, Latin, Ijekavian) added: 1,442 rows, one/few/other plurals, `bs-*` locales; AI-assisted, native proofreading pending | | 2026-10-22 | minor | Command line IME: enabled while a prompt collects text, composition shown but not saved, commit inserted once; single-line TEXT edits accept CJK input (#1761) | | 2026-10-19 | minor | Brazilian Portuguese: row brought up to date (it still read 0%); native-speaker terminology pass on 69 rows (Bind as Integrar, prompt keywords and SPDX kept in English, Thaw Layer, Snap type, Revolve fixed; snap, viewport, grip, offset, layer on/off and multiline wording made consistent with Brazilian usage) | | 2026-10-15 | minor | Greek (`el`) catalog: 1,330 rows, context/plural/locale/font tests; review pending | From 8d1bd19ee29aa3a7f7d8730214fa8d6b90a4e7a6 Mon Sep 17 00:00:00 2001 From: Zinadin Zidan Date: Sat, 31 Oct 2026 01:46:34 +0600 Subject: [PATCH 49/49] Save As suggests the default save format for opened drawings too (#2199) (#2509) * Save As suggests the default save format for opened drawings too (#2199) Options > Open and Save > "Save as" in AutoCAD is the format every drawing is saved in. CADCraft applied File > Default Save Format only to untitled drawings, so Save As on an opened DWG kept DWG with DXF chosen, and the other way round. Save As now swaps a DWG, DXF or DWT extension for the chosen format; other names, and Save of an opened file, are unchanged. Co-Authored-By: Claude Opus 5.5 * Default Save Format's echo says Save As will suggest the format (#2199) "Save As will save drawings as DWG" promised more than Save As does: it only swaps a DWG, DXF or DWT extension in the name it suggests, and the path picked in the dialog decides the format. The echo now reads "Save As will suggest DWG", and default_save_format_applies_to_opened_drawings pins it. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/ui-egui/src/lib.rs | 36 ++++++++++++++++++---------- crates/ui-egui/src/menus.rs | 2 +- crates/ui-egui/tests/save_version.rs | 34 ++++++++++++++++++++++++++ 3 files changed, 59 insertions(+), 13 deletions(-) diff --git a/crates/ui-egui/src/lib.rs b/crates/ui-egui/src/lib.rs index 311dd4cbf..91902017f 100644 --- a/crates/ui-egui/src/lib.rs +++ b/crates/ui-egui/src/lib.rs @@ -118,7 +118,7 @@ pub struct UiState { /// Animation effects (dialog and menu fades, smoothed scrolling): "system" (follow the OS /// setting), "on" or "off". pub animations: animation::AnimationPref, - /// The format Save As suggests for a drawing that has no file yet: "dxf" or "dwg". + /// The format Save As suggests: "dxf" or "dwg", for new drawings and opened files alike. pub save_format: SaveFormat, /// The version Save As writes for a drawing that has no file yet ("2000" … "2018"); a /// drawing opened from a file keeps that file's version. @@ -132,8 +132,8 @@ pub struct UiState { /// A DXF/DWG file version (2000 … 2018). pub use cadcraft_engine::cmd::file::Version as SaveVersion; -/// The default save format for new drawings, like AutoCAD's Options > Open and Save > "Save as". -/// A drawing opened from a file keeps that file's format. +/// The default save format, like AutoCAD's Options > Open and Save > "Save as": the format Save As +/// suggests for every drawing, an opened DWG or DXF too. Save (QSAVE) of an opened file keeps its file. #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)] #[serde(rename_all = "lowercase")] pub enum SaveFormat { @@ -158,13 +158,19 @@ impl SaveFormat { SaveFormat::ALL.into_iter().find(|f| f.as_str().eq_ignore_ascii_case(s.trim().trim_start_matches('.'))) } - /// The name Save As suggests: a title that already has an extension (a drawing opened from a - /// file) keeps it; an untitled drawing gets this format's extension. + /// The name Save As suggests: this format's extension, replacing a drawing's own (DWG, DXF or + /// DWT, from a drawing opened from a file); any other extension is kept. pub fn suggested_name(self, title: Option<&str>) -> String { - match title.map(str::trim).filter(|t| !t.is_empty()) { - Some(t) if std::path::Path::new(t).extension().is_some() => t.to_owned(), - Some(t) => format!("{t}.{}", self.as_str()), - None => format!("Drawing.{}", self.as_str()), + let Some(t) = title.map(str::trim).filter(|t| !t.is_empty()) else { return format!("Drawing.{}", self.as_str()) }; + let path = std::path::Path::new(t); + match path.extension().and_then(|e| e.to_str()) { + Some(e) if ["dwg", "dxf", "dwt"].iter().any(|d| d.eq_ignore_ascii_case(e)) => { + // the extension is ASCII, so this is a char boundary + let stem = t.get(..t.len().saturating_sub(e.len() + 1)).unwrap_or(t); + format!("{stem}.{}", self.as_str()) + } + Some(_) => t.to_owned(), + None => format!("{t}.{}", self.as_str()), } } } @@ -1142,11 +1148,17 @@ mod tests { b.start("ui.saveformat.dwg"); b.start("ui.resetpalettes"); assert_eq!(b.ui.save_format, SaveFormat::Dwg); - // Untitled drawings get the format's extension; files keep their own. + // Untitled drawings get the format's extension, and so do opened drawings (#2199). assert_eq!(SaveFormat::Dwg.suggested_name(Some("Drawing1")), "Drawing1.dwg"); assert_eq!(SaveFormat::Dxf.suggested_name(Some("Drawing1")), "Drawing1.dxf"); - assert_eq!(SaveFormat::Dwg.suggested_name(Some("Floorplan.dxf")), "Floorplan.dxf"); - assert_eq!(SaveFormat::Dxf.suggested_name(Some("Floorplan.DWG")), "Floorplan.DWG"); + assert_eq!(SaveFormat::Dwg.suggested_name(Some("Floorplan.dxf")), "Floorplan.dwg"); + assert_eq!(SaveFormat::Dxf.suggested_name(Some("Floorplan.DWG")), "Floorplan.dxf"); + assert_eq!(SaveFormat::Dxf.suggested_name(Some("Floorplan.dxf")), "Floorplan.dxf"); + assert_eq!(SaveFormat::Dwg.suggested_name(Some("Title block.dwt")), "Title block.dwg"); + assert_eq!(SaveFormat::Dwg.suggested_name(Some("v1.2 plan.Dxf")), "v1.2 plan.dwg"); + assert_eq!(SaveFormat::Dwg.suggested_name(Some("平面図.dxf")), "平面図.dwg"); + assert_eq!(SaveFormat::Dwg.suggested_name(Some(".dxf")), ".dxf.dwg", "a dot file has no extension"); + assert_eq!(SaveFormat::Dxf.suggested_name(Some("logo.svg")), "logo.svg", "other files keep their type"); assert_eq!(SaveFormat::Dwg.suggested_name(None), "Drawing.dwg"); assert_eq!(SaveFormat::Dwg.suggested_name(Some(" ")), "Drawing.dwg"); let ui: UiState = serde_json::from_value(json!({ "saveFormat": "dwg" })).unwrap_or_default(); diff --git a/crates/ui-egui/src/menus.rs b/crates/ui-egui/src/menus.rs index 58055542f..797952edf 100644 --- a/crates/ui-egui/src/menus.rs +++ b/crates/ui-egui/src/menus.rs @@ -520,7 +520,7 @@ fn saveas_params(ui: &crate::UiState, session: &cadcraft_engine::Session, path: fn set_save_format(app: &mut CadApp, format: crate::SaveFormat) -> Value { app.ui.save_format = format; - app.session.echo(format!("New drawings will be saved as {}", format.as_str().to_ascii_uppercase())); + app.session.echo(format!("Save As will suggest {}", format.as_str().to_ascii_uppercase())); json!({ "saveFormat": format.as_str() }) } diff --git a/crates/ui-egui/tests/save_version.rs b/crates/ui-egui/tests/save_version.rs index 47b716b89..402c43623 100644 --- a/crates/ui-egui/tests/save_version.rs +++ b/crates/ui-egui/tests/save_version.rs @@ -44,3 +44,37 @@ fn default_save_version_applies_to_new_drawings_and_persists() { b.start("ui.resetpalettes"); assert_eq!(b.ui.save_version, "2004"); } + +/// The default save format (#2199) is what Save As suggests for an opened DWG or DXF too, as +/// AutoCAD's Options > Open and Save > "Save as" does; Save keeps the opened file. +#[test] +fn default_save_format_applies_to_opened_drawings() { + set_io(IoHooks { read: |_, _| Ok(Drawing::new_metric()), write: |_, _| Ok(b"plain".to_vec()), plot: None }); + set_write_as(with_options); + let dir = std::env::temp_dir().join(format!("cadcraft-ui-save-format-{}", std::process::id())); + std::fs::create_dir_all(&dir).unwrap(); + let suggested = std::sync::Arc::new(std::sync::Mutex::new(Vec::::new())); + let (seen, to) = (suggested.clone(), dir.clone()); + let pick = move |name: &str| { + seen.lock().unwrap().push(name.to_string()); + Some(to.join(name).to_string_lossy().to_string()) + }; + let mut app = CadApp::new(Session::empty(), Services { pick_save: Some(Box::new(pick)), ..Services::default() }); + for (opened, format, expected) in + [("Plan.dwg", "dxf", "Plan.dxf"), ("Plan.DXF", "dwg", "Plan.dwg"), ("Plan.dxf", "dxf", "Plan.dxf"), ("Sheet.dwt", "dwg", "Sheet.dwg")] + { + let file = dir.join(opened); + std::fs::write(&file, b"0\nEOF\n").unwrap(); + app.run("open", json!({ "path": file.to_string_lossy() })).unwrap(); + app.run("ui.saveformat", json!({ "format": format })).unwrap(); + // the picker's path decides the format, so the echo promises only the suggestion + let echo = format!("Save As will suggest {}", format.to_ascii_uppercase()); + assert_eq!(app.session.log.last(), Some(&echo), "{opened} with {format}"); + app.run("ui.saveas", Value::Null).unwrap(); + assert_eq!(suggested.lock().unwrap().last().map(String::as_str), Some(expected), "{opened} with {format}"); + let path = app.session.state().unwrap().path.clone().unwrap_or_default(); + assert!(path.ends_with(expected), "{opened}: saved as {path}"); + assert!(dir.join(expected).exists()); + } + let _ = std::fs::remove_dir_all(&dir); +}