From 5a4c45e79aec9757a0277d5dbe83c666704820df Mon Sep 17 00:00:00 2001 From: FredApps <153173854+FredApps@users.noreply.github.com> Date: Thu, 5 Nov 2026 04:33:16 +0100 Subject: [PATCH 01/34] About: let every credits column be dragged and refit changed tables (#5588) * Let every credits column be dragged, and refit changed tables The last column was egui's remainder column, which has no drag handle, so it could only be resized from the edge before it. It is now an ordinary column with its own handle. A table keeps its column widths, so switching to a longer name left the Name column at its old width and clipped the text. The table now goes back to the opening fit whenever that fit changes: a longer widest cell or a resized window. Dragged widths are dropped at that point. fit_widths could overflow the room when one column hit the minimum, because the other columns did not take up its share. Columns now give way in proportion to their width above the minimum. Co-Authored-By: Claude Opus 5.5 * Refit credits tables on what they measure, not the fitted widths Comparing the fitted widths missed the case it was meant for. Name is the only growing column, so a longer name takes its extra width from the spare room and the fit comes out the same: a dragged Name width stayed, clipping the longer name. It could also drop dragged widths by accident. The fit comes from the available width inside the scroll area, which scrolling can nudge, so scrolling a widened table could reset it. The table now compares the natural widths and the clip rect's width, which scrolling does not move. Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- crates/ui-egui/src/credits.rs | 149 ++++++++++++++++++++++++++++++---- 1 file changed, 133 insertions(+), 16 deletions(-) diff --git a/crates/ui-egui/src/credits.rs b/crates/ui-egui/src/credits.rs index d206a454c2..b52f192335 100644 --- a/crates/ui-egui/src/credits.rs +++ b/crates/ui-egui/src/credits.rs @@ -293,19 +293,20 @@ fn natural(ui: &egui::Ui, header: RichText, cells: impl Iterator) /// Opening column widths: each column's natural width, with the spare room shared out by `grow`, /// so the columns fill `room` exactly. When there is too little room, only the growing columns -/// give way, down to [`MIN_COLUMN`]. +/// give way, each in proportion to its width above [`MIN_COLUMN`], and none goes below that. fn fit_widths(natural: &[f32], grow: &[f32], room: f32) -> Vec { let spare = room - natural.iter().sum::(); let weight = grow.iter().sum::(); - let flexible: f32 = natural.iter().zip(grow).filter(|(_, g)| **g > 0.0).map(|(w, _)| *w).sum(); + let slack = |w: f32| (w - MIN_COLUMN).max(0.0); + let flexible: f32 = natural.iter().zip(grow).filter(|(_, g)| **g > 0.0).map(|(w, _)| slack(*w)).sum(); natural .iter() .zip(grow) .map(|(w, g)| { - if spare >= 0.0 && weight > 0.0 { + if *g > 0.0 && spare >= 0.0 { w + spare * g / weight } else if *g > 0.0 && flexible > 0.0 { - (w + spare * w / flexible).max(MIN_COLUMN) + w - (-spare).min(flexible) * slack(*w) / flexible } else { *w } @@ -314,26 +315,30 @@ fn fit_widths(natural: &[f32], grow: &[f32], room: f32) -> Vec { } /// A striped table whose columns open at [`fit_widths`], so it fills the width and nothing scrolls -/// sideways. Each column can be dragged wider or narrower at its edge. The last column fills -/// whatever width is left but never shrinks below its opening width, so widening a column grows -/// the table, as in a spreadsheet, instead of crushing the last one: only a table dragged wider -/// than the window scrolls sideways. Text too long for its column is clipped. +/// sideways. Every column, the last included, can be dragged wider or narrower at its right edge: +/// only a table dragged wider than the window scrolls sideways. Text too long for its column is +/// clipped. When a column's natural width or the window changes, the columns go back to a new fit, +/// dropping any dragged widths. fn fitted_table<'a>(ui: &'a mut egui::Ui, id: &str, natural: &[f32], grow: &[f32]) -> egui_extras::TableBuilder<'a> { // Every cell is followed by the item gap, and the vertical scrollbar keeps its margins. let s = ui.spacing(); let gaps = s.item_spacing.x * natural.len() as f32; let bar = s.scroll.bar_width + s.scroll.bar_inner_margin + s.scroll.bar_outer_margin; let widths = fit_widths(natural, grow, (ui.available_width() - gaps - bar).max(0.0)); + // The table keeps its own column widths, so a change in what they were fitted to has to clear + // them. A longer name can leave the fit itself unchanged, and scrolling can nudge the available + // width, so this compares the natural widths and the clip rect, which scrolling never moves. + let fit = egui::Id::unique(("credits_fit", id)); + let measured = (natural.to_vec(), ui.clip_rect().width()); + let refit = ui.data_mut(|d| d.get_temp::<(Vec, f32)>(fit)).as_ref() != Some(&measured); + ui.data_mut(|d| d.insert_temp(fit, measured)); let mut t = egui_extras::TableBuilder::new(ui).id_salt(id).striped(true).resizable(true).auto_shrink([false, false]).max_scroll_height(f32::INFINITY); - let last = widths.len().saturating_sub(1); - for (i, w) in widths.into_iter().enumerate() { - let c = if i == last { - egui_extras::Column::remainder().at_least(w.max(MIN_COLUMN)) - } else { - egui_extras::Column::initial(w).at_least(MIN_COLUMN) - }; - t = t.column(c.clip(true)); + if refit { + t.reset(); + } + for w in widths { + t = t.column(egui_extras::Column::initial(w).at_least(MIN_COLUMN).clip(true)); } t } @@ -579,4 +584,116 @@ mod tests { assert_eq!(fit_widths(&[100.0, 40.0, 60.0], &[1.0, 0.0, 0.0], 0.0), [MIN_COLUMN, 40.0, 60.0]); assert_eq!(fit_widths(&[100.0, 40.0], &[0.0, 0.0], 50.0), [100.0, 40.0]); } + + #[test] + fn a_column_at_the_minimum_leaves_the_shortfall_to_the_others() { + let w = fit_widths(&[100.0, 300.0, 50.0], &[1.0, 1.0, 0.0], 140.0); + assert!((w.iter().sum::() - 140.0).abs() < 0.01, "the columns still fit the room: {w:?}"); + assert!(w.iter().all(|c| *c >= MIN_COLUMN), "no column goes below the minimum: {w:?}"); + assert_eq!(fit_widths(&[100.0, 300.0, 50.0], &[1.0, 1.0, 0.0], 0.0), [MIN_COLUMN, MIN_COLUMN, 50.0]); + } + + const WINDOW: f32 = 640.5; + const NATURAL: [f32; 3] = [120.0, 80.0, 80.0]; + const GROW: [f32; 3] = [1.0, 0.0, 0.0]; + + /// One frame of a table long enough to scroll; the rects of its header cells. + fn table_frame(ctx: &egui::Context, width: f32, natural: &[f32], events: Vec) -> Vec { + scrolled_frame(ctx, width, natural, 0.0, events) + } + + /// [`table_frame`], scrolled `offset` points sideways. + fn scrolled_frame(ctx: &egui::Context, width: f32, natural: &[f32], offset: f32, events: Vec) -> Vec { + let screen_rect = Some(egui::Rect::from_min_size(egui::Pos2::ZERO, egui::vec2(width, 300.0))); + let raw = egui::RawInput { screen_rect, events, ..Default::default() }; + let mut cells = Vec::new(); + let out = ctx.run_ui(raw, |ui| { + cells.clear(); + egui::ScrollArea::horizontal().auto_shrink([false, false]).horizontal_scroll_offset(offset).show(ui, |ui| { + fitted_table(ui, "test", natural, &GROW) + .header(20.0, |mut header| { + for _ in natural { + header.col(|ui| cells.push(ui.max_rect())); + } + }) + .body(|mut body| { + for _ in 0..40 { + body.row(20.0, |mut row| { + for _ in natural { + row.col(|ui| { + ui.label("x"); + }); + } + }); + } + }); + }); + }); + out.drop_without_applying_deltas(); + cells + } + + /// A new context with the table open and settled, and the rects of its header cells. + fn opened_table() -> (egui::Context, Vec) { + let ctx = egui::Context::default(); + table_frame(&ctx, WINDOW, &NATURAL, Vec::new()); + let cells = table_frame(&ctx, WINDOW, &NATURAL, Vec::new()); + (ctx, cells) + } + + /// Drags a column's right edge, which runs midway through the gap after `cell`, then lets go. + fn drag_edge(ctx: &egui::Context, cell: egui::Rect, by: f32) { + use egui::{Event, Modifiers, PointerButton}; + let start = egui::pos2(cell.right() + 4.0, cell.center().y); + let halfway = start + egui::vec2(by / 2.0, 0.0); + let end = start + egui::vec2(by, 0.0); + let moved = Event::PointerMoved; + let button = |pos, pressed| Event::PointerButton { pos, button: PointerButton::Primary, pressed, modifiers: Modifiers::NONE }; + for event in [moved(start), button(start, true), moved(halfway), moved(end), button(end, false)] { + table_frame(ctx, WINDOW, &NATURAL, vec![event]); + } + } + + #[test] + fn every_column_can_be_dragged_at_its_right_edge_and_stays_there() { + let (_, opened) = opened_table(); + for (dragged, cell) in opened.iter().enumerate() { + let (ctx, _) = opened_table(); + drag_edge(&ctx, *cell, -30.0); + table_frame(&ctx, WINDOW, &NATURAL, Vec::new()); + let after = table_frame(&ctx, WINDOW, &NATURAL, Vec::new()); + for (column, (was, now)) in opened.iter().zip(&after).enumerate() { + let want = if column == dragged { was.width() - 30.0 } else { was.width() }; + assert!((now.width() - want).abs() < 1.0, "dragging column {dragged}: column {column} is {now:?}, was {was:?}"); + } + } + } + + #[test] + fn a_changed_fit_replaces_the_column_widths() { + let (ctx, opened) = opened_table(); + drag_edge(&ctx, opened[0], -30.0); + let longer_name = table_frame(&ctx, WINDOW, &[200.0, 80.0, 80.0], Vec::new()); + assert!((longer_name[0].width() - opened[0].width()).abs() < 1.0, "a longer name drops a dragged width: {longer_name:?}"); + let wider = table_frame(&ctx, WINDOW, &[120.0, 200.0, 80.0], Vec::new()); + let widths: Vec = wider.iter().map(|c| c.width().round()).collect(); + assert!(widths.ends_with(&[200.0, 80.0]), "a longer cell widens its column: {widths:?}"); + assert!(wider[2].right() < WINDOW, "the table still fits the window: {wider:?}"); + let narrower = table_frame(&ctx, 400.0, &NATURAL, Vec::new()); + assert!(narrower[2].right() < 400.0, "a narrower window refits the table: {narrower:?}"); + } + + #[test] + fn scrolling_sideways_keeps_dragged_widths() { + let (ctx, opened) = opened_table(); + drag_edge(&ctx, opened[0], 100.0); + table_frame(&ctx, WINDOW, &NATURAL, Vec::new()); + let dragged = table_frame(&ctx, WINDOW, &NATURAL, Vec::new()); + assert!((dragged[0].width() - opened[0].width() - 100.0).abs() < 1.0, "the drag took: {dragged:?}"); + for offset in [13.3, 27.77, 41.1, 0.6] { + scrolled_frame(&ctx, WINDOW, &NATURAL, offset, Vec::new()); + let scrolled = scrolled_frame(&ctx, WINDOW, &NATURAL, offset, Vec::new()); + assert!((scrolled[0].width() - dragged[0].width()).abs() < 1.0, "scrolled {offset}: {scrolled:?}"); + } + } } From 96286f0e966ce2d971f4551ac8314508184d3f71 Mon Sep 17 00:00:00 2001 From: Rees <109076338+OPUZZLES@users.noreply.github.com> Date: Thu, 5 Nov 2026 09:13:27 +0100 Subject: [PATCH 02/34] Avoid repeated paragraph scans when picking ink (#3614) (#4763) * #3614: reuse paragraph-prefix lookups during ink discovery * Update ink lookup status date (#3614) --------- Co-authored-by: Martin Ball --- ROADMAP.md | 5 +- crates/engine/src/cmd/draw.rs | 12 +- crates/engine/src/cmd/draw/page_objects.rs | 48 +++++++ crates/engine/src/cmd/draw/tests.rs | 2 + .../engine/src/cmd/draw/tests/page_lookup.rs | 132 ++++++++++++++++++ docs/gaps.md | 4 +- docs/hardware-parity.md | 4 +- 7 files changed, 201 insertions(+), 6 deletions(-) create mode 100644 crates/engine/src/cmd/draw/page_objects.rs create mode 100644 crates/engine/src/cmd/draw/tests/page_lookup.rs diff --git a/ROADMAP.md b/ROADMAP.md index 87c0e70128..dab0388b7c 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -4,7 +4,7 @@ **Stage: alpha** · next: beta, ~15 points (60% → 75% ready for real work) and ~150–230 h away -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-04 · **Change:** trivial (progress log: ODT display settings removed); previously trivial (progress log: dialogs are modal except the five Word keeps modeless, and a press beside one shakes it, #3859); previously trivial (progress log: picture brightness, contrast and transparency, ODT element audit, ODT checked against 220 files from other applications, ODT display styles); previously trivial (progress log: the dialogs of the mirrored Arabic interface read right to left: label-and-field rows, tables (list columns, the Models table), tile galleries and the Add/Remove arrows follow the reading direction, through one `rtl::Table` helper that draws exactly as before in English; no ranked gap closed, readiness estimates unchanged); previously trivial (progress log: fonts that aren't installed are flagged in the font box and status bar); previously trivial (progress log: ODT sections inside text boxes); previously trivial (progress log: ODT definitions sharing a name, sections around tables, stacking order); previously trivial (progress log: ODT forms and indexes written as read); previously trivial (progress log: ODT table styles saved, WordCraft-origin documents checked in LibreOffice); previously trivial (progress log: ODT interpretation profile); previously trivial (progress log: ODT controls, custom shapes, in-line placement); previously trivial (progress log: ODT charts kept, frame outlines, header height); previously trivial (progress log: ODT header rows); previously trivial (progress log: ODT layout setting, padding, columns); previously trivial (progress log: ODT tables, header spacing, picture paragraphs); previously trivial (progress log: ODT round trips keep their page count); previously trivial (progress log: emphasis marks, SET fields, ODT page backgrounds and tables); previously trivial (progress log: ODT checked against LibreOffice's templates); previously trivial (progress log: ODT at ~90%); previously trivial (progress log: ODT read and written nearly whole); previously trivial (progress log: ODT text boxes); previously trivial (progress log: ODT layout settings); previously trivial (progress log: ODT character styles); previously trivial (progress log: ODT custom styles); previously trivial (progress log: ODT equations saved); previously trivial (progress log: ODT floating pictures); previously trivial (progress log: ODT paragraph borders); previously trivial (progress log: ODT heading numbering); previously trivial (progress log: ODT table borders); previously trivial (progress log: ODT heading styles); previously trivial (progress log: ODT tab stops); previously trivial (progress log: ODT character formatting); previously trivial (progress log: ODT lists); previously trivial (progress log: ODT comments); previously trivial (progress log: ODT footnotes and endnotes); previously trivial (progress log: ODT headers, footers and fields); previously trivial (progress log: ODT paragraph spacing); previously trivial (progress log: Options › Language redesign, CP4.3); previously trivial (progress log: the missing-pack bar on a fresh install, the caret's typing language, and the spelling menu heading in the interface language, CP4.3); previously trivial (progress log: Language pack languages in every language list, CP4.3); previously trivial (progress log: craft-proof pin, French elision and Valencian, CP4.3); previously trivial (progress log: a long comment's card and balloon stop at ten lines, #3382); previously trivial (progress log: a pasted text box story is charged for the formatting it copies); previously trivial (progress log: a .doc table row keeps one override per cell); previously trivial (progress log: a .doc file's sections find their paragraphs by index); previously minor (Arabic interface language with mirrored UI, #1195); previously trivial (progress log: Replace and Remove Table of Contents with Word's title above a section break, #4041); previously trivial (progress log: a password-protected file named on the command line asks for its password after the startup document is replaced, #5299); previously trivial (progress log: language-packs-2 published and pinned, 75 Language packs); previously trivial (progress log: language-packs-1 published and pinned, CP4.4); previously trivial (progress log: Language packs, CP4);; previously trivial (DOCX table rows and cells inside selected alternate-content branches survive open and repeated saves (#5219); broader corpus qualification and readiness estimates unchanged); previously trivial (progress log: a list inside a Markdown block quote stays quoted); previously trivial (progress log: arrowheads keep their kind, width and length and are drawn at Word's sizes); previously trivial (progress log: the line between columns for selected text, #5178); previously trivial (progress log: .doc standard font, #5066); previously trivial (progress log: a table row doesn't split off a picture that doesn't fit, #4272); previously trivial (progress log: a middle or bottom cell of a row split across pages lines up on the first page); previously trivial (progress log: tab leader dots spaced and placed as in Word); previously trivial (progress log: a list level above counts its first number at the first deeper item); previously trivial (progress log: paragraph side borders lie outside the text, #5036); previously trivial (progress log: a paragraph naming an undefined style is formatted as Normal, #5077); previously trivial (progress log: TOC page numbers as PAGEREF fields, #5097); previously trivial (progress log: Backstage keytips, #4960); previously trivial (Progress log: only the printer's PDF leaves out links; Save these pages as PDF keeps them, #4734); previously trivial (progress log: Chinese and Japanese text counts a word per character, #4547; previously trivial: aligned-copy review fixes retain the document axis through scrolling and include secondary selections (#4764)); previously trivial (connector rerouting indexes laid-out object positions once per batch (#3631); previously trivial (progress log: corporate authors in bibliographies, #4848); previously trivial (custom-property bookmark-link preservation, #4767); previously trivial (progress log: Table Properties follows the selection, #4857); previously trivial (Relative font-size commands preserve mixed sizes in the selection (#4903); existing button steps and one-point shortcuts are unchanged; readiness estimates unchanged); previously trivial (Arabic Backspace removes one combining mark and keeps its base letter (#4757); previously trivial (note conversion walks reference offsets and formatting runs together, #4750); previously trivial (DOCX comment-ID save lookups); previously trivial (progress log: RTF pictures stored as Windows or Enhanced Metafiles are imported, #4259); previously trivial (#4658 bounds nested Markdown reference-label work); previously trivial (HTML import keeps preformatted lines with CR or CRLF input newlines, #4810); previously trivial (progress log: Insert › Shapes icon grid, #4349); previously trivial (progress log: AutoCorrect Options with no document open, #4585); previously trivial (progress log: window fallback geometry and equation symbol tooltips); previously trivial (progress log: window titles omit NUL characters, #3634); previously trivial (Recipient labels continue across product-sized sheets instead of stopping after the first sheet (#4880)); previously trivial (progress log: Custom document properties dialog, #2982; previously trivial: progress log: View › New Window; previously trivial: progress log: interface translations come from storytold/craft-i18n through the `craft-i18n` crate; previously trivial: progress log: disabled-control reasons translated in every interface language, #2678; previously trivial: progress log: mail merge record navigation and record ranges for printing, #3028; previously trivial: selection bar for right-to-left paragraphs and table rows; previously trivial: group connector rerouting preserves rotated and flipped free or unresolved endpoints under nonuniform group scaling; readiness estimates unchanged; previously trivial: progress log: a word with no break opportunity in it no longer makes the layout quadratic, #3412; previously trivial: progress log: a relationship the markup names without the prefix is read as it wrote, and an ordinary `id` names no part; previously trivial: progress log: a document with many relationships opens in the time its part takes, and an id the text only mentions is not a reference, #3411; previously trivial: progress log: read only and comments-only protection grey out edits; previously trivial: progress log: an empty paragraph with a hidden mark shows nothing, not even its list number, #3982; previously trivial: progress log: "NaN" in the Font dialog's Size box no longer closes the app, #3663; previously trivial: progress log: a table cell span from a `.json` file no longer overflows, #3637; previously trivial: progress log: a click in the footer while editing the header moves there; previously trivial: explicit documents keep the editor when recovery discovery finishes; readable recovery controls; previously trivial: Slovenian interface catalog, 2,614 entries; previously trivial: Insert Table of Figures dialog for any caption label, #3013; previously trivial: progress log: Home › Underline drop-down, #2738; previously trivial: personal templates in File › New and Save as Word Template, #2852; previously trivial: progress log: the scrollbar page tip stays on one line, #3341; previously trivial: progress log: forms protection greys out the control buttons; previously trivial: progress log: a document with many content controls saves in the time the controls take, #13; previously trivial: progress log: Word signature lines kept on save; previously trivial: a Thai run with Latin finds one installed font covering it all on Linux too, #1549; previously trivial: progress log: closing the header returns to the body selection, #3331; previously trivial: progress log: saving to a NAS share mounted by GVFS, #3003; previously trivial: progress log: a picture dragged near the bottom of a page lands there, #3169; previously trivial: centred list labels after leading page breaks, #2964; previously trivial: progress log: inline pictures drag to an insertion cursor and stay inline, #2233, #2234; previously trivial: progress log: a text file saved over itself closes without asking, #2376; previously trivial: progress log: a text frame in the paragraph defaults frames nothing, #2360; previously trivial: fixed font inputs in four layout controls; previously trivial: typing no longer starts render threads on every repaint, #3027; previously trivial: a right, centre or decimal tab whose text doesn't fit, or a left tab past the right indent, goes to the next line with its text, #1840; previously trivial: progress log: banded rows shade as in Word, #3415; previously trivial: progress log: the table handles show while the caret is in the table, #2428; previously trivial: progress log: a click below a floating table reaches the text after it, #2038; previously trivial: progress log: Delete on selected table cells leaves one empty paragraph in each, #2802; previously trivial: progress log: lam-alef in exported PDFs extracts whole with fonts that draw it as two glyphs, #2310; previously trivial: Bullets and Numbering toggle off style-inherited lists at their effective level, including basedOn chains and numbered ListParagraph styles; other paragraphs and list definitions stay unchanged (related to #3459); previously trivial: Russian sorting keeps ё with е and recognises decomposed ё/й; previously trivial: progress log: a text box that keeps the keyboard no longer resets the input method every frame, #2986; previously trivial: progress log: recovery copies and .json files store pictures as base64, #586 follow-up; previously trivial: progress log: legacy menu keys, #1697; previously trivial: progress log: shape gradients and transparency, #1500; previously trivial: progress log: Focus fills the screen, and Full Screen View shows the pages alone, #1678; previously trivial: progress log: text above a float's anchor wraps around it, #2048; previously trivial: progress log: File › Recover follows the app theme, #3243; previously trivial: progress log: formatting toolbar with the text context menu, #2959; previously trivial: progress log: caret inside ligatures, #1974; previously trivial: text typed into a content control takes the control's formatting; localized placeholder styles recognised; previously trivial: forms protection keeps its content controls: no inserting, Properties or Remove Content Control; previously trivial: long navigation headings wrap onto further lines within the pane, #3015; previously trivial: clearing a no-match font query keeps the recent heading visible, #2068; previously trivial: a word after a slash wraps whole, like Word, #2963; previously trivial: progress log: a header-cell picture watermark sits behind the text, #1775; previously trivial: symbols keep their font when the text font changes, #2036; previously trivial: opening a DOCX no longer copies its pictures; previously trivial: Add Font imports every selected font file, #1789); previously trivial (RTF export writes sections (gap 19); previously trivial: ODT export writes sections (gap 19); previously trivial: Read Aloud speaks each sentence in its own language, #1843; previously trivial: hint-reliant CJK outlines; previously trivial: Ctrl+wheel zoom no longer scrolls the document, #1743; previously trivial: progress log: Turkish case mapping in AutoCorrect, #1923; previously trivial: a mouse drag on a table leaves the view where it is, #1738; previously trivial: progress log: Hebrew field results and smart quotes, #1670; previously trivial: Backspace removes a selected table, rows or columns, #1844; previously trivial: progress log: mixed Hebrew/Latin text keeps its order in Word, #1543; previously trivial: progress log: web typing in non-Latin text no longer repeats, #1480; previously trivial: progress log: font family caches bounded and math font lookups follow font changes, #1354; previously trivial: `-->` AutoCorrect replacement, #2223; previously trivial: numbered headings, #1793; previously trivial: Navigation Find exposes Results, #2096; previously trivial: progress log: Columns on selected text, #2024; previously trivial: progress log: legacy outline, shadow, emboss and imprint text effects drawn, #2534; previously trivial: progress log: Indonesian proofing, #498; previously trivial: progress log: DOCX glossary documents (building blocks); previously trivial: progress log: Read Mode keeps the keyboard and shows whole, unobscured columns, #1772); previously trivial: progress log: font list entries of tall-ascent fonts no longer cut off, #2570); previously trivial: progress log: Split Cells and Convert Text to Table dialogs follow the Word check, #2592; previously trivial: a new source's Tag is made like Word's, three letters of the author and two digits of the year with a number added when taken, and an edit keeps the Tag, #2094; previously trivial: Web Layout fills the window width, #1876; previously trivial: progress log: Different First Page headers reachable from page 1, #2826; previously trivial: Language dialog keeps inherited proofing language and no-proof choices (#2717); previously trivial: progress log: web preferences kept between visits, #2132; previously trivial: progress log: undrawable private-use list bullets show the level's default bullet, #1683; previously trivial: progress log: `w:eastAsianLayout` kept on save; previously trivial: table style editor formats every part, #714); previously trivial: VML freeforms read and kept on save; previously trivial: progress log: consistent preferred cell widths; previously trivial: multi-paragraph field instructions no longer add blank lines; previously trivial: page-break-only list paragraphs hide their labels; previously trivial: progress log: grouped `flowChartOr` shapes draw their circle and crossing spokes; previously trivial: progress log: copies keep their formatting in other programs, #1523; previously trivial: progress log: privacy options on save, #1062; previously trivial: progress log: equation pictures in theme colours on Windows, #1002; previously trivial: symbol fonts, #776; previously trivial: the save prompt answers from the keyboard, #861; previously trivial: table column and row markers on the rulers, #700; previously trivial: table borders and the resize handle drag on the page, #217; previously trivial: formatting revisions landed, #41; previously trivial: Draw tab ink, #307, and Draw Table and Eraser, #303, landed: catalog 402/434; previously minor: readiness table with hours per audience; full number back to the additive weighted sum, 60%; mainstream and essentials numbers added; alpha gate checked; previously major: full re-measure against Word for Mac 16.113.4; progress docs restructured) · **Target:** Microsoft Word (Microsoft 365) for Mac 16.113.4 +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-04 · **Change:** trivial (per-page ink object lookups, #3614); previously trivial (progress log: ODT display settings removed); previously trivial (progress log: dialogs are modal except the five Word keeps modeless, and a press beside one shakes it, #3859); previously trivial (progress log: picture brightness, contrast and transparency, ODT element audit, ODT checked against 220 files from other applications, ODT display styles); previously trivial (progress log: the dialogs of the mirrored Arabic interface read right to left: label-and-field rows, tables (list columns, the Models table), tile galleries and the Add/Remove arrows follow the reading direction, through one `rtl::Table` helper that draws exactly as before in English; no ranked gap closed, readiness estimates unchanged); previously trivial (progress log: fonts that aren't installed are flagged in the font box and status bar); previously trivial (progress log: ODT sections inside text boxes); previously trivial (progress log: ODT definitions sharing a name, sections around tables, stacking order); previously trivial (progress log: ODT forms and indexes written as read); previously trivial (progress log: ODT table styles saved, WordCraft-origin documents checked in LibreOffice); previously trivial (progress log: ODT interpretation profile); previously trivial (progress log: ODT controls, custom shapes, in-line placement); previously trivial (progress log: ODT charts kept, frame outlines, header height); previously trivial (progress log: ODT header rows); previously trivial (progress log: ODT layout setting, padding, columns); previously trivial (progress log: ODT tables, header spacing, picture paragraphs); previously trivial (progress log: ODT round trips keep their page count); previously trivial (progress log: emphasis marks, SET fields, ODT page backgrounds and tables); previously trivial (progress log: ODT checked against LibreOffice's templates); previously trivial (progress log: ODT at ~90%); previously trivial (progress log: ODT read and written nearly whole); previously trivial (progress log: ODT text boxes); previously trivial (progress log: ODT layout settings); previously trivial (progress log: ODT character styles); previously trivial (progress log: ODT custom styles); previously trivial (progress log: ODT equations saved); previously trivial (progress log: ODT floating pictures); previously trivial (progress log: ODT paragraph borders); previously trivial (progress log: ODT heading numbering); previously trivial (progress log: ODT table borders); previously trivial (progress log: ODT heading styles); previously trivial (progress log: ODT tab stops); previously trivial (progress log: ODT character formatting); previously trivial (progress log: ODT lists); previously trivial (progress log: ODT comments); previously trivial (progress log: ODT footnotes and endnotes); previously trivial (progress log: ODT headers, footers and fields); previously trivial (progress log: ODT paragraph spacing); previously trivial (progress log: Options › Language redesign, CP4.3); previously trivial (progress log: the missing-pack bar on a fresh install, the caret's typing language, and the spelling menu heading in the interface language, CP4.3); previously trivial (progress log: Language pack languages in every language list, CP4.3); previously trivial (progress log: craft-proof pin, French elision and Valencian, CP4.3); previously trivial (progress log: a long comment's card and balloon stop at ten lines, #3382); previously trivial (progress log: a pasted text box story is charged for the formatting it copies); previously trivial (progress log: a .doc table row keeps one override per cell); previously trivial (progress log: a .doc file's sections find their paragraphs by index); previously minor (Arabic interface language with mirrored UI, #1195); previously trivial (progress log: Replace and Remove Table of Contents with Word's title above a section break, #4041); previously trivial (progress log: a password-protected file named on the command line asks for its password after the startup document is replaced, #5299); previously trivial (progress log: language-packs-2 published and pinned, 75 Language packs); previously trivial (progress log: language-packs-1 published and pinned, CP4.4); previously trivial (progress log: Language packs, CP4);; previously trivial (DOCX table rows and cells inside selected alternate-content branches survive open and repeated saves (#5219); broader corpus qualification and readiness estimates unchanged); previously trivial (progress log: a list inside a Markdown block quote stays quoted); previously trivial (progress log: arrowheads keep their kind, width and length and are drawn at Word's sizes); previously trivial (progress log: the line between columns for selected text, #5178); previously trivial (progress log: .doc standard font, #5066); previously trivial (progress log: a table row doesn't split off a picture that doesn't fit, #4272); previously trivial (progress log: a middle or bottom cell of a row split across pages lines up on the first page); previously trivial (progress log: tab leader dots spaced and placed as in Word); previously trivial (progress log: a list level above counts its first number at the first deeper item); previously trivial (progress log: paragraph side borders lie outside the text, #5036); previously trivial (progress log: a paragraph naming an undefined style is formatted as Normal, #5077); previously trivial (progress log: TOC page numbers as PAGEREF fields, #5097); previously trivial (progress log: Backstage keytips, #4960); previously trivial (Progress log: only the printer's PDF leaves out links; Save these pages as PDF keeps them, #4734); previously trivial (progress log: Chinese and Japanese text counts a word per character, #4547; previously trivial: aligned-copy review fixes retain the document axis through scrolling and include secondary selections (#4764)); previously trivial (connector rerouting indexes laid-out object positions once per batch (#3631); previously trivial (progress log: corporate authors in bibliographies, #4848); previously trivial (custom-property bookmark-link preservation, #4767); previously trivial (progress log: Table Properties follows the selection, #4857); previously trivial (Relative font-size commands preserve mixed sizes in the selection (#4903); existing button steps and one-point shortcuts are unchanged; readiness estimates unchanged); previously trivial (Arabic Backspace removes one combining mark and keeps its base letter (#4757); previously trivial (note conversion walks reference offsets and formatting runs together, #4750); previously trivial (DOCX comment-ID save lookups); previously trivial (progress log: RTF pictures stored as Windows or Enhanced Metafiles are imported, #4259); previously trivial (#4658 bounds nested Markdown reference-label work); previously trivial (HTML import keeps preformatted lines with CR or CRLF input newlines, #4810); previously trivial (progress log: Insert › Shapes icon grid, #4349); previously trivial (progress log: AutoCorrect Options with no document open, #4585); previously trivial (progress log: window fallback geometry and equation symbol tooltips); previously trivial (progress log: window titles omit NUL characters, #3634); previously trivial (Recipient labels continue across product-sized sheets instead of stopping after the first sheet (#4880)); previously trivial (progress log: Custom document properties dialog, #2982; previously trivial: progress log: View › New Window; previously trivial: progress log: interface translations come from storytold/craft-i18n through the `craft-i18n` crate; previously trivial: progress log: disabled-control reasons translated in every interface language, #2678; previously trivial: progress log: mail merge record navigation and record ranges for printing, #3028; previously trivial: selection bar for right-to-left paragraphs and table rows; previously trivial: group connector rerouting preserves rotated and flipped free or unresolved endpoints under nonuniform group scaling; readiness estimates unchanged; previously trivial: progress log: a word with no break opportunity in it no longer makes the layout quadratic, #3412; previously trivial: progress log: a relationship the markup names without the prefix is read as it wrote, and an ordinary `id` names no part; previously trivial: progress log: a document with many relationships opens in the time its part takes, and an id the text only mentions is not a reference, #3411; previously trivial: progress log: read only and comments-only protection grey out edits; previously trivial: progress log: an empty paragraph with a hidden mark shows nothing, not even its list number, #3982; previously trivial: progress log: "NaN" in the Font dialog's Size box no longer closes the app, #3663; previously trivial: progress log: a table cell span from a `.json` file no longer overflows, #3637; previously trivial: progress log: a click in the footer while editing the header moves there; previously trivial: explicit documents keep the editor when recovery discovery finishes; readable recovery controls; previously trivial: Slovenian interface catalog, 2,614 entries; previously trivial: Insert Table of Figures dialog for any caption label, #3013; previously trivial: progress log: Home › Underline drop-down, #2738; previously trivial: personal templates in File › New and Save as Word Template, #2852; previously trivial: progress log: the scrollbar page tip stays on one line, #3341; previously trivial: progress log: forms protection greys out the control buttons; previously trivial: progress log: a document with many content controls saves in the time the controls take, #13; previously trivial: progress log: Word signature lines kept on save; previously trivial: a Thai run with Latin finds one installed font covering it all on Linux too, #1549; previously trivial: progress log: closing the header returns to the body selection, #3331; previously trivial: progress log: saving to a NAS share mounted by GVFS, #3003; previously trivial: progress log: a picture dragged near the bottom of a page lands there, #3169; previously trivial: centred list labels after leading page breaks, #2964; previously trivial: progress log: inline pictures drag to an insertion cursor and stay inline, #2233, #2234; previously trivial: progress log: a text file saved over itself closes without asking, #2376; previously trivial: progress log: a text frame in the paragraph defaults frames nothing, #2360; previously trivial: fixed font inputs in four layout controls; previously trivial: typing no longer starts render threads on every repaint, #3027; previously trivial: a right, centre or decimal tab whose text doesn't fit, or a left tab past the right indent, goes to the next line with its text, #1840; previously trivial: progress log: banded rows shade as in Word, #3415; previously trivial: progress log: the table handles show while the caret is in the table, #2428; previously trivial: progress log: a click below a floating table reaches the text after it, #2038; previously trivial: progress log: Delete on selected table cells leaves one empty paragraph in each, #2802; previously trivial: progress log: lam-alef in exported PDFs extracts whole with fonts that draw it as two glyphs, #2310; previously trivial: Bullets and Numbering toggle off style-inherited lists at their effective level, including basedOn chains and numbered ListParagraph styles; other paragraphs and list definitions stay unchanged (related to #3459); previously trivial: Russian sorting keeps ё with е and recognises decomposed ё/й; previously trivial: progress log: a text box that keeps the keyboard no longer resets the input method every frame, #2986; previously trivial: progress log: recovery copies and .json files store pictures as base64, #586 follow-up; previously trivial: progress log: legacy menu keys, #1697; previously trivial: progress log: shape gradients and transparency, #1500; previously trivial: progress log: Focus fills the screen, and Full Screen View shows the pages alone, #1678; previously trivial: progress log: text above a float's anchor wraps around it, #2048; previously trivial: progress log: File › Recover follows the app theme, #3243; previously trivial: progress log: formatting toolbar with the text context menu, #2959; previously trivial: progress log: caret inside ligatures, #1974; previously trivial: text typed into a content control takes the control's formatting; localized placeholder styles recognised; previously trivial: forms protection keeps its content controls: no inserting, Properties or Remove Content Control; previously trivial: long navigation headings wrap onto further lines within the pane, #3015; previously trivial: clearing a no-match font query keeps the recent heading visible, #2068; previously trivial: a word after a slash wraps whole, like Word, #2963; previously trivial: progress log: a header-cell picture watermark sits behind the text, #1775; previously trivial: symbols keep their font when the text font changes, #2036; previously trivial: opening a DOCX no longer copies its pictures; previously trivial: Add Font imports every selected font file, #1789); previously trivial (RTF export writes sections (gap 19); previously trivial: ODT export writes sections (gap 19); previously trivial: Read Aloud speaks each sentence in its own language, #1843; previously trivial: hint-reliant CJK outlines; previously trivial: Ctrl+wheel zoom no longer scrolls the document, #1743; previously trivial: progress log: Turkish case mapping in AutoCorrect, #1923; previously trivial: a mouse drag on a table leaves the view where it is, #1738; previously trivial: progress log: Hebrew field results and smart quotes, #1670; previously trivial: Backspace removes a selected table, rows or columns, #1844; previously trivial: progress log: mixed Hebrew/Latin text keeps its order in Word, #1543; previously trivial: progress log: web typing in non-Latin text no longer repeats, #1480; previously trivial: progress log: font family caches bounded and math font lookups follow font changes, #1354; previously trivial: `-->` AutoCorrect replacement, #2223; previously trivial: numbered headings, #1793; previously trivial: Navigation Find exposes Results, #2096; previously trivial: progress log: Columns on selected text, #2024; previously trivial: progress log: legacy outline, shadow, emboss and imprint text effects drawn, #2534; previously trivial: progress log: Indonesian proofing, #498; previously trivial: progress log: DOCX glossary documents (building blocks); previously trivial: progress log: Read Mode keeps the keyboard and shows whole, unobscured columns, #1772); previously trivial: progress log: font list entries of tall-ascent fonts no longer cut off, #2570); previously trivial: progress log: Split Cells and Convert Text to Table dialogs follow the Word check, #2592; previously trivial: a new source's Tag is made like Word's, three letters of the author and two digits of the year with a number added when taken, and an edit keeps the Tag, #2094; previously trivial: Web Layout fills the window width, #1876; previously trivial: progress log: Different First Page headers reachable from page 1, #2826; previously trivial: Language dialog keeps inherited proofing language and no-proof choices (#2717); previously trivial: progress log: web preferences kept between visits, #2132; previously trivial: progress log: undrawable private-use list bullets show the level's default bullet, #1683; previously trivial: progress log: `w:eastAsianLayout` kept on save; previously trivial: table style editor formats every part, #714); previously trivial: VML freeforms read and kept on save; previously trivial: progress log: consistent preferred cell widths; previously trivial: multi-paragraph field instructions no longer add blank lines; previously trivial: page-break-only list paragraphs hide their labels; previously trivial: progress log: grouped `flowChartOr` shapes draw their circle and crossing spokes; previously trivial: progress log: copies keep their formatting in other programs, #1523; previously trivial: progress log: privacy options on save, #1062; previously trivial: progress log: equation pictures in theme colours on Windows, #1002; previously trivial: symbol fonts, #776; previously trivial: the save prompt answers from the keyboard, #861; previously trivial: table column and row markers on the rulers, #700; previously trivial: table borders and the resize handle drag on the page, #217; previously trivial: formatting revisions landed, #41; previously trivial: Draw tab ink, #307, and Draw Table and Eraser, #303, landed: catalog 402/434; previously minor: readiness table with hours per audience; full number back to the additive weighted sum, 60%; mainstream and essentials numbers added; alpha gate checked; previously major: full re-measure against Word for Mac 16.113.4; progress docs restructured) · **Target:** Microsoft Word (Microsoft 365) for Mac 16.113.4 > **Printing update:** 2026-10-12 · direct desktop printing through craft-print; details below. WordCraft aims for complete parity with Microsoft Word, then goes further on speed, openness and @@ -139,6 +139,8 @@ Ranked, to beta (detail and remaining milestones in [docs/roadmap.md](docs/roadm ## Progress log +- 2026-10-28: Ink replay, eraser picking, lasso selection and arrow-candidate discovery reuse the paragraph prefixes they have already scanned (#3614). Page item order, stroke geometry and saved data retain their behavior. This narrows the stability work; ink import fidelity, native pen input and broader corpus qualification remain open. + - 2026-11-04: OpenDocument files have no display settings any more (gap 19): File › Options › Advanced › OpenDocument files, `file.options` `odf`, `WORDCRAFT_ODF`, the LibreOffice style and custom values are gone. WordCraft makes one choice for each case the standard leaves open, the one the default made, and still follows what a file states ([docs/odf-interpretation.md](docs/odf-interpretation.md)). - 2026-10-31: Dialogs are modal, as in Word (#3859): while one is open, the ribbon, File, the page and the panes of its document window take no clicks, and typing and shortcuts (Ctrl+O…) do nothing until it closes; WordCraft's own Open/Save As window is modal too. A press beside a modal dialog shakes it a little, so it is clear why nothing behind it reacts (Word beeps); with animation effects off, its border flashes instead. Find and Replace, Symbol, Mark Index Entry, Cross-reference and Insert Merge Field stay modeless, as in Word for Mac 16.114.1 (checked on a newer build than the 16.113.4 the parity target names). - 2026-11-04: OpenDocument files are shown in one of two styles (gap 19): Microsoft Word style, the default, or LibreOffice style (File › Options › Advanced › OpenDocument files; `file.options` `{"odf": {"preset": "word"}}` or `"libreoffice"`; `WORDCRAFT_ODF=word` or `WORDCRAFT_ODF=libreoffice`). Custom stays for one's own value per case; `wordcraft`, the earlier id of Word's style, is still taken. @@ -770,6 +772,7 @@ Footer page-table height and body wrapping are corrected. Other pagination gaps | Date | Change | Summary | |---|---|---| +| 2026-10-28 | trivial | Per-page ink object lookups, #3614. Drawing order, geometry and saved data retain their behavior; no readiness estimate change | | 2026-11-04 | trivial | Progress log: OpenDocument display settings removed (gap 19) | | 2026-10-31 | trivial | Progress log: dialogs are modal except the five Word keeps modeless; a press beside one shakes it (#3859) | | 2026-11-04 | trivial | Progress log: picture brightness, contrast and transparency (#1711, #1766) | diff --git a/crates/engine/src/cmd/draw.rs b/crates/engine/src/cmd/draw.rs index 11d7bea76d..f762cb30b2 100644 --- a/crates/engine/src/cmd/draw.rs +++ b/crates/engine/src/cmd/draw.rs @@ -26,6 +26,9 @@ use super::ink_shape::{ArrowParts, InkShape, arrow_parts, pair_parts, recognise} use super::pos_json; use crate::{CmdError, CmdResult, CommandSpec, Session, p}; +mod page_objects; +use page_objects::PageObjects; + /// What dragging on the page does (Draw tab). #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -325,12 +328,13 @@ impl PlacedInk { /// turn and geometry on the page. pub fn ink_on(s: &Session, layout: &DocLayout, page: usize) -> Vec { let Some(pg) = layout.pages.get(page) else { return Vec::new() }; + let mut objects = PageObjects::new(&s.doc); pg.items .iter() .filter_map(|it| match it { Placed::Object { rect, spin, story, path, off, .. } => { let pos = Pos { story: *story, path: path.clone(), off: *off }; - match s.doc.para_at(&pos).and_then(|p| p.object_at(*off)) { + match objects.get(&pos) { Some(InlineObject::Shape { freeform: Some(f), stroke_width, stroke, .. }) if f.is_ink() => { Some(PlacedInk { pos, rect: *rect, spin: *spin, freeform: f.clone(), color: *stroke, width: *stroke_width }) } @@ -577,10 +581,11 @@ fn lasso(s: &mut Session, v: &Value) -> CmdResult { return Err(CmdError::Params("a lasso loop needs at least three points".into())); } let mut items = Vec::new(); + let mut objects = PageObjects::new(&s.doc); for it in &pg.items { let Placed::Object { rect, spin, story, path, off, .. } = it else { continue }; let pos = Pos { story: *story, path: path.clone(), off: *off }; - let Some(obj) = s.doc.para_at(&pos).and_then(|p| p.object_at(*off)) else { continue }; + let Some(obj) = objects.get(&pos) else { continue }; let picked = match obj.ink() { Some(_) if s.view.hide_ink => false, Some(f) => { @@ -771,13 +776,14 @@ fn near(a: Rect, b: Rect) -> bool { fn arrow_pieces(s: &Session, layout: &DocLayout, page: usize, keep: impl Fn(&Pos, &Rect) -> bool) -> Vec { let Some(pg) = layout.pages.get(page) else { return Vec::new() }; let mut out = Vec::new(); + let mut objects = PageObjects::new(&s.doc); for it in &pg.items { let Placed::Object { rect, spin, story, path, off, .. } = it else { continue }; let pos = Pos { story: *story, path: path.clone(), off: *off }; if !spin.is_identity() || !keep(&pos, rect) { continue; } - let Some(InlineObject::Shape { kind, freeform: Some(f), float, .. }) = s.doc.para_at(&pos).and_then(|p| p.object_at(*off)) else { continue }; + let Some(InlineObject::Shape { kind, freeform: Some(f), float, .. }) = objects.get(&pos) else { continue }; let Some(fp) = f.paths.first().filter(|_| f.paths.len() == 1) else { continue }; let pen = matches!(f.ink, Some(InkTool::Pen | InkTool::Pencil)) && !s.view.hide_ink; let shape = f.ink.is_none() && *kind == ShapeKind::Freeform && matches!((fp.pts.len(), fp.closed), (2, false) | (3, true)); diff --git a/crates/engine/src/cmd/draw/page_objects.rs b/crates/engine/src/cmd/draw/page_objects.rs new file mode 100644 index 0000000000..b72e8ba306 --- /dev/null +++ b/crates/engine/src/cmd/draw/page_objects.rs @@ -0,0 +1,48 @@ +//! Per-call object lookups for drawing-order page walks, which can revisit a paragraph's +//! offsets out of text order. Scan only as far as the furthest requested object, once. + +use std::collections::HashMap; +use wordcraft_doc::para::OBJ; +use wordcraft_doc::{Document, InlineObject, Path, Pos, StoryRef}; + +#[derive(Default)] +struct ParagraphObjects<'a> { + scanned: usize, + ordinal: usize, + objects: Vec<(usize, &'a InlineObject)>, +} + +pub(super) struct PageObjects<'a> { + doc: &'a Document, + paragraphs: HashMap<(StoryRef, Path), ParagraphObjects<'a>>, +} + +impl<'a> PageObjects<'a> { + pub(super) fn new(doc: &'a Document) -> Self { + Self { doc, paragraphs: HashMap::new() } + } + + pub(super) fn get(&mut self, pos: &Pos) -> Option<&'a InlineObject> { + let p = self.doc.para_at(pos)?; + if !p.text.get(pos.off..)?.starts_with(OBJ) { + return None; + } + let end = pos.off.checked_add(OBJ.len_utf8())?; + let cached = self.paragraphs.entry((pos.story, pos.path.clone())).or_default(); + if end > cached.scanned { + // Start after the last scanned marker, not at the paragraph's start. In particular, + // a lone object near the start never scans a long text suffix it doesn't need. + for (off, c) in p.text.get(cached.scanned..end)?.char_indices() { + if c == OBJ { + if let Some(object) = p.objects.get(cached.ordinal) { + cached.objects.push((cached.scanned + off, object)); + } + cached.ordinal += 1; + } + } + cached.scanned = end; + } + let i = cached.objects.binary_search_by_key(&pos.off, |(off, _)| *off).ok()?; + cached.objects.get(i).map(|(_, object)| *object) + } +} diff --git a/crates/engine/src/cmd/draw/tests.rs b/crates/engine/src/cmd/draw/tests.rs index 66c02cc848..90a758e1fe 100644 --- a/crates/engine/src/cmd/draw/tests.rs +++ b/crates/engine/src/cmd/draw/tests.rs @@ -5,6 +5,8 @@ use wordcraft_doc::para::{InlineObject, ShapeKind, Wrap}; use crate::Session; +mod page_lookup; + fn session() -> Session { let mut s = Session::new(wordcraft_doc::Document::new()); s.run("document.setText", &json!({"text": "First paragraph of text.\nSecond paragraph of text."})).unwrap(); diff --git a/crates/engine/src/cmd/draw/tests/page_lookup.rs b/crates/engine/src/cmd/draw/tests/page_lookup.rs new file mode 100644 index 0000000000..a2b9e6b6ba --- /dev/null +++ b/crates/engine/src/cmd/draw/tests/page_lookup.rs @@ -0,0 +1,132 @@ +use super::super::{PlacedInk, ink_on}; +use crate::Session; +use std::sync::Arc; +use wordcraft_doc::freeform::{Freeform, InkTool}; +use wordcraft_doc::para::{Float, InlineObject, OBJ, ShapeKind, Wrap}; +use wordcraft_doc::{CharProps, Document, Paragraph, Path, Pos, StoryRef, para_block}; +use wordcraft_geom::{Rect, Spin}; +use wordcraft_layout::{DocLayout, Page, Placed}; + +fn stroke(order: u32) -> InlineObject { + InlineObject::Shape { + kind: ShapeKind::Freeform, + w: 20.0, + h: 10.0, + fill: None, + stroke: Some(wordcraft_doc::Rgb(12, 34, 56)), + stroke_width: 2.0, + float: Float { wrap: Wrap::InFrontOfText, ..Default::default() }, + story: None, + freeform: Some(Arc::new(Freeform { order: Some(order), ..Freeform::ink(InkTool::Pen, 20.0, 10.0, vec![[1.0, 1.0], [19.0, 9.0]]) })), + effects: Default::default(), + extra: Default::default(), + } +} + +fn placed(story: StoryRef, path: Path, off: usize, x: f32) -> Placed { + Placed::Object { + rect: Rect::new(x, 30.0, 20.0, 10.0), + spin: Spin::default(), + story, + path, + off, + text_box: None, + wrap: Wrap::InFrontOfText, + origin: Default::default(), + } +} + +fn orders(ink: &[PlacedInk]) -> Vec { + ink.iter().map(|k| k.freeform.order.unwrap()).collect() +} + +#[test] +fn page_ink_keeps_item_order_duplicates_story_paths_and_unmatched_storage() { + let mut d = Document::new(); + let mut p = Paragraph::new(); + p.text = format!("é{OBJ}{OBJ}{OBJ}漢{OBJ}"); + p.runs = vec![wordcraft_doc::Run { len: p.text.len(), props: CharProps::default() }]; + p.objects = vec![InlineObject::BookmarkStart { name: "original".into() }, stroke(11), stroke(22)]; + d.body = vec![para_block(p.clone())]; + let h = d.add_part(wordcraft_doc::PartKind::Header, vec![para_block(p.clone())]); + let mut table = wordcraft_doc::Table::new(1, 1, 100.0); + p.objects.push(stroke(33)); + p.objects.push(stroke(99)); // Surplus storage has no character and is not placed. + table.rows[0].cells[0].blocks = vec![para_block(p)]; + d.body.push(Arc::new(wordcraft_doc::Block::Table(table))); + let cell = Path(vec![1, 0, 0, 0]); + let mut items = vec![ + placed(StoryRef::Body, Path::top(0), 8, 50.0), + placed(StoryRef::Part(h), Path::top(0), 5, 60.0), + placed(StoryRef::Body, cell.clone(), 14, 70.0), + placed(StoryRef::Body, Path::top(0), 5, 80.0), + placed(StoryRef::Body, Path::top(0), 8, 90.0), + ]; + items.extend([0, 1, 2, 3, 4, 11, 14, usize::MAX].map(|off| placed(StoryRef::Body, Path::top(0), off, 0.0))); + items.push(placed(StoryRef::Part(999), Path::top(0), 0, 0.0)); + let l = DocLayout { pages: vec![Page { items, ..Default::default() }], ..Default::default() }; + let mut s = Session::new(d); + let original = s.doc.clone(); + let got = ink_on(&s, &l, 0); + assert_eq!(orders(&got), [22, 11, 33, 11, 22]); + assert_eq!(got.iter().map(|k| k.rect.x).collect::>(), [50.0, 60.0, 70.0, 80.0, 90.0]); + assert_eq!(got[1].pos, Pos::new(StoryRef::Part(h), Path::top(0), 5)); + assert_eq!(got[2].pos.path, cell); + assert!(got.iter().all(|k| k.width == 2.0 && k.color == Some(wordcraft_doc::Rgb(12, 34, 56)))); + assert!(ink_on(&s, &l, 1).is_empty()); + s.view.hide_ink = true; + assert_eq!(orders(&ink_on(&s, &l, 0)), orders(&got), "discovery retains hidden ink; callers decide visibility"); + assert_eq!(s.doc, original); +} + +#[test] +fn page_ink_lookup_work_does_not_multiply_with_paragraph_objects() { + fn fixture(n: usize) -> (Session, DocLayout) { + let mut d = Document::new(); + let mut p = Paragraph::new(); + p.text = OBJ.to_string().repeat(n); + p.runs = vec![wordcraft_doc::Run { len: p.text.len(), props: CharProps::default() }]; + p.objects = (0..n).map(|i| stroke(i as u32)).collect(); + d.body = vec![para_block(p)]; + let items = (0..n).map(|i| placed(StoryRef::Body, Path::top(0), i * OBJ.len_utf8(), 50.0)).collect(); + (Session::new(d), DocLayout { pages: vec![Page { items, ..Default::default() }], ..Default::default() }) + } + // Scheduling delays do not count. Without an advancing Linux thread CPU clock, the + // semantic assertions still run and only the scaling check is skipped. + fn ran() -> Option { + std::fs::read_to_string("/proc/thread-self/schedstat").ok()?.split_whitespace().next()?.parse().ok() + } + fn cost(mut f: impl FnMut()) -> Option { + let before = ran()?; + for _ in 0..32 { + f(); + } + let elapsed = ran()?.checked_sub(before)?; + (elapsed > 0).then_some(elapsed as f64 / 32.0) + } + let (small, a) = fixture(250); + let (big, b) = fixture(2000); + assert_eq!(ink_on(&small, &a, 0).len(), 250); + assert_eq!(ink_on(&big, &b, 0).len(), 2000); + let mut t1 = f64::INFINITY; + let mut t8 = f64::INFINITY; + for _ in 0..5 { + let Some(small_cost) = cost(|| { + for _ in 0..8 { + std::hint::black_box(ink_on(&small, &a, 0)); + } + }) else { + return; + }; + let Some(big_cost) = cost(|| { + std::hint::black_box(ink_on(&big, &b, 0)); + }) else { + return; + }; + t1 = t1.min(small_cost / 8.0); + t8 = t8.min(big_cost); + } + let ratio = t8 / t1; + eprintln!("page ink CPU ratio={ratio:.2} for 8x objects"); + assert!(ratio < 24.0, "page ink lookup repeats paragraph-prefix work: {ratio:.2}x CPU for 8x objects"); +} diff --git a/docs/gaps.md b/docs/gaps.md index 29a88606b2..cbb76c76b9 100644 --- a/docs/gaps.md +++ b/docs/gaps.md @@ -1,6 +1,6 @@ # Where WordCraft falls short of Word -> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-04 · **Change:** trivial (#19: ODT settings for what the standard leaves open removed); previously trivial (#19: ODT element audit; files from other applications checked); previously trivial (#11: the dialogs of the mirrored Arabic interface read right to left: label-and-field rows, tables (list columns, the Models table), tile galleries and the Add/Remove arrows follow the reading direction, through one `rtl::Table` helper that draws exactly as before in English; no ranked gap closed, readiness estimates unchanged); previously trivial (#4: fonts that aren't installed are flagged in the font box and status bar); previously trivial (#19: ODT sections inside text boxes kept as read); previously trivial (#19: an ODT saved without edits keeps what WordCraft doesn't model); previously trivial (#19: ODT interpretation profile, WordCraft / LibreOffice / custom); previously trivial (#19: ODT form controls placed and multi-line; custom shapes keep their geometry); previously trivial (#19: ODT in-line frames placed against the text; template instantiation listed as left); previously trivial (#19: ODT charts kept as read; frame outlines; default header height); previously trivial (#19: ODT tables no longer gain repeated header rows); previously trivial (#19: ODT padding without a border, unequal columns, column breaks, picture-only lines); previously trivial (#19: ODT tables' margins and spacing, header spacing, pictures alone in a paragraph); previously trivial (#19: no LibreOffice template changes page count through a save); previously trivial (#19: ODT variables, emphasis marks, page backgrounds, fixed tables, default size); previously trivial (#19: ODT checked against LibreOffice's own templates: placeholders, first-page styles, unsized pages, metafile logos, `.ott`); previously trivial (#19: ODT at ~90%: custom shapes, cell formulas, macros kept, turned text, control sizes and buttons); previously trivial (#19 narrowed: ODT read and written nearly whole; estimate 18–27 h → 10–16 h); previously trivial (#10 narrowed: text in a turned text box is drawn turned with it); previously trivial (gap 19 narrowed: ODT heading numbering read and written); previously trivial (gap 19 narrowed: ODT table borders and padding read and written); previously trivial (gap 19 narrowed: ODT heading style looks read and written); previously trivial (gap 19 narrowed: ODT tab stops read and written); previously trivial (gap 19 narrowed: ODT character formatting read and written); previously trivial (gap 19 narrowed: ODT list formats read and written); previously trivial (gap 19 narrowed: ODT comments read and written); previously trivial (gap 19 narrowed: ODT footnotes and endnotes read and written); previously trivial (gap 19 narrowed: ODT headers and footers written, text fields and paragraph spacing read and written); previously trivial (#8: Options › Language lists Your languages and Add a language… replaces the Language packs table); previously trivial (#8: the missing-pack bar works on a fresh install and counts the caret's language); previously trivial (#8: Language pack languages are in Set Proofing Language, Review › Language and the status bar; built-in proofing is named as such); previously trivial (#20: layout resource caps and linear-time passes (#3867, #3866)); previously trivial (#3 narrowed: a pasted text box story is charged for the formatting it copies); previously trivial (#3 narrowed: a .doc table row keeps one override per cell); previously trivial (#3 narrowed: a .doc file's sections find their paragraphs by index); previously minor (#11: Arabic interface with mirrored shell landed, #1195; hi/id/pt-PT and Hebrew UI remain); previously trivial (#8: language-packs-2 is published and pinned: 75 packs, adding Danish, German (Germany, Austria, Switzerland), Esperanto, Estonian, Persian, Croatian, Hungarian, Norwegian (Bokmål, Nynorsk), Dutch and Swedish (Sweden, Finland); no ranked gap changed); previously trivial (#8: language-packs-1 is published and pinned, 61 packs: Lithuanian, Romanian, Catalan, French, Greek, Slovak, Serbian and Latvian install as Language packs; Dutch, German and the other compounding languages wait on craft-proof; no ranked gap changed); previously minor (#8: Language packs: every other language's spelling and hyphenation installs from File › Options › Language or the missing-pack bar, through the font store; Lithuanian and Romanian are available as a Language pack once language-packs-1 is published; Dutch, Catalan, French, Greek, Slovak, Serbian and Latvian packs wait on craft-proof engine support); previously trivial (gap 8: English spelling reads SCOWL 2026, one dictionary per English, #40, #520, #5205; no ranked gap changed);; previously trivial (DOCX table rows and cells inside selected alternate-content branches survive open and repeated saves (#5219); broader corpus qualification and readiness estimates unchanged); previously trivial (#26 narrowed: MHT opens and `w:altChunk` content is brought in on open; saving MHT remains) previously trivial (gap 8 points at craft-proof in craft-libs, its data in craft-i18n, #5202; no ranked gap changed); previously trivial (arrowheads keep their kind, width and length and are drawn at Word's sizes; no ranked gap changed); previously trivial (.doc default font from the stylesheet's standard font, #5066; no ranked gap changed); previously trivial (a middle or bottom cell of a row split across pages lines up on the first page; no ranked gap changed); previously trivial (tab leader dots spaced and placed as in Word; no ranked gap changed); previously trivial (a list level above counts its first number at the first deeper item; no ranked gap changed); previously trivial (only the PDF sent to the printer leaves out link annotations; Save these pages as PDF keeps them, #4734; no ranked gap changed); previously trivial (documents with links print: the print job leaves out link annotations, #4734; no ranked gap changed; previously trivial: aligned-copy review fixes retain the document axis through scrolling and include secondary selections (#4764)); previously trivial (connector rerouting indexes laid-out object positions once per batch (#3631); previously trivial (custom-property bookmark-link preservation, #4767); previously trivial (Relative font-size commands preserve mixed sizes in the selection (#4903); existing button steps and one-point shortcuts are unchanged; readiness estimates unchanged); previously trivial (Arabic Backspace removes one combining mark and keeps its base letter (#4757); previously trivial (note conversion reference-run membership uses one ordered walk, #4750); previously trivial (DOCX comment-ID save lookups); previously trivial (gap 19: RTF reads and writes WMF and EMF pictures, #4259); previously trivial (#4658 bounds nested Markdown reference-label work); previously trivial (HTML import keeps preformatted lines with CR or CRLF input newlines, #4810); previously trivial (Recipient labels continue across product-sized sheets instead of stopping after the first sheet (#4880)); previously trivial (View windows: several open documents and Switch Windows in the engine; previously trivial: explicit documents keep the editor when recovery discovery finishes; readable recovery controls; previously trivial: text mini toolbar available with the right-click menu, #2959; previously trivial: personal templates in File › New and Save as Word Template, #2852; previously trivial: tracked table/row/cell/section property changes record in WordCraft, narrowing gap 5; previously trivial: a document with many content controls saves in the time the controls take, #13; previously trivial: Format Page Numbers dialog carries Word's number formats and Continue from previous section / Start at, #1113; previously trivial: centred list labels after leading page breaks, #2964; previously trivial: fixed font inputs in four layout controls; previously trivial: a right, centre or decimal tab whose text doesn't fit, or a left tab past the right indent, goes to the next line with its text, #1840; previously trivial: Bullets and Numbering toggle off style-inherited lists at their effective level, including basedOn chains and numbered ListParagraph styles; other paragraphs and list definitions stay unchanged (related to #3459); previously trivial: Russian sorting keeps ё with е and recognises decomposed ё/й; previously trivial: #8: English dialects — en-GB, en-CA, en-AU… flag each other's spellings, #1281; previously trivial: #1: shape gradients and transparency, #1500; previously trivial: text typed into a content control takes the control's formatting; localized placeholder styles recognised; previously trivial: forms protection keeps its content controls: no inserting, Properties or Remove Content Control; previously trivial: clearing a no-match font query keeps the recent heading visible, #2068; previously trivial: line breaking: a slash opening a word travels whole to the next line, #2963; previously trivial: recipient list search and merged-only view, #1576; previously trivial: #2 impact restated: only ink rendering and OLE editing remain; previously trivial: #2 narrowed: native ink nested in groups and drawing canvases kept on save; previously trivial: opening a DOCX no longer copies its pictures; previously trivial: RTF export writes sections (gap 19); previously trivial: ODT export writes sections (gap 19); previously trivial: automatic Asian/Latin and Asian/number spacing laid out, #2358; previously trivial: hint-reliant CJK outlines; previously trivial: numbered headings, #1793; previously trivial: legacy outline, shadow, emboss and imprint text effects drawn, #2534; previously trivial: #8 narrowed: Indonesian proofing from the installed Hunspell dictionary, #498; previously trivial: glossary/building blocks closed; previously trivial: Split Cells and Convert Text to Table follow the Word check, #2592; previously trivial: Language dialog keeps inherited proofing language and no-proof choices (#2717); previously trivial: #29: a copied equation also goes in the MathML clipboard formats, #1297; previously trivial: #24: the Spike, Ctrl+F3 and Ctrl+Shift+F3; previously trivial: VML freeforms read and kept on save; previously trivial: consistent preferred cell widths; previously trivial: multi-paragraph field instructions no longer add blank lines; previously trivial: page-break-only list paragraphs hide their labels; previously trivial: floating-table overlap ignores empty line-break lines; previously trivial: copies keep their formatting on the clipboard as HTML, #1523; previously trivial: sample-text formulas on Enter, #1067; previously trivial: #29: copied equations as MathML, OMML open as #1297, #816; previously trivial: the Font list no longer keeps every previewed font in memory, #848; previously trivial: table column and row markers on the rulers, #700; previously trivial: table borders and the resize handle drag on the page, #217; previously trivial: formatting revisions landed, #41; previously trivial: Draw Table and Eraser landed, #303; previously minor: beta distance restated: ~15 points, ~150–230 h; previously: first version; every known shortfall from the 2026-10-10 re-measure, ranked) · **Target:** Microsoft Word (Microsoft 365) for Mac 16.113.4 +> **Last reviewed:** 2026-10-10 · **Last updated:** 2026-11-04 · **Change:** trivial (ink page lookups reuse scanned paragraph prefixes, #3614); previously trivial (#19: ODT settings for what the standard leaves open removed); previously trivial (#19: ODT element audit; files from other applications checked); previously trivial (#11: the dialogs of the mirrored Arabic interface read right to left: label-and-field rows, tables (list columns, the Models table), tile galleries and the Add/Remove arrows follow the reading direction, through one `rtl::Table` helper that draws exactly as before in English; no ranked gap closed, readiness estimates unchanged); previously trivial (#4: fonts that aren't installed are flagged in the font box and status bar); previously trivial (#19: ODT sections inside text boxes kept as read); previously trivial (#19: an ODT saved without edits keeps what WordCraft doesn't model); previously trivial (#19: ODT interpretation profile, WordCraft / LibreOffice / custom); previously trivial (#19: ODT form controls placed and multi-line; custom shapes keep their geometry); previously trivial (#19: ODT in-line frames placed against the text; template instantiation listed as left); previously trivial (#19: ODT charts kept as read; frame outlines; default header height); previously trivial (#19: ODT tables no longer gain repeated header rows); previously trivial (#19: ODT padding without a border, unequal columns, column breaks, picture-only lines); previously trivial (#19: ODT tables' margins and spacing, header spacing, pictures alone in a paragraph); previously trivial (#19: no LibreOffice template changes page count through a save); previously trivial (#19: ODT variables, emphasis marks, page backgrounds, fixed tables, default size); previously trivial (#19: ODT checked against LibreOffice's own templates: placeholders, first-page styles, unsized pages, metafile logos, `.ott`); previously trivial (#19: ODT at ~90%: custom shapes, cell formulas, macros kept, turned text, control sizes and buttons); previously trivial (#19 narrowed: ODT read and written nearly whole; estimate 18–27 h → 10–16 h); previously trivial (#10 narrowed: text in a turned text box is drawn turned with it); previously trivial (gap 19 narrowed: ODT heading numbering read and written); previously trivial (gap 19 narrowed: ODT table borders and padding read and written); previously trivial (gap 19 narrowed: ODT heading style looks read and written); previously trivial (gap 19 narrowed: ODT tab stops read and written); previously trivial (gap 19 narrowed: ODT character formatting read and written); previously trivial (gap 19 narrowed: ODT list formats read and written); previously trivial (gap 19 narrowed: ODT comments read and written); previously trivial (gap 19 narrowed: ODT footnotes and endnotes read and written); previously trivial (gap 19 narrowed: ODT headers and footers written, text fields and paragraph spacing read and written); previously trivial (#8: Options › Language lists Your languages and Add a language… replaces the Language packs table); previously trivial (#8: the missing-pack bar works on a fresh install and counts the caret's language); previously trivial (#8: Language pack languages are in Set Proofing Language, Review › Language and the status bar; built-in proofing is named as such); previously trivial (#20: layout resource caps and linear-time passes (#3867, #3866)); previously trivial (#3 narrowed: a pasted text box story is charged for the formatting it copies); previously trivial (#3 narrowed: a .doc table row keeps one override per cell); previously trivial (#3 narrowed: a .doc file's sections find their paragraphs by index); previously minor (#11: Arabic interface with mirrored shell landed, #1195; hi/id/pt-PT and Hebrew UI remain); previously trivial (#8: language-packs-2 is published and pinned: 75 packs, adding Danish, German (Germany, Austria, Switzerland), Esperanto, Estonian, Persian, Croatian, Hungarian, Norwegian (Bokmål, Nynorsk), Dutch and Swedish (Sweden, Finland); no ranked gap changed); previously trivial (#8: language-packs-1 is published and pinned, 61 packs: Lithuanian, Romanian, Catalan, French, Greek, Slovak, Serbian and Latvian install as Language packs; Dutch, German and the other compounding languages wait on craft-proof; no ranked gap changed); previously minor (#8: Language packs: every other language's spelling and hyphenation installs from File › Options › Language or the missing-pack bar, through the font store; Lithuanian and Romanian are available as a Language pack once language-packs-1 is published; Dutch, Catalan, French, Greek, Slovak, Serbian and Latvian packs wait on craft-proof engine support); previously trivial (gap 8: English spelling reads SCOWL 2026, one dictionary per English, #40, #520, #5205; no ranked gap changed);; previously trivial (DOCX table rows and cells inside selected alternate-content branches survive open and repeated saves (#5219); broader corpus qualification and readiness estimates unchanged); previously trivial (#26 narrowed: MHT opens and `w:altChunk` content is brought in on open; saving MHT remains) previously trivial (gap 8 points at craft-proof in craft-libs, its data in craft-i18n, #5202; no ranked gap changed); previously trivial (arrowheads keep their kind, width and length and are drawn at Word's sizes; no ranked gap changed); previously trivial (.doc default font from the stylesheet's standard font, #5066; no ranked gap changed); previously trivial (a middle or bottom cell of a row split across pages lines up on the first page; no ranked gap changed); previously trivial (tab leader dots spaced and placed as in Word; no ranked gap changed); previously trivial (a list level above counts its first number at the first deeper item; no ranked gap changed); previously trivial (only the PDF sent to the printer leaves out link annotations; Save these pages as PDF keeps them, #4734; no ranked gap changed); previously trivial (documents with links print: the print job leaves out link annotations, #4734; no ranked gap changed; previously trivial: aligned-copy review fixes retain the document axis through scrolling and include secondary selections (#4764)); previously trivial (connector rerouting indexes laid-out object positions once per batch (#3631); previously trivial (custom-property bookmark-link preservation, #4767); previously trivial (Relative font-size commands preserve mixed sizes in the selection (#4903); existing button steps and one-point shortcuts are unchanged; readiness estimates unchanged); previously trivial (Arabic Backspace removes one combining mark and keeps its base letter (#4757); previously trivial (note conversion reference-run membership uses one ordered walk, #4750); previously trivial (DOCX comment-ID save lookups); previously trivial (gap 19: RTF reads and writes WMF and EMF pictures, #4259); previously trivial (#4658 bounds nested Markdown reference-label work); previously trivial (HTML import keeps preformatted lines with CR or CRLF input newlines, #4810); previously trivial (Recipient labels continue across product-sized sheets instead of stopping after the first sheet (#4880)); previously trivial (View windows: several open documents and Switch Windows in the engine; previously trivial: explicit documents keep the editor when recovery discovery finishes; readable recovery controls; previously trivial: text mini toolbar available with the right-click menu, #2959; previously trivial: personal templates in File › New and Save as Word Template, #2852; previously trivial: tracked table/row/cell/section property changes record in WordCraft, narrowing gap 5; previously trivial: a document with many content controls saves in the time the controls take, #13; previously trivial: Format Page Numbers dialog carries Word's number formats and Continue from previous section / Start at, #1113; previously trivial: centred list labels after leading page breaks, #2964; previously trivial: fixed font inputs in four layout controls; previously trivial: a right, centre or decimal tab whose text doesn't fit, or a left tab past the right indent, goes to the next line with its text, #1840; previously trivial: Bullets and Numbering toggle off style-inherited lists at their effective level, including basedOn chains and numbered ListParagraph styles; other paragraphs and list definitions stay unchanged (related to #3459); previously trivial: Russian sorting keeps ё with е and recognises decomposed ё/й; previously trivial: #8: English dialects — en-GB, en-CA, en-AU… flag each other's spellings, #1281; previously trivial: #1: shape gradients and transparency, #1500; previously trivial: text typed into a content control takes the control's formatting; localized placeholder styles recognised; previously trivial: forms protection keeps its content controls: no inserting, Properties or Remove Content Control; previously trivial: clearing a no-match font query keeps the recent heading visible, #2068; previously trivial: line breaking: a slash opening a word travels whole to the next line, #2963; previously trivial: recipient list search and merged-only view, #1576; previously trivial: #2 impact restated: only ink rendering and OLE editing remain; previously trivial: #2 narrowed: native ink nested in groups and drawing canvases kept on save; previously trivial: opening a DOCX no longer copies its pictures; previously trivial: RTF export writes sections (gap 19); previously trivial: ODT export writes sections (gap 19); previously trivial: automatic Asian/Latin and Asian/number spacing laid out, #2358; previously trivial: hint-reliant CJK outlines; previously trivial: numbered headings, #1793; previously trivial: legacy outline, shadow, emboss and imprint text effects drawn, #2534; previously trivial: #8 narrowed: Indonesian proofing from the installed Hunspell dictionary, #498; previously trivial: glossary/building blocks closed; previously trivial: Split Cells and Convert Text to Table follow the Word check, #2592; previously trivial: Language dialog keeps inherited proofing language and no-proof choices (#2717); previously trivial: #29: a copied equation also goes in the MathML clipboard formats, #1297; previously trivial: #24: the Spike, Ctrl+F3 and Ctrl+Shift+F3; previously trivial: VML freeforms read and kept on save; previously trivial: consistent preferred cell widths; previously trivial: multi-paragraph field instructions no longer add blank lines; previously trivial: page-break-only list paragraphs hide their labels; previously trivial: floating-table overlap ignores empty line-break lines; previously trivial: copies keep their formatting on the clipboard as HTML, #1523; previously trivial: sample-text formulas on Enter, #1067; previously trivial: #29: copied equations as MathML, OMML open as #1297, #816; previously trivial: the Font list no longer keeps every previewed font in memory, #848; previously trivial: table column and row markers on the rulers, #700; previously trivial: table borders and the resize handle drag on the page, #217; previously trivial: formatting revisions landed, #41; previously trivial: Draw Table and Eraser landed, #303; previously minor: beta distance restated: ~15 points, ~150–230 h; previously: first version; every known shortfall from the 2026-10-10 re-measure, ranked) · **Target:** Microsoft Word (Microsoft 365) for Mac 16.113.4 > **Highlight update:** 2026-10-25 · Highlight shortcut toggles the last chosen colour off when the whole selection has it; explicit colour commands remain setters (#4085). Readiness estimates unchanged. > **Last reviewed:** 2026-10-10 · **Last updated:** 2026-10-29 · **Change:** trivial (aligned-copy review fixes retain the document axis through scrolling and include secondary selections (#4764)); previously trivial (#15: bibliography sources keep a corporate author, #4848); previously trivial (Table Properties applies to the selected rows, columns and cells, #4857); previously trivial (Relative font-size commands preserve mixed sizes in the selection (#4903); existing button steps and one-point shortcuts are unchanged; readiness estimates unchanged); previously trivial (Arabic Backspace removes one combining mark and keeps its base letter (#4757); previously trivial (Recipient labels continue across product-sized sheets instead of stopping after the first sheet (#4880)); previously trivial (#7: Custom Document Properties dialog, #2982; previously trivial: egui 0.37 migration: the interface catalogs stay shared and pinned by `craft-i18n.rev` at `9205108cfdced5177706264038848b68b2422d2b` (27 languages, English fallback); input-method handling has new regressions but managed CI passed, and native IME acceptance plus native-speaker catalog review remain open; previously trivial: Markdown code spans keep line-broken text literal, #3738; previously trivial: small follow-ups from the field, table and AutoFormat batch, #4232; previously trivial: highlight target includes selected paragraph marks, #4085; previously trivial: full-target highlight check beyond 10,000 runs, #4085; previously trivial: Exact-spacing table contact uses the specified line height rather than paragraph-mark metrics (#3977); previously trivial: cu20we: restrict pre-spacing float origins to paragraph anchors; document cap helpers and regressions; previously trivial: a command that changes nothing is not an edit: no undo step, no unsaved changes, no relayout, and the redo stack survives it; previously minor: #8 narrowed: Spanish proofing (Spain, Mexico, Latin America, Uruguay) from the installed Hunspell dictionaries, #3360, #3553; previously trivial: gap 10: group connector rerouting preserves transformed free and unresolved endpoints under nonuniform scaling; obstacle routing still missing; readiness estimates unchanged; previously trivial: a word with no break opportunity in it no longer makes the layout quadratic, #3412; previously trivial: the ranked gap list held two rows each for #19, #20 and #21; each gap appears once now; a document with many relationships opens in the time its part takes, #3411; previously trivial: the file commands that change the document are checked on a protected document, the protection of a protected document needs an explicit stop, the session author can't change through `file.setAuthor` under protection (the CLI's `--author` uses the same protection check), and the post-check compares the settings and the metadata; previously trivial: explicit documents keep the editor when recovery discovery finishes; readable recovery controls; previously trivial: text mini toolbar available with the right-click menu, #2959; previously trivial: personal templates in File › New and Save as Word Template, #2852; previously trivial: tracked table/row/cell/section property changes record in WordCraft, narrowing gap 5; previously trivial: a document with many content controls saves in the time the controls take, #13; previously trivial: Format Page Numbers dialog carries Word's number formats and Continue from previous section / Start at, #1113; previously trivial: centred list labels after leading page breaks, #2964; previously trivial: fixed font inputs in four layout controls; previously trivial: a right, centre or decimal tab whose text doesn't fit, or a left tab past the right indent, goes to the next line with its text, #1840; previously trivial: Bullets and Numbering toggle off style-inherited lists at their effective level, including basedOn chains and numbered ListParagraph styles; other paragraphs and list definitions stay unchanged (related to #3459); previously trivial: Russian sorting keeps ё with е and recognises decomposed ё/й; previously trivial: #8: English dialects — en-GB, en-CA, en-AU… flag each other's spellings, #1281; previously trivial: #1: shape gradients and transparency, #1500; previously trivial: text typed into a content control takes the control's formatting; localized placeholder styles recognised; previously trivial: forms protection keeps its content controls: no inserting, Properties or Remove Content Control; previously trivial: clearing a no-match font query keeps the recent heading visible, #2068; previously trivial: line breaking: a slash opening a word travels whole to the next line, #2963; previously trivial: recipient list search and merged-only view, #1576; previously trivial: #2 impact restated: only ink rendering and OLE editing remain; previously trivial: #2 narrowed: native ink nested in groups and drawing canvases kept on save; previously trivial: opening a DOCX no longer copies its pictures; previously trivial: RTF export writes sections (gap 19); previously trivial: ODT export writes sections (gap 19); previously trivial: automatic Asian/Latin and Asian/number spacing laid out, #2358; previously trivial: hint-reliant CJK outlines; previously trivial: numbered headings, #1793; previously trivial: legacy outline, shadow, emboss and imprint text effects drawn, #2534; previously trivial: #8 narrowed: Indonesian proofing from the installed Hunspell dictionary, #498; previously trivial: glossary/building blocks closed; previously trivial: Split Cells and Convert Text to Table follow the Word check, #2592; previously trivial: Language dialog keeps inherited proofing language and no-proof choices (#2717); previously trivial: #29: a copied equation also goes in the MathML clipboard formats, #1297; previously trivial: #24: the Spike, Ctrl+F3 and Ctrl+Shift+F3; previously trivial: VML freeforms read and kept on save; previously trivial: consistent preferred cell widths; previously trivial: multi-paragraph field instructions no longer add blank lines; previously trivial: page-break-only list paragraphs hide their labels; previously trivial: floating-table overlap ignores empty line-break lines; previously trivial: copies keep their formatting on the clipboard as HTML, #1523; previously trivial: sample-text formulas on Enter, #1067; previously trivial: #29: copied equations as MathML, OMML open as #1297, #816; previously trivial: the Font list no longer keeps every previewed font in memory, #848; previously trivial: table column and row markers on the rulers, #700; previously trivial: table borders and the resize handle drag on the page, #217; previously trivial: formatting revisions landed, #41; previously trivial: Draw Table and Eraser landed, #303; previously minor: beta distance restated: ~15 points, ~150–230 h; previously: first version; every known shortfall from the 2026-10-10 re-measure, ranked) · **Target:** Microsoft Word (Microsoft 365) for Mac 16.113.4 Recovery discovery no longer interrupts an explicitly created or opened document. Older copies remain in File › Recover, whose buttons use the interface palette. See [local recovery](recovery.md). @@ -141,6 +141,7 @@ Small follow-ups from the 2026-10-25 field, table and AutoFormat batch (#4232): - AutoFormat's `*bold*` and `_italic_` don't convert when a closing bracket or quote follows the closing mark (`(*see note*)`): the trigger checks only space and `,.;:!?` (#4098). - The ribbon's Accept and Reject buttons only open their menus; Word's main half runs Accept (Reject) and Move to Next. The ribbon needs a big split button (Paste needs one too) (#4205). +Ink replay, eraser picking, lasso selection and arrow-candidate discovery reuse the paragraph prefixes they have already scanned (#3614). Page item order, stroke geometry and saved data retain their behavior. This narrows the stability work; ink import fidelity, native pen input and broader corpus qualification remain open. Recipient label generation (#4880) now includes all selected recipients across as many sheets as needed, retaining filtered/sorted order and the chosen product geometry. This fixes the one-sheet omission; Update Labels and Finish & Merge template behavior remain separate, and gap 21 remains open. Readiness estimates are unchanged. File > Print offers 2, 4, 6, 9 or 16 logical pages per physical sheet side and left/right-bound booklets (#641). Preview and print PDF share the sheet plan, selected pages, parity, copy padding and markup geometry. Custom-range changes reset the preview to the first sheet; Print Markup invalidates preview layout and textures. Native jobs omit link annotations as required by upstream #4734, while saved print PDFs keep their remapped links. Native printing submits copies to the spooler without multiplying them in the PDF. Ordinary PDF export remains single-page by default. Translations are reviewed separately in craft-i18n#38. Physical-printer qualification and driver-specific options remain unverified. @@ -161,6 +162,7 @@ Table rows and cells inside `mc:AlternateContent` use the same selected-branch p | Date | Change | Summary | |---|---|---| +| 2026-10-28 | trivial | Ink page lookups reuse scanned paragraph prefixes, #3614. Drawing order, geometry and saved data retain their behavior; no readiness estimate change | | 2026-11-04 | trivial | #19: ODT settings for what the standard leaves open removed: one choice for each case | | 2026-11-04 | trivial | #19: ODT element audit; files from other applications checked | | 2026-11-01 | trivial | #19 narrowed: ODT read and written nearly whole on this branch (styles, tables, notes, comments, tracked changes including formatting, fields, indexes and marks, drawings, charts, embedded objects, forms, ruby, password protection, flat ODT), checked against LibreOffice; what's left listed; estimate 18–27 h → 10–16 h | diff --git a/docs/hardware-parity.md b/docs/hardware-parity.md index 665e10f664..364bb90fe2 100644 --- a/docs/hardware-parity.md +++ b/docs/hardware-parity.md @@ -1,6 +1,6 @@ # Hardware parity with Microsoft Word -> **Last reviewed:** 2026-10-12 · **Last updated:** 2026-11-01 · **Change:** trivial (only the PDF sent to the printer has no link annotations; Save these pages as PDF keeps them, #4734); previously trivial (a document with links prints: the print job's PDF has no link annotations, #4734; previously trivial: Pen / stylus row: two-stroke and closed-head arrows; previously trivial: Pen / stylus row: ink, eraser and Ink to Shape incl. arrows landed; previously trivial: a window too big for its screen shrinks to fit when it opens, #1215; previously trivial: 32-bit Windows starts on OpenGL; previously major: first version) · **Target:** Microsoft Word (Microsoft 365) for Mac 16.113.4 and Word for Windows +> **Last reviewed:** 2026-10-12 · **Last updated:** 2026-11-01 · **Change:** trivial (ink page lookup work, #3614); previously trivial (only the PDF sent to the printer has no link annotations; Save these pages as PDF keeps them, #4734); previously trivial (a document with links prints: the print job's PDF has no link annotations, #4734; previously trivial: Pen / stylus row: two-stroke and closed-head arrows; previously trivial: Pen / stylus row: ink, eraser and Ink to Shape incl. arrows landed; previously trivial: a window too big for its screen shrinks to fit when it opens, #1215; previously trivial: 32-bit Windows starts on OpenGL; previously major: first version) · **Target:** Microsoft Word (Microsoft 365) for Mac 16.113.4 and Word for Windows > **Printing update:** 2026-10-12 · direct desktop printing through craft-print; details below. @@ -21,12 +21,14 @@ pens, microphones (Dictate) and speakers (Read Aloud), and displays. | Touch screens and touchpads: pinch zoom, inertial scroll | ✅ | ✅ pinch (#179) | ✅ | ✅ inertial scroll (#252) | ✅ | 85% | 0–1 | | Scanners/cameras (Insert from device / Continuity Camera on Mac) | ✅ | ❌ | ❌ | ❌ | ❌ | 0% | 2–4 | +Ink replay, eraser picking, lasso selection and arrow-candidate discovery reuse the paragraph prefixes they have already scanned (#3614). Page item order, stroke geometry and saved data retain their behavior. This narrows the stability work; ink import fidelity, native pen input and broader corpus qualification remain open. File > Print offers 2, 4, 6, 9 or 16 logical pages per physical sheet side and left/right-bound booklets (#641). Preview and print PDF share the sheet plan, selected pages, parity, copy padding and markup geometry. Custom-range changes reset the preview to the first sheet; Print Markup invalidates preview layout and textures. Native jobs omit link annotations as required by upstream #4734, while saved print PDFs keep their remapped links. Native printing submits copies to the spooler without multiplying them in the PDF. Ordinary PDF export remains single-page by default. Translations are reviewed separately in craft-i18n#38. Physical-printer qualification and driver-specific options remain unverified. ## Revision history | Date | Change | Summary | |---|---|---| +| 2026-10-28 | trivial | Ink page lookup work, #3614. Drawing order, geometry and saved data retain their behavior; no readiness estimate change | | 2026-11-01 | trivial | N-up and booklet print imposition (#641): integrate current print-job link handling (#4734), preserve markup preview and sheet/copy planning; readiness estimates unchanged. | | 2026-10-30 | trivial | Only the PDF sent to the printer leaves out link annotations; Save these pages as PDF (`file.printPdf`) keeps them (#4734) | | 2026-10-29 | trivial | A document with links prints: the print job's PDF leaves out link annotations, which the spooler refused to fit to the paper (#4734) | From 7ac4a838c65cce24ff325ac09a5aaad2860d32d9 Mon Sep 17 00:00:00 2001 From: Joseph Anglada Date: Thu, 5 Nov 2026 04:13:42 -0400 Subject: [PATCH 03/34] Mini toolbar: hovering a formatting button previews it on the selection (#4732) * Mini toolbar: hovering a formatting button previews it on the selection (#4664) Co-Authored-By: Claude Sonnet 5.5 * Keep mini toolbar stable during alignment preview * Track live mini toolbar anchor during preview * Mini toolbar: hovering a font, size, highlight or font colour previews it (#4664) Co-Authored-By: Claude Sonnet 5.5 * Mini toolbar preview: the page holds its scroll position (#4664) Co-Authored-By: Claude Sonnet 5.5 * Mini toolbar: hovering the highlight and font colour buttons previews their colour (#4664) Co-Authored-By: Claude Sonnet 5.5 * Mini toolbar: the font list and colour menus mark the choice in effect (#4664) Co-Authored-By: Claude Sonnet 5.5 * Skip hover previews in context toolbar * Pass preview mode in toolbar test * Font list: a picked family keeps its place until the list next opens (#4664) Co-Authored-By: Claude Sonnet 5.5 * Font and size lists close when an entry is picked (#4664) Co-Authored-By: Claude Sonnet 5.5 * Mini toolbar: a clicked button holds its preview until the pointer leaves (#4664) Co-Authored-By: Claude Sonnet 5.5 * Mini toolbar: a button already on does not preview (#4664) Co-Authored-By: Claude Sonnet 5.5 * Alignment buttons follow the paragraph a selection covers; a toggle previews its undo on return (#4664) Co-Authored-By: Claude Sonnet 5.5 * Font list: a recent family is marked as chosen in Recently Used Fonts only (#4664) Co-Authored-By: Claude Sonnet 5.5 --------- Co-authored-by: Claude Sonnet 5.5 Co-authored-by: Fluorine --- crates/engine/src/cmd/para.rs | 2 +- crates/engine/src/cmd/para/format.rs | 5 +- crates/ui-egui/src/canvas.rs | 64 ++++- crates/ui-egui/src/canvas/pages.rs | 9 +- crates/ui-egui/src/mini_toolbar.rs | 137 ++++++++--- crates/ui-egui/src/mini_toolbar/tests.rs | 290 ++++++++++++++++++++++- crates/ui-egui/src/ribbon/home.rs | 2 +- crates/ui-egui/src/ribbon/layout.rs | 2 +- crates/ui-egui/src/widgets.rs | 2 +- crates/ui-egui/src/widgets/buttons.rs | 5 +- crates/ui-egui/src/widgets/combo.rs | 123 +++++++++- docs/ui-parity.md | 3 + 12 files changed, 582 insertions(+), 62 deletions(-) diff --git a/crates/engine/src/cmd/para.rs b/crates/engine/src/cmd/para.rs index 264c44dd86..2941925c5f 100644 --- a/crates/engine/src/cmd/para.rs +++ b/crates/engine/src/cmd/para.rs @@ -18,7 +18,7 @@ mod styles; mod tabs_borders; use format::{align, asian_typography, cur, direction, line_spacing, ls, set_align, set_props, tog}; -pub use format::{fmt, indent, outdent}; +pub use format::{cur as selection_para, fmt, indent, outdent}; pub use lists::{ListButtons, list_buttons, manage_list, touch_all}; use lists::{list, restart_numbering}; pub(crate) use outline::{ensure_heading_style, set_heading}; diff --git a/crates/engine/src/cmd/para/format.rs b/crates/engine/src/cmd/para/format.rs index 86b773e104..7d83e1f79b 100644 --- a/crates/engine/src/cmd/para/format.rs +++ b/crates/engine/src/cmd/para/format.rs @@ -1,7 +1,8 @@ use super::{Align, CmdError, CmdResult, LineSpacing, NumRef, ParaProps, Pos, Session, Value, json, p, sel_result}; -/// Resolved paragraph props at the caret. -pub(super) fn cur(s: &Session) -> wordcraft_doc::resolve::ResolvedPara { +/// Resolved paragraph props of the selection: those of the paragraph the caret is in, or of the +/// last paragraph a selection covers when it ends at the next paragraph's start. +pub fn cur(s: &Session) -> wordcraft_doc::resolve::ResolvedPara { // A selection ending at the next paragraph's start doesn't format that paragraph (#418), so // its state comes from the last paragraph it does cover. let (a, b) = s.sel.ordered(); diff --git a/crates/ui-egui/src/canvas.rs b/crates/ui-egui/src/canvas.rs index 6e179210e7..ae5fb46e3d 100644 --- a/crates/ui-egui/src/canvas.rs +++ b/crates/ui-egui/src/canvas.rs @@ -272,15 +272,23 @@ pub struct CanvasState { /// The rows and columns hovered in Insert › Table's grid this frame: the page shows that /// table where it would go (#3931). Set by the grid each frame, taken by [`show`]. pub(crate) table_preview: Option<(usize, usize)>, + /// A command (id, params) the page shows run on the selection, without running it: the + /// formatting button the floating mini toolbar is hovered over. Set each frame, taken by [`show`]. + pub(crate) command_preview: Option<(String, serde_json::Value)>, + /// The command preview the page last drew, so the bar repaints only when its hover changes. + pub(crate) command_previewed: Option<(String, serde_json::Value)>, + /// The scroll offset held while a command preview is shown, so the page does not move as + /// the previewed text reflows. + pub(crate) preview_scroll: Option, /// The last previewed table's layout, the copy of the document it was laid out from and the /// copy's selection, with - /// what it was laid out for (rows, columns, document id, revision, selection, and the + /// what it was laid out for (command, params, document id, revision, selection, and the /// document's own layout, which a view change replaces), so a still pointer doesn't lay the /// document out every frame. Set only while the page shows the preview. table_preview_layout: Option<(TablePreviewKey, wordcraft_doc::Document, wordcraft_engine::Selection, std::sync::Arc)>, } -type TablePreviewKey = ((usize, usize, u64, u64, wordcraft_engine::Selection), std::sync::Arc); +type TablePreviewKey = ((String, serde_json::Value, u64, u64, wordcraft_engine::Selection), std::sync::Arc); impl CanvasState { /// Another document is shown in the window: everything about the page that was shown (drags, @@ -425,6 +433,9 @@ impl Default for CanvasState { tab_drag: None, drawn_ibeam: crate::ibeam::DRAWN, table_preview: None, + command_preview: None, + command_previewed: None, + preview_scroll: None, table_preview_layout: None, } } @@ -1307,12 +1318,53 @@ fn finish_canvas_frame(finish: CanvasFinish<'_>, out: egui::scroll_area::ScrollA /// Lays out and paints the document pages for print, Read and Web views, settles viewports, draw /// rulers and overlays, anchors zoom and scrolling, and routes pointer, selection, IME and caret /// input. +/// While the page shows a command preview the view stays where it was when the preview began: +/// no scrolling to the caret, and the offset is held against the previewed text's reflow. +fn hold_scroll_for_preview(app: &mut WordApp) -> bool { + if app.canvas.command_previewed.is_none() { + app.canvas.preview_scroll = None; + return false; + } + let at = *app.canvas.preview_scroll.get_or_insert(app.canvas.scroll_offset); + app.canvas.scroll_request = Some(at); + true +} + +/// The live selection's rects on screen, from the document's own layout rather than a command +/// preview's, which can move the lines (Align Right) from under the mini toolbar's pointer. +fn live_selection_screen_rects(app: &mut WordApp, rects: &[Rect], scale: f32) -> Vec { + let layout = app.session.layout(); + let selected: Vec<_> = if crate::objects::selected(app).is_some() { + Vec::new() + } else if let Some(range) = app.session.cell_range() { + wordcraft_engine::cmd::table_mouse::cell_rects(&layout, &app.session.doc, range) + } else if !app.session.sel.is_collapsed() { + match app.session.column_segments() { + Some(segs) => segs.iter().flat_map(|(a, b)| layout.selection_rects(&app.session.doc, a, b, app.session.page_hint)).collect(), + None => { + let (a, b) = app.session.sel.ordered(); + wordcraft_engine::cmd::table_mouse::selection_rects(&layout, &app.session.doc, &a, &b, app.session.page_hint) + } + } + } else { + Vec::new() + }; + selected + .into_iter() + .filter_map(|(pi, r)| { + let pr = rects.get(pi)?; + let scale = layout.pages.get(pi).map_or(scale, |page| page_screen_scale(*pr, page, scale)); + Some(Rect::from_min_size(pos2(pr.min.x + r.x * scale, pr.min.y + r.y * scale), vec2(r.w * scale, r.h * scale))) + }) + .collect() +} + pub fn show(app: &mut WordApp, ui: &mut Ui) { let t = Tokens::get(ui.ctx()); let full = ui.available_rect_before_wrap(); let layout = prepare_layout(app, ui, full); let view = prepare_view(app, ui, full, &layout); - let scroll_target = update_caret_scroll(app, &view); + let scroll_target = if hold_scroll_for_preview(app) { None } else { update_caret_scroll(app, &view) }; let motion = scroll_motion(app, ui, full, &view); let scroll_area = configure_scroll_area(app, ui, &view, motion); let CanvasView { area, hruler, vruler, paper, geo, dim_body, grid_story, caret, .. } = view; @@ -1429,7 +1481,11 @@ pub fn show(app: &mut WordApp, ui: &mut Ui) { // Anchor only to visible selection geometry. A selection can span pages, and its // document-first line may be scrolled offscreen; using it would pin the toolbar to an // old screen position unrelated to the visible selection. - app.canvas.mini_anchor = crate::mini_toolbar::visible_anchor(screen_rects, visible_clip); + // Alignment previews can move the selected text while the pointer is still over a mini + // toolbar button. Keep the bar anchored to the live selection until the preview ends, or + // it can move out from under the pointer and flicker between preview and live layouts. + let anchor_rects = if app.canvas.command_previewed.is_some() { live_selection_screen_rects(app, &rects, geo.scale) } else { screen_rects }; + app.canvas.mini_anchor = crate::mini_toolbar::visible_anchor(anchor_rects, visible_clip); // Content controls: the frame of the one the caret is in (all of them in Design Mode). crate::content_controls::paint(app, &painter, &t, &layout, &rects, geo.scale); paint_read_aloud_highlight(app, &painter, &layout, &rects, &geo, &t); diff --git a/crates/ui-egui/src/canvas/pages.rs b/crates/ui-egui/src/canvas/pages.rs index eb07068ace..544ba0e19f 100644 --- a/crates/ui-egui/src/canvas/pages.rs +++ b/crates/ui-egui/src/canvas/pages.rs @@ -184,20 +184,23 @@ pub(super) fn drawing_grid_step(spacing: f32, scale: f32) -> f32 { /// hovering over (#3931). The preview is laid out on a copy, so the document and its undo history /// change only when a square is clicked. pub(super) fn shown_layout(app: &mut WordApp) -> std::sync::Arc { - let Some((rows, cols)) = app.canvas.table_preview.take() else { + let table = app.canvas.table_preview.take().map(|(rows, cols)| ("insert.table".to_string(), json!({"rows": rows, "cols": cols}))); + let command = app.canvas.command_preview.take(); + app.canvas.command_previewed = command.clone().filter(|_| table.is_none()); + let Some((id, params)) = table.or(command) else { app.canvas.table_preview_layout = None; return app.session.layout(); }; // The caret can move, or the view change, with the grid still hovered: the table then goes // somewhere else, or the page is laid out to another width. - let key = ((rows, cols, app.session.document_id(), app.session.rev(), app.session.sel.clone()), app.session.layout()); + let key = ((id.clone(), params.clone(), app.session.document_id(), app.session.rev(), app.session.sel.clone()), app.session.layout()); if let Some((k, _, _, l)) = &app.canvas.table_preview_layout && k.0 == key.0 && std::sync::Arc::ptr_eq(&k.1, &key.1) { return l.clone(); } - match app.session.preview_layout("insert.table", &json!({"rows": rows, "cols": cols})) { + match app.session.preview_layout(&id, ¶ms) { Some((doc, sel, l)) => { app.canvas.table_preview_layout = Some((key, doc, sel, l.clone())); l diff --git a/crates/ui-egui/src/mini_toolbar.rs b/crates/ui-egui/src/mini_toolbar.rs index 400e027135..5585738eb7 100644 --- a/crates/ui-egui/src/mini_toolbar.rs +++ b/crates/ui-egui/src/mini_toolbar.rs @@ -165,6 +165,9 @@ pub fn track_dismissal(app: &mut WordApp, ctx: &egui::Context, viewport: Rect) { /// canvas area it must stay inside. pub fn show(app: &mut WordApp, ctx: &egui::Context, selection: Rect, viewport: Rect) { if !visible(app) { + if app.canvas.command_previewed.is_some() { + ctx.request_repaint(); + } return; } let Some(bar) = anchor_rect(selection.min.y, selection.min.x, viewport) else { return }; @@ -192,7 +195,11 @@ pub fn show(app: &mut WordApp, ctx: &egui::Context, selection: Rect, viewport: R let inner = bar.shrink2(Vec2::new(PAD_X, PAD_Y)); let mut child = ui.new_child(egui::UiBuilder::new().max_rect(inner).layout(Layout::top_down(Align::Min))); child.spacing_mut().item_spacing = Vec2::new(SPACING, ROW_GAP); - content(app, &mut child, &t); + content(app, &mut child, &t, true); + // The page was drawn before the bar this frame: another frame shows or clears the preview. + if app.canvas.command_preview != app.canvas.command_previewed { + ctx.request_repaint(); + } let used = child.min_rect(); ctx.data_mut(|d| d.insert_temp(shown_id(), [bar, used])); }); @@ -219,7 +226,7 @@ pub fn show_in_context_menu(app: &mut WordApp, ui: &mut egui::Ui) { ui.set_style(ui.ctx().global_style()); ui.set_width(ROW2_W); ui.spacing_mut().item_spacing = Vec2::new(SPACING, ROW_GAP); - content(app, ui, &t); + content(app, ui, &t, false); if app.dialog.is_some() || app.colors.is_some() { ui.close(); } @@ -229,7 +236,7 @@ pub fn show_in_context_menu(app: &mut WordApp, ui: &mut egui::Ui) { /// The controls in two rows like Word's mini toolbar, reusing the ribbon's widgets so the bar /// matches the ribbon exactly. -fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens) { +fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens, preview_on_hover: bool) { let st: Value = app.session.run("format.state", &json!({})).unwrap_or_default(); let flag = |k: &str| st.get(k).and_then(Value::as_bool).unwrap_or(false); // As on the ribbon, the buttons show alignment as seen on the page (#3579). @@ -237,8 +244,8 @@ fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens) { .session .doc .para_at(&app.session.sel.focus) - .map(|p| { - let r = app.session.doc.styles.resolve_para(&p.props); + .map(|_| { + let r = wordcraft_engine::cmd::para::selection_para(&app.session); r.align.visual(r.bidi) }) .unwrap_or_default(); @@ -256,6 +263,7 @@ fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens) { let fams = app.previews.families(); let recent: Vec = app.ui.recent_fonts.iter().map(|f| app.previews.font_shown(f)).collect(); let prev = app.previews.font_preview_fn(); + let _ = widgets::take_hover(ui.ctx()); let options = widgets::FontComboOptions { id: "mini_font", width: COMBO_FONT_W, @@ -266,7 +274,16 @@ fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens) { tip: tl!("Font"), shown_as: warning.as_deref(), }; - if let Some(f) = widgets::font_combo_with_recent_hint(ui, options) { + let picked = widgets::font_combo_with_recent_hint(ui, options); + if preview_on_hover + && picked.is_none() + && let Some(f) = widgets::take_hover(ui.ctx()) + && f != crate::widgets::ADD_FONT + && f != crate::widgets::LOAD_SYSTEM_FONTS + { + app.canvas.command_preview = Some(("format.font".to_string(), json!({"name": app.previews.font_stored(&f)}))); + } + if let Some(f) = picked { let _ = if f == crate::widgets::ADD_FONT { app.run("font.add", json!({})) } else if f == crate::widgets::LOAD_SYSTEM_FONTS { @@ -280,33 +297,34 @@ fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens) { st.get("size").and_then(Value::as_f64).map(|s| if s.fract() == 0.0 { format!("{s:.0}") } else { s.to_string() }).unwrap_or_default(); let sizes: Vec = wordcraft_engine::cmd::format::SIZES.iter().map(|s| if s.fract() == 0.0 { format!("{s:.0}") } else { s.to_string() }).collect(); - if let Some(v) = widgets::combo_hint(ui, "mini_size", COMBO_SIZE_W, &size, &sizes, None, tl!("Font Size")) + let _ = widgets::take_hover(ui.ctx()); + let picked = widgets::combo_hint(ui, "mini_size", COMBO_SIZE_W, &size, &sizes, None, tl!("Font Size")); + if preview_on_hover + && picked.is_none() + && let Some(x) = widgets::take_hover(ui.ctx()).and_then(|v| v.trim().parse::().ok()) + { + app.canvas.command_preview = Some(("format.size".to_string(), json!({"size": x}))); + } + if let Some(v) = picked && let Ok(x) = v.trim().parse::() { let _ = app.run("format.size", json!({"size": x})); } ui.add_space(GAP); - widgets::small(ui, app, "grow", None, "Increase Font Size", crate::widgets::ButtonAction::new("format.growFont", json!({}), false)); - widgets::small(ui, app, "shrink", None, "Decrease Font Size", crate::widgets::ButtonAction::new("format.shrinkFont", json!({}), false)); + hover_small(ui, app, "grow", "Increase Font Size", "format.growFont", false, preview_on_hover); + hover_small(ui, app, "shrink", "Decrease Font Size", "format.shrinkFont", false, preview_on_hover); }); row(ui, app, &|ui, app| { - widgets::small(ui, app, "bold", None, "Bold", crate::widgets::ButtonAction::new("format.bold", json!({}), flag("bold"))); - widgets::small(ui, app, "italic", None, "Italic", crate::widgets::ButtonAction::new("format.italic", json!({}), flag("italic"))); - widgets::small(ui, app, "underline", None, "Underline", crate::widgets::ButtonAction::new("format.underline", json!({}), flag("underline"))); - widgets::small( - ui, - app, - "strike", - None, - "Strikethrough", - crate::widgets::ButtonAction::new("format.strikethrough", json!({}), flag("strike")), - ); + hover_small(ui, app, "bold", "Bold", "format.bold", flag("bold"), preview_on_hover); + hover_small(ui, app, "italic", "Italic", "format.italic", flag("italic"), preview_on_hover); + hover_small(ui, app, "underline", "Underline", "format.underline", flag("underline"), preview_on_hover); + hover_small(ui, app, "strike", "Strikethrough", "format.strikethrough", flag("strike"), preview_on_hover); sep(ui, t); let hl = app.canvas.last_highlight.clone(); let (icon, sw, color) = highlight_button_appearance(&hl); - widgets::split( + let main = widgets::split( ui, app, icon, @@ -314,12 +332,20 @@ fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens) { crate::widgets::ButtonAction::new("format.highlight", json!({"color": color}), false), sw, |ui, app| { + let _ = widgets::take_hover(ui.ctx()); + let in_effect = st.get("highlight").and_then(Value::as_str).unwrap_or("none").to_string(); + widgets::set_current_pick(ui.ctx(), Some(in_effect)); highlight_menu(ui, app); + widgets::set_current_pick(ui.ctx(), None); + if preview_on_hover && let Some(c) = widgets::take_hover(ui.ctx()) { + app.canvas.command_preview = Some(("format.highlight".to_string(), json!({"color": c}))); + } }, ); + preview_on_hover_if(app, &main, "format.highlight", json!({"color": color}), preview_on_hover); let fc = app.canvas.last_font_color.clone(); let sw = wordcraft_doc::Rgb::parse(&fc).map(crate::theme::c32); - widgets::split( + let main = widgets::split( ui, app, "fontcolor", @@ -327,26 +353,50 @@ fn content(app: &mut WordApp, ui: &mut egui::Ui, t: &Tokens) { crate::widgets::ButtonAction::new("format.color", json!({"color": fc}), false), sw, |ui, app| { + let _ = widgets::take_hover(ui.ctx()); + widgets::set_current_pick(ui.ctx(), st.get("color").and_then(Value::as_str).map(str::to_string)); font_color_menu(ui, app); + widgets::set_current_pick(ui.ctx(), None); + if preview_on_hover && let Some(c) = widgets::take_hover(ui.ctx()) { + app.canvas.command_preview = Some(("format.color".to_string(), json!({"color": c}))); + } }, ); + preview_on_hover_if(app, &main, "format.color", json!({"color": fc}), preview_on_hover); sep(ui, t); use wordcraft_doc::Align as A; - widgets::small(ui, app, "alignLeft", None, "Align Left", crate::widgets::ButtonAction::new("para.alignLeft", json!({}), align == A::Left)); - widgets::small(ui, app, "alignCenter", None, "Center", crate::widgets::ButtonAction::new("para.alignCenter", json!({}), align == A::Center)); - widgets::small( - ui, - app, - "alignRight", - None, - "Align Right", - crate::widgets::ButtonAction::new("para.alignRight", json!({}), align == A::Right), - ); - widgets::small(ui, app, "justify", None, "Justify", crate::widgets::ButtonAction::new("para.justify", json!({}), align == A::Justify)); + hover_small(ui, app, "alignLeft", "Align Left", "para.alignLeft", align == A::Left, preview_on_hover); + hover_small(ui, app, "alignCenter", "Center", "para.alignCenter", align == A::Center, preview_on_hover); + hover_small(ui, app, "alignRight", "Align Right", "para.alignRight", align == A::Right, preview_on_hover); + hover_small(ui, app, "justify", "Justify", "para.justify", align == A::Justify, preview_on_hover); }); } +/// A bar button that, while hovered, makes the page show its command run on the selection. The +/// preview runs on a copy, so the document, its undo history and the selection stay as they are. +fn hover_small(ui: &mut egui::Ui, app: &mut WordApp, icon: &str, tip: &str, id: &str, checked: bool, preview: bool) { + let action = crate::widgets::ButtonAction::new(id, json!({}), checked); + let r = widgets::small(ui, app, icon, None, tip, action); + preview_on_hover_if(app, &r, id, json!({}), preview); +} + +/// Previews command `id` with `params` while its button `r` is hovered and not pressed. After a +/// click the preview stays off until the pointer leaves the button: a toggle would otherwise +/// preview its other state under the pointer and look as if it flashed. +fn preview_on_hover_if(app: &mut WordApp, r: &egui::Response, id: &str, params: Value, preview: bool) { + let hold = r.id.with("hold_preview"); + if r.clicked() { + r.ctx.data_mut(|d| d.insert_temp(hold, true)); + } else if !r.hovered() { + r.ctx.data_mut(|d| d.remove::(hold)); + } + let held = r.ctx.data(|d| d.get_temp::(hold)).unwrap_or(false); + if preview && !held && r.hovered() && !r.is_pointer_button_down_on() && !r.clicked() && widgets::enabled(app, id) { + app.canvas.command_preview = Some((id.to_string(), params)); + } +} + /// A hairline divider between the bar's groups. fn sep(ui: &mut egui::Ui, t: &Tokens) { let (r, _) = ui.allocate_exact_size(Vec2::new(SEP_W, 20.0), Sense::hover()); @@ -370,6 +420,13 @@ pub(crate) fn highlight_menu(ui: &mut egui::Ui, app: &mut WordApp) { let Some(c) = h.rgb() else { continue }; let (r, resp) = ui.allocate_exact_size(Vec2::new(18.0, 18.0), Sense::click()); ui.painter().rect_filled(r, 2.0, egui::Color32::from_rgb(c.0, c.1, c.2)); + if resp.hovered() { + widgets::note_hover(ui.ctx(), h.ooxml().to_string()); + } + if widgets::current_pick(ui.ctx()).is_some_and(|cur| cur.eq_ignore_ascii_case(&c.hex())) { + let accent = Tokens::get(ui.ctx()).accent; + ui.painter().rect_stroke(r.expand(1.0), 2.0, egui::Stroke::new(2.0, accent), egui::StrokeKind::Outside); + } if resp.on_hover_text(tl!(h.name())).clicked() { app.canvas.last_highlight = h.ooxml().to_string(); widgets::run_from_ribbon(app, "format.highlight", json!({"color": h.ooxml()})); @@ -381,7 +438,12 @@ pub(crate) fn highlight_menu(ui: &mut egui::Ui, app: &mut WordApp) { } }); let enabled = widgets::enabled(app, "format.highlight"); - if ui.add_enabled(enabled, egui::Button::new(tl!("No Color")).min_size(Vec2::new(200.0, 0.0))).clicked() { + let none_in_effect = widgets::current_pick(ui.ctx()).is_some_and(|cur| cur == "none"); + let no_color = ui.add_enabled(enabled, egui::Button::new(tl!("No Color")).selected(none_in_effect).min_size(Vec2::new(200.0, 0.0))); + if no_color.hovered() { + widgets::note_hover(ui.ctx(), "none".to_string()); + } + if no_color.clicked() { app.canvas.last_highlight = "none".into(); widgets::run_from_ribbon(app, "format.highlight", json!({"color": "none"})); ui.close(); @@ -391,7 +453,12 @@ pub(crate) fn highlight_menu(ui: &mut egui::Ui, app: &mut WordApp) { /// Font colour: Automatic, the colour grid, Recent Colors and More Colors… (#606). fn font_color_menu(ui: &mut egui::Ui, app: &mut WordApp) { egui::ScrollArea::vertical().max_height(280.0).show(ui, |ui| { - if ui.selectable_label(false, "Automatic").clicked() { + let auto_in_effect = widgets::current_pick(ui.ctx()).is_some_and(|cur| cur == "auto"); + let automatic = ui.selectable_label(auto_in_effect, "Automatic"); + if automatic.hovered() { + widgets::note_hover(ui.ctx(), "auto".to_string()); + } + if automatic.clicked() { widgets::run_from_ribbon(app, "format.color", json!({"color": "auto"})); ui.close(); return; diff --git a/crates/ui-egui/src/mini_toolbar/tests.rs b/crates/ui-egui/src/mini_toolbar/tests.rs index 6c8ef4240d..4a5d6b8c48 100644 --- a/crates/ui-egui/src/mini_toolbar/tests.rs +++ b/crates/ui-egui/src/mini_toolbar/tests.rs @@ -198,6 +198,211 @@ fn format_state(h: &mut egui_kittest::Harness<'static, WordApp>) -> Value { h.state_mut().session.run("format.state", &json!({})).unwrap() } +/// Hovering an entry of the bar's size list previews that size; the pick is not made. +#[test] +fn hovering_a_size_in_the_bars_list_previews_it() { + use egui::accesskit::Role; + use egui_kittest::kittest::Queryable; + let mut h = bar_over("brown fox"); + let (doc, size) = (h.state().session.doc.clone(), format_state(&mut h).get("size").cloned()); + let viewport = h.state().canvas.viewport.unwrap(); + let size_box = h + .get_all_by_role(Role::TextInput) + .map(|n| n.rect()) + .filter(|r| viewport.contains_rect(*r)) + .max_by(|a, b| a.min.x.total_cmp(&b.min.x)) + .expect("the bar has a size box"); + click_at(&mut h, pos2(size_box.max.x + 8.0, size_box.center().y)); + let twenty = h.get_by_label("20").rect().center(); + h.event(egui::Event::PointerMoved(twenty)); + steps(&mut h); + assert_eq!(h.state().canvas.command_previewed, Some(("format.size".to_string(), json!({"size": 20.0})))); + assert_ne!(crate::canvas::page_doc(h.state()), &doc, "the page shows the 20 pt text"); + assert_eq!(&h.state().session.doc, &doc); + assert_eq!(format_state(&mut h).get("size").cloned(), size); +} + +/// Hovering a family of the bar's font list previews it; clicking it applies it. +#[test] +fn hovering_and_clicking_a_font_in_the_bars_list() { + use egui::accesskit::Role; + use egui_kittest::kittest::Queryable; + let mut h = bar_over("brown fox"); + let doc = h.state().session.doc.clone(); + let viewport = h.state().canvas.viewport.unwrap(); + let font_box = h + .get_all_by_role(Role::TextInput) + .map(|n| n.rect()) + .filter(|r| viewport.contains_rect(*r)) + .min_by(|a, b| a.min.y.total_cmp(&b.min.y).then(a.min.x.total_cmp(&b.min.x))) + .expect("the bar has a font box"); + click_at(&mut h, pos2(font_box.max.x + 8.0, font_box.center().y)); + let family = h.state_mut().previews.families().into_iter().find(|f| f != "Aptos Display" && f != "Aptos").expect("another family is installed"); + let at = h.get_all_by_label(&family).map(|n| n.rect().center()).find(|p| p.y > font_box.max.y).expect("the list shows the family"); + h.event(egui::Event::PointerMoved(at)); + steps(&mut h); + let previewed = h.state().canvas.command_previewed.clone(); + assert!(previewed.is_some_and(|(id, _)| id == "format.font"), "hovering a family previews the font"); + assert_eq!(&h.state().session.doc, &doc); + click_at(&mut h, at); + assert_ne!(&h.state().session.doc, &doc, "clicking the family applies the font"); +} + +/// A picked family joins Recently Used Fonts when the list next opens, not in the frame after the +/// pick, when the list is still on screen and would shift under the pointer. +#[test] +fn a_picked_font_joins_the_recent_section_on_the_next_open() { + use egui::accesskit::Role; + use egui_kittest::kittest::Queryable; + let mut h = bar_over("brown fox"); + let viewport = h.state().canvas.viewport.unwrap(); + let font_box = h + .get_all_by_role(Role::TextInput) + .map(|n| n.rect()) + .filter(|r| viewport.contains_rect(*r)) + .min_by(|a, b| a.min.y.total_cmp(&b.min.y).then(a.min.x.total_cmp(&b.min.x))) + .expect("the bar has a font box"); + let arrow = pos2(font_box.max.x + 8.0, font_box.center().y); + click_at(&mut h, arrow); + let family = h.state_mut().previews.families().into_iter().find(|f| f != "Aptos Display" && f != "Aptos").expect("another family is installed"); + let at = h.get_all_by_label(&family).map(|n| n.rect().center()).find(|p| p.y > font_box.max.y).expect("the list shows the family"); + h.event(egui::Event::PointerMoved(at)); + h.event(egui::Event::PointerButton { pos: at, button: egui::PointerButton::Primary, pressed: true, modifiers: Default::default() }); + h.event(egui::Event::PointerButton { pos: at, button: egui::PointerButton::Primary, pressed: false, modifiers: Default::default() }); + h.step(); + h.step(); + h.step(); + assert_eq!(h.query_all_by_label("Recently Used Fonts").count(), 0, "the list does not shift under the pointer"); + assert_eq!(h.query_all_by_label("Add Font…").count(), 0, "picking a family closes the list"); + steps(&mut h); + click_at(&mut h, arrow); + assert_eq!(h.query_all_by_label("Recently Used Fonts").count(), 1, "the next open lists the family first"); +} + +/// Hovering the highlight and font colour buttons previews their last colour. +#[test] +fn hovering_the_colour_buttons_previews_their_colour() { + use egui_kittest::kittest::Queryable; + let mut h = bar_over("brown fox"); + let viewport = h.state().canvas.viewport.unwrap(); + for (label, id) in [("Text Highlight Color", "format.highlight"), ("Font Color", "format.color")] { + let r = h.get_all_by_label(label).map(|n| n.rect()).find(|r| viewport.contains_rect(*r)).expect("the bar has the button"); + h.event(egui::Event::PointerMoved(r.center())); + steps(&mut h); + let previewed = h.state().canvas.command_previewed.clone(); + assert!(previewed.is_some_and(|(p, _)| p == id), "{label} previews {id}"); + } +} + +/// Hovering a colour of the bar's highlight list previews it on the selection. +#[test] +fn hovering_a_highlight_colour_previews_it() { + use egui_kittest::kittest::{By, Queryable}; + let mut h = bar_over("brown fox"); + let doc = h.state().session.doc.clone(); + let [bar, _] = h.ctx.data(|d| d.get_temp::<[Rect; 2]>(shown_id())).expect("the bar is shown over a selection"); + let arrow = h + .query_all(By::new().predicate(|n| n.raw_bounds().is_some_and(|r| ((r.x1 - r.x0) - 11.0).abs() < 0.5 && ((r.y1 - r.y0) - 22.0).abs() < 0.5))) + .map(|n| n.rect()) + .filter(|r| bar.contains_rect(*r)) + .min_by(|a, b| a.min.x.total_cmp(&b.min.x)) + .expect("the bar has the Highlight split button"); + click_at(&mut h, arrow.center()); + let no_color = h.get_by_label("No Color").rect(); + h.event(egui::Event::PointerMoved(pos2(no_color.min.x + 10.0, no_color.center().y - 30.0))); + steps(&mut h); + let previewed = h.state().canvas.command_previewed.clone(); + assert!(previewed.is_some_and(|(id, _)| id == "format.highlight"), "a swatch previews the highlight"); + assert_eq!(&h.state().session.doc, &doc); + h.event(egui::Event::PointerMoved(pos2(5.0, 5.0))); + steps(&mut h); + assert_eq!(h.state().canvas.command_previewed, None); +} + +/// Hovering a bar button previews its command on the selection; leaving the bar restores the +/// page. The document, its selection and its revision stay as they were. +#[test] +fn hovering_a_bar_button_previews_it_on_the_selection() { + use egui_kittest::kittest::Queryable; + let mut h = bar_over("brown fox"); + let (doc, sel, rev) = (h.state().session.doc.clone(), h.state().session.sel.clone(), h.state().session.rev()); + let viewport = h.state().canvas.viewport.unwrap(); + let bold = h.get_all_by_label("Bold").map(|n| n.rect()).find(|r| viewport.contains_rect(*r)).expect("the bar has Bold"); + h.event(egui::Event::PointerMoved(bold.center())); + steps(&mut h); + assert_eq!(h.state().canvas.command_previewed, Some(("format.bold".to_string(), json!({})))); + assert_ne!(crate::canvas::page_doc(h.state()), &doc, "the page shows the bold text"); + assert_eq!((&h.state().session.doc, &h.state().session.sel, h.state().session.rev()), (&doc, &sel, rev)); + assert_eq!(format_state(&mut h).get("bold"), Some(&json!(false))); + + h.event(egui::Event::PointerMoved(pos2(5.0, 5.0))); + steps(&mut h); + assert_eq!(h.state().canvas.command_previewed, None); + assert_eq!(crate::canvas::page_doc(h.state()), &doc, "off the bar the page is as it was"); + + // Alignment moves the previewed selection. The toolbar must stay anchored to the live + // selection so the hovered button remains under the pointer until the pointer leaves. + let anchor = h.state().canvas.mini_anchor.unwrap(); + let align_right = h.get_all_by_label("Align Right").map(|n| n.rect()).find(|r| viewport.contains_rect(*r)).expect("the bar has Align Right"); + h.event(egui::Event::PointerMoved(align_right.center())); + steps(&mut h); + assert_eq!(h.state().canvas.command_previewed, Some(("para.alignRight".to_string(), json!({})))); + assert_eq!(h.state().canvas.mini_anchor, Some(anchor), "the alignment preview must not move the toolbar"); +} + +/// While a preview is shown the page holds its scroll position, though the previewed text +/// reflows and the caret would be scrolled into view. +#[test] +fn the_page_holds_its_place_while_a_preview_is_shown() { + let mut h = bar_over("brown fox"); + h.state_mut().run("caret.docStart", json!({})).unwrap(); + h.state_mut().run("text.insert", json!({"text": "x\n".repeat(150)})).unwrap(); + h.state_mut().run("select.text", json!({"text": "brown fox"})).unwrap(); + steps(&mut h); + let page = h.state().canvas.viewport.unwrap(); + h.event(egui::Event::PointerMoved(pos2(page.min.x + 20.0, page.center().y))); + h.event(egui::Event::MouseWheel { + unit: egui::MouseWheelUnit::Point, + delta: egui::vec2(0.0, -60.0), + phase: egui::TouchPhase::Start, + modifiers: Default::default(), + source: egui::MouseWheelSource::Unknown, + }); + steps(&mut h); + let held = h.state().canvas.scroll_offset; + for _ in 0..4 { + h.state_mut().canvas.command_preview = Some(("format.size".to_string(), json!({"size": 72.0}))); + h.state_mut().canvas.scroll_to_caret = true; + h.step(); + } + assert!(h.state().canvas.command_previewed.is_some()); + assert_eq!(h.state().canvas.scroll_offset, held, "the preview does not move the page"); + steps(&mut h); + assert_eq!(h.state().canvas.preview_scroll, None, "the hold ends with the preview"); +} + +/// With no preview shown the bar's anchor follows the selection as the page scrolls. +#[test] +fn the_bar_anchor_follows_the_selection_as_the_page_scrolls() { + let mut h = bar_over("brown fox"); + h.state_mut().run("caret.docStart", json!({})).unwrap(); + h.state_mut().run("text.insert", json!({"text": "x\n".repeat(150)})).unwrap(); + h.state_mut().run("select.text", json!({"text": "brown fox"})).unwrap(); + steps(&mut h); + let anchored = h.state().canvas.mini_anchor.unwrap(); + let page = h.state().canvas.viewport.unwrap(); + h.event(egui::Event::PointerMoved(pos2(page.min.x + 20.0, page.center().y))); + h.event(egui::Event::MouseWheel { + unit: egui::MouseWheelUnit::Point, + delta: egui::vec2(0.0, 120.0), + phase: egui::TouchPhase::Start, + modifiers: Default::default(), + source: egui::MouseWheelSource::Unknown, + }); + steps(&mut h); + assert_ne!(h.state().canvas.mini_anchor, Some(anchored), "the toolbar anchor follows the live selection as the viewport scrolls"); +} + /// #2959: formatting must be available alongside the text's right-click menu, using the /// selection that was clicked. Its lists must remain usable inside the context popup. #[test] @@ -219,6 +424,11 @@ fn context_menu_toolbar_formats_the_selection_and_opens_its_size_list() { assert!(bar_layer(&h).is_none(), "the standalone selection toolbar must not double up"); let viewport = h.state().canvas.viewport.unwrap(); let bold = h.get_all_by_label("Bold").map(|n| n.rect()).find(|r| viewport.contains_rect(*r)).expect("the context menu has Bold"); + let doc = h.state().session.doc.clone(); + h.event(egui::Event::PointerMoved(bold.center())); + steps(&mut h); + assert_eq!(h.state().canvas.command_previewed, None, "the context toolbar does not start the hidden floating bar's preview repaint loop"); + assert_eq!(&h.state().session.doc, &doc, "hovering a context-menu control does not preview a document change"); click_at(&mut h, bold.center()); assert_eq!(format_state(&mut h).get("bold"), Some(&json!(true))); assert_eq!(h.state().session.sel, selection); @@ -602,7 +812,7 @@ fn alignment_buttons_mark_the_alignment_seen_on_the_page_in_a_right_to_left_para } egui::Area::new(egui::Id::unique("mini_align_probe")).fixed_pos(pos2(10.0, 10.0)).show(ui.ctx(), |ui| { let t = Tokens::get(ui.ctx()); - content(app, ui, &t); + content(app, ui, &t, true); }); }, a, @@ -626,3 +836,81 @@ fn alignment_buttons_mark_the_alignment_seen_on_the_page_in_a_right_to_left_para assert!(!is_marked(unlit), "rtl={rtl} {cmd:?}: {unlit} is not marked"); } } + +#[test] +fn the_alignment_buttons_align_the_paragraph() { + use egui_kittest::kittest::Queryable; + for (label, align) in [("Center", "center"), ("Align Right", "right"), ("Justify", "both"), ("Align Left", "left")] { + let mut h = bar_over("brown fox"); + let viewport = h.state().canvas.viewport.unwrap(); + let b = h.get_all_by_label(label).map(|n| n.rect()).find(|r| viewport.contains_rect(*r)).expect("the bar has the button"); + h.event(egui::Event::PointerMoved(b.center())); + steps(&mut h); + click_at(&mut h, b.center()); + let got = h.state().session.doc.para_at(&h.state().session.sel.focus).map(|p| format!("{:?}", p.props.align)).unwrap_or_default(); + assert!(got.to_lowercase().contains(align) || (align == "both" && got.to_lowercase().contains("justif")), "{label}: {got}"); + } +} + +/// After a click the button's preview stays off while the pointer is on it, so a toggle does not +/// flash its other state; leaving and coming back previews again. +#[test] +fn a_clicked_button_holds_its_preview_until_the_pointer_leaves() { + use egui_kittest::kittest::Queryable; + let mut h = bar_over("brown fox"); + let viewport = h.state().canvas.viewport.unwrap(); + let size = format_state(&mut h).get("size").cloned(); + let grow = h.get_all_by_label("Increase Font Size").map(|n| n.rect()).find(|r| viewport.contains_rect(*r)).expect("the bar has Grow").center(); + h.event(egui::Event::PointerMoved(grow)); + steps(&mut h); + assert!(h.state().canvas.command_previewed.is_some(), "hovering previews"); + click_at(&mut h, grow); + steps(&mut h); + assert_ne!(format_state(&mut h).get("size").cloned(), size, "the click grew the text"); + assert_eq!(h.state().canvas.command_previewed, None, "no preview of the next step under the pointer"); + h.event(egui::Event::PointerMoved(pos2(5.0, 5.0))); + steps(&mut h); + h.event(egui::Event::PointerMoved(grow)); + steps(&mut h); + assert!(h.state().canvas.command_previewed.is_some(), "coming back previews again"); +} + +/// After a click the preview stays still while the pointer is on the button. Leaving and coming +/// back previews the undo: Bold over bold text shows it unbolded. +#[test] +fn coming_back_to_a_toggle_previews_its_undo() { + use egui_kittest::kittest::Queryable; + let mut h = bar_over("brown fox"); + let viewport = h.state().canvas.viewport.unwrap(); + let bold = h.get_all_by_label("Bold").map(|n| n.rect()).find(|r| viewport.contains_rect(*r)).expect("the bar has Bold").center(); + click_at(&mut h, bold); + steps(&mut h); + assert_eq!(format_state(&mut h).get("bold"), Some(&json!(true))); + assert_eq!(h.state().canvas.command_previewed, None, "the page holds still after the click"); + h.event(egui::Event::PointerMoved(pos2(5.0, 5.0))); + steps(&mut h); + h.event(egui::Event::PointerMoved(bold)); + steps(&mut h); + assert_eq!(h.state().canvas.command_previewed, Some(("format.bold".to_string(), json!({}))), "coming back previews the undo"); + let doc = h.state().session.doc.clone(); + assert_ne!(crate::canvas::page_doc(h.state()), &doc, "the page shows the text unbolded"); +} + +/// A selection that ends at the next paragraph's start (Select Paragraph, a triple-click) shows +/// the alignment of the paragraph it covers, not the next one's. +#[test] +fn a_selected_paragraph_shows_its_own_alignment() { + let mut h = bar_over("brown fox"); + h.state_mut().session = wordcraft_engine::Session::new(wordcraft_doc::Document::from_text("First paragraph\nSecond paragraph")); + h.state_mut().session.sel.anchor = wordcraft_doc::Pos::body(0, 2); + h.state_mut().session.sel.focus = wordcraft_doc::Pos::body(0, 2); + h.state_mut().run("para.alignRight", json!({})).unwrap(); + h.state_mut().session.sel.anchor = wordcraft_doc::Pos::body(0, 0); + h.state_mut().session.sel.focus = wordcraft_doc::Pos::body(1, 0); + steps(&mut h); + let s = &h.state().session; + let focus_align = s.doc.para_at(&s.sel.focus).map(|p| s.doc.styles.resolve_para(&p.props).align); + assert_eq!(focus_align, Some(wordcraft_doc::Align::Left), "the next paragraph is left aligned"); + let r = wordcraft_engine::cmd::para::selection_para(s); + assert_eq!(r.align, wordcraft_doc::Align::Right, "the buttons read the selected paragraph"); +} diff --git a/crates/ui-egui/src/ribbon/home.rs b/crates/ui-egui/src/ribbon/home.rs index 2fefbc97b7..a4d9d0f4bb 100644 --- a/crates/ui-egui/src/ribbon/home.rs +++ b/crates/ui-egui/src/ribbon/home.rs @@ -169,7 +169,7 @@ pub(super) fn home(app: &mut WordApp, ui: &mut Ui) { }); }); group(ui, "Paragraph", Some("para.dialog"), app, |ui, app| { - let rp = app.session.doc.para_at(&app.session.sel.focus).map(|p| app.session.doc.styles.resolve_para(&p.props)); + let rp = app.session.doc.para_at(&app.session.sel.focus).map(|_| wordcraft_engine::cmd::para::selection_para(&app.session)); // The buttons show alignment as seen on the page (Align Right is a right-to-left paragraph's start). let align = rp.as_ref().map(|r| r.align.visual(r.bidi)).unwrap_or_default(); let rtl = rp.as_ref().is_some_and(|r| r.bidi); diff --git a/crates/ui-egui/src/ribbon/layout.rs b/crates/ui-egui/src/ribbon/layout.rs index 041a61083c..39e1654e28 100644 --- a/crates/ui-egui/src/ribbon/layout.rs +++ b/crates/ui-egui/src/ribbon/layout.rs @@ -121,7 +121,7 @@ pub(super) fn layout(app: &mut WordApp, ui: &mut Ui) { }); }); group(ui, "Paragraph", Some("para.dialog"), app, |ui, app| { - let rp = app.session.doc.para_at(&app.session.sel.focus).map(|p| app.session.doc.styles.resolve_para(&p.props)); + let rp = app.session.doc.para_at(&app.session.sel.focus).map(|_| wordcraft_engine::cmd::para::selection_para(&app.session)); let Some(rp) = rp else { return }; // #654: header + two rows of 20 px fields fit the content height above the group title // (1.5 pt between rows; 3 ran 2.5 pt into it); labels and fields sit on shared columns, diff --git a/crates/ui-egui/src/widgets.rs b/crates/ui-egui/src/widgets.rs index 98c10f6302..e4bf42eb2f 100644 --- a/crates/ui-egui/src/widgets.rs +++ b/crates/ui-egui/src/widgets.rs @@ -17,13 +17,13 @@ pub use buttons::{ label_line, menu_button, menu_enabled, small, split, }; pub(crate) use buttons::{bg, run_from_ribbon}; -pub(crate) use combo::swatch; pub use combo::{ ADD_FONT, COMBO_PREVIEW_ROW_H, DrawnState, FontComboOptions, LOAD_SYSTEM_FONTS, color_grid, combo, combo_hint, combo_list, drawn_state, font_combo, font_combo_with_recent, font_combo_with_recent_hint, font_matches, }; #[cfg(test)] use combo::{Row, highlight_row, section_row, section_rows}; +pub(crate) use combo::{current_pick, note_hover, set_current_pick, swatch, take_hover}; pub use groups::{command_icon, command_menu, customize_menu_items, group, group_titled, row}; pub use icon_buttons::{ dialog_tabs, icon_button, icon_menu_item, icon_only_button, icon_text_button, icon_text_button_width, icon_text_menu_button, primary_button, diff --git a/crates/ui-egui/src/widgets/buttons.rs b/crates/ui-egui/src/widgets/buttons.rs index 299da8897d..6a5bf890fb 100644 --- a/crates/ui-egui/src/widgets/buttons.rs +++ b/crates/ui-egui/src/widgets/buttons.rs @@ -173,7 +173,7 @@ pub fn split( action: ButtonAction<'_>, swatch: Option, menu: impl FnOnce(&mut Ui, &mut WordApp), -) { +) -> Response { let ButtonAction { id, params, checked } = action; let tip = tl!(tip); let t = Tokens::get(ui.ctx()); @@ -205,12 +205,13 @@ pub fn split( // (#3172). aresp.widget_info(|| egui::WidgetInfo::labeled(egui::Role::Button, on, &arrow_title)); if !on { - return; + return resp; } crate::rtl::menu(&aresp).show(|ui| { ui.set_min_width(180.0); menu(ui, app); }); + resp } /// Whether a menu button whose menu is about command `id` is on ("" = always). diff --git a/crates/ui-egui/src/widgets/combo.rs b/crates/ui-egui/src/widgets/combo.rs index 9bf51c5048..5dea0f4e01 100644 --- a/crates/ui-egui/src/widgets/combo.rs +++ b/crates/ui-egui/src/widgets/combo.rs @@ -39,6 +39,44 @@ pub fn color_grid(ui: &mut Ui, theme: &[wordcraft_doc::Rgb]) -> Option { picked } +fn hover_key() -> egui::Id { + egui::Id::unique("wc_pick_hover") +} + +/// Records the list entry or colour the pointer is over in this pass (one per pass; the last +/// drawn wins). [`take_hover`] reads it. +pub(crate) fn note_hover(ctx: &egui::Context, value: String) { + let pass = ctx.cumulative_pass_nr(); + ctx.data_mut(|d| d.insert_temp(hover_key(), (pass, value))); +} + +/// The entry noted by [`note_hover`] in this pass, if any; it is read once. Callers take before +/// drawing a list too, to drop what another widget noted. +pub(crate) fn take_hover(ctx: &egui::Context) -> Option { + let pass = ctx.cumulative_pass_nr(); + let seen = ctx.data_mut(|d| d.remove_temp::<(u64, String)>(hover_key())); + seen.filter(|(p, _)| *p == pass).map(|(_, v)| v) +} + +fn current_key() -> egui::Id { + egui::Id::unique("wc_pick_current") +} + +/// The colour (hex, or a name the menu uses) a palette marks as the one in effect; `None` marks +/// nothing. The caller sets it before drawing a menu and clears it after. +pub(crate) fn set_current_pick(ctx: &egui::Context, current: Option) { + ctx.data_mut(|d| match current { + Some(c) => { + d.insert_temp(current_key(), c); + } + None => d.remove::(current_key()), + }); +} + +pub(crate) fn current_pick(ctx: &egui::Context) -> Option { + ctx.data(|d| d.get_temp::(current_key())) +} + pub(crate) fn swatch(ui: &mut Ui, c: wordcraft_doc::Rgb) -> bool { let (r, resp) = ui.allocate_exact_size(vec2(15.0, 15.0), Sense::click()); ui.painter().rect_filled(r, 0.0, Color32::from_rgb(c.0, c.1, c.2)); @@ -49,6 +87,12 @@ pub(crate) fn swatch(ui: &mut Ui, c: wordcraft_doc::Rgb) -> bool { Stroke::new(if resp.hovered() { 1.5 } else { 0.5 }, if resp.hovered() { t.accent } else { t.border_strong }), egui::StrokeKind::Inside, ); + if resp.hovered() { + note_hover(ui.ctx(), c.hex()); + } + if current_pick(ui.ctx()).is_some_and(|cur| cur.eq_ignore_ascii_case(&c.hex())) { + ui.painter().rect_stroke(r.expand(1.0), 0.0, Stroke::new(2.0, t.accent), egui::StrokeKind::Outside); + } resp.on_hover_text(format!("#{}", c.hex())).clicked() } @@ -377,11 +421,22 @@ fn combo_impl(ui: &mut Ui, options: ComboOptions<'_>) -> Option { menu_field.rect = resp.rect.union(ar); let menu = craft_ui::combo::Menu::new(ui, &menu_field).close_behavior(close).height(420.0); let row_h = if preview.is_some() { COMBO_PREVIEW_ROW_H } else { ui.spacing().interact_size.y }; + // The recent section keeps its order while the list stays open: a pick moves the family to + // the top for the next time the list opens, not under the pointer. + let frozen_id = search_id.with("recent_frozen"); + let menu_recent: Vec = ui.data(|d| d.get_temp(frozen_id)).unwrap_or_else(|| recent.to_vec()); let item = |k: usize| items.get(k); - let row = |k: usize| section_row(k, recent, &item); - let total = section_rows(recent.len(), items.len()); + let row = |k: usize| section_row(k, &menu_recent, &item); + let total = section_rows(menu_recent.len(), items.len()); let list = |ui: &mut Ui, range: std::ops::Range, ()| { - draw_rows(ui, RowDrawOptions { width, current, range, row: &row, highlight: None, preview, row_height: row_h }) + let picked = draw_rows( + ui, + RowDrawOptions { width, current, range, row: &row, highlight: None, preview, row_height: row_h, recent_rows: menu_recent.len() }, + ); + if picked.is_some() { + ui.close(); + } + picked }; let footer = |ui: &mut Ui| { let mut picked = None; @@ -402,6 +457,13 @@ fn combo_impl(ui: &mut Ui, options: ComboOptions<'_>) -> Option { } else { menu.show_rows_with_header(|_| (), row_h, |()| total, list) }; + ui.data_mut(|d| { + if picked.is_some() { + d.insert_temp(frozen_id, menu_recent.clone()); + } else { + d.remove::>(frozen_id); + } + }); if let Some(v) = picked.flatten() { out = Some(v); } @@ -425,7 +487,10 @@ fn combo_impl(ui: &mut Ui, options: ComboOptions<'_>) -> Option { .show(ui, |ui| { let item = |k: usize| matches.get(k).and_then(|&i| items.get(i)); let row = |k: usize| section_row(k, recent_shown, &item); - list_rows(ui, RowListOptions { width, current, n, row: &row, highlight: Some(lit), scroll, preview }) + list_rows( + ui, + RowListOptions { width, current, n, row: &row, highlight: Some(lit), scroll, preview, recent_rows: recent_shown.len() }, + ) }) .inner }); @@ -467,7 +532,20 @@ pub const COMBO_PREVIEW_ROW_H: f32 = 24.0; /// family and each preview loads that font, so building all rows loaded every font on the system /// (gigabytes on large font collections) and froze the app (#121). pub fn combo_list(ui: &mut Ui, width: f32, current: &str, items: &[String], preview: Option<&dyn Fn(&mut Ui, &str) -> Response>) -> Option { - list_rows(ui, RowListOptions { width, current, n: items.len(), row: &|k| items.get(k).map(Row::Item), highlight: None, scroll: None, preview }).0 + list_rows( + ui, + RowListOptions { + width, + current, + n: items.len(), + row: &|k| items.get(k).map(Row::Item), + highlight: None, + scroll: None, + preview, + recent_rows: 0, + }, + ) + .0 } /// A row of a combo's list: a dim section heading nothing picks, or an entry. @@ -536,13 +614,19 @@ struct RowDrawOptions<'rows, 'text> { highlight: Option, preview: Option<&'rows dyn Fn(&mut Ui, &str) -> Response>, row_height: f32, + /// How many recent families head the list (0 without the section). + recent_rows: usize, } fn draw_rows(ui: &mut Ui, options: RowDrawOptions<'_, '_>) -> Option { - let RowDrawOptions { width, current, range, row, highlight, preview, row_height: row_h } = options; + let RowDrawOptions { width, current, range, row, highlight, preview, row_height: row_h, recent_rows } = options; let mut out = None; - let fill = Tokens::get(ui.ctx()).checked; + let tokens = Tokens::get(ui.ctx()); + let (fill, accent) = (tokens.checked, tokens.accent); ui.set_min_width(width + 60.0); + // A family in Recently Used is marked there only: marked again under All Fonts it would look as + // if two were chosen. + let current_is_recent = (1..=recent_rows).any(|k| matches!(row(k), Some(Row::Item(r)) if r == current)); for k in range { let it = match row(k) { Some(Row::Item(it)) => it, @@ -559,9 +643,25 @@ fn draw_rows(ui: &mut Ui, options: RowDrawOptions<'_, '_>) -> Option { let r = Rect::from_min_size(ui.cursor().min, vec2(ui.available_width(), row_h)); ui.painter().rect_filled(r, 3.0, fill); } - p(ui, it).clicked() + let in_all_fonts = recent_rows > 0 && k > recent_rows.saturating_add(1); + if it == current && !(in_all_fonts && current_is_recent) { + let r = Rect::from_min_size(ui.cursor().min, vec2(ui.available_width(), row_h)); + ui.painter().rect_filled(r, 3.0, fill); + ui.painter().rect_filled(Rect::from_min_size(r.min, vec2(3.0, row_h)), 1.5, accent); + } + let resp = p(ui, it); + if resp.hovered() { + note_hover(ui.ctx(), it.clone()); + } + resp.clicked() + } + None => { + let resp = ui.selectable_label(if highlight.is_some() { lit } else { it == current }, it.as_str()); + if resp.hovered() { + note_hover(ui.ctx(), it.clone()); + } + resp.clicked() } - None => ui.selectable_label(if highlight.is_some() { lit } else { it == current }, it.as_str()).clicked(), }; if clicked { out = Some(it.clone()); @@ -581,10 +681,11 @@ struct RowListOptions<'rows, 'text> { highlight: Option, scroll: Option<(f32, f32)>, preview: Option<&'rows dyn Fn(&mut Ui, &str) -> Response>, + recent_rows: usize, } fn list_rows(ui: &mut Ui, options: RowListOptions<'_, '_>) -> (Option, f32, f32) { - let RowListOptions { width, current, n, row, highlight, scroll, preview } = options; + let RowListOptions { width, current, n, row, highlight, scroll, preview, recent_rows } = options; let mut out = None; let row_h = if preview.is_some() { COMBO_PREVIEW_ROW_H } else { ui.spacing().interact_size.y }; let desired_h = (n as f32 * (row_h + ui.spacing().item_spacing.y)).min(420.0); @@ -607,7 +708,7 @@ fn list_rows(ui: &mut Ui, options: RowListOptions<'_, '_>) -> (Option, f area = area.vertical_scroll_offset(offset.max(0.0)); } let shown = area.show_rows(ui, row_h, n, |ui, range| { - if let Some(v) = draw_rows(ui, RowDrawOptions { width, current, range, row, highlight, preview, row_height: row_h }) { + if let Some(v) = draw_rows(ui, RowDrawOptions { width, current, range, row, highlight, preview, row_height: row_h, recent_rows }) { out = Some(v); } }); diff --git a/docs/ui-parity.md b/docs/ui-parity.md index a58e7c4d15..592b452486 100644 --- a/docs/ui-parity.md +++ b/docs/ui-parity.md @@ -17,6 +17,8 @@ Document title opens Rename Document; the account badge opens Options › Genera | Ribbon tabs and groups | All Word tabs including contextual Table Design/Layout, Picture Format, Shape Format, Header & Footer, Equation, Outlining (Outline view, #493); ribbon overflow (#43, #129). Draw tab: Select, Eraser, Pen, Pencil, Highlighter with colour and thickness (#307); Lasso (drag to move, Delete, recolour), Add Pen gallery (right-click to remove), Ink to Shape (lines, arrows, rectangles, ellipses, polygons), Ink Replay with play/pause/rewind/forward bar (#395); missing: Ink to Math. The app opens on Home every launch, as in Word: the active tab is not restored between runs, but going File and back to the editor returns to the tab that was showing, contextual tabs included. Home › Font: the font box lists Recently Used Fonts (the fonts applied from the box, the mini toolbar or the Font dialog, most recent first, ten at most, kept between runs) above All Fonts, as in Word; the sections show while nothing is typed, including after a no-match query is cleared in a scrollable list (#2068). With Filling in forms enforced (Restrict Editing), the Developer tab's content-control buttons and Properties grey out, their tooltips saying why, as in Word. Read only and comments-only protection without an exception the author may edit grey out every edit, their tooltips saying why, and tracked-changes protection greys out Accept, Reject and Track Changes; what decides it is cached per document revision, so the ribbon doesn't walk the document on every frame | Same plus Draw | 85% | (Draw in features) | | Keytips (Alt / F10) | Ribbon badges (#43), Backstage page badges after Alt, F (H, N, O, I, S, A, P, E, C, T; P and V open Print, #4960) and numbered Quick Access Toolbar badges in the user's button order (#620; none while the toolbar is hidden, #1945); File › Options › Advanced › Display switch saved per user (`ui.keytips`); Alt leaves macOS Option typing alone, and AltGr leaves typing alone on Linux and Windows (#2388); legacy menu keys (#1697; not on macOS): 18 Word 2003 sequences Word for Windows still takes, as observed there (Alt, V, U Full Screen View; V, P/W/O/N views; V, D/L/Z; E, L/F/E/G; I, S; I, P, F; O, F/P; T, W; A, I, T), hidden, with a hint under the tab row (under the slim bar in Focus and Full Screen View); an unknown letter is ignored, Esc cancels; Alt, I, B left out (no Break dialog) | ✅ | 85% | 1–2 | | Mini-toolbar on selection and text context menu | ✅ (#43, two rows #535; Recently Used Fonts in its font box #2068; the text context menu includes the same toolbar at a caret or selection, #2959) | ✅ | 80% | 1–2 | +| Keytips (Alt / F10) | Ribbon badges (#43) and numbered Quick Access Toolbar badges in the user's button order (#620; none while the toolbar is hidden, #1945); File › Options › Advanced › Display switch saved per user (`ui.keytips`); Alt leaves macOS Option typing alone, and AltGr leaves typing alone on Linux and Windows (#2388); legacy menu keys (#1697; not on macOS): 18 Word 2003 sequences Word for Windows still takes, as observed there (Alt, V, U Full Screen View; V, P/W/O/N views; V, D/L/Z; E, L/F/E/G; I, S; I, P, F; O, F/P; T, W; A, I, T), hidden, with a hint under the tab row (under the slim bar in Focus and Full Screen View); an unknown letter is ignored, Esc cancels; Alt, I, B left out (no Break dialog) | ✅ | 85% | 1–2 | +| Mini-toolbar on selection and text context menu | ✅ (#43, two rows #535; hovering a formatting button previews it on the selected text, #4664; Recently Used Fonts in its font box #2068; the text context menu includes the same toolbar at a caret or selection, #2959) | ✅ | 80% | 1–2 | | Colour drop-downs: theme/standard colours, Recent Colors, More Colors… → Colors dialog (Standard honeycomb, Custom hue/saturation field with lightness, RGB/HSL and hex) | ✅ Font Color (ribbon, mini toolbar, Font dialog), Shading, Page Color, Shape Fill/Outline/Glow, pen colours, dialog colour fields (#606); Shape Fill › Gradient: Light and Dark Variations of the shape's colour, More Gradients… (#1500); no eyedropper | ✅ | 90% | 1 | | Quick Access Toolbar | AutoSave, then the user's commands (Save, Undo, Redo by default); add, remove and reorder from its … menu (common commands, More Commands…), right-click on any ribbon button, or Customize Ribbon; saved per user (#379, #376). Undo's ▾ list: recent steps newest first, hover highlights the steps a click undoes ("Undo 3 Actions"), one click undoes them all (#701; `edit.undoTo`, `edit.undoHistory`). Its menu ends with Hide Quick Access Toolbar, which takes it out of the title bar; Show Quick Access Toolbar on the ribbon's right-click menu, or in Customize Ribbon › Quick Access Toolbar, brings it back; kept between runs; `ui.quickAccessToolbar` for scripts (#1945). Not shown below the ribbon | customizable | 92% | 0.5 | | Customize Ribbon / Customize Keyboard | Customize Keyboard (#368): categories, a command's keys, press a combination to see which command uses it, Assign / Remove / Reset All; custom keys override built-ins, removed built-ins do nothing, saved per user; `tools.customizeKeyboard` for agents. Customize Ribbon (#379): show, hide and reorder tabs, custom tabs and custom groups (on any tab) holding any commands, rename, remove, Reset; right-click on the ribbon; saved per user; `tools.customizeRibbon` for agents. Built-in tabs can't be renamed; no import/export file; filter-as-you-type command search in all three pickers (#1845) | ✅ | 85% | 1–2 | @@ -117,6 +119,7 @@ Right-click and Shift+F10 keep the compact suggestions menu. The pane is shared | 2026-10-27 | trivial | File › Print: Return prints, as Word's Print dialog does with Print as its default button; a field or list on the page that has the keyboard keeps Return | | 2026-10-26 | minor | Word-observed Proofing task pane uses shared review commands; clicking a suggestion corrects and advances; context, suggestion cards and ignore/dictionary links follow the Windows reference; inspected previews prompted a full-width context and scrollable three-card list; exact selected spelling takes priority over overlapping grammar, with command/pane regressions and integration workflow paths; readiness estimates unchanged | | 2026-11-01 | trivial | N-up and booklet print imposition (#641): integrate current print-job link handling (#4734), preserve markup preview and sheet/copy planning; readiness estimates unchanged. | +| 2026-10-28 | trivial | Mini toolbar: after a click a button shows no preview until the pointer leaves it, and coming back previews the undo (Bold over bold text shows it unbolded); the alignment buttons of the bar and the Home and Layout ribbons follow the paragraph a selection covers, not the next one it ends at; picking from a font or size list closes it, and the recent fonts reorder the next time it opens; the font list and the colour menus mark the choice in effect, apart from the one hovered, and a family listed under Recently Used Fonts is marked there only; the page holds its scroll position while a preview is shown; while the pointer is on Bold, Italic, Underline, Strikethrough, Grow, Shrink or an alignment button, or on an entry of the font, size, highlight or font colour lists, the page shows that command run on the selection, laid out on a copy, so the document, undo history and selection do not change; moving to another button updates it, leaving the bar restores the page, a click applies the command as before (#4664) | | 2026-10-22 | trivial | View › Window › New Window opens another window on the document, focused and cascaded; two windows on one document are titled `Name:1` and `Name:2` (one window: the plain name). Each window keeps its own selection, scroll position, zoom, view mode, ruler and panes; the text, undo history, unsaved state and file are the document's, so an edit or Undo in either window shows in both, and a caret in text the other window deleted moves to the nearest place left. Closing one of a document's windows asks nothing; closing its last asks about unsaved changes, and quitting asks once per document. Switch Windows lists every window. The web app keeps one window | | 2026-10-22 | trivial | One native window per open document on the desktop (the web app keeps one window): New and Open open the document in a window of its own, focused and cascaded from the last; Open replaces an untouched blank document in its window and brings an already-open file's window forward; each window keeps its own ribbon tab, File page, dialogs, panes and composition; View › Window › Switch Windows lists the windows and brings the chosen one forward; File › Close and the window's close button close the window (asking about unsaved changes) and the window focused before comes forward, while the last window stays open with no document; quitting asks Save / Don't Save / Cancel about each document in its own window | | 2026-10-22 | trivial | Several open documents in one window (one window per document comes next): View › Window › Switch Windows lists the open documents, the shown one marked and unsaved ones dotted, and shows the one chosen, with its own scroll position, zoom, comment drafts and AutoSave file; File › New, Open, Envelopes, Labels, Finish & Merge and personal templates open beside the open documents without asking about unsaved changes; File › Close shows the next open document; the window's close button asks Save / Don't Save / Cancel about each document with unsaved changes, showing it, and Cancel keeps the app open. Untitled documents are numbered (Document2) in the interface language | From 107996dd248507435e20254618418458b703d093 Mon Sep 17 00:00:00 2001 From: ro-legal-docx <348714721+ro-legal-docx@users.noreply.github.com> Date: Thu, 5 Nov 2026 10:13:52 +0200 Subject: [PATCH 04/34] REF: preserve paragraph numbers when updating cross-references (#4609) * M6: preserve numbered REF results during field updates Adapt and validate the patch published in WordCraft #4533, retaining main's bounded numbering renderer and adding relative-context/cache guards. Co-authored-by: Alyosha-dot-shop <218732667+Alyosha-dot-shop@users.noreply.github.com> * M6: reuse bookmark lookup for numbered REF updates * REF: use explicit imports for the workspace clippy gate * #4609: adapt synthetic fixtures to shared document data * #4609: checkpoint review fixes and isolated validation notes * #4609: retain rendered REF labels and isolate relative context by list --------- Co-authored-by: Alyosha-dot-shop <218732667+Alyosha-dot-shop@users.noreply.github.com> Co-authored-by: Martin Ball --- ROADMAP.md | 4 + crates/doc/src/numbering.rs | 167 ++++++-- crates/engine/src/cmd/references.rs | 1 + crates/engine/src/cmd/references/fields.rs | 12 + crates/engine/src/cmd/references/numbers.rs | 135 ++++++ crates/engine/tests/it/main.rs | 2 + .../engine/tests/it/ref_paragraph_numbers.rs | 404 ++++++++++++++++++ docs/file-format-parity.md | 4 + docs/gaps.md | 3 + docs/layout-parity.md | 3 + 10 files changed, 705 insertions(+), 30 deletions(-) create mode 100644 crates/engine/src/cmd/references/numbers.rs create mode 100644 crates/engine/tests/it/ref_paragraph_numbers.rs diff --git a/ROADMAP.md b/ROADMAP.md index dab0388b7c..d285bad32a 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -779,6 +779,7 @@ Footer page-table height and body wrapping are corrected. Other pagination gaps | 2026-11-04 | trivial | Progress log: ODT element audit (gap 19) | | 2026-11-04 | trivial | Progress log: ODT checked against 220 files from other applications (gap 19) | | 2026-11-04 | trivial | Progress log: OpenDocument files shown in Microsoft Word style or LibreOffice style (gap 19) | +| 2026-11-04 | trivial | PR #4609: relative REF keeps context already displayed by the own or a needed ancestor label; six synthetic legal-template cases and separate-list context follow the Word for Windows measurements reported by @pakiat in PR discussion. Existing unknown-switch/cache boundaries and readiness estimates unchanged; no new native Word run. | | 2026-11-01 | trivial | Progress log: SEQ, STYLEREF and REF fields show fresh results in output | | 2026-10-29 | trivial | Progress log: Print Markup balloon anchors use one object walk per paragraph (#3614); readiness estimates unchanged | | 2026-10-28 | trivial | Print Markup text-copy comment discovery walks paragraph objects once (#3614); quotes, order, limits and readiness estimates unchanged | @@ -826,6 +827,7 @@ Footer page-table height and body wrapping are corrected. Other pagination gaps | 2026-10-29 | trivial | Progress log: window titles omit NUL characters (#3634) | | 2026-10-29 | trivial | Recipient labels continue across product-sized sheets instead of stopping after the first sheet (#4880). Filtered/sorted order, product geometry and single-label mode retained; readiness estimates unchanged. | | 2026-10-27 | trivial | Progress log: Return on File › Print prints, as Word's default Print button does | +| 2026-10-27 | trivial | PR #4609: Numeric cross-references (#4533): preserve the numbered clause through field updates; adapted from @Alyosha-dot-shop's issue patch, with extra relative-context and cache guards. Synthetic checks only; readiness estimates unchanged. | | 2026-10-26 | minor | Word-observed Proofing task pane uses shared review commands; clicking a suggestion corrects and advances; context, suggestion cards and ignore/dictionary links follow the Windows reference; inspected previews prompted a full-width context and scrollable three-card list; exact selected spelling takes priority over overlapping grammar, with command/pane regressions and integration workflow paths; readiness estimates unchanged | | 2026-10-14 | trivial | Progress log: Insert Date and Time and DATE/TIME fields use local time (#1707) | | 2026-10-22 | trivial | Progress log: one native window per open document | @@ -1209,3 +1211,5 @@ Footer page-table height and body wrapping are corrected. Other pagination gaps | 2026-10-27 | trivial | Progress log: AutoCorrect Options with no document open (#4585) | | 2026-10-28 | trivial | Progress log: RTF metafile pictures are imported (#4259) | | 2026-10-28 | trivial | Progress log: Chinese and Japanese text counts a word per character (#4547) | +| 2026-10-27 | trivial | 2026-10-27 · #4533 review: numeric REF updates lazily index body bookmarks once per update, retaining the first body bookmark for duplicate names. Unsupported switches and ordinary REF/PAGEREF behavior are unchanged; a synthetic 64-reference regression covers repeated updates and duplicate names. Estimates unchanged. | +| 2026-10-27 | trivial | 2026-10-27 · #4533: numeric REF fields use paragraph list numbers for no/full/relative context, reusing bounded numbering. Shared context already embedded in a level label is removed; merged-away cells do not count. Unsupported separator/text/position switches and ambiguous contexts or delimiter-free joins retain cached results. Synthetic OOXML regressions; no native Word or real-document validation, estimates unchanged. | diff --git a/crates/doc/src/numbering.rs b/crates/doc/src/numbering.rs index bf4d8a5c5e..a5d2ec6e10 100644 --- a/crates/doc/src/numbering.rs +++ b/crates/doc/src/numbering.rs @@ -294,6 +294,14 @@ pub struct Counters { /// Per abstract list: whether each level has counted yet (a value of 0 can be a real count when a /// level starts at 0). flags: HashMap, + /// The last explicitly rendered label and template at each abstract-list level. + labels: HashMap<(u32, u8), CountedLabel>, +} + +#[derive(Debug, Clone)] +struct CountedLabel { + label: Option, + levels: Vec, } /// Whether a level has counted yet, and the value its next item takes if a start override says so. @@ -320,6 +328,7 @@ impl Counters { let def = level_def(lv)?.clone(); // A "none" level shows no label at all (Word's numFmt none) — not even its text. if def.format == NumFormat::None { + self.labels.insert((abs.id, lv as u8), CountedLabel { label: None, levels: Vec::new() }); return None; } let st = self.state.entry(abs.id).or_insert([0; 9]); @@ -366,42 +375,101 @@ impl Counters { if restarts { *deeper = 0; *f = LevelFlags::default(); + self.labels.remove(&(abs.id, d as u8)); } } let vals = *st; let started = *fl; - if def.format == NumFormat::Bullet { - return Some((def.text.clone(), def)); - } - let mut label = String::new(); - // Word's level text is short; .docx and the lists command already cap it at 64. - let mut chars = def.text.chars().take(MAX_LEVEL_TEXT).peekable(); - while let Some(c) = chars.next() { - if c == '%' - && let Some(d) = chars.peek().and_then(|d| d.to_digit(10)) - { - chars.next(); - let k = (d as usize).saturating_sub(1).min(8); - let val = vals.get(k).copied().unwrap_or(0); - let counted = started.get(k).is_some_and(|f| f.started); - let val = if counted { val } else { level_def(k).map(|l| l.start).unwrap_or(1) }; - // Legal numbering (w:isLgl) shows every level in Arabic digits, whatever its own - // format (二 of a Chinese outline becomes 2 in "2.1"). - let fmt = match level_def(k).map(|l| l.format).unwrap_or(NumFormat::Decimal) { - NumFormat::DecimalZero => NumFormat::DecimalZero, - _ if def.legal => NumFormat::Decimal, - f => f, - }; - label.push_str(&fmt.format(val)); - if label.len() > MAX_LABEL_BYTES { - break; - } - } else { - label.push(c); - } - } + let numeric = def.format != NumFormat::Bullet; + let label = if numeric { render_label(numbering, num, &def, &vals, &started) } else { def.text.clone() }; + self.labels.insert((abs.id, lv as u8), CountedLabel { label: numeric.then(|| label.clone()), levels: template_levels(&def.text) }); Some((label, def)) } + /// Which levels of `num`'s list have counted a paragraph yet (a level never used has no + /// number of its own to show in a reference). + pub fn started(&self, numbering: &Numbering, num: u32) -> Option<[bool; 9]> { + let abs = numbering.abstract_of(num)?; + Some(std::array::from_fn(|k| self.labels.get(&(abs.id, k as u8)).is_some_and(|last| last.label.is_some()))) + } + + /// The label `level` of `num`'s list shows at this point of the walk, without counting: what + /// the last paragraph at that level showed (`"14."` while walking clause 14's sub-clauses). + /// `None` for a bullet or "none" level, or a level the list doesn't define. + pub fn current_label(&self, numbering: &Numbering, num: u32, level: u8) -> Option { + let abs = numbering.abstract_of(num)?; + if let Some(last) = self.labels.get(&(abs.id, level.min(8))) { + return last.label.clone(); + } + // A deeper item can count a level implicitly without rendering a paragraph there. + let def = numbering.level(num, level.min(8))?; + if matches!(def.format, NumFormat::None | NumFormat::Bullet) { + return None; + } + let vals = self.state.get(&abs.id).copied().unwrap_or([0; 9]); + let started = self.flags.get(&abs.id).copied().unwrap_or_default(); + Some(render_label(numbering, num, def, &vals, &started)) + } + + /// Levels shown by the last rendered label, or the current definition for an implicit level. + pub fn current_template_levels(&self, numbering: &Numbering, num: u32, level: u8) -> Vec { + if let Some(abs) = numbering.abstract_of(num) + && let Some(last) = self.labels.get(&(abs.id, level.min(8))) + { + return last.levels.clone(); + } + numbering.level(num, level.min(8)).map(|def| template_levels(&def.text)).unwrap_or_default() + } +} + +/// The zero-based levels a label template shows (`"%1.%2"` → `[0, 1]`, `"(%3)"` → `[2]`). +pub fn template_levels(text: &str) -> Vec { + let mut out = Vec::new(); + let mut chars = text.chars().take(MAX_LEVEL_TEXT).peekable(); + while let Some(c) = chars.next() { + if c == '%' + && let Some(d) = chars.peek().and_then(|d| d.to_digit(10)) + { + chars.next(); + let k = (d as usize).saturating_sub(1).min(8); + if !out.contains(&k) { + out.push(k); + } + } + } + out +} + +/// Render a list label without advancing counters, retaining the existing hostile-input caps. +fn render_label(numbering: &Numbering, num: u32, def: &Level, vals: &[u32; 9], started: &[LevelFlags; 9]) -> String { + let level_def = |k: usize| numbering.level(num, k as u8); + let mut label = String::new(); + // Word's level text is short; .docx and the lists command already cap it at 64. + let mut chars = def.text.chars().take(MAX_LEVEL_TEXT).peekable(); + while let Some(c) = chars.next() { + if c == '%' + && let Some(d) = chars.peek().and_then(|d| d.to_digit(10)) + { + chars.next(); + let k = (d as usize).saturating_sub(1).min(8); + let val = vals.get(k).copied().unwrap_or(0); + let counted = started.get(k).is_some_and(|f| f.started); + let val = if counted { val } else { level_def(k).map(|l| l.start).unwrap_or(1) }; + // Legal numbering (w:isLgl) shows every level in Arabic digits, whatever its own + // format (二 of a Chinese outline becomes 2 in "2.1"). + let fmt = match level_def(k).map(|l| l.format).unwrap_or(NumFormat::Decimal) { + NumFormat::DecimalZero => NumFormat::DecimalZero, + _ if def.legal => NumFormat::Decimal, + f => f, + }; + label.push_str(&fmt.format(val)); + if label.len() > MAX_LABEL_BYTES { + break; + } + } else { + label.push(c); + } + } + label } /// Longest level text (in characters) expanded into a list label. @@ -413,6 +481,45 @@ const MAX_LABEL_BYTES: usize = 256; mod tests { use super::*; + /// Read-only counter APIs retain the renderer's bounds and never advance a list. + #[test] + fn reference_labels_are_bounded_and_do_not_advance_counters() { + let mut n = Numbering::default(); + let id = n.add_list(ListKind::Numbered); + if let Some(num) = n.nums.iter_mut().find(|x| x.id == id) { + num.level_overrides = vec![(0, Level { text: "%1".repeat(30_000), ..Level::default() })]; + } + let mut c = Counters::default(); + let label = c.next_label(&n, id, 0).unwrap().0; + let before = c.values(&n, id); + assert_eq!(c.current_label(&n, id, 0).as_deref(), Some(label.as_str())); + assert_eq!(c.values(&n, id), before); + assert!(label.len() <= 512); + assert_eq!(template_levels(&"%1%9".repeat(30_000)), [0, 8]); + assert!(c.started(&n, id).unwrap()[0]); + } + + #[test] + fn last_ancestor_label_keeps_the_instance_that_rendered_it() { + let mut numbering = Numbering::default(); + let first = numbering.add_list(ListKind::Numbered); + numbering.abstracts[0].levels[0].text = "Clause %1.".into(); + let mut second = numbering.num(first).unwrap().clone(); + second.id = first + 1; + second.level_overrides = vec![ + (0, Level { text: "Part %1.%2.".into(), ..Level::default() }), + (1, Level { format: NumFormat::LowerLetter, text: "(%2)".into(), ..Level::default() }), + ]; + let second_id = second.id; + numbering.nums.push(second); + let mut counters = Counters::default(); + assert_eq!(counters.next_label(&numbering, first, 0).unwrap().0, "Clause 1."); + assert_eq!(counters.next_label(&numbering, second_id, 1).unwrap().0, "(a)"); + assert_eq!(counters.current_label(&numbering, second_id, 0).as_deref(), Some("Clause 1.")); + assert_eq!(counters.current_template_levels(&numbering, second_id, 0), vec![0]); + assert_eq!(counters.started(&numbering, second_id).unwrap()[..2], [true, true]); + } + #[test] fn a_huge_level_text_gives_a_bounded_label() { let mut n = Numbering::default(); diff --git a/crates/engine/src/cmd/references.rs b/crates/engine/src/cmd/references.rs index ae949fa4d2..0cfeda45a4 100644 --- a/crates/engine/src/cmd/references.rs +++ b/crates/engine/src/cmd/references.rs @@ -12,6 +12,7 @@ use crate::{CmdError, CmdResult, CommandSpec, Selection, Session, p}; mod fields; mod notes; +mod numbers; mod properties; mod toc; diff --git a/crates/engine/src/cmd/references/fields.rs b/crates/engine/src/cmd/references/fields.rs index 0575be9f58..238cf553b3 100644 --- a/crates/engine/src/cmd/references/fields.rs +++ b/crates/engine/src/cmd/references/fields.rs @@ -1,3 +1,4 @@ +use super::numbers::{body_bookmark_paths, para_numbers, ref_number}; use super::properties::{ bookmark_ends_in_its_paragraph, bookmark_text, bookmark_text_at, count_text, date_picture, doc_property, doc_property_arg, new_property_value, set_summary_property, summary_property, text_result, @@ -335,6 +336,9 @@ pub fn update_fields_in(s: &mut Session, all: bool) -> Result<(), CmdError> { // The document properties as the fields read and set them (`SUBJECT "New subject"`): a field // after one that sets a property shows the new value. let mut core = s.doc.core.clone(); + // Build each body lookup once, only when a supported numeric REF needs it. + let mut numbers = None; + let mut bookmark_paths = None; let paths: Vec<(StoryRef, Path)> = stories.into_iter().flat_map(|st| s.doc.para_paths(st).into_iter().map(move |p| (st, p))).collect(); // SET "" (ECMA-376 §17.16.5.58): the values it gives, which REF shows; a // REF before the SET shows the last value set, as Word's bookmark does after an update. @@ -374,6 +378,14 @@ pub fn update_fields_in(s: &mut Session, all: bool) -> Result<(), CmdError> { let r = if name == "REF" { if has_switch(instr, 'p') { None + } else if let Some(sw) = ['w', 'r', 'n'].into_iter().find(|c| has_switch(instr, *c)) { + if has_switch(instr, 'd') || has_switch(instr, 't') { + continue; // Preserve cached results for unsupported delimiter/text switches. + } + let numbers = numbers.get_or_insert_with(|| para_numbers(&s.doc)); + let from = (story == StoryRef::Body).then_some(&path); + let paths = bookmark_paths.get_or_insert_with(|| body_bookmark_paths(&s.doc)); + paths.get(target).and_then(|tp| ref_number(numbers, tp, from, sw)) } else { bookmark_text(&s.doc, target).or_else(|| { let key = target.to_lowercase(); diff --git a/crates/engine/src/cmd/references/numbers.rs b/crates/engine/src/cmd/references/numbers.rs new file mode 100644 index 0000000000..959430dd19 --- /dev/null +++ b/crates/engine/src/cmd/references/numbers.rs @@ -0,0 +1,135 @@ +//! Numbered REF results, adapted from @Alyosha-dot-shop's patch in #4533. + +use super::{Counters, NumFormat, Path, StoryRef}; + +/// What a numbered body paragraph shows: the counter value of each level down to its own, the +/// label each of those levels shows at that point (`["14.", "(a)"]` for 14(a)), and the levels +/// each label's template shows (`"%1.%2"` shows levels 0 and 1). +#[derive(Clone, Debug, Default)] +pub(super) struct ParaNumber { + /// Relative context is shared only within the same numbering instance. + list: u32, + values: Vec, + /// Whether each level has counted a paragraph yet: a level the list never used (an `(a)` item + /// with no clause above it in its list) shows no number in a reference. + started: Vec, + labels: Vec>, + shows: Vec>, +} + +/// Whether the body paragraph at `path` sits in a table cell merged into the one above +/// (`w:vMerge` continue), at any nesting depth. The layout shows nothing of such a cell, so its +/// paragraphs take no list number. +fn in_merged_cell(doc: &wordcraft_doc::Document, path: &Path) -> bool { + let p = &path.0; + let mut j = 0usize; + // [table, row, cell, block, row, cell, block, …]: a table at p[..=j], its row and cell next. + while j.saturating_add(3) < p.len() { + let (Some(tp), Some(&r), Some(&c)) = (p.get(..=j), p.get(j + 1), p.get(j + 2)) else { return false }; + let merged = doc + .table(StoryRef::Body, &Path(tp.to_vec())) + .and_then(|t| t.rows.get(r as usize)) + .and_then(|row| row.cells.get(c as usize)) + .is_some_and(|cell| cell.props.vmerge == wordcraft_doc::props::VMerge::Continue); + if merged { + return true; + } + j = j.saturating_add(3); + } + false +} + +/// Every numbered body paragraph's number, by path, walking the lists in document order as the +/// layout does (cells merged into the one above count nothing). Bullets have no number. +pub(super) fn para_numbers(doc: &wordcraft_doc::Document) -> std::collections::HashMap { + let mut counters = Counters::default(); + let mut out = std::collections::HashMap::new(); + for path in doc.para_paths(StoryRef::Body) { + if in_merged_cell(doc, &path) { + continue; + } + let Some(p) = doc.para(StoryRef::Body, &path) else { continue }; + let Some(n) = p.props.numbering.or_else(|| doc.styles.resolve_para(&p.props).numbering).filter(|n| n.num != 0) else { continue }; + let Some((_, def)) = counters.next_label(&doc.numbering, n.num, n.level) else { continue }; + if def.format == NumFormat::Bullet { + continue; + } + let level = usize::from(n.level.min(8)); + let values = counters.values(&doc.numbering, n.num).unwrap_or_default(); + let started = counters.started(&doc.numbering, n.num).unwrap_or_default(); + let mut num = ParaNumber { list: n.num, ..Default::default() }; + for k in 0..=level { + num.values.push(values.get(k).copied().unwrap_or(0)); + num.started.push(started.get(k).copied().unwrap_or(false)); + num.labels.push(counters.current_label(&doc.numbering, n.num, k as u8)); + num.shows.push(counters.current_template_levels(&doc.numbering, n.num, k as u8)); + } + out.insert(path, num); + } + out +} + +/// A paragraph number as a cross-reference shows it: without the trailing period ("14." → "14"), +/// keeping a closing bracket ("(a)"). +fn ref_part(label: &str) -> &str { + label.trim().trim_end_matches('.').trim_end() +} + +/// The number `REF \n`, `\r` or `\w` shows for the bookmarked paragraph `target` (ECMA-376 Part 1 +/// §17.16.5.51), as Word computes it: +/// - `\n` (no context): the paragraph's own label. +/// - `\w` (full context): the own label, with the label of each level above it put in front when +/// no label already in the result shows that level: under `%1.` / `%1.%2` / `(%3)`, clause (a) +/// of 1.1 is `1.1(a)`, not `1.1.1(a)`. +/// - `\r` (relative context): like `\w`, but leaving out the leading levels whose counters the +/// field's own paragraph (`from`) shares with the target, compared level by level within the same list. From inside clause 14, 14(a) is `(a)`; from clause 5 or an unnumbered paragraph it +/// is `14(a)`. Context already displayed by the own or a needed ancestor label stays. +/// +/// A level above the target that its list never used adds nothing (Word shows `(a)` for an item +/// whose list has no clause above it, not a made-up `1.1(a)`). `None` when the target paragraph +/// has no number. +pub(super) fn ref_number(numbers: &std::collections::HashMap, target: &Path, from: Option<&Path>, switch: char) -> Option { + let t = numbers.get(target)?; + let level = t.values.len().checked_sub(1)?; + let own = t.labels.get(level)?.as_deref()?; + let mut out = ref_part(own).to_string(); + if switch == 'n' { + return Some(out); + } + let used = |k: usize| t.started.get(k).copied().unwrap_or(false); + let first = match (switch, from.and_then(|p| numbers.get(p))) { + ('r', Some(f)) if f.list == t.list => { + (0..level).take_while(|&k| !used(k) || (f.values.get(k).is_some() && f.values.get(k) == t.values.get(k))).count() + } + _ => 0, + }; + // Relative context suppresses added ancestors, never text already rendered in a label. + // Word's measured legal-template cases retain 2.2.2 even when 2 or 2.2 is shared. + let mut shown = t.shows.get(level).cloned().unwrap_or_default(); + for k in (first..level).rev() { + if shown.contains(&k) || !used(k) { + continue; + } + if t.labels.get(k).is_some_and(Option::is_some) { + let prefix = ref_part(t.labels.get(k)?.as_deref()?); + // Without a delimiter, joining separate numeric labels would invent a number. + if prefix.chars().next_back().is_some_and(char::is_alphanumeric) && out.chars().next().is_some_and(char::is_alphanumeric) { + return None; + } + out.insert_str(0, prefix); + shown.extend(t.shows.get(k).into_iter().flatten().copied()); + } + } + Some(out) +} + +/// Index the first body paragraph for each bookmark name, retaining document-order lookup semantics. +pub(super) fn body_bookmark_paths(doc: &wordcraft_doc::Document) -> std::collections::HashMap { + let mut paths = std::collections::HashMap::new(); + for (name, pos) in doc.bookmarks() { + if pos.story == StoryRef::Body { + paths.entry(name).or_insert(pos.path); + } + } + paths +} diff --git a/crates/engine/tests/it/main.rs b/crates/engine/tests/it/main.rs index dd3deae7d2..322edc2d17 100644 --- a/crates/engine/tests/it/main.rs +++ b/crates/engine/tests/it/main.rs @@ -15,3 +15,5 @@ mod rtf_sections; #[cfg(not(target_arch = "wasm32"))] mod safe_save; mod three_column_headers; + +mod ref_paragraph_numbers; diff --git a/crates/engine/tests/it/ref_paragraph_numbers.rs b/crates/engine/tests/it/ref_paragraph_numbers.rs new file mode 100644 index 0000000000..e31a6be9b6 --- /dev/null +++ b/crates/engine/tests/it/ref_paragraph_numbers.rs @@ -0,0 +1,404 @@ +//! Synthetic numbered-reference regression adapted from the patch by @Alyosha-dot-shop in #4533. +//! Switch semantics: Microsoft MS-OI29500, Part 1 Section 17.16.5.51 (REF). +//! All OOXML packages and document text are constructed in memory; no external documents. + +use std::io::Write; + +use serde_json::json; +use wordcraft_doc::{InlineObject, StoryRef}; + +const W: &str = r#"xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships""#; + +/// Build an OOXML ZIP entirely in memory. +fn zip(entries: &[(&str, &str)]) -> Vec { + let mut zw = zip::ZipWriter::new(std::io::Cursor::new(Vec::new())); + for (name, body) in entries { + zw.start_file(*name, zip::write::SimpleFileOptions::default()).unwrap(); + zw.write_all(body.as_bytes()).unwrap(); + } + zw.finish().unwrap().into_inner() +} + +/// One synthetic numbering level. +fn lvl(ilvl: u8, fmt: &str, text: &str) -> String { + format!(r#""#) +} + +/// Five independent list schemes for context and restart coverage. +fn numbering() -> String { + let schemes: [&[(&str, &str)]; 5] = [ + &[("decimal", "%1."), ("decimal", "%1.%2"), ("lowerLetter", "(%3)")], + &[("decimal", "%1"), ("decimal", "%1.%2"), ("decimal", "%1.%2.%3")], + &[("decimal", "%1"), ("decimal", "%1.%2"), ("lowerLetter", "(%3)")], + &[("decimal", "%1."), ("lowerLetter", "(%2)")], + // Scheme 5: as scheme 1, a list of its own whose first two levels are never used. + &[("decimal", "%1."), ("decimal", "%1.%2"), ("lowerLetter", "(%3)")], + ]; + let mut out = format!(r#""#); + for (i, levels) in schemes.iter().enumerate() { + out.push_str(&format!(r#""#)); + for (k, (fmt, text)) in levels.iter().enumerate() { + out.push_str(&lvl(k as u8, fmt, text)); + } + out.push_str(""); + } + for i in 0..schemes.len() { + out.push_str(&format!(r#""#, i + 1)); + } + out + "" +} + +/// A paragraph, numbered `(numId, level)` or not, holding `content`. +fn para(num: Option<(u32, u8)>, content: &str) -> String { + let ppr = num.map(|(n, l)| format!(r#""#)).unwrap_or_default(); + format!("{ppr}{content}") +} + +/// One synthetic text run. +fn text(t: &str) -> String { + format!(r#"{t}"#) +} + +/// A bookmark surrounding a synthetic text run. +fn marked(name: &str, id: u32, t: &str) -> String { + format!(r#"{}"#, text(t)) +} + +/// A complex REF field with an intentionally stale result. +fn field(instr: &str, cached: &str) -> String { + format!( + concat!( + r#""#, + r#" {} "#, + r#""#, + r#"{}"#, + r#""#, + ), + instr, cached + ) +} + +/// Open a synthetic OOXML package through the real document reader. +fn open(body: &str) -> wordcraft_engine::Session { + let rels = r#""#; + let doc_rels = r#""#; + let doc = format!(r#"{body}"#); + let numbering = numbering(); + let bytes = + zip(&[("_rels/.rels", rels), ("word/_rels/document.xml.rels", doc_rels), ("word/document.xml", &doc), ("word/numbering.xml", &numbering)]); + wordcraft_engine::Session::new(wordcraft_engine::io::open_bytes("d.docx", &bytes).expect("opens")) +} + +/// Every body field, as (code, result), in document order. +fn fields(s: &wordcraft_engine::Session) -> Vec<(String, String)> { + let mut out = Vec::new(); + for path in s.doc.para_paths(StoryRef::Body) { + let Some(p) = s.doc.para(StoryRef::Body, &path) else { continue }; + for o in &p.objects { + if let InlineObject::Field { instr, result, .. } = o { + out.push((instr.trim().to_string(), result.clone())); + } + } + } + out +} + +/// Numeric REF switches replace cached values with list labels, while plain REF and position switches retain their behavior. +#[test] +fn ref_number_switches_show_the_paragraph_number_as_word_does() { + let body = [ + // Scheme 1: %1. / %1.%2 / (%3) — clause (a) of 1.1. + para(Some((1, 0)), &text("Definitions")), + para(Some((1, 1)), &text("Defined terms")), + para(Some((1, 2)), &marked("_RefA", 1, "Synthetic target alpha.")), + // Scheme 2: the stock chapter scheme %1 / %1.%2 / %1.%2.%3. + para(Some((2, 0)), &text("Chapter")), + para(Some((2, 1)), &text("Section")), + para(Some((2, 2)), &marked("_RefB", 2, "Point")), + // Scheme 3: %1 / %1.%2 / (%3). + para(Some((3, 0)), &text("Part")), + para(Some((3, 1)), &text("Part point")), + para(Some((3, 2)), &marked("_RefC", 3, "Sub-point")), + // Scheme 4: %1. / (%2), clauses and sub-clauses as in most contracts. + para(Some((4, 0)), &text("Hire")), + para(Some((4, 1)), &text("first")), + para(Some((4, 0)), &marked("_RefD", 4, "Payment")), + para(Some((4, 1)), &text("a")), + para(Some((4, 1)), &marked("_RefE", 5, "b")), + // 2(c), inside clause 2: relative references drop the shared clause number. + para(Some((4, 1)), &format!("{}{}{}", text("See "), field(r"REF _RefE \r \h", "STALE"), field(r"REF _RefD \r \h", "STALE"))), + para(Some((4, 0)), &text("Third")), + // 3(a), another clause: the full number. _RefF's list has no clauses above its items. + para(Some((4, 1)), &format!("{}{}", field(r"REF _RefE \r \h", "STALE"), field(r"REF _RefF \r \h", "STALE"))), + // Scheme 5 items in a table whose second row's cell is merged into the first: the empty + // item in the merged-away cell takes no number, so the next item is (b), not (c). + format!( + concat!( + r#""#, + r#"{}"#, + r#"{}"#, + ), + para(Some((5, 2)), &marked("_RefF", 6, "Target F")), + para(Some((5, 2)), ""), + ), + para(Some((5, 2)), &marked("_RefG", 7, "Target G")), + // An unnumbered paragraph. + para( + None, + &[ + field(r"REF _RefA \w \h", "STALE"), + field(r"REF _RefA \n \h", "STALE"), + field(r"REF _RefA \r \h", "STALE"), + field(r"REF _RefB \w \h", "STALE"), + field(r"REF _RefC \w \h", "STALE"), + field(r"REF _RefE \r \h", "STALE"), + field(r"REF _RefD \n \h", "STALE"), + field(r"REF _RefG \r \h", "STALE"), + // Unchanged: no number switch shows the text; \p (above/below) is left as it is. + field(r"REF _RefB \h", "STALE"), + field(r"REF _RefA \r \p", "KEEP"), + ] + .concat(), + ), + ] + .concat(); + let mut s = open(&body); + s.run("references.updateFields", &json!({"all": true})).expect("updates"); + let got: Vec<(String, String)> = fields(&s); + let want = [ + (r"REF _RefE \r \h", "(b)"), + (r"REF _RefD \r \h", "2"), + (r"REF _RefE \r \h", "2(b)"), + (r"REF _RefF \r \h", "(a)"), + (r"REF _RefA \w \h", "1.1(a)"), + (r"REF _RefA \n \h", "(a)"), + (r"REF _RefA \r \h", "1.1(a)"), + (r"REF _RefB \w \h", "1.1.1"), + (r"REF _RefC \w \h", "1.1(a)"), + (r"REF _RefE \r \h", "2(b)"), + (r"REF _RefD \n \h", "2"), + (r"REF _RefG \r \h", "(b)"), + (r"REF _RefB \h", "Point"), + (r"REF _RefA \r \p", "KEEP"), + ]; + let want: Vec<(String, String)> = want.iter().map(|(i, r)| (i.to_string(), r.to_string())).collect(); + assert_eq!(got, want); +} + +/// Word retains context already rendered by the target's own label for relative REF. +#[test] +fn relative_number_keeps_context_already_in_the_target_label() { + let body = [ + para(Some((2, 0)), &text("Root")), + para(Some((2, 1)), &text("First section")), + para(Some((2, 2)), &marked("_Target", 20, "Synthetic target")), + para(Some((2, 2)), &field(r"REF _Target \r", "STALE")), + para(Some((2, 1)), &text("Other section")), + para(Some((2, 2)), &field(r"REF _Target \r", "STALE")), + para(None, &field(r"REF _Target \w", "STALE")), + ] + .concat(); + let mut s = open(&body); + s.run("references.updateFields", &json!({"all": true})).unwrap(); + let got: Vec<_> = fields(&s).into_iter().map(|(_, r)| r).collect(); + assert_eq!(got, ["1.1.1", "1.1.1", "1.1.1"]); +} + +/// Cached values of unsupported switches, missing targets and locked fields are not replaced with paragraph text. +#[test] +fn unsupported_or_unresolvable_numeric_refs_preserve_their_cache() { + let body = [ + para(Some((1, 0)), &marked("_Root", 30, "Synthetic root")), + para( + None, + &[ + field(r"REF _Root \w \d /", "KEEP DELIMITER"), + field(r"REF _Root \n \t", "KEEP TEXT"), + field(r"REF _Root \r \p", "KEEP POSITION"), + field(r"REF _Missing \w", "KEEP MISSING"), + field(r"REF _Plain \n", "KEEP UNNUMBERED"), + field(r"REF _Root \n", "KEEP LOCKED").replace(r#"w:fldCharType="begin""#, r#"w:fldCharType="begin" w:fldLock="true""#), + ] + .concat(), + ), + para(None, &marked("_Plain", 31, "Synthetic unnumbered target")), + ] + .concat(); + let mut s = open(&body); + let before = fields(&s); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + assert_eq!(fields(&s), before); +} + +/// Updating, undoing and saving keep the field instructions and their numeric results intact. +#[test] +fn numeric_refs_survive_undo_redo_and_docx_round_trip() { + let body = [ + para(Some((4, 0)), &text("Root")), + para(Some((4, 1)), &marked("_Item", 40, "Synthetic item șțăîâ")), + para(None, &field(r"REF _Item \w \h", "STALE")), + ] + .concat(); + let mut s = open(&body); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + assert_eq!(fields(&s), [(r"REF _Item \w \h".into(), "1(a)".into())]); + s.run("edit.undo", &json!({})).unwrap(); + assert_eq!(fields(&s)[0].1, "STALE"); + s.run("edit.redo", &json!({})).unwrap(); + assert_eq!(fields(&s)[0].1, "1(a)"); + let bytes = wordcraft_docx::write(&s.doc).unwrap(); + let back = wordcraft_engine::Session::new(wordcraft_engine::io::open_bytes("roundtrip.docx", &bytes).unwrap()); + assert_eq!(fields(&back), fields(&s)); +} + +/// Context already displayed by a needed parent label is retained as Word measured it. +#[test] +fn relative_number_from_the_root_keeps_the_parents_rendered_context() { + let body = [ + para(Some((1, 0)), &field(r"REF _Target \r", "STALE")), + para(Some((1, 1)), &text("Synthetic section")), + para(Some((1, 2)), &marked("_Target", 50, "Synthetic target")), + ] + .concat(); + let mut s = open(&body); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + assert_eq!(fields(&s)[0].1, "1.1(a)"); +} + +/// A header can reference a body list without inheriting the body caret's relative context. +#[test] +fn numeric_refs_in_headers_use_the_body_target_number() { + use wordcraft_doc::{Paragraph, PartKind, para_block}; + let mut s = open(&[para(Some((4, 0)), &text("Synthetic root")), para(Some((4, 1)), &marked("_Target", 60, "Synthetic target"))].concat()); + let mut header = Paragraph::new(); + header + .insert_object( + 0, + InlineObject::Field { + instr: r"REF _Target \r \h".into(), + result: "STALE".into(), + locked: false, + dirty: false, + code: false, + form: String::new(), + }, + &Default::default(), + ) + .unwrap(); + let id = s.doc.add_part(PartKind::Header, vec![para_block(header)]); + s.doc.last_section.headers.default = Some(id); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + let p = s.doc.para(StoryRef::Part(id), &wordcraft_doc::Path::top(0)).unwrap(); + let InlineObject::Field { result, .. } = &p.objects[0] else { panic!() }; + assert_eq!(result, "1(a)"); +} + +/// Separate bare numeric level labels cannot be concatenated without inventing a delimiter. +#[test] +fn ambiguous_numeric_label_join_keeps_the_cached_full_context() { + let mut s = open( + &[ + para(Some((2, 0)), &text("Root")), + para(Some((2, 1)), &text("Section")), + para(Some((2, 2)), &marked("_Target", 70, "Synthetic target")), + para(None, &field(r"REF _Target \w", "1.1.1")), + para(None, &field(r"REF _Target \n", "STALE")), + ] + .concat(), + ); + let abs = std::sync::Arc::make_mut(&mut s.doc.numbering).abstracts.iter_mut().find(|a| a.id == 1).unwrap(); + abs.levels[1].text = "%2".into(); + abs.levels[2].text = "%3".into(); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + let got: Vec<_> = fields(&s).into_iter().map(|(_, s)| s).collect(); + assert_eq!(got, ["1.1.1", "1"]); +} + +/// Reusing the lookup keeps the first body bookmark even with duplicate names and many updates. +#[test] +fn repeated_numeric_refs_keep_the_first_body_bookmark() { + use wordcraft_doc::{PartKind, Path}; + let mut body = [ + para(Some((4, 0)), &marked("_Duplicate", 80, "First synthetic target")), + para(Some((4, 0)), &marked("_Duplicate", 81, "Second synthetic target")), + ] + .concat(); + for _ in 0..64 { + body.push_str(¶(None, &field(r"REF _Duplicate \w \h", "STALE"))); + } + body.push_str(¶(None, &field(r"REF _Duplicate \h", "STALE"))); + let mut s = open(&body); + assert_eq!(s.doc.bookmarks().iter().filter(|(name, _)| name == "_Duplicate").count(), 2); + // A same-named bookmark outside the body cannot replace the body target. + let header = open(¶(None, &marked("_Duplicate", 82, "Header synthetic target"))).doc.body[0].clone(); + let id = s.doc.add_part(PartKind::Header, vec![header]); + s.doc.last_section.headers.default = Some(id); + s.run("references.updateFields", &json!({"all": true})).unwrap(); + let got = fields(&s); + assert_eq!(got.len(), 65); + assert!(got[..64].iter().all(|(_, value)| value == "1")); + assert_eq!(got[64].1, "First synthetic target"); + assert_eq!(s.doc.bookmarks().iter().find(|(name, _)| name == "_Duplicate").unwrap().1.path, Path::top(0)); +} + +/// A target's instance must not invent a different label for its actual ancestor paragraph. +#[test] +fn full_context_keeps_the_actual_ancestor_instance_label() { + let mut s = open( + &[ + para(Some((1, 0)), &text("Synthetic ancestor")), + para(Some((6, 1)), &marked("_ActualAncestor", 80, "Synthetic child")), + para(None, &field(r"REF _ActualAncestor \w", "STALE")), + ] + .concat(), + ); + let numbering = std::sync::Arc::make_mut(&mut s.doc.numbering); + numbering.abstracts.iter_mut().find(|a| a.id == 0).unwrap().levels[0].text = "Clause %1.".into(); + let mut child = numbering.nums.iter().find(|n| n.id == 1).unwrap().clone(); + child.id = 6; + child.level_overrides = vec![ + (0, wordcraft_doc::numbering::Level { text: "Part %1.%2.".into(), ..Default::default() }), + (1, wordcraft_doc::numbering::Level { format: wordcraft_doc::section::NumFormat::LowerLetter, text: "(%2)".into(), ..Default::default() }), + ]; + numbering.nums.push(child); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + assert_eq!(fields(&s).into_iter().map(|(_, value)| value).collect::>(), ["Clause 1(a)"]); +} + +/// The six legal-list cases measured in Word for Windows by @pakiat: +/// https://github.com/storytold/wordcraft/pull/4609#issuecomment-6557062456 +#[test] +fn relative_refs_keep_the_legal_template_in_the_six_measured_contexts() { + let refs = || [field(r"REF _Leaf \r", "STALE"), field(r"REF _Mid \r", "STALE")].concat(); + let body = [ + para(Some((2, 0)), &text("Synthetic first root")), + para(Some((2, 0)), &refs()), + para(Some((2, 1)), &text("Synthetic first section")), + para(Some((2, 1)), &marked("_Mid", 90, "Synthetic target section")), + para(Some((2, 2)), &text("Synthetic first leaf")), + para(Some((2, 2)), &marked("_Leaf", 91, "Synthetic target leaf")), + para(Some((2, 2)), &refs()), + para(Some((2, 1)), &refs()), + ] + .concat(); + let mut s = open(&body); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + let got: Vec<_> = fields(&s).into_iter().map(|(_, r)| r).collect(); + assert_eq!(got, ["2.2.2", "2.2", "2.2.2", "2.2", "2.2.2", "2.2"]); +} + +/// Equal counter values in another list do not provide shared relative context. +#[test] +fn relative_context_is_not_shared_by_different_lists() { + let mut s = open( + &[ + para(Some((4, 0)), &text("Synthetic target root")), + para(Some((4, 1)), &marked("_OtherList", 92, "Synthetic target")), + para(Some((1, 0)), &text("Synthetic separate root")), + para(Some((1, 1)), &field(r"REF _OtherList \r", "STALE")), + ] + .concat(), + ); + s.run("references.updateFields", &json!({"all":true})).unwrap(); + assert_eq!(fields(&s)[0].1, "1(a)"); +} diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index 09f836b0ee..5c8fc85609 100644 --- a/docs/file-format-parity.md +++ b/docs/file-format-parity.md @@ -297,6 +297,8 @@ Table rows and cells inside `mc:AlternateContent` use the same selected-branch p | Date | Change | Summary | |---|---|---| +| 2026-11-04 | trivial | REF context update: 2026-11-04 · #4609 retains the label and template actually rendered by an ancestor list instance; implicitly counted levels remain distinct from explicitly rendered paragraphs. Synthetic instance-override and field-update regressions; no new native Word qualification or readiness change. | +| 2026-11-04 | trivial | PR #4609: relative REF keeps context already displayed by the own or a needed ancestor label; six synthetic legal-template cases and separate-list context follow the Word for Windows measurements reported by @pakiat in PR discussion. Existing unknown-switch/cache boundaries and readiness estimates unchanged; no new native Word run. | | 2026-11-04 | trivial | Picture brightness, contrast and transparency: DrawingML `a:lum` and `a:alphaModFix`, VML `gain`/`blacklevel` (Washout watermarks) read, drawn on screen and in PDF as Word does (PDF test reads the embedded pixels back), and written as DrawingML; Word 2003 XML writes brightness and contrast as `gain`/`blacklevel` (#1711, #1766) | | 2026-11-02 | trivial | ODT form controls: one hanging from the baseline (as LibreOffice places those it makes) was saved with no placement, which LibreOffice puts at the line's top; its place on the line is kept (`ContentControl::form_raise`) and written, standing on the baseline when it had none. A multi-line text field was saved without LibreOffice's `MultiLine` property, so it showed one centred line; it says so, and text fields have LibreOffice's flat border. ODT custom shapes: a shape drawn from its own geometry was saved as WordCraft's path of it, and a preset WordCraft draws as a rectangle (a cloud) as a rectangle; the geometry as read (type, path, equations, handles) is kept (`ShapeExtra::odf_geometry`) and written back, mirrored as the shape is now, until the shape is made another kind. The forms document round-trips pixel-identical (from 2,949), the shape presets to 1,220 (from 2,467; what's left is LibreOffice's hairline outline, which WordCraft keeps as 0.5 pt) (`forms::controls_keep_their_place_on_the_line_and_a_text_area_its_lines`, `custom_geometry::a_custom_shapes_geometry_is_written_back_as_it_was_read`, `engine::tests::changing_a_shape_drops_the_geometry_kept_from_a_file`) | | 2026-11-02 | trivial | ODT, found with LibreOffice's style templates: an in-line frame placed against the text (`style:vertical-rel="text"` or `"char"`: `middle`, `top`, `bottom`) stood on the baseline; it's raised or lowered against the text's height from its size (measured in LibreOffice: `middle` centres it on the text). An in-line picture or chart was saved with no placement, which LibreOffice puts at the line's top (measured); it's saved standing on the baseline, as WordCraft and Word show it. Two templates round-trip with a third to a half of their difference (`floats::an_inline_frame_placed_against_the_text_is_raised_from_its_size`, `floats::an_inline_picture_is_saved_standing_on_the_baseline`). Left in them: template instantiation (LibreOffice refreshes a template's fixed dates and fills its sender fields from the user's data when opening it), a first-page footer's frame placed against the page content, and a page background picture centred in the margins rather than on the page | @@ -617,3 +619,5 @@ Table rows and cells inside `mc:AlternateContent` use the same selected-branch p | 2026-10-28 | trivial | RTF import: pictures stored as Windows Metafiles (`\wmetafile`) or Enhanced Metafiles (`\emfblip`) are kept as WMF/EMF media instead of dropped, and RTF export writes WMF/EMF pictures back as `\wmetafile8`/`\emfblip` instead of dropping them (`rtf::tests::metafile_pictures_are_imported`, #4259) | | 2026-11-01 | trivial | Markdown export: a list inside a block quote keeps its `>` marker on every line (nested levels and continuation lines included), so the list no longer moves out of the quote when the document is saved as Markdown, also after a .docx round trip | | 2026-11-03 | trivial | Opening a password-protected file named on the command line shows the Password box also when a chosen region replaced the first blank document (the window followed the replacement only on the first frame, which dropped the box, #5299) | +| 2026-10-27 | trivial | 2026-10-27 · #4533 review: numeric REF updates lazily index body bookmarks once per update, retaining the first body bookmark for duplicate names. Unsupported switches and ordinary REF/PAGEREF behavior are unchanged; a synthetic 64-reference regression covers repeated updates and duplicate names. Estimates unchanged. | +| 2026-10-27 | trivial | 2026-10-27 · #4533: numeric REF fields use paragraph list numbers for no/full/relative context, reusing bounded numbering. Shared context already embedded in a level label is removed; merged-away cells do not count. Unsupported separator/text/position switches and ambiguous contexts or delimiter-free joins retain cached results. Synthetic OOXML regressions; no native Word or real-document validation, estimates unchanged. | diff --git a/docs/gaps.md b/docs/gaps.md index cbb76c76b9..d1ea35ebc2 100644 --- a/docs/gaps.md +++ b/docs/gaps.md @@ -165,6 +165,7 @@ Table rows and cells inside `mc:AlternateContent` use the same selected-branch p | 2026-10-28 | trivial | Ink page lookups reuse scanned paragraph prefixes, #3614. Drawing order, geometry and saved data retain their behavior; no readiness estimate change | | 2026-11-04 | trivial | #19: ODT settings for what the standard leaves open removed: one choice for each case | | 2026-11-04 | trivial | #19: ODT element audit; files from other applications checked | +| 2026-11-04 | trivial | PR #4609: relative REF keeps context already displayed by the own or a needed ancestor label; six synthetic legal-template cases and separate-list context follow the Word for Windows measurements reported by @pakiat in PR discussion. Existing unknown-switch/cache boundaries and readiness estimates unchanged; no new native Word run. | | 2026-11-01 | trivial | #19 narrowed: ODT read and written nearly whole on this branch (styles, tables, notes, comments, tracked changes including formatting, fields, indexes and marks, drawings, charts, embedded objects, forms, ruby, password protection, flat ODT), checked against LibreOffice; what's left listed; estimate 18–27 h → 10–16 h | | 2026-11-01 | trivial | #10 narrowed: text in a turned text box is drawn turned with it on screen and in PNG and PDF (upside down when flipped across, never mirrored); editing it still goes by its upright text; estimate unchanged | | 2026-10-29 | trivial | Print Markup balloon anchor discovery no longer repeats paragraph-prefix scans (#3614); readiness estimates unchanged | @@ -420,6 +421,8 @@ Table rows and cells inside `mc:AlternateContent` use the same selected-branch p | 2026-10-29 | trivial | #15 narrowed: a Word bibliography source with a corporate author keeps it (read, saved, cited and listed whole), and Create Source has the Corporate Author box (#4848) | | 2026-10-29 | trivial | Table Properties: row, column and cell settings apply to the selected rows, columns and cells, not only the caret's (#4857); no gap entry tracked it | | 2026-10-28 | trivial | Gap 19 narrowed: RTF reads and writes WMF and EMF pictures, chosen by their bytes (#4259); ranking unchanged | +| 2026-10-27 | trivial | 2026-10-27 · #4533 review: numeric REF updates lazily index body bookmarks once per update, retaining the first body bookmark for duplicate names. Unsupported switches and ordinary REF/PAGEREF behavior are unchanged; a synthetic 64-reference regression covers repeated updates and duplicate names. Estimates unchanged. | +| 2026-10-27 | trivial | 2026-10-27 · #4533: numeric REF fields use paragraph list numbers for no/full/relative context, reusing bounded numbering. Shared context already embedded in a level label is removed; merged-away cells do not count. Unsupported separator/text/position switches and ambiguous contexts or delimiter-free joins retain cached results. Synthetic OOXML regressions; no native Word or real-document validation, estimates unchanged. | ## Layout validation fonts diff --git a/docs/layout-parity.md b/docs/layout-parity.md index b8e55b9b1d..686ce58999 100644 --- a/docs/layout-parity.md +++ b/docs/layout-parity.md @@ -283,6 +283,7 @@ layout suite are pending; this is not a new Word/native-IME acceptance claim. | Date | Change | Summary | |---|---|---| +| 2026-11-04 | trivial | PR #4609: relative REF keeps context already displayed by the own or a needed ancestor label; six synthetic legal-template cases and separate-list context follow the Word for Windows measurements reported by @pakiat in PR discussion. Existing unknown-switch/cache boundaries and readiness estimates unchanged; no new native Word run. | | 2026-11-01 | trivial | SEQ fields in text boxes are numbered where their boxes are anchored, in output and after F9, and a REF finds a bookmark in a text box | | 2026-11-01 | trivial | SEQ, STYLEREF and REF fields show fresh results in output; readiness estimates unchanged | | 2026-10-29 | trivial | Print Markup balloon anchor discovery walks paragraph objects once (#3614); readiness estimates unchanged | @@ -324,6 +325,8 @@ layout suite are pending; this is not a new Word/native-IME acceptance claim. | 2026-10-23 | trivial | Continuous sections running off a page go onto the next; empty marks after a section mark take a line until the page is full, measured in Word (#3907) | | 2026-10-27 | trivial | Empty marks past the page bottom draw nothing, not even a list label; an empty mark after a text paragraph closing a section stays quiet and, like any mark taking no room, draws no bullet (#3907 review) | | 2026-10-27 | trivial | A kept-together paragraph in a continuous section is measured against the next page's body, so a tall different first-page header no longer splits one that fits on page 2 (#3907 CodeRabbit) | +| 2026-10-27 | trivial | 2026-10-27 · #4533 review: numeric REF updates lazily index body bookmarks once per update, retaining the first body bookmark for duplicate names. Unsupported switches and ordinary REF/PAGEREF behavior are unchanged; a synthetic 64-reference regression covers repeated updates and duplicate names. Estimates unchanged. | +| 2026-10-27 | trivial | 2026-10-27 · #4533: numeric REF fields use paragraph list numbers for no/full/relative context, reusing bounded numbering. Shared context already embedded in a level label is removed; merged-away cells do not count. Unsupported separator/text/position switches and ambiguous contexts or delimiter-free joins retain cached results. Synthetic OOXML regressions; no native Word or real-document validation, estimates unchanged. | | 2026-10-20 | trivial | A click below a floating table, outside its cells, goes to the paragraph beside or after it instead of a cell of its last row, as checked in Word (#2038) | | 2026-10-19 | trivial | A right, centre or decimal tab whose text doesn't fit, or a left tab past the right indent, starts the next line with its text instead of ending the line (a TOC entry's page number keeps its leader); a left tab still past the right indent there takes no room (#1840) | | 2026-10-19 | trivial | Justified lines (compatibility mode 15) shrink their spaces to fit one more word by at most a quarter of the spaces' width (was a fifth) and by at most 0.355 of that word's own width with the space before it. Measured in Word for Mac with synthetic justified paragraphs: words of 2.7 to 80 pt, spaces of 3.3 and 6.7 pt, only justified text, last lines included, never in modes 12 and 14. A real paper's justified abstract now breaks like Word on all 23 lines (3 before); on 180 real-world papers, page counts matching Word went from 139 to 142, none further | From 94cbdeb4cba9daa607f59cef9b8905cb52a9e91c Mon Sep 17 00:00:00 2001 From: NetterSilver <133535268+Silvertree2010@users.noreply.github.com> Date: Thu, 5 Nov 2026 09:13:57 +0100 Subject: [PATCH 05/34] Keep wgpu indirect validation for x86_64 builds on Apple silicon (#5244) Fixes #5199 Co-authored-by: Claude Opus 5.5 --- apps/wordcraft/src/graphics.rs | 53 ++++++++++++++++++++++++++++++++-- apps/wordcraft/src/main.rs | 3 +- 2 files changed, 52 insertions(+), 4 deletions(-) diff --git a/apps/wordcraft/src/graphics.rs b/apps/wordcraft/src/graphics.rs index 0edd57666f..c05df03de7 100644 --- a/apps/wordcraft/src/graphics.rs +++ b/apps/wordcraft/src/graphics.rs @@ -15,9 +15,25 @@ use eframe::{ /// compiler aborts on them, the device is lost and eframe exits before the window opens. WordCraft /// issues no indirect draws or dispatches, so Intel Macs skip them; every other GPU keeps wgpu's /// default. Same fix as PhotoCraft's storytold/PhotoCraft#3171. +/// +/// `x86_64` is the build's architecture. An x86_64 build also runs on Apple silicon under Rosetta +/// (#5199), so it skips only when the machine itself isn't Apple silicon. #[cfg_attr(not(target_os = "macos"), allow(dead_code))] -pub fn skips_indirect_validation(macos: bool, intel: bool) -> bool { - macos && intel +pub fn skips_indirect_validation(macos: bool, x86_64: bool) -> bool { + // Short-circuits: only x86_64 macOS builds ask the system. + macos && x86_64 && !runs_on_apple_silicon() +} + +/// Whether the machine is Apple silicon, also when this process is translated by Rosetta: +/// `hw.optional.arm64` describes the hardware, not the process. Assumes not (an Intel Mac) when +/// the system can't tell. +#[cfg_attr(not(target_os = "macos"), allow(dead_code))] +fn runs_on_apple_silicon() -> bool { + cfg!(target_os = "macos") + && std::process::Command::new("/usr/sbin/sysctl") + .args(["-n", "hw.optional.arm64"]) + .output() + .is_ok_and(|out| out.status.success() && out.stdout.trim_ascii() == b"1") } /// Leaves wgpu's indirect-call validation out of the instance eframe creates when `skip`. @@ -181,7 +197,8 @@ mod tests { #[test] fn intel_macs_skip_the_indirect_validation_shaders() { // #2652: Metal's Intel compiler aborted on them, losing the device before the window opened. - assert!(skips_indirect_validation(true, true)); + // An x86_64 build on Apple silicon (Rosetta) isn't an Intel Mac (#5199). + assert_eq!(skips_indirect_validation(true, true), !host_is_apple_silicon()); // Apple silicon, Windows and Linux keep wgpu's validation. for (macos, intel) in [(true, false), (false, true), (false, false)] { assert!(!skips_indirect_validation(macos, intel), "macos={macos} intel={intel}"); @@ -205,6 +222,36 @@ mod tests { } } + /// Whether the machine running the tests is Apple silicon, whatever this build's architecture. + fn host_is_apple_silicon() -> bool { + cfg!(target_os = "macos") + && std::process::Command::new("/usr/sbin/sysctl") + .args(["-n", "hw.optional.arm64"]) + .output() + .is_ok_and(|out| out.status.success() && out.stdout.trim_ascii() == b"1") + } + + /// #5199: an x86_64 build running under Rosetta on Apple silicon isn't an Intel Mac and keeps + /// wgpu's indirect-call validation. + #[test] + fn x86_64_builds_on_apple_silicon_keep_indirect_validation() { + if !host_is_apple_silicon() { + return; + } + // What main.rs passes from an x86_64 build. + assert!(!skips_indirect_validation(true, true), "Rosetta build on Apple silicon must keep validation"); + let mut options = NativeOptions::default(); + let WgpuSetup::CreateNew(before) = &options.wgpu_options.wgpu_setup else { + panic!("default native options must create a wgpu instance"); + }; + let before = before.instance_descriptor.flags; + configure_indirect_validation(&mut options, skips_indirect_validation(true, true)); + let WgpuSetup::CreateNew(create) = &options.wgpu_options.wgpu_setup else { + panic!("default native options must create a wgpu instance"); + }; + assert_eq!(create.instance_descriptor.flags, before, "indirect-call validation kept"); + } + fn configured_backends(backends: Backends) -> Backends { let mut options = NativeOptions::default(); configure_backends(&mut options, backends); diff --git a/apps/wordcraft/src/main.rs b/apps/wordcraft/src/main.rs index 6b723be720..ab4e5c57e7 100644 --- a/apps/wordcraft/src/main.rs +++ b/apps/wordcraft/src/main.rs @@ -486,7 +486,8 @@ fn main() -> eframe::Result { // FXC, which needs no DLL of ours (#603; see graphics.rs). #[cfg(target_os = "windows")] graphics::configure(&mut options, eframe::wgpu::Backends::from_env()); - // Intel Macs: Metal's compiler aborts on wgpu's indirect-validation shaders (#2652). + // Intel Macs: Metal's compiler aborts on wgpu's indirect-validation shaders (#2652). An x86_64 + // build under Rosetta on Apple silicon keeps them (#5199). #[cfg(target_os = "macos")] graphics::configure_indirect_validation(&mut options, graphics::skips_indirect_validation(true, cfg!(target_arch = "x86_64"))); load_user_fonts(); From 12a840f6539dfd6b174b2163b9310bea3042b7aa Mon Sep 17 00:00:00 2001 From: Harrison Booth <73434116+Harrison-Booth@users.noreply.github.com> Date: Thu, 5 Nov 2026 02:14:03 -0600 Subject: [PATCH 06/34] Preserve section settings when saving DOCX (#5311) * DOCX: preserve section print and note settings * docs: record chapter style byte range * fix: accept XML integer syntax for tray codes * fix: preserve automatic footnote columns --- Cargo.lock | 1 + ROADMAP.md | 2 + crates/doc/src/section.rs | 50 ++++++++++++++ crates/docx/Cargo.toml | 1 + crates/docx/src/read/props.rs | 18 +++++ crates/docx/src/write/story/section.rs | 53 ++++++++++++--- crates/docx/tests/it/main.rs | 1 + .../tests/it/section_metadata_preservation.rs | 66 +++++++++++++++++++ docs/file-format-parity.md | 3 + docs/gaps.md | 2 + 10 files changed, 189 insertions(+), 8 deletions(-) create mode 100644 crates/docx/tests/it/section_metadata_preservation.rs diff --git a/Cargo.lock b/Cargo.lock index 666b2a033f..64ed59e285 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -6880,6 +6880,7 @@ dependencies = [ "log", "proptest", "quick-xml 0.41.0", + "serde_json", "sha1 0.11.0", "sha2 0.11.1", "thiserror 2.0.21", diff --git a/ROADMAP.md b/ROADMAP.md index d285bad32a..60c01c8cac 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -758,6 +758,8 @@ Imported Word 97–2003 `.doc`/`.dot` files now ask for a supported DOCX target Footer page-table height and body wrapping are corrected. Other pagination gaps remain open. +Section page-numbering settings preserve `w:chapStyle` values across the full unsigned-byte range. + ## Revision history > 2026-11-03 · Arabic dialogs read right to left (rtl::Table); recorded in the progress log, readiness unchanged. diff --git a/crates/doc/src/section.rs b/crates/doc/src/section.rs index 7541c35d02..1d72468f6f 100644 --- a/crates/doc/src/section.rs +++ b/crates/doc/src/section.rs @@ -115,6 +115,40 @@ pub enum NumFormat { DollarText, } +/// Chapter separator for page numbers (`w:chapSep`, ECMA-376 §17.18.12). +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub enum ChapterSep { + Hyphen, + Period, + Colon, + EmDash, + EnDash, +} + +impl ChapterSep { + pub fn from_ooxml(value: &str) -> Option { + match value { + "hyphen" => Some(Self::Hyphen), + "period" => Some(Self::Period), + "colon" => Some(Self::Colon), + "emDash" => Some(Self::EmDash), + "enDash" => Some(Self::EnDash), + _ => None, + } + } + + pub const fn ooxml(self) -> &'static str { + match self { + Self::Hyphen => "hyphen", + Self::Period => "period", + Self::Colon => "colon", + Self::EmDash => "emDash", + Self::EnDash => "enDash", + } + } +} + impl NumFormat { /// Every format, in the order ST_NumberFormat lists them (which is also the order of the /// binary .doc number format codes up to 0x27). @@ -749,6 +783,9 @@ pub struct SectionProps { pub title_page: bool, pub page_num_start: Option, pub page_num_format: NumFormat, + /// Chapter heading level and separator in `w:pgNumType`. + pub chapter_style: Option, + pub chapter_sep: Option, /// The file carries a `w:pgNumType` element that sets nothing else (no start, decimal /// format), so saving writes it back rather than dropping it. #[serde(skip_serializing_if = "std::ops::Not::not")] @@ -779,6 +816,13 @@ pub struct SectionProps { pub footnote_pr: NoteProps, #[serde(skip_serializing_if = "NoteProps::is_empty")] pub endnote_pr: NoteProps, + /// First-page and other-page printer trays (`w:paperSrc`). + pub paper_src_first: Option, + pub paper_src_other: Option, + /// Section-specific suppression of endnotes (`w:noEndnote`). + pub no_endnote: Option, + /// Independent footnote column count (`w15:footnoteColumns`). + pub footnote_columns: Option, /// Whether its columns end balanced (an ODF section's `text:dont-balance-text-columns`): /// `None` is Word's rule, balanced when a continuous section follows; `Some(true)` also at /// the end of the document, `Some(false)` never. @@ -809,6 +853,8 @@ impl Default for SectionProps { title_page: false, page_num_start: None, page_num_format: NumFormat::Decimal, + chapter_style: None, + chapter_sep: None, page_num_set: false, line_numbers: None, valign: PageVAlign::Top, @@ -821,6 +867,10 @@ impl Default for SectionProps { doc_grid: None, footnote_pr: NoteProps::default(), endnote_pr: NoteProps::default(), + paper_src_first: None, + paper_src_other: None, + no_endnote: None, + footnote_columns: None, balance_columns: None, } } diff --git a/crates/docx/Cargo.toml b/crates/docx/Cargo.toml index 5e16d7e4c2..6f7f1b3860 100644 --- a/crates/docx/Cargo.toml +++ b/crates/docx/Cargo.toml @@ -32,6 +32,7 @@ getrandom = { workspace = true, features = ["wasm_js"] } [dev-dependencies] wordcraft-doc = { workspace = true, features = ["test-support"] } +serde_json = { workspace = true } proptest = { workspace = true } image = { workspace = true } zip = { workspace = true } diff --git a/crates/docx/src/read/props.rs b/crates/docx/src/read/props.rs index 5aa683f9c0..12a15dad10 100644 --- a/crates/docx/src/read/props.rs +++ b/crates/docx/src/read/props.rs @@ -763,8 +763,26 @@ pub fn sectpr(pc: &PropCtx, e: &El) -> (SectionProps, Vec) { if let Some(f) = k.attr("w:fmt") { s.page_num_format = NumFormat::from_ooxml(f); } + s.chapter_style = k.attr("w:chapStyle").and_then(u32_of).filter(|v| *v <= u8::MAX as u32).map(|v| v as u8); + s.chapter_sep = k.attr("w:chapSep").and_then(wordcraft_doc::section::ChapterSep::from_ooxml); s.page_num_set = s.page_num_start.is_none() && s.page_num_format == NumFormat::Decimal; } + "w:paperSrc" => { + let tray = |name| { + let value = k.attr(name)?.trim(); + let digits = value.strip_prefix('+').unwrap_or(value); + if digits.is_empty() || !digits.bytes().all(|b| b.is_ascii_digit()) { + return None; + } + u32_of(digits).filter(|v| *v <= u16::MAX as u32).map(|v| v as u16) + }; + s.paper_src_first = tray("w:first"); + s.paper_src_other = tray("w:other"); + } + "w:noEndnote" => s.no_endnote = Some(on_off(k)), + "w15:footnoteColumns" => { + s.footnote_columns = k.attr("w:val").and_then(u32_of).filter(|v| (1..=45).contains(v)); + } "w:lnNumType" => { let mut l = LineNumbering::default(); if let Some(v) = k.attr("w:countBy").and_then(u32_of) { diff --git a/crates/docx/src/write/story/section.rs b/crates/docx/src/write/story/section.rs index e9712ddcc5..f08377ba72 100644 --- a/crates/docx/src/write/story/section.rs +++ b/crates/docx/src/write/story/section.rs @@ -87,6 +87,7 @@ fn sectpr_body(w: &mut W, s: &SectionProps) { ("w:gutter", &twips(s.gutter.max(0.0))), ], ); + paper_source(w, s); if let Some(b) = &s.page_borders { borders(w, "w:pgBorders", b, None, &[("w:offsetFrom", "text")]); } @@ -107,14 +108,7 @@ fn sectpr_body(w: &mut W, s: &SectionProps) { let refs: Vec<(&str, &str)> = a.iter().map(|(k, v)| (*k, v.as_str())).collect(); w.empty("w:lnNumType", &refs); } - if s.page_num_set || s.page_num_start.is_some() || s.page_num_format != wordcraft_doc::section::NumFormat::Decimal { - let mut a = vec![("w:fmt", s.page_num_format.ooxml().to_string())]; - if let Some(st) = s.page_num_start { - a.push(("w:start", st.to_string())); - } - let refs: Vec<(&str, &str)> = a.iter().map(|(k, v)| (*k, v.as_str())).collect(); - w.empty("w:pgNumType", &refs); - } + page_number_type(w, s); let c = &s.columns; let count = c.count.clamp(1, 45); let mut ca = vec![("w:space", twips(c.space.max(0.0))), ("w:num", n(count as i64))]; @@ -134,6 +128,9 @@ fn sectpr_body(w: &mut W, s: &SectionProps) { let refs: Vec<(&str, &str)> = ca.iter().map(|(k, v)| (*k, v.as_str())).collect(); w.empty("w:cols", &refs); } + if let Some(count) = s.footnote_columns.filter(|count| *count > 0) { + w.empty("w15:footnoteColumns", &[("w:val", &count.clamp(1, 45).to_string())]); + } if let Some(on) = s.form_prot { w.empty("w:formProt", if on { &[] } else { &[("w:val", "0")] }); } @@ -143,6 +140,9 @@ fn sectpr_body(w: &mut W, s: &SectionProps) { wordcraft_doc::section::PageVAlign::Justify => w.val("w:vAlign", "both"), wordcraft_doc::section::PageVAlign::Bottom => w.val("w:vAlign", "bottom"), } + if let Some(on) = s.no_endnote { + w.empty("w:noEndnote", if on { &[] } else { &[("w:val", "0")] }); + } if s.title_page { w.empty("w:titlePg", &[]); } @@ -167,6 +167,43 @@ fn sectpr_body(w: &mut W, s: &SectionProps) { } } +fn paper_source(w: &mut W, s: &SectionProps) { + let mut attrs = Vec::new(); + if let Some(first) = s.paper_src_first { + attrs.push(("w:first", first.to_string())); + } + if let Some(other) = s.paper_src_other { + attrs.push(("w:other", other.to_string())); + } + if !attrs.is_empty() { + let refs: Vec<(&str, &str)> = attrs.iter().map(|(k, v)| (*k, v.as_str())).collect(); + w.empty("w:paperSrc", &refs); + } +} + +fn page_number_type(w: &mut W, s: &SectionProps) { + if !(s.page_num_set + || s.page_num_start.is_some() + || s.page_num_format != wordcraft_doc::section::NumFormat::Decimal + || s.chapter_style.is_some() + || s.chapter_sep.is_some()) + { + return; + } + let mut attrs = vec![("w:fmt", s.page_num_format.ooxml().to_string())]; + if let Some(start) = s.page_num_start { + attrs.push(("w:start", start.to_string())); + } + if let Some(style) = s.chapter_style { + attrs.push(("w:chapStyle", style.to_string())); + } + if let Some(separator) = s.chapter_sep { + attrs.push(("w:chapSep", separator.ooxml().to_string())); + } + let refs: Vec<(&str, &str)> = attrs.iter().map(|(k, v)| (*k, v.as_str())).collect(); + w.empty("w:pgNumType", &refs); +} + /// The children of a `w:footnotePr` / `w:endnotePr` in schema order (`w:pos`, `w:numFmt`, /// `w:numStart`, `w:numRestart`; ECMA-376 §17.11.11), for the fields that are set. pub(in super::super) fn note_pr_inner(w: &mut W, pr: &NoteProps) { diff --git a/crates/docx/tests/it/main.rs b/crates/docx/tests/it/main.rs index b6c60dcce3..e54afbd5f5 100644 --- a/crates/docx/tests/it/main.rs +++ b/crates/docx/tests/it/main.rs @@ -29,6 +29,7 @@ mod roundtrip; mod row_property_exceptions; mod run_props; mod section_form_protection; +mod section_metadata_preservation; mod section_page_number_type; mod section_text_direction; mod section_valign; diff --git a/crates/docx/tests/it/section_metadata_preservation.rs b/crates/docx/tests/it/section_metadata_preservation.rs new file mode 100644 index 0000000000..c3b10fe8c8 --- /dev/null +++ b/crates/docx/tests/it/section_metadata_preservation.rs @@ -0,0 +1,66 @@ +//! Section printer, note and chapter-number metadata survives DOCX and native JSON saves. + +use std::io::{Read, Write}; + +fn docx(body: &str) -> Vec { + let root = r#""#; + let doc = format!( + r#"{body}"# + ); + let mut zw = zip::ZipWriter::new(std::io::Cursor::new(Vec::new())); + for (name, bytes) in [("_rels/.rels", root.as_bytes()), ("word/document.xml", doc.as_bytes())] { + zw.start_file(name, zip::write::SimpleFileOptions::default()).unwrap(); + zw.write_all(bytes).unwrap(); + } + zw.finish().unwrap().into_inner() +} + +fn document_xml(bytes: &[u8]) -> String { + let mut z = zip::ZipArchive::new(std::io::Cursor::new(bytes)).unwrap(); + let mut s = String::new(); + z.by_name("word/document.xml").unwrap().read_to_string(&mut s).unwrap(); + s +} + +#[test] +fn section_metadata_survives_native_json_and_two_docx_save_reopen_cycles() { + let input = docx( + r#"First sectionSecond section"#, + ); + let mut document = wordcraft_docx::read(&input).unwrap(); + let json = serde_json::to_vec(&document).unwrap(); + document = serde_json::from_slice(&json).unwrap(); + for cycle in 0..2 { + let bytes = wordcraft_docx::write(&document).unwrap(); + let xml = document_xml(&bytes); + assert!(xml.contains(r#""#), "cycle {cycle}: {xml}"); + assert!(xml.contains(r#""#), "cycle {cycle}: {xml}"); + assert!(xml.contains(""), "cycle {cycle}: {xml}"); + assert!(xml.contains(r#""#), "cycle {cycle}: {xml}"); + assert!(xml.contains(r#""#), "cycle {cycle}: {xml}"); + assert!(xml.contains(r#""#), "cycle {cycle}: {xml}"); + assert!(xml.contains(r#"w:chapStyle="1" w:chapSep="hyphen""#), "cycle {cycle}: {xml}"); + assert!(xml.contains(r#"w:chapStyle="10" w:chapSep="colon""#), "cycle {cycle}: {xml}"); + assert!(xml.contains("xmlns:w15=") && xml.contains("mc:Ignorable=\"w14 w15 wp14\""), "cycle {cycle}: {xml}"); + document = wordcraft_docx::read(&bytes).unwrap(); + let json = serde_json::to_vec(&document).unwrap(); + document = serde_json::from_slice(&json).unwrap(); + } +} + +#[test] +fn invalid_section_metadata_is_ignored_and_missing_values_stay_missing() { + let bytes = docx( + r#"Text"#, + ); + let mut d = wordcraft_docx::read(&bytes).unwrap(); + let xml = document_xml(&wordcraft_docx::write(&d).unwrap()); + assert!(!xml.contains("paperSrc"), "{xml}"); + assert!(!xml.contains("footnoteColumns"), "{xml}"); + assert!(!xml.contains("chapStyle") && !xml.contains("chapSep"), "{xml}"); + assert!(!xml.contains("noEndnote"), "{xml}"); + + d.last_section.footnote_columns = Some(0); + let xml = document_xml(&wordcraft_docx::write(&d).unwrap()); + assert!(!xml.contains("footnoteColumns"), "{xml}"); +} diff --git a/docs/file-format-parity.md b/docs/file-format-parity.md index 5c8fc85609..8f1df33cb5 100644 --- a/docs/file-format-parity.md +++ b/docs/file-format-parity.md @@ -289,6 +289,9 @@ Table rows and cells inside `mc:AlternateContent` use the same selected-branch p ## Revision history +> 2026-11-03 · Section `w:chapStyle` values preserve the full unsigned-byte range, including 10, while values above 255 are rejected. + +| 2026-10-30 | trivial | DOCX section metadata now preserves independent printer trays, section endnote suppression, chapter numbering settings, and footnote columns through native JSON and repeated save/reopen | > 2026-10-28 · Charts and SmartArt: text the font lacks (Chinese axis labels and legends) is drawn in a fallback face instead of boxes, one face per run as in body text (#4720, `layout::tests::chart_text_the_font_lacks_is_drawn_in_a_fallback_face`). > 2026-10-25 · Arabic list labels: `arabicAlpha` and `arabicAbjad` draw the 28 Arabic letters (alphabetical and abjad order), doubling past the last letter; Hebrew, Hindi, Thai and Vietnamese still show decimal (`doc::section::tests::arabic_letters_count_in_both_orders`). diff --git a/docs/gaps.md b/docs/gaps.md index d1ea35ebc2..b8f97f22c8 100644 --- a/docs/gaps.md +++ b/docs/gaps.md @@ -150,6 +150,8 @@ Table rows and cells inside `mc:AlternateContent` use the same selected-branch p ## Revision history +> 2026-11-03 · Section `w:chapStyle` values now preserve the complete unsigned-byte range, including 10; values above 255 are rejected. + > 2026-11-03 · Gap 11: the Arabic dialogs, tables and galleries read right to left (rtl::Table); readiness unchanged. > > 2026-10-27 · Technical synchronization: existing Proofing pane hooks and regression tests follow the extracted engine/UI modules on main `436d444`; compact context menus remain upstream. New-SHA validation is pending; readiness unchanged. From 475ca5420b41f7f924dbf55dddf21b747ac31236 Mon Sep 17 00:00:00 2001 From: Valentin Klein Date: Thu, 5 Nov 2026 09:14:16 +0100 Subject: [PATCH 07/34] Drop-down list button: pressing it no longer moves the caret out of the control (#5389) (#5485) * Content controls: a press on the drop-down list button no longer moves the caret (#5389) The list button hangs over whatever follows the control. The canvas put the caret under the pointer first, which left the control, and the list closed in the frame it opened. A press on the button now skips the caret move. Co-Authored-By: Claude Sonnet 5.5 * Content controls: only a press that began on the list button skips the caret move (#5389) Co-Authored-By: Claude Sonnet 5.5 * Content controls: a press and release in one frame, and a table tool, no longer hit the button guard (review points) CodeRabbit pointed out that egui clears press_origin when a press and its release arrive in the same frame, so the caret still moved off the control and closed the list; the press is now also read from the frame's events. It also pointed out that the guard ran before the table pen, so a stroke could not start over the button; the guard is skipped while a table tool is on. Co-Authored-By: Claude Sonnet 5.5 * Content controls: feed the same-frame press and release as one frame in the test Harness::event runs one frame per event, so the earlier version of the test did not exercise the single-frame case. Co-Authored-By: Claude Sonnet 5.5 --------- Co-authored-by: Claude Sonnet 5.5 --- crates/ui-egui/src/canvas.rs | 17 +++++ crates/ui-egui/src/content_controls.rs | 92 ++++++++++++++++++++++++++ 2 files changed, 109 insertions(+) diff --git a/crates/ui-egui/src/canvas.rs b/crates/ui-egui/src/canvas.rs index ae5fb46e3d..bbe4e60163 100644 --- a/crates/ui-egui/src/canvas.rs +++ b/crates/ui-egui/src/canvas.rs @@ -1085,6 +1085,23 @@ fn handle_primary_pointer( geo: &Geometry, middle_gesture: bool, ) { + // A press that began on a drop-down's list button opens the list (`content_controls::clicks`) and must + // not move the caret: the button hangs over what follows the control, and a caret placed + // there leaves the control, which closes the list in the frame it opens (#5389). + // A press and its release in one frame (a quick click on a slow frame) leave no `press_origin`; + // the press is still among the frame's events. A table tool owns the pointer instead: a stroke + // may start over the button. + let press = ui.input(|i| { + i.pointer.press_origin().or_else(|| { + i.events.iter().find_map(|e| match e { + egui::Event::PointerButton { pos, pressed: true, .. } => Some(*pos), + _ => None, + }) + }) + }); + if app.canvas.table_tool.is_none() && press.is_some_and(|p| app.controls.on_button(p)) { + return; + } // Double-click the space between two pages (or the line between them) to hide or show it. if resp.double_clicked() && app.session.view.mode == wordcraft_layout::ViewMode::Print diff --git a/crates/ui-egui/src/content_controls.rs b/crates/ui-egui/src/content_controls.rs index 6baa8fb7d3..33a5009cb4 100644 --- a/crates/ui-egui/src/content_controls.rs +++ b/crates/ui-egui/src/content_controls.rs @@ -30,6 +30,11 @@ impl ControlUi { pub(crate) fn popup_open(&self) -> bool { self.popup.is_some() } + + /// Whether `p` (screen) is on the list/calendar button of the current control. + pub(crate) fn on_button(&self, p: egui::Pos2) -> bool { + self.button.as_ref().is_some_and(|(b, _)| b.contains(p)) + } } struct Popup { @@ -250,3 +255,90 @@ fn calendar(ui: &mut Ui, t: &Tokens, month: &mut (i64, u32)) -> Option { }); picked } + +#[cfg(test)] +mod tests { + use super::*; + use egui::{Event, PointerButton}; + + fn press(at: egui::Pos2) -> Event { + Event::PointerButton { pos: at, button: PointerButton::Primary, pressed: true, modifiers: Default::default() } + } + + fn release(at: egui::Pos2) -> Event { + Event::PointerButton { pos: at, button: PointerButton::Primary, pressed: false, modifiers: Default::default() } + } + + /// A harness showing a drop-down control followed by text, with the caret in the control and + /// its list button on screen. + fn dropdown_harness() -> egui_kittest::Harness<'static, WordApp> { + let mut app = WordApp::new(wordcraft_engine::Session::new(wordcraft_doc::Document::new()), Default::default()); + app.run("text.insert", json!({"text": "tail text"})).unwrap(); + app.run("caret.docStart", json!({})).unwrap(); + app.run("developer.dropDown", json!({"items": ["A", "B"]})).unwrap(); + app.run("view.commentsPane", json!({"value": false})).unwrap(); + let mut h = egui_kittest::Harness::builder().with_size(egui::vec2(1440.0, 900.0)).with_step_dt(1.0 / 60.0).build_ui_state( + |ui, app: &mut WordApp| { + let ctx = ui.ctx().clone(); + app.logic(&ctx); + app.ui(ui); + }, + app, + ); + for _ in 0..6 { + h.step(); + } + let before = h.state().session.sel.focus.clone(); + assert!(h.state().session.doc.control_at(&before).is_some(), "the caret starts in the control"); + h + } + + /// #5389: pressing a drop-down's list button opens the list and leaves the caret in the + /// control, even when text follows the control and the button hangs over it. + #[test] + fn pressing_the_list_button_keeps_the_caret_in_the_control() { + let mut h = dropdown_harness(); + let at = h.state().controls.button.as_ref().expect("the list button is shown").0.center(); + h.event(Event::PointerMoved(at)); + h.event(press(at)); + h.step(); + h.event(release(at)); + for _ in 0..3 { + h.step(); + } + let after = h.state().session.sel.focus.clone(); + assert!(h.state().session.doc.control_at(&after).is_some(), "the caret stays in the control"); + assert!(h.state().controls.popup_open(), "the list is open"); + } + + /// The same click when press and release arrive in one frame: egui has no press origin left + /// by then. + #[test] + fn a_click_that_presses_and_releases_in_one_frame_keeps_the_caret_in_the_control() { + let mut h = dropdown_harness(); + let at = h.state().controls.button.as_ref().expect("the list button is shown").0.center(); + h.event(Event::PointerMoved(at)); + h.step(); + // `Harness::event` runs a frame per event, so both go into the frame's input directly. + h.input_mut().events.extend([press(at), release(at)]); + h.step(); + for _ in 0..3 { + h.step(); + } + let after = h.state().session.sel.focus.clone(); + assert!(h.state().session.doc.control_at(&after).is_some(), "the caret stays in the control"); + assert!(h.state().controls.popup_open(), "the list is open"); + } + + /// A table tool owns the pointer: a press over the list button starts a stroke. + #[test] + fn the_draw_table_tool_starts_a_stroke_over_the_list_button() { + let mut h = dropdown_harness(); + h.state_mut().canvas.table_tool = Some(crate::table_pen::TableTool::Draw); + let at = h.state().controls.button.as_ref().expect("the list button is shown").0.center(); + h.event(Event::PointerMoved(at)); + h.event(press(at)); + h.step(); + assert!(h.state().canvas.table_stroke.is_some(), "the stroke started on the button"); + } +} From 122c85bd096e09924fda86b6bbd1e97697d25325 Mon Sep 17 00:00:00 2001 From: Valentin Klein Date: Thu, 5 Nov 2026 09:14:25 +0100 Subject: [PATCH 08/34] .doc import: cap paragraph and cell marks, keep the table context only for table marks (#5476) (#5486) * docbin: cap paragraph and cell marks, keep the table context only for table marks (#5476) The walk budget counts characters, not paragraphs, so a file made of paragraph marks grew memory about 2,000 times faster than its size (4 MB of marks: 9.4 s, 8.4 GB peak). Marks now draw on one document-wide cap (2,000,000, all stories together); past it the read returns DocbinError::Limit. A ParaOut no longer embeds the 296-byte RowInfo of a table mark: it is an optional box, present only for table marks. Co-Authored-By: Claude Sonnet 5.5 * docbin: say what the paragraph cap bounds; name the budget test for what it checks Co-Authored-By: Claude Sonnet 5.5 * docbin: refuse an exhausted paragraph budget before assembling a story (review point) CodeRabbit pointed out that the header, footnote, endnote and text box walks assembled their partial paragraph lists before the budget check, a transient memory peak. They now share story_blocks, which checks first. Co-Authored-By: Claude Sonnet 5.5 * docbin: test that the paragraph cap is shared by the body and a footnote (review nitpick) Co-Authored-By: Claude Sonnet 5.5 * docbin test: review fixes (assert empty pairs, comment wording) Co-Authored-By: Claude Sonnet 5.5 --------- Co-authored-by: Claude Sonnet 5.5 --- crates/docbin/src/lib.rs | 74 ++++++++++++++++++++++++++++++--- crates/docbin/src/table.rs | 15 ++++--- crates/docbin/src/tests.rs | 85 +++++++++++++++++++++++++++++++++++++- 3 files changed, 162 insertions(+), 12 deletions(-) diff --git a/crates/docbin/src/lib.rs b/crates/docbin/src/lib.rs index 43f2e8d65e..fc56849193 100644 --- a/crates/docbin/src/lib.rs +++ b/crates/docbin/src/lib.rs @@ -51,6 +51,14 @@ const MAX_PARTS: usize = 50_000; /// headers, notes, text boxes), whatever the file's size. The working budget is tied to the /// WordDocument stream (see [`read`]); this caps even a maximal stream. const MAX_TOTAL_CHARS: u64 = 64 << 20; +/// Most paragraph and cell marks across every story walk of one document. The character +/// budget does not see them: a mark is one byte of the file but about 1 KB of document, so a +/// file of nothing but marks would grow memory about a thousand times faster than its size. +/// The cap bounds a flood to about 2 GB while reading (about 4 GB at the very cap, when the +/// blocks are assembled). Past it the read fails with [`DocbinError::Limit`]. Real documents stay far below it: +/// 50 paragraphs on each of 10,000 pages is 500,000, and a 10,000-page one-column table (46 +/// rows, each a cell mark plus a row mark) is about 920,000. +const MAX_PARAGRAPHS: usize = 2_000_000; /// Bytes of repeated work per document beyond the text itself: piece Prm grpprls (Prcs, up /// to 64 KB each) interpreted (#3692), hyperlink targets (#3708), picture alt text (#3709) /// and floating objects (#3710) copied into every run or anchor. Past it Prms are skipped, @@ -195,6 +203,12 @@ pub fn read(bytes: &[u8]) -> Result { /// verifier ([`DocbinError::WrongPassword`] when it does not match) and then decrypted. The /// password is ignored for an unprotected file. pub fn read_with_password(bytes: &[u8], password: Option<&str>) -> Result { + read_limited(bytes, password, MAX_PARAGRAPHS) +} + +/// [`read_with_password`] with the paragraph cap as a parameter, so tests need not build a +/// file of [`MAX_PARAGRAPHS`] marks. +fn read_limited(bytes: &[u8], password: Option<&str>, max_paragraphs: usize) -> Result { let mut comp = open_container(bytes)?; let mut word = stream(&mut comp, "WordDocument").ok_or_else(|| DocbinError::NotWord("no WordDocument stream".into()))?; if word.len() as u64 > MAX_STREAM { @@ -270,6 +284,7 @@ pub fn read_with_password(bytes: &[u8], password: Option<&str>) -> Result) -> Result) -> Result= MAX_PARTS || tb_stories.contains_key(&spid) { continue; } - let blocks = table::assemble(walk(&ctx, a, b, &mut pics)); + let blocks = story_blocks(&ctx, a, b, &mut pics, max_paragraphs)?; tb_stories.insert(spid, doc.add_part(PartKind::TextBox, blocks)); } } @@ -329,7 +345,7 @@ pub fn read_with_password(bytes: &[u8], password: Option<&str>) -> Result PartKind::Header, _ => PartKind::Footer, }; - let blocks = table::assemble(walk(&ctx, a, b, &mut pics)); + let blocks = story_blocks(&ctx, a, b, &mut pics, max_paragraphs)?; if !blocks.is_empty() { let id = doc.add_part(kind, blocks); hf_ids.push((si, k, id)); @@ -342,7 +358,7 @@ pub fn read_with_password(bytes: &[u8], password: Option<&str>) -> Result = Vec::new(); for (cp, ab) in notes::parse_notes(&table, &fib, fib::pair::PLCF_FND_REF, fib::pair::PLCF_FND_TXT) { let Some((a, b)) = story(ftn_base, fib.ccp.ftn, ab) else { continue }; - let blocks = table::assemble(walk(&ctx, a, b, &mut pics)); + let blocks = story_blocks(&ctx, a, b, &mut pics, max_paragraphs)?; if !blocks.is_empty() && doc.parts.len() < MAX_PARTS { let id = doc.add_part(PartKind::Footnote, blocks); note_links.push((cp, NoteKind::Footnote, id)); @@ -350,7 +366,7 @@ pub fn read_with_password(bytes: &[u8], password: Option<&str>) -> Result) -> Result) -> Result DocbinError { + DocbinError::Limit(format!("the document has more than {max_paragraphs} paragraphs and table cells")) +} + +/// Walks one story into blocks. A walk that spent the shared paragraph budget is refused before +/// its partial list is assembled, so a flood does not build blocks it will throw away. +fn story_blocks(ctx: &WalkCtx<'_>, a: u32, b: u32, pics: &mut media::Pictures, max_paragraphs: usize) -> Result { + let paras = walk(ctx, a, b, pics); + if ctx.paragraphs.exceeded.get() { + return Err(paragraph_limit(max_paragraphs)); + } + Ok(table::assemble(paras)) +} + /// A story's CP range `[a, b)`, relative to a subdocument starting at `base` with `len` /// CPs, as absolute CPs clamped to that subdocument; `None` when empty. fn story(base: u32, len: u32, (a, b): (u32, u32)) -> Option<(u32, u32)> { @@ -433,10 +466,35 @@ struct WalkCtx<'a> { /// footnotes, text boxes) are hostile and can each span a whole subdocument, so thousands of /// them could otherwise materialise the same text thousands of times; this bounds the total. budget: &'a std::cell::Cell, + /// Paragraph and cell marks still allowed across every story walk ([`MAX_PARAGRAPHS`]). + paragraphs: &'a ParaBudget, /// Repeated-work bytes left ([`MAX_WORK`]), and what they left out. work: &'a Work, } +/// The paragraph and cell marks still allowed in this document, and whether a walk ran into +/// the end of them (the read then fails). +struct ParaBudget { + left: std::cell::Cell, + exceeded: std::cell::Cell, +} + +impl ParaBudget { + /// Spends one mark; false (and the overrun noted) when none are left. + fn spend(&self) -> bool { + match self.left.get().checked_sub(1) { + Some(left) => { + self.left.set(left); + true + } + None => { + self.exceeded.set(true); + false + } + } + } +} + /// State while assembling one paragraph from per-CP formatting. #[derive(Default)] struct ParaBuild { @@ -527,6 +585,9 @@ fn walk<'a>(ctx: &WalkCtx<'a>, cp_start: u32, cp_end: u32, pics: &mut media::Pic let section_mark = c == '\u{C}' && ctx.sect_ends.binary_search(&cp.saturating_add(1)).is_ok(); match c { '\r' | '\u{7}' | '\u{C}' if c != '\u{C}' || section_mark => { + if !ctx.paragraphs.spend() { + break; + } // Paragraph mark: its PAPX covers the FC range of the paragraph it ends, so // querying at the mark's own FC finds that paragraph's properties. let fc_mark = ctx.pieces.fc_of_cp(cp).unwrap_or(0); @@ -536,6 +597,9 @@ fn walk<'a>(ctx: &WalkCtx<'a>, cp_start: u32, cp_end: u32, pics: &mut media::Pic } let mut row = table::decode(papx); row.cell_mark = c == '\u{7}'; + // Only table marks keep their table context; a plain paragraph would carry + // a `RowInfo` (about 300 bytes) it never uses. + let row = row.is_table().then(|| Box::new(row)); let mut ilvl = 0u8; let mut ilfo = 0i32; for prl in sprm::iter(papx) { @@ -669,7 +733,7 @@ fn walk<'a>(ctx: &WalkCtx<'a>, cp_start: u32, cp_end: u32, pics: &mut media::Pic out.push(ParaOut { para: Paragraph { text: done.text, runs: done.runs, props: done.props, mark: done.mark, objects: done.objects, ..Default::default() }, end_cp: cp_end, - row: table::RowInfo::default(), + row: None, }); } out diff --git a/crates/docbin/src/table.rs b/crates/docbin/src/table.rs index 3b0daf6395..400c8715c7 100644 --- a/crates/docbin/src/table.rs +++ b/crates/docbin/src/table.rs @@ -83,6 +83,11 @@ pub(crate) struct RowInfo { /// Read the table context out of a paragraph mark's PAPX grpprl. impl RowInfo { + /// Does the mark belong to a table: inside one, ending a row, or ending a cell? + pub(crate) fn is_table(&self) -> bool { + self.in_table || self.ttp || self.cell_mark + } + /// The row height from `sprmTDyaRowHeight`, for tests. #[cfg(test)] pub(crate) fn height(&self) -> Option { @@ -263,8 +268,8 @@ pub(crate) struct ParaOut { pub(crate) para: Paragraph, /// CP just past the terminating mark. pub(crate) end_cp: u32, - /// Table context from the mark's PAPX (empty default = not in a table). - pub(crate) row: RowInfo, + /// Table context from the mark's PAPX; `None` for a paragraph outside a table. + pub(crate) row: Option>, } /// Group consecutive in-table paragraphs into [`Table`] blocks; the rest pass through. @@ -369,9 +374,7 @@ pub(crate) fn assemble(paras: Vec) -> Blocks { } for p in paras { - let info = p.row; - let is_table = info.in_table || info.ttp || info.cell_mark; - if !is_table { + let Some(info) = p.row else { if open { flush_table(&mut out, &mut rows, &mut cells, &mut cell, &grid, &props, depth_seen > 1); grid.clear(); @@ -386,7 +389,7 @@ pub(crate) fn assemble(paras: Vec) -> Blocks { } out.push(para_block(p.para)); continue; - } + }; if !open { open = true; } diff --git a/crates/docbin/src/tests.rs b/crates/docbin/src/tests.rs index b251cadbb5..ea56a9c85b 100644 --- a/crates/docbin/src/tests.rs +++ b/crates/docbin/src/tests.rs @@ -116,6 +116,12 @@ fn piece_bytes(p: &Piece) -> Vec { /// A document whose main text is the given pieces (extra subdocument text may follow). fn text_doc(main: &[Piece], extra: &[Piece], ccp_hdd: u32) -> Vec { + text_doc_with(main, extra, FibSpec { ccp_hdd, ..Default::default() }, &[]) +} + +/// [`text_doc`] with the FIB knobs given (`ccp_text` is filled in from `main`; `pairs` must be empty) and extra +/// Table-stream data placed after the piece table: `(pair index, bytes)` for each. +fn text_doc_with(main: &[Piece], extra: &[Piece], spec: FibSpec, table_data: &[(usize, &[u8])]) -> Vec { let all: Vec = main.iter().chain(extra.iter()).cloned().collect(); let ccp_text: u32 = main.iter().map(|p| p.text.chars().count() as u32).sum(); let mut word = vec![0u8; TEXT_FC as usize]; @@ -128,7 +134,13 @@ fn text_doc(main: &[Piece], extra: &[Piece], ccp_hdd: u32) -> Vec { clx.extend_from_slice(&plc); let mut table = vec![0u8; CLX_AT as usize]; table.extend_from_slice(&clx); - let spec = FibSpec { ccp_text, ccp_hdd, pairs: vec![(33, CLX_AT, clx.len() as u32)], ..Default::default() }; + let mut pairs = vec![(33, CLX_AT, clx.len() as u32)]; + for (pair, bytes) in table_data { + pairs.push((*pair, table.len() as u32, bytes.len() as u32)); + table.extend_from_slice(bytes); + } + debug_assert!(spec.pairs.is_empty(), "text_doc_with sets the pairs itself"); + let spec = FibSpec { ccp_text, pairs, ..spec }; word[..fib_bytes(&spec).len()].copy_from_slice(&fib_bytes(&spec)); cfb_file(&[("WordDocument", &word), ("0Table", &table)]) } @@ -247,6 +259,77 @@ fn empty_paragraphs_kept() { assert_eq!(body_texts(&doc), ["a", "", "b"]); } +/// A document of `n` copies of `mark` as one compressed piece. +fn marks_doc(mark: char, n: usize) -> Vec { + text_doc(&[Piece { compressed: true, text: mark.to_string().repeat(n) }], &[], 0) +} + +/// Paragraph marks are one byte each in the file but about 1 KB each in memory, so they have +/// their own cap ([`super::MAX_PARAGRAPHS`]); a file past it is refused instead of growing +/// until the machine runs out. A document exactly at the cap still opens. +#[test] +fn a_flood_of_paragraph_marks_is_refused() { + let at_cap = super::read_limited(&marks_doc('\r', 1000), None, 1000).expect("opens"); + assert_eq!(at_cap.body.len(), 1000); + let over = super::read_limited(&marks_doc('\r', 1001), None, 1000); + assert!(matches!(over, Err(crate::DocbinError::Limit(_))), "{over:?}"); +} + +/// The paragraph cap is one budget for the whole document, not one per story: marks in the +/// body and in a footnote add up. (A walk that got its own budget would open both over-cap files.) +#[test] +fn the_paragraph_cap_is_shared_by_the_body_and_a_footnote() { + // One footnote at CP 0 whose text is `note` marks, stored right after the body in the stream. + let doc_of = |body: usize, note: usize| { + let cps = |v: &[u32]| v.iter().flat_map(|c| c.to_le_bytes()).collect::>(); + let mut refs = cps(&[0, 1]); + refs.extend_from_slice(&[0, 0]); // the one reference's data + let txt = cps(&[0, note as u32, note as u32]); // story 0..note, then the limit + let spec = FibSpec { ccp_ftn: note as u32, ..Default::default() }; + text_doc_with( + &[Piece { compressed: true, text: "\r".repeat(body) }], + &[Piece { compressed: true, text: "\r".repeat(note) }], + spec, + &[(2, &refs), (3, &txt)], + ) + }; + let at_cap = super::read_limited(&doc_of(600, 400), None, 1000).expect("opens"); + assert_eq!(at_cap.body.len(), 600); + assert_eq!(at_cap.parts.len(), 1); + let over = super::read_limited(&doc_of(600, 401), None, 1000); + assert!(matches!(over, Err(crate::DocbinError::Limit(_))), "{over:?}"); + let over = super::read_limited(&doc_of(601, 400), None, 1000); + assert!(matches!(over, Err(crate::DocbinError::Limit(_))), "{over:?}"); +} + +/// Cell marks are paragraph marks too: a never-closed row of them is refused the same way. +#[test] +fn a_flood_of_cell_marks_is_refused() { + let over = super::read_limited(&marks_doc('\u{7}', 5000), None, 1000); + assert!(matches!(over, Err(crate::DocbinError::Limit(_))), "{over:?}"); +} + +/// The budget counts down across spends and notes the overrun (`walk` receives one shared by +/// every story of the document). +#[test] +fn the_paragraph_budget_counts_down_and_notes_the_overrun() { + let budget = super::ParaBudget { left: std::cell::Cell::new(2), exceeded: std::cell::Cell::new(false) }; + assert!(budget.spend() && budget.spend()); + assert!(!budget.exceeded.get()); + assert!(!budget.spend()); + assert!(budget.exceeded.get()); +} + +/// The cap is far above any real document (10,000 pages of 50 paragraphs is 500,000), and a +/// paragraph outside a table no longer carries a table context (a `ParaOut` was 1,224 bytes). +#[test] +fn the_paragraph_cap_leaves_room_and_a_paragraph_stays_small() { + const { assert!(super::MAX_PARAGRAPHS >= 1_000_000) }; + assert!(std::mem::size_of::() < 1000, "{}", std::mem::size_of::()); + let doc = read(&marks_doc('\r', 10)).expect("opens"); + assert_eq!(doc.body.len(), 10); +} + #[test] fn empty_document_gets_a_paragraph() { let f = text_doc(&[Piece { compressed: false, text: "".into() }], &[], 0); From c230e2b13efa8f79edbd2993b5933e3c7af6e3b5 Mon Sep 17 00:00:00 2001 From: ljkx <177671075+ljkx@users.noreply.github.com> Date: Thu, 5 Nov 2026 09:14:32 +0100 Subject: [PATCH 09/34] Alt codes type their character in Find and other text boxes (#4403) (#5405) * Alt codes type their character in Find and other text boxes (#4403) Alt+numpad codes worked only on the page. In a text box (Find what, Replace with, a dialog's field) the digits were typed instead on Linux, which sends their text with Alt held; on Windows the box got only what the system composes, a byte for a code above 255. A pass before the frame is drawn now gives the focused text box the same codes as the page: the digits' text is dropped, letting go of Alt types the character the code names in the same code pages, and a platform's own composed character is not typed twice (up to 255 the system's replaces ours, as on the page). * Alt codes in text boxes: letting go of Alt ends the digits' text The flag that drops a digit's own text stayed set when no text came for the last digit, so the first text after the release was lost: on Windows the system's composed character for a code we name no character for (CodeRabbit), and on Linux whatever followed a frame whose digits sent no text (CI). A digit's text comes with its key, before Alt is let go, so the release now clears the flag everywhere. --- crates/ui-egui/src/app.rs | 2 + crates/ui-egui/src/canvas.rs | 3 + crates/ui-egui/src/keys.rs | 2 +- crates/ui-egui/src/keys/alt_code.rs | 118 +++++++++++++++++++++++++++- crates/ui-egui/src/keys/tests.rs | 102 ++++++++++++++++++++++++ docs/typing-parity.md | 3 +- 6 files changed, 227 insertions(+), 3 deletions(-) diff --git a/crates/ui-egui/src/app.rs b/crates/ui-egui/src/app.rs index db417f398d..45a07aa1f1 100644 --- a/crates/ui-egui/src/app.rs +++ b/crates/ui-egui/src/app.rs @@ -443,6 +443,8 @@ impl WordApp { // Keytips are read before layout so the frame paints the new state; badges paint after // the ribbon so they sit on top of it. crate::keytips::logic(self, &ctx); + // Alt codes in a text box are read before the box is drawn, so it types the character. + crate::keys::field_alt_codes(self, &ctx); // A failed Recent open, or a failed Save As, is news only until File closes (#2938). if !self.ui.backstage { backstage::forget_open_error(&ctx); diff --git a/crates/ui-egui/src/canvas.rs b/crates/ui-egui/src/canvas.rs index bbe4e60163..ac52931bfc 100644 --- a/crates/ui-egui/src/canvas.rs +++ b/crates/ui-egui/src/canvas.rs @@ -257,6 +257,8 @@ pub struct CanvasState { /// The character an Alt code just typed: if the platform also sends its own composed /// character as text on the Alt release (Windows does), it isn't typed twice. pub(crate) alt_code_echo: Option, + /// Alt+numpad entry in the focused text box, while the page doesn't have the keyboard (#4403). + pub(crate) field_alt_code: crate::keys::FieldAltCode, /// Create Link is waiting for a click on the text box to link to: the linking box's object. pub(crate) link_from: Option, /// What screen readers were last told about the document (#488). @@ -411,6 +413,7 @@ impl Default for CanvasState { ime_viewport: None, alt_code: String::new(), alt_code_echo: None, + field_alt_code: Default::default(), wheel: Default::default(), auto_scroll: Default::default(), scroll_offset: egui::Vec2::ZERO, diff --git a/crates/ui-egui/src/keys.rs b/crates/ui-egui/src/keys.rs index 1b893c7f3d..4107613c24 100644 --- a/crates/ui-egui/src/keys.rs +++ b/crates/ui-egui/src/keys.rs @@ -12,7 +12,7 @@ mod canvas; mod ime; mod shortcuts; -pub(crate) use alt_code::AltCodeEcho; +pub(crate) use alt_code::{AltCodeEcho, FieldAltCode, field_alt_codes}; pub use canvas::canvas_events; pub(crate) use ime::observe_ime; #[cfg(test)] diff --git a/crates/ui-egui/src/keys/alt_code.rs b/crates/ui-egui/src/keys/alt_code.rs index 25f7f5f1e1..61989bea67 100644 --- a/crates/ui-egui/src/keys/alt_code.rs +++ b/crates/ui-egui/src/keys/alt_code.rs @@ -29,11 +29,15 @@ fn alt_code_digit(key: Key) -> Option { char::from_digit(n, 10) } +/// Alt is the only modifier held: the one an Alt code's digits are typed with. +fn alt_only(m: &Modifiers) -> bool { + m.alt && !m.ctrl && !m.shift && !m.command && !m.mac_cmd +} + /// Alt+numpad entry (#961): digits typed with Alt alone held collect; releasing Alt types the /// character their code names (`text.typeCode`: 0233 → é, 233 → Θ in code page 437). Returns /// whether the event was part of it (and isn't handled otherwise). pub(super) fn alt_code_event(app: &mut WordApp, e: &egui::Event) -> bool { - let alt_only = |m: &Modifiers| m.alt && !m.ctrl && !m.shift && !m.command && !m.mac_cmd; match e { egui::Event::Key { key, pressed: true, repeat, modifiers, .. } if alt_only(modifiers) => match alt_code_digit(*key) { // A held digit's auto-repeat adds nothing (as on Windows). @@ -131,3 +135,115 @@ pub(super) fn alt_code_echoed(app: &mut WordApp, echo: &AltCodeEcho, text: &str) } true } + +/// Alt+numpad entry in the focused text box (Find what, a dialog's fields, the ribbon's boxes); +/// the page has its own ([`alt_code_event`]), #4403. +#[derive(Clone, Debug, Default)] +pub(crate) struct FieldAltCode { + /// The digits typed while Alt is held. + code: String, + /// The last digit's own text (Linux sends it with Alt held) isn't typed. + swallow_text: bool, + /// What the last code typed, for the platform's own composed character that may follow. + echo: Option, +} + +/// The character an Alt code names in the code pages the page uses for it: the system locale's +/// on Windows, else `text.typeCode`'s defaults (Windows-1252 and the locale's OEM page). +fn field_code_char(code: &str) -> Option { + use wordcraft_engine::cmd::text::{alt_code_char, system_code_pages, system_oem_code_page}; + let (ansi, oem) = if cfg!(target_os = "windows") { system_code_pages() } else { (1252, system_oem_code_page()) }; + alt_code_char(code, ansi, oem) +} + +/// Whether `e` lets go of Alt: its key's release, or modifiers without it. +fn alt_released(e: &egui::Event) -> bool { + match e { + egui::Event::Key { key: Key::AltLeft | Key::AltRight, pressed: false, .. } => true, + egui::Event::ModifiersChanged(m) => !m.alt, + _ => false, + } +} + +/// Alt codes in the focused text box, as on the page (#4403). Rewrites this frame's input before +/// the box reads it: the digits typed with Alt held type nothing (Linux sends their text), and +/// letting go of Alt types the code's character. A platform that composes the code itself +/// (Windows) sends its character after that: the same character isn't typed twice, and for a +/// code up to 255 the system's character replaces ours, as on the page ([`alt_code_echoed`]). +pub(crate) fn field_alt_codes(app: &mut WordApp, ctx: &egui::Context) { + if !alt_codes_supported(ctx) || app.canvas.focused || !ctx.text_edit_focused() { + app.canvas.field_alt_code = FieldAltCode::default(); + return; + } + let st = &mut app.canvas.field_alt_code; + let events = ctx.input(|i| i.events.clone()); + let mut out = Vec::with_capacity(events.len() + 1); + let mut changed = false; + for e in events { + match &e { + egui::Event::Key { key, pressed: true, repeat, modifiers, .. } => { + st.swallow_text = false; + st.echo = None; + match alt_code_digit(*key).filter(|_| alt_only(modifiers)) { + Some(d) => { + // A held digit's auto-repeat adds nothing; past seven digits a code + // names nothing, so stop collecting rather than grow. + if !*repeat && st.code.len() < 8 { + st.code.push(d); + } + st.swallow_text = true; + } + // Another key (Alt itself, a letter, a digit with Ctrl) ends the entry. + None => st.code.clear(), + } + } + egui::Event::Text(_) if std::mem::take(&mut st.swallow_text) => { + changed = true; + continue; + } + egui::Event::Text(t) => { + if let Some(echo) = st.echo.take() + && (echo.typed == *t || echo.system_composes) + { + changed = true; + if echo.typed != *t && echo.byte_code && t.chars().count() == 1 { + // Ours was typed just before, with no key or click since: take it back. + out.push(egui::Event::Key { + key: Key::Backspace, + physical_key: None, + pressed: true, + repeat: false, + modifiers: Modifiers::NONE, + }); + out.push(e); + } + continue; + } + } + egui::Event::PointerButton { pressed: true, .. } => st.echo = None, + // Focus elsewhere (another window) ends an Alt code unfinished. + egui::Event::WindowFocused(false) => st.code.clear(), + _ => {} + } + let released = alt_released(&e); + out.push(e); + if released && !st.code.is_empty() { + let code = std::mem::take(&mut st.code); + let system_composes = cfg!(target_os = "windows"); + // A digit's own text comes with its key, before Alt is let go: text after this is + // the system's composed character (Windows), also for a code we name no character + // for (a double-byte lead byte, say), or what is typed next. A digit that sent no + // text must not cost it. + st.swallow_text = false; + if let Some(c) = field_code_char(&code) { + let byte_code = code.trim_start_matches('0').parse::().is_ok_and(|v| v <= 255); + st.echo = Some(AltCodeEcho { typed: c.to_string(), system_composes, byte_code }); + out.push(egui::Event::Text(c.to_string())); + changed = true; + } + } + } + if changed { + ctx.input_mut(|i| i.events = out); + } +} diff --git a/crates/ui-egui/src/keys/tests.rs b/crates/ui-egui/src/keys/tests.rs index 528f3bf83c..1cd6b4df86 100644 --- a/crates/ui-egui/src/keys/tests.rs +++ b/crates/ui-egui/src/keys/tests.rs @@ -376,6 +376,108 @@ fn altgr_types_its_characters_without_keytips() { assert_eq!(a.ui.keytips, crate::keytips::Phase::Tabs); } +/// The Find dialog's Find what box, after the frames that open the dialog and focus the box. +fn find_box_harness() -> egui_kittest::Harness<'static, WordApp> { + let mut a = WordApp::new(wordcraft_engine::Session::new(wordcraft_doc::Document::new()), crate::Services::default()); + a.dialog = crate::dialogs::Dialog::open("find", &mut a); + let mut h = egui_kittest::Harness::builder().with_size(egui::vec2(1440.0, 900.0)).build_ui_state( + |ui, app: &mut WordApp| { + let ctx = ui.ctx().clone(); + app.logic(&ctx); + app.ui(ui); + }, + a, + ); + h.run_steps(4); + h +} + +/// What the Find dialog's Find what box holds. +fn find_box(h: &egui_kittest::Harness<'static, WordApp>) -> String { + match &h.state().dialog { + Some(crate::dialogs::Dialog::Find { query, .. }) => query.clone(), + _ => panic!("the Find dialog is open"), + } +} + +/// One frame: Alt held, `digits` pressed and released (with their text, as Linux sends it, when +/// `digit_text`), Alt let go; then `after`, which a platform may send once Alt is up. +fn alt_code_frame(h: &mut egui_kittest::Harness<'static, WordApp>, digits: &str, digit_text: bool, after: &[&str]) { + let alt = Modifiers { alt: true, ..Default::default() }; + let key = |key, pressed, modifiers| egui::Event::Key { key, physical_key: Some(key), pressed, repeat: false, modifiers }; + h.event(egui::Event::ModifiersChanged(alt)); + h.event(key(Key::AltLeft, true, alt)); + for d in digits.chars() { + let k = Key::from_name(&d.to_string()).expect("a digit key"); + h.event(key(k, true, alt)); + if digit_text { + h.event(egui::Event::Text(d.to_string())); + } + h.event(key(k, false, alt)); + } + h.event(key(Key::AltLeft, false, alt)); + h.event(egui::Event::ModifiersChanged(Modifiers::NONE)); + for t in after { + h.event(egui::Event::Text((*t).to_string())); + } + h.step(); +} + +/// #4403: an Alt code typed in a text box (here Find what) types its character there, as on the +/// page. Before, the box got the digits (Linux sends their text with Alt held), or on Windows only +/// what the system composes, a byte for a code above 255. The page's text is left alone. +#[test] +fn alt_code_types_its_character_in_a_text_box() { + if cfg!(target_os = "macos") { + return; + } + // The code pages the page's Alt codes use (`text.typeCode`). + let (ansi, oem) = if cfg!(target_os = "windows") { + wordcraft_engine::cmd::text::system_code_pages() + } else { + (1252, wordcraft_engine::cmd::text::system_oem_code_page()) + }; + let ch = |code| wordcraft_engine::cmd::text::alt_code_char(code, ansi, oem).expect("a character code").to_string(); + let mut h = find_box_harness(); + assert_eq!(find_box(&h), ""); + // Linux: each digit's text arrives too; none of it is typed. + alt_code_frame(&mut h, "0233", true, &[]); + let mut want = ch("0233"); + assert_eq!(find_box(&h), want); + // Above 255 the code is the Unicode character's (Word's €), and a platform's echo of the + // same character isn't typed twice. + alt_code_frame(&mut h, "8364", false, &["\u{20AC}"]); + want.push('\u{20AC}'); + assert_eq!(find_box(&h), want); + // Windows composes a code itself: up to 255 its character replaces ours (it knows the code + // pages), above that ours stays (it reduces the code to a byte). Elsewhere text after the + // release is typed as it comes. + alt_code_frame(&mut h, "0199", false, &["\u{1E9E}"]); + alt_code_frame(&mut h, "9731", false, &["X"]); + if cfg!(target_os = "windows") { + want.push_str("\u{1E9E}\u{2603}"); + } else { + want.push_str(&format!("{}\u{1E9E}\u{2603}X", ch("0199"))); + } + assert_eq!(find_box(&h), want); + // A code we name no character for (past Unicode here; a double-byte lead byte on Windows) + // types nothing of ours, and the character the system composes for it is typed, not taken + // for a digit's text. Windows sends no digit text; Linux does. + assert_eq!(wordcraft_engine::cmd::text::alt_code_char("1114112", ansi, oem), None); + alt_code_frame(&mut h, "1114112", !cfg!(target_os = "windows"), &["Y"]); + want.push('Y'); + assert_eq!(find_box(&h), want); + // Digits without Alt type themselves; a bare Alt tap types nothing and opens no keytips. + h.event(egui::Event::Key { key: Key::Num5, physical_key: Some(Key::Num5), pressed: true, repeat: false, modifiers: Modifiers::NONE }); + h.event(egui::Event::Text("5".into())); + h.step(); + alt_code_frame(&mut h, "", false, &[]); + want.push('5'); + assert_eq!(find_box(&h), want); + assert_eq!(h.state().ui.keytips, crate::keytips::Phase::Off); + assert_eq!(h.state().session.doc.plain_text(wordcraft_doc::StoryRef::Body).trim_end(), "", "the page typed nothing"); +} + fn alt_frame_app() -> (egui::Context, WordApp) { let a = WordApp::new(wordcraft_engine::Session::new(wordcraft_doc::Document::new()), crate::Services::default()); (egui::Context::default(), a) diff --git a/docs/typing-parity.md b/docs/typing-parity.md index 64809baf2e..ed4040ceb9 100644 --- a/docs/typing-parity.md +++ b/docs/typing-parity.md @@ -135,7 +135,7 @@ Windows/Linux keys are given first, macOS second. | Shift+F5 | Go Back: the caret cycles through the last four places edited, most recent first | `shift_f5_goes_back_through_the_last_edits` | | Alt+X (no macOS default) | the hex code before the caret (up to six digits, `U+` optional) or the selected code becomes its character; otherwise the character before the caret becomes its code (`é` ↔ `00E9`); one undo step | `alt_x_toggles_between_a_character_and_its_code` | | Shift+Backspace / Shift+Delete | Shift+Backspace erases like Backspace (#707). Shift+Delete cuts the selection to the clipboard and does nothing without one (Word for Windows, observed 2026-10-14). Windows delivers Shift+Delete as a Cut; macOS and Linux deliver the key, which did nothing (#1669) | `shift_delete_cuts_the_selection_and_shift_backspace_erases` | -| Alt+numpad code (Windows and Linux; not macOS) | hold Alt, type a decimal code, release Alt: the character appears at the caret as typed text (one undo step). With a leading 0 the code is the ANSI code page — Windows-1252 by default (`0233` → é, `0128` → €); without one, 1–255 is the OEM code page — 437 by default and in US English (`233` → Θ, `1` → ☺, `7` → •), 850 for Western European locales and English outside the US (`155` → ø; `233` is Ú there, per the CP850 mapping file — é is `130` in both). On Windows the system locale picks both pages (`text.typeCode` `ansi`/`oem`): Central European 1250/852 (Polish `0185` and `165` → ą), Cyrillic 1251/866, Greek 1253/737, Turkish 1254/857, and for codes up to 255 the character Windows composes itself replaces ours (it knows every code page, double-byte ones too); Linux keeps 1252 and 437/850. Above 255, with or without the 0, the Unicode character with that decimal value (`8364` → €). Control characters, 0, unassigned bytes and values past Unicode type nothing; auto-repeat of a held digit adds nothing, and switching windows drops a half-typed code. Word counts only keypad digits; egui reports keypad and top-row digits alike, so top-row digits with Alt alone compose codes too. An Alt code never opens KeyTips | `alt_numpad_codes_map_like_word_on_windows`, `alt_numpad_code_types_one_character`, ui-egui `alt_numpad_code_types_its_character_without_keytips` | +| Alt+numpad code (Windows and Linux; not macOS) | hold Alt, type a decimal code, release Alt: the character appears at the caret as typed text (one undo step). With a leading 0 the code is the ANSI code page — Windows-1252 by default (`0233` → é, `0128` → €); without one, 1–255 is the OEM code page — 437 by default and in US English (`233` → Θ, `1` → ☺, `7` → •), 850 for Western European locales and English outside the US (`155` → ø; `233` is Ú there, per the CP850 mapping file — é is `130` in both). On Windows the system locale picks both pages (`text.typeCode` `ansi`/`oem`): Central European 1250/852 (Polish `0185` and `165` → ą), Cyrillic 1251/866, Greek 1253/737, Turkish 1254/857, and for codes up to 255 the character Windows composes itself replaces ours (it knows every code page, double-byte ones too); Linux keeps 1252 and 437/850. Above 255, with or without the 0, the Unicode character with that decimal value (`8364` → €). Control characters, 0, unassigned bytes and values past Unicode type nothing; auto-repeat of a held digit adds nothing, and switching windows drops a half-typed code. Word counts only keypad digits; egui reports keypad and top-row digits alike, so top-row digits with Alt alone compose codes too. An Alt code never opens KeyTips. A text box (Find what, a dialog's field, the ribbon's boxes) takes the same codes: its character, not the digits (#4403) | `alt_numpad_codes_map_like_word_on_windows`, `alt_numpad_code_types_one_character`, ui-egui `alt_numpad_code_types_its_character_without_keytips`, `alt_code_types_its_character_in_a_text_box` | | AltGr (Right Alt on Polish, German, Czech… layouts) | AltGr+letter types the layout's character (AltGr+S → ś, AltGr+L → ł) and a bare AltGr tap does nothing; neither opens KeyTips. On Linux AltGr is the Right Alt key with Level 3 Shift, not Alt, so its modifiers event no longer reads as Alt let go (#2388); on Windows it is Ctrl+Alt. Right Alt on a layout without AltGr (US) is Alt and opens KeyTips like Left Alt | ui-egui `altgr_types_its_characters_without_keytips` | | Shift+Right (⇧→) at the end of a cell's text | the whole cell is selected first (its end-of-cell mark); the next Shift+Right selects the next cell with it. In an empty cell the first press selects the cell | `shift_right_at_the_end_of_a_cell_selects_the_cell_first` | @@ -564,6 +564,7 @@ this correction; native Windows interaction and Microsoft Word remain untested. | Date | Change | Summary | |---|---|---| +| 2026-11-03 | trivial | Alt+numpad codes type their character in text boxes too (Find what, dialog fields), not the digits or nothing (#4403) | | 2026-11-01 | minor | English spelling by dialect from SCOWL 2026: typed British, Canadian and Australian text, modern words and ordinals pinned (#40, #520, #1281, #1045; CP2) | | 2026-10-29 | trivial | Relative font-size commands preserve mixed sizes in the selection (#4903); existing button steps and one-point shortcuts are unchanged; readiness estimates unchanged | | 2026-10-28 | trivial | Highlighting at a caret leaves the word alone and sets the colour for what is typed next (#4086). | From fede86cd1a1dcc03808157fe1596307d0c95c360 Mon Sep 17 00:00:00 2001 From: Michael Mu <69072633+MichaelMuClaude@users.noreply.github.com> Date: Thu, 5 Nov 2026 16:14:38 +0800 Subject: [PATCH 10/34] Tests: comment export discovery counts work steps instead of timing (#5618) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `comment_export_discovery_scales_with_unrelated_markers` timed `notes` on 2,000 and 16,000 markers through /proc/thread-self/schedstat. That count moves only at a scheduler tick or switch, so a 17 µs baseline read as nothing or a whole tick, and gate failed on linear code (58.68x on PR #3228's run 41932894607). As #5608 did for the balloon anchors, the test now counts the characters the walk visits (`wordcraft_doc::work`): 4,010 -> 32,010 steps, 8.0x, every run. A prefix scan per marker injected into `notes` counts 63.9x and fails it. `work::steps` becomes public so a crate that walks a paragraph's text itself can count it; outside tests it is still nothing. Co-authored-by: Claude Opus 5.5 --- crates/doc/src/work.rs | 5 ++-- crates/formats/src/comments.rs | 1 + crates/formats/src/comments/tests.rs | 43 ++++++---------------------- 3 files changed, 12 insertions(+), 37 deletions(-) diff --git a/crates/doc/src/work.rs b/crates/doc/src/work.rs index 6cb4d69fd0..1cf061022a 100644 --- a/crates/doc/src/work.rs +++ b/crates/doc/src/work.rs @@ -10,9 +10,10 @@ thread_local! { static STEPS: std::cell::Cell = const { std::cell::Cell::new(0) }; } -/// Count `n` steps of a walk (nothing outside tests). +/// Count `n` steps of a walk (nothing outside tests). Public for the walks other crates do over a +/// paragraph's text themselves (Markdown and HTML comment export, for one). #[inline(always)] -pub(crate) fn steps(n: usize) { +pub fn steps(n: usize) { #[cfg(any(test, feature = "test-support"))] STEPS.with(|s| s.set(s.get().saturating_add(n as u64))); #[cfg(not(any(test, feature = "test-support")))] diff --git a/crates/formats/src/comments.rs b/crates/formats/src/comments.rs index 75fc97d3a9..da66dfd2c4 100644 --- a/crates/formats/src/comments.rs +++ b/crates/formats/src/comments.rs @@ -58,6 +58,7 @@ pub fn notes(doc: &Document) -> Vec { let Some(p) = doc.para(StoryRef::Body, &path) else { continue }; let mut objects = p.objects.iter(); for c in p.text.chars() { + wordcraft_doc::work::steps(1); if c == OBJ { match objects.next() { Some(InlineObject::CommentStart { id }) => { diff --git a/crates/formats/src/comments/tests.rs b/crates/formats/src/comments/tests.rs index f91e7626e0..a14008c924 100644 --- a/crates/formats/src/comments/tests.rs +++ b/crates/formats/src/comments/tests.rs @@ -64,45 +64,18 @@ fn dense_markers(n: usize) -> Document { doc } -// Ignore scheduler delays. An absent, failed, decreasing or nonadvancing counter supplies no -// performance evidence; the semantic assertions below still run on every platform. -fn cpu_cost(mut f: impl FnMut()) -> Option { - let ran = || std::fs::read_to_string("/proc/thread-self/schedstat").ok()?.split_whitespace().next()?.parse::().ok(); - let before = ran(); - f(); - match (before, ran()) { - (Some(a), Some(b)) if b > a => Some((b - a) as f64 * 1e-9), - _ => None, - } -} - -/// Unrelated markers must add one walk, rather than a fresh paragraph-prefix scan per marker. #[test] fn comment_export_discovery_scales_with_unrelated_markers() { let (small, big) = (dense_markers(2_000), dense_markers(16_000)); let expected = vec![Note { author: "Ada".into(), quote: "é漢 quote".into(), text: "Kept note".into(), replies: vec![] }]; assert_eq!(notes(&small), expected); assert_eq!(notes(&big), expected); - let (mut t1, mut t8) = (f64::INFINITY, f64::INFINITY); - for _ in 0..3 { - let a = cpu_cost(|| { - for _ in 0..8 { - std::hint::black_box(notes(&small)); - } - }); - let b = cpu_cost(|| { - std::hint::black_box(notes(&big)); - }); - if let (Some(a), Some(b)) = (a, b) { - t1 = t1.min(a / 8.0); - t8 = t8.min(b); - } - } - if t1.is_finite() && t8.is_finite() { - let ratio = t8 / t1; - eprintln!("comment discovery CPU: small={t1:.6}s big={t8:.6}s ratio={ratio:.2}"); - assert!(ratio < 24.0, "8x the markers cost {ratio:.2}x CPU ({t1:.6}s versus {t8:.6}s)"); - } else { - eprintln!("comment discovery scaling skipped: no advancing thread CPU samples"); - } + // The characters the discovery walks (`wordcraft_doc::work`), not a timing: about 8x for 8x + // the markers when the walk is linear, about 64x when it is quadratic. Timed, this failed on + // busy CI machines with a linear walk (58x for a 17 µs baseline). + let (s, b) = (wordcraft_doc::work::count(|| drop(notes(&small))), wordcraft_doc::work::count(|| drop(notes(&big)))); + let ratio = b as f64 / s.max(1) as f64; + eprintln!("comment discovery steps: {s} -> {b}, {ratio:.1}x for 8x markers"); + assert!(s > 0, "no steps counted, so the walk this test watches no longer counts them (wordcraft_doc::work)"); + assert!(ratio <= 12.0, "8x the markers cost {ratio:.1}x the steps ({s} -> {b})"); } From c0ab7e29f9deffbf1461f1d50ecdd6953647e1f2 Mon Sep 17 00:00:00 2001 From: Valentin Klein Date: Thu, 5 Nov 2026 09:14:56 +0100 Subject: [PATCH 11/34] .doc import: a field's cached result keeps its formatting per run, not per character (#5477) (#5489) * docbin: a field's cached result keeps its formatting per run, not per character (#5477) The result was a Vec<(char, CharProps)>: 365 bytes per character, 1.44 GB at peak for a 4 MB file with one field. It is now a String plus a run list that gains an entry only when the formatting changes (25 MB peak for the same file). Output is unchanged. Co-Authored-By: Claude Sonnet 5.5 * docbin: show the objects when the field-result test fails Co-Authored-By: Claude Sonnet 5.5 --------- Co-authored-by: Claude Sonnet 5.5 --- crates/docbin/src/lib.rs | 51 +++++++++++++++++++++++++---------- crates/docbin/src/tests.rs | 54 ++++++++++++++++++++++++++++++++++++-- 2 files changed, 89 insertions(+), 16 deletions(-) diff --git a/crates/docbin/src/lib.rs b/crates/docbin/src/lib.rs index fc56849193..e97e2676d3 100644 --- a/crates/docbin/src/lib.rs +++ b/crates/docbin/src/lib.rs @@ -653,7 +653,7 @@ fn walk<'a>(ctx: &WalkCtx<'a>, cp_start: u32, cp_end: u32, pics: &mut media::Pic && f.depth == 1 && f.sep.is_none() { - f.sep = Some(Vec::new()); + f.sep = Some(FieldResult::default()); } cp = cp.saturating_add(1); continue; @@ -744,7 +744,28 @@ fn walk<'a>(ctx: &WalkCtx<'a>, cp_start: u32, cp_end: u32, pics: &mut media::Pic struct FieldBuild { depth: u32, instr: String, - sep: Option>, + sep: Option, +} + +/// A field's cached result: its text and, as runs, the formatting of that text. A run is added +/// only when the formatting changes, so a result of millions of equally formatted characters +/// costs one `CharProps`, not one per character (365 bytes each). +#[derive(Default)] +struct FieldResult { + text: String, + /// (byte length in `text`, formatting) in order; adjacent runs differ. + runs: Vec<(usize, CharProps)>, +} + +impl FieldResult { + fn push(&mut self, c: char, props: CharProps) { + let len = c.len_utf8(); + match self.runs.last_mut() { + Some((n, last)) if *last == props => *n += len, + _ => self.runs.push((len, props)), + } + self.text.push(c); + } } /// Bytes a clone of `obj` copies: the object itself plus a picture's alt text, a group with all @@ -769,24 +790,26 @@ fn finish_field(pb: &mut ParaBuild, f: FieldBuild, work: &Work) { let result = f.sep.unwrap_or_default(); if let Some(target) = hyperlink_target(&instr) { let cost = target.len() as u64; - let mut run: Option = None; - for (c, props) in result { - if run.as_ref() == Some(&props) { - pb.extend(c); - continue; - } - let mut linked = props.clone(); + let mut chars = result.text.chars(); + for (len, props) in result.runs { + let mut linked = props; if work.charge(cost, Cost::LinkTarget) { linked.link = Some(target.clone()); } - pb.push(c, linked); - run = Some(props); + let mut left = len; + let Some(first) = chars.next() else { break }; + pb.push(first, linked); + left = left.saturating_sub(first.len_utf8()); + while left > 0 { + let Some(c) = chars.next() else { break }; + pb.extend(c); + left = left.saturating_sub(c.len_utf8()); + } } return; } - let result_text: String = result.iter().map(|(c, _)| *c).collect(); pb.push('\u{FFFC}', CharProps::default()); - pb.objects.push(InlineObject::Field { instr, result: result_text, locked: false, dirty: false, code: false, form: String::new() }); + pb.objects.push(InlineObject::Field { instr, result: result.text, locked: false, dirty: false, code: false, form: String::new() }); } /// `sprmCPicLocation` from a CHPX grpprl: the fc of the picture in the Data stream. @@ -870,7 +893,7 @@ fn push_formatted<'a>(pb: &mut ParaBuild, cp: u32, c: char, ctx: &WalkCtx<'a>, f Some(f) => match f.sep.as_mut() { // Inside a field, characters are recorded for the field object instead of shown; // `finish_field` emits the visible text (hyperlink runs or one object anchor). - Some(result) => result.push((c, props)), + Some(result) => result.push(c, props), None => f.instr.push(c), }, None => pb.push(c, props), diff --git a/crates/docbin/src/tests.rs b/crates/docbin/src/tests.rs index ea56a9c85b..1128eca38a 100644 --- a/crates/docbin/src/tests.rs +++ b/crates/docbin/src/tests.rs @@ -2743,7 +2743,8 @@ fn a_long_hyperlink_over_a_long_result_is_one_linked_run() { assert_eq!(linked.first().map(|r| r.len), Some(n)); // One copy of the target for the one run, not one per character (~2.5 s here): counted by // what the copies charge to the work budget, which a busy machine can't skew. - let result = vec![('y', wordcraft_doc::props::CharProps::default()); n]; + let mut result = super::FieldResult::default(); + (0..n).for_each(|_| result.push('y', wordcraft_doc::props::CharProps::default())); let f = super::FieldBuild { depth: 1, instr: format!("HYPERLINK \"http://{target}\""), sep: Some(result) }; let work = super::Work::new(u64::MAX); super::finish_field(&mut super::ParaBuild::default(), f, &work); @@ -2756,7 +2757,8 @@ fn a_long_hyperlink_over_a_long_result_is_one_linked_run() { fn hyperlink_target_copies_are_charged_to_the_work_budget() { use wordcraft_doc::props::CharProps; let bold = CharProps { bold: Some(true), ..Default::default() }; - let result: Vec<(char, CharProps)> = (0..1000).map(|i| ('a', if i % 2 == 0 { bold.clone() } else { CharProps::default() })).collect(); + let mut result = super::FieldResult::default(); + (0..1000).for_each(|i| result.push('a', if i % 2 == 0 { bold.clone() } else { CharProps::default() })); let f = super::FieldBuild { depth: 1, instr: format!("HYPERLINK \"{}\"", "u".repeat(100)), sep: Some(result) }; let mut pb = super::ParaBuild::default(); let budget = super::Work::new(10_000); @@ -2830,3 +2832,51 @@ fn prm_grpprls_past_the_work_budget_are_skipped() { assert_eq!(work.left.get(), 1); assert_eq!(work.dropped(), [super::Cost::Formatting]); } + +/// A field's cached result keeps one `CharProps` per formatting run, not one per character +/// (365 bytes each: 4 million result characters took 1.4 GB). +#[test] +fn a_field_result_stores_one_props_per_run() { + use wordcraft_doc::props::CharProps; + let bold = CharProps { bold: Some(true), ..Default::default() }; + let mut r = super::FieldResult::default(); + for _ in 0..200_000 { + r.push('x', CharProps::default()); + } + assert_eq!(r.runs.len(), 1); + assert_eq!(r.runs.first().map(|(n, _)| *n), Some(200_000)); + r.push('\u{e9}', bold.clone()); + r.push('y', bold); + r.push('z', CharProps::default()); + assert_eq!(r.runs.iter().map(|(n, _)| *n).collect::>(), [200_000, 3, 1], "a two-byte char counts its bytes"); + assert_eq!(r.text.len(), 200_004); +} + +/// A hyperlink whose result changes formatting, with multi-byte text, keeps every run's text and +/// links all of it; a plain field keeps its result text whole. +#[test] +fn field_results_keep_their_text_and_runs() { + use wordcraft_doc::props::CharProps; + let bold = CharProps { bold: Some(true), ..Default::default() }; + let mut result = super::FieldResult::default(); + for (c, p) in + [('a', CharProps::default()), ('\u{e9}', CharProps::default()), ('\u{20ac}', bold.clone()), ('b', bold), ('c', CharProps::default())] + { + result.push(c, p); + } + let f = super::FieldBuild { depth: 1, instr: "HYPERLINK \"http://x\"".into(), sep: Some(result) }; + let mut pb = super::ParaBuild::default(); + super::finish_field(&mut pb, f, &super::Work::new(u64::MAX)); + assert_eq!(pb.text, "a\u{e9}\u{20ac}bc"); + assert_eq!(pb.runs.iter().map(|r| r.len).collect::>(), [3, 4, 1]); + assert!(pb.runs.iter().all(|r| r.props.link.as_deref() == Some("http://x"))); + let doc = read(&text_doc(&[Piece { compressed: false, text: "\u{13} PAGE \u{14}1\u{e9}2\u{15}\r".into() }], &[], 0)).expect("opens"); + let p = doc.body.first().and_then(|b| b.as_para()).expect("paragraph"); + assert!( + p.objects + .iter() + .any(|o| matches!(o, wordcraft_doc::para::InlineObject::Field { instr, result, .. } if instr == "PAGE" && result == "1\u{e9}2")), + "{:?}", + p.objects + ); +} From 7a8819c296f37559f04723adb8ee92e7faabf44f Mon Sep 17 00:00:00 2001 From: Helen Kwok <107752876+helenkwok@users.noreply.github.com> Date: Mon, 26 Oct 2026 11:05:24 +1030 Subject: [PATCH 12/34] Contributors: credit helenkwok as Helen Kwok --- contributors/people.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/contributors/people.toml b/contributors/people.toml index 950a26a2b5..a048cd0a1d 100644 --- a/contributors/people.toml +++ b/contributors/people.toml @@ -192,3 +192,6 @@ sync_github_name = true [people.entropybeater] display_name = "entropybeater" + +[people.helenkwok] +real_name = "Helen Kwok" From 5f9bb3f1112d2397ff8073fc30cda997e7e3c4b3 Mon Sep 17 00:00:00 2001 From: Helen Kwok <107752876+helenkwok@users.noreply.github.com> Date: Mon, 26 Oct 2026 11:05:43 +1030 Subject: [PATCH 13/34] feat(web): page host mode, so a page can host WordCraft in its own document (#4366) data-host="page" on the canvas opts a page that loads the module into its own document into the host bridge. The ?host=parent messages travel as non-bubbling CustomEvents on the canvas; the bridge holds a Transport (Parent or Page) with one send, and the open, save, dirty, ready and failure handling is shared. ?host=parent is checked first and unchanged, including no bridge for an unframed page. The hosting guide documents both modes. --- apps/wordcraft-web/Cargo.toml | 2 +- apps/wordcraft-web/src/host.rs | 186 +++++++++++++++++++++-------- apps/wordcraft-web/src/hostmode.rs | 22 ++++ apps/wordcraft-web/src/main.rs | 8 +- apps/wordcraft-web/src/web.rs | 15 ++- packaging/web/README.md | 76 ++++++++++++ 6 files changed, 253 insertions(+), 56 deletions(-) create mode 100644 apps/wordcraft-web/src/hostmode.rs diff --git a/apps/wordcraft-web/Cargo.toml b/apps/wordcraft-web/Cargo.toml index 4a2a9d014e..1d6d8cc344 100644 --- a/apps/wordcraft-web/Cargo.toml +++ b/apps/wordcraft-web/Cargo.toml @@ -29,4 +29,4 @@ rfd = { workspace = true } wasm-bindgen = "0.2" wasm-bindgen-futures = "0.4" js-sys = "0.3" -web-sys = { version = "0.3", features = ["Window", "Document", "Element", "HtmlElement", "HtmlCanvasElement", "HtmlAnchorElement", "HtmlIFrameElement", "Blob", "BlobPropertyBag", "Url", "Location", "CssStyleDeclaration", "Event", "EventTarget", "BeforeUnloadEvent", "ClipboardEvent", "DataTransfer", "FileList", "File", "DomStringList", "IdbFactory", "IdbOpenDbRequest", "IdbRequest", "IdbDatabase", "IdbObjectStore", "IdbTransaction", "IdbTransactionMode", "MediaQueryList", "Storage", "MessageEvent", "UrlSearchParams"] } +web-sys = { version = "0.3", features = ["Window", "Document", "Element", "HtmlElement", "HtmlCanvasElement", "HtmlAnchorElement", "HtmlIFrameElement", "Blob", "BlobPropertyBag", "Url", "Location", "CssStyleDeclaration", "Event", "EventTarget", "BeforeUnloadEvent", "ClipboardEvent", "DataTransfer", "FileList", "File", "DomStringList", "IdbFactory", "IdbOpenDbRequest", "IdbRequest", "IdbDatabase", "IdbObjectStore", "IdbTransaction", "IdbTransactionMode", "MediaQueryList", "Storage", "MessageEvent", "UrlSearchParams", "CustomEvent", "CustomEventInit"] } diff --git a/apps/wordcraft-web/src/host.rs b/apps/wordcraft-web/src/host.rs index 9307e0ed15..2f0fab64b1 100644 --- a/apps/wordcraft-web/src/host.rs +++ b/apps/wordcraft-web/src/host.rs @@ -1,6 +1,11 @@ -//! The `postMessage` bridge to a same-origin parent page (`?host=parent`), for pages that embed -//! WordCraft in an `