diff --git a/apps/vectorcraft/src/tests.rs b/apps/vectorcraft/src/tests.rs index e81dd7815..6e61cbe31 100644 --- a/apps/vectorcraft/src/tests.rs +++ b/apps/vectorcraft/src/tests.rs @@ -193,7 +193,8 @@ fn the_system_title_bar_preference_keeps_the_window_decorations() { /// Preferences › User Interface › VectorCraft Title Bar on Every Desktop gives the app frame where /// the probe chose the desktop's (KDE, X11, a window opened through XWayland); without it the probe -/// decides, and `VECTORCRAFT_TITLEBAR` takes precedence over both. +/// decides, and `VECTORCRAFT_TITLEBAR` set to `app`, `system` or `desktop` takes precedence over +/// both. #[test] fn the_app_title_bar_preference_gives_the_app_frame_on_desktop_frames() { assert!(!super::opted_into_app_title_bar(None), "no preferences: the default"); diff --git a/apps/vectorcraft/src/titlebar.rs b/apps/vectorcraft/src/titlebar.rs index 17c847040..fc6e39592 100644 --- a/apps/vectorcraft/src/titlebar.rs +++ b/apps/vectorcraft/src/titlebar.rs @@ -42,7 +42,7 @@ pub(crate) const CUSTOM_TITLEBAR: bool = !cfg!(target_os = "macos"); /// Whether the user asked for the system title bar in Preferences › User Interface › System Title /// Bar. Read from the saved preferences before the window opens; a missing or unreadable value is /// `false` (the default). This preference forces the desktop/native frame back on unless -/// `VECTORCRAFT_TITLEBAR` is set ([`system_title_bar_applies`]). +/// `VECTORCRAFT_TITLEBAR` is set to `app`, `system` or `desktop` ([`system_title_bar_applies`]). pub(crate) fn opted_into_system_title_bar(saved: Option<&vectorcraft_ui_egui::UiState>) -> bool { saved.map(|ui| ui.engine_prefs.get("systemTitleBar").and_then(serde_json::Value::as_bool).unwrap_or(false)).unwrap_or(false) } @@ -56,8 +56,8 @@ pub(crate) fn opted_into_app_title_bar(saved: Option<&vectorcraft_ui_egui::UiSta /// Whether the app draws the frame on this start, before the System Title Bar preference is /// applied ([`custom_titlebar_from`]). `probed_app` is the `craft-window` probe's answer and -/// `overridden` its `VECTORCRAFT_TITLEBAR` override. In order: the override decides when it is -/// set; VectorCraft Title Bar on Every Desktop (`opted_into_app`) gives the app frame; a window +/// `overridden` its `VECTORCRAFT_TITLEBAR` override. In order: the override decides when the +/// variable is set to `app`, `system` or `desktop`;VectorCraft Title Bar on Every Desktop (`opted_into_app`) gives the app frame; a window /// that opens through XWayland (`forced_to_x11`) gets the desktop frame; otherwise the probe /// decides. pub(crate) fn app_draws_frame(probed_app: bool, overridden: Option, forced_to_x11: bool, opted_into_app: bool) -> bool { @@ -89,13 +89,14 @@ fn probed_choice() -> &'static craft_window::Choice { /// Whether `VECTORCRAFT_TITLEBAR` chose this window's frame (Linux and the BSDs), so Preferences › /// User Interface › System Title Bar and VectorCraft Title Bar on Every Desktop do not apply while -/// it is set. Always `false` on macOS and Windows. +/// it is set to `app`, `system` or `desktop`. Always `false` on macOS and Windows. pub(crate) fn titlebar_from_env() -> bool { cfg!(not(any(target_os = "macos", target_os = "windows"))) && probed_choice().overridden().is_some() } /// Whether System Title Bar decides this start: `opted_into_system` unless `VECTORCRAFT_TITLEBAR` -/// is set (`from_env`), which chooses the frame for the run it is set in. +/// is set to `app`, `system` or `desktop` (`from_env`), which chooses the frame for the run it is +/// set in. pub(crate) fn system_title_bar_applies(opted_into_system: bool, from_env: bool) -> bool { opted_into_system && !from_env } @@ -107,10 +108,10 @@ pub(crate) fn system_title_bar_applies(opted_into_system: bool, from_env: bool) /// ([`craft_window::Frame::Desktop`]) on macOS, Windows, X11 and any Wayland compositor with /// server-side decorations (KDE, Sway, Hyprland, COSMIC); the app draws it /// ([`craft_window::Frame::App`]) only where the compositor leaves it to the app (GNOME's Mutter), -/// or when `VECTORCRAFT_TITLEBAR` overrides the probe. VectorCraft draws its own title bar exactly +/// or when `VECTORCRAFT_TITLEBAR` set to `app`, `system` or `desktop` overrides the probe. VectorCraft draws its own title bar exactly /// when `craft-window` says the app owns the frame **and** the user has not opted into the system /// title bar; the preference forces the native frame back on unless `VECTORCRAFT_TITLEBAR` is set -/// ([`system_title_bar_applies`]). +/// to one of those values ([`system_title_bar_applies`]). /// /// macOS and Windows keep today's behavior and are decided by [`CUSTOM_TITLEBAR`] rather than the /// probe: `craft-window` returns `Frame::Desktop` for both (the OS always draws a frame), but @@ -132,13 +133,14 @@ pub(crate) fn custom_titlebar_from(_frame: &craft_window::Frame, opted_into_syst /// Whether this start draws its own title bar. Probes the shared `craft-window` crate once (its /// override variable is `VECTORCRAFT_TITLEBAR`) and combines its decision with the saved System -/// Title Bar preference, which does not apply while the variable is set. Call once at startup, +/// Title Bar preference, which does not apply while the variable is set to `app`, `system` or +/// `desktop`. Call once at startup, /// before [`native_options`]. /// /// On Linux, Preferences › Performance › Linux Display Server › X11 opens the window through /// XWayland (below). A GNOME/Wayland probe would say `Frame::App` there, but the window really runs /// on X11, whose window manager draws the frame — so when XWayland is being forced, keep the native -/// frame, the same as a real X11 session. An explicit `VECTORCRAFT_TITLEBAR` override still wins, +/// frame, the same as a real X11 session. A recognized `VECTORCRAFT_TITLEBAR` override still wins, /// and so does VectorCraft Title Bar on Every Desktop ([`app_draws_frame`]). pub(crate) fn custom_titlebar(saved: Option<&vectorcraft_ui_egui::UiState>) -> bool { let choice = probed_choice(); diff --git a/crates/engine/src/cmd/buildcmds/shape_builder.rs b/crates/engine/src/cmd/buildcmds/shape_builder.rs index 5cbcdea97..fea79a0e6 100644 --- a/crates/engine/src/cmd/buildcmds/shape_builder.rs +++ b/crates/engine/src/cmd/buildcmds/shape_builder.rs @@ -1,5 +1,5 @@ use super::{ - Beside, BuilderMap, EngineError, FillRule, Node, NodeId, PathData, Point, Rect, Result, Session, SubPath, Touched, Value, b, bad, check_numbers, + Arc, Beside, BuilderMap, EngineError, FillRule, Node, NodeId, PathData, Point, Rect, Result, Session, Touched, Value, b, bad, check_numbers, f64_or, fill_param, finite, gap_param, ids_json, json, marquee_param, po, points_param, remnant, replace_leaves, replace_with_pieces, root_ids, shape_node, switch_or, }; @@ -41,6 +41,7 @@ pub(super) fn sb_merge(s: &mut Session, p: &Value) -> Result { let gap = gap_param(p); // The map the Shape Builder tool already has, which a click or drag of it is made over. let shared = s.tool.shape_builder_map().filter(|(_, g)| *g == gap); + let prepared = s.tool.shape_builder_merge(); let label = if erase { "Shape Builder Delete" } else { "Shape Builder" }; let (ids, merged, touched, split) = s.edit(label, |d, sel| { let (shapes, leaves) = b::shape_builder_shapes(d, &roots, open_filled_as_closed); @@ -89,16 +90,28 @@ pub(super) fn sb_merge(s: &mut Session, p: &Value) -> Result { touched.add(map.hit(q, Some(tol))); return Ok((ids, None, touched, Some(split))); } - let mut touched = Touched { regions: marquee.map(|(a, b)| map.regions_in_marquee(a, b)).unwrap_or_default(), ..Default::default() }; - touched.extend(&map.builder_hits_along(&pts, piece_tol)); - touched.edges = map.erased_edges(&touched); + let touched = map.merge_touched(&pts, marquee, piece_tol); if touched.is_empty() { return Err(EngineError::Other("Shape Builder: no region under the pointer".into())); } - let cuts: Vec<&SubPath> = touched.edges.iter().filter_map(|&k| map.edges.get(k)?.0.path.subpaths.first()).collect(); + let inputs = b::merge_inputs(&leaves.iter().collect::>(), open_filled_as_closed); + // The tool computed this merge on another thread when it would come out the same. + let ready = prepared.as_ref().filter(|m| { + shared.as_ref().is_some_and(|(s, _)| Arc::ptr_eq(s, &m.map) && std::ptr::eq(s.as_ref(), map)) + && m.gap == gap + && m.touched == touched + && m.inputs == inputs + }); + let computed; + let geometry = match ready { + Some(m) => &m.geometry, + None => { + computed = b::merge_geometry(map, &touched, gap, &inputs); + &computed + } + }; let picked: Vec<&po::Region> = touched.regions.iter().filter_map(|&i| map.regions.get(i).map(|r| &r.0)).collect(); - let faces = po::FaceMerger::with_gap(&map.shapes, gap_param(p)); - let union = if picked.is_empty() { PathData::default() } else { faces.merge(&picked) }; + let union = &geometry.union; // Pick Color From Artwork: the merged shape takes the look of the front-most object under the // drag's first point, else under its last point, else of the front-most object. Color // Swatches: the current fill, with the rest of the look of the front-most object over the @@ -115,7 +128,7 @@ pub(super) fn sb_merge(s: &mut Session, p: &Value) -> Result { // What goes in place of each object the map was made from (none: it stays as it is). let mut outs: Vec>> = vec![]; let mut merged_id = None; - for (i, (sh, leaf)) in map.shapes.iter().zip(&leaves).enumerate() { + for (i, leaf) in leaves.iter().take(map.shapes.len()).enumerate() { let mut out = None; let pieces: Vec = map.lines.iter().enumerate().filter(|(_, (l, _))| l.key == i as u64).map(|(k, _)| k).collect(); if !pieces.is_empty() { @@ -131,41 +144,15 @@ pub(super) fn sb_merge(s: &mut Session, p: &Value) -> Result { } out = Some(kept); } - } else { + } else if let Some(Some(rest)) = geometry.rests.get(i) { // A shape loses the regions deleted or merged, then the edges deleted (each one on - // its outline, shared edges from every shape along them). - let in_union = picked.iter().any(|r| r.sources.contains(&i)); - let mut rest = if in_union { - // What is left of it: its faces not merged or deleted, united. They share their - // edges with the merged faces exactly, where subtracting the merged shape left - // slivers of the outline along them (#569). A sliver goes in only where the - // shape covers it and the merged shape does not take it in. - let kept: Vec<&po::Region> = map - .regions - .iter() - .enumerate() - .filter(|(k, (r, ..))| r.sources.contains(&i) && !touched.regions.contains(k)) - .map(|(_, (r, ..))| r) - .collect(); - if kept.is_empty() { PathData::default() } else { faces.merge_rest(i, &kept, &picked) } + // its outline, shared edges from every shape along them). What is left of its own + // outline keeps its fill rule; united faces fill with non-zero. + out = Some(if rest.path.is_empty() { + vec![] } else { - b::node_outline(leaf).map_or_else(|| sh.path.clone(), |o| o.0) - }; - let fill_closes = open_filled_as_closed && !leaf.appearance.fill_paint().is_none(); - // Edges come back from the planar map within a few hundredths of the outlines they - // follow, whatever else is selected. - let cut_tol = b::outline_snap(&sh.path); - let mut cut = false; - for piece in &cuts { - if let Some(r) = po::cut_out(&rest, piece, fill_closes, cut_tol) { - rest = r; - cut = true; - } - } - if in_union || cut { - // What is left of its own outline keeps its fill rule; united faces fill with non-zero. - out = Some(if rest.is_empty() { vec![] } else { vec![remnant(d, leaf, rest, in_union.then_some(FillRule::NonZero))] }); - } + vec![remnant(d, leaf, rest.path.clone(), rest.united.then_some(FillRule::NonZero))] + }); } // The merged shape goes in place of the object it takes its look from, so it stays in // that object's group (a clip group too). diff --git a/crates/engine/src/cmd/fileio/save.rs b/crates/engine/src/cmd/fileio/save.rs index 015c0bddd..6cc93ede1 100644 --- a/crates/engine/src/cmd/fileio/save.rs +++ b/crates/engine/src/cmd/fileio/save.rs @@ -752,6 +752,8 @@ pub(super) fn encode_ai(cmd: &str, f: &Format, doc: &Document, p: &Value) -> Res /// file becomes the document's own; the live document gets them in [`SaveJob::finish`]). Bad /// options fail here, before anything is encoded. pub fn save_job(s: &mut Session, plan: SavePlan) -> Result { + // A Shape Builder merge still being computed for a click is saved with the document. + s.finish_tool_edit_later()?; // The web build, without a clock, leaves the dates unless given one. let at = if plan.path.is_some() && plan.retargets() { clock_date(s, "modified", plan.modified) } else { None }; job_for_stamped(s, s.doc()?, plan, at) diff --git a/crates/engine/src/cmd/prefscmds.rs b/crates/engine/src/cmd/prefscmds.rs index 60f0f4565..f3cf6416f 100644 --- a/crates/engine/src/cmd/prefscmds.rs +++ b/crates/engine/src/cmd/prefscmds.rs @@ -678,6 +678,12 @@ impl Session { for e in self.prefs.keep_folders(&mut p) { log::warn!("{e}"); } + // The edit the active tool computes on another thread is applied first (the Preferences + // dialog applies its settings here, outside a command). A failure to apply it was the + // edit's own, and the preferences apply all the same. + if self.depth == 0 { + let _ = self.finish_tool_edit_later(); + } let grid_changed = p.gridline_every != self.prefs.gridline_every || p.grid_subdivisions != self.prefs.grid_subdivisions; let history_changed = p.history_states != self.prefs.history_states; let tile_edge_changed = p.pattern_tile_edge_color != self.prefs.pattern_tile_edge_color; diff --git a/crates/engine/src/command_sets.rs b/crates/engine/src/command_sets.rs index 9708d9af3..38ce14cab 100644 --- a/crates/engine/src/command_sets.rs +++ b/crates/engine/src/command_sets.rs @@ -1,4 +1,4 @@ -use super::{NodeId, Value, cmd}; +use super::{NodeId, Value, cmd, find_command}; /// The commands that act on the active artboard (#693), which the app passes as their `artboard`: /// Paste in Place, in Front and in Back paste onto it, Align to Artboard aligns to it, Distribute @@ -78,6 +78,34 @@ pub(crate) fn strip_replay_only(id: &str, p: &mut Value) { } } +/// Queries that apply the edit the active tool is computing before they run, as edits do +/// ([`Session::finish_tool_edit`]): a batch runs edits, Find Objects with `select`, Select All +/// Instances and Lock Guides change the selection, and the proof views, the preferences and added +/// fonts give the documents new revisions (they draw again, and type lays out again). +const WAIT_FOR_TOOL_EDIT: &[&str] = &[ + "command.batch", + "document.find", + "symbol.selectInstances", + "view.guides.lock", + "view.proofSetup", + "view.proofColors", + "view.overprintPreview", + "view.separationsPreview", + "prefs.set", + "prefs.reset", + "text.addFontFiles", +]; + +/// Does command `id`, run on its own, first apply the edit the active tool is computing on +/// another thread and the input held for it ([`Session::finish_tool_edit`])? Every command that +/// can edit, select, save or give a document a new revision does; queries that only read do not +/// (`commands_that_do_not_wait_for_a_tool_edit_change_no_document` in the command sweep checks +/// them). A frontend that adds params from +/// its own state (the active artboard) applies them first itself. +pub fn waits_for_tool_edit(id: &str) -> bool { + find_command(id).is_some_and(|spec| spec.journal || WAIT_FOR_TOOL_EDIT.contains(&id)) +} + /// Journaled commands that write a file and change nothing in the document: with an object of a /// dynamic symbol instance's art selected, they read the instance as queries do /// ([`crate::Session::execute`]). diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index 779d78f41..29c2f638c 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -62,6 +62,19 @@ pub struct Session { /// While Cmd lends `tool` (a selection tool) for a drag: the tool it was lent to, which comes /// back as it was at the release ([`Session::pointer`]). pub(crate) lender: Option>, + /// Pointer and key input that came while the tool computed an edit on another thread, each with + /// its number and view, made in order once the edit is applied. + held_input: std::collections::VecDeque<(u64, tooling::HeldInput, ViewInfo)>, + /// The number the next pointer or key event handed to the session gets. + input_count: u64, + /// The number of the event whose handling started the edit the tool is computing. + edit_started_by: Option, + /// Set while the tool's edit and the input held for it are applied: the commands that run then + /// do not start applying them again. + settling_tool_edit: bool, + /// Requests for the UI from making held input where nothing could take them (a command, a tool + /// switch), which the next [`Session::tool_poll`] returns. + held_ui: Vec, /// The active document (its uid) and its [`History::step`] when the tool last handled a pointer /// event or drew its overlays: when they differ at the next one, the tool is told first /// ([`vectorcraft_tools::Tool::history_moved`]). None until the first. @@ -312,7 +325,7 @@ mod session; pub(crate) use command_sets::SELECTS_GIVEN_IDS; #[cfg(test)] use command_sets::given_ids; -pub use command_sets::{FIT_ACTIVE_ARTBOARD, ON_ACTIVE_ARTBOARD}; +pub use command_sets::{FIT_ACTIVE_ARTBOARD, ON_ACTIVE_ARTBOARD, waits_for_tool_edit}; pub use doc_state::{DocState, OpenRows, RecalledSelection}; pub use error::{EngineError, Result}; pub use history::{History, HistoryEntry, NamedStep, default_history_budget}; diff --git a/crates/engine/src/prefs.rs b/crates/engine/src/prefs.rs index e1346b457..d3b034526 100644 --- a/crates/engine/src/prefs.rs +++ b/crates/engine/src/prefs.rs @@ -176,7 +176,7 @@ pub struct Prefs { pub system_title_bar: bool, /// Linux and the BSDs: draw the app bar as the title bar in sessions where the desktop draws /// the frame (X11, Wayland compositors with server-side decorations, XWayland), as on GNOME. - /// Read when the app starts; System Title Bar and `VECTORCRAFT_TITLEBAR` take precedence over it. + /// Read when the app starts; System Title Bar and `VECTORCRAFT_TITLEBAR` set to `app`, `system` or `desktop` take precedence over it. pub app_title_bar: bool, // Performance pub gpu_performance: bool, diff --git a/crates/engine/src/session.rs b/crates/engine/src/session.rs index 27976ff51..2c59c5630 100644 --- a/crates/engine/src/session.rs +++ b/crates/engine/src/session.rs @@ -1,4 +1,4 @@ -use super::command_sets::{JOURNALED_READS, SELECTS_GIVEN_IDS, given_ids, strip_replay_only}; +use super::command_sets::{JOURNALED_READS, SELECTS_GIVEN_IDS, given_ids, strip_replay_only, waits_for_tool_edit}; use super::doc_state::DocState; use super::error::{EngineError, Result}; use super::history::NamedStep; diff --git a/crates/engine/src/session/documents.rs b/crates/engine/src/session/documents.rs index bde2a7d24..24fd02e99 100644 --- a/crates/engine/src/session/documents.rs +++ b/crates/engine/src/session/documents.rs @@ -46,6 +46,11 @@ impl Session { journal: Journal::default(), tool: vectorcraft_tools::create("selection"), lender: None, + held_input: Default::default(), + input_count: 0, + edit_started_by: None, + settling_tool_edit: false, + held_ui: vec![], tool_step: None, selection_at_lend: None, lent_selection: None, @@ -161,6 +166,9 @@ impl Session { } self.press_type_selection = None; let view = self.last_view; + // The edit the tool computes on another thread and the input held for it belong to the + // document being left. The switch goes on whatever they did, as for the deactivation. + let _ = self.finish_tool_edit_later(); // The switch goes on whatever the lent tool's last actions did, as for the deactivation. let _ = self.give_back_tool(view); let acts = self.with_tool_cx(view, |t, cx| t.deactivate(cx)); diff --git a/crates/engine/src/session/edit.rs b/crates/engine/src/session/edit.rs index 7fcbdc912..7c72da22d 100644 --- a/crates/engine/src/session/edit.rs +++ b/crates/engine/src/session/edit.rs @@ -230,6 +230,11 @@ impl Session { if label != "Typing" && cmd::typing_in_progress(self) { cmd::settle_interaction(self)?; } + // An edit the tool computes on another thread (a Shape Builder merge) is applied first too, + // so the snapshot the interaction previews from and goes back to holds it. + if !self.in_interaction() { + self.finish_tool_edit_later()?; + } self.clear_deferred_overlay_cache(); let paint = self.paint.clone(); let st = self.doc_mut()?; diff --git a/crates/engine/src/session/execute.rs b/crates/engine/src/session/execute.rs index 0f23fe4cc..1a60c2101 100644 --- a/crates/engine/src/session/execute.rs +++ b/crates/engine/src/session/execute.rs @@ -1,6 +1,6 @@ use super::{ CommandSpec, EngineError, JOURNALED_READS, NodeId, Result, SELECTS_GIVEN_IDS, Selection, Session, Value, cmd, find_command, given_ids, guard, - strip_replay_only, + strip_replay_only, waits_for_tool_edit, }; impl Session { @@ -39,6 +39,12 @@ impl Session { /// Execute a command by id. This is THE entry point for every frontend. pub fn execute(&mut self, id: &str, params: &Value) -> Result { let spec = find_command(id).ok_or_else(|| cmd::params::unknown_command(id))?; + // An edit the active tool is computing on another thread (a Shape Builder merge) is + // applied before a command that may edit, select, save or give a document a new revision, + // as the click came first. Queries that only read do not wait for it. + if self.depth == 0 && waits_for_tool_edit(id) { + self.finish_tool_edit_later()?; + } let outer = std::mem::replace(&mut self.reading, !spec.journal || JOURNALED_READS.contains(&id)); let r = self.execute_spec(spec, id, params); self.reading = outer; diff --git a/crates/engine/src/session/undo.rs b/crates/engine/src/session/undo.rs index 831f550be..58fd90579 100644 --- a/crates/engine/src/session/undo.rs +++ b/crates/engine/src/session/undo.rs @@ -207,6 +207,10 @@ impl Session { /// [`Session::end_undo_scope`]: open an undo group there or, when one is open already, join it, /// so that the edits are part of its step. `None` without a document. pub fn begin_undo_scope(&mut self) -> Option { + // An edit the tool computes on another thread is a step before the scope, so the scope's + // snapshot holds it. A failure to apply it was the edit's own, and the scope begins all the + // same. + let _ = self.finish_tool_edit_later(); let journal = self.journal.len(); let st = self.active()?; let uid = st.uid; diff --git a/crates/engine/src/tests/build.rs b/crates/engine/src/tests/build.rs index 60a9bac8e..467dd4052 100644 --- a/crates/engine/src/tests/build.rs +++ b/crates/engine/src/tests/build.rs @@ -607,6 +607,486 @@ fn shape_builder_merge_uses_the_map_the_tool_has() { assert_eq!(maps_built(), built + 1, "another gap"); } +/// 40 squares 20 pt wide in a row, each 10 pt right of the one before (160 segments, which the +/// Shape Builder merges on another thread), all selected. +fn square_row(s: &mut Session) -> Vec { + let ids: Vec = (0..40).map(|k| rect(s, f64::from(k) * 10.0, 0.0, 20.0, 20.0)).collect(); + s.execute("select.set", &json!({"ids": ids.iter().map(|i| i.0).collect::>()})).unwrap(); + ids +} + +/// The active document of `s` without its dates, so documents made in two sessions at different +/// times compare equal when their art is. +fn undated(s: &Session) -> vectorcraft_doc::Document { + let mut d = (*s.doc().unwrap().doc).clone(); + (d.metadata.created, d.metadata.modified) = (None, None); + d +} + +/// The Shape Builder over [`square_row`], its map built, after a click at (15, 10): the merge is +/// being computed on another thread, and the document is as it was. +fn click_row(s: &mut Session, v: ViewInfo) { + s.select_tool("shapeBuilder", v).unwrap(); + s.pointer(&PointerEvent::new(PointerKind::Move, 15.0, 10.0), v).unwrap(); + s.tool_poll(v, true).unwrap(); + let revision = s.doc().unwrap().revision; + s.pointer(&PointerEvent::new(PointerKind::Down, 15.0, 10.0), v).unwrap(); + s.pointer(&PointerEvent::new(PointerKind::Up, 15.0, 10.0), v).unwrap(); + assert!(s.tool_editing() && s.tool_waiting()); + assert_eq!(s.doc().unwrap().revision, revision, "the release returns before the merge is applied"); +} + +/// A click of the Shape Builder on a large selection merges on another thread, and the merge the +/// next poll applies is the command's own, as one undo step. +#[test] +fn shape_builder_merges_a_large_selection_on_another_thread() { + use vectorcraft_tools::builder::merges_computed; + let v = ViewInfo::default(); + let mut s = session(); + square_row(&mut s); + click_row(&mut s, v); + let computed = merges_computed(); + s.tool_poll(v, true).unwrap(); + assert!(!s.tool_editing()); + assert_eq!(merges_computed(), computed, "the command takes the merge computed on another thread"); + assert_eq!(s.journal.last().unwrap().0, "shapeBuilder.merge"); + assert_eq!(layer_children(&s), 41, "the overlap and what is left of the two squares over it"); + let mut direct = session(); + square_row(&mut direct); + direct.execute("shapeBuilder.merge", &json!({"points": [[15, 10]]})).unwrap(); + assert!(undated(&s) == undated(&direct), "the same document as the command gives"); + s.execute("edit.undo", &json!({})).unwrap(); + assert_eq!(layer_children(&s), 40, "one undo step"); +} + +/// What comes after a click whose merge is being computed on another thread waits for the merge +/// and runs on the merged art, as when the merge ran on the calling thread: a command (an edit, +/// an undo, a selection, a save, a batch, Lock Guides, the proof views, a preference, Add Font +/// Files), an option change, another tool, a save made outside a command, preferences applied +/// outside a command, a dialog's preview, a scrubbed field's undo scope, a Cmd-click or Cmd-drag +/// with the selection tool. The merge is the one computed on the other thread. +#[test] +fn shape_builder_applies_a_merge_before_what_comes_next() { + use vectorcraft_tools::builder::merges_computed; + type Next = (&'static str, fn(&mut Session, &[NodeId], &std::path::Path)); + let v = ViewInfo::default(); + let next: Vec = vec![ + ("Select All Instances", |s, _, _| { + s.execute("symbol.selectInstances", &json!({"name": "S"})).unwrap(); + assert_eq!(s.doc().unwrap().selection.objects.len(), 1); + }), + ("an edit", |s, _, _| { + s.execute("object.move", &json!({"dx": 0, "dy": 100})).unwrap(); + }), + ("an undo", |s, _, _| { + s.execute("edit.undo", &json!({})).unwrap(); + assert_eq!(layer_children(s), 40, "the undo takes the merge back"); + s.execute("edit.redo", &json!({})).unwrap(); + }), + ("another selection", |s, _, _| { + s.execute("select.inverse", &json!({})).unwrap(); + }), + ("Select All", |s, _, _| { + s.execute("select.all", &json!({})).unwrap(); + assert_eq!(s.doc().unwrap().selection.objects.len(), 41); + }), + ("a save", |s, _, dir| { + s.execute("file.saveAs", &json!({"path": dir.join("a.vectorcraft").to_string_lossy()})).unwrap(); + assert!(!s.doc().unwrap().is_dirty(), "the file holds the merge"); + }), + ("a save outside a command", |s, _, dir| { + let p = json!({"path": dir.join("b.vectorcraft").to_string_lossy()}); + let plan = cmd::fileio::save_plan(s, cmd::fileio::SaveMode::SaveAs, &p).unwrap(); + assert_eq!(layer_children(s), 40, "planning a save leaves the document"); + let job = cmd::fileio::save_job(s, plan).unwrap(); + assert_eq!(layer_children(s), 41, "the snapshot is taken after the merge"); + drop(job); + }), + ("a batch", |s, _, _| { + s.execute("command.batch", &json!({"commands": [{"command": "object.move", "params": {"dx": 0, "dy": 50}}]})).unwrap(); + }), + ("an option change", |s, _, _| { + s.set_tool_option_cmd(&json!({"key": "gapDetection", "value": true})).unwrap(); + }), + ("another tool", |s, _, _| { + s.select_tool("selection", ViewInfo::default()).unwrap(); + }), + ("a closed document", |s, _, _| { + s.execute("file.close", &json!({})).unwrap(); + }), + ("Lock Guides", |s, _, _| { + s.execute("view.guides.lock", &json!({"locked": true})).unwrap(); + }), + ("an option set from a panel", |s, _, _| { + s.set_tool_option("gapDetection", &json!(true)); + }), + ("a dialog's preview, canceled", |s, _, _| { + s.begin_interaction("Move").unwrap(); + s.preview("object.move", &json!({"dx": 7, "dy": 0})).unwrap(); + s.preview("object.move", &json!({"dx": 9, "dy": 0})).unwrap(); + s.cancel_interaction().unwrap(); + assert_eq!(layer_children(s), 41, "canceling the preview keeps the merge"); + }), + ("a dialog's preview, kept", |s, _, _| { + s.begin_interaction("Move").unwrap(); + s.preview("object.move", &json!({"dx": 7, "dy": 0})).unwrap(); + s.commit_interaction().unwrap(); + let labels: Vec<&str> = s.doc().unwrap().history.undo.iter().rev().take(2).map(|e| e.label.as_str()).collect(); + assert_eq!(labels, ["Move", "Shape Builder"]); + }), + ("a scrubbed field, canceled", |s, _, _| { + let scope = s.begin_undo_scope().unwrap(); + s.execute("object.move", &json!({"dx": 5, "dy": 0})).unwrap(); + s.end_undo_scope(scope, true); + assert_eq!( + s.doc().unwrap().history.undo.last().map(|e| e.label.as_str()), + Some("Shape Builder"), + "the scrub's step is undone, not the merge" + ); + }), + ("a held click, then another tool", |s, _, _| { + let v = ViewInfo::default(); + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, 55.0, 10.0), v).unwrap(); + } + assert!(s.tool_editing(), "the click is held"); + s.select_tool("selection", v).unwrap(); + let labels: Vec<&str> = s.doc().unwrap().history.undo.iter().rev().take(2).map(|e| e.label.as_str()).collect(); + assert_eq!(labels, ["Shape Builder", "Shape Builder"], "the held click merges with the Shape Builder first"); + }), + ("a held click, then another document", |s, _, _| { + let v = ViewInfo::default(); + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, 55.0, 10.0), v).unwrap(); + } + let first = s.active_index().unwrap(); + s.add_document(vectorcraft_doc::Document::new(100.0, 100.0), None); + assert!(!s.tool_editing()); + let labels: Vec<&str> = s.documents()[first].history.undo.iter().rev().take(2).map(|e| e.label.as_str()).collect(); + assert_eq!(labels, ["Shape Builder", "Shape Builder"], "the held click merges in its own document first"); + s.set_active(first); + }), + ("a Cmd-click", |s, _, _| { + let v = ViewInfo::default(); + let cmd = Mods { cmd: true, ..Default::default() }; + assert_eq!(s.cursor(Point::new(500.0, 300.0), cmd, v), vectorcraft_tools::Cursor::Busy, "Cmd shows the merge is computed"); + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, 500.0, 300.0).with_mods(cmd), v).unwrap(); + } + assert!(s.tool_editing(), "the click is held"); + while s.tool_waiting() { + s.tool_poll(v, true).unwrap(); + } + assert!(s.doc().unwrap().selection.is_empty(), "the lent selection tool deselects after the merge"); + assert_eq!(s.tool_id(), "shapeBuilder"); + }), + ("a Cmd-drag", |s, _, _| { + let v = ViewInfo::default(); + let cmd = Mods { cmd: true, ..Default::default() }; + for (kind, y) in [(PointerKind::Down, 10.0), (PointerKind::Drag, 60.0), (PointerKind::Drag, 110.0), (PointerKind::Up, 110.0)] { + s.pointer(&PointerEvent::new(kind, 305.0, y).with_mods(cmd), v).unwrap(); + } + assert!(s.tool_editing(), "the drag is held"); + while s.tool_waiting() { + s.tool_poll(v, true).unwrap(); + } + let labels: Vec<&str> = s.doc().unwrap().history.undo.iter().rev().take(2).map(|e| e.label.as_str()).collect(); + assert_eq!(labels, ["Move", "Shape Builder"]); + }), + // The proof views redraw every document (a new revision); they are left off, as the + // other tests of the process-wide proof view expect. + ("Separations Preview", |s, _, _| { + s.execute("view.separationsPreview", &json!({"on": false})).unwrap(); + }), + ("Overprint Preview", |s, _, _| { + s.execute("view.overprintPreview", &json!({"on": false})).unwrap(); + }), + ("Proof Colors", |s, _, _| { + s.execute("view.proofColors", &json!({"on": false})).unwrap(); + }), + ("Proof Setup", |s, _, _| { + s.execute("view.proofSetup", &json!({})).unwrap(); + }), + ("a preference", |s, _, _| { + let every = s.prefs.gridline_every; + s.execute("prefs.set", &json!({"key": "gridlineEvery", "value": every + 10.0})).unwrap(); + }), + ("Reset Preferences", |s, _, _| { + s.execute("prefs.reset", &json!({})).unwrap(); + }), + ("preferences applied outside a command", |s, _, _| { + let mut p = s.prefs.clone(); + p.gridline_every += 10.0; + s.apply_prefs(p); + }), + ("Add Font Files", |s, _, _| { + // No files: the command fails after the merge. + assert!(s.execute("text.addFontFiles", &json!({"files": []})).is_err()); + }), + ]; + let _proof = crate::tests_colormgmt::GLOBAL.lock().unwrap_or_else(std::sync::PoisonError::into_inner); + let dir = vectorcraft_testkit::temp_dir("shape-builder-merge-first"); + for (what, then) in next { + let mut s = session(); + if what == "Select All Instances" { + let far = rect(&mut s, 500.0, 500.0, 20.0, 20.0); + s.execute("symbol.new", &json!({"name": "S", "ids": [far.0]})).unwrap(); + } + let ids = square_row(&mut s); + click_row(&mut s, v); + let computed = merges_computed(); + let journal = s.journal.len(); + then(&mut s, &ids, &dir); + assert!(!s.tool_editing(), "{what}"); + assert_eq!(merges_computed(), computed, "{what}: the merge computed on another thread"); + assert_eq!(s.journal.since(journal).first().map(|j| j.0.as_str()), Some("shapeBuilder.merge"), "{what}: the merge comes first"); + if what != "a closed document" { + assert!(layer_children(&s) >= 41, "{what}: the merge stays"); + } + } +} + +/// Gestures and arrow keys that come while a merge is computed on another thread are held and +/// made after it, in order: the document is the one they make one after the other, and the +/// events count as made once they are and the merge they start is applied. +#[test] +fn shape_builder_holds_gestures_made_during_a_merge() { + type Gesture = fn(&mut Session, ViewInfo); + let cases: [(&str, bool, Gesture); 6] = [ + ("a second click", false, |s, v| { + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, 55.0, 10.0), v).unwrap(); + } + }), + ("a drag", false, |s, v| { + for (kind, x) in [(PointerKind::Down, 75.0), (PointerKind::Drag, 85.0), (PointerKind::Drag, 95.0), (PointerKind::Up, 95.0)] { + s.pointer(&PointerEvent::new(kind, x, 10.0), v).unwrap(); + } + }), + ("two clicks", false, |s, v| { + for x in [55.0, 135.0] { + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, x, 10.0), v).unwrap(); + } + } + }), + ("a Cmd-click", false, |s, v| { + let cmd = Mods { cmd: true, ..Default::default() }; + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, 500.0, 300.0).with_mods(cmd), v).unwrap(); + } + }), + ("a Cmd-drag and a click", false, |s, v| { + let cmd = Mods { cmd: true, ..Default::default() }; + for (kind, y) in [(PointerKind::Down, 10.0), (PointerKind::Drag, 110.0), (PointerKind::Up, 110.0)] { + s.pointer(&PointerEvent::new(kind, 305.0, y).with_mods(cmd), v).unwrap(); + } + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, 55.0, 10.0), v).unwrap(); + } + }), + ("an arrow key", true, |s, v| { + s.tool_key(ToolKey::Right, Mods::default(), v).unwrap(); + }), + ]; + let v = ViewInfo::default(); + let start = |swatches: bool| { + let mut s = session(); + if swatches { + s.select_tool("shapeBuilder", v).unwrap(); + s.set_tool_option_cmd(&json!({"key": "pickColorFrom", "value": "swatches"})).unwrap(); + } + square_row(&mut s); + click_row(&mut s, v); + s + }; + for (what, swatches, send) in cases { + // One after the other: the merge applied before the gesture, and each merge after its own. + let mut one = start(swatches); + while one.tool_waiting() { + one.tool_poll(v, true).unwrap(); + } + send(&mut one, v); + while one.tool_waiting() { + one.tool_poll(v, true).unwrap(); + } + // While the merge is computed. + let mut s = start(swatches); + let revision = s.doc().unwrap().revision; + let from = s.input_count(); + send(&mut s, v); + let to = s.input_count(); + assert!(s.tool_editing() && !s.input_applied(from, to), "{what}: held"); + assert_eq!(s.doc().unwrap().revision, revision, "{what}: nothing made before the merge"); + while s.tool_waiting() { + s.tool_poll(v, true).unwrap(); + } + assert!(!s.tool_editing() && s.input_applied(from, to), "{what}"); + assert!(undated(&s) == undated(&one), "{what}: the document the gestures make one after the other"); + assert_eq!(s.doc().unwrap().selection, one.doc().unwrap().selection, "{what}"); + assert_eq!(s.paint.fill, one.paint.fill, "{what}"); + let labels = |s: &Session| s.doc().unwrap().history.undo.iter().map(|e| e.label.clone()).collect::>(); + assert_eq!(labels(&s), labels(&one), "{what}"); + // The click's merge alone. + let mut merged = start(swatches); + while merged.tool_waiting() { + merged.tool_poll(v, true).unwrap(); + } + let changed = labels(&s).len() > labels(&merged).len() + || s.paint.fill != merged.paint.fill + || s.doc().unwrap().selection != merged.doc().unwrap().selection; + assert!(changed, "{what}: the gesture did something"); + } +} + +/// A press held while a merge is computed on another thread, then dropped (a long touch, a +/// canceled touch, a second finger), is never made: once the merge is applied, the tool is at +/// rest and the document is the one the same input makes, dropped the same way, after the merge. +/// A held click before the press is still made, and so is a perspective plane key held after it. +#[test] +fn shape_builder_drops_a_press_held_during_a_merge() { + use vectorcraft_tools::distort::perspective::{PerspectiveGrid, Plane}; + type Gesture = fn(&mut Session, ViewInfo); + fn press(s: &mut Session, v: ViewInfo, x: f64, mods: Mods) { + s.pointer(&PointerEvent::new(PointerKind::Down, x, 10.0).with_mods(mods), v).unwrap(); + } + fn click(s: &mut Session, v: ViewInfo) { + for kind in [PointerKind::Down, PointerKind::Up] { + s.pointer(&PointerEvent::new(kind, 55.0, 10.0), v).unwrap(); + } + } + // What a case sends, and whether the perspective grid is shown. + let cases: [(&str, bool, Gesture); 7] = [ + ("a press", false, |s, v| press(s, v, 75.0, Mods::default())), + ("a drag", false, |s, v| { + press(s, v, 75.0, Mods::default()); + s.pointer(&PointerEvent::new(PointerKind::Drag, 95.0, 10.0), v).unwrap(); + }), + ("a Cmd-press", false, |s, v| press(s, v, 305.0, Mods { cmd: true, ..Default::default() })), + ("a press and a key", false, |s, v| { + press(s, v, 75.0, Mods::default()); + s.tool_key(ToolKey::Escape, Mods::default(), v).unwrap(); + }), + ("a press and an arrow key", false, |s, v| { + press(s, v, 75.0, Mods::default()); + s.tool_key(ToolKey::Right, Mods::default(), v).unwrap(); + }), + ("a press and a plane key", true, |s, v| { + press(s, v, 75.0, Mods::default()); + s.tool_key(ToolKey::Digit(3), Mods::default(), v).unwrap(); + }), + ("a click, then a press", false, |s, v| { + click(s, v); + press(s, v, 135.0, Mods::default()); + }), + ]; + let v = ViewInfo::default(); + let start = |grid: bool| { + let mut s = session(); + s.select_tool("shapeBuilder", v).unwrap(); + s.set_tool_option_cmd(&json!({"key": "pickColorFrom", "value": "swatches"})).unwrap(); + if grid { + s.execute("perspective.grid.preset", &json!({"kind": 2})).unwrap(); + } + square_row(&mut s); + click_row(&mut s, v); + s + }; + // A tool left in the middle of a gesture keeps waiting: the polls stop after a few. + let settle = |s: &mut Session| { + for _ in 0..8 { + if !s.tool_waiting() { + return; + } + s.tool_poll(v, true).unwrap(); + } + }; + let labels = |s: &Session| s.doc().unwrap().history.undo.iter().map(|e| e.label.clone()).collect::>(); + let plane = |s: &Session| PerspectiveGrid::from_doc(&s.doc().unwrap().doc).unwrap().plane; + for (what, grid, send) in cases { + // The same input after the merge, dropped the same way. + let mut one = start(grid); + settle(&mut one); + send(&mut one, v); + one.drop_tool_press(v).unwrap(); + settle(&mut one); + let mut s = start(grid); + if grid { + assert_ne!(plane(&s), Plane::Right, "{what}: the plane before the key"); + } + let from = s.input_count(); + send(&mut s, v); + let to = s.input_count(); + assert!(s.tool_editing() && !s.input_applied(from, to), "{what}: held"); + s.drop_tool_press(v).unwrap(); + settle(&mut s); + assert!(!s.tool_waiting() && !s.tool_editing() && s.input_applied(from, to), "{what}"); + assert!(!s.tool_busy(), "{what}: the tool is at rest"); + assert_eq!(s.tool_id(), "shapeBuilder", "{what}: no tool is lent"); + assert!(undated(&s) == undated(&one), "{what}: the document the input makes after the merge"); + assert_eq!(labels(&s), labels(&one), "{what}"); + assert_eq!(s.doc().unwrap().selection, one.doc().unwrap().selection, "{what}"); + assert_eq!(s.paint.fill, one.paint.fill, "{what}"); + if grid { + assert_eq!(plane(&one), Plane::Right, "{what}: the plane key is made after the merge"); + assert_eq!(plane(&s), Plane::Right, "{what}: the plane key is made"); + } + } +} + +/// A new revision of the document made outside a command while a merge is computed on another +/// thread keeps the merge when the selected art is as it was (the next poll applies it, as the +/// command computes it), and drops it when the art changed. +#[test] +fn shape_builder_keeps_a_merge_over_a_new_revision_of_the_same_art() { + use vectorcraft_tools::builder::merges_computed; + let v = ViewInfo::default(); + let mut s = session(); + square_row(&mut s); + click_row(&mut s, v); + let computed = merges_computed(); + s.active_mut().unwrap().revision += 1; + s.tool_poll(v, true).unwrap(); + assert!(!s.tool_editing()); + assert_eq!(merges_computed(), computed, "the merge computed on another thread"); + assert_eq!(s.journal.last().unwrap().0, "shapeBuilder.merge"); + let mut direct = session(); + square_row(&mut direct); + direct.execute("shapeBuilder.merge", &json!({"points": [[15, 10]]})).unwrap(); + assert!(undated(&s) == undated(&direct), "the same document as the command gives"); + // The art changed: the merge is dropped. + let mut s = session(); + let ids = square_row(&mut s); + click_row(&mut s, v); + let journal = s.journal.len(); + let st = s.active_mut().unwrap(); + Arc::make_mut(&mut st.doc).node_mut(ids[1]).unwrap().transform(Affine::translate((0.0, 50.0)), false); + st.revision += 1; + s.tool_poll(v, true).unwrap(); + assert!(!s.tool_editing()); + assert_eq!(s.journal.len(), journal, "nothing merged"); + assert_eq!(layer_children(&s), 40); +} + +/// A merge computed for the tool Cmd lent the selection tool's drag away from is applied before +/// a command too. +#[test] +fn shape_builder_merge_of_the_lending_tool_comes_first() { + let v = ViewInfo::default(); + let mut s = session(); + square_row(&mut s); + click_row(&mut s, v); + let lent = s.make_tool("selection"); + s.lender = Some(std::mem::replace(&mut s.tool, lent)); + assert!(s.tool_editing()); + let journal = s.journal.len(); + s.execute("object.move", &json!({"dx": 0, "dy": 100})).unwrap(); + assert!(!s.tool_editing()); + assert_eq!(s.journal.since(journal).first().map(|j| j.0.as_str()), Some("shapeBuilder.merge")); + assert_eq!(s.tool_id(), "selection", "the lent tool stays active until the release"); + assert_eq!(s.lender.as_ref().map(|t| t.id()), Some("shapeBuilder")); +} + #[test] fn shape_builder_tool_merges_the_narrow_shape_it_highlights_in_a_wide_selection() { let mut s = session(); diff --git a/crates/engine/src/tooling.rs b/crates/engine/src/tooling.rs index 405940842..d8b32eab7 100644 --- a/crates/engine/src/tooling.rs +++ b/crates/engine/src/tooling.rs @@ -83,6 +83,23 @@ pub enum UiRequest { /// Place a file with these `file.place` params: a click or drag of the place cursor, when /// [`Session::place_cursor_requests`] is set. Place(Value), + /// A press held while the tool computed an edit on another thread was made now, at `pos` in the + /// document with [`crate::DocState::uid`] `doc`, with tool `tool` active (the selection tool Cmd + /// lent): the frontend does what it does after a press it hands over itself. + HeldPress { + doc: Option, + pos: Point, + tool: &'static str, + }, +} + +/// Pointer or key input that came while the active tool computed an edit on another thread +/// ([`Tool::editing`]), made in order once the edit is applied ([`Session::tool_poll`], +/// [`Session::finish_tool_edit`]). +#[derive(Clone, Copy, Debug)] +pub(crate) enum HeldInput { + Pointer(PointerEvent), + Key(ToolKey, Mods), } impl Session { @@ -106,6 +123,7 @@ impl Session { /// Choose a tool (the toolbar, its shortcut, MCP), finishing any pending tool work first. pub fn select_tool(&mut self, id: &str, view: ViewInfo) -> Result<()> { + self.finish_tool_edit_later()?; // Choosing a perspective tool shows the document's perspective grid; Hide Grid hides it // again, the tool staying chosen. if matches!(id, "perspectiveGrid" | "perspectiveSelection") @@ -129,6 +147,8 @@ impl Session { /// Switch to tool `id` without choosing it afresh (back from a temporary tool: a hidden /// perspective grid stays hidden), finishing any pending tool work first. pub fn switch_tool(&mut self, id: &str, view: ViewInfo) -> Result<()> { + // The edit the tool computes on another thread and the input held for it come first. + self.finish_tool_edit_later()?; self.give_back_tool(view)?; if self.tool.id() == id { return Ok(()); @@ -430,8 +450,85 @@ impl Session { self.tool_step = now; } - /// Feed a pointer event to the active tool. Returns requests for the UI. + /// Feed a pointer event to the active tool. Returns requests for the UI. While the tool computes + /// an edit on another thread, a press and what follows it are held and made once the edit is + /// applied, in order ([`Session::tool_poll`]); moves of the pointer with no button held go to + /// the tool at once. pub fn pointer(&mut self, ev: &PointerEvent, view: ViewInfo) -> Result> { + let n = self.next_input(); + if ev.kind != PointerKind::Move && (!self.held_input.is_empty() || self.tool_edit_pending()) { + self.held_input.push_back((n, HeldInput::Pointer(*ev), view)); + return Ok(vec![]); + } + let r = self.pointer_now(ev, view); + self.note_edit_start(n); + r + } + + /// The number of the next pointer or key event handed to the session. + fn next_input(&mut self) -> u64 { + let n = self.input_count; + self.input_count = n.wrapping_add(1); + n + } + + /// How many pointer and key events have been handed to the session ([`Session::pointer`], + /// [`Session::tool_key`]); with [`Session::input_applied`], a frontend tells when the events it + /// handed over have been made. + pub fn input_count(&self) -> u64 { + self.input_count + } + + /// Have the events numbered `from..to` ([`Session::input_count`] before and after handing them + /// over) been made, and the edit they started on another thread applied? + pub fn input_applied(&self, from: u64, to: u64) -> bool { + let ours = |n: &u64| (from..to).contains(n); + !self.held_input.iter().any(|(n, ..)| ours(n)) && !(self.tool_edit_pending() && self.edit_started_by.as_ref().is_some_and(ours)) + } + + /// After event `n` was made: the event that started the edit being computed, if one is. + fn note_edit_start(&mut self, n: u64) { + if !self.tool_edit_pending() { + self.edit_started_by = None; + } else if self.edit_started_by.is_none() { + self.edit_started_by = Some(n); + } + } + + /// Is the active tool, or the tool Cmd lent the selection tool's drag away from, computing an + /// edit on another thread? + fn tool_edit_pending(&self) -> bool { + self.tool.editing() || self.lender.as_ref().is_some_and(|t| t.editing()) + } + + /// Makes the input held while the tool computed an edit, in order, until a held gesture starts + /// another such edit. + fn replay_held_input(&mut self) -> Result> { + let mut ui = vec![]; + let mut failed = None; + while !self.tool_edit_pending() + && let Some((n, input, view)) = self.held_input.pop_front() + { + let r = match input { + HeldInput::Pointer(ev) => self.pointer_now(&ev, view).map(|mut r| { + if ev.kind == PointerKind::Down { + r.push(UiRequest::HeldPress { doc: self.active().map(|d| d.uid), pos: ev.pos, tool: self.tool.id() }); + } + r + }), + HeldInput::Key(key, mods) => self.tool_key_now(key, mods, view), + }; + self.note_edit_start(n); + match r { + Ok(r) => ui.extend(r), + // The input after it is still made, as it was when each event came on its own. + Err(e) => failed = failed.or(Some(e)), + } + } + failed.map_or(Ok(ui), Err) + } + + fn pointer_now(&mut self, ev: &PointerEvent, view: ViewInfo) -> Result> { self.pointer_event(ev, view, true) } @@ -442,8 +539,25 @@ impl Session { /// nothing and a click opens no size dialog. The tool gets back the persistent options it had /// when the press began, and none of the press's changes to them are stored. A dropped Type /// press restores the prior selection. The freeform gradient point selected once the tool - /// took the press is selected again. + /// took the press is selected again. A press held while the tool computes an edit on another + /// thread has not reached the tool: it is removed from the held input with the pointer events + /// and tool keys held after it, and the tool is left as it is. A perspective plane key held + /// after it stays held, since the plane it picks outlasts a dropped press. Pointer events held + /// after the last held release belong to the press the tool has, and are removed with it. pub fn drop_tool_press(&mut self, view: ViewInfo) -> Result<()> { + let (from, held) = self.held_press(); + let keep: Vec = (self.held_input.iter().enumerate()) + .map(|(j, (_, input, _))| match input { + _ if j < from => true, + HeldInput::Pointer(_) => false, + HeldInput::Key(key, _) => !held || self.plane_key(*key).is_some(), + }) + .collect(); + let mut keep = keep.into_iter(); + self.held_input.retain(|_| keep.next().unwrap_or(true)); + if held { + return Ok(()); + } // Nothing to roll back without a document; the tool still drops the press and gets the release. let _ = self.cancel_interaction(); let before = self.press_options.take(); @@ -485,6 +599,19 @@ impl Session { r.map(drop) } + /// Where the input of the press in progress starts in the held input, and whether the press + /// itself is held: the last held press when no release is held after it; otherwise the input + /// after the last held release (all of it when none is held), which follows a press the tool + /// already has. + fn held_press(&self) -> (usize, bool) { + let ends = |kind: PointerKind| matches!(kind, PointerKind::Down | PointerKind::Up); + match self.held_input.iter().rposition(|(_, input, _)| matches!(input, HeldInput::Pointer(ev) if ends(ev.kind))) { + Some(i) if matches!(self.held_input.get(i), Some((_, HeldInput::Pointer(ev), _)) if ev.kind == PointerKind::Down) => (i, true), + Some(i) => (i + 1, false), + None => (0, false), + } + } + /// The options of `t` that [`Self::store_tool_settings`] stores. fn persistent_options(t: &dyn Tool) -> Map { let opts = t.options(); @@ -619,19 +746,148 @@ impl Session { self.tool.wants_samples() } - /// Is the active tool waiting for work it runs on another thread ([`Tool::waiting`])? + /// Is the active tool waiting for work it runs on another thread ([`Tool::waiting`]), is input + /// held until an edit it computes is applied, or are requests for the UI left from making it? pub fn tool_waiting(&self) -> bool { - self.tool.waiting() + self.tool.waiting() || !self.held_input.is_empty() || !self.held_ui.is_empty() } /// Lets the active tool check on the work [`Session::tool_waiting`] reports, and with `wait` - /// wait for it to finish ([`Tool::poll`]). - pub fn tool_poll(&mut self, view: ViewInfo, wait: bool) -> Result<()> { - self.with_tool_cx(view, |t, cx| t.poll(cx, wait)); - self.take_tool_panic() + /// wait for it to finish ([`Tool::poll`]); an edit the work made is applied, and then the input + /// held for it is made. Returns requests for the UI, those left from making held input where + /// nothing could take them first ([`Session::finish_tool_edit_later`]). + pub fn tool_poll(&mut self, view: ViewInfo, wait: bool) -> Result> { + if self.settling_tool_edit { + return Ok(vec![]); + } + self.settling_tool_edit = true; + let r = self.tool_poll_now(view, wait); + self.settling_tool_edit = false; + // On an error the requests left wait for the next poll. + let r = r?; + let mut ui = std::mem::take(&mut self.held_ui); + ui.extend(r); + Ok(ui) } + fn tool_poll_now(&mut self, view: ViewInfo, wait: bool) -> Result> { + let acts = self.with_tool_cx(view, |t, cx| t.poll(cx, wait)); + self.take_tool_panic()?; + let applied = !acts.is_empty(); + let mut ui = self.apply_actions(acts)?; + if !self.tool_edit_pending() { + self.edit_started_by = None; + // The input held for an edit applied now is made at the next poll, so what waits for the + // edit alone (a `ui.pointer` reply) sees the document as the edit left it. + if !applied { + ui.extend(self.replay_held_input()?); + } + } + Ok(ui) + } + + /// Is the active tool computing an edit on another thread ([`Tool::editing`]), or is input held + /// until it is applied? + pub fn tool_editing(&self) -> bool { + self.tool_edit_pending() || !self.held_input.is_empty() + } + + /// Waits for the edit the active tool computes on another thread and applies it + /// ([`Tool::finish_edit`]), then makes the input held for it, waiting in turn for an edit that + /// starts, so what runs next sees the document as the gestures left it. Commands, saves, option + /// changes, interactions, undo scopes and tool or document switches call it first. Returns + /// requests for the UI, with those left from earlier ([`Session::finish_tool_edit_later`]); on + /// an error, the next [`Session::tool_poll`] returns them. + pub fn finish_tool_edit(&mut self) -> Result> { + if self.settling_tool_edit { + return Ok(vec![]); + } + let mut ui = std::mem::take(&mut self.held_ui); + if self.tool_editing() { + self.settling_tool_edit = true; + let r = self.finish_tool_edit_now(); + self.settling_tool_edit = false; + match r { + Ok(r) => ui.extend(r), + Err(e) => { + ui.append(&mut self.held_ui); + self.held_ui = ui; + return Err(e); + } + } + } + Ok(ui) + } + + /// [`Session::finish_tool_edit`] for a caller that cannot hand requests to the UI (a command, a + /// tool switch): the next [`Session::tool_poll`] returns them, and [`Session::tool_waiting`] + /// holds until then. + pub(crate) fn finish_tool_edit_later(&mut self) -> Result<()> { + let ui = self.finish_tool_edit()?; + self.held_ui.extend(ui); + Ok(()) + } + + fn finish_tool_edit_now(&mut self) -> Result> { + let mut ui = vec![]; + let mut failed = None; + loop { + match self.finish_pending_edit() { + Ok(r) => ui.extend(r), + Err(e) => failed = failed.or(Some(e)), + } + // A tool that cannot finish its edit keeps the input held. + if self.tool_edit_pending() { + break; + } + self.edit_started_by = None; + if self.held_input.is_empty() { + break; + } + match self.replay_held_input() { + Ok(r) => ui.extend(r), + Err(e) => failed = failed.or(Some(e)), + } + } + match failed { + None => Ok(ui), + Some(e) => { + self.held_ui.extend(ui); + Err(e) + } + } + } + + /// Waits for the edit being computed and applies it: the active tool's, or that of the tool + /// Cmd lent the selection tool's drag away from, which is active meanwhile. + fn finish_pending_edit(&mut self) -> Result> { + if self.tool.editing() { + let acts = self.with_tool_cx(self.last_view, |t, cx| t.finish_edit(cx)); + self.take_tool_panic()?; + return self.apply_actions(acts); + } + let Some(lender) = self.lender.take_if(|t| t.editing()) else { return Ok(vec![]) }; + let lent = std::mem::replace(&mut self.tool, lender); + let acts = self.with_tool_cx(self.last_view, |t, cx| t.finish_edit(cx)); + let r = self.take_tool_panic().and_then(|()| self.apply_actions(acts)); + self.lender = Some(std::mem::replace(&mut self.tool, lent)); + r + } + + /// A key for the active tool. While the tool computes an edit on another thread, the key is held + /// and made once the edit is applied, after the input held before it. pub fn tool_key(&mut self, key: ToolKey, mods: Mods, view: ViewInfo) -> Result> { + let n = self.next_input(); + if self.tool_editing() { + self.held_input.push_back((n, HeldInput::Key(key, mods), view)); + return Ok(vec![]); + } + let r = self.tool_key_now(key, mods, view); + self.note_edit_start(n); + r + } + + fn tool_key_now(&mut self, key: ToolKey, mods: Mods, view: ViewInfo) -> Result> { // 1–4 pick the active perspective plane while the grid is shown. if let Some(plane) = self.plane_key(key) { self.execute("perspective.plane.set", &serde_json::json!({ "plane": plane.id() }))?; @@ -837,7 +1093,8 @@ impl Session { /// it is on, makes the drawing tools' a crosshair, [`Cursor::precise`]). With Cmd held, the pointer of the selection tool a /// press would borrow ([`Self::lend_selection_tool`]). pub fn cursor(&mut self, p: Point, mods: Mods, view: ViewInfo) -> Cursor { - let lent = if mods.cmd && self.lender.is_none() { self.lent_tool(self.tool.id(), &mods) } else { None }; + // While an edit is computed, a Cmd press is held for the active tool, which shows it is busy. + let lent = if mods.cmd && self.lender.is_none() && !self.tool_editing() { self.lent_tool(self.tool.id(), &mods) } else { None }; let c = match lent { Some(id) => { let lent = self.make_tool(id); @@ -860,6 +1117,9 @@ impl Session { self.tool.options() } pub fn set_tool_option(&mut self, key: &str, v: &Value) { + // The active tool's edit being computed is applied with the options it was started with. A + // failure to apply it was the edit's own, and the option is set all the same. + let _ = self.finish_tool_edit_later(); if key == "queue" && self.tool.id() == "place" { self.note_place_queue_roots(); } @@ -934,6 +1194,10 @@ impl Session { { return Err(format!("unknown tool `{t}`")); } + // The active tool's merge being computed is applied with the options it was started with. + if tool.is_none_or(|t| t == self.tool.id()) { + self.finish_tool_edit_later().map_err(|e| e.to_string())?; + } let mut values = p.get("values").and_then(Value::as_object).cloned().unwrap_or_default(); if let Some(k) = p.get("key").and_then(Value::as_str) { values.insert(k.to_string(), p.get("value").cloned().unwrap_or(Value::Null)); diff --git a/crates/engine/tests/command_sweep.rs b/crates/engine/tests/command_sweep.rs index 863a574cd..de14c38b5 100644 --- a/crates/engine/tests/command_sweep.rs +++ b/crates/engine/tests/command_sweep.rs @@ -219,6 +219,56 @@ fn every_command_with_junk_params() { ); } +/// Each document's uid, revision and selected ids, the active document and the current paint. +type ToolEditState = (Vec<(u64, u64, Vec)>, Option, vectorcraft_tools::PaintDefaults); + +/// What a command that runs while the active tool computes an edit on another thread must leave +/// as it was: every document's revision and selection, which document is active, and the current +/// paint. +fn tool_edit_state(s: &Session) -> ToolEditState { + let docs = s.documents().iter().map(|d| (d.uid, d.revision, d.selection.objects.iter().map(|i| i.0).collect())).collect(); + (docs, s.active_index(), s.paint.clone()) +} + +/// Every command that runs at once while the active tool computes an edit on another thread (a +/// Shape Builder merge), rather than applying the edit first (`waits_for_tool_edit`), leaves the +/// documents' revisions and selections, the active document and the current paint as they were, +/// with `{}`, junk params and params that turn its options on and off: the edit, computed for the +/// document as it was, still applies after it. +#[test] +fn commands_that_do_not_wait_for_a_tool_edit_change_no_document() { + let path = safe_path(); + let mut failures = vec![]; + for fx in [Fixture::Single, Fixture::Multi] { + for c in command_specs().iter().filter(|c| !vectorcraft_engine::waits_for_tool_edit(c.id)) { + let mut cases = junk_params(c.params, &path); + if heavy(c.id) { + cases.truncate(12); + } + for k in param_keys(c.params) { + for v in [json!(true), json!(false), json!(1), json!("on")] { + cases.push(json!({ k.as_str(): v })); + } + } + // Find Objects selects only with a filter, which one key at a time does not give it. + if c.id == "document.find" { + cases.extend([json!({"kind": "Path", "select": true}), json!({"name": "no such name", "select": true})]); + } + for p in &cases { + let mut s = fx.session(); + let before = tool_edit_state(&s); + let _ = catch_quiet(|| no_panic(s.execute(c.id, p))); + if tool_edit_state(&s) != before { + failures.push(format!("{} {p} [{fx:?}]", c.id)); + } + } + } + } + failures.sort(); + failures.dedup_by(|a, b| a.split(' ').next() == b.split(' ').next()); + assert!(failures.is_empty(), "{} commands change a document without waiting for a tool edit:\n{}", failures.len(), failures.join("\n")); +} + /// Junk inside the obvious structured params: ids arrays, anchors, matrices, colours, stops. #[test] fn structured_junk() { diff --git a/crates/engine/tests/import_fuzz.rs b/crates/engine/tests/import_fuzz.rs index 4a33c5f01..3d4498c07 100644 --- a/crates/engine/tests/import_fuzz.rs +++ b/crates/engine/tests/import_fuzz.rs @@ -3239,6 +3239,50 @@ fn text_editing_of(document: &str, objects: &str) -> String { /// Area Type Options as an area frame's data may keep them: rows, columns, gutters and the first /// baseline, and keys besides, each with a value of any kind, in or out of range. +/// A paragraph's attributes as a text document might keep them: an alignment (key 0), auto leading +/// (7), hyphenation options (10 to 15) and tab stops (30) of any value or type, the stops a list of +/// any length whose entries may be anything. +fn arb_paragraph_attributes() -> impl Strategy { + let values = prop::sample::select(vec![ + "0", + "1", + "2", + "3", + "6", + "7", + "-1", + "2.5", + "1e400", + "-1e400", + "NaN", + "inf", + "1e9", + "(x)", + "true", + "false", + "/nil", + "[ 1 ]", + "<< /0 1 >>", + ]); + let keys = prop::sample::select(vec!["0", "7", "10", "11", "12", "13", "14", "15"]); + let stop = (values.clone(), values.clone(), 0usize..3).prop_map(|(at, align, shape)| match shape { + 0 => format!("<< /0 {at} /1 {align} >>"), + 1 => format!("<< /1 {align} >>"), + _ => at.to_string(), + }); + let tabs = (prop::collection::vec(stop, 0..40), 0usize..4).prop_map(|(stops, shape)| match shape { + 0 => format!("/30 << /0 [ {} ] >>", stops.join(" ")), + 1 => "/30 << /0 7 >>".to_string(), + 2 => "/30 [ 1 2 ]".to_string(), + _ => String::new(), + }); + (prop::collection::vec((keys, values), 0..8), tabs).prop_map(|(kv, tabs)| { + let mut attrs: Vec = kv.iter().map(|(k, v)| format!("/{k} {v}")).collect(); + attrs.push(tabs); + attrs.join(" ") + }) +} + fn arb_area_options() -> impl Strategy { let keys = prop::sample::select(vec!["3", "4", "5", "7", "8", "10", "13", "14"]); let values = prop::sample::select(vec![ @@ -3463,6 +3507,18 @@ proptest! { survive(".ai text frames with hostile area options", || Some(vectorcraft_eps::layered_ai(&private, Document::new(100.0, 100.0), vec![], false, false, 1.0).0))?; } + /// The same text document with hostile paragraph attributes: an alignment, auto leading, + /// hyphenation options and tab stops of any value, type or size. + #[test] + fn text_frames_with_hostile_paragraph_attributes_never_panic(attrs in arb_paragraph_attributes()) { + let text = frames_document_text().replace("/5 << /0 2 /1 4 /2 6 >>", &format!("/5 << /1 4 /2 6 {attrs} >>")); + let editing = text_editing_of(&text, FRAME_OBJECTS); + let bytes = editing_eps(&editing); + survive("EPS text frames with hostile paragraph attributes", || vectorcraft_engine::cmd::fileio::load("x.eps", &bytes).ok().map(|l| l.doc))?; + let private = [b"%AI24_ZStandard_Data".as_slice(), &zstd(&editing)].concat(); + survive(".ai text frames with hostile paragraph attributes", || Some(vectorcraft_eps::layered_ai(&private, Document::new(100.0, 100.0), vec![], false, false, 1.0).0))?; + } + /// The type on a path of the same text document with hostile Type on a Path Options, opened as /// an EPS document and as a `.ai`'s editing data. #[test] diff --git a/crates/eps/src/import/ate.rs b/crates/eps/src/import/ate.rs index eae8bc138..2250dea96 100644 --- a/crates/eps/src/import/ate.rs +++ b/crates/eps/src/import/ate.rs @@ -25,7 +25,10 @@ use std::collections::BTreeMap; use kurbo::{BezPath, CubicBez, ParamCurve, ParamCurveArclen}; use vectorcraft_color::{Color, Paint}; -use vectorcraft_doc::{CharStyle, Justify, Node, NodeId, NodeKind, ParaDirection, ParaStyle, PathAlign, PathEffect, TextKind, TextObject, TextRun}; +use vectorcraft_doc::{ + CharStyle, HyphenationOptions, JustificationOptions, Justify, Node, NodeId, NodeKind, ParaDirection, ParaStyle, PathAlign, PathEffect, TabAlign, + TabStop, TextKind, TextObject, TextRun, +}; use vectorcraft_geom::{Affine, PathData, Point, Rect}; /// Longest story read (bytes). @@ -383,8 +386,33 @@ struct Para { space_before: f64, space_after: f64, hyphenate: bool, + /// Key 7: the share of its type size a line takes as its auto leading (1.2: 120%, the default; + /// Justification… sets 0 to 500%: + /// https://helpx.adobe.com/illustrator/using/line-character-spacing.html). `None`: the default. + auto_leading: Option, + /// Keys 10 to 15, in the order of Paragraph panel menu › Hyphenation…: Words Longer Than, + /// After First, Before Last, Hyphen Limit, Hyphenation Zone (pt) and Hyphenate Capitalized + /// Words. A value that can't be read, or is out of its range, keeps the default. + hyphenation: HyphenationOptions, + /// Key 30, its list (key 0): the tab stops, each its position from the frame's left edge (key + /// 0) and alignment (key 1: 0 left, the default, 1 center, 2 right, 3 decimal, in the order of + /// the Tabs panel's buttons), sorted. A stop that can't be read is left out, and so are those + /// past the first [`MAX_TABS`]. Leaders aren't read. + tabs: Vec, + /// The paragraph has more than [`MAX_TABS`] stops: those past them were left out. + tabs_truncated: bool, } +/// Most tab stops read for one paragraph. +const MAX_TABS: usize = 1024; +/// Largest tab stop position read (in the text document's units), as `text.tabs.set` takes it. +const MAX_TAB_POSITION: f64 = 100_000.0; +/// Most tab stops a story's paragraphs take in all: a paragraph style's stops are copied into +/// every paragraph that has them. The paragraphs past it take the default stops, with a warning. +const MAX_STORY_TABS: usize = 1 << 20; +/// The warning when [`MAX_STORY_TABS`] leaves tab stops out. +pub(crate) const TABS_LEFT_OUT: &str = "tab stops past VectorCraft's limits were left out"; + /// The text of one story, in the units of the text document. #[derive(Debug)] pub(super) struct Story { @@ -405,6 +433,20 @@ pub(super) struct Story { /// Vertical type (Type › Type Orientation › Vertical): its lines are columns, from right to /// left. Its layout's lines run down from the anchor, each column further left. vertical: bool, + /// Tab stops past [`MAX_STORY_TABS`] were left out of its paragraphs. + tabs_left_out: std::cell::Cell, +} + +/// Spend `budget` on the tab stops `tabs`: when there aren't enough left, they're left out (the +/// default stops apply). Whether they were. +fn spend_tabs(tabs: &mut Vec, budget: &mut usize) -> bool { + if tabs.len() <= *budget { + *budget -= tabs.len(); + false + } else { + tabs.clear(); + true + } } #[derive(Clone, Debug)] @@ -607,7 +649,12 @@ impl Texts { if runs.is_empty() { runs.push((text.chars().count(), self.style(None))); } - Some(Story { text, anchor, lines, frames, paras, runs, path_spacing, vertical }) + let mut budget = MAX_STORY_TABS; + let mut tabs_left_out = false; + for (_, p) in &mut paras { + tabs_left_out |= p.tabs_truncated | spend_tabs(&mut p.tabs, &mut budget); + } + Some(Story { text, anchor, lines, frames, paras, runs, path_spacing, vertical, tabs_left_out: tabs_left_out.into() }) } /// A paragraph's attributes (`run`: its attributes, key 5, and the paragraph style it is based @@ -633,6 +680,46 @@ impl Texts { space_before: num("4"), space_after: num("5"), hyphenate: !matches!(pick("9"), Some(Val::Bool(false))), + auto_leading: pick("7").and_then(Val::num).filter(|v| v.is_finite() && *v > 0.0 && *v <= 5.0), + hyphenation: { + let d = HyphenationOptions::default(); + let count = |k: &str, lo: f64, hi: f64, or: u32| { + pick(k).and_then(Val::num).filter(|v| v.is_finite() && v.fract() == 0.0 && (lo..=hi).contains(v)).map_or(or, |v| v as u32) + }; + HyphenationOptions { + words_longer_than: count("10", 1.0, 25.0, d.words_longer_than), + after_first: count("11", 1.0, 15.0, d.after_first), + before_last: count("12", 1.0, 15.0, d.before_last), + hyphen_limit: count("13", 0.0, 25.0, d.hyphen_limit), + zone: pick("14").and_then(Val::num).filter(|v| v.is_finite() && (0.0..=1296.0).contains(v)).unwrap_or(d.zone), + capitalized: match pick("15") { + Some(Val::Bool(b)) => *b, + _ => d.capitalized, + }, + } + }, + tabs_truncated: pick("30").and_then(|t| t.get("0")).map(Val::list).is_some_and(|list| list.len() > MAX_TABS), + tabs: { + let list = pick("30").and_then(|t| t.get("0")).map(Val::list).unwrap_or_default(); + let mut tabs: Vec = list + .iter() + .take(MAX_TABS) + .filter_map(|t| { + let position = t.get("0").and_then(Val::num).filter(|p| (0.0..=MAX_TAB_POSITION).contains(p))?; + let align = match t.get("1").map(Val::num) { + None | Some(Some(0.0)) => TabAlign::Left, + Some(Some(1.0)) => TabAlign::Center, + Some(Some(2.0)) => TabAlign::Right, + Some(Some(3.0)) => TabAlign::Decimal, + _ => return None, + }; + Some(TabStop { position, align, leader: String::new(), align_on: '.' }) + }) + .collect(); + tabs.sort_by(|a, b| a.position.total_cmp(&b.position)); + tabs.dedup_by(|a, b| (a.position - b.position).abs() < 1e-6); + tabs + }, } } @@ -1001,7 +1088,6 @@ impl Story { // The text document measures in the art's units too: the document's scale carries its // sizes and spacings onto the page (a Large Canvas copy is written at 1:10; #2031). let scale = scale * art_scale(to_doc); - let leading = self.line_leading(scale); let chars: Vec = text.chars().collect(); let mut runs = vec![]; let mut from = 0usize; @@ -1012,13 +1098,13 @@ impl Story { if piece.is_empty() { continue; } - runs.push(TextRun::new(piece, char_style(st, scale, leading))); + runs.push(TextRun::new(piece, char_style(st, scale))); } if from < chars.len() { let last = self.runs.last().map(|r| &r.1)?; - runs.push(TextRun::new(chars.get(from..).unwrap_or_default().iter().collect::(), char_style(last, scale, leading))); + runs.push(TextRun::new(chars.get(from..).unwrap_or_default().iter().collect::(), char_style(last, scale))); } - let first = self.runs.first().map(|r| char_style(&r.1, scale, leading))?; + let first = self.runs.first().map(|r| char_style(&r.1, scale))?; let mut t = TextObject::point(Point::ZERO, "", first); if !runs.is_empty() { t.runs = runs; @@ -1065,6 +1151,21 @@ impl Story { !self.lines.is_empty() && vectorcraft_text::fit_first_line(vectorcraft_text::FontDb::global(), t) } + /// Area type of one frame that the file lays more lines out in than fit here: in the fallback + /// font, or a last line whose descent the file lets pass the frame's bottom. The frame is made + /// taller from its bottom (`vectorcraft_text::fit_source_lines`) so the file's lines show. + /// Whether it was. + pub(super) fn fit_last_lines(&self, t: &mut TextObject) -> bool { + matches!(self.frames.as_slice(), [FrameKind::Area(..)]) + && vectorcraft_text::fit_source_lines(vectorcraft_text::FontDb::global(), t, self.lines.len()) + } + + /// Were tab stops past [`MAX_STORY_TABS`] left out of its paragraphs (so far: making its text + /// object counts them again)? + pub(super) fn tabs_left_out(&self) -> bool { + self.tabs_left_out.get() + } + /// Area type (`node`, the story's first frame as [`Self::node`] makes it with `template` and /// `to_doc`) whose first line the file lays out higher or lower than it is laid out here, as its /// page draws it: its first baseline is fixed where the file has it. The font's ascent below the @@ -1103,38 +1204,6 @@ impl Story { true } - /// The leading the file's own line positions imply: the distance from one line to the next, less - /// the space between paragraphs that is part of it (a paragraph's space after and the next one's - /// space before; a layout's lines are where that space has put them, and the text object adds it - /// again). - fn line_leading(&self, scale: f64) -> Option { - let para_at = |c: usize| { - let mut end = 0usize; - for (n, p) in &self.paras { - end = end.saturating_add(*n); - if c < end { - return Some(p); - } - } - self.paras.last().map(|(_, p)| p) - }; - let chars: Vec = self.text.chars().collect(); - let breaks: Vec = chars.iter().enumerate().filter(|(_, c)| matches!(c, '\r' | '\x03')).map(|(i, _)| i).collect(); - // More lines than breaks: area type wraps, and which break ends which line is unknown. - let wraps = self.lines.len() > breaks.len() + 1; - self.lines.windows(2).enumerate().find_map(|(i, w)| { - let pitch = w[1].1 - w[0].1; - let between = match breaks.get(i) { - Some(&at) if !wraps && chars.get(at) == Some(&'\r') => { - para_at(at).map_or(0.0, |p| p.space_after) + para_at(at + 1).map_or(0.0, |p| p.space_before) - } - _ => 0.0, - }; - let l = (pitch - between) * scale; - (l.is_finite() && l > 0.0).then_some(l) - }) - } - /// The style of each paragraph of `text` (paragraphs split at `\n`). fn paragraph_styles(&self, text: &str, scale: f64) -> Vec { let count = text.split('\n').count(); @@ -1142,9 +1211,13 @@ impl Story { let mut runs = self.paras.iter(); let mut current = runs.next(); let mut left = current.map_or(usize::MAX, |r| r.0); + let mut budget = MAX_STORY_TABS; for p in text.split('\n') { - let para = current.map(|r| r.1.clone()).unwrap_or_default(); - out.push(para_style(¶, scale)); + let mut style = current.map_or_else(|| para_style(&Para::default(), scale), |r| para_style(&r.1, scale)); + if spend_tabs(&mut style.tabs, &mut budget) { + self.tabs_left_out.set(true); + } + out.push(style); // Each paragraph and its ending `\r` count. let mut used = p.chars().count() + 1; while used > 0 { @@ -1165,6 +1238,8 @@ impl Story { } } +/// The paragraph style of paragraph attributes `p`, its lengths (indents, spacing, the +/// hyphenation zone) scaled by `scale`, as sizes are. fn para_style(p: &Para, scale: f64) -> ParaStyle { ParaStyle { justify: match p.justify { @@ -1184,21 +1259,33 @@ fn para_style(p: &Para, scale: f64) -> ParaStyle { space_before: p.space_before * scale, space_after: p.space_after * scale, hyphenate: p.hyphenate, + hyphenation: HyphenationOptions { zone: p.hyphenation.zone * scale, ..p.hyphenation.clone() }, + tabs: p.tabs.iter().map(|t| TabStop { position: t.position * scale, ..t.clone() }).collect(), // A right-to-left paragraph lays its text out from the right whatever letters it has // (" 120.5 mm " reads "mm 120.5"); without the key, from its first strong letter. direction: p.rtl.then_some(ParaDirection::RightToLeft), + justification: JustificationOptions { + // Rounded, so the file's 1.2 is the default 120% exactly. + auto_leading: p.auto_leading.map_or(JustificationOptions::default().auto_leading, |a| (a * 1e6).round() / 1e4), + ..JustificationOptions::default() + }, ..ParaStyle::default() } } -fn char_style(s: &Style, scale: f64, leading: Option) -> CharStyle { +/// The character style of character attributes `s`: its font from the fonts the app has, its +/// lengths (size, leading, baseline shift, stroke width) scaled by `scale`. +fn char_style(s: &Style, scale: f64) -> CharStyle { let (family, style) = s.font.as_deref().map_or_else(|| (CharStyle::default().font_family, "Regular".to_string()), crate::family_style); let family = vectorcraft_text::FontDb::global().find_family(&family).unwrap_or(family); CharStyle { font_family: family, font_style: style, size: s.size * scale, - leading: s.leading.map(|l| l * scale).or(leading), + // Auto leading stays auto: the layout gives each line the paragraph's share of the largest + // type on it, as the file's own layout does ("The largest leading value in a line of type + // determines the leading for that line": https://helpx.adobe.com/illustrator/using/line-character-spacing.html). + leading: s.leading.map(|l| l * scale), tracking: s.tracking, baseline_shift: s.baseline_shift * scale, h_scale: s.h_scale * 100.0, @@ -1247,6 +1334,130 @@ mod tests { assert_eq!(justify(b"/0 1 /33 0"), Justify::Right); } + /// Key 7 is the paragraph's auto leading, a share of the type size; one that can't be read + /// leaves the default, 120%. + #[test] + fn a_paragraph_keeps_its_auto_leading() { + let texts = Texts { + stories: vec![], + fonts: vec![], + defaults: Val::Dict(BTreeMap::new()), + para_defaults: read(b"/7 1.2").unwrap(), + char_sheets: vec![], + para_sheets: vec![], + frames: vec![], + }; + let auto = |own: &[u8]| para_style(&texts.para(Some(&read(&[b"/5 << ", own, b" >>"].concat()).unwrap())), 1.0).justification.auto_leading; + assert_eq!(auto(b""), JustificationOptions::default().auto_leading); + assert_eq!(auto(b"/7 1.5"), 150.0); + assert_eq!(auto(b"/7 1.15"), 115.0); + for unreadable in [b"/7 0".as_slice(), b"/7 -1", b"/7 1e9", b"/7 /nil"] { + assert!((auto(unreadable) - 120.0).abs() < 1e-9, "{}", String::from_utf8_lossy(unreadable)); + } + } + + /// Keys 10 to 15 are the paragraph's hyphenation options; one that can't be read, or is out of + /// its range, keeps the default. The zone is in points of the text document, scaled as sizes are. + #[test] + fn a_paragraph_keeps_its_hyphenation_options() { + let texts = Texts { + stories: vec![], + fonts: vec![], + defaults: Val::Dict(BTreeMap::new()), + para_defaults: read(b"/10 6 /11 2 /12 2 /13 0 /14 36.0 /15 true").unwrap(), + char_sheets: vec![], + para_sheets: vec![], + frames: vec![], + }; + let options = |own: &[u8], scale: f64| para_style(&texts.para(Some(&read(&[b"/5 << ", own, b" >>"].concat()).unwrap())), scale).hyphenation; + let want = HyphenationOptions { words_longer_than: 6, after_first: 2, before_last: 2, hyphen_limit: 0, zone: 36.0, capitalized: true }; + assert_eq!(options(b"", 1.0), want); + assert_eq!( + options(b"/10 8 /13 3 /15 false", 0.5), + HyphenationOptions { words_longer_than: 8, hyphen_limit: 3, zone: 18.0, capitalized: false, ..want.clone() } + ); + let d = HyphenationOptions::default(); + let bare = Texts { + stories: vec![], + fonts: vec![], + defaults: Val::Dict(BTreeMap::new()), + para_defaults: Val::Dict(BTreeMap::new()), + char_sheets: vec![], + para_sheets: vec![], + frames: vec![], + }; + let own = |own: &[u8]| para_style(&bare.para(Some(&read(&[b"/5 << ", own, b" >>"].concat()).unwrap())), 1.0).hyphenation; + assert_eq!(own(b""), d); + assert_eq!(own(b"/10 0 /11 99 /12 2.5 /13 -1 /14 -3 /15 1"), d); + } + + /// Key 30 holds the paragraph's tab stops: their positions (key 0), sorted, and alignments (key + /// 1: 0 left, 1 center, 2 right, 3 decimal), scaled as sizes are. A stop that can't be read is + /// left out. A user's price list keeps a right stop at 269.29 and a left one at 272.13. + #[test] + fn a_paragraph_keeps_its_tab_stops() { + let texts = Texts { + stories: vec![], + fonts: vec![], + defaults: Val::Dict(BTreeMap::new()), + para_defaults: Val::Dict(BTreeMap::new()), + char_sheets: vec![], + para_sheets: vec![], + frames: vec![], + }; + let tabs = |own: &[u8], scale: f64| { + para_style(&texts.para(Some(&read(&[b"/5 << ", own, b" >>"].concat()).unwrap())), scale) + .tabs + .iter() + .map(|t| (t.position, t.align)) + .collect::>() + }; + assert_eq!(tabs(b"", 1.0), []); + assert_eq!( + tabs(b"/30 << /0 [ << /0 272.12598 /1 0 >> << /0 269.29135 /1 2 >> ] >>", 1.0), + [(269.29135, TabAlign::Right), (272.12598, TabAlign::Left)] + ); + assert_eq!( + tabs(b"/30 << /0 [ << /0 10 /1 1 >> << /0 20 /1 3 >> << /0 30 >> ] >>", 0.5), + [(5.0, TabAlign::Center), (10.0, TabAlign::Decimal), (15.0, TabAlign::Left)] + ); + // Past MAX_TABS stops, the rest are left out, and the paragraph says so (the story's warning). + let many = |n: usize| { + let stops: String = (0..n).map(|i| format!("<< /0 {i} >> ")).collect(); + texts.para(Some(&read(format!("/5 << /30 << /0 [ {stops}] >> >>").as_bytes()).unwrap())) + }; + let p = many(MAX_TABS + 6); + assert!(p.tabs_truncated && p.tabs.len() == MAX_TABS); + let p = many(MAX_TABS); + assert!(!p.tabs_truncated && p.tabs.len() == MAX_TABS); + // Unreadable: a position out of range or not a number, an unknown alignment. + assert_eq!( + tabs(b"/30 << /0 [ << /0 -1 >> << /0 1e9 >> << /0 /nil >> << /0 5 /1 7 >> << /0 6 /1 /x >> << /0 7 /1 2 >> ] >>", 1.0), + [(7.0, TabAlign::Right)] + ); + } + + /// A story's paragraphs take at most [`MAX_STORY_TABS`] tab stops in all (a paragraph style's + /// are copied into each paragraph): those past it take the default stops, and the story says so. + #[test] + fn a_story_s_tab_stops_are_bounded() { + let mut budget = 3; + let mut tabs = vec![TabStop { position: 1.0, align: TabAlign::Left, leader: String::new(), align_on: '.' }; 2]; + assert!(!spend_tabs(&mut tabs, &mut budget) && tabs.len() == 2 && budget == 1); + assert!(spend_tabs(&mut tabs, &mut budget) && tabs.is_empty() && budget == 1); + // Paragraphs of a style with MAX_TABS stops each, more than the story takes. + let stop = TabStop { position: 1.0, align: TabAlign::Left, leader: String::new(), align_on: '.' }; + let para = Para { tabs: vec![stop; MAX_TABS], ..Para::default() }; + let count = MAX_STORY_TABS / MAX_TABS + 2; + let s = story(&"a\r".repeat(count), &[0.0], ¶); + assert!(!s.tabs_left_out()); + let styles = s.paragraph_styles(&format!("{}a", "a\n".repeat(count - 1)), 1.0); + assert_eq!(styles.len(), count); + assert!(s.tabs_left_out()); + assert_eq!(styles.iter().map(|p| p.tabs.len()).sum::(), MAX_STORY_TABS); + assert!(styles.last().is_some_and(|p| p.tabs.is_empty())); + } + /// Where point type lies runs along its baseline: a label turned a quarter (as a vertical /// dimension's is) lies in a tall box, not a wide one. #[test] @@ -1636,6 +1847,7 @@ mod tests { )], path_spacing: 0.0, vertical: false, + tabs_left_out: false.into(), } } @@ -1882,25 +2094,54 @@ mod tests { } } + /// The baselines of the text object `story` comes in as, laid out. + fn baselines_of(story: &Story) -> Vec { + let Some(node) = story.node(NodeId(1), 0, (0.0, 0.0), Affine::IDENTITY) else { return vec![] }; + let NodeKind::Text(t) = &node.kind else { return vec![] }; + vectorcraft_text::layout(vectorcraft_text::FontDb::global(), t).baselines().iter().map(|b| b.0.y).collect() + } + + /// Auto leading stays auto: each line takes the paragraph's share of the largest type on it, as + /// the file's own layout does, not the distance between the first two lines for every line. A + /// 15 pt heading over 10 pt type at 120%: 18 pt between the heading's lines, then 12 pt. + #[test] + fn auto_leading_follows_the_size_of_each_line() { + let mut s = story("Big\x03Bigger\rsmall\r", &[0.0, 18.0, 30.0], &Para::default()); + let base = s.runs[0].1.clone(); + s.runs = vec![(11, Style { size: 15.0, ..base.clone() }), (6, Style { size: 10.0, ..base })]; + assert_eq!(leading_of(&s), None); + let ys = baselines_of(&s); + assert_eq!(ys.len(), 3, "{ys:?}"); + assert!(((ys[1] - ys[0]).abs() - 18.0).abs() < 1e-6, "{ys:?}"); + assert!(((ys[2] - ys[1]).abs() - 12.0).abs() < 1e-6, "{ys:?}"); + // At a share the paragraph sets (key 7) of 150%: 22.5 pt, then 15 pt. + let share = Para { auto_leading: Some(1.5), ..Para::default() }; + s.paras = s.paras.iter().map(|(n, _)| (*n, share.clone())).collect(); + let ys = baselines_of(&s); + assert!(((ys[1] - ys[0]).abs() - 22.5).abs() < 1e-6, "{ys:?}"); + assert!(((ys[2] - ys[1]).abs() - 15.0).abs() < 1e-6, "{ys:?}"); + } + #[test] fn leading_leaves_out_the_space_between_paragraphs_that_the_lines_already_have() { // Lines 10.6 apart that are three paragraphs with 5 less after each: auto leading (15.6) less 5. let para = Para { space_after: -5.0, ..Para::default() }; + // The text object keeps auto leading and the spacing, so its lines are where the file's are. let s = story("one\rtwo\rthree\r", &[0.0, 10.6, 21.2], ¶); - assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9); - assert!((leading_of(&s).unwrap() - 15.6).abs() < 1e-9); - // Space after and space before both count; the scale of the frame carries onto the leading. + assert_eq!(leading_of(&s), None); + let ys = baselines_of(&s); + assert!(ys.len() == 3 && ys.windows(2).all(|w| ((w[1] - w[0]).abs() - 10.6).abs() < 1e-6), "{ys:?}"); + // Space after and space before both count. let para = Para { space_after: 4.0, space_before: 2.0, ..Para::default() }; - let s = story("one\rtwo\r", &[0.0, 20.0], ¶); - assert!((s.line_leading(1.0).unwrap() - 14.0).abs() < 1e-9); - assert!((s.line_leading(0.5).unwrap() - 7.0).abs() < 1e-9); + let ys = baselines_of(&story("one\rtwo\r", &[0.0, 21.6], ¶)); + assert!(((ys[1] - ys[0]).abs() - 21.6).abs() < 1e-6, "{ys:?}"); } /// #2031: a Large Canvas editing copy measures its text document in its art's units, a tenth /// of the page's: the story's size and leading reach the page through `to_doc`'s scale. #[test] fn a_story_in_a_scaled_art_space_keeps_its_size_and_leading() { - let s = story("one\rtwo\r", &[0.0, 20.0], &Para::default()); + let s = story("one\rtwo\r", &[0.0, 15.6], &Para::default()); // A copy written at 1:10 (see `ai::read::ensure_space`): its art's units reach the // document, 100 points to the page, through `to_doc`'s scale. let to_doc = Affine::scale(10.0) * Affine::new([1.0, 0.0, 0.0, -1.0, 0.0, 100.0]); @@ -1909,24 +2150,18 @@ mod tests { _ => panic!("not text"), }; assert_eq!(t.runs[0].style.size, 130.0, "13 pt at the page's scale"); - assert_eq!(t.runs[0].style.leading, Some(200.0), "a 20-unit line pitch at the page's scale"); + assert_eq!(t.runs[0].style.leading, None, "auto leading: 120% of its size at the page's scale"); + assert_eq!(t.para.justification.auto_leading, 120.0); } #[test] fn leading_between_lines_of_a_paragraph_is_their_distance() { // A line break inside a paragraph has no paragraph spacing between its lines. let para = Para { space_after: -5.0, space_before: 3.0, ..Para::default() }; - let s = story("one\x03two\x03three\r", &[0.0, 15.6, 31.2], ¶); - assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9); - // Paragraphs without spacing: the distance as it was. - let s = story("one\rtwo\r", &[0.0, 15.6], &Para::default()); - assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9); - // Area type whose paragraph wraps: lines and breaks don't pair up, so nothing is taken off. - let para = Para { space_after: -5.0, ..Para::default() }; - let s = story("one two three\rfour\r", &[0.0, 15.6, 31.2, 41.8], ¶); - assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9); - // One line has no distance to read. - assert_eq!(story("one\r", &[0.0], &Para::default()).line_leading(1.0), None); + let ys = baselines_of(&story("one\x03two\x03three\r", &[0.0, 15.6, 31.2], ¶)); + assert!(ys.len() == 3 && ys.windows(2).all(|w| ((w[1] - w[0]).abs() - 15.6).abs() < 1e-6), "{ys:?}"); + // One line. + assert_eq!(baselines_of(&story("one\r", &[0.0], &Para::default())).len(), 1); } /// A `\x03` ends a line inside its paragraph: it comes in as a forced line break, and the @@ -1970,6 +2205,32 @@ mod tests { assert!(!story("Heading\r", &[], &Para::default()).fit_first_line(&mut t) && height(&t).unwrap().3 == 13.0); } + /// The file sets three lines in a frame whose third line's descent passes its bottom: the frame + /// grows from its bottom so the third shows. Only when the story's one frame is area type. + #[test] + fn the_last_lines_the_file_sets_in_its_frame_show() { + let db = vectorcraft_text::FontDb::global(); + let area = |height: f64| { + let mut t = TextObject::point(Point::ZERO, "one\ntwo\nthree", CharStyle { size: 13.0, ..CharStyle::default() }); + t.kind = TextKind::Area { frame: vectorcraft_geom::shapes::rectangle(Rect::new(10.0, 20.0, 210.0, 20.0 + height)) }; + t + }; + let tall = vectorcraft_text::layout(db, &area(400.0)); + let third = &tall.lines[2]; + let mut t = area(third.baseline - 20.0 + third.descent / 2.0); + assert_eq!(vectorcraft_text::layout(db, &t).lines.len(), 2); + let mut s = story("one\rtwo\rthree\r", &[0.0, 15.6, 31.2], &Para::default()); + // A point-type frame (the helper's) isn't fitted. + assert!(!s.fit_last_lines(&mut t)); + s.frames = vec![FrameKind::Area(vec![], AreaFrame::default())]; + assert!(s.fit_last_lines(&mut t)); + assert_eq!(vectorcraft_text::layout(db, &t).lines.len(), 3); + // A story threaded through two frames: its lines are the first frame's alone. + let mut t = area(third.baseline - 20.0 + third.descent / 2.0); + s.frames.push(FrameKind::Area(vec![], AreaFrame::default())); + assert!(!s.fit_last_lines(&mut t)); + } + #[test] fn area_type_s_first_line_goes_where_the_file_lays_it_out() { // GUARDS: area type's first baseline was the font's ascent below the frame's top, where the diff --git a/crates/eps/src/import/native/plan.rs b/crates/eps/src/import/native/plan.rs index 3cfc3a6b5..5dd918fb5 100644 --- a/crates/eps/src/import/native/plan.rs +++ b/crates/eps/src/import/native/plan.rs @@ -59,7 +59,7 @@ pub(super) fn make_slots( to_doc: Affine, warn: &mut Vec, ) -> Vec> { - let mut taller = 0; + let (mut taller, mut deeper, mut tabs_left_out) = (0, 0, false); let made = infos .iter() .enumerate() @@ -67,6 +67,7 @@ pub(super) fn make_slots( let t = template?; let story = stories.get(k)?.as_ref()?; let mut node = story.node(NodeId(0), info.frame, t, to_doc)?; + tabs_left_out |= story.tabs_left_out(); let mut region = story.region(t, to_doc); // The first line where the file has it, in the text document's frame (that of a // copied object is its original's, as its lines are). @@ -80,6 +81,11 @@ pub(super) fn make_slots( { taller += 1; } + if let NodeKind::Text(text) = &mut node.kind + && story.fit_last_lines(text) + { + deeper += 1; + } Some((Box::new(node), region)) }) .collect(); @@ -88,6 +94,14 @@ pub(super) fn make_slots( "area type in frames too short for a line of the font it shows in got taller frames ({taller}): their type wouldn't show otherwise" )); } + if deeper > 0 { + warn.push(format!( + "area type whose last lines the file sets in frames too short for them here got taller frames ({deeper}): those lines wouldn't show otherwise" + )); + } + if tabs_left_out { + warn.push(crate::import::ate::TABS_LEFT_OUT.into()); + } made } diff --git a/crates/mcp/src/headless.rs b/crates/mcp/src/headless.rs index 12c3d766e..32735d9a0 100644 --- a/crates/mcp/src/headless.rs +++ b/crates/mcp/src/headless.rs @@ -173,6 +173,8 @@ impl Headless { UiRequest::Place(p) => { self.session.execute("file.place", &p).map_err(|e| e.to_string())?; } + // The host keeps its view's artboard on a press, as for the presses it hands over. + UiRequest::HeldPress { .. } => {} } } Ok(()) @@ -204,10 +206,11 @@ impl Headless { }; let reqs = self.session.pointer(&ev, self.view).map_err(|e| e.to_string())?; self.apply_ui_requests(reqs, &mut requests)?; - // With no frames to show the highlight in later, a hover waits for the work the tool - // runs on another thread. - if kind == PointerKind::Move && self.session.tool_waiting() { - self.session.tool_poll(self.view, true).map_err(|e| e.to_string())?; + // With no frames to show the highlight or apply an edit in later, each event waits for + // the work the tool runs on another thread (a hover's map, a release's merge). + if self.session.tool_waiting() { + let reqs = self.session.tool_poll(self.view, true).map_err(|e| e.to_string())?; + self.apply_ui_requests(reqs, &mut requests)?; } let hold = PointerEvent::json_hold(e); if hold > 0.0 { diff --git a/crates/mcp/src/tests.rs b/crates/mcp/src/tests.rs index 90df3349e..f52d0aeba 100644 --- a/crates/mcp/src/tests.rs +++ b/crates/mcp/src/tests.rs @@ -498,6 +498,15 @@ fn headless_hover_waits_for_the_shape_builder_map() { assert!(!r.is_error, "{r:?}"); assert!(!h.session.tool_waiting()); assert!(!h.session.overlays(h.view).is_empty(), "the region under the pointer is highlighted"); + // A click's reply comes once the merge the tool computes on another thread is applied, with + // the selection after it. + let click = json!({"events": [{"kind": "down", "x": 115, "y": 110}, {"kind": "up", "x": 115, "y": 110}]}); + let r = crate::call_tool(&mut h, "pointer_gesture", &click); + assert!(!r.is_error, "{r:?}"); + assert!(!h.session.tool_waiting() && !h.session.tool_editing()); + let text: String = r.content.iter().filter_map(|c| c["text"].as_str()).collect(); + let reply: Value = serde_json::from_str(&text).unwrap(); + assert_eq!(reply["selection"].as_array().map(Vec::len), Some(41), "the overlap and the 40 squares, two of them cut: {reply}"); } /// inspect_document reads back the paint type's characters show, as add_text and set_paint give it. diff --git a/crates/text/src/layout.rs b/crates/text/src/layout.rs index e4289109b..9d96dca04 100644 --- a/crates/text/src/layout.rs +++ b/crates/text/src/layout.rs @@ -39,7 +39,7 @@ use breaking::tab_advance; use breaking::{break_line, candidates}; #[cfg(test)] pub(crate) use driver::layout_faces_per_call; -pub use driver::{decorations, fit_first_line, layout, layout_with, scaled}; +pub use driver::{decorations, fit_first_line, fit_source_lines, layout, layout_with, scaled}; use vertical::{TcyStyle, stands_upright, tate_chu_yoko, upright_cell, upright_centre, upright_extent, whole_character_widths}; #[cfg(test)] diff --git a/crates/text/src/layout/driver.rs b/crates/text/src/layout/driver.rs index 75796e265..805c4dead 100644 --- a/crates/text/src/layout/driver.rs +++ b/crates/text/src/layout/driver.rs @@ -62,6 +62,38 @@ pub fn fit_first_line(db: &FontDb, t: &mut TextObject) -> bool { true } +/// Area type whose source lays out `lines` lines in its frame, more than fit here: a font that isn't +/// available shows in the fallback font, whose lines may reach lower, and the source may set a last +/// line whose descent passes the frame's bottom, which isn't drawn here. For importers: the frame is +/// made taller, from its bottom, by its lines' deepest descent plus 0.05 pt, when that lays out +/// more of the source's lines and no more than it has. Horizontal type only. Whether it was. +pub fn fit_source_lines(db: &FontDb, t: &mut TextObject, lines: usize) -> bool { + let TextKind::Area { frame } = &t.kind else { return false }; + if t.vertical { + return false; + } + let Some(b) = frame.bounds().filter(|b| b.height() > 1e-6) else { return false }; + let laid = layout(db, t); + let have = laid.lines.len(); + if !laid.overflow || have == 0 || have >= lines { + return false; + } + // The deepest descent of its lines (a little more, for the rounding of the layout). + let Some(descent) = laid.lines.iter().map(|l| l.descent).reduce(f64::max).filter(|d| d.is_finite() && *d > 0.0) else { return false }; + let by = (b.height() + descent + 0.05) / b.height(); + if !(by.is_finite() && by > 1.0) { + return false; + } + let taller = frame.transformed(Affine::translate((0.0, b.y0)) * Affine::scale_non_uniform(1.0, by) * Affine::translate((0.0, -b.y0))); + let short = std::mem::replace(&mut t.kind, TextKind::Area { frame: taller }); + let now = layout(db, t).lines.len(); + if now > have && now <= lines { + return true; + } + t.kind = short; + false +} + /// The underline and strikethrough bars of `t` laid out as `layout` (#847): per run and line, a /// bar from the stretch's first glyph to its last one's advance, placed and sized by the font's /// own underline and strikeout metrics through the glyph's transform (so the size, baseline shift diff --git a/crates/text/src/layout/flow.rs b/crates/text/src/layout/flow.rs index 652213940..e1d55eece 100644 --- a/crates/text/src/layout/flow.rs +++ b/crates/text/src/layout/flow.rs @@ -410,6 +410,9 @@ struct LineJustification { start_x: f64, after: Vec>, kashidas: Vec<(usize, f64)>, + /// Right-aligned area type: the line's last tab, which takes the text after it to the right + /// edge (the text before it sits at its stops, from the left edge). + last_tab: Option, } fn run_paragraph_lines(cx: &mut Ctx<'_>, pen: &mut Pen<'_>, t: &TextObject, mut paragraph: ParagraphData<'_, '_>) -> bool { @@ -464,6 +467,9 @@ fn run_paragraph_lines(cx: &mut Ctx<'_>, pen: &mut Pen<'_>, t: &TextObject, mut true } +/// The geometry of the line of `paragraph` from glyph `index`, placed at `position`: where it +/// ends with its trailing spaces trimmed, its hyphen, its room and margins, the glyphs that hang or +/// stay out of justification, and whether it is the paragraph's last line. fn prepare_line_geometry(cx: &Ctx<'_>, t: &TextObject, paragraph: &ParagraphData<'_, '_>, position: LinePosition, index: usize) -> LineGeometry { let para = paragraph.para; let sg = ¶graph.sg; @@ -571,7 +577,11 @@ fn prepare_line_geometry(cx: &Ctx<'_>, t: &TextObject, paragraph: &ParagraphData // Justification adds nothing to the list marker's glyphs. let mut held = held; held.extend(index..paragraph.marker.min(body)); - let last_of_para = position.end >= n || position.end.checked_sub(1).and_then(|i| sg.get(i)).is_some_and(|g| g.ch == '\u{2028}'); + // A line a soft return ends is justified as a wrapped one is: only the paragraph's last line + // keeps the alignment of Justify Left, Center or Right. A paragraph that ends in a soft return + // ends with the empty line after it (`run_paragraph_lines`). + let soft_return = position.end > index && sg.get(position.end - 1).is_some_and(|g| g.ch == '\u{2028}'); + let last_of_para = position.end >= n && !soft_return; LineGeometry { position, index, @@ -631,6 +641,9 @@ fn flow_line_flex(glyph: usize, flex: &[Flex], held: &[usize], hung: &[usize]) - value } +/// How `line` of `paragraph` is aligned: where it starts, what justification adds to its spaces, +/// gaps and glyphs, its kashidas, and, in right-aligned area type, its last tab, which takes the +/// text after it to the right edge. fn justify_flow_line(cx: &Ctx<'_>, paragraph: &ParagraphData<'_, '_>, line: &LineGeometry) -> LineJustification { let para = paragraph.para; let sg = ¶graph.sg; @@ -718,7 +731,14 @@ fn justify_flow_line(cx: &Ctx<'_>, paragraph: &ParagraphData<'_, '_>, line: &Lin } } let position = &line.position; - let start_x = if justify || pushed_in { + // Right-aligned area type with a tab: the text before the last tab sits at its stops, from the + // left edge, and the text after it against the right edge, as Illustrator's own layout in a + // user's `.ai` sets a price list. Centred and justified lines are aligned as a whole. + let last_tab = (para.justify == Justify::Right && !justify && !paragraph.rtl && paragraph.regions.is_some()) + // A tab ending the line counts: its text sits at the left edge, the tab up to the right one. + .then(|| (line.index..line.position.end).rev().find(|&j| sg.get(j).is_some_and(|g| g.ch == '\t' && g.len > 0))) + .flatten(); + let start_x = if justify || pushed_in || last_tab.is_some() { line.ax0 - line.opt_l } else if paragraph.regions.is_none() { match align { @@ -733,9 +753,43 @@ fn justify_flow_line(cx: &Ctx<'_>, paragraph: &ParagraphData<'_, '_>, line: &Lin _ => line.ax1 + line.opt_r - width, } }; - LineJustification { per_space, per_gap, per_cjk, squeeze, fit, start_x, after, kashidas } + LineJustification { per_space, per_gap, per_cjk, squeeze, fit, start_x, after, kashidas, last_tab } } +/// The advance and leader of tab `glyph_index` of `line`, at pen position `x`: up to its stop +/// ([`tab_advance`], measured from `tab_origin` less `tab_shift`), or, for the last tab of +/// right-aligned area type ([`LineJustification::last_tab`]), up to where the rest of the line +/// ends on the right edge. The tab after a list marker keeps the width `prepend_marker` gave it +/// (`advance`). +fn tab_glyph<'p>( + paragraph: &'p ParagraphData<'_, '_>, + line: &LineGeometry, + justification: &LineJustification, + glyph_index: usize, + x: f64, + (tab_origin, tab_shift): (f64, f64), + advance: f64, +) -> (f64, &'p str) { + let sg = ¶graph.sg; + // The tab of a list marker keeps the width `prepend_marker` gave it. + if !sg.get(glyph_index).is_some_and(|g| g.len > 0) { + return (advance, ""); + } + let (advance, leader) = tab_advance(¶graph.para.tabs, tab_origin, x - tab_shift, sg.get(glyph_index + 1..line.trimmed).unwrap_or_default()); + if justification.last_tab != Some(glyph_index) { + return (advance, leader); + } + // The width of what follows up to the line's end (nothing, when the tab ends the line), with + // the hyphen a hyphenated line ends with. + let after = sg.get(glyph_index + 1..line.trimmed).unwrap_or_default(); + let hyphen = line.hyphen.as_ref().map_or(0.0, |g| g.adv); + let rest = if after.is_empty() { 0.0 } else { after.iter().map(|g| g.adv).sum::() - line.end_trim + hyphen }; + ((line.ax1 + line.opt_r - rest - x).max(0.0), leader) +} + +/// Lay out `line` of `paragraph` as `justification` aligns it: each glyph placed along the +/// baseline (tabs as [`tab_glyph`] sets them), its hyphen, and the line's record, then the pen +/// moved on past it. fn emit_flow_line(cx: &mut Ctx<'_>, pen: &mut Pen<'_>, paragraph: &ParagraphData<'_, '_>, line: &LineGeometry, justification: &LineJustification) { let para = paragraph.para; let sg = ¶graph.sg; @@ -775,10 +829,7 @@ fn emit_flow_line(cx: &mut Ctx<'_>, pen: &mut Pen<'_>, paragraph: &ParagraphData let mut scale = 1.0; let mut leader = ""; if glyph.ch == '\t' { - // The tab of a list marker keeps the width `prepend_marker` gave it. - if glyph.len > 0 { - (advance, leader) = tab_advance(¶.tabs, tab_origin, x - tab_shift, &sg[glyph_index + 1..trimmed.max(glyph_index + 1)]); - } + (advance, leader) = tab_glyph(paragraph, line, justification, glyph_index, x, (tab_origin, tab_shift), advance); } else if glyph_index < body { let flex = flow_line_flex(glyph_index, ¶graph.flex, &line.held, &line.hung); if is_word_space(glyph) { diff --git a/crates/text/src/lib.rs b/crates/text/src/lib.rs index dad7f0a6f..27d35c170 100644 --- a/crates/text/src/lib.rs +++ b/crates/text/src/lib.rs @@ -47,7 +47,7 @@ pub use svg_glyph::{SvgGlyphReader, set_svg_glyph_reader}; pub use kept::{KeptLayoutsFrame, LayoutStamp, keep_layout, take_kept_layout}; use kurbo::{Affine, BezPath, Point, Rect, Shape, Vec2}; -pub use layout::{decorations, fit_first_line, layout, layout_with, scaled}; +pub use layout::{decorations, fit_first_line, fit_source_lines, layout, layout_with, scaled}; pub use vectorcraft_doc::TextObject; pub use vectorcraft_doc::{AreaFit, FirstBaseline, TextFlow, VerticalAlign}; diff --git a/crates/text/src/tests.rs b/crates/text/src/tests.rs index 1338e08db..68fe65528 100644 --- a/crates/text/src/tests.rs +++ b/crates/text/src/tests.rs @@ -306,6 +306,39 @@ fn area_alignment_and_justify() { assert!((l.lines[0].x1 - frame.x1).abs() < 1e-6); } +/// A source that sets a last line whose descent passes its frame's bottom: the frame grows from its +/// bottom by its lines' deepest descent plus 0.05 pt, so that line shows, and only as many lines as +/// the source has. +#[test] +fn fit_source_lines_keeps_the_last_lines_the_source_sets() { + let text = "one\ntwo\nthree"; + let tall = layout(db(), &area(text, style(12.0), Rect::new(0.0, 0.0, 200.0, 400.0), Justify::Left)); + let third = &tall.lines[2]; + // The third baseline is in the frame, its descent isn't. + let frame = Rect::new(0.0, 0.0, 200.0, third.baseline + third.descent / 2.0); + let mut t = area(text, style(12.0), frame, Justify::Left); + let short = layout(db(), &t); + assert!(short.overflow && short.lines.len() == 2); + // A source with no more lines than fit leaves the frame as it is. + assert!(!fit_source_lines(db(), &mut t, 2)); + assert_eq!(layout(db(), &t).lines.len(), 2); + assert!(fit_source_lines(db(), &mut t, 3)); + let fitted = layout(db(), &t); + assert!(!fitted.overflow && fitted.lines.len() == 3); + let TextKind::Area { frame: grown } = &t.kind else { panic!("area type") }; + let grown = grown.bounds().unwrap(); + assert!(grown.y0 == frame.y0 && grown.y1 > frame.y1 && grown.y1 <= frame.y1 + third.descent + 0.1, "{grown:?}"); + // Fitted, nothing more to do. + assert!(!fit_source_lines(db(), &mut t, 3)); + // More than a descent short: a line the source can't have set in its frame stays out. + let frame = Rect::new(0.0, 0.0, 200.0, tall.lines[1].baseline + tall.lines[1].descent + 1.0); + let mut t = area(text, style(12.0), frame, Justify::Left); + assert!(!fit_source_lines(db(), &mut t, 3)); + // Point type and vertical type aren't fitted. + let mut p = point(text, style(12.0)); + assert!(!fit_source_lines(db(), &mut p, 9)); +} + #[test] fn indents_and_paragraph_spacing() { let frame = Rect::new(0.0, 0.0, 200.0, 400.0); @@ -880,12 +913,67 @@ fn a_leading_tab_takes_its_width_in_the_line_and_the_justification() { } } +/// Right-aligned area type with tabs: the text before the last tab sits at its stops, measured from +/// the frame's left edge, and the text after the last tab against the right edge, as Illustrator's +/// own layout in a user's `.ai` (used locally, not committed) sets a list of an item and two +/// prices: with a right stop at 269.29 and a left one at 272.13, the item starts at 0, the first +/// price ends at 269.29 and the second ends on the edge. +#[test] +fn right_aligned_area_type_sets_the_text_after_its_last_tab_against_the_edge() { + use vectorcraft_doc::{TabAlign, TabStop}; + let stop = |position: f64, align: TabAlign| TabStop { position, align, leader: String::new(), align_on: '.' }; + let frame = Rect::new(0.0, 0.0, 336.0, 100.0); + let mut t = area("Item\t12.50\t24.00", style(13.0), frame, Justify::Right); + t.para.tabs = vec![stop(269.29, TabAlign::Right), stop(272.13, TabAlign::Left)]; + let lay = layout(db(), &t); + let glyph = |byte: usize| lay.glyphs.iter().find(|g| g.byte == byte).unwrap(); + let end = |byte: usize| glyph(byte).origin.x + glyph(byte).advance; + assert!(glyph(0).origin.x.abs() < 1e-6, "the item starts at the left edge: {}", glyph(0).origin.x); + let first_price_end = "Item\t12.50".len() - 1; + assert!((end(first_price_end) - 269.29).abs() < 1e-6, "the first price ends on its right stop: {}", end(first_price_end)); + let last = t.plain_text().len() - 1; + assert!((end(last) - 336.0).abs() < 1e-6, "the last price ends on the edge: {}", end(last)); + // One tab: the text after it is against the edge, whatever its stop. + let mut one = area("Another item\t8.00", style(13.0), frame, Justify::Right); + one.para.tabs = t.para.tabs.clone(); + let lay = layout(db(), &one); + let first = lay.glyphs.first().unwrap(); + let last = lay.glyphs.last().unwrap(); + assert!( + first.origin.x.abs() < 1e-6 && (last.origin.x + last.advance - 336.0).abs() < 1e-6, + "{} {}", + first.origin.x, + last.origin.x + last.advance + ); + // A tab ending the line (a heading in the user's file): the text before it at the left edge, + // the tab to the right edge. + let lay = layout(db(), &area("Heading\t\nNext", style(13.0), frame, Justify::Right)); + assert!(lay.glyphs.first().unwrap().origin.x.abs() < 1e-6, "{}", lay.glyphs.first().unwrap().origin.x); + let tab = lay.glyphs.iter().find(|g| g.byte == 7).unwrap(); + assert!((tab.origin.x + tab.advance - 336.0).abs() < 1e-6, "the tab ends at {}", tab.origin.x + tab.advance); + // Text after the last tab that breaks with a hyphen: the hyphen ends on the edge too. + let text = "A\tinternationalization"; + let mut hyphenated = area(text, style(13.0), Rect::new(0.0, 0.0, 100.0, 200.0), Justify::Right); + hyphenated.para.hyphenate = true; + hyphenated.para.composer = vectorcraft_doc::Composer::SingleLine; + let lay = layout(db(), &hyphenated); + let line = &lay.lines[0]; + assert!(line.end > 2 && line.end < text.len(), "the first line breaks inside the word: {line:?}"); + let last = lay.glyphs.get(line.glyph_end - 1).unwrap(); + assert!((last.origin.x + last.advance - 100.0).abs() < 1e-6, "the hyphen ends at {}", last.origin.x + last.advance); + // Without a tab, the line is right aligned as a whole. + let lay = layout(db(), &area("Name", style(13.0), frame, Justify::Right)); + assert!(lay.glyphs.first().unwrap().origin.x > 200.0); +} + #[test] fn a_centred_or_right_aligned_line_sets_its_tabs_as_if_it_started_at_the_left() { use vectorcraft_doc::{TabAlign, TabStop}; // "AB" with a stop at 100 pt is 100 pt plus B wide whatever the alignment: the whole line // moves, the gap between A and B stays 100 pt, and a right aligned line ends on the edge (#2457). - for justify in [Justify::Center, Justify::Right, Justify::JustifyCenter, Justify::JustifyRight] { + // (Right aligned area type sets the text after its last tab against the edge instead: see + // `right_aligned_area_type_sets_the_text_after_its_last_tab_against_the_edge`.) + for justify in [Justify::Center, Justify::JustifyCenter, Justify::JustifyRight] { let mut t = area("A\tB", style(12.0), Rect::new(0.0, 0.0, 200.0, 100.0), justify); t.para.tabs = vec![TabStop { position: 100.0, align: TabAlign::Left, leader: String::new(), align_on: '.' }]; let lay = layout(db(), &t); diff --git a/crates/text/src/tests/typo.rs b/crates/text/src/tests/typo.rs index 4791347d0..4b8bdbc09 100644 --- a/crates/text/src/tests/typo.rs +++ b/crates/text/src/tests/typo.rs @@ -1970,14 +1970,28 @@ fn soft_return_breaks_line_without_new_paragraph() { assert_eq!(&t.plain_text()[l1.start..l1.end], "Line 2"); } +/// A line ending in a soft return is justified as a wrapped line is: only the paragraph's last +/// line keeps its alignment. Illustrator's own layout in a user's `.ai` (used locally, not +/// committed) spreads such lines to the frame's edge. #[test] -fn soft_return_in_justified_text_does_not_spread() { - let text = "Short\u{2028}A much longer second line of text inside the frame."; - let t = area(text, style(12.0), Rect::new(0.0, 0.0, 300.0, 200.0), Justify::JustifyLeft); - let lay = layout(db(), &t); - assert!(lay.lines.len() >= 2); - let l0 = &lay.lines[0]; - assert!(l0.x1 - l0.x0 < 100.0, "short line ending with soft return is not justified: {}", l0.x1 - l0.x0); +fn soft_return_in_justified_text_spreads_like_a_wrapped_line() { + let frame = Rect::new(0.0, 0.0, 300.0, 200.0); + let text = "A line of a few words\u{2028}and the last line."; + for justify in [Justify::JustifyLeft, Justify::JustifyCenter, Justify::JustifyRight] { + let lay = layout(db(), &area(text, style(12.0), frame, justify)); + assert_eq!(lay.lines.len(), 2); + let (l0, l1) = (&lay.lines[0], &lay.lines[1]); + assert!((l0.x0 - frame.x0).abs() < 1e-6 && (l0.x1 - frame.x1).abs() < 1e-6, "{justify:?}: {l0:?}"); + assert!(l1.x1 - l1.x0 < 200.0, "{justify:?}: the last line isn't justified: {l1:?}"); + // A soft return ending the paragraph: the empty line after it is the last one, so the line + // it ends is justified too. + let lay = layout(db(), &area("A line of a few words\u{2028}", style(12.0), frame, justify)); + let l0 = lay.lines.first().unwrap(); + assert!((l0.x0 - frame.x0).abs() < 1e-6 && (l0.x1 - frame.x1).abs() < 1e-6, "{justify:?}, trailing soft return: {l0:?}"); + } + // Aligned type stays aligned. + let lay = layout(db(), &area(text, style(12.0), frame, Justify::Left)); + assert!(lay.lines[0].x1 < frame.x1 - 100.0); } #[test] diff --git a/crates/tools/src/builder.rs b/crates/tools/src/builder.rs index 96e3333a9..b8e5840c2 100644 --- a/crates/tools/src/builder.rs +++ b/crates/tools/src/builder.rs @@ -32,7 +32,7 @@ mod live_paint; mod lookup; mod map; -use cache::RegionCache; +use cache::{BACKGROUND_SEGMENTS, CacheKey, RegionCache}; #[cfg(test)] use live_paint::LpHover; use live_paint::lp_color; @@ -45,7 +45,10 @@ pub use lookup::{ is_live_paint, leaf_shapes, live_paint_at, live_paint_takes, node_outline, outline_snap, path_contains, shape_builder_shapes, shapes_for, sources, visible_edge_near, visible_face_at, }; -pub use map::{BuilderMap, HATCH, HIGHLIGHT_RED, Hit, Touched, hatch, maps_built, sample_polyline, sorted_roots}; +pub use map::{ + BuilderMap, HATCH, HIGHLIGHT_RED, Hit, MergeGeometry, MergeInput, PreparedMerge, Rest, Touched, hatch, maps_built, merge_geometry, merge_inputs, + merges_computed, sample_polyline, sorted_roots, +}; /// Small, Medium and Large gap lengths in points. pub const GAP_LENGTHS: [f64; 3] = [3.0, 6.0, 12.0]; @@ -169,6 +172,52 @@ pub struct ShapeBuilderTool { /// The pointer went more than [`CLICK_TOL_PX`] from the press during the drag, so the gesture /// is not a click. far: bool, + /// The merge of the last gesture over a large selection, being computed on another thread. + merging: Option, + /// That merge once computed, for `shapeBuilder.merge` ([`Tool::shape_builder_merge`]). + prepared: Option>, + /// A gesture made while the map of a large selection is being built on another thread. + deferred: Option, +} + +/// A Shape Builder gesture made while the map of the selection was being built on another +/// thread: the map key and the inputs it was made over, its pointer events, which [`Tool::poll`] +/// replays once the map is there, and whether the release has come. +struct Deferred { + key: CacheKey, + shapes: Vec, + events: Vec, + released: bool, +} + +/// A Shape Builder merge being computed on another thread: the map key it is for (the document, +/// its revision and the selection), the `shapeBuilder.merge` params that apply it, what it was +/// computed from, and the channel the result arrives on. +struct PendingMerge { + key: CacheKey, + params: Value, + map: Arc, + touched: Touched, + gap: f64, + inputs: Vec, + done: Receiver, +} + +/// Computes [`merge_geometry`] on a new thread; None when no thread starts. +#[cfg(not(target_arch = "wasm32"))] +fn spawn_merge(map: Arc, touched: Touched, gap: f64, inputs: Vec) -> Option> { + let (tx, done) = std::sync::mpsc::channel(); + let spawned = std::thread::Builder::new().name("vectorcraft-shape-builder-merge".into()).spawn(move || { + // The tool may have dropped the receiver meanwhile (another tool, another document). + let _ = tx.send(merge_geometry(&map, &touched, gap, &inputs)); + }); + spawned.is_ok().then_some(done) +} + +/// The web build has no threads: the merge runs in the command. +#[cfg(target_arch = "wasm32")] +fn spawn_merge(_map: Arc, _touched: Touched, _gap: f64, _inputs: Vec) -> Option> { + None } /// How close (screen px) the pointer must come to a line piece or an edge to delete it. @@ -213,6 +262,132 @@ impl ShapeBuilderTool { alt.then(|| cx.tol(LINE_TOL_PX)) } + /// Starts computing the merge `params` describe on another thread when the map of the + /// selection is current and has more than [`BACKGROUND_SEGMENTS`] segments; `false` when it + /// did not (small selections, the web build), and the command computes it. + fn start_merge(&mut self, cx: &ToolContext, params: &Value) -> bool { + let key = RegionCache::key_for(cx, self.opts.open_filled_as_closed); + if cfg!(target_arch = "wasm32") || params.get("splitStroke").is_some() || self.cache.key.as_ref() != Some(&key) { + return false; + } + let map = Arc::clone(&self.cache.map); + let segments: usize = map.shapes.iter().map(|s| s.path.subpaths.iter().map(|sp| sp.segment_count()).sum::()).sum(); + if segments <= BACKGROUND_SEGMENTS { + return false; + } + // What the command reads from its params, read the same way. + let num = |v: &Value| v.as_f64().unwrap_or(f64::NAN); + let pts: Vec = params["points"].as_array().map(|a| a.iter().map(|q| Point::new(num(&q[0]), num(&q[1]))).collect()).unwrap_or_default(); + let marquee = params["rect"].as_array().filter(|r| r.len() == 4).map(|r| { + let (x, y) = (num(&r[0]), num(&r[1])); + (Point::new(x, y), Point::new(x + num(&r[2]), y + num(&r[3]))) + }); + let piece_tol = (params["erase"] == json!(true)).then(|| params["tolerance"].as_f64().unwrap_or(2.0).clamp(0.0, 1000.0)); + let touched = map.merge_touched(&pts, marquee, piece_tol); + if touched.is_empty() { + return false; + } + let roots = sorted_roots(cx.doc, &cx.selection.objects); + let (_, leaves) = shape_builder_shapes(cx.doc, &roots, self.opts.open_filled_as_closed); + let inputs = merge_inputs(&leaves, self.opts.open_filled_as_closed); + let gap = self.gap(); + let Some(done) = spawn_merge(Arc::clone(&map), touched.clone(), gap, inputs.clone()) else { return false }; + self.merging = Some(PendingMerge { key, params: params.clone(), map, touched, gap, inputs, done }); + true + } + + /// Takes the merge being computed on another thread once it has arrived, or with `wait` once + /// it arrives: the action that applies it, while the document, the selection and its inputs are + /// those it was computed for. When one of them changed (an edit or a selection made other than + /// by a command, which applies the merge first), the merge is dropped at once, without waiting + /// for the thread. A copy of the document (a save stamping its dates) and a new revision that leaves + /// the inputs as they were keep the merge. When the thread failed, the command computes the + /// merge and reports what went wrong. + fn poll_merge(&mut self, cx: &ToolContext, wait: bool) -> Vec { + let Some(mut m) = self.merging.take() else { return vec![] }; + let now = RegionCache::key_for(cx, m.key.3); + if (now.1.0, &now.2) != (m.key.1.0, &m.key.2) { + return vec![]; + } + // A new revision that leaves the selection's inputs as they were (a view setting or a + // preference that redraws the document) keeps the merge. + if now.1 != m.key.1 { + if !self.inputs_are(cx, m.key.3, &m.map.shapes) { + return vec![]; + } + m.key = now; + } + let got = if wait { m.done.recv().map_err(|_| TryRecvError::Disconnected) } else { m.done.try_recv() }; + let geometry = match got { + Ok(g) => Some(g), + Err(TryRecvError::Empty) => { + self.merging = Some(m); + return vec![]; + } + Err(TryRecvError::Disconnected) => None, + }; + self.prepared = geometry.map(|geometry| Arc::new(PreparedMerge { map: m.map, touched: m.touched, gap: m.gap, inputs: m.inputs, geometry })); + vec![Action::Exec("shapeBuilder.merge".into(), m.params)] + } + + /// Is the map of the selection being built on another thread (it is not current yet)? + fn map_building(&mut self, cx: &ToolContext) -> bool { + self.cache.ready(cx, self.opts.open_filled_as_closed).is_none() && self.cache.pending.is_some() + } + + /// Are the inputs of the selection in `cx` `shapes`? The map, or the map being built, is filed + /// under the key of `cx` first when they are its inputs ([`RegionCache::rekey`]). + fn inputs_are(&mut self, cx: &ToolContext, open_filled_as_closed: bool, shapes: &[po::Shape]) -> bool { + let _ = self.cache.rekey(cx, open_filled_as_closed); + let key = RegionCache::key_for(cx, open_filled_as_closed); + if self.cache.key.as_ref() == Some(&key) { + return self.cache.shapes == shapes; + } + if let Some(p) = self.cache.pending.as_ref().filter(|p| p.key == key) { + return p.shapes == shapes; + } + let roots = sorted_roots(cx.doc, &cx.selection.objects); + shape_builder_shapes(cx.doc, &roots, open_filled_as_closed).0 == shapes + } + + /// Is a gesture made while the map was being built released and waiting for the map? + fn deferred_released(&self) -> bool { + self.deferred.as_ref().is_some_and(|d| d.released) + } + + /// Replays the released gesture made while the map was being built once the map is there, or + /// with `wait` once it is built, and with `wait` also waits for the merge it starts: the + /// actions the gesture gives. When the document, the selection or its inputs changed since the + /// gesture, it is dropped; a new revision that leaves them as they were keeps it. + fn replay_deferred(&mut self, cx: &ToolContext, wait: bool) -> Vec { + if !self.deferred_released() { + return vec![]; + } + let ofac = self.opts.open_filled_as_closed; + let now = RegionCache::key_for(cx, ofac); + if let Some(mut d) = self.deferred.take() { + if (d.key.1.0, &d.key.2) != (now.1.0, &now.2) || (d.key.1 != now.1 && !self.inputs_are(cx, ofac, &d.shapes)) { + return vec![]; + } + d.key = now; + self.deferred = Some(d); + } + if wait { + self.cache.get(cx, self.opts.open_filled_as_closed); + } else if self.map_building(cx) { + return vec![]; + } + let Some(d) = self.deferred.take() else { return vec![] }; + let mut acts = vec![]; + for ev in &d.events { + acts.extend(self.pointer(cx, ev)); + } + if wait { + acts.extend(self.poll_merge(cx, true)); + } + acts + } + /// Adds what the drag from `from` to `to` touches, picked as `shapeBuilder.merge` picks it. fn touch(&mut self, cx: &ToolContext, from: Option, to: Point) { let pts: Vec = from.into_iter().chain([to]).collect(); @@ -274,6 +449,8 @@ impl Tool for ShapeBuilderTool { fn pointer(&mut self, cx: &ToolContext, ev: &PointerEvent) -> Vec { let p = ev.pos; + // The command has taken the merge computed for the last gesture by now. + self.prepared = None; match ev.kind { PointerKind::Move => { self.alt = ev.mods.alt; @@ -282,7 +459,8 @@ impl Tool for ShapeBuilderTool { vec![] } PointerKind::Down => { - if cx.selection.is_empty() { + // While a merge is being computed, a press starts no gesture. + if cx.selection.is_empty() || self.editing() { return vec![]; } self.dragging = true; @@ -291,11 +469,35 @@ impl Tool for ShapeBuilderTool { self.points = vec![p]; self.far = false; self.touched = Touched::default(); + // While the map is being built on another thread, the gesture is recorded and + // replayed once the map is there. + if self.map_building(cx) { + let key = RegionCache::key_for(cx, self.opts.open_filled_as_closed); + let shapes = match self.cache.pending.as_ref().filter(|p| p.key == key) { + Some(p) => p.shapes.clone(), + None => self.cache.inputs(cx, self.opts.open_filled_as_closed).0, + }; + self.deferred = Some(Deferred { key, shapes, events: vec![*ev], released: false }); + return vec![]; + } self.touch(cx, None, p); vec![] } PointerKind::Drag if self.dragging => { self.at = Some(p); + if let Some(d) = &mut self.deferred { + // The drag's line or marquee shows meanwhile. + d.events.push(*ev); + if let Some((a, _)) = self.marquee { + self.marquee = Some((a, p)); + } else if self.opts.straight_line { + self.points.truncate(1); + self.points.push(p); + } else if self.points.last().is_none_or(|q| q.distance(p) >= cx.tol(1.0)) { + self.points.push(p); + } + return vec![]; + } if self.points.first().is_some_and(|s| s.distance(p) > cx.tol(CLICK_TOL_PX)) { self.far = true; } @@ -316,6 +518,13 @@ impl Tool for ShapeBuilderTool { } PointerKind::Up if self.dragging => { self.dragging = false; + if let Some(d) = &mut self.deferred { + d.events.push(*ev); + d.released = true; + self.points.clear(); + self.marquee = None; + return vec![]; + } if self.marquee.is_some() { self.marquee_to(cx, p); } else if self.opts.straight_line { @@ -361,6 +570,10 @@ impl Tool for ShapeBuilderTool { if self.opts.swatches { params["pickColorFrom"] = json!("swatches"); } + // A large selection's merge is computed on another thread; `poll` applies it. + if self.start_merge(cx, ¶ms) { + return vec![]; + } vec![Action::Exec("shapeBuilder.merge".into(), params)] } _ => vec![], @@ -369,10 +582,13 @@ impl Tool for ShapeBuilderTool { fn overlays(&self, cx: &ToolContext) -> Vec { let mut out = vec![]; - let map = &self.cache.map; - let color = if self.alt { HIGHLIGHT_RED } else { HATCH }; - let show: Vec = if self.dragging { - let t = &self.touched; + // While a merge is being computed, what its gesture touched stays highlighted. + let map = self.merging.as_ref().map_or(&self.cache.map, |m| &m.map); + // The mode of the gesture being merged, else the drag's or the hover's. + let alt = self.merging.as_ref().filter(|_| !self.dragging).map_or(self.alt, |m| m.params["erase"] == json!(true)); + let color = if alt { HIGHLIGHT_RED } else { HATCH }; + let touched = if self.dragging { Some(&self.touched) } else { self.merging.as_ref().map(|m| &m.touched) }; + let show: Vec = if let Some(t) = touched { let regions = t.regions.iter().map(|&i| Hit::Region(i)); regions.chain(t.lines.iter().map(|&i| Hit::Line(i))).chain(map.erased_edges(t).into_iter().map(Hit::Edge)).collect() } else { @@ -381,7 +597,7 @@ impl Tool for ShapeBuilderTool { for hit in show { match hit { // Highlight Fill off: merge mode leaves the regions as they are. - Hit::Region(_) if !self.alt && !self.opts.highlight_fill => {} + Hit::Region(_) if !alt && !self.opts.highlight_fill => {} Hit::Region(i) => { if let Some((_, bp, _)) = map.regions.get(i) { out.push(Overlay::Path { path: hatch(bp, cx.tol(4.0)), color, width: 1.0, dashed: false }); @@ -424,7 +640,10 @@ impl Tool for ShapeBuilderTool { fn cursor(&self, _cx: &ToolContext, _p: Point, m: Mods) -> Cursor { // A drag keeps the mode it started in; hovering follows the key. let erase = if self.dragging { self.alt } else { m.alt }; - if erase { + if self.editing() { + // The merge of the last gesture, or the map it waits for, is being computed. + Cursor::Busy + } else if erase { Cursor::ShapeBuilderErase } else if self.stroke.is_some() && !self.dragging { // Over a stroke a click splits. @@ -439,30 +658,53 @@ impl Tool for ShapeBuilderTool { } fn waiting(&self) -> bool { - self.cache.waiting() + self.cache.waiting() || self.merging.is_some() || self.deferred.is_some() } - fn poll(&mut self, cx: &ToolContext, wait: bool) { - if !self.cache.waiting() || self.dragging { - return; + fn editing(&self) -> bool { + self.merging.is_some() || self.deferred_released() + } + + fn finish_edit(&mut self, cx: &ToolContext) -> Vec { + let mut acts = self.replay_deferred(cx, true); + acts.extend(self.poll_merge(cx, true)); + acts + } + + /// Choosing another tool or another document applies the merge being computed first. + fn deactivate(&mut self, cx: &ToolContext) -> Vec { + self.finish_edit(cx) + } + + fn poll(&mut self, cx: &ToolContext, wait: bool) -> Vec { + let mut acts = self.poll_merge(cx, wait); + if !acts.is_empty() || self.dragging { + return acts; } // The map that arrives may be for an earlier revision; the hover then starts the current // one's, which `wait` waits for too. - loop { + while self.cache.waiting() { self.cache.settle(wait); if let Some(p) = self.at { self.hover_at(cx, p); } - if !wait || !self.cache.waiting() { + if !wait { break; } } + // A gesture made while the map was being built goes on once it is there. + acts.extend(self.replay_deferred(cx, wait)); + acts } fn shape_builder_map(&self) -> Option<(Arc, f64)> { self.cache.key.is_some().then(|| (Arc::clone(&self.cache.map), self.cache.gap)) } + fn shape_builder_merge(&self) -> Option> { + self.prepared.clone() + } + /// With Pick Color From Color Swatches, the Left and Right arrow keys pick the color swatch /// before or after the current fill. Escape during a drag cancels it: the release after it /// merges and deletes nothing. @@ -471,13 +713,16 @@ impl Tool for ShapeBuilderTool { } fn key(&mut self, cx: &ToolContext, key: ToolKey, _mods: Mods) -> Vec { - if !self.claims_key(cx, key) { + // While a merge is being computed, the arrows leave the current fill it takes as it was. + if !self.claims_key(cx, key) || self.editing() { return vec![]; } if key == ToolKey::Escape { self.dragging = false; self.points.clear(); self.touched = Touched::default(); + // A gesture recorded while the map is being built is canceled with it. + self.deferred = None; (self.marquee, self.hover, self.far) = (None, None, false); return vec![]; } diff --git a/crates/tools/src/builder/cache.rs b/crates/tools/src/builder/cache.rs index f34a29000..4b38fe1b7 100644 --- a/crates/tools/src/builder/cache.rs +++ b/crates/tools/src/builder/cache.rs @@ -8,18 +8,21 @@ pub(super) type CacheKey = (usize, (u64, u64), Vec, bool); /// Hovering builds the map of inputs with more segments than this on another thread /// ([`RegionCache::ready`]); smaller maps are built on the calling thread. -const BACKGROUND_SEGMENTS: usize = 128; +pub(super) const BACKGROUND_SEGMENTS: usize = 128; -/// A map being built on another thread: the key it is for, the drawn outlines of its inputs, and -/// the channel it arrives on. -struct Pending { - key: CacheKey, +/// A map being built on another thread: the key it is for, its inputs and their drawn outlines, +/// and the channel it arrives on. +pub(super) struct Pending { + pub(super) key: CacheKey, + pub(super) shapes: Vec, outlines: Vec, done: Receiver, } /// The planar map of the current selection, cached by document identity, revision, selection and -/// whether filled open paths count as closed. +/// whether filled open paths count as closed. When only the document's identity or revision +/// changed and the selection's inputs did not (a view setting, a preference, a copy of the +/// document), the map is kept under the new key ([`RegionCache::rekey`]). #[derive(Default)] pub(super) struct RegionCache { pub(super) key: Option, @@ -31,8 +34,12 @@ pub(super) struct RegionCache { pub(super) gap: f64, /// The outlines of the Shape Builder's inputs as they are drawn (see [`BuilderMap::stroke_at`]). pub(super) outlines: Vec, + /// The inputs the map was built from. + pub(super) shapes: Vec, + /// The last key whose inputs [`Self::rekey`] compared with the map's. + compared: Option, /// The map being built on another thread, if any. - pending: Option, + pub(super) pending: Option, /// The key of the last map whose build on another thread failed. failed: Option, /// How many times the map has been built. @@ -76,13 +83,13 @@ impl RegionCache { Self { live: true, ..Default::default() } } - fn key_for(cx: &ToolContext, open_filled_as_closed: bool) -> CacheKey { + pub(super) fn key_for(cx: &ToolContext, open_filled_as_closed: bool) -> CacheKey { (cx.doc as *const Document as usize, cx.revision, cx.selection.objects.clone(), open_filled_as_closed) } /// The inputs of the selection's map, back → front, and their drawn outlines (Shape Builder /// only). - fn inputs(&self, cx: &ToolContext, open_filled_as_closed: bool) -> (Vec, Vec) { + pub(super) fn inputs(&self, cx: &ToolContext, open_filled_as_closed: bool) -> (Vec, Vec) { let roots = sorted_roots(cx.doc, &cx.selection.objects); if self.live { (shapes_for(cx.doc, &roots).0, vec![]) @@ -93,8 +100,9 @@ impl RegionCache { } } - fn install(&mut self, key: CacheKey, map: BuilderMap, outlines: Vec) { + fn install(&mut self, key: CacheKey, map: BuilderMap, shapes: Vec, outlines: Vec) { self.map = Arc::new(map); + self.shapes = shapes; self.outlines = outlines; self.key = Some(key); #[cfg(test)] @@ -122,8 +130,12 @@ impl RegionCache { pub(super) fn get(&mut self, cx: &ToolContext, open_filled_as_closed: bool) -> &BuilderMap { let key = Self::key_for(cx, open_filled_as_closed); if self.key.as_ref() != Some(&key) { - let built = self.pending.take().filter(|p| p.key == key).and_then(|p| Some((p.done.recv().ok()?, p.outlines))); - let (map, outlines) = match built { + let inputs = self.rekey(cx, open_filled_as_closed); + if self.key.as_ref() == Some(&key) { + return &self.map; + } + let built = self.pending.take().filter(|p| p.key == key).and_then(|p| Some((p.done.recv().ok()?, p.shapes, p.outlines))); + let (map, shapes, outlines) = match built { Some(b) => { #[cfg(test)] { @@ -132,15 +144,45 @@ impl RegionCache { b } None => { - let (shapes, outlines) = self.inputs(cx, open_filled_as_closed); - (build_map(shapes, self.live, self.gap), outlines) + let (shapes, outlines) = inputs.unwrap_or_else(|| self.inputs(cx, open_filled_as_closed)); + (build_map(shapes.clone(), self.live, self.gap), shapes, outlines) } }; - self.install(key, map, outlines); + self.install(key, map, shapes, outlines); } &self.map } + /// When the map, or the map being built, is for the selection of `cx` but for another revision + /// or address of the document, and the selection's inputs and their outlines are those it is + /// made from, files it under the key of `cx`: nothing it is made from changed. Returns the + /// inputs it computed when that did not file a map (they changed), for the caller to build + /// from. + pub(super) fn rekey(&mut self, cx: &ToolContext, open_filled_as_closed: bool) -> Option<(Vec, Vec)> { + let key = Self::key_for(cx, open_filled_as_closed); + let other = |k: &CacheKey| *k != key && (&k.2, k.3) == (&key.2, key.3); + if self.pending.as_ref().is_some_and(|p| p.key == key) { + return None; + } + let installed = self.key.as_ref().is_some_and(other); + let building = self.pending.as_ref().is_some_and(|p| other(&p.key)); + // The inputs are compared once for each key. + if (!installed && !building) || self.compared.as_ref() == Some(&key) { + return None; + } + self.compared = Some(key.clone()); + let (shapes, outlines) = self.inputs(cx, open_filled_as_closed); + if installed && self.shapes == shapes && self.outlines == outlines { + self.key = Some(key); + return None; + } + if let Some(p) = self.pending.as_mut().filter(|p| other(&p.key) && p.shapes == shapes && p.outlines == outlines) { + p.key = key; + return None; + } + Some((shapes, outlines)) + } + /// Takes the map being built on another thread once it has arrived, or with `wait` once it /// arrives, as the map for the key it was built for. pub(super) fn settle(&mut self, wait: bool) { @@ -152,7 +194,7 @@ impl RegionCache { { self.background += 1; } - self.install(p.key, map, p.outlines); + self.install(p.key, map, p.shapes, p.outlines); } // The build failed (a bug in the planar map): hovering does not build it again, and a // gesture builds it on the calling thread, which reports the failure. @@ -171,21 +213,25 @@ impl RegionCache { if self.key.as_ref() == Some(&key) { return Some(&self.map); } + let inputs = self.rekey(cx, open_filled_as_closed); + if self.key.as_ref() == Some(&key) { + return Some(&self.map); + } if self.pending.is_some() || self.failed.as_ref() == Some(&key) { return None; } - let (shapes, outlines) = self.inputs(cx, open_filled_as_closed); + let (shapes, outlines) = inputs.unwrap_or_else(|| self.inputs(cx, open_filled_as_closed)); let segments: usize = shapes.iter().map(|s| s.path.subpaths.iter().map(|sp| sp.segment_count()).sum::()).sum(); if segments > BACKGROUND_SEGMENTS && cfg!(not(target_arch = "wasm32")) { - if let Some(done) = spawn_build(shapes, self.live, self.gap) { - self.pending = Some(Pending { key, outlines, done }); + if let Some(done) = spawn_build(shapes.clone(), self.live, self.gap) { + self.pending = Some(Pending { key, shapes, outlines, done }); return None; } // No thread started: build here. return Some(self.get(cx, open_filled_as_closed)); } - let map = build_map(shapes, self.live, self.gap); - self.install(key, map, outlines); + let map = build_map(shapes.clone(), self.live, self.gap); + self.install(key, map, shapes, outlines); Some(&self.map) } diff --git a/crates/tools/src/builder/live_paint.rs b/crates/tools/src/builder/live_paint.rs index f4c1ffd85..08fca1432 100644 --- a/crates/tools/src/builder/live_paint.rs +++ b/crates/tools/src/builder/live_paint.rs @@ -282,9 +282,9 @@ impl Tool for LivePaintBucketTool { self.cache.waiting() } - fn poll(&mut self, cx: &ToolContext, wait: bool) { + fn poll(&mut self, cx: &ToolContext, wait: bool) -> Vec { if !self.cache.waiting() { - return; + return vec![]; } // As the Shape Builder's: the map that arrives may be for an earlier revision. Over a part // of a Live Paint group the hover takes no map. @@ -297,6 +297,7 @@ impl Tool for LivePaintBucketTool { break; } } + vec![] } } diff --git a/crates/tools/src/builder/lookup.rs b/crates/tools/src/builder/lookup.rs index 99aeeb7aa..5e85d9339 100644 --- a/crates/tools/src/builder/lookup.rs +++ b/crates/tools/src/builder/lookup.rs @@ -284,4 +284,6 @@ pub(super) fn faces_of(regions: Vec) -> Vec { thread_local! { /// The Shape Builder maps built on this thread ([`maps_built`]). pub(super) static MAPS_BUILT: std::cell::Cell = const { std::cell::Cell::new(0) }; + /// The Shape Builder merges computed on this thread ([`merges_computed`]). + pub(super) static MERGES_COMPUTED: std::cell::Cell = const { std::cell::Cell::new(0) }; } diff --git a/crates/tools/src/builder/map.rs b/crates/tools/src/builder/map.rs index b1ccfa949..74ec31f69 100644 --- a/crates/tools/src/builder/map.rs +++ b/crates/tools/src/builder/map.rs @@ -1,4 +1,4 @@ -use super::lookup::{Face, MAPS_BUILT, faces_of, outline_snap, shape_builder_shapes}; +use super::lookup::{Face, MAPS_BUILT, MERGES_COMPUTED, faces_of, node_outline, outline_snap, shape_builder_shapes}; use super::*; /// Shape Builder hover hatch colour (neutral grey) and Live Paint highlight red. @@ -12,6 +12,12 @@ pub fn maps_built() -> usize { MAPS_BUILT.with(std::cell::Cell::get) } +/// How many Shape Builder merges ([`merge_geometry`]) this thread has computed, for tests that +/// count them. +pub fn merges_computed() -> usize { + MERGES_COMPUTED.with(std::cell::Cell::get) +} + /// The Shape Builder's planar map of a selection. #[derive(Default)] pub struct BuilderMap { @@ -345,6 +351,112 @@ impl BuilderMap { let bounds_one = |(e, _): &(po::Shape, Rect)| self.sides(e).iter().any(|r| r.is_some_and(|r| touched.regions.contains(&r))); touched.edges.iter().copied().filter(|&k| self.edges.get(k).is_some_and(|e| !bounds_one(e))).collect() } + + /// What `shapeBuilder.merge` touches: the regions the marquee from `marquee.0` to `marquee.1` + /// reaches, then what the drag along `pts` touches ([`Self::builder_hits_along`]), and the + /// edges that deletes ([`Self::erased_edges`]). + pub fn merge_touched(&self, pts: &[Point], marquee: Option<(Point, Point)>, piece_tol: Option) -> Touched { + let mut touched = Touched { regions: marquee.map(|(a, b)| self.regions_in_marquee(a, b)).unwrap_or_default(), ..Default::default() }; + touched.extend(&self.builder_hits_along(pts, piece_tol)); + touched.edges = self.erased_edges(&touched); + touched + } +} + +/// What a merge needs of each input besides the map: its outline as drawn ([`node_outline`]) and +/// whether its fill closes its open subpaths (Consider Open Filled Paths as Closed, and a fill). +#[derive(Clone, Debug, PartialEq)] +pub struct MergeInput { + pub outline: Option, + pub fill_closes: bool, +} + +/// The [`MergeInput`] of each of `leaves`. +pub fn merge_inputs(leaves: &[&Node], open_filled_as_closed: bool) -> Vec { + leaves + .iter() + .map(|l| MergeInput { outline: node_outline(l).map(|o| o.0), fill_closes: open_filled_as_closed && !l.appearance.fill_paint().is_none() }) + .collect() +} + +/// What is left of an input a merge or a delete changes: its faces not touched, united +/// (`united`), or its own outline, with the deleted edges cut out of it. +#[derive(Clone, Debug, PartialEq)] +pub struct Rest { + pub path: PathData, + pub united: bool, +} + +/// The new shapes of a Shape Builder merge or delete ([`merge_geometry`]). +#[derive(Clone, Debug, Default, PartialEq)] +pub struct MergeGeometry { + /// The union of the touched regions (empty when none is touched). + pub union: PathData, + /// For each closed input, what goes in its place when the gesture changes it. + pub rests: Vec>, +} + +/// The new shapes of a gesture over `map` that touched `touched`, closing gaps up to `gap`: the +/// union of the touched regions, and for each closed input that has a touched region or a deleted +/// edge, what is left of it. An input a touched region covers keeps its other faces, united +/// (they share their edges with the merged faces exactly, where subtracting the merged shape left +/// slivers of the outline along them, #569; a sliver goes in only where the input covers it and +/// the merged shape does not take it in); then each deleted edge is cut out of it. Inputs with +/// pieces of open paths (`map.lines`) are left to the caller. +pub fn merge_geometry(map: &BuilderMap, touched: &Touched, gap: f64, inputs: &[MergeInput]) -> MergeGeometry { + MERGES_COMPUTED.with(|n| n.set(n.get() + 1)); + let cuts: Vec<&SubPath> = touched.edges.iter().filter_map(|&k| map.edges.get(k)?.0.path.subpaths.first()).collect(); + let picked: Vec<&po::Region> = touched.regions.iter().filter_map(|&i| map.regions.get(i).map(|r| &r.0)).collect(); + let faces = po::FaceMerger::with_gap(&map.shapes, gap); + let union = if picked.is_empty() { PathData::default() } else { faces.merge(&picked) }; + let rests = map + .shapes + .iter() + .enumerate() + .map(|(i, sh)| { + let input = inputs.get(i)?; + let in_union = picked.iter().any(|r| r.sources.contains(&i)); + if map.lines.iter().any(|(l, _)| l.key == i as u64) || (!in_union && cuts.is_empty()) { + return None; + } + let mut rest = if in_union { + let kept: Vec<&po::Region> = map + .regions + .iter() + .enumerate() + .filter(|(k, (r, ..))| r.sources.contains(&i) && !touched.regions.contains(k)) + .map(|(_, (r, ..))| r) + .collect(); + if kept.is_empty() { PathData::default() } else { faces.merge_rest(i, &kept, &picked) } + } else { + input.outline.clone().unwrap_or_else(|| sh.path.clone()) + }; + // Edges come back from the planar map within a few hundredths of the outlines they + // follow, whatever else is selected. + let cut_tol = outline_snap(&sh.path); + let mut cut = false; + for piece in &cuts { + if let Some(r) = po::cut_out(&rest, piece, input.fill_closes, cut_tol) { + rest = r; + cut = true; + } + } + (in_union || cut).then_some(Rest { path: rest, united: in_union }) + }) + .collect(); + MergeGeometry { union, rests } +} + +/// A merge computed on another thread for a Shape Builder click or drag +/// ([`Tool::shape_builder_merge`]): the map, what the gesture touched and the inputs it was +/// computed from, and the result. `shapeBuilder.merge` takes the result when it would compute the +/// same. +pub struct PreparedMerge { + pub map: Arc, + pub touched: Touched, + pub gap: f64, + pub inputs: Vec, + pub geometry: MergeGeometry, } /// The regions, line pieces and edges a Shape Builder gesture has touched, in the order touched. diff --git a/crates/tools/src/builder/tests.rs b/crates/tools/src/builder/tests.rs index fc3ed294c..4e3919db8 100644 --- a/crates/tools/src/builder/tests.rs +++ b/crates/tools/src/builder/tests.rs @@ -132,20 +132,34 @@ fn shape_builder_builds_its_map_once_for_hover_alt_hover_and_a_merge() { // The merge left the document as it was (it failed, say): the map still fits it. t.pointer(&cx1, &ev(PointerKind::Move, 75.0, 75.0)); assert_eq!(t.cache.builds, 1, "a hover after a merge that changed nothing"); + // A new revision of the same art (a view setting, a preference) keeps the map. let cx2 = ToolContext { revision: (1, 2), ..cx(&d, &s, &p) }; t.pointer(&cx2, &ev(PointerKind::Move, 75.0, 75.0)); - assert_eq!(t.cache.builds, 2, "a hover on a new revision"); + assert_eq!(t.cache.builds, 1, "a hover on a new revision of the same art"); + assert!(matches!(t.hover, Some(Hit::Region(_))), "{:?}", t.hover); + // The same objects, one of them moved. + let mut moved = d.clone(); + let second = s.objects[1]; + moved.node_mut(second).unwrap().transform(vectorcraft_geom::Affine::translate((10.0, 0.0)), false); + let cx3 = ToolContext { revision: (1, 3), ..cx(&moved, &s, &p) }; + t.pointer(&cx3, &ev(PointerKind::Move, 75.0, 75.0)); + assert_eq!(t.cache.builds, 2, "a hover on a new revision of other art"); } /// A row of `n` selected squares 20 pt wide, each overlapping the next by half: 4 segments each. fn square_row(n: usize) -> (Document, Selection) { + square_row_at(n, 0.0) +} + +/// [`square_row`] with the squares' tops at `y`: the same objects, moved. +fn square_row_at(n: usize, y: f64) -> (Document, Selection) { let mut d = Document::new(500.0, 500.0); let l = d.layers[0].id; let mut s = Selection::default(); for k in 0..n { let x = k as f64 * 10.0; let id = d.alloc_id(); - d.insert(Some(l), k, Node::path(id, shapes::rectangle(Rect::new(x, 0.0, x + 20.0, 20.0)), Appearance::default_art())).unwrap(); + d.insert(Some(l), k, Node::path(id, shapes::rectangle(Rect::new(x, y, x + 20.0, y + 20.0)), Appearance::default_art())).unwrap(); s.add(id); } (d, s) @@ -176,9 +190,10 @@ fn shape_builder_hover_builds_a_large_map_on_another_thread() { assert_eq!((t.cache.builds, t.cache.background), (1, 1)); assert_eq!(t.overlays(&cx1).len(), 2, "the region's hatch and outline"); // A new revision while the map of the one before it is being built: only the newer one's - // map is used. - let cx2 = ToolContext { revision: (1, 2), ..cx(&d, &s, &p) }; - let cx3 = ToolContext { revision: (1, 3), ..cx(&d, &s, &p) }; + // map is used. Each revision moves the squares down 1 pt. + let rows: Vec = (0..7).map(|k| square_row_at(40, f64::from(k)).0).collect(); + let cx2 = ToolContext { revision: (1, 2), ..cx(&rows[2], &s, &p) }; + let cx3 = ToolContext { revision: (1, 3), ..cx(&rows[3], &s, &p) }; t.pointer(&cx2, &hover); t.pointer(&cx3, &hover); poll_until_ready(&mut t, &cx3); @@ -186,29 +201,265 @@ fn shape_builder_hover_builds_a_large_map_on_another_thread() { assert_eq!((t.cache.builds, t.cache.background), (3, 3), "the earlier revision's map, then the newer one's"); assert_eq!(t.cache.key.as_ref().map(|k| k.1), Some((1, 3))); // A host without frames waits for the map. - let cx4 = ToolContext { revision: (1, 4), ..cx(&d, &s, &p) }; + let cx4 = ToolContext { revision: (1, 4), ..cx(&rows[4], &s, &p) }; t.pointer(&cx4, &hover); assert!(t.waiting() && t.hover.is_none()); t.poll(&cx4, true); assert!(!t.waiting()); assert!(matches!(t.hover, Some(Hit::Region(_))), "{:?}", t.hover); assert_eq!((t.cache.builds, t.cache.background), (4, 4)); - // A press while the map is being built waits for it, and the drag merges. - let cx5 = ToolContext { revision: (1, 5), ..cx(&d, &s, &p) }; + // A drag while the map is being built is replayed once it is there, and merges (on + // another thread, see `shape_builder_merges_a_large_selection_on_another_thread` and + // `shape_builder_gesture_waits_for_the_map_without_holding_the_caller`). + let cx5 = ToolContext { revision: (1, 5), ..cx(&rows[5], &s, &p) }; t.pointer(&cx5, &hover); t.pointer(&cx5, &ev(PointerKind::Down, 15.0, 10.0)); t.pointer(&cx5, &ev(PointerKind::Drag, 35.0, 10.0)); - let acts = t.pointer(&cx5, &ev(PointerKind::Up, 35.0, 10.0)); - assert!(matches!(acts.as_slice(), [Action::Exec(id, _)] if id == "shapeBuilder.merge"), "{acts:?}"); + assert!(t.pointer(&cx5, &ev(PointerKind::Up, 35.0, 10.0)).is_empty()); + let acts = t.poll(&cx5, true); assert_eq!((t.cache.builds, t.cache.background), (5, 5)); + assert!(matches!(acts.as_slice(), [Action::Exec(id, _)] if id == "shapeBuilder.merge"), "{acts:?}"); assert!(!t.waiting()); // Changing an option forgets a map being built with the old one. - let cx6 = ToolContext { revision: (1, 6), ..cx(&d, &s, &p) }; + let cx6 = ToolContext { revision: (1, 6), ..cx(&rows[6], &s, &p) }; t.pointer(&cx6, &hover); t.set_option("gapDetection", &json!(true)); assert!(!t.waiting()); } +/// Polls `t` until it stops waiting, as the desktop app does each frame, and returns the +/// actions the polls gave. +fn poll_actions(t: &mut dyn Tool, cx: &ToolContext) -> Vec { + let start = std::time::Instant::now(); + let mut acts = vec![]; + while t.waiting() { + assert!(start.elapsed() < std::time::Duration::from_secs(60), "the tool is still waiting"); + std::thread::sleep(std::time::Duration::from_millis(2)); + acts.extend(t.poll(cx, false)); + } + acts +} + +/// A Shape Builder over `square_row(40)` (160 segments) that has merged nothing, with its map, +/// after a click at (15, 10) that started a merge on another thread. +fn clicked_row(cx: &ToolContext) -> ShapeBuilderTool { + let mut t = ShapeBuilderTool::default(); + t.pointer(cx, &ev(PointerKind::Move, 15.0, 10.0)); + poll_until_ready(&mut t, cx); + t.pointer(cx, &ev(PointerKind::Down, 15.0, 10.0)); + assert!(t.pointer(cx, &ev(PointerKind::Up, 15.0, 10.0)).is_empty(), "the release returns before the merge is computed"); + assert!(t.waiting() && t.editing()); + t +} + +#[test] +fn shape_builder_merges_a_large_selection_on_another_thread() { + let (d, s) = square_row(40); + let p = paint(); + let cx = cx(&d, &s, &p); + let computed = merges_computed(); + let mut t = clicked_row(&cx); + assert_eq!(t.cursor(&cx, Point::new(15.0, 10.0), Mods::default()), Cursor::Busy); + assert_eq!(t.overlays(&cx).len(), 2, "the clicked region's hatch and outline stay"); + // A press while the merge is being computed starts no gesture. + assert!(t.pointer(&cx, &ev(PointerKind::Down, 35.0, 10.0)).is_empty()); + assert!(!t.busy()); + assert!(t.pointer(&cx, &ev(PointerKind::Up, 35.0, 10.0)).is_empty()); + let acts = poll_actions(&mut t, &cx); + assert_eq!(merges_computed(), computed, "the merge was computed on another thread"); + let [Action::Exec(id, params)] = acts.as_slice() else { panic!("{acts:?}") }; + assert_eq!((id.as_str(), ¶ms["points"]), ("shapeBuilder.merge", &json!([[15.0, 10.0]]))); + assert!(!t.waiting() && !t.editing()); + assert_eq!(t.cursor(&cx, Point::new(15.0, 10.0), Mods::default()), Cursor::ShapeBuilder); + let m = t.shape_builder_merge().expect("the merge the command takes"); + assert!(Arc::ptr_eq(&m.map, &t.cache.map)); + assert_eq!((m.touched.regions.len(), m.touched.lines.len(), m.touched.edges.len()), (1, 0, 0)); + assert!(!m.geometry.union.is_empty()); + assert_eq!(m.geometry, merge_geometry(&m.map, &m.touched, m.gap, &m.inputs)); + assert_eq!(m.geometry.rests.iter().flatten().count(), 2, "the two squares over the region change"); + // The next event lets it go. + t.pointer(&cx, &ev(PointerKind::Move, 15.0, 10.0)); + assert!(t.shape_builder_merge().is_none()); +} + +#[test] +fn shape_builder_drops_a_merge_the_art_changed_under() { + let (d, s) = square_row(40); + let p = paint(); + let mut fewer = Selection::default(); + fewer.set(s.objects.iter().skip(1).copied()); + let cx1 = ToolContext { revision: (1, 1), ..cx(&d, &s, &p) }; + let (moved, _) = square_row_at(40, 5.0); + let later = [ + // An edit or an undo: the squares moved. + ToolContext { revision: (1, 2), ..cx(&moved, &s, &p) }, + // Another document. + ToolContext { revision: (2, 1), ..cx(&d, &s, &p) }, + // Another selection. + ToolContext { revision: (1, 1), ..cx(&d, &fewer, &p) }, + ]; + for (k, cx2) in later.iter().enumerate() { + let mut t = clicked_row(&cx1); + // Dropped at the first poll, before the thread is done. + assert!(t.poll(cx2, false).is_empty(), "change {k}: the merge is not applied"); + assert!(!t.editing() && !t.waiting() && t.shape_builder_merge().is_none(), "change {k}"); + } + // Unchanged, the same wait applies it. + let mut t = clicked_row(&cx1); + assert_eq!(t.poll(&cx1, true).len(), 1); + // A copy of the document at the same revision (a save stamps its dates on a copy), and + // finishing the edit before a command, apply it too. + let copy = d.clone(); + let cx3 = ToolContext { revision: (1, 1), ..cx(©, &s, &p) }; + let mut t = clicked_row(&cx1); + assert_eq!(t.finish_edit(&cx3).len(), 1); + assert!(!t.editing() && t.shape_builder_merge().is_some()); + // Switching away applies it. + let mut t = clicked_row(&cx1); + assert_eq!(t.deactivate(&cx1).len(), 1); + assert!(!t.editing()); +} + +/// A new revision of the document that leaves the selection's inputs as they were (a view +/// setting or a preference that redraws it) keeps the merge being computed, the gesture made +/// while the map is being built and the map itself: the merge applies with the map it was +/// computed over, and no map is built again. +#[test] +fn shape_builder_keeps_its_work_over_a_new_revision_of_the_same_art() { + let (d, s) = square_row(40); + let p = paint(); + let cx1 = ToolContext { revision: (1, 1), ..cx(&d, &s, &p) }; + let cx2 = ToolContext { revision: (1, 2), ..cx(&d, &s, &p) }; + // A merge being computed. + let computed = merges_computed(); + let mut t = clicked_row(&cx1); + let acts = poll_actions(&mut t, &cx2); + assert!(matches!(acts.as_slice(), [Action::Exec(id, _)] if id == "shapeBuilder.merge"), "{acts:?}"); + assert_eq!(merges_computed(), computed, "the merge computed on another thread"); + let m = t.shape_builder_merge().expect("the merge the command takes"); + assert!(Arc::ptr_eq(&m.map, &t.cache.map), "the map the merge was computed over"); + assert_eq!(t.cache.key.as_ref().map(|k| k.1), Some((1, 2))); + assert_eq!(t.cache.builds, 1, "no map built again"); + // Finishing it before a command too. + let mut t = clicked_row(&cx1); + assert_eq!(t.finish_edit(&cx2).len(), 1); + // A hover over the new revision builds no map. + let mut t = ShapeBuilderTool::default(); + let hover = ev(PointerKind::Move, 15.0, 10.0); + t.pointer(&cx1, &hover); + poll_until_ready(&mut t, &cx1); + t.pointer(&cx2, &hover); + assert!(!t.waiting() && matches!(t.hover, Some(Hit::Region(_))), "{:?}", t.hover); + assert_eq!(t.cache.builds, 1); + // A map being built, and a gesture made meanwhile. + let drag = [ev(PointerKind::Down, 15.0, 10.0), ev(PointerKind::Drag, 35.0, 10.0), ev(PointerKind::Up, 35.0, 10.0)]; + let mut ready = ShapeBuilderTool::default(); + ready.pointer(&cx1, &hover); + poll_until_ready(&mut ready, &cx1); + for e in &drag { + ready.pointer(&cx1, e); + } + let want = poll_actions(&mut ready, &cx1); + let mut t = ShapeBuilderTool::default(); + t.pointer(&cx1, &hover); + for e in &drag { + assert!(t.pointer(&cx1, e).is_empty()); + } + assert!(t.editing() && t.cache.builds == 0, "the gesture waits for the map"); + assert_eq!(poll_actions(&mut t, &cx2), want); + assert_eq!((t.cache.builds, t.cache.background), (1, 1), "the map built for the first revision"); + // Finishing it before a command waits for the map being built rather than building it again. + let mut t = ShapeBuilderTool::default(); + t.pointer(&cx1, &hover); + for e in &drag { + t.pointer(&cx1, e); + } + assert_eq!(t.finish_edit(&cx2), want); + assert_eq!((t.cache.builds, t.cache.background), (1, 1), "the map built on the other thread"); + // Another document with the same art drops the merge. + let cx3 = ToolContext { revision: (2, 1), ..cx(&d, &s, &p) }; + let mut t = clicked_row(&cx1); + assert!(t.poll(&cx3, false).is_empty()); + assert!(!t.editing()); +} + +/// A press while the map of a large selection is being built on another thread does not wait +/// for it: the gesture is recorded, each event returns at once, and the polls replay it once +/// the map is there, giving the merge the same gesture gives over the map. Finishing the edit +/// waits for the map and the merge; another revision of other art drops the gesture. +#[test] +fn shape_builder_gesture_waits_for_the_map_without_holding_the_caller() { + let (d, s) = square_row(200); + let p = paint(); + let cx1 = ToolContext { revision: (1, 1), ..cx(&d, &s, &p) }; + let hover = ev(PointerKind::Move, 15.0, 10.0); + let drag = [ev(PointerKind::Down, 15.0, 10.0), ev(PointerKind::Drag, 35.0, 10.0), ev(PointerKind::Up, 35.0, 10.0)]; + let mut ready = ShapeBuilderTool::default(); + ready.pointer(&cx1, &hover); + poll_until_ready(&mut ready, &cx1); + for e in &drag { + ready.pointer(&cx1, e); + } + let want = poll_actions(&mut ready, &cx1); + assert!(matches!(want.as_slice(), [Action::Exec(id, _)] if id == "shapeBuilder.merge"), "{want:?}"); + let made_while_building = || { + let mut t = ShapeBuilderTool::default(); + t.pointer(&cx1, &hover); + for e in &drag { + assert!(t.pointer(&cx1, e).is_empty()); + } + assert_eq!(t.cache.builds, 0, "the gesture did not wait for the map"); + assert!(t.editing() && t.waiting()); + t + }; + let mut t = made_while_building(); + assert_eq!(t.cursor(&cx1, Point::new(35.0, 10.0), Mods::default()), Cursor::Busy); + // A press before the gesture is replayed starts nothing. + assert!(t.pointer(&cx1, &ev(PointerKind::Down, 55.0, 10.0)).is_empty()); + assert!(t.pointer(&cx1, &ev(PointerKind::Up, 55.0, 10.0)).is_empty()); + assert_eq!(poll_actions(&mut t, &cx1), want); + assert!(!t.editing() && t.shape_builder_merge().is_some()); + // Finishing the edit before a command waits for both. + let mut t = made_while_building(); + assert_eq!(t.finish_edit(&cx1), want); + // Another revision of other art before the map is there drops the gesture. + let mut t = made_while_building(); + let (moved, _) = square_row_at(200, 5.0); + let cx2 = ToolContext { revision: (1, 2), ..cx(&moved, &s, &p) }; + assert!(t.poll(&cx2, false).is_empty()); + assert!(!t.editing()); +} + +/// Escape during a drag made while the map of a large selection is being built cancels the +/// recorded gesture too: the release and the polls after it merge nothing, the tool stops +/// waiting once the map is there, and the next drag merges on its own. +#[test] +fn shape_builder_escape_cancels_a_gesture_made_while_the_map_is_built() { + let (d, s) = square_row(200); + let p = paint(); + let cx1 = ToolContext { revision: (1, 1), ..cx(&d, &s, &p) }; + let mut t = ShapeBuilderTool::default(); + t.pointer(&cx1, &ev(PointerKind::Move, 15.0, 10.0)); + assert!(t.pointer(&cx1, &ev(PointerKind::Down, 15.0, 10.0)).is_empty()); + assert!(t.pointer(&cx1, &ev(PointerKind::Drag, 35.0, 10.0)).is_empty()); + assert_eq!(t.cache.builds, 0, "the gesture did not wait for the map"); + assert!(t.claims_key(&cx1, ToolKey::Escape)); + assert!(t.key(&cx1, ToolKey::Escape, Mods::default()).is_empty()); + assert!(t.pointer(&cx1, &ev(PointerKind::Up, 35.0, 10.0)).is_empty()); + assert!(poll_actions(&mut t, &cx1).is_empty(), "the canceled gesture merges nothing"); + assert!(!t.waiting() && !t.editing()); + // The next drag merges what it touches, with no event of the canceled one. + let mut fresh = ShapeBuilderTool::default(); + fresh.pointer(&cx1, &ev(PointerKind::Move, 55.0, 10.0)); + poll_until_ready(&mut fresh, &cx1); + let next = [ev(PointerKind::Down, 55.0, 10.0), ev(PointerKind::Drag, 75.0, 10.0), ev(PointerKind::Up, 75.0, 10.0)]; + for e in &next { + fresh.pointer(&cx1, e); + t.pointer(&cx1, e); + } + assert_eq!(poll_actions(&mut t, &cx1), poll_actions(&mut fresh, &cx1)); +} + #[test] fn shape_builder_hover_builds_a_small_map_at_once() { let (d, s) = square_row(3); @@ -1110,9 +1361,15 @@ fn bucket_keeps_its_map_while_the_document_is_unchanged() { // The fill left the document as it was: the map still fits it. t.pointer(&cx1, &ev(PointerKind::Move, 25.0, 50.0)); assert_eq!(t.cache.builds, 1, "a hover after a fill that changed nothing"); + // A new revision of the same art keeps the map; one with an object moved builds it again. let cx2 = ToolContext { revision: (1, 2), ..cx(&d, &s, &p) }; t.pointer(&cx2, &ev(PointerKind::Move, 25.0, 50.0)); - assert_eq!(t.cache.builds, 2, "a hover on a new revision"); + assert_eq!(t.cache.builds, 1, "a hover on a new revision of the same art"); + let mut moved = d.clone(); + moved.node_mut(b).unwrap().transform(vectorcraft_geom::Affine::translate((10.0, 0.0)), false); + let cx3 = ToolContext { revision: (1, 3), ..cx(&moved, &s, &p) }; + t.pointer(&cx3, &ev(PointerKind::Move, 25.0, 50.0)); + assert_eq!(t.cache.builds, 2, "a hover on a new revision of other art"); } #[test] diff --git a/crates/tools/src/lib.rs b/crates/tools/src/lib.rs index f8157df42..557fe52b1 100644 --- a/crates/tools/src/lib.rs +++ b/crates/tools/src/lib.rs @@ -267,21 +267,41 @@ pub trait Tool: Send { false } /// Is the tool waiting for work it runs on another thread (the planar map of a large selection - /// for the Shape Builder and the Live Paint Bucket)? It highlights no region under the pointer - /// until the work is done. While this holds, the desktop app calls [`Tool::poll`] each frame, - /// and hosts without frames call it with `wait` after a [`PointerKind::Move`]. + /// for the Shape Builder and the Live Paint Bucket, a Shape Builder merge of one)? It + /// highlights nothing under the pointer until a map is done. While this holds, the desktop app + /// calls [`Tool::poll`] each frame, and hosts without frames call it with `wait` after each + /// pointer event. fn waiting(&self) -> bool { false } - /// Checks on the work [`Tool::waiting`] reports, waiting for it to finish with `wait`. Once it - /// is done, the tool shows the highlight under the pointer where it last moved. - fn poll(&mut self, _cx: &ToolContext, _wait: bool) {} + /// Is the tool computing an edit on another thread, which [`Tool::poll`] applies once it is + /// done (a Shape Builder merge of a large selection)? + fn editing(&self) -> bool { + false + } + /// Checks on the work [`Tool::waiting`] reports, waiting for it to finish with `wait`. Once a + /// map is done, the tool shows the highlight under the pointer where it last moved; once an + /// edit is done, the actions returned apply it. + fn poll(&mut self, _cx: &ToolContext, _wait: bool) -> Vec { + vec![] + } + /// Waits for the edit [`Tool::editing`] reports and returns the actions that apply it, before + /// a command runs on the document; none when the document's revision or the selection changed + /// since the gesture. + fn finish_edit(&mut self, _cx: &ToolContext) -> Vec { + vec![] + } /// The Shape Builder's planar map of the selection, with the outline edges, and the gap it /// closes, when the tool has one. `shapeBuilder.merge` uses it in place of a map of its own /// when the map's inputs are the merge's inputs. fn shape_builder_map(&self) -> Option<(std::sync::Arc, f64)> { None } + /// The Shape Builder merge the tool computed on another thread for its last gesture, which + /// `shapeBuilder.merge` takes when it would compute the same ([`builder::PreparedMerge`]). + fn shape_builder_merge(&self) -> Option> { + None + } } /// Create a tool by id. Unknown or not-yet-implemented tools fall back to a no-op tool that keeps the id. diff --git a/crates/ui-egui/src/app.rs b/crates/ui-egui/src/app.rs index a75fecde2..910dd8e49 100644 --- a/crates/ui-egui/src/app.rs +++ b/crates/ui-egui/src/app.rs @@ -110,6 +110,7 @@ impl VectorcraftApp { deferred_control: None, synthetic_dropped_before: 0, pending_screenshots: vec![], + pointer_replies: vec![], queued_screenshots: vec![], screenshot_token: 0, screenshot_reserved: 0, @@ -337,8 +338,9 @@ impl VectorcraftApp { ctx.request_repaint_after(std::time::Duration::from_millis(100)); } // The window's close button (or the system quitting the app) asks about unsaved documents, - // once the saves running in the background are done. Not while a file dialog's sheet is on - // the window: what asked for it runs again when it answers. + // once the saves running in the background are done and a Shape Builder merge being + // computed is applied. Not while a file dialog's sheet is on the window: what asked for it + // runs again when it answers. if ctx.input(|i| i.viewport().close_requested()) { // This native viewport is going away: release its IME context. No request is // allocated here: the close prompt or file sheet publishes no custom descriptor, so a @@ -346,7 +348,7 @@ impl VectorcraftApp { // fresh generation on the next pass (never inherits a composition across the prompt). crate::ime::close_viewport(self, ctx); self.ime_context.end_viewport(ctx.viewport_id()); - background::wait_all(self); + unsaved::finish_pending(self); if self.file_sheet_open() { ctx.send_viewport_cmd(egui::ViewportCommand::CancelClose); self.status(picks::busy()); @@ -374,6 +376,7 @@ impl VectorcraftApp { crate::chrome::sync_window_title(self, ctx); crate::chrome::sync_fullscreen(self, ctx); self.drain_control(ctx); + self.answer_pointer_replies(ctx); // An egui `PasteImage` with a rich system clipboard: run the paste command now, once. It // goes through `run`, whose `edit.paste` branch calls `adopt_system_clipboard` (which clears // the request) to read the formats and then pastes them. A text paste in the same UI pass diff --git a/crates/ui-egui/src/app/commands.rs b/crates/ui-egui/src/app/commands.rs index de227b748..d5ca8a196 100644 --- a/crates/ui-egui/src/app/commands.rs +++ b/crates/ui-egui/src/app/commands.rs @@ -1,5 +1,5 @@ use super::fonts::MAX_RECENT_FONTS; -use super::{Value, VectorcraftApp, dialogs, fileio, io, menus, panels, picks, toolbar}; +use super::{Value, VectorcraftApp, canvas, dialogs, fileio, io, menus, panels, picks, toolbar}; use crate::placing; use crate::state::ReplaceFontWarning; @@ -94,6 +94,17 @@ impl VectorcraftApp { result } + /// A command that waits for the edit the tool computes on another thread and the input held + /// for it waits before the app adds the view's active artboard to its params: a held press + /// may change it. The app's own commands (its dialogs, panels and view) wait too. + fn wait_for_tool_edit(&mut self, id: &str) { + let ui_command = vectorcraft_engine::find_command(id).is_none(); + if (ui_command || vectorcraft_engine::waits_for_tool_edit(id)) && self.session.tool_waiting() { + let r = self.session.finish_tool_edit(); + canvas::apply_requests(self, r); + } + } + /// [`Self::run`] it, inside what asks for file dialogs. fn run_now(&mut self, id: &str, params: Value) -> Result { crate::state::sync_zoom_stops_display_print_size(self.session.prefs.display_print_size); @@ -104,6 +115,7 @@ impl VectorcraftApp { if cfg!(debug_assertions) && !self.session.replaying() { menus::check_params(&self.session, id, ¶ms)?; } + self.wait_for_tool_edit(id); // A `.ai` file a command writes (a save, an export, a timestamped copy, a batch's save) names // the view's active artboard. io::remember_active_artboard(self); diff --git a/crates/ui-egui/src/app/control.rs b/crates/ui-egui/src/app/control.rs index 213204b95..5ef64dfa3 100644 --- a/crates/ui-egui/src/app/control.rs +++ b/crates/ui-egui/src/app/control.rs @@ -1,6 +1,6 @@ use super::{ MAX_PENDING_SCREENSHOTS, MAX_SCREENSHOT_BYTES, MAX_SCREENSHOT_TOTAL_BYTES, PendingScreenshot, QueuedScreenshot, SCREENSHOT_TIMEOUT_MS, - VectorcraftApp, file_access, json, now_ms, + VectorcraftApp, canvas, file_access, json, now_ms, }; use crate::control; @@ -112,6 +112,9 @@ impl VectorcraftApp { } } } + control::Outcome::AfterToolEdit { from, to, document } => { + self.pointer_replies.push(control::PendingPointerReply { from, to, document, reply }); + } } } if handled == control::MAX_CONTROL_REQUESTS_PER_FRAME { @@ -121,6 +124,38 @@ impl VectorcraftApp { self.control_rx = Some(rx); } + /// Sends the `ui.pointer` replies that wait for the tool's edit once their events have been + /// made and the edit is applied. The canvas checks on the tool each frame it is drawn; this + /// checks too, for frames without it. + pub(crate) fn answer_pointer_replies(&mut self, ctx: &egui::Context) { + // Those whose events the canvas's check made go first, before this check makes the input + // held after them. + self.send_pointer_replies(); + if self.pointer_replies.is_empty() { + return; + } + if self.session.tool_editing() { + let r = self.session.tool_poll(self.view_info(), false); + canvas::apply_requests(self, r); + } + self.send_pointer_replies(); + if !self.pointer_replies.is_empty() { + ctx.request_repaint_after(std::time::Duration::from_millis(16)); + } + } + + /// Sends the waiting `ui.pointer` replies whose events have been made. + fn send_pointer_replies(&mut self) { + for pending in std::mem::take(&mut self.pointer_replies) { + let control::PendingPointerReply { from, to, document, reply } = pending; + if self.session.input_applied(from, to) { + let _ = reply.send(control::pointer_reply_for(self, document)); + } else { + self.pointer_replies.push(control::PendingPointerReply { from, to, document, reply }); + } + } + } + /// The active document's identity: its process-unique uid and revision. A capture records it /// at admission and issuance and refuses to answer with a different document or undo state. pub(super) fn document_identity(&self) -> Option<(u64, u64)> { diff --git a/crates/ui-egui/src/canvas/drag.rs b/crates/ui-egui/src/canvas/drag.rs index 63b4ef9c9..930daf8fd 100644 --- a/crates/ui-egui/src/canvas/drag.rs +++ b/crates/ui-egui/src/canvas/drag.rs @@ -376,19 +376,29 @@ pub fn dispatch(app: &mut VectorcraftApp, ev: &PointerEvent, view: vectorcraft_e { v.artboard = i; } - // A press with a selection tool inside an artboard makes it the active one (#693), as the - // Artboard tool's does: Paste in Place and in Front or Back then paste onto it, Align to - // Artboard aligns to it, and All on Active Artboard selects on it. - if ev.kind == PointerKind::Down - && vectorcraft_tools::catalog::is_selection_tool(app.session.tool_id()) - && let Some(i) = app.session.active().and_then(|d| d.doc.artboard_at(ev.pos)) - && let Some(v) = app.view_mut() - { - v.artboard = i; + if ev.kind == PointerKind::Down { + pressed_with(app, app.session.active_index(), ev.pos, app.session.tool_id()); } apply_requests(app, r); } +/// A press at `pos` in document `index` with tool `tool` (a selection tool) inside an artboard +/// makes it that document's active one (#693), as the Artboard tool's does: Paste in Place and in +/// Front or Back then paste onto it, Align to Artboard aligns to it, and All on Active Artboard +/// selects on it. +fn pressed_with(app: &mut VectorcraftApp, index: Option, pos: Point, tool: &str) { + if !vectorcraft_tools::catalog::is_selection_tool(tool) { + return; + } + app.sync_views(); + if let Some(i) = index + && let Some(board) = app.session.documents().get(i).and_then(|d| d.doc.artboard_at(pos)) + && let Some(v) = app.views.get_mut(i) + { + v.artboard = board; + } +} + /// Act on what a tool event asked the UI for (dialogs, tool switches), or show its error. pub fn apply_requests(app: &mut VectorcraftApp, r: vectorcraft_engine::Result>) { match r { @@ -399,6 +409,15 @@ pub fn apply_requests(app: &mut VectorcraftApp, r: vectorcraft_engine::Result app.select_tool(&t), vectorcraft_engine::UiRequest::Status(msg) => app.status(msg), vectorcraft_engine::UiRequest::Place(p) => crate::place::place_from_cursor(app, &p), + // In the document the press was made in, which may no longer be the active one. + vectorcraft_engine::UiRequest::HeldPress { doc, pos, tool } => { + let index = doc.and_then(|uid| app.session.documents().iter().position(|d| d.uid == uid)); + pressed_with(app, index, pos, tool); + // The selection tool Cmd lent has the press now, so its drag can carry art to another tab. + if let Some(ctx) = app.ui_ctx.clone() { + crate::document_drag::begin(app, &ctx, pos); + } + } } } } diff --git a/crates/ui-egui/src/canvas/input.rs b/crates/ui-egui/src/canvas/input.rs index 6eb161a26..5fbc2b903 100644 --- a/crates/ui-egui/src/canvas/input.rs +++ b/crates/ui-egui/src/canvas/input.rs @@ -147,12 +147,12 @@ pub(super) fn handle_input(app: &mut VectorcraftApp, ui: &Ui, resp: &egui::Respo app.session.tool_hover_ended(view); ui.ctx().request_repaint(); } - // The tool works on another thread (a large selection's planar map): it checks each frame - // whether the work is done, and then shows the highlight under the pointer. + // The tool works on another thread (a large selection's planar map or merge): it checks each + // frame whether the work is done, and then shows the highlight under the pointer or applies + // the edit. if app.session.tool_waiting() { - if let Err(e) = app.session.tool_poll(view, false) { - app.status(e.to_string()); - } + let r = app.session.tool_poll(view, false); + apply_requests(app, r); ui.ctx().request_repaint_after(std::time::Duration::from_millis(16)); } if pointer.primary_released() diff --git a/crates/ui-egui/src/control.rs b/crates/ui-egui/src/control.rs index af5ab9de2..6af51d95a 100644 --- a/crates/ui-egui/src/control.rs +++ b/crates/ui-egui/src/control.rs @@ -96,6 +96,13 @@ fn reserve_synthetic(app: &mut VectorcraftApp, additional: usize) -> Result<(), pub type ControlResponse = Value; +pub(crate) struct PendingPointerReply { + pub from: u64, + pub to: u64, + pub document: Option, + pub reply: Sender, +} + pub struct ControlRequest { pub method: String, pub params: Value, @@ -167,6 +174,34 @@ pub enum Outcome { path: Option, data: bool, }, + /// A `ui.pointer` reply ([`pointer_reply`]), sent once the events numbered `from..to` + /// ([`vectorcraft_engine::Session::input_applied`]) have been made and the edit they started + /// on another thread is applied, so it shows the selection after the edit. + AfterToolEdit { + from: u64, + to: u64, + document: Option, + }, +} + +/// The reply to `ui.pointer`: the selection, the key object and the active tool. +pub(crate) fn pointer_reply(app: &mut VectorcraftApp) -> Value { + pointer_reply_for(app, app.session.active().map(|d| d.uid)) +} + +pub(crate) fn pointer_reply_for(app: &VectorcraftApp, document: Option) -> Value { + let state = document.and_then(|uid| app.session.documents().iter().find(|d| d.uid == uid)); + match state { + Some(state) => json!({ + "ok": true, + "result": { + "selection": state.selection.objects.iter().map(|id| id.0).collect::>(), + "key": state.selection.key.map(|id| id.0), + "tool": app.session.tool_id(), + } + }), + None => json!({"ok": false, "error": "the gesture's document is no longer open"}), + } } fn ok(v: Value) -> Outcome { @@ -580,6 +615,7 @@ fn pointer_events(app: &mut VectorcraftApp, ctx: &egui::Context, req: &ControlRe let base_mods: Mods = p.get("mods").and_then(|m| serde_json::from_value(m.clone()).ok()).unwrap_or_default(); let view = app.view_info(); let xf = app.canvas_rect.zip(app.view().copied()).map(|(rect, v)| Xf::new(rect, &v)); + let from = app.session.input_count(); let held = PointerEvent::json_backquote(p, false).and_then(|d| events.iter().map(|e| PointerEvent::json_backquote(e, d)).collect::, _>>()); let held = match held { @@ -620,7 +656,15 @@ fn pointer_events(app: &mut VectorcraftApp, ctx: &egui::Context, req: &ControlRe } } ctx.request_repaint(); - wrap(app.run("document.inspect", json!({})).map(|d| json!({"selection": d["selection"], "key": d["key"], "tool": app.session.tool_id()}))) + // A Shape Builder merge of a large selection is computed on another thread, and the + // reply to the events that started it waits for it without holding the frames up. A + // gesture sent while it is computed is made after it, and its reply waits until then; + // a hover is answered at once. + let to = app.session.input_count(); + if !app.session.input_applied(from, to) { + return Outcome::AfterToolEdit { from, to, document: app.session.active().map(|d| d.uid) }; + } + Outcome::Done(pointer_reply(app)) } /// `ui.click` and `ui.drag`: pointer input through egui itself. diff --git a/crates/ui-egui/src/control/tests.rs b/crates/ui-egui/src/control/tests.rs index e587c0489..6d46e6c0f 100644 --- a/crates/ui-egui/src/control/tests.rs +++ b/crates/ui-egui/src/control/tests.rs @@ -1,5 +1,6 @@ use serde_json::{Value, json}; use vectorcraft_engine::Session; +use vectorcraft_tools::{Mods, PointerEvent, PointerKind}; use super::{ControlRequest, MAX_DIALOG_FIELDS, Outcome, handle}; use crate::state::Dialog; @@ -11,6 +12,27 @@ fn input_request(app: &mut VectorcraftApp, method: &str, params: Value) -> Value r } +#[test] +fn deferred_pointer_reply_uses_the_gesture_document_after_file_new() { + let mut app = VectorcraftApp::new(Session::new(), Services::default()); + app.run("file.new", json!({"width": 200, "height": 200})).unwrap(); + let id = app.run("shape.rectangle", json!({"x": 10, "y": 10, "width": 40, "height": 40})).unwrap()["id"].as_u64().unwrap(); + app.run("select.set", json!({"ids": [id]})).unwrap(); + let (reply, received) = std::sync::mpsc::channel(); + let at = app.session.input_count(); + app.pointer_replies.push(super::PendingPointerReply { from: at, to: at, document: app.session.active().map(|d| d.uid), reply }); + + app.run("file.new", json!({"width": 200, "height": 200})).unwrap(); + app.run("tool.select", json!({"tool": "rectangle"})).unwrap(); + app.answer_pointer_replies(&egui::Context::default()); + + let result = received.try_recv().unwrap(); + assert_eq!(result["ok"], true, "{result}"); + assert_eq!(result["result"]["selection"], json!([id])); + assert_eq!(result["result"]["key"], Value::Null); + assert_eq!(result["result"]["tool"], "rectangle"); +} + #[test] fn control_lists_and_selects_optional_addon_tools() { let mut app = VectorcraftApp::new(Session::new(), Services::default()); @@ -338,6 +360,263 @@ fn pointer_replies_name_the_key_object() { assert_eq!(click(&mut app), Some(Value::Null), "a click on the key again lets it go"); } +/// A Shape Builder click on a large selection merges on another thread: the frames go on, and +/// the `ui.pointer` reply comes once the merge is applied, with the selection after it. +#[test] +fn pointer_reply_waits_for_a_merge_on_another_thread() { + let (tx, rx) = std::sync::mpsc::channel(); + let mut app = VectorcraftApp::new(Session::new(), Services::default()).with_control(rx); + app.run("file.new", json!({"width": 800, "height": 200})).unwrap(); + for k in 0..40 { + app.run("shape.rectangle", json!({"x": k * 10, "y": 0, "width": 20, "height": 20})).unwrap(); + } + app.run("select.all", json!({})).unwrap(); + app.run("tool.select", json!({"tool": "shapeBuilder"})).unwrap(); + let ctx = egui::Context::default(); + let send = |app: &mut VectorcraftApp, events: Value| { + let (req, reply) = ControlRequest::new("ui.pointer", json!({"events": events})); + tx.send(req).unwrap(); + app.drain_control(&ctx); + reply + }; + let hover = send(&mut app, json!([{"kind": "move", "x": 15, "y": 10}])); + assert_eq!(hover.try_recv().unwrap()["ok"], true, "a hover is answered at once"); + app.session.tool_poll(app.view_info(), true).unwrap(); + let revision = app.session.active().unwrap().revision; + let click = send(&mut app, json!([{"kind": "down", "x": 15, "y": 10}, {"kind": "up", "x": 15, "y": 10}])); + assert!(click.try_recv().is_err() && app.session.tool_editing(), "the click is not answered before the merge is applied"); + // A hover sent meanwhile is answered at once; a click is made after the merge, and its + // reply waits until then. + let hover = send(&mut app, json!([{"kind": "move", "x": 35, "y": 10}])); + assert_eq!(hover.try_recv().map(|r| r["ok"].clone()), Ok(json!(true)), "a hover during the merge"); + let cmd = json!({"cmd": true}); + let press = send(&mut app, json!([{"kind": "down", "x": 500, "y": 150, "mods": cmd}, {"kind": "up", "x": 500, "y": 150, "mods": cmd}])); + assert!(press.try_recv().is_err(), "a Cmd-click during the merge waits for it"); + let hover = send(&mut app, json!([{"kind": "move", "x": 45, "y": 10}])); + assert_eq!(hover.try_recv().map(|r| r["ok"].clone()), Ok(json!(true)), "a hover after the held Cmd-click"); + let start = std::time::Instant::now(); + let reply = loop { + if let Ok(r) = click.try_recv() { + break r; + } + assert!(app.session.tool_editing(), "the merge is being computed until the reply goes"); + assert_eq!(app.session.active().unwrap().revision, revision); + assert!(start.elapsed() < std::time::Duration::from_secs(60), "no reply"); + std::thread::sleep(std::time::Duration::from_millis(2)); + // A frame: the canvas checks on the tool, then the replies are answered. + let r = app.session.tool_poll(app.view_info(), false); + crate::canvas::apply_requests(&mut app, r); + app.answer_pointer_replies(&ctx); + }; + assert_eq!(reply["ok"], true, "{reply}"); + assert_eq!(reply["result"]["selection"].as_array().map(Vec::len), Some(41), "{reply}: the selection after the merge"); + assert_ne!(app.session.active().unwrap().revision, revision); + let press = loop { + if let Ok(r) = press.try_recv() { + break r; + } + assert!(start.elapsed() < std::time::Duration::from_secs(60), "no reply to the Cmd-click"); + let r = app.session.tool_poll(app.view_info(), false); + crate::canvas::apply_requests(&mut app, r); + app.answer_pointer_replies(&ctx); + }; + assert_eq!(press["result"]["selection"].as_array().map(Vec::len), Some(0), "{press}: the lent selection tool deselected after the merge"); + assert_eq!(press["result"]["tool"], "shapeBuilder", "{press}"); +} + +/// A Cmd-click held while a Shape Builder merge is computed on another thread makes the artboard +/// it lands in active once it is made, as a Cmd-click made at once does: by the frames' checks, +/// by choosing another tool first, or before a command that acts on the active artboard takes +/// it. +#[test] +fn a_held_cmd_click_makes_its_artboard_active() { + for then in ["frames", "another tool", "All on Active Artboard", "another document"] { + held_cmd_click(then); + } +} + +fn held_cmd_click(then: &str) { + let mut app = VectorcraftApp::new(Session::new(), Services::default()); + if then == "another document" { + // A document with an artboard where the press is, whose view keeps its own. + app.run("file.new", json!({"width": 1400, "height": 200})).unwrap(); + app.run("artboard.new", json!({"x": 1000, "y": 0, "width": 300, "height": 200})).unwrap(); + app.view_mut().unwrap().artboard = 0; + } + app.run("file.new", json!({"width": 800, "height": 200})).unwrap(); + app.run("artboard.new", json!({"x": 1000, "y": 0, "width": 300, "height": 200})).unwrap(); + for k in 0..40 { + app.run("shape.rectangle", json!({"x": k * 10, "y": 0, "width": 20, "height": 20})).unwrap(); + } + app.run("select.all", json!({})).unwrap(); + app.run("tool.select", json!({"tool": "shapeBuilder"})).unwrap(); + app.view_mut().unwrap().artboard = 0; + let view = app.view_info(); + let at = |kind, x, mods| PointerEvent { kind, pos: vectorcraft_geom::Point::new(x, 10.0), mods, pressure: 1.0, backquote: false, pen: None }; + crate::canvas::dispatch(&mut app, &at(PointerKind::Move, 15.0, Mods::default()), view); + app.session.tool_poll(view, true).unwrap(); + crate::canvas::dispatch(&mut app, &at(PointerKind::Down, 15.0, Mods::default()), view); + crate::canvas::dispatch(&mut app, &at(PointerKind::Up, 15.0, Mods::default()), view); + let cmd = Mods { cmd: true, ..Default::default() }; + crate::canvas::dispatch(&mut app, &at(PointerKind::Down, 1100.0, cmd), view); + crate::canvas::dispatch(&mut app, &at(PointerKind::Up, 1100.0, cmd), view); + assert_eq!(app.view().unwrap().artboard, 0, "{then}: the Cmd-click is held"); + if then == "another tool" { + app.select_tool("rectangle"); + assert!(!app.session.tool_editing(), "{then}"); + } + if then == "All on Active Artboard" { + app.run("select.allOnArtboard", json!({})).unwrap(); + assert!(app.session.doc().unwrap().selection.is_empty(), "{then}: the second artboard, which holds no art"); + } + let doc = app.session.active_index().unwrap(); + if then == "another document" { + // A document tab chosen. + app.session.set_active(0); + } + while app.session.tool_waiting() { + let r = app.session.tool_poll(view, true); + crate::canvas::apply_requests(&mut app, r); + } + app.sync_views(); + assert_eq!(app.views[doc].artboard, 1, "{then}: the Cmd-click made the artboard it landed in active"); + if then == "another document" { + assert_eq!(app.views[0].artboard, 0, "{then}: the other document's view keeps its artboard"); + } +} + +/// A dialog chosen from the menu, or with `ui.menuDialog`, while a Shape Builder merge is +/// computed on another thread opens after the merge is applied, on the merged art. So do the +/// app's own dialogs (Recolor Artwork), from the menu or a panel's button. +#[test] +fn menu_dialogs_open_after_a_merge_on_another_thread() { + for route in ["menu", "ui.menuDialog", "app dialog from the menu", "app dialog from a panel"] { + let mut app = VectorcraftApp::new(Session::new(), Services::default()); + app.run("file.new", json!({"width": 800, "height": 200})).unwrap(); + for k in 0..40 { + app.run("shape.rectangle", json!({"x": k * 10, "y": 0, "width": 20, "height": 20})).unwrap(); + } + app.run("select.all", json!({})).unwrap(); + app.run("tool.select", json!({"tool": "shapeBuilder"})).unwrap(); + let view = app.view_info(); + let at = |kind| PointerEvent { + kind, + pos: vectorcraft_geom::Point::new(15.0, 10.0), + mods: Mods::default(), + pressure: 1.0, + backquote: false, + pen: None, + }; + crate::canvas::dispatch(&mut app, &at(PointerKind::Move), view); + app.session.tool_poll(view, true).unwrap(); + crate::canvas::dispatch(&mut app, &at(PointerKind::Down), view); + crate::canvas::dispatch(&mut app, &at(PointerKind::Up), view); + assert!(app.session.tool_editing(), "{route}"); + match route { + "menu" => crate::menus::invoke(&mut app, "object.move", json!({})), + "ui.menuDialog" => { + app.run("ui.menuDialog", json!({"command": "object.move"})).unwrap(); + } + "app dialog from the menu" => crate::menus::invoke(&mut app, "ui.recolorDialog", json!({})), + _ => { + app.run("ui.recolorDialog", json!({})).unwrap(); + } + } + assert!(app.ui.dialog.is_some(), "{route}: the dialog is open"); + assert!(!app.session.tool_editing(), "{route}"); + let merged = app.session.doc().unwrap().history.undo.last().map(|e| e.label.clone()); + assert_eq!(merged.as_deref(), Some("Shape Builder"), "{route}"); + assert_eq!(app.session.doc().unwrap().selection.objects.len(), 41, "{route}: the dialog acts on the merged art"); + } +} + +/// The Separations panel's checkboxes and a preference set while a Shape Builder merge is +/// computed on another thread give the documents new revisions: the merge is applied first, +/// and the document keeps it. +#[test] +fn panels_that_redraw_apply_a_merge_on_another_thread_first() { + let cases = [ + ("view.separationsPreview", json!({"on": false})), + ("view.overprintPreview", json!({"on": false})), + ("prefs.set", json!({"values": {"gridlineEvery": 90}})), + ]; + for (id, params) in cases { + let mut app = VectorcraftApp::new(Session::new(), Services::default()); + app.run("file.new", json!({"width": 800, "height": 200})).unwrap(); + for k in 0..40 { + app.run("shape.rectangle", json!({"x": k * 10, "y": 0, "width": 20, "height": 20})).unwrap(); + } + app.run("select.all", json!({})).unwrap(); + app.run("tool.select", json!({"tool": "shapeBuilder"})).unwrap(); + let view = app.view_info(); + let at = |kind| PointerEvent { + kind, + pos: vectorcraft_geom::Point::new(15.0, 10.0), + mods: Mods::default(), + pressure: 1.0, + backquote: false, + pen: None, + }; + crate::canvas::dispatch(&mut app, &at(PointerKind::Move), view); + app.session.tool_poll(view, true).unwrap(); + crate::canvas::dispatch(&mut app, &at(PointerKind::Down), view); + crate::canvas::dispatch(&mut app, &at(PointerKind::Up), view); + assert!(app.session.tool_editing(), "{id}"); + app.run(id, params).unwrap(); + assert!(!app.session.tool_editing(), "{id}"); + for _ in 0..3 { + app.session.tool_poll(view, false).unwrap(); + } + let merged = app.session.doc().unwrap().history.undo.last().map(|e| e.label.clone()); + assert_eq!(merged.as_deref(), Some("Shape Builder"), "{id}"); + assert_eq!(app.session.doc().unwrap().selection.objects.len(), 41, "{id}"); + } +} + +/// Saving, exporting or closing while a Shape Builder merge is computed on another thread +/// applies the merge first: the file holds it, and closing asks to save it. +#[test] +fn save_and_close_apply_a_merge_on_another_thread_first() { + let dir = vectorcraft_testkit::temp_dir("control-merge-save"); + for then in ["file.saveAs", "file.exportAs", "file.close"] { + let services = Services { write: Some(Box::new(|p: &str, b: &[u8]| std::fs::write(p, b).map_err(|e| e.to_string()))), ..Default::default() }; + let mut app = VectorcraftApp::new(Session::new(), services); + app.run("file.new", json!({"width": 800, "height": 200})).unwrap(); + for k in 0..40 { + app.run("shape.rectangle", json!({"x": k * 10, "y": 0, "width": 20, "height": 20})).unwrap(); + } + app.run("select.all", json!({})).unwrap(); + app.run("tool.select", json!({"tool": "shapeBuilder"})).unwrap(); + // As if just saved: only the merge modifies it. + app.session.doc_mut().unwrap().mark_saved(); + let view = app.view_info(); + let at = |kind| PointerEvent { + kind, + pos: vectorcraft_geom::Point::new(15.0, 10.0), + mods: Mods::default(), + pressure: 1.0, + backquote: false, + pen: None, + }; + crate::canvas::dispatch(&mut app, &at(PointerKind::Move), view); + app.session.tool_poll(view, true).unwrap(); + crate::canvas::dispatch(&mut app, &at(PointerKind::Down), view); + crate::canvas::dispatch(&mut app, &at(PointerKind::Up), view); + assert!(app.session.tool_editing() && !app.session.doc().unwrap().is_dirty(), "{then}"); + let path = dir.join(if then == "file.exportAs" { "a.svg" } else { "a.vectorcraft" }); + let p = if then == "file.close" { json!({}) } else { json!({"path": path.to_string_lossy()}) }; + let r = app.run(then, p).unwrap(); + assert!(!app.session.tool_editing(), "{then}"); + let merged = app.session.doc().unwrap().history.undo.last().map(|e| e.label.clone()); + assert_eq!(merged.as_deref(), Some("Shape Builder"), "{then}"); + match then { + "file.saveAs" => assert!(!app.session.doc().unwrap().is_dirty(), "the file holds the merge"), + "file.exportAs" => assert!(app.session.doc().unwrap().is_dirty(), "an export leaves the document modified"), + _ => assert_eq!(r["pending"], "saveChanges", "closing asks to save the merge"), + } + } +} + /// `ui.dialog.set` of a field the open dialog does not have is an error that lists its fields, /// and the dialog stays as it was. Fields a dialog may not hold yet are still set: `discard` /// with a discard button, `preview` with a live preview, `__` fields and the spec's `inputs`. diff --git a/crates/ui-egui/src/io/export.rs b/crates/ui-egui/src/io/export.rs index 52ce3677c..562dc0e00 100644 --- a/crates/ui-egui/src/io/export.rs +++ b/crates/ui-egui/src/io/export.rs @@ -33,6 +33,9 @@ pub fn export(app: &mut VectorcraftApp, format: Option<&str>, path: Option, + /// `ui.pointer` replies waiting for their events and the edit the tool computes on another + /// thread ([`control::Outcome::AfterToolEdit`]), with the numbers of those events. + pointer_replies: Vec, /// Admitted captures whose settled frame has not come yet (issued one at a time). queued_screenshots: Vec, screenshot_token: u64, diff --git a/crates/ui-egui/src/menus/invoke.rs b/crates/ui-egui/src/menus/invoke.rs index 263c458b1..7b3adaffe 100644 --- a/crates/ui-egui/src/menus/invoke.rs +++ b/crates/ui-egui/src/menus/invoke.rs @@ -138,6 +138,11 @@ pub fn invoke(app: &mut VectorcraftApp, id: &str, p: Value) { if waits_for_ime(app, id) { return; } + // A command chosen while the tool computes an edit on another thread (a Shape Builder merge) + // comes after it: the edit is applied first, so the command's dialog, or the app's own dialog + // (Recolor Artwork), opens on the art as the gesture left it. + let r = app.session.finish_tool_edit(); + crate::canvas::apply_requests(app, r); // A shortcut or a palette pick on a filter plug-in does nothing while its menu item is dimmed. if id == "plugin.dialog" && !enabled(app, id) { return; diff --git a/crates/ui-egui/src/menus/run.rs b/crates/ui-egui/src/menus/run.rs index 9e673ca8d..8821679e8 100644 --- a/crates/ui-egui/src/menus/run.rs +++ b/crates/ui-egui/src/menus/run.rs @@ -820,16 +820,21 @@ fn run_ui_part10(app: &mut VectorcraftApp, id: &str, p: &Value) -> Option crate::dialogs::svg_filter::open(app, p), "ui.importSvgFilter" => crate::dialogs::svg_filter::import_file(app), "ui.spotColors" => crate::dialogs::spot_colors::open(app), - "ui.menuDialog" => match s("command").as_deref() { - Some(c) if crate::dialogs::envelope::opens(c) => crate::dialogs::envelope::open(app, c), - c => match c.and_then(|c| menu_dialog(app, c)) { - Some((kind, fields)) => { - app.ui.dialog = Some(crate::state::Dialog::new(kind, fields)); - Ok(Value::Null) - } - None => Err("`command` must be a command whose menu item opens a dialog (see ui.menuDialog)".into()), - }, - }, + "ui.menuDialog" => { + // As from the menu ([`invoke`]), the edit the tool computes on another thread first. + let r = app.session.finish_tool_edit(); + crate::canvas::apply_requests(app, r); + match s("command").as_deref() { + Some(c) if crate::dialogs::envelope::opens(c) => crate::dialogs::envelope::open(app, c), + c => match c.and_then(|c| menu_dialog(app, c)) { + Some((kind, fields)) => { + app.ui.dialog = Some(crate::state::Dialog::new(kind, fields)); + Ok(Value::Null) + } + None => Err("`command` must be a command whose menu item opens a dialog (see ui.menuDialog)".into()), + }, + } + } "ui.widthPointEdit" => crate::dialogs::width_point::open(app, p), "ui.corners" => crate::dialogs::corners::open(app, p), "ui.hyphenation" => crate::dialogs::hyphenation::open(app), diff --git a/crates/ui-egui/src/placing.rs b/crates/ui-egui/src/placing.rs index 7bdc1f9d6..3eacb2832 100644 --- a/crates/ui-egui/src/placing.rs +++ b/crates/ui-egui/src/placing.rs @@ -192,6 +192,10 @@ pub fn available(app: &VectorcraftApp) -> bool { /// checked here first, so a bad one is an error at once. When no thread could start, the file is /// placed at once → `file.place`'s reply. pub fn start(app: &mut VectorcraftApp, p: &Value, dropped: bool) -> Result { + // The edit the tool computes on another thread comes first: the object Replace swaps is the + // one selected after it. + let r = app.session.finish_tool_edit(); + crate::canvas::apply_requests(app, r); let job = app.session.prepare_place(p).map_err(|e| e.to_string())?; let name = job.name(); let started = spawn(app, name.clone(), name, dropped, move || job.read().map(|r| Read::Place(Box::new(r))).map_err(|e| e.to_string()))?; diff --git a/crates/ui-egui/src/placing/tests.rs b/crates/ui-egui/src/placing/tests.rs index fcd209016..96492a651 100644 --- a/crates/ui-egui/src/placing/tests.rs +++ b/crates/ui-egui/src/placing/tests.rs @@ -1166,6 +1166,46 @@ fn a_replace_whose_object_was_deleted_meanwhile_places_nothing() { assert!(state(&app) == cleared, "nothing placed"); } +/// A Replace started while a Shape Builder merge is computed on another thread swaps the object +/// as the merge leaves it: the merge is applied first. +#[test] +fn a_replace_during_a_merge_on_another_thread_swaps_the_merged_object() { + use vectorcraft_tools::{Mods, PointerEvent, PointerKind}; + let path = saved("replace-merge", "photo.tif", &picture(Tiff, 60, 40)); + let mut app = app(true); + for k in 0..40 { + app.run("shape.rectangle", json!({"x": k * 10, "y": 0, "width": 20, "height": 20})).unwrap(); + } + app.run("select.all", json!({})).unwrap(); + app.run("object.group", json!({})).unwrap(); + app.run("tool.select", json!({"tool": "shapeBuilder"})).unwrap(); + let view = app.view_info(); + let at = |kind, x| PointerEvent { + kind, + pos: vectorcraft_geom::Point::new(x, 10.0), + mods: Mods::default(), + pressure: 1.0, + backquote: false, + pen: None, + }; + crate::canvas::dispatch(&mut app, &at(PointerKind::Move, 5.0), view); + app.session.tool_poll(view, true).unwrap(); + // A drag across the row merges every square into one object, the one Replace swaps. + for (kind, x) in [(PointerKind::Down, 5.0), (PointerKind::Drag, 200.0), (PointerKind::Drag, 405.0), (PointerKind::Up, 405.0)] { + crate::canvas::dispatch(&mut app, &at(kind, x), view); + } + assert!(app.session.tool_editing()); + start(&mut app, &json!({"path": path, "replace": true}), false).unwrap(); + assert!(!app.session.tool_editing(), "the merge is applied first"); + placed(&mut app); + assert!(app.ui.status.is_empty(), "{}", app.ui.status); + let mut placed_names = vec![]; + app.session.doc().unwrap().doc.walk(|n| placed_names.extend(n.name.clone())); + assert!(placed_names.iter().any(|n| n == "photo.tif"), "the merged art is replaced: {placed_names:?}"); + let labels: Vec = app.session.doc().unwrap().history.undo.iter().rev().take(2).map(|e| e.label.clone()).collect(); + assert_eq!(labels.last().map(String::as_str), Some("Shape Builder"), "{labels:?}"); +} + /// A file read while a dialog is open waits for the dialog to close, as a document that opens /// does (#1694): the dialog's OK acts on the active document. #[test] diff --git a/crates/ui-egui/src/prefs_dialog.rs b/crates/ui-egui/src/prefs_dialog.rs index d5f391433..fad2d45e7 100644 --- a/crates/ui-egui/src/prefs_dialog.rs +++ b/crates/ui-egui/src/prefs_dialog.rs @@ -493,7 +493,8 @@ fn category_fields(ui: &mut egui::Ui, app: &mut VectorcraftApp, d: &mut Dialog, } } // Linux and the BSDs only, where the desktop may draw the frame: dimmed while System - // Title Bar is on or VECTORCRAFT_TITLEBAR is set, which take precedence over it. A note + // Title Bar is on or VECTORCRAFT_TITLEBAR is set to `app`, `system` or `desktop`, which + // take precedence over it. A note // names each one that is in effect. PrefKind::Bool if sp.key == "appTitleBar" => { if APP_TITLE_BAR_SHOWN { diff --git a/crates/ui-egui/src/state.rs b/crates/ui-egui/src/state.rs index d7f3cc579..53046a5a8 100644 --- a/crates/ui-egui/src/state.rs +++ b/crates/ui-egui/src/state.rs @@ -74,8 +74,9 @@ pub const ROTATE_VIEW_ANGLES: [(&str, f64); 12] = [ ("-90°", -90.0), ]; -use super::{ControlResponse, Sender}; +use super::ControlResponse; use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::mpsc::Sender; /// Zoom stop stepping reads this (set each UI frame and before commands) so canvas wheel zoom /// matches the status bar when Display Print Size at 100% Zoom is on. diff --git a/crates/ui-egui/src/tests/document_drag.rs b/crates/ui-egui/src/tests/document_drag.rs index b5727eaad..f01314a66 100644 --- a/crates/ui-egui/src/tests/document_drag.rs +++ b/crates/ui-egui/src/tests/document_drag.rs @@ -4,6 +4,7 @@ use egui::{Event, PointerButton, Pos2}; use serde_json::json; use vectorcraft_engine::Session; use vectorcraft_geom::Point; +use vectorcraft_tools::{PointerEvent, PointerKind}; use crate::{VectorcraftApp, canvas, chrome}; @@ -142,6 +143,57 @@ fn drag_fixture_modifiers(modifiers: egui::Modifiers) -> (VectorcraftApp, egui:: (app, ctx, grab, tabs) } +/// A Cmd-press held while a Shape Builder merge is computed reaches the lent Selection tool once +/// the merge is applied, and its drag carries the artwork over another tab. +#[test] +fn a_cmd_drag_held_during_a_merge_activates_another_tab() { + let mut app = VectorcraftApp::new(Session::new(), Default::default()); + app.run("file.new", json!({"width":800,"height":200,"name":"Source"})).unwrap(); + for k in 0..40 { + app.run("shape.rectangle", json!({"x": k * 10, "y": 0, "width": 20, "height": 20})).unwrap(); + } + app.run("select.all", json!({})).unwrap(); + app.run("file.new", json!({"width":800,"height":200,"name":"Target"})).unwrap(); + app.session.set_active(0); + app.select_tool("shapeBuilder"); + app.ui.task_bar = false; + app.ui.view.rulers = false; + let ctx = egui::Context::default(); + crate::theme::install_fonts(&ctx); + app.ui_ctx = Some(ctx.clone()); + frame(&mut app, &ctx, 0.0, vec![]); + let tabs = frame(&mut app, &ctx, 0.01, vec![]); + let view = app.view_info(); + app.session.pointer(&PointerEvent::new(PointerKind::Move, 15.0, 10.0), view).unwrap(); + app.session.tool_poll(view, true).unwrap(); + app.session.pointer(&PointerEvent::new(PointerKind::Down, 15.0, 10.0), view).unwrap(); + app.session.pointer(&PointerEvent::new(PointerKind::Up, 15.0, 10.0), view).unwrap(); + assert!(app.session.tool_editing(), "the click starts a merge on another thread"); + let grab = canvas::Xf::new(app.canvas_rect.unwrap(), app.view().unwrap()).to_screen(Point::new(355.0, 10.0)); + let modifiers = egui::Modifiers::COMMAND; + frame( + &mut app, + &ctx, + 0.05, + vec![ + Event::ModifiersChanged(modifiers), + Event::PointerMoved(grab), + Event::PointerButton { pos: grab, button: PointerButton::Primary, pressed: true, modifiers }, + ], + ); + assert_eq!(app.session.tool_id(), "shapeBuilder", "the press waits for the merge"); + let r = app.session.tool_poll(view, true); + canvas::apply_requests(&mut app, r); + frame(&mut app, &ctx, 0.08, vec![]); + assert_eq!(app.session.tool_id(), "selection", "the held press borrowed the Selection tool"); + frame(&mut app, &ctx, 0.1, vec![Event::PointerMoved(grab + egui::vec2(20.0, 10.0))]); + let tab = tabs[1].center(); + frame(&mut app, &ctx, 0.2, vec![Event::PointerMoved(tab)]); + frame(&mut app, &ctx, 0.25, vec![]); + frame(&mut app, &ctx, 0.8, vec![]); + assert_eq!(app.session.active_index(), Some(1), "holding the artwork over the tab activates it"); +} + /// Verify that leaving a tab restarts its dwell timer and hovering its close button never activates it. #[test] fn tab_hover_delay_restarts_after_leaving_and_close_button_does_not_activate() { diff --git a/crates/ui-egui/src/unsaved.rs b/crates/ui-egui/src/unsaved.rs index aa5c107e4..7b068bc7e 100644 --- a/crates/ui-egui/src/unsaved.rs +++ b/crates/ui-egui/src/unsaved.rs @@ -23,11 +23,19 @@ pub(crate) fn refuse_while_picking(app: &VectorcraftApp) -> Result<(), String> { if app.file_sheet_open() { Err(crate::picks::busy().into()) } else { Ok(()) } } +/// Finishes the work that decides whether there is anything left to save: the saves running in +/// the background, and an edit the active tool is computing on another thread (a Shape Builder +/// merge), which is applied. +pub fn finish_pending(app: &mut VectorcraftApp) { + crate::background::wait_all(app); + let r = app.session.finish_tool_edit(); + crate::canvas::apply_requests(app, r); +} + /// File → Close (or a tab's ×) for document `i`. pub fn close(app: &mut VectorcraftApp, i: usize) -> Result { refuse_while_picking(app)?; - // A save still running decides whether there is anything left to save. - crate::background::wait_all(app); + finish_pending(app); let dirty = app.session.documents().get(i).ok_or("no such document")?.is_dirty(); if dirty { ask(app, i, "close") } else { close_now(app, i) } } @@ -36,7 +44,7 @@ pub fn close(app: &mut VectorcraftApp, i: usize) -> Result { /// or finish once none is left. pub fn close_all(app: &mut VectorcraftApp, then: &str) -> Result { refuse_while_picking(app)?; - crate::background::wait_all(app); + finish_pending(app); if let Some(i) = app.session.documents().iter().position(|d| d.is_dirty()) { return ask(app, i, then); } diff --git a/docs/control-protocol.md b/docs/control-protocol.md index fc8b9909b..104d95216 100644 --- a/docs/control-protocol.md +++ b/docs/control-protocol.md @@ -96,7 +96,7 @@ the two can still win that race. | `ui.menu.list` / `ui.menu.invoke` | `{command, params}` | the full menu tree / invoke an item | | `ui.contextMenu.list` | | the canvas context menu for the current selection, flattened like `ui.menu.list` (`path` holds its submenus). `ui.click {x, y, button: "right"}` on the canvas opens it, after selecting the object there unless it is already selected. With the Artboard tool it lists the artboard entries (see `docs/mcp.md`), after selecting the artboard there unless it is already selected. While a menu opened over locked objects is open, it has an `Unlock` submenu with one item for each locked object under the pointer, topmost first and at most 20, labeled with the object's name, which runs `layer.setProps {ids: [id], locked: false}`. A locked group gets one item, and the locked objects inside it get none. Hidden objects, objects on hidden, locked or template layers, and in isolation mode objects outside the isolated group get no item | | `ui.tool.select` / `ui.tool.list` | `{tool}` | | -| `ui.pointer` | `{events:[{kind: down|drag|up|move|doubleclick, x, y, space?: "doc"|"screen", mods?}]}` | drive the active tool exactly like the mouse: `mods.cmd` held at a press with any tool but a selection tool drags with the selection tool chosen last (Direct Selection with the Pen until one is), and the release gives the tool back as it was; the reply lists `selection`, `key` (the key object, null without one) and `tool`. With the Shape Builder or the Live Paint Bucket and a selection of more than 128 segments, the app finds the regions off the UI thread, so a `move` replies before the region under the pointer is highlighted, and the highlight shows in the first frame after the regions are found | +| `ui.pointer` | `{events:[{kind: down|drag|up|move|doubleclick, x, y, space?: "doc"|"screen", mods?}]}` | drive the active tool exactly like the mouse: `mods.cmd` held at a press with any tool but a selection tool drags with the selection tool chosen last (Direct Selection with the Pen until one is), and the release gives the tool back as it was; the reply lists `selection`, `key` (the key object, null without one) and `tool`. With the Shape Builder or the Live Paint Bucket and a selection of more than 128 segments, the app finds the regions off the UI thread, so a `move` replies before the region under the pointer is highlighted, and the highlight shows in the first frame after the regions are found. With the Shape Builder and such a selection, the app also merges off the UI thread: the reply to the events that end a click or drag comes once the merge is applied. A click or drag made before the regions are found does not wait for them; the app records it and makes it once they are found. Until then the canvas keeps drawing, with the touched regions highlighted and the busy pointer. A click or drag sent meanwhile, with `mods.cmd` too, and the Shape Builder's arrow keys are made after the merge in the order sent, and the reply to such a request comes once its events are made and any merge they start is applied; a request of `move` events alone is answered at once. A command that can edit, select, save or redraw the documents (an edit, an undo, a selection, a save or an export, a tool option, another tool, another document, closing, a dialog's preview, a menu item, a command of the app's own such as `ui.recolorDialog`, the proof and separations views, a preference, added fonts) waits for the merge and the input sent before it, and runs after them; queries that only read, such as `document.inspect`, run at once on the document before the merge | | `ui.key` / `ui.text` | `{key, shift?, alt?, cmd?}` / `{text}` | synthetic keyboard input | | `ui.move` | `{x, y}` | screen-point pointer move | | `ui.click` / `ui.drag` | `{x, y, button?, count?, shift?, alt?, ctrl?, cmd?}` / `{x, y, toX, toY, steps?, count?, button?, shift?, alt?, ctrl?, cmd?}` | egui pointer input; see synthetic input budgets above | @@ -344,7 +344,9 @@ sessions where the desktop would draw the frame: X11 sessions, Wayland composito such as KDE Plasma, and a window opened through XWayland. System Title Bar and `VECTORCRAFT_TITLEBAR` (`app`, or `system` or `desktop`) take precedence over it. The checkbox is dimmed while either applies, and a note under it names each one that applies. `VECTORCRAFT_TITLEBAR` also takes precedence over System Title Bar for the run it is set in: -`app` keeps the app bar as the title bar with System Title Bar on. While the variable is set, the Preferences dialog dims +`app` keeps the app bar as the title bar with System Title Bar on. Only the values `app`, `system` and `desktop` take +precedence (case-sensitive, surrounding spaces ignored); any other value, such as `unknown`, is ignored and does not +override System Title Bar. While the variable is set to one of those values, the Preferences dialog dims System Title Bar and its `__titlebarFromEnv` field is `true`. Fill/Stroke chips and panel shortcuts: the Control bar's and Properties' Fill and Stroke chips bring their proxy diff --git a/docs/development.md b/docs/development.md index a4077abc6..c6523bd03 100644 --- a/docs/development.md +++ b/docs/development.md @@ -118,7 +118,7 @@ A file opened from the file manager (double-click, Open With, a drop on the exec ## Linux: Wayland and X11 -On GNOME/Wayland, enable **Preferences › User Interface › System Title Bar** and restart to use winit's font-free Adwaita window controls (`wayland-csd-adwaita-notitle`); the existing custom title bar remains the Linux default. On X11, on a Wayland compositor that draws server-side decorations such as KDE Plasma, and in a window opened through XWayland, enable **Preferences › User Interface › VectorCraft Title Bar on Every Desktop** and restart to use the app bar as the title bar instead of the desktop's frame. `VECTORCRAFT_TITLEBAR=app`, `=system` or `=desktop` chooses the frame for one run and takes precedence over System Title Bar and VectorCraft Title Bar on Every Desktop. +On GNOME/Wayland, enable **Preferences › User Interface › System Title Bar** and restart to use winit's font-free Adwaita window controls (`wayland-csd-adwaita-notitle`); the existing custom title bar remains the Linux default. On X11, on a Wayland compositor that draws server-side decorations such as KDE Plasma, and in a window opened through XWayland, enable **Preferences › User Interface › VectorCraft Title Bar on Every Desktop** and restart to use the app bar as the title bar instead of the desktop's frame. `VECTORCRAFT_TITLEBAR=app`, `=system` or `=desktop` chooses the frame for one run and takes precedence over System Title Bar and VectorCraft Title Bar on Every Desktop. The variable is case-sensitive and surrounding spaces are ignored; any other value, such as `unknown`, is ignored and does not override System Title Bar. The window runs natively on Wayland (eframe's `wayland` feature) and on X11. On machines with two GPUs it renders on the one the desktop runs on unless Preferences say otherwise; see [Desktop graphics processor](#desktop-graphics-processor) (#502). The system clipboard (`apps/vectorcraft/src/clipboard.rs`) is arboard with its `wayland-data-control` feature: diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index cbd5c3788..71f595508 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-11-07 · **Change:** minor (`.ai` and EPS import: Art brushes in the older form of their objects come into the Brushes panel; EPS import: gradients drawn as abutting strips come in as one gradient, without seams; EPS import: composite fonts draw their Type 42 glyphs; SVG import: filter and mask regions clip, #5876, #5875; SVG import: Gaussian blurs keep `color-interpolation-filters`, #5877; PDF and `.ai` export: objects' URLs as links, #5785; SVG import: `color-interpolation="linearRGB"` gradients, #5878; `.ai` import: paths with a Calligraphic brush open brushed, #372) · **Target:** Adobe Illustrator 2026 (30.x) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-07 · **Change:** minor (`.ai` and EPS type from the text document keeps its tab stops; it keeps auto leading and hyphenation options, and may show more of the file's last lines in an area frame; `.ai` and EPS import: Art brushes in the older form of their objects come into the Brushes panel; EPS import: gradients drawn as abutting strips come in as one gradient, without seams; EPS import: composite fonts draw their Type 42 glyphs; SVG import: filter and mask regions clip, #5876, #5875; SVG import: Gaussian blurs keep `color-interpolation-filters`, #5877; PDF and `.ai` export: objects' URLs as links, #5785; SVG import: `color-interpolation="linearRGB"` gradients, #5878; `.ai` import: paths with a Calligraphic brush open brushed, #372) · **Target:** Adobe Illustrator 2026 (30.x) Every format Illustrator opens, places, saves or exports, against VectorCraft's format table (`FORMATS`, `OPEN_EXTS`, `PLACE_EXTS` in `crates/engine/src/cmd/fileio/formats.rs`). Illustrator's list comes from its public @@ -52,6 +52,11 @@ private editing data. VectorCraft: An opacity mask's art of one shown object, other than a guide or a clipping path, opens as that object in the editing data of a `.ai`, EPS or PDF; other art opens in a group. Art in the mask that sets no paint of its own paints with the paint before the mask's dictionary, as the writer leaves out paint that doesn't change. + Type from the text document keeps auto leading as auto, each line taking the paragraph's share + (Auto Leading) of the largest type on it ([Line and character spacing](https://helpx.adobe.com/illustrator/using/line-character-spacing.html)), + and the paragraph's hyphenation options and tab stops. Area type of one + frame whose last lines the file sets but which don't fit here (the fallback font, or a descent + past the frame's bottom) may get a frame taller from its bottom, by its lines' deepest descent plus 0.05 pt and only when that shows more of those lines, with a warning when it does. RGB in the PDF page's `ICCBased` spaces keeps the file's numbers in a `.ai` (the `uncalibrated_rgb` import option, on for editor documents, off for PDFs), so `.ai` files tagged with a non-sRGB RGB profile open with different, unconverted RGB colours than before. @@ -315,6 +320,8 @@ Names in the editing data that aren't UTF-8 (layers, objects, artboards, colors, | Date | Change | Summary | |---|---|---| +| 2026-11-07 | minor | EPS and `.ai` type from the text document keeps its paragraphs' tab stops (positions and alignments; leaders aren't read), at most 1,024 a paragraph and 2^20 a story, past which the default stops apply with a warning. A user's `.ai` (used locally, not committed) whose price lists came in on the default stops now lays them out as its page has them (its type 0.8% from its page, from 1.5%; what differs is hyphenation in Hungarian and type in a font that isn't installed). Scores and estimates unchanged. | +| 2026-11-07 | minor | EPS and `.ai` type from the text document: auto leading stays auto at the paragraph's share (it was the first two lines' distance for every line, so 10 pt lines under a 15 pt heading came in 18 pt apart), the paragraph's hyphenation options are read, and area type of one frame whose last lines the file sets in too short a frame for them here may get a frame taller by its lines' deepest descent plus 0.05 pt, when that shows more of them. A user's `.ai` (used locally, not committed) whose type differed from its page by 6.6%, so that it opened from its PDF part, now opens from its layers (4.9%; type with tab stops in right-aligned paragraphs still differs, a separate issue) (#6137). Scores and estimates unchanged. | | 2026-11-06 | minor | EPS and `.ai` editing data: a path or compound path whose art style stacks several fills and strokes (solid colours and gradients, each with its own visibility, opacity and blend mode, under effects any object takes) comes in as itself with that appearance instead of its drawn look. Each gradient must be its own swatch, placed as the drawn look places it; a stack that repeats a swatch, or whose look doesn't paint its gradients, keeps the drawn look, as do fills and strokes with effects of their own. | | 2026-11-06 | minor | `.ai` and EPS import: Art brushes whose objects are in the older form (first number 1, one field fewer and 8 numbers at the end) come into the Brushes panel with their art instead of being left out with a note. In a survey of 302 users' EPS files (used locally, not committed), 652 Art brushes in 188 of the 197 files with the note were left out this way; afterwards 55 files have the note, all for Pattern brushes. Test `an_older_art_brush_comes_in_with_its_art` (crate `vectorcraft-eps`); scores unchanged | | 2026-11-06 | minor | EPS import: composite (Type 0) fonts with the 8/8 mapping (`FMapType` 2: PLRM 3rd ed., §5.10) draw a Type 42 descendant's glyphs from the TrueType outlines its `sfnts` carry (Adobe Technical Note #5012), spaced by their own widths or the show operator's numbers, and `charpath` and `stringwidth` read them; descendants found by name set their characters as type at the composite font's size instead of a thousand times it. EPS from `pdftops` of a PDF with embedded TrueType fonts showed nothing, or one black shape, where its type was. | diff --git a/docs/mcp.md b/docs/mcp.md index 6b044edb5..74c330407 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -451,8 +451,8 @@ opens the picker through `run_command` with the remote backend. | `inspect_document` | `{depth?, childLimit?, ids?, kind?, limit?, offset?}` | Artboards (with `color`, `#rrggbb`, for one with a background color), layer tree (ids, kinds, bounds, paint), selection, history, tool. A type node's `fill`, `stroke` and `strokeWidth` are the paint its characters show (its first run's); fills and strokes of the type object itself come as `objectFill`, `objectStroke` and `objectStrokeWidth`. Paint comes as a label (`"#ff0000"`, `"None"`, `"G1 40% (#ff9999)"` for a swatch at a tint); `paint.proxies` gives it as an object. | | `inspect_ui` | `{}` | UI state. Remote mode only. | | `select_tool` | `{tool}` | `selection`, `directSelection`, `pen`, `rectangle`, `ellipse`, `polygon`, `star`, `lineSegment`, … | -| `pointer_gesture` | `{events:[{kind,x,y,mods?,backquote?,pressure?,tiltX?,tiltY?,rotation?,holdMs?}], tool?, mods?, backquote?}` | `kind` is one of `down`, `drag`, `up`, `move`, `doubleclick`. `backquote` is the held state for each event; the top-level value supplies its default, and a `backquote` that is not a boolean is an error. Events go through the same path as the mouse. Headless, a `move` replies after the tool's highlight under the pointer is ready, including the Shape Builder's and the Live Paint Bucket's regions of a large selection, which the desktop app finds off the UI thread and highlights after the reply. | -| `pointer_gesture` | `{events:[{kind,x,y,mods?,backquote?,pressure?,tiltX?,tiltY?,rotation?,holdMs?}], tool?, mods?, backquote?}` | `kind` is one of `down`, `drag`, `up`, `move`, `doubleclick`. `backquote` is the held state for each event; the top-level value supplies its default. Events go through the same path as the mouse. Headless, a `move` replies after the tool's highlight under the pointer is ready, including the Shape Builder's and the Live Paint Bucket's regions of a large selection, which the desktop app finds off the UI thread and highlights after the reply. Remote, the events wait until the keys and other input sent before them (`press_key`, `type_text`) have reached the app, so a key pressed between two calls of one drag applies before the release. When that input is dropped because the document, a dialog or the focus changed first, the call fails and its events are not sent. | +| `pointer_gesture` | `{events:[{kind,x,y,mods?,backquote?,pressure?,tiltX?,tiltY?,rotation?,holdMs?}], tool?, mods?, backquote?}` | `kind` is one of `down`, `drag`, `up`, `move`, `doubleclick`. `backquote` is the held state for each event; the top-level value supplies its default, and a `backquote` that is not a boolean is an error. Events go through the same path as the mouse. Headless, a `move` replies after the tool's highlight under the pointer is ready, including the Shape Builder's and the Live Paint Bucket's regions of a large selection, which the desktop app finds off the UI thread and highlights after the reply. The release of a Shape Builder click or drag over such a selection replies once the merge is applied, headless and in the desktop app, which computes the merge off the UI thread. In the desktop app, a gesture sent before then is made after the merge, and its reply comes once it is made; a command that can edit, select, save or redraw the documents (a preference, the proof and separations views), sent before then, waits for the merge and runs after it. | +| `pointer_gesture` | `{events:[{kind,x,y,mods?,backquote?,pressure?,tiltX?,tiltY?,rotation?,holdMs?}], tool?, mods?, backquote?}` | `kind` is one of `down`, `drag`, `up`, `move`, `doubleclick`. `backquote` is the held state for each event; the top-level value supplies its default. Events go through the same path as the mouse. Headless, a `move` replies after the tool's highlight under the pointer is ready, including the Shape Builder's and the Live Paint Bucket's regions of a large selection, which the desktop app finds off the UI thread and highlights after the reply. Remote, the events wait until the keys and other input sent before them (`press_key`, `type_text`) have reached the app, so a key pressed between two calls of one drag applies before the release. When that input is dropped because the document, a dialog or the focus changed first, the call fails and its events are not sent. The release of a Shape Builder click or drag over such a selection replies once the merge is applied, headless and in the desktop app, which computes the merge off the UI thread. In the desktop app, a gesture sent before then is made after the merge, and its reply comes once it is made; a command that can edit, select, save or redraw the documents (a preference, the proof and separations views), sent before then, waits for the merge and runs after it. | | `draw_path` | `{points \| d, closed?, fill?, stroke?, strokeWidth?, dash?, cap?, join?, opacity?, name?, effects?}` | `points` is `[[x,y],…]` or `[{x,y,in?,out?,smooth?},…]`. `d` is SVG path data. The options are below. | | `draw_shape` | `{shape, …geometry, fill?, stroke?, strokeWidth?, dash?, cap?, join?, opacity?, name?, effects?}` | `rectangle`/`ellipse`: `x,y,width,height` (plus `radius` for corners). `polygon`: `cx,cy,radius,sides`. `star`: `cx,cy,radius1,radius2,points`. `line`: `x1,y1,x2,y2`. | | `set_paint` | `{fill?, stroke?, strokeWidth?, ids?}` | Applies to the selection (or `ids`) and becomes the default for new art. Returns `{applied, objects}`: `objects` is the number of objects painted, as the `objects` of the `paint.setFill`, `paint.setStroke` and `stroke.set` replies (the largest of them): a selected group counts the objects inside it. When it is 0, a `note` says that only the paint for new art changed. | diff --git a/docs/roadmap.md b/docs/roadmap.md index a5e5a3558..69fea5b1c 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,6 +1,6 @@ # Roadmap: milestones and what's next -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-09 · **Change:** minor (numeric fields step on wheel hover without taking keyboard focus, #5949) · **Target:** Adobe Illustrator 2026 (30.x) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-09 · **Change:** minor (M4/M7: `.ai`/EPS type keeps its tab stops, and right-aligned lines with tabs lay out as the file's page, #6147; M4/M7: `.ai`/EPS type from the text document lays its lines out closer to the file's page, within limits, #6137; numeric fields step on wheel hover without taking keyboard focus, #5949) · **Target:** Adobe Illustrator 2026 (30.x) ## Feature submission evidence @@ -40,6 +40,8 @@ M7 type: Touch Type moves a right-to-left character along its line and up from i | Date | Change | Summary | |---|---|---| +| 2026-11-07 | minor | M4/M7: `.ai`/EPS type from the text document keeps its paragraphs' tab stops, and right-aligned area type sets the text after a line's last tab against the right edge, the text before it at its stops from the left edge (#6147). Scores and estimates unchanged. | +| 2026-11-07 | minor | M4/M7: `.ai`/EPS type from the text document keeps auto leading at the paragraph's share, the paragraph's hyphenation options and may show more of the last lines the file sets in an area frame of its own, when growing the frame by its lines' deepest descent plus 0.05 pt shows them, and a line a soft return ends is justified as a wrapped line is (#6137); a user's `.ai` that opened from its PDF part now opens from its layers. Limits: frames grow only for area type of one frame, horizontal, by its lines' deepest descent plus 0.05 pt; type in a font that isn't installed, and hyphenation in a language that isn't imported, still lay out differently. Scores and estimates unchanged. | | 2026-11-08 | minor | Character Styles panel: a double-click on a user style's row opens its Character Style Options (`ui.charStyleOptions`); the dialog keeps a fixed width and scrolls its sections in a shorter window, so OK and Cancel stay on screen. Tests `panels::text_styles::tests::double_clicking_a_character_style_row_opens_its_options` and `dialogs::char_style_options::tests::the_sections_scroll_in_a_window_shorter_than_the_general_list`. Scores and estimates unchanged. | | 2026-11-02 | minor | Selection QoL: saved marquee modes, screen drag direction with a 3 px dead zone, and translated mode/E feedback (#5313); VectorCraft addition, scores and estimates unchanged. | | 2026-11-07 | minor | Indian-language hyphenation (#4947): eleven MIT-licensed pattern sets, with grapheme and shaping-cluster protection in both composers and existing paragraph limits. Assamese and Sanskrit are selectable; Sanskrit automatic patterns remain pending an allowlisted source. Scores and estimates unchanged. | @@ -131,13 +133,13 @@ native wording review, layout checks and a web Devanagari font remain. [Notes](l | M2 | Drawing tools + smart guides | ✅ mostly done (Polygon/Star exact-size count persistence, with repeated-drag, tool-switch and Cancel regression coverage; Curvature point markers without direction handles (#1236, in part); Direct Selection segment click/Delete preserves neighboring edges, #1278; Flare, Reshape, Live Corners widget dragging and per-corner radii and kinds landed, on any path's corners; Shaper rough-shape recognition and orientation steps, the remaining Pen modifier nuances; Shaper Groups with editable sources and separate fill/stroke edits landed; custom ruler origin with drag preview, active-artboard reset, relative X/Y fields and native round-trip (#1212); construction widget/refinements pending); Tangent and straight-segment perpendicular snapping use saved Smart Guides Geometric Guides preferences and Control bar quick access (#2537); no View submenu | 12–18 | | M3 | Paint & appearance (swatches, color, gradient, stroke, appearance, transparency, styles) | ✅ done (M3.7–M3.98): swatches, groups, libraries, tints, Lab spots and Registration; Eyedropper styles highlighted text only (atomic transparency rejection); Eyedropper reads visible locked and outside-isolation sources (#1251); Color Picker, Color panel, Color Guide, Color Themes, Edit Colors and Recolor Artwork (screen-bounded Edit chip list, #3416); gradients that follow every transform, the annotator, linked stops, freeform gradients, focal points, gradients on strokes and Expand; visible strokes when paint is added to inherited None/zero-width art (#1253); stroke geometry, arrowheads, dashes fitted to corners, stroke on type, width profiles and the Width tool (Shift-double-click enables adjoining adjustment in Width Point Edit; finite-arithmetic follow-up regressions and full CI passed ([Validation evidence](target-app-parity.md#evidence-what-ships-today-by-area))), Scale Strokes and preview bounds; Appearance targeting, container appearance, target circles, Expand Appearance; knockout, isolation, blend accuracy, CMYK blending, overprint, Attributes, masks and clipping, Flatten Transparency; graphic styles, links and libraries; CSS library export preserves fractional linear and radial gradient stop positions. Left: freeform gradients in SVG/PDF, mixed spot/process gradients in SVG and PDF gradients mixing a spot color with RGB or Lab stops export as stops or process colors; PDF export writes dithered gradient fills with spot stops, and Perceptual spot gradients with RGB or Lab stops other than white or more than 4,096 stops on their curve, as images in process colors; confirm the Scale Strokes & Effects default; Recolor model selection is available through the engine and MCP only (#2520); the dialog retains its existing controls | 4–8 | | M2 | Drawing tools + smart guides | ✅ mostly done (Curvature point markers without direction handles (#1236, in part); Direct Selection segment click/Delete preserves neighboring edges, #1278; Flare, Reshape, Live Corners widget dragging and per-corner radii and kinds landed, on any path's corners; Shaper rough-shape recognition and orientation steps, the remaining Pen modifier nuances; Shaper Groups with editable sources and separate fill/stroke edits landed; custom ruler origin with drag preview, active-artboard reset, relative X/Y fields and native round-trip (#1212); construction widget/refinements pending) | 12–18 | -| M4 | Files (native, SVG, PDF, raster, Export for Screens, clipboard interop) | ✅ done (M4.14–M4.98 on 2026-10-05): Save As/Save a Copy/Revert/templates, Data Recovery and background save, SVG import and export fidelity (units, text, symbols, filters, SVGZ, Preserve Editing, SVG Options), shared guarded PDF writer and windowed reader ([pdf-backend.md](pdf-backend.md)), PDF import (colours, layers, masks, editable text, security) and export (presets, marks, bleed, ICC and output intent, raster effects, subset fonts, PDF/X-1a, X-3 and X-4, PDF layers, overprint, page thumbnails, fast web view, PDF 1.3), Place and Links, Package, EPS and DXF in and out (EPS legacy mesh corners, vector opacity masks and raster page comparison verified; closed SPLINE flags round-trip and circular paths export as native CIRCLE/ARC, #1299), EMF/WMF, TIFF/BMP/Targa/PSD/GIF/PNG-8 export, Print and print presets, slices, Save for Web, TIFF in Export for Screens and Asset Export, clipboard flavours, File Info; AF.1–AF.4 add Affinity import (native layers, artboards, vectors, text and images from Affinity 1–3 files; the embedded preview only as a warned fallback; AF.4 expands current `.af` fixtures and every-board round-trip validation); EPS Save and Save As keep an opened EPS as EPS with its page frame and complete editable VectorCraft document (2026-10-26; G9 import fidelity unchanged). Left: DWG (use DXF), PSD placement as layers, overprint read back from PDF, Affinity export, polish; SVG CSS classes survive export and repeated import in all four styling modes (#2480); current-main integration retains event attributes and scripts; SVG CSS classes survive export and repeated import in all four styling modes (#2480); current-main integration retains event attributes and scripts | 3–6 (existing scope; Affinity export unestimated) | +| M4 | Files (native, SVG, PDF, raster, Export for Screens, clipboard interop) | `.ai`/EPS type from the text document keeps its paragraphs' tab stops (#6147); `.ai`/EPS type from the text document keeps auto leading per line, its hyphenation options, and may show more of the last lines the file sets in an area frame of its own, when growing the frame by its lines' deepest descent plus 0.05 pt shows them (#6137); ✅ done (M4.14–M4.98 on 2026-10-05): Save As/Save a Copy/Revert/templates, Data Recovery and background save, SVG import and export fidelity (units, text, symbols, filters, SVGZ, Preserve Editing, SVG Options), shared guarded PDF writer and windowed reader ([pdf-backend.md](pdf-backend.md)), PDF import (colours, layers, masks, editable text, security) and export (presets, marks, bleed, ICC and output intent, raster effects, subset fonts, PDF/X-1a, X-3 and X-4, PDF layers, overprint, page thumbnails, fast web view, PDF 1.3), Place and Links, Package, EPS and DXF in and out (EPS legacy mesh corners, vector opacity masks and raster page comparison verified; closed SPLINE flags round-trip and circular paths export as native CIRCLE/ARC, #1299), EMF/WMF, TIFF/BMP/Targa/PSD/GIF/PNG-8 export, Print and print presets, slices, Save for Web, TIFF in Export for Screens and Asset Export, clipboard flavours, File Info; AF.1–AF.4 add Affinity import (native layers, artboards, vectors, text and images from Affinity 1–3 files; the embedded preview only as a warned fallback; AF.4 expands current `.af` fixtures and every-board round-trip validation); EPS Save and Save As keep an opened EPS as EPS with its page frame and complete editable VectorCraft document (2026-10-26; G9 import fidelity unchanged). Left: DWG (use DXF), PSD placement as layers, overprint read back from PDF, Affinity export, polish; SVG CSS classes survive export and repeated import in all four styling modes (#2480); current-main integration retains event attributes and scripts; SVG CSS classes survive export and repeated import in all four styling modes (#2480); current-main integration retains event attributes and scripts | 3–6 (existing scope; Affinity export unestimated) | | M3 | Paint & appearance (swatches, color, gradient, stroke, appearance, transparency, styles) | ✅ done (M3.7–M3.98): swatches, groups, libraries, tints, Lab spots and Registration; Eyedropper styles highlighted text only (atomic transparency rejection); Eyedropper reads visible locked and outside-isolation sources (#1251); Color Picker, Color panel, Color Guide, Color Themes, Edit Colors and Recolor Artwork (screen-bounded Edit chip list, #3416); gradients that follow every transform, the annotator, linked stops, freeform gradients, focal points, gradients on strokes and Expand; visible strokes when paint is added to inherited None/zero-width art (#1253); stroke geometry, arrowheads, dashes fitted to corners, stroke on type, width profiles and the Width tool (Shift-double-click enables adjoining adjustment in Width Point Edit), Scale Strokes and preview bounds; Appearance targeting, container appearance, target circles, Expand Appearance; knockout, isolation, blend accuracy, CMYK blending, overprint, Attributes, masks and clipping, Flatten Transparency; graphic styles, links and libraries; CSS library export preserves fractional linear and radial gradient stop positions. Left: freeform gradients in SVG/PDF, mixed spot/process gradients in SVG and PDF gradients mixing a spot color with RGB or Lab stops export as stops or process colors; PDF export writes dithered gradient fills with spot stops, and Perceptual spot gradients with RGB or Lab stops other than white or more than 4,096 stops on their curve, as images in process colors; confirm the Scale Strokes & Effects default | 4–8 | | M5 | Performance | 🟡 background render + caches + MT done; `vectorcraft-cli bench` and `vectorcraft-cli perf` (budget suite); opaque solid-fill knockout paths draw once in hard-edge/supersampled raster export, with analytical-AA compositing unchanged; file format v2 opens 3× faster (50k paths: 722 → 244 ms); raster effects (glows, shadows, blur, feather) no longer force the whole frame single-threaded (filtered offscreen per effect, verified equal to the single-threaded reference); Craquelure/Mosaic Tiles/Stained Glass distance searches optimized with pixel-invariance checks and the `texture_drag_perf` probe (#1257); effect-heavy demos need a clean-machine benchmark; dirty-region rendering, GPU backend spike pending | 15–25 | | M6 | Path operations (Pathfinder, Shape Builder, offset…) | ✅ mostly done (live compound shapes: Make, Alt-click a Shape Mode, member modes, Release, Expand (#4522); single-result Pathfinder names and SVG IDs retained (#1293); Divide open-cutting-path geometry, appearance and history verified (#1307; existing segment cap remains); Simplify preview/counts and rewritten-path component selection verified (#1272; the slider opens at the Auto-Simplify level; a Direct Selection part of a path simplifies on its own); Compound appearance and member fill-rule edits verified (#1197); Boolean precision on almost-horizontal edges fixed and the property tests made deterministic; Shape Builder gap detection, large-offset bug open); Shape Builder Gap Detection shares Live Paint’s spatial gap finder and temporary merge bridges (#2526); Custom is capped at 72 pt in the existing options dialog | 3–6 | -| M7 | Type (point/area/path, editing, styles, OpenType, threading, glyphs) | Indian-language pattern hyphenation preserves syllables in both composers (#4947); 🟡 Hanging punctuation keeps its published amounts under Glyph Scaling, and Standard burasagari counts a hung line start as room; Fullwidth `!` / `?` keep an upright fallback in vertical type; Document-point character controls after object/group scaling (#1034; optional font-size preservation remains separate), Character/Paragraph Styles (explicit Auto-leading resets and local leading overrides), per-paragraph paragraph attributes, mixed paragraph alignment indication (headless regressions, full integration CI and visual review pass), Area Type Options (with Width/Height, Auto Size and Shrink Text to Fit; overflow reported to agents and vertical Align), type areas resized by their handles and reshaped with Direct Selection, threaded text, Fit Headline, Glyphs, OpenType panel (including font-defined Stylistic Sets), Find Font (Document, Recent and System replacement sources, #5217), installed system fonts in every font menu (fonts registered with Windows outside its font folders, the XDG and Flatpak host font folders on Linux, and fonts installed while the app runs, listed when it comes back to the front; searchable; the Character and Properties menus show each family's sample of the selected text, preview it live under the pointer or ↑/↓, show recently applied families first (#3515), filter by script and kind, list a family's styles, and star favourites; the Glyphs panel and Find Font's Replace With use the same menu without the live preview) and found by name on open/import (full-name aliases and Missing Fonts searches verified, #1258; Windows font-service QA pending), variable fonts' named instances as styles, CJK names in the UI, input methods (marked text in place, candidate window at the caret; Japanese IME), Text Wrap (offset, invert, both sides of an object; follows edits), Type on a Path effects and Options with draggable start/centre/end brackets (slide, flip), tab stops + Tabs panel (Above Text floats it over the selected text, its ruler at the canvas zoom so stops line up with the columns, #729), inline symbols in text (beyond parity), Hebrew/Arabic bidirectional text, Paragraph Direction, Every-line/Single-line Composer per object (ragged text too) done; tab leaders, spell check, vertical type pending | 45–60 | -| M7 | Type (point/area/path, editing, styles, OpenType, threading, glyphs) | Indian-language pattern hyphenation preserves syllables in both composers (#4947); 🟡 Fullwidth `!` / `?` keep an upright fallback in vertical type; Hyphenation… and Justification… per paragraph (#2310, #2755), Auto Leading also driving the Character panel's Leading, the Alt+↑/↓ leading nudge and Fill with Placeholder Text; Document-point character controls after object/group scaling (#1034; optional font-size preservation remains separate), Character/Paragraph Styles (explicit Auto-leading resets and local leading overrides), per-paragraph paragraph attributes, mixed paragraph alignment indication (headless regressions, full integration CI and visual review pass), Area Type Options (with Width/Height, Auto Size and Shrink Text to Fit; overflow reported to agents and vertical Align), type areas resized by their handles and reshaped with Direct Selection, threaded text, Fit Headline, Glyphs, OpenType panel, Find Font (Document, Recent and System replacement sources, #5217), installed system fonts in every font menu (fonts registered with Windows outside its font folders, the XDG and Flatpak host font folders on Linux, and fonts installed while the app runs, listed when it comes back to the front; searchable; the Character and Properties menus show each family's sample of the selected text, preview it live under the pointer or ↑/↓, filter by script and kind, list a family's styles, and star favourites; the Glyphs panel and Find Font's Replace With use the same menu without the live preview) and found by name on open/import (full-name aliases and Missing Fonts searches verified, #1258; Windows font-service QA pending), variable fonts' named instances as styles, CJK names in the UI, input methods (marked text in place, candidate window at the caret; Japanese IME), Text Wrap (offset, invert, both sides of an object; follows edits), Type on a Path effects and Options with draggable start/centre/end brackets (slide, flip), tab stops + Tabs panel (Above Text floats it over the selected text, its ruler at the canvas zoom so stops line up with the columns, #729), inline symbols in text (beyond parity), Hebrew/Arabic bidirectional text, Paragraph Direction, Every-line/Single-line Composer per object (ragged text too) done; tab leaders, spell check, vertical type pending | 45–60 | -| M7 | Type (point/area/path, editing, styles, OpenType, threading, glyphs) | Indian-language pattern hyphenation preserves syllables in both composers (#4947); 🟡 Fullwidth `!` / `?` keep an upright fallback in vertical type; Document-point character controls after object/group scaling (#1034; optional font-size preservation remains separate), Character/Paragraph Styles (explicit Auto-leading resets and local leading overrides), per-paragraph paragraph attributes, mixed paragraph alignment indication (headless regressions, full integration CI and visual review pass), Area Type Options (with Width/Height, Auto Size and Shrink Text to Fit; overflow reported to agents and vertical Align), type areas resized by their handles and reshaped with Direct Selection, threaded text, Fit Headline, Glyphs, OpenType panel, Find Font (Document, Recent and System replacement sources, #5217), installed system fonts in every font menu (fonts registered with Windows outside its font folders, the XDG and Flatpak host font folders on Linux, and fonts installed while the app runs, listed when it comes back to the front; searchable; the Character and Properties menus show each family's sample of the selected text, preview it live under the pointer or ↑/↓, show recently applied families first (#3515), filter by script and kind, list a family's styles, and star favourites; the Glyphs panel and Find Font's Replace With use the same menu without the live preview) and found by name on open/import (full-name aliases and Missing Fonts searches verified, #1258; Windows font-service QA pending), variable fonts' named instances as styles, CJK names in the UI, input methods (marked text in place, candidate window at the caret; Japanese IME), Text Wrap (offset, invert, both sides of an object; follows edits), Type on a Path effects and Options with draggable start/centre/end brackets (slide, flip), tab stops + Tabs panel (Above Text floats it over the selected text, its ruler at the canvas zoom so stops line up with the columns, #729), inline symbols in text (beyond parity), Hebrew/Arabic bidirectional text, Paragraph Direction, Every-line/Single-line Composer per object (ragged text too) done; tab leaders, spell check, vertical type pending | 45–60 | +| M7 | Type (point/area/path, editing, styles, OpenType, threading, glyphs) | Right-aligned area type sets the text after a line's last tab against the right edge, the text before it at its stops (#6147); A line a soft return ends is justified as a wrapped line is (#6137); Indian-language pattern hyphenation preserves syllables in both composers (#4947); 🟡 Hanging punctuation keeps its published amounts under Glyph Scaling, and Standard burasagari counts a hung line start as room; Fullwidth `!` / `?` keep an upright fallback in vertical type; Document-point character controls after object/group scaling (#1034; optional font-size preservation remains separate), Character/Paragraph Styles (explicit Auto-leading resets and local leading overrides), per-paragraph paragraph attributes, mixed paragraph alignment indication (headless regressions, full integration CI and visual review pass), Area Type Options (with Width/Height, Auto Size and Shrink Text to Fit; overflow reported to agents and vertical Align), type areas resized by their handles and reshaped with Direct Selection, threaded text, Fit Headline, Glyphs, OpenType panel (including font-defined Stylistic Sets), Find Font (Document, Recent and System replacement sources, #5217), installed system fonts in every font menu (fonts registered with Windows outside its font folders, the XDG and Flatpak host font folders on Linux, and fonts installed while the app runs, listed when it comes back to the front; searchable; the Character and Properties menus show each family's sample of the selected text, preview it live under the pointer or ↑/↓, show recently applied families first (#3515), filter by script and kind, list a family's styles, and star favourites; the Glyphs panel and Find Font's Replace With use the same menu without the live preview) and found by name on open/import (full-name aliases and Missing Fonts searches verified, #1258; Windows font-service QA pending), variable fonts' named instances as styles, CJK names in the UI, input methods (marked text in place, candidate window at the caret; Japanese IME), Text Wrap (offset, invert, both sides of an object; follows edits), Type on a Path effects and Options with draggable start/centre/end brackets (slide, flip), tab stops + Tabs panel (Above Text floats it over the selected text, its ruler at the canvas zoom so stops line up with the columns, #729), inline symbols in text (beyond parity), Hebrew/Arabic bidirectional text, Paragraph Direction, Every-line/Single-line Composer per object (ragged text too) done; tab leaders, spell check, vertical type pending | 45–60 | +| M7 | Type (point/area/path, editing, styles, OpenType, threading, glyphs) | Right-aligned area type sets the text after a line's last tab against the right edge, the text before it at its stops (#6147); A line a soft return ends is justified as a wrapped line is (#6137); Indian-language pattern hyphenation preserves syllables in both composers (#4947); 🟡 Fullwidth `!` / `?` keep an upright fallback in vertical type; Hyphenation… and Justification… per paragraph (#2310, #2755), Auto Leading also driving the Character panel's Leading, the Alt+↑/↓ leading nudge and Fill with Placeholder Text; Document-point character controls after object/group scaling (#1034; optional font-size preservation remains separate), Character/Paragraph Styles (explicit Auto-leading resets and local leading overrides), per-paragraph paragraph attributes, mixed paragraph alignment indication (headless regressions, full integration CI and visual review pass), Area Type Options (with Width/Height, Auto Size and Shrink Text to Fit; overflow reported to agents and vertical Align), type areas resized by their handles and reshaped with Direct Selection, threaded text, Fit Headline, Glyphs, OpenType panel, Find Font (Document, Recent and System replacement sources, #5217), installed system fonts in every font menu (fonts registered with Windows outside its font folders, the XDG and Flatpak host font folders on Linux, and fonts installed while the app runs, listed when it comes back to the front; searchable; the Character and Properties menus show each family's sample of the selected text, preview it live under the pointer or ↑/↓, filter by script and kind, list a family's styles, and star favourites; the Glyphs panel and Find Font's Replace With use the same menu without the live preview) and found by name on open/import (full-name aliases and Missing Fonts searches verified, #1258; Windows font-service QA pending), variable fonts' named instances as styles, CJK names in the UI, input methods (marked text in place, candidate window at the caret; Japanese IME), Text Wrap (offset, invert, both sides of an object; follows edits), Type on a Path effects and Options with draggable start/centre/end brackets (slide, flip), tab stops + Tabs panel (Above Text floats it over the selected text, its ruler at the canvas zoom so stops line up with the columns, #729), inline symbols in text (beyond parity), Hebrew/Arabic bidirectional text, Paragraph Direction, Every-line/Single-line Composer per object (ragged text too) done; tab leaders, spell check, vertical type pending | 45–60 | +| M7 | Type (point/area/path, editing, styles, OpenType, threading, glyphs) | Right-aligned area type sets the text after a line's last tab against the right edge, the text before it at its stops (#6147); A line a soft return ends is justified as a wrapped line is (#6137); Indian-language pattern hyphenation preserves syllables in both composers (#4947); 🟡 Fullwidth `!` / `?` keep an upright fallback in vertical type; Document-point character controls after object/group scaling (#1034; optional font-size preservation remains separate), Character/Paragraph Styles (explicit Auto-leading resets and local leading overrides), per-paragraph paragraph attributes, mixed paragraph alignment indication (headless regressions, full integration CI and visual review pass), Area Type Options (with Width/Height, Auto Size and Shrink Text to Fit; overflow reported to agents and vertical Align), type areas resized by their handles and reshaped with Direct Selection, threaded text, Fit Headline, Glyphs, OpenType panel, Find Font (Document, Recent and System replacement sources, #5217), installed system fonts in every font menu (fonts registered with Windows outside its font folders, the XDG and Flatpak host font folders on Linux, and fonts installed while the app runs, listed when it comes back to the front; searchable; the Character and Properties menus show each family's sample of the selected text, preview it live under the pointer or ↑/↓, show recently applied families first (#3515), filter by script and kind, list a family's styles, and star favourites; the Glyphs panel and Find Font's Replace With use the same menu without the live preview) and found by name on open/import (full-name aliases and Missing Fonts searches verified, #1258; Windows font-service QA pending), variable fonts' named instances as styles, CJK names in the UI, input methods (marked text in place, candidate window at the caret; Japanese IME), Text Wrap (offset, invert, both sides of an object; follows edits), Type on a Path effects and Options with draggable start/centre/end brackets (slide, flip), tab stops + Tabs panel (Above Text floats it over the selected text, its ruler at the canvas zoom so stops line up with the columns, #729), inline symbols in text (beyond parity), Hebrew/Arabic bidirectional text, Paragraph Direction, Every-line/Single-line Composer per object (ragged text too) done; tab leaders, spell check, vertical type pending | 45–60 | | M8 | Transform & distort (Puppet Warp, Liquify tools, Envelopes, Blends, Perspective Grid) | ✅ done (M8.1–M8.20 on 2026-10-06, fidelity pass): Liquify Tool Options with one shared brush, pen pressure, hold-to-apply, a safe scope and incremental strokes; tool options that last; Puppet Warp rotation, multi-select, Control bar and a rest-shape session that follows Undo; Width tool on compound paths; Envelope dialogs with preview, Reset with Warp/Mesh, full Envelope Options, type/images/symbols/appearance/gradients/patterns distorted on canvas and in every export, warps that keep their frame, Edit Contents, mesh handles and Control bar; Blend Options, anchor-targeted Blend tool, editable spine, keys picked on the canvas, faithful interpolation and knockout; Anchor Point spine conversion/handle editing and selection priority (#2544), with #2425 Shift reshape preserved; Perspective Grid with Define Grid, presets, lock/snap/rulers, widgets, the 1–4 plane switch, movable planes, Perspective Selection scale/copy/perpendicular/Transform Again, and type and symbols truly projected with Edit Text. Left: Anti-Alias and Preserve Shape output, warp-envelope point editing, brush interpolation in blends, Free Transform/Scale/Reflect along a rotated box | 2–4 | | M9 | Live effects (+ 3D & Materials) | 🟡 2D effects done incl. Effect → Pathfinder, Color Adjustments and Document Raster Effects Settings; PDF export warns when the pixel cap lowers raster-effect resolution; Artistic › Colored Pencil, Cutout, Dry Brush, Film Grain, Fresco, Neon Glow, Paint Daubs, Palette Knife, Poster Edges, Rough Pastels, Smudge Stick, Sponge, Underpainting and Watercolor and Sketch › Halftone Pattern, Bas Relief, Charcoal, Conté Crayon, Photocopy, Stamp, Torn Edges and Water Paper done (57/57 Photoshop filters); Revolve with automatic smooth vector shading, default-on circular caps and continuous rims, Extrude & Bevel, Inflate and Rotate with one to ten colored directional lights and four original lighting presets; SVG Filters, remaining raster effects and 3D materials and shadows pending | 81–130 | | M10 | Brushes, symbols, patterns, Repeat | 🟡 pattern swatches (5 tile types, Pattern Options, editing mode, SVG ``/PDF export) and live Repeat (radial/grid/mirror) done; interactive selected mirror axis implemented (focused and native checks passed; full CI blocked by an unrelated text test); symbol libraries done (Window › Symbol Libraries, a generated Basic Shapes library, User Defined, Other Library…, Save Symbols); brush libraries done (Window › Brush Libraries, four generated libraries, User Defined, Other Library…, Save Brushes); symbol editing shows draggable 9-slice guides (#5280), with guides outside the artwork still unsupported; brushes/symbols in progress | 23–37 | diff --git a/docs/target-app-parity.md b/docs/target-app-parity.md index 6af8e2c79..4bdd3c102 100644 --- a/docs/target-app-parity.md +++ b/docs/target-app-parity.md @@ -1,6 +1,6 @@ # Parity with Adobe Illustrator -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-09 · **Change:** minor (`.ai` and EPS import: older Art brush objects read; numeric fields step on wheel hover without taking keyboard focus, and a panel wheel turn cannot seed a canvas zoom glide, #5949) · **Target:** Adobe Illustrator 2026 (30.x; public release notes through 30.7, August 2026) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-09 · **Change:** minor (`.ai`/EPS type keeps its tab stops, and right-aligned lines with tabs lay out as the file's page, #6147; `.ai`/EPS type from the text document lays its lines out closer to the file's page, within limits, #6137; `.ai` and EPS import: older Art brush objects read; numeric fields step on wheel hover without taking keyboard focus, and a panel wheel turn cannot seed a canvas zoom glide, #5949) · **Target:** Adobe Illustrator 2026 (30.x; public release notes through 30.7, August 2026) ## Feature submission evidence @@ -20,12 +20,14 @@ Spiral decay now applies after each full wind of four segments. A newly drawn sp Creating a gradient from solid or empty paint uses the document's color model for its default stops, including drawing its vector with the Gradient tool. Explicit `keepModel: true` retains RGB defaults, and existing gradients keep their own colors. Scores and estimates are unchanged. -**Feature evidence last updated:** 2026-11-05. +**Feature evidence last updated:** 2026-11-07. Window → Help Bar toggles the bottom tool-help strip independently of the status bar. Its visibility is saved with workspaces and UI preferences; Presentation Mode hides both bars. Scores and estimates are unchanged. The shared assessment status line and revision history are current upstream; this dated section records the submission's feature evidence and revisions without rescoring upstream or claiming a new combined build or runtime measurement. +- File formats and Type core (#6147): `.ai`/EPS type from the text document keeps its paragraphs' tab stops, and right-aligned area type sets the text before a line's last tab at its stops, from the left edge, and the text after it against the right edge. Evidence: `ate::tests::a_paragraph_keeps_its_tab_stops`, `ate::tests::a_story_s_tab_stops_are_bounded`, `tests::right_aligned_area_type_sets_the_text_after_its_last_tab_against_the_edge`, `import_fuzz::text_frames_with_hostile_paragraph_attributes_never_panic`; scores and estimates unchanged +- File formats and Type core (#6137): `.ai`/EPS type from the text document keeps auto leading at the paragraph's share of each line's largest type, the paragraph's hyphenation options, and may show more of the last lines the file sets in an area frame of its own, when growing the frame by its lines' deepest descent plus 0.05 pt shows them; a line a soft return ends is justified as a wrapped line is. Evidence: `ate::tests::auto_leading_follows_the_size_of_each_line`, `ate::tests::a_paragraph_keeps_its_hyphenation_options`, `ate::tests::the_last_lines_the_file_sets_in_its_frame_show`, `tests::fit_source_lines_keeps_the_last_lines_the_source_sets`, `tests::typo::soft_return_in_justified_text_spreads_like_a_wrapped_line`. Limits: frames grow only for area type of one frame, horizontal, by its lines' deepest descent plus 0.05 pt; type in a font that isn't installed, and hyphenation in a language that isn't imported, still lay out differently; scores and estimates unchanged - Current-main conflict reconciliation retains upstream and feature behavior; scores and estimates unchanged - Superseded 2026-10-20 behavior, retained as history: Artboard Options shares existing presets and orientation controls and can fit artwork without moving it; artwork fitting uses the original target artboard and revision-scoped bounds caches (scores/hours unchanged) @@ -37,6 +39,8 @@ Artboard Options forwards the active Artboard tool's Scale Artwork with Artboard | Date | Change | Summary | |---|---|---| +| 2026-11-07 | minor | File formats and Type core (#6147): `.ai`/EPS type keeps its paragraphs' tab stops (positions and alignments; leaders aren't read; at most 1,024 a paragraph and 2^20 a story), and right-aligned area type sets the text after a line's last tab against the right edge, the text before it at its stops; centred and justified lines are aligned as a whole as before; evidence added. Scores and estimates unchanged. | +| 2026-11-07 | minor | File formats and Type core (#6137): `.ai`/EPS type from the text document keeps auto leading per line, its hyphenation options, may show more of the last lines the file sets in an area frame of its own, when growing the frame by its lines' deepest descent plus 0.05 pt shows them, and a line a soft return ends is justified; evidence added. Limits: frames grow only for area type of one frame, horizontal, by its lines' deepest descent plus 0.05 pt; type in a font that isn't installed, and hyphenation in a language that isn't imported, still lay out differently. Scores and estimates unchanged. | | 2026-11-08 | minor | Style panels: a double-click on a user character style's row opens its Character Style Options (`ui.charStyleOptions`), and on a paragraph style's row its Paragraph Style Options (rename); the Character Style Options dialog keeps a fixed width and scrolls its sections in a shorter window, so OK and Cancel stay on screen. Tests `panels::text_styles::tests::double_clicking_a_character_style_row_opens_its_options` and `dialogs::char_style_options::tests::the_sections_scroll_in_a_window_shorter_than_the_general_list`. Scores and estimates unchanged. | | 2026-11-07 | minor | Pen and Curvature tool with Cmd/Ctrl held: Edit › Copy and Cut take the anchors and segments the lent Direct Selection picked, not the whole path; with the Pen's own last anchor selected Copy still takes the whole path (#6123); scores and estimates unchanged | | 2026-11-07 | minor | Live Corners: with Direct Selection, while every corner of a path is selected (the path selected whole), a Shift-click on a corner widget picks that corner alone, as the first click of "click one widget, then Shift-click the others" does, instead of deselecting it and hiding its widget (#5188). The other corners' widgets then hide: a Shift-click on another corner's anchor adds that corner and shows its widget, and a Shift-click on a showing widget deselects its corner. Adding a corner by Shift-clicking its widget while it is hidden stays open (#1232). Test: `corners::tests::a_shift_click_on_a_widget_of_a_whole_path_picks_its_corner`. Scores and estimates unchanged. | @@ -552,6 +556,8 @@ since 2026-10-01. - **Canvas review follow-up:** Cached canvas dimensions match the renderer limit before cache-key creation, view construction and worker submission. Controlled-worker regression checks oversized width and height, high DPI and the render transform without allocating oversized images. Scores and estimates are unchanged. - **Cached canvas frames during viewport changes:** Cached screen textures use their own raster dimensions and pixels-per-point when reprojected. `canvas::tests::cached_frames_keep_their_scale_during_resize_rotation_and_dpi_changes` holds the worker and checks every UV corner against the cached render transform, including isolated viewport-only resize at zero/30-degree rotation, fractional raster dimensions, zoom/pan, changed rotation, monitor-DPI changes in both directions, Pixel Preview and replacement-frame delivery. The contributor rebuilt and confirmed the original resize issue is fixed with their own artwork on 2026-10-19; the subsequent upstream rebase is checked by regressions and full CI. The artwork stays local. Scores and estimates are unchanged. - **PDF editable import:** Place from bytes or a path with `link: false`, and `clipboard.importPdf` followed by Paste, preserve live type on the selected page. Place still honors `textAs: "outlines"`. Synthetic two-page regressions: `crates/engine/src/cmd/fileio/tests_pdffidelity.rs`. No change to the PDF reader's existing fallback rules. +- **Tab stops in `.ai`/EPS type and right-aligned lines with tabs (#6147):** type from the text document keeps its paragraphs' tab stops (key 30: positions and left, center, right and decimal alignments; leaders aren't read), at most 1,024 a paragraph and 2^20 a story, past which the default stops apply with a warning. In right-aligned area type, the text before a line's last tab sits at its stops, measured from the left edge, and the text after it (none when the tab ends the line, with its hyphen when the line is hyphenated) against the right edge; centred and justified lines, point type and right-to-left paragraphs are aligned as a whole as before. Evidence: `ate::tests::a_paragraph_keeps_its_tab_stops`, `ate::tests::a_story_s_tab_stops_are_bounded`, `tests::right_aligned_area_type_sets_the_text_after_its_last_tab_against_the_edge`, `import_fuzz::text_frames_with_hostile_paragraph_attributes_never_panic`. Scores unchanged. +- **`.ai`/EPS type laid out closer to the file's page (#6137):** type from the text document keeps auto leading as auto, each line taking the paragraph's Auto Leading share (key 7) of the largest type on it ([Line and character spacing](https://helpx.adobe.com/illustrator/using/line-character-spacing.html)); the paragraph's hyphenation options (keys 10 to 15) are read; area type of one frame whose last lines the file sets, but which don't fit here, may get a frame taller from its bottom, by its lines' deepest descent plus 0.05 pt and only when that shows more of those lines and no more than the file has (`vectorcraft_text::fit_source_lines`), with a warning when it does: the frame can stay as it is, or show only some of them; and a line a soft return ends is justified as a wrapped line is, a paragraph's last line keeping its alignment. Evidence: `ate::tests::auto_leading_follows_the_size_of_each_line`, `ate::tests::a_paragraph_keeps_its_auto_leading`, `ate::tests::a_paragraph_keeps_its_hyphenation_options`, `ate::tests::the_last_lines_the_file_sets_in_its_frame_show`, `tests::fit_source_lines_keeps_the_last_lines_the_source_sets`, `tests::typo::soft_return_in_justified_text_spreads_like_a_wrapped_line`. Limits: frames grow only for area type of one frame, horizontal, by its lines' deepest descent plus 0.05 pt; type in a font that isn't installed, and hyphenation in a language that isn't imported, still lay out differently. Scores unchanged. - **Selected Grid Repeat handles (#2691):** `tools/src/repeat_grid.rs` tests place the handles outside the grid at zoom 0.5, 1 and 4, preview rows, columns and spacing, leave no undo step for a drag that ends where it began, and give bounding-box handles priority; a headless canvas regression drags the row handle two tiles down in a zoomed view (3 → 5 rows, the source unchanged, one Undo back) and the column-spacing slider. Scores and hours unchanged. - **Selected Mirror Repeat handles:** a headless canvas regression creates the default mirror repeat and drags its Top bounding-box handle where the axis crosses it; the repeat grows vertically while its width stays fixed. Existing mirror-axis checks cover center movement and end-handle hit priority. The focused UI mirror tests pass. Scores and hours unchanged. - **Transform effect options (#885):** Effect › Distort & Transform › Transform… has visible Transform Objects, Transform Patterns and Scale Strokes & Effects checkboxes (`distort.transform` params `objects`, `patterns`, `strokes`; files without them draw as before). With Transform Objects off the geometry stays and makes no copies; Scale Strokes & Effects scales stroke weights, dashes and the fills' and strokes' effect distances by the mean scale, and Transform Patterns moves pattern tiles, each copy `k` by the transformation `k` times. Such objects draw, export and expand through the same per-copy art, so the canvas and Expand Appearance agree (engine `tests_transformfx`, effects `tests_transformfx`, the dialog test). A Transform effect in a fill's or stroke's own effects applies the same options to that fill or stroke: its weight and dashes, the distances of its later effects and its pattern follow the transformation, and with copies each copy is an object of its own; the canvas, export, Expand Appearance and Use Preview Bounds use the same art (effects `tests_transformfx`). Not yet: object effects after a Transform effect keep their distances. Public reference: [Scale objects](https://helpx.adobe.com/illustrator/desktop/manage-objects/reshape-transform-objects/scale-objects.html), [How to apply effects](https://helpx.adobe.com/illustrator/using/effects.html), [Distort and transform effects](https://helpx.adobe.com/illustrator/desktop/manage-objects/reshape-transform-objects/distort-and-transform-effects-in-illustrator.html). Scores and hours unchanged. @@ -822,7 +828,7 @@ Moved from the ROADMAP's "Shipped so far" on 2026-10-10. Update it when a featur - Shortcut sets other apps save as text (`.kys`) open in Import Shortcut Set from File › Open, from Edit › Keyboard Shortcuts › Import… in the desktop app, or from a drop on the window. It matches each entry to a tool, command or panel by name and decodes the file's key and modifier codes where VectorCraft's default shortcuts agree on them; the user answers the rest, and Apply fills the Keyboard Shortcuts dialog's working set. The answers are kept with the preferences for the next import (`shortcutSet.read`, `importMatches.*`). - Edit › Keyboard Shortcuts › Export Text… saves the set shown in the dialog as a UTF-8 text file, as the reference app's [Export keyboard shortcuts list as a text document](https://helpx.adobe.com/illustrator/desktop/get-started/preferences-and-settings/export-keyboard-shortcuts-list.html) page describes (`shortcuts.exportText {path?}`). The layout is VectorCraft's own: the set's name, then the Tools and Menu Commands rows in the dialog's order, each with its name, a tab and its shortcuts as the dialog shows them, and nothing after the tab for a row with no shortcut. Tests `shortcut_editor::tests::export_text_*` and `tests::picks::keyboard_shortcuts_export_text_writes_the_working_set_as_text`. - On Windows and Linux the app bar is the window's title bar (its own minimize, maximize and close buttons, drag to move, edges to resize), with the dragon app icon as the brand mark; dialogs and menus size to their content. As on a native menu bar, once one menu is open, moving the pointer onto another title opens that one. - - On Linux and the BSDs, Preferences › User Interface › VectorCraft Title Bar on Every Desktop (off by default) uses the app bar as the title bar from the next start in the sessions where the desktop would draw the window's frame (X11, Wayland compositors with server-side decorations such as KDE Plasma, a window opened through XWayland). System Title Bar and `VECTORCRAFT_TITLEBAR` take precedence over it, and `VECTORCRAFT_TITLEBAR` also takes precedence over System Title Bar for the run it is set in. + - On Linux and the BSDs, Preferences › User Interface › VectorCraft Title Bar on Every Desktop (off by default) uses the app bar as the title bar from the next start in the sessions where the desktop would draw the window's frame (X11, Wayland compositors with server-side decorations such as KDE Plasma, a window opened through XWayland). System Title Bar and `VECTORCRAFT_TITLEBAR` take precedence over it, and `VECTORCRAFT_TITLEBAR` also takes precedence over System Title Bar for the run it is set in. Only the values `app`, `system` and `desktop` take precedence (case-sensitive, surrounding spaces ignored); any other value, such as `unknown`, is ignored and does not override System Title Bar. - Edit › Keyboard Shortcuts lists items of the menu bar and panel menus, as the reference app's [Customize keyboard shortcuts](https://web.archive.org/web/20221205131209id_/https://helpx.adobe.com/illustrator/using/customizing-keyboard-shortcuts.html) page describes for its Menu Commands. A menu command with no default shortcut that needs a value a key press does not give, such as File › Document Setup › Units (`document.setUnits {units}`), is listed only while the user has changed its shortcut. A command stays listed when a menu bar item runs it without a value or when it opens a dialog run without one, as the Variables panel's commands do. - A shortcut on the key left of 1 runs whatever character that key types, and Edit › Keyboard Shortcuts, the menus in the window, the command palette and tool tips show it as that character once the key has been pressed: `"` on a Turkish Q layout, `~` on a US layout as before. Shortcuts saved as `~` keep working (#4559). - On Windows a maximized window stays inside the work area with the taskbar on any edge (#3242, #3723). @@ -1881,6 +1887,8 @@ Edit › Copy and Cut put the selected ruler guides on the clipboard, with the s | Date | Change | Summary | |---|---|---| +| 2026-11-07 | minor | File formats and Type core: `.ai`/EPS type keeps its paragraphs' tab stops, and right-aligned area type sets the text after a line's last tab against the right edge, the text before it at its stops (#6147); evidence added; scores unchanged. | +| 2026-11-07 | minor | File formats and Type core: `.ai`/EPS type from the text document lays its lines out closer to the file's page: auto leading per line at the paragraph's share, the paragraph's hyphenation options, possibly more of the last lines the file sets in an area frame of its own, and a line a soft return ends justified (#6137); evidence added; scores unchanged. | | 2026-11-06 | minor | `.ai` and EPS import: Art brushes in the older form of their objects come into the Brushes panel; evidence updated; scores unchanged. | | 2026-11-08 | minor | Panel numeric wheel turns do not seed canvas zoom glides; corrected the disabled-field scroll description (#5949). Scores and estimates unchanged. | | 2026-11-07 | minor | Numeric fields step on wheel hover without taking focus; keyboard focus and existing rounding rules remain (#5949). Scores and estimates unchanged. | diff --git a/docs/type-parity.md b/docs/type-parity.md index 8b2cf40de..6b68d3a45 100644 --- a/docs/type-parity.md +++ b/docs/type-parity.md @@ -1,6 +1,6 @@ # Type parity -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-08 · **Change:** minor (Character Styles panel: a double-click on a style's row opens its Character Style Options; the dialog keeps a fixed width and scrolls its sections, so its buttons stay on screen) · **Target:** Adobe Illustrator 2026 (30.x) +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-08 · **Change:** minor (right-aligned area type sets the text after a line's last tab against the right edge; a soft return in justified type no longer keeps its line from being justified; Character Styles panel: a double-click on a style's row opens its Character Style Options; the dialog keeps a fixed width and scrolls its sections, so its buttons stay on screen) · **Target:** Adobe Illustrator 2026 (30.x) Type is Illustrator's largest single area by use (weight 13 of 105 across "Type core" and "Type advanced" in [target-app-parity.md](target-app-parity.md)). This checklist lists the features one by one. Status is from the @@ -19,7 +19,7 @@ against Illustrator's public documentation; **estimated** unless noted. | Feature | Status | Notes | |---|---|---| | Mouse wheel over the closed font-family field | done | #5253: Character, Properties and Control step selected text through the family list using saved font filters (excluding search text), one undo step per notch; the style is matched and the list stops at either end. Escape and leaving the field keep the change. Order, bounds and Undo grouping are VectorCraft's choices; scores unchanged. | -| Soft return (forced line break, Shift+Enter) | done | Shift+Enter inserts a soft return (U+2028), breaking the line without starting a new paragraph; paragraph spacing (space before/after) and first-line indents apply only at paragraph ends; continuation lines in lists do not repeat the marker; soft return lines in justified text do not spread (#2754) | +| Soft return (forced line break, Shift+Enter) | done | Shift+Enter inserts a soft return (U+2028), breaking the line without starting a new paragraph; paragraph spacing (space before/after) and first-line indents apply only at paragraph ends; continuation lines in lists do not repeat the marker; in justified text a line a soft return ends is justified as a wrapped line is, only the paragraph's last line keeping its alignment, as Illustrator's own layout in a user's `.ai` sets it (evidence: `tests::typo::soft_return_in_justified_text_spreads_like_a_wrapped_line`; first done the other way in #2754) | | Native font-family labels | partial | With Show Font Names in English off, localized legacy names are used when typographic names contain no native label (#2208); loaded-font and catalog-only regressions. Choosing among multiple native languages is unchanged. | | Point, area and type-on-a-path type; vertical variants | done / partial | vertical point, area and path type have initial support; fullwidth `!` / `?` keep the nominal glyph upright when no vertical alternate exists (Unicode Tu); in a non-rectangular area a word too wide for the top lines moves down to the first line that holds it (#1615); Escape while typing ends the edit, keeps the type selected and switches back to the tool whose double-click on type chose the Type tool (kept until another tool is chosen or another document or window becomes active, so later edits with the Type tool return there too), or to the Selection tool when there is no such tool, as when the Type tool was chosen from the toolbar or after such a switch (#1802), and Cmd+Enter (Ctrl+Enter on Windows and Linux) does the same unless a command is bound to it; `text.create` and `text.createInPath` take `justify` (#1752); MCP `add_text` forwards `vertical` to both commands; Type › Type Orientation sets every frame of a thread, and a thread's frames share one writing direction; the Type and Vertical Type tools make area type when a closed path's outline is clicked and type on a path when an open one is, with pointers that say which, as the public help describes ([Create text](https://web.archive.org/web/20220127090642/https://helpx.adobe.com/illustrator/using/creating-text.html), [Create type on a path](https://web.archive.org/web/20220127090635/https://helpx.adobe.com/illustrator/using/creating-type-path.html)) | | Area Type Options (rows, columns, inset, first baseline, Text Flow by rows or by columns, Auto Size, Shrink Text to Fit) | done | Text Flow fills the cells down each column first (By Columns, the default, as files from before it open) or across each row first (By Rows), in the dialog and `text.areaOptions {flow}` (#4978); the commands that make or restyle type say when it does not fit its frame; MCP `add_text` takes Auto Size and Shrink Text to Fit (#1471) | @@ -45,7 +45,7 @@ against Illustrator's public documentation; **estimated** unless noted. | Hyphenation… and Justification… options | done | Eleven Indian languages use attributed patterns and preserve syllables in both composers (#4947). Hyphenation… (`ui.hyphenation`, `text.setFormat`) sets each paragraph's Words Longer Than, After First, Before Last, Hyphen Limit, Hyphenation Zone (Single-line Composer only) and Hyphenate Capitalized Words, and paragraph styles carry them (#2310). Justification… (`ui.justification`, `text.setFormat`, #2755) sets Word Spacing, Letter Spacing and Glyph Scaling (Minimum, Desired, Maximum), Auto Leading and Single Word Justification; Desired applies to every line, justified lines and the Every-line Composer use the ranges. Vertical type isn't glyph scaled; type on a path doesn't use them. Evidence: `crates/text/src/tests/justify.rs`, `dialogs::justification::tests` | | Roman Hanging Punctuation | done | Paragraph panel menu › Roman Hanging Punctuation, `text.setFormat {romanHangingPunctuation}` (#2756): per paragraph, Optical Margin Alignment's punctuation and amounts without the letters; paragraph styles carry it. Evidence: `tests::roman_hanging_punctuation_hangs_punctuation_but_not_letters`, `typecmd::area_tests::roman_hanging_punctuation_is_set_per_paragraph_and_saved_only_when_on` | | Hyphenation… and Justification… options | done | Eleven Indian languages use attributed patterns and preserve syllables in both composers (#4947). Hyphenation… (`ui.hyphenation`, `text.setFormat`) sets each paragraph's Words Longer Than, After First, Before Last, Hyphen Limit, Hyphenation Zone (Single-line Composer only) and Hyphenate Capitalized Words, and paragraph styles carry them (#2310). Justification… (`ui.justification`, `text.setFormat`, #2755) sets Word Spacing, Letter Spacing and Glyph Scaling (Minimum, Desired, Maximum), Auto Leading and Single Word Justification; Desired applies to every line, justified lines and the Every-line Composer use the ranges. Vertical type isn't glyph scaled; type on a path doesn't use them. Auto Leading also sets the Leading the Character panel shows for Auto type, the leading Alt+↑/↓ (`type.step`) steps from, per paragraph, and the lines Fill with Placeholder Text counts. Evidence: `crates/text/src/tests/justify.rs`, `dialogs::justification::tests`, `tests_prefs::auto_leading_steps_and_fills_from_the_paragraph_auto_leading`, `panels::character` test `leading_field_shows_the_paragraph_auto_leading` | -| Tab stops and leaders; Tabs panel | partial | Tabs panel and stops with leaders in the model (`text.tabs.set`); a stop drags from where the press landed (#1458); leaders fill the tab's gap, repeated on a grid so they line up from line to line (#1877); Ctrl-dragging a stop (Command on macOS) moves all the stops together | +| Tab stops and leaders; Tabs panel | partial | Tabs panel and stops with leaders in the model (`text.tabs.set`); a stop drags from where the press landed (#1458); leaders fill the tab's gap, repeated on a grid so they line up from line to line (#1877); Ctrl-dragging a stop (Command on macOS) moves all the stops together; in right-aligned area type the text before a line's last tab sits at its stops, from the left edge, and the text after it against the right edge, as Illustrator's own layout in a user's `.ai` sets a price list (evidence: `tests::right_aligned_area_type_sets_the_text_after_its_last_tab_against_the_edge`; centred and justified lines are still aligned as a whole) | | Hidden characters (Show Hidden Characters) | done | `type.hiddenCharacters` | | Spell check (Check Spelling, Auto Spell Check, custom dictionary) | missing | menu stubs; needs an openly licensed dictionary | | Smart Punctuation, Change Case, Find & Replace | done | | @@ -81,6 +81,8 @@ Character Styles menu New/Redefine and footer New capture the first selected cha | Date | Change | Summary | |---|---|---| +| 2026-11-07 | minor | Tabs: in right-aligned area type, the text before a line's last tab sits at its stops, measured from the left edge, and the text after it (none, when the tab ends the line) against the right edge; the line was aligned as a whole, which moved its start off the left edge. Illustrator's own layout in a user's `.ai` (used locally, not committed) sets its price lists so. Centred and justified lines keep their alignment as a whole. Scores and estimates unchanged. | +| 2026-11-07 | minor | Soft return: in Justify Left, Center or Right, the line a soft return ends is justified as a wrapped line is; only the paragraph's last line keeps its alignment. Illustrator's own layout in a user's `.ai` (used locally, not committed) justifies those lines. Scores and estimates unchanged. | | 2026-11-08 | minor | Style panels: a double-click on a user character style's row opens its Character Style Options (`ui.charStyleOptions`), and on a paragraph style's row its Paragraph Style Options (rename); the Character Style Options dialog keeps a fixed width and scrolls its sections in a shorter window, so OK and Cancel stay on screen. Tests `panels::text_styles::tests::double_clicking_a_character_style_row_opens_its_options` and `dialogs::char_style_options::tests::the_sections_scroll_in_a_window_shorter_than_the_general_list`. Scores and estimates unchanged. | | 2026-11-07 | minor | Alt + numeric-keypad codes with NumLock off: the keypad keys arrive as Insert, End, arrows, Clear, Home and Page Up/Down, which Windows still composes into the code; with Alt held they now count as digits and are taken out of the frame instead of moving the caret, while the separate navigation keys (extended-key flag) keep their meaning (follow-up to #5939). Scores and estimates unchanged. | | 2026-11-07 | minor | Indian-language hyphenation (#4947): eleven MIT-licensed pattern sets, with grapheme and shaping-cluster protection in both composers and existing paragraph limits. Assamese and Sanskrit are selectable; Sanskrit automatic patterns remain pending an allowlisted source. Scores and estimates unchanged. |