6ef13b2cc8a6
tests.rs
use super::*;
use wordcraft_doc::fill::Fill;
use wordcraft_doc::para::InlineObject;
use wordcraft_doc::props::{Align, Border, BorderStyle, Borders, ParaProps, TextDirection};
use wordcraft_doc::{Pos, Table};
mod autospace;
mod bidi;
mod budget;
mod cell_floats;
mod complex;
mod float_top;
mod grid;
mod ligature;
pub(crate) mod linear;
mod missing_glyphs;
mod nbsp;
mod nested_cant_split;
mod numeral;
mod pages;
mod styleref;
mod table_contact;
mod textbox;
mod vertical;
const WRAP_TEST_FONT: &str = "Source Sans 3";
fn lay(doc: &Document) -> DocLayout {
let mut c = LayoutCache::new();
layout(doc, &mut c, &LayoutOptions::default())
}
/// These pagination fixtures test physical boundaries, not the host's Aptos substitution.
/// Keep their explicit spacing local; ordinary document/layout defaults remain unchanged.
pub(super) fn pagination_fixture_document(text: &str) -> Document {
let mut doc = Document::from_text(text);
Arc::make_mut(&mut doc.styles).default_chr.font = Some(WRAP_TEST_FONT.into());
Arc::make_mut(&mut doc.styles).default_chr.size = Some(12.0);
for block in &mut doc.body {
if let Block::Para(para) = Arc::make_mut(block) {
para.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(14.0));
para.props.space_before = Some(0.0);
para.props.space_after = Some(8.0);
}
}
doc
}
/// Asserts that every laid-out fixture paragraph uses the bundled Source Sans 3 Regular bytes at
/// 12 pt and that at least one paragraph was actually inspected.
pub(super) fn assert_pagination_fixture_font(layout: &DocLayout) {
let mut paragraphs = 0;
for page in &layout.pages {
for item in &page.items {
if let Placed::Lines { para, .. } = item {
paragraphs += 1;
for style in ¶.styles {
assert_eq!(style.rc.font, WRAP_TEST_FONT, "the fixture requests its bundled face");
assert_eq!(style.face.family, WRAP_TEST_FONT, "the fixture must not silently substitute another family");
assert_eq!(style.face.style, "Regular", "the fixture must resolve the intended regular face");
assert_eq!(style.size, 12.0, "the fixture keeps its explicit point size");
assert!(
style.face.data() == include_bytes!("../../../assets/fonts/SourceSans3-Regular.ttf").as_slice(),
"the selected face must be the exact already-bundled regular font bytes"
);
}
}
}
}
assert!(paragraphs > 0, "font assertions must inspect actual laid-out paragraphs");
}
/// Preserve the 22 short filler paragraphs while giving the following row a measured boundary.
fn pagination_filler_leaving(room: f32) -> Document {
let lines: Vec<String> = (1..=22).map(|i| format!("Filler {i}")).collect();
let mut doc = pagination_fixture_document(&lines.join("\n"));
let after = doc.last_section.text_height() - room - 22.0 * 14.0 - 21.0 * 8.0;
assert!(after >= 8.0, "the last gap may add room-taking space, not remove filler content");
doc.para_mut(StoryRef::Body, &Path::top(21)).unwrap().props.space_after = Some(after);
let probe = lay(&doc);
assert_pagination_fixture_font(&probe);
assert_eq!(probe.pages.len(), 1, "all filler must precede the row on page one");
let lines: Vec<_> = probe.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story: StoryRef::Body, path, para, y, l0, l1, .. } if path.0.len() == 1 => Some((para, *y, l1 - l0)),
_ => None,
})
.collect();
assert_eq!(lines.len(), 22, "every filler paragraph remains");
assert!(lines.iter().all(|(_, _, count)| *count == 1), "filler text must remain one line per paragraph");
let (last, y, _) = lines.last().unwrap();
let remaining = probe.pages[0].body.bottom() - y - last.height - last.rp.space_after;
assert!((remaining - room).abs() < 0.02, "requested {room}pt of actual row room, got {remaining}pt");
assert!(remaining > 0.0 && (remaining < 63.6) == (room < 63.6), "the measured room must be on the intended side of the row boundary");
doc
}
/// The top-level body text bottom and its trailing space-after, if the page has one.
fn pagination_body_bottom(page: &Page) -> Option<(f32, f32)> {
let mut body_bottom = None::<(f32, f32)>;
for item in &page.items {
if let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, y, .. } = item
&& path.0.len() == 1
&& let (Some(first), Some(last)) = (para.lines.get(*l0), para.lines.get(l1.saturating_sub(1)))
{
let bottom = y + last.top + last.height - first.top;
if body_bottom.is_none_or(|(prior, _)| bottom > prior) {
body_bottom = Some((bottom, para.rp.space_after));
}
}
}
body_bottom
}
/// Report the page's top-level body text bottom, when there is one.
fn pagination_write_body_bottom(out: &mut String, page: &Page) {
use std::fmt::Write as _;
if let Some((bottom, after)) = pagination_body_bottom(page) {
let _ = writeln!(
out,
" top-level body text bottom={bottom:.3} trailing_space_after={after:.3} remaining_to_body_bottom={:.3} remaining_after_unadjusted_space={:.3}",
page.body.bottom() - bottom,
page.body.bottom() - bottom - after
);
}
}
/// The first and last line of the placed range, with their physical extents.
fn pagination_write_line_rows(out: &mut String, para: &ParaLayout, l0: usize, l1: usize) {
use std::fmt::Write as _;
for (li, line) in para.lines.iter().enumerate().filter(|(i, _)| *i >= l0 && *i < l1 && (*i == l0 || i.saturating_add(1) == l1)) {
let _ = writeln!(
out,
" line={li} bytes={}..{} top={:.3} height={:.3} baseline={:.3} text_asc={:.3} text_desc={:.3} end={:?}",
line.start, line.stop, line.top, line.height, line.baseline, line.text_asc, line.text_desc, line.end
);
}
}
/// The styles this paragraph actually uses (plus the first), with their resolved metrics.
fn pagination_write_styles(out: &mut String, para: &ParaLayout) {
use std::fmt::Write as _;
for (si, st) in para.styles.iter().enumerate().filter(|(i, _)| *i == 0 || para.clusters.iter().any(|c| c.style as usize == *i)).take(4) {
let (asc, desc) = wordcraft_fonts::word::line_metrics(&st.face);
let raw_height = (asc + desc) * f64::from(st.size) / st.face.upem;
let _ = writeln!(
out,
" style={si} requested={:?} actual={:?}/{:?} face_id={} upem={} size={} word_asc={} word_desc={} raw_height_pt={raw_height:.3} resolved_asc={:.3} resolved_desc={:.3}",
st.rc.font,
st.face.family,
st.face.style,
st.face.id(),
st.face.upem,
st.size,
asc,
desc,
st.ascent,
st.descent
);
}
}
/// One placed paragraph line range and its styles.
fn pagination_write_lines(out: &mut String, ii: usize, item: &Placed, doc: Option<&Document>) {
use std::fmt::Write as _;
let Placed::Lines { story, path, para, l0, l1, x, y, turn } = item else {
return;
};
let text = doc.and_then(|d| d.para(*story, path)).map(|p| p.text.chars().take(96).collect::<String>());
let _ = writeln!(
out,
" item={ii} Lines story={story:?} path={path:?} text={text:?} xy=({x:.3},{y:.3}) turn={turn:?} lines={l0}..{l1}/{} para_height={:.3} before={:.3} after={:.3} spacing={:?}",
para.lines.len(),
para.height,
para.rp.space_before,
para.rp.space_after,
para.rp.line_spacing
);
pagination_write_line_rows(out, para, *l0, *l1);
pagination_write_styles(out, para);
}
/// One retained placed item (the middle items are omitted by the caller).
fn pagination_write_item(out: &mut String, ii: usize, item: &Placed, doc: Option<&Document>) {
use std::fmt::Write as _;
match item {
Placed::Lines { .. } => pagination_write_lines(out, ii, item, doc),
Placed::Cell { rect, table, row, cell, story, clip, .. } => {
let _ = writeln!(out, " item={ii} Cell table={table:?} story={story:?} row={row} cell={cell} rect={rect:?} clip={clip}");
}
Placed::Object { rect, story, path, off, text_box, .. } => {
let _ = writeln!(out, " item={ii} Object story={story:?} path={path:?} off={off} textbox={text_box:?} rect={rect:?}");
}
_ => {}
}
}
/// Failure-only evidence for the selected pagination fixtures below. Inspect the already produced
/// styles and placements, not a second run.
pub(super) fn pagination_fixture_diagnostics(label: &str, doc: Option<&Document>, layout: &DocLayout) -> String {
use std::fmt::Write as _;
let mut out = String::new();
let _ = writeln!(out, "\npagination fixture {label}: {} pages", layout.pages.len());
for (pi, page) in layout.pages.iter().enumerate().take(8) {
let _ = writeln!(
out,
"page={pi} body={:?} first_block={} floats={:?} items={}",
page.body,
page.first_block,
page.float_tables,
page.items.len()
);
pagination_write_body_bottom(&mut out, page);
for (ii, item) in page.items.iter().enumerate().filter(|(i, _)| *i < 32 || i.saturating_add(16) >= page.items.len()) {
pagination_write_item(&mut out, ii, item, doc);
}
if page.items.len() > 48 {
let _ = writeln!(out, " omitted {} middle items (first32/last16 retained)", page.items.len() - 48);
}
}
if layout.pages.len() > 8 {
let _ = writeln!(out, "omitted {} later pages", layout.pages.len() - 8);
}
out
}
#[derive(Clone, Copy)]
enum SpacingLocation {
Cell,
Body,
Header,
}
fn legacy_table_gap(mode: u32, allow: bool, location: SpacingLocation) -> f32 {
let mut d = Document::new();
d.settings.compat_mode = mode;
d.settings.allow_space_of_same_style_in_table = allow;
let chr = wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(12.0), ..Default::default() };
let mut a = wordcraft_doc::Paragraph::with_text("Alpha probe", chr.clone());
a.props = ParaProps {
space_before: Some(0.0),
space_after: Some(12.0),
line_spacing: Some(wordcraft_doc::props::LineSpacing::Exactly(24.0)),
contextual_spacing: Some(true),
..Default::default()
};
let mut b = wordcraft_doc::Paragraph::with_text("Beta probe", chr);
b.props = ParaProps { space_after: Some(0.0), ..a.props.clone() };
let blocks = vec![wordcraft_doc::para_block(a), wordcraft_doc::para_block(b)];
match location {
SpacingLocation::Cell => {
let mut table = Table::new(1, 1, 468.0);
// Cell identity must not depend on whether table-style formatting exists.
table.props.style = None;
table.props.cell_margins = Some([0.0; 4]);
table.rows[0].cells[0].blocks = blocks;
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(table))];
}
SpacingLocation::Body => d.body = blocks,
SpacingLocation::Header => {
let id = d.add_part(wordcraft_doc::PartKind::Header, blocks);
d.last_section.headers.default = Some(id);
}
}
let l = lay(&d);
let items = if matches!(location, SpacingLocation::Header) { &l.pages[0].header } else { &l.pages[0].items };
let baselines: Vec<_> = items
.iter()
.filter_map(|i| match i {
Placed::Lines { para, y, .. } => Some(y + para.lines[0].baseline),
_ => None,
})
.collect();
assert_eq!(baselines.len(), 2);
baselines[1] - baselines[0] - 24.0
}
#[test]
fn legacy_table_contextual_spacing_flag_keeps_after_space() {
crate::test_fonts();
// Original Word for Mac 16.113.3 probe: after 12 pt, before 0 pt, both contextual.
// Zero before-space keeps the compatibility rule independent of ordinary overlap.
for mode in [11, 12, 14] {
let gap = legacy_table_gap(mode, true, SpacingLocation::Cell);
assert!((gap - 12.0).abs() < 0.01, "mode={mode}: gap={gap}, expected 12 pt");
}
}
#[test]
fn legacy_table_contextual_spacing_flag_is_scoped_to_cells_and_legacy_mode() {
crate::test_fonts();
for (mode, allow) in [(11, false), (12, false), (14, false), (15, false), (15, true)] {
assert!(legacy_table_gap(mode, allow, SpacingLocation::Cell).abs() < 0.01);
}
for mode in [14, 15] {
for location in [SpacingLocation::Body, SpacingLocation::Header] {
assert!(legacy_table_gap(mode, true, location).abs() < 0.01);
}
}
}
/// Baseline of the paragraph after a one-row table, less that of the first cell's last
/// paragraph, which has 12 pt after in `style`, contextual or not. `next_cell` adds a second cell
/// whose paragraph has that style; `after_table` styles the paragraph after the table; `text` is
/// the last paragraph's text.
fn cell_end_gap(style: &str, contextual: bool) -> f32 {
cell_end_gap_in(Document::new(), style, contextual, None, None, "Beta probe")
}
fn cell_end_gap_in(mut d: Document, style: &str, contextual: bool, next_cell: Option<&str>, after_table: Option<&str>, text: &str) -> f32 {
use wordcraft_doc::props::LineSpacing;
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "Other".into(),
name: "Other".into(),
based_on: Some("Normal".into()),
..Default::default()
});
let chr = wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(12.0), ..Default::default() };
let props = ParaProps { space_before: Some(0.0), space_after: Some(0.0), line_spacing: Some(LineSpacing::Exactly(24.0)), ..Default::default() };
let para = |text: &str, props: ParaProps| {
let mut p = wordcraft_doc::Paragraph::with_text(text, chr.clone());
p.props = props;
wordcraft_doc::para_block(p)
};
let styled = |s: Option<&str>| ParaProps { style: s.map(Into::into), ..props.clone() };
let mut table = Table::new(1, if next_cell.is_some() { 2 } else { 1 }, 468.0);
table.props.style = None;
table.props.cell_margins = Some([0.0; 4]);
let last = ParaProps { style: Some(style.into()), space_after: Some(12.0), contextual_spacing: Some(contextual), ..props.clone() };
table.rows[0].cells[0].blocks = vec![para("Alpha probe", props.clone()), para(text, last)];
if let Some(cell) = table.rows[0].cells.get_mut(1) {
cell.blocks = vec![para("Delta probe", styled(next_cell))];
}
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(table)), para("Gamma probe", styled(after_table))];
let l = lay(&d);
let baseline = |at: &[u32]| {
l.pages[0].items.iter().find_map(|i| match i {
Placed::Lines { para, y, path, .. } if path.0 == at => Some(y + para.lines[0].baseline),
_ => None,
})
};
let (Some(cell), Some(after)) = (baseline(&[0, 0, 0, 1]), baseline(&[1])) else { panic!("probe lines missing") };
after - cell
}
#[test]
fn contextual_spacing_drops_the_space_after_a_cells_last_normal_paragraph() {
// The end-of-cell mark is a Normal paragraph: contextual spacing drops the 12 pt after a
// Normal last paragraph (docxide-pdf `cell-end-text-context`, `cell-end-empty-context`), not
// after one in another style (`cell-end-other-style`) or without contextual spacing.
let kept = cell_end_gap("Normal", false);
assert!((cell_end_gap("Other", true) - kept).abs() < 0.01);
let dropped = cell_end_gap("Normal", true);
assert!((kept - dropped - 12.0).abs() < 0.01, "kept {kept}, dropped {dropped}");
// An undefined style is formatted as Normal, and drops it too.
assert!((cell_end_gap("Missing", true) - dropped).abs() < 0.01);
// The mark decides, not a neighbour: another style in the next cell or after the table
// leaves the drop as it is.
for (next_cell, after_table) in [(Some("Other"), None), (None, Some("Other"))] {
let gap = cell_end_gap_in(Document::new(), "Normal", true, next_cell, after_table, "Beta probe");
assert!((gap - dropped).abs() < 0.01, "{next_cell:?} {after_table:?}: {gap}, dropped {dropped}");
}
// And the reverse: another style keeps its space beside Normal neighbours.
let gap = cell_end_gap_in(Document::new(), "Other", true, Some("Normal"), Some("Normal"), "Beta probe");
assert!((gap - kept).abs() < 0.01, "other beside Normal: {gap}, kept {kept}");
// An empty last paragraph drops it too (`cell-end-empty-context`).
let gap = cell_end_gap_in(Document::new(), "Normal", true, None, None, "");
assert!((gap - dropped).abs() < 0.01, "empty: {gap}, dropped {dropped}");
// Where `allowSpaceOfSameStyleInTable` keeps same-style space in cells (modes 11/12/14), the
// 12 pt stays.
let mut legacy = Document::new();
legacy.settings.compat_mode = 14;
legacy.settings.allow_space_of_same_style_in_table = true;
let gap = cell_end_gap_in(legacy, "Normal", true, None, None, "Beta probe");
assert!((gap - kept).abs() < 0.01, "legacy {gap}, kept {kept}");
}
fn contextual_gap(after: f32, before: f32, first: bool, second: bool, different_style: bool, header: bool) -> f32 {
use wordcraft_doc::props::LineSpacing;
let mut d = Document::new();
for id in ["SpacingA", "SpacingB"] {
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style { id: id.into(), name: id.into(), ..Default::default() });
}
let chr = wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(12.0), ..Default::default() };
let props = ParaProps {
style: Some("SpacingA".into()),
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(LineSpacing::Exactly(24.0)),
..Default::default()
};
let mut a = wordcraft_doc::Paragraph::with_text("Alpha probe", chr.clone());
a.props = ParaProps { space_after: Some(after), contextual_spacing: Some(first), ..props.clone() };
let mut b = wordcraft_doc::Paragraph::with_text("Beta probe", chr);
b.props = ParaProps {
style: Some(if different_style { "SpacingB" } else { "SpacingA" }.into()),
space_before: Some(before),
contextual_spacing: Some(second),
..props
};
let paragraphs = vec![wordcraft_doc::para_block(a), wordcraft_doc::para_block(b)];
if header {
let id = d.add_part(wordcraft_doc::PartKind::Header, paragraphs);
d.last_section.headers.default = Some(id);
} else {
d.body = paragraphs;
}
let l = lay(&d);
let items = if header { &l.pages[0].header } else { &l.pages[0].items };
let baselines: Vec<_> =
items.iter().filter_map(|i| if let Placed::Lines { para, y, .. } = i { Some(y + para.lines[0].baseline) } else { None }).collect();
assert_eq!(baselines.len(), 2);
baselines[1] - baselines[0] - 24.0
}
// Original two-paragraph probes measured in Word for Mac 16.113.3, build 26092714.
// Exactly 24 pt spacing isolates the extra gap from font-dependent line height.
#[test]
fn contextual_after_removes_a_smaller_before_gap() {
crate::test_fonts();
for header in [false, true] {
let gap = contextual_gap(12.0, 8.0, true, false, false, header);
assert!(gap.abs() < 0.01, "header={header}: gap={gap}, expected 0 pt");
}
}
#[test]
fn contextual_after_keeps_only_the_residual_before_gap() {
crate::test_fonts();
// ISO/IEC 29500-1 §17.3.1.9's worked example: max(10, 12) - 10 = 2 pt.
for header in [false, true] {
let gap = contextual_gap(10.0, 12.0, true, false, false, header);
assert!((gap - 2.0).abs() < 0.01, "header={header}: gap={gap}, expected 2 pt");
}
}
#[test]
fn contextual_spacing_preserves_each_side_and_style_identity() {
crate::test_fonts();
for header in [false, true] {
for (after, before, first, second, different, expected) in [
(12.0, 8.0, false, true, false, 12.0),
(12.0, 8.0, true, true, false, 0.0),
(12.0, 0.0, true, true, true, 12.0),
(12.0, 0.0, false, false, false, 12.0),
] {
let gap = contextual_gap(after, before, first, second, different, header);
assert!(
(gap - expected).abs() < 0.01,
"header={header}, first={first}, second={second}, different={different}: gap={gap}, expected {expected}"
);
}
}
}
#[test]
fn contextual_spacing_removes_every_gap_in_a_four_paragraph_run() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
for table in [false, true] {
let mut doc = Document::new();
Arc::make_mut(&mut doc.styles).upsert(wordcraft_doc::Style { id: "SpacingA".into(), name: "SpacingA".into(), ..Default::default() });
let paragraphs = ["One", "Two", "Three", "Four"]
.into_iter()
.map(|text| {
let mut p = wordcraft_doc::Paragraph::with_text(
text,
wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(12.0), ..Default::default() },
);
p.props = ParaProps {
style: Some("SpacingA".into()),
space_before: Some(6.0),
space_after: Some(6.0),
contextual_spacing: Some(true),
line_spacing: Some(LineSpacing::Exactly(24.0)),
..Default::default()
};
wordcraft_doc::para_block(p)
})
.collect::<Vec<_>>();
if table {
let mut cell = Table::new(1, 1, 400.0);
cell.rows[0].cells[0].blocks = paragraphs;
doc.body = vec![Arc::new(Block::Table(cell))];
} else {
doc.body = paragraphs;
}
let layout = lay(&doc);
let baselines = layout.pages[0]
.items
.iter()
.filter_map(|item| match item {
Placed::Lines { para, y, .. } => Some(y + para.lines[0].baseline),
_ => None,
})
.collect::<Vec<_>>();
assert_eq!(baselines.len(), 4);
// Every same-style contextual boundary has zero extra space, including after paragraph two.
for pair in baselines.windows(2) {
assert!((pair[1] - pair[0] - 24.0).abs() < 0.01, "table={table}: {baselines:?}");
}
}
}
// Contextual and automatic list spacing can suppress the same after-space only once.
#[test]
fn contextual_automatic_lists_do_not_subtract_the_gap_twice() {
crate::test_fonts();
use wordcraft_doc::props::{LineSpacing, NumRef};
for table in [false, true] {
let mut doc = Document::new();
let num = Arc::make_mut(&mut doc.numbering).add_list(wordcraft_doc::ListKind::Numbered);
let paragraphs = ["First", "Second", "Third"]
.into_iter()
.map(|text| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props = ParaProps {
contextual_spacing: Some(true),
space_before_auto: Some(true),
space_after_auto: Some(true),
numbering: Some(NumRef { num, level: 0 }),
line_spacing: Some(LineSpacing::Exactly(24.0)),
..Default::default()
};
wordcraft_doc::para_block(p)
})
.collect::<Vec<_>>();
if table {
let mut cell = Table::new(1, 1, 400.0);
cell.rows[0].cells[0].blocks = paragraphs;
doc.body = vec![Arc::new(Block::Table(cell))];
} else {
doc.body = paragraphs;
}
let layout = lay(&doc);
let baselines = layout.pages[0]
.items
.iter()
.filter_map(|item| match item {
Placed::Lines { para, y, .. } => Some(y + para.lines[0].baseline),
_ => None,
})
.collect::<Vec<_>>();
assert_eq!(baselines.len(), 3);
for pair in baselines.windows(2) {
assert!((pair[1] - pair[0] - 24.0).abs() < 0.01, "table={table}: {baselines:?}");
}
}
}
fn lines_of(l: &DocLayout) -> usize {
l.pages.iter().flat_map(|p| p.items.iter()).map(|it| if let Placed::Lines { l0, l1, .. } = it { l1 - l0 } else { 0 }).sum()
}
#[test]
fn empty_doc_has_one_page() {
crate::test_fonts();
let d = Document::new();
let l = lay(&d);
assert_eq!(l.pages.len(), 1);
assert_eq!(lines_of(&l), 1);
let c = l.caret(&Pos::body(0, 0)).unwrap();
assert_eq!(c.page, 0);
assert!((c.x - 72.0).abs() < 0.5, "{c:?}");
assert!(c.top >= 72.0 && c.height > 8.0);
}
#[test]
fn hidden_marks_take_no_space() {
crate::test_fonts();
let mut d = Document::new();
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Before", Default::default()))];
for _ in 0..20 {
let mut p = wordcraft_doc::Paragraph::new();
p.mark.hidden = Some(true);
d.body.push(wordcraft_doc::para_block(p));
}
d.body.push(wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("After", Default::default())));
let l = lay(&d);
let y = |block: usize| {
l.pages
.iter()
.flat_map(|p| &p.items)
.find_map(|item| match item {
Placed::Lines { path, y, .. } if *path == Path::top(block) => Some(*y),
_ => None,
})
.unwrap()
};
let mut plain = Document::new();
plain.body = vec![
wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Before", Default::default())),
wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("After", Default::default())),
];
let plain_layout = lay(&plain);
let plain_after = plain_layout.pages[0]
.items
.iter()
.find_map(|item| match item {
Placed::Lines { path, y, .. } if *path == Path::top(1) => Some(*y),
_ => None,
})
.unwrap();
assert!((y(21) - plain_after).abs() < 0.1, "hidden paragraphs moved the following text to {} vs {plain_after}", y(21));
let shown = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden: true, ..Default::default() });
let after = shown.caret(&Pos::body(21, 0)).unwrap();
assert!(after.top > plain_after + 100.0, "showing hidden marks must restore their lines");
}
#[test]
fn long_paragraph_wraps_and_paginates() {
crate::test_fonts();
let text = "The quick brown fox jumps over the lazy dog. ".repeat(400);
let d = Document::from_text(&text);
let l = lay(&d);
assert!(l.pages.len() >= 3, "pages {}", l.pages.len());
// Every line fits the text width.
for p in &l.pages {
for it in &p.items {
if let Placed::Lines { para, l0, l1, x, .. } = it {
for li in *l0..*l1 {
let line = ¶.lines[li];
let w = para.x_of(li, line.stop).unwrap() + x;
assert!(w <= 612.0 - 72.0 + 30.0, "line too wide: {w}");
}
}
}
}
}
#[test]
fn reading_layout_reflows_into_viewport_height_pages_without_changing_print_layout() {
crate::test_fonts();
let d = Document::from_text(&"A moderately long sentence that should wrap across reading columns. ".repeat(250));
let opts = LayoutOptions { view: ViewMode::Read, web_width: 230.0, read_height: 390.0, ..Default::default() };
let read = layout(&d, &mut LayoutCache::new(), &opts);
assert!(read.pages.len() > 5, "reading column count: {}", read.pages.len());
assert!(read.pages.iter().all(|p| p.w == 230.0 && p.h == 390.0));
assert!(read.pages.iter().all(|p| p.body.w < p.w && p.body.h < p.h));
assert_eq!(
lines_of(&read),
lines_of(&layout(&d, &mut LayoutCache::new(), &LayoutOptions { view: ViewMode::Web, web_width: 230.0, ..Default::default() }))
);
let print = lay(&d);
assert_eq!(print.pages[0].w, d.sections()[0].1.page_w);
assert_eq!(print.pages[0].h, d.sections()[0].1.page_h);
// Window height changes page breaks, not the text, and a malformed dimension stays bounded.
let short = layout(&d, &mut LayoutCache::new(), &LayoutOptions { read_height: 260.0, ..opts.clone() });
assert!(short.pages.len() > read.pages.len());
let spaced = layout(&d, &mut LayoutCache::new(), &LayoutOptions { read_line_spacing: Some(2.0), ..opts.clone() });
assert!(spaced.pages.len() > read.pages.len(), "reader-only line spacing repaginates text");
let invalid = layout(&d, &mut LayoutCache::new(), &LayoutOptions { web_width: f32::NAN, read_height: f32::INFINITY, ..opts });
assert!(invalid.pages.iter().all(|p| p.w.is_finite() && p.h.is_finite()));
}
#[test]
fn hit_and_caret_agree() {
crate::test_fonts();
let d = Document::from_text("Hello world, this is WordCraft.\nSecond paragraph here.");
let l = lay(&d);
for off in [0, 5, 12, 31] {
let pos = Pos::body(0, off);
let c = l.caret(&pos).unwrap();
let back = l.hit(c.page, c.x + 0.1, c.top + c.height / 2.0, StoryRef::Body).unwrap();
assert_eq!(back, pos, "off {off}");
}
let c1 = l.caret(&Pos::body(1, 0)).unwrap();
let (down, _) = l.vertical(&Pos::body(0, 0), None, 1, 0).unwrap();
assert_eq!(down.path, Path::top(1));
assert!(c1.top > l.caret(&Pos::body(0, 0)).unwrap().top);
let (up, _) = l.vertical(&Pos::body(1, 3), None, -1, 0).unwrap();
assert_eq!(up.path, Path::top(0));
}
#[test]
fn selection_bar_finds_the_line_beside_the_pointer() {
crate::test_fonts();
// #856: the left margin beside a line is Word's selection bar.
let text = format!("{}\nShort.", "The quick brown fox jumps over the lazy dog. ".repeat(8));
let mut d = Document::from_text(&text);
d.insert_block(StoryRef::Body, &Path::top(2), wordcraft_doc::Block::Table(Table::new(1, 1, 468.0))).unwrap();
let l = lay(&d);
let p = &l.pages[0];
let c = l.caret(&Pos::body(0, 0)).unwrap();
let first = l.selection_bar_at(0, 30.0, c.top + c.height / 2.0).unwrap();
assert_eq!(first, Pos::body(0, 0));
// The second line of the wrapped paragraph: its start, and its span is the whole line.
let line2 = l.selection_bar_at(0, 30.0, c.top + c.height * 1.5).unwrap();
assert_eq!(line2.path, Path::top(0));
assert!(line2.off > 0);
let (a, b, last) = l.line_span(&line2, 0).unwrap();
assert_eq!(a, line2);
assert!(b.off > a.off && !last);
let (_, b, last) = l.line_span(&Pos::body(1, 0), 0).unwrap();
assert_eq!(b.off, "Short.".len());
assert!(last);
// In the text column, the header area, off the page or beside a table: not the bar.
assert_eq!(l.selection_bar_at(0, p.body.x + 5.0, c.top + 2.0), None);
assert_eq!(l.selection_bar_at(0, 30.0, p.body.y - 10.0), None);
assert_eq!(l.selection_bar_at(0, -5.0, c.top + 2.0), None);
assert_eq!(l.selection_bar_at(0, f32::NAN, c.top), None);
assert_eq!(l.selection_bar_at(9, 30.0, c.top), None);
let cell = l.caret(&Pos { story: StoryRef::Body, path: Path(vec![2, 0, 0, 0]), off: 0 }).unwrap();
assert_eq!(l.selection_bar_at(0, 30.0, cell.top + cell.height / 2.0), None);
// Dragging takes the nearest top-level line at any height.
assert_eq!(l.body_line_at(0, -100.0), Some(Pos::body(0, 0)));
}
#[test]
fn selection_bar_of_a_right_to_left_paragraph_is_in_the_right_margin() {
// Paragraph 0 reads left to right, paragraph 1 right to left, paragraph 2 left to right.
let mut d = Document::from_text("Left one\n\u{5e9}\u{5dc}\u{5d5}\u{5dd} \u{5e9}\u{5dc}\u{5d5}\u{5dd}\nLeft two");
let at = Pos::body(1, 0);
d.format_paragraphs(&at, &at, &|p: &mut ParaProps| p.bidi = Some(true)).unwrap();
let l = lay(&d);
let p = &l.pages[0];
let mid = |i: usize| {
let c = l.caret(&Pos::body(i, 0)).unwrap();
c.top + c.height / 2.0
};
let (left_x, right_x) = (p.body.x / 2.0, (p.body.right() + p.w) / 2.0);
// The right-to-left paragraph: the bar is on the right, not the left.
assert_eq!(l.selection_bar_at(0, right_x, mid(1)).map(|q| q.path), Some(Path::top(1)));
assert_eq!(l.selection_bar_at(0, left_x, mid(1)), None);
// Left-to-right neighbours keep the left margin only (each line uses its own side).
assert_eq!(l.selection_bar_at(0, left_x, mid(0)), Some(Pos::body(0, 0)));
assert_eq!(l.selection_bar_at(0, right_x, mid(0)), None);
assert_eq!(l.selection_bar_at(0, left_x, mid(2)), Some(Pos::body(2, 0)));
assert_eq!(l.selection_bar_at(0, right_x, mid(2)), None);
// Not in the text column, off the page, or hostile numbers.
assert_eq!(l.selection_bar_at(0, p.body.right() - 5.0, mid(1)), None);
assert_eq!(l.selection_bar_at(0, p.w + 5.0, mid(1)), None);
assert_eq!(l.selection_bar_at(0, f32::INFINITY, mid(1)), None);
// The line span is the whole line, as for the left bar.
let q = l.selection_bar_at(0, right_x, mid(1)).unwrap();
assert!(l.line_span(&q, 0).is_some());
}
#[test]
fn deletions_leave_the_final_text_layout() {
crate::test_fonts();
// "Keep " + deleted "DELETEDTEXT " (5..17) + inserted "INSERTED".
let mut d = Document::from_text("Keep DELETEDTEXT INSERTED");
d.format_range(&Pos::body(0, 5), &Pos::body(0, 17), &|c| c.del = Some(0)).unwrap();
d.format_range(&Pos::body(0, 17), &Pos::body(0, 25), &|c| c.ins = Some(0)).unwrap();
let texts = |l: &DocLayout, markup: bool| -> (String, usize) {
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions { markup, ..Default::default() });
let text = items.iter().filter_map(|i| if let display::Draw::Glyphs { text, .. } = i { Some(text.as_str()) } else { None }).collect();
(text, items.iter().filter(|i| matches!(i, display::Draw::Line { .. })).count())
};
// Markup: the deletion is laid out and struck through, the insertion underlined, and the
// changed line has a bar in the margin.
let full = lay(&d);
assert_eq!(texts(&full, true), ("Keep DELETEDTEXT INSERTED".into(), 3));
// Without markup a full layout still never prints the deletion as plain text.
assert!(!texts(&full, false).0.contains("DELETED"));
// The final layout gives the deletion no width.
let fin = layout(&d, &mut LayoutCache::new(), &LayoutOptions { hide_deleted: true, ..Default::default() });
assert_eq!(texts(&fin, false), ("Keep INSERTED".into(), 0));
let at = |off| fin.caret(&Pos::body(0, off)).unwrap();
assert!((at(5).x - at(17).x).abs() < 0.01, "{:?} {:?}", at(5), at(17));
// Every offset maps to a caret, and clicks land outside the hidden text.
for off in 0..=25 {
let c = at(off);
let back = fin.hit(c.page, c.x + 0.1, c.top + c.height / 2.0, StoryRef::Body).unwrap();
assert!(back.off <= 5 || back.off >= 17, "off {off} hit {back:?}");
}
}
#[test]
fn deleted_soft_hyphen_is_no_hyphenation_point_without_markup() {
crate::test_fonts();
// "ab\u{ad}cdef" in a column where "ab-" fits but the whole word does not; only the soft
// hyphen is track-deleted.
let mut d = Document::from_text("ab\u{ad}cdef");
d.format_range(&Pos::body(0, 2), &Pos::body(0, 4), &|c| c.del = Some(0)).unwrap();
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.indent_right = Some(468.0 - 26.0)).unwrap();
let hyphens = |hide_deleted: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { hide_deleted, ..Default::default() });
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
para.lines.iter().filter(|l| l.hyphen.is_some()).count()
};
// With markup the deleted soft hyphen is still there, and the word breaks at it.
assert_eq!(hyphens(false), 1);
// Final text: the soft hyphen is gone, so is the hyphen.
assert_eq!(hyphens(true), 0);
}
#[test]
fn deleted_text_adds_no_line_break_opportunity_without_markup() {
crate::test_fonts();
// "xx ab\u{ad}cdef" in a column where "xx ab-" and "abcdef" fit but "xx abcdef" does not; only
// the soft hyphen (5..7) is track-deleted.
let mut d = Document::from_text("xx ab\u{ad}cdef");
Arc::make_mut(&mut d.styles).default_chr.font = Some(WRAP_TEST_FONT.into());
d.format_range(&Pos::body(0, 5), &Pos::body(0, 7), &|c| c.del = Some(0)).unwrap();
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.indent_right = Some(468.0 - 40.0)).unwrap();
let line_starts = |hide_deleted: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { hide_deleted, ..Default::default() });
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
para.lines.iter().map(|l| para.clusters.get(l.c0).map_or(usize::MAX, |c| c.start)).collect::<Vec<_>>()
};
// With markup the word breaks at the (deleted) soft hyphen.
assert_eq!(line_starts(false), vec![0, 7]);
// Final text: "abcdef" is one word, so the line breaks at the space before it.
assert_eq!(line_starts(true), vec![0, 3]);
}
#[test]
fn hidden_soft_hyphen_is_no_hyphenation_point_when_hidden_text_is_not_shown() {
crate::test_fonts();
// As with deletions: "ab\u{ad}cdef" where only the soft hyphen is hidden text.
let mut d = Document::from_text("ab\u{ad}cdef");
d.format_range(&Pos::body(0, 2), &Pos::body(0, 4), &|c| c.hidden = Some(true)).unwrap();
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.indent_right = Some(468.0 - 26.0)).unwrap();
let hyphens = |show_hidden: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
para.lines.iter().filter(|l| l.hyphen.is_some()).count()
};
// Hidden text shown: the soft hyphen is there, and the word breaks at it.
assert_eq!(hyphens(true), 1);
// Not shown (as printed): no soft hyphen, so no hyphen. Word breaks "abc" / "def" here.
assert_eq!(hyphens(false), 0);
}
#[test]
fn hidden_text_adds_no_line_break_opportunity_when_not_shown() {
crate::test_fonts();
// "xx ab" + hidden soft hyphen or space + "cdef", in a column where "xx ab-" and "abcdef" fit
// but "xx abcdef" does not. Measured in Word (hidden text not printed): "xx" / "abcdef" both times.
for hidden in ["\u{ad}", " "] {
let mut d = Document::from_text(&format!("xx ab{hidden}cdef"));
Arc::make_mut(&mut d.styles).default_chr.font = Some(WRAP_TEST_FONT.into());
let end = 5 + hidden.len();
d.format_range(&Pos::body(0, 5), &Pos::body(0, end), &|c| c.hidden = Some(true)).unwrap();
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.indent_right = Some(468.0 - 40.0)).unwrap();
let line_starts = |show_hidden: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
para.lines.iter().map(|l| para.clusters.get(l.c0).map_or(usize::MAX, |c| c.start)).collect::<Vec<_>>()
};
// Shown, the word breaks at the hidden soft hyphen or space.
assert_eq!(line_starts(true), vec![0, end], "{hidden:?}");
// Not shown, "abcdef" is one word, so the line breaks at the space before it.
assert_eq!(line_starts(false), vec![0, 3], "{hidden:?}");
}
}
/// How much bigger the second document is in the linear-time tests. At 8x a linear layout costs
/// about 8x as much and a quadratic one about 64x, so a limit of 24x stays far from both.
pub(crate) const SCALE: usize = 8;
/// The CPU time `f` takes on this thread, in seconds. On Linux it is the scheduler's count of the
/// time the thread actually ran, so the time it waits while other work on a busy machine has the
/// CPU is left out. When the counter does not advance, or elsewhere, use wall-clock time.
fn cpu_cost(f: &mut impl FnMut()) -> f64 {
let ran = || {
let s = std::fs::read_to_string("/proc/thread-self/schedstat").ok()?;
s.split_whitespace().next()?.parse::<u64>().ok()
};
let (t, before) = (std::time::Instant::now(), ran());
f();
match (before, ran()) {
(Some(a), Some(b)) if b > a => (b - a) as f64 * 1e-9,
_ => t.elapsed().as_secs_f64(),
}
}
/// How much more `big` costs than `small`, for `big` an input `scale` times the size of `small`'s:
/// (small, big, big / small), ~`scale` when linear and ~`scale`² when quadratic. Each is the
/// cheapest of several runs after a warm-up, the runs alternating so a busy spell slows both sizes
/// alike; `small` is timed `scale` times over per run, so both timings are long against the clock's
/// resolution.
pub(crate) fn cost_ratio(scale: usize, mut small: impl FnMut(), mut big: impl FnMut()) -> (f64, f64, f64) {
small();
big();
let mut small_scaled = || (0..scale).for_each(|_| small());
let (mut t1, mut tk) = (f64::INFINITY, f64::INFINITY);
for _ in 0..5 {
t1 = t1.min(cpu_cost(&mut small_scaled) / scale as f64);
tk = tk.min(cpu_cost(&mut big));
}
(t1, tk, tk / t1.max(1e-9))
}
/// [`cost_ratio`] of laying out `doc(SCALE * n)` against `doc(n)`.
pub(crate) fn layout_time_ratio(doc: impl Fn(usize) -> Document, n: usize, opts: &LayoutOptions) -> (f64, f64, f64) {
let (small, big) = (doc(n), doc(SCALE * n));
cost_ratio(
SCALE,
|| {
layout(&small, &mut LayoutCache::new(), opts);
},
|| {
layout(&big, &mut LayoutCache::new(), opts);
},
)
}
/// A document that is one word with no break opportunity in it, laid out beside a floating
/// object: the word is wider than the span the object leaves, so the measurement that asks
/// whether it would fit the full line runs for every line the word takes.
fn long_word_beside_a_float(n: usize) -> Document {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&"a".repeat(n));
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(0, 0), rect_shape(144.0, 100.0, f), &Default::default()).unwrap();
d
}
/// A word with no break opportunity in it: measuring the word for every line it takes scanned
/// the whole paragraph each time, so the layout was quadratic in the word's length.
#[test]
#[cfg_attr(coverage, ignore = "coverage instrumentation skews the time ratio")]
fn a_long_unbreakable_word_lays_out_in_linear_time() {
let (t1, tk, ratio) = layout_time_ratio(long_word_beside_a_float, 50_000, &LayoutOptions::default());
eprintln!("t(n) {t1:.4} s, t(8n) {tk:.4} s, ratio {ratio:.1}");
assert!(ratio < 24.0, "8x the word took {ratio:.1}x the time ({t1:.4} s → {tk:.4} s): not linear");
}
/// A word a megabyte long lays out in a fraction of a second: it used to take half a minute.
#[test]
#[cfg_attr(coverage, ignore = "coverage instrumentation skews the measured time")]
fn a_megabyte_long_word_lays_out_quickly() {
let d = long_word_beside_a_float(1_000_000);
let t = std::time::Instant::now();
lay(&d);
assert!(t.elapsed().as_secs() < 15, "a megabyte-long word took {:?}", t.elapsed());
}
/// A cluster with the given advance and kind, for the tests that measure a word by hand.
fn word_cluster(kind: para::ClKind, adv: f32, break_after: bool) -> para::Cluster {
para::Cluster { start: 0, end: 1, adv, kind, style: 0, g0: 0, g1: 1, break_after, obj_h: 0.0, obj_d: 0.0, dot: false }
}
/// A word that a negative advance makes narrower still fits beside a float: the width of a word
/// is the sum of its advances, and a font that pulls a glyph back takes the width off again.
#[test]
fn a_word_a_negative_advance_narrows_still_fits() {
// A hundred points, then a font that pulls the last glyph back by sixty: the word is forty
// wide, and fits in sixty.
let clusters = vec![word_cluster(para::ClKind::Text, 100.0, false), word_cluster(para::ClKind::Text, -60.0, true)];
let widths = para::word_widths(&clusters, &[]);
assert_eq!(widths[0], 40.0, "the word is the sum of its advances");
assert!(widths[0] <= 60.0, "a word of forty points fits in sixty");
assert!(widths[0] > 30.0, "a word of forty points does not fit in thirty");
// The same word in a document: a font that pulls one glyph back takes the width off the
// rest of the word too, and the strip a floating object leaves is the row's only span, so
// the word is measured against it.
use wordcraft_doc::para::{Anchor, Float, ShapeKind, Wrap};
// Twelve characters, the sixth of them pulled back by thirty points.
let word = |pull: f32| {
let mut d = Document::from_text(&"a".repeat(12));
if pull != 0.0 {
d.format_range(&Pos::body(0, 5), &Pos::body(0, 6), &|c| c.spacing = Some(pull)).unwrap();
}
d
};
fn body(l: &DocLayout) -> &ParaLayout {
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { story: StoryRef::Body, .. })) else {
panic!("no body text on the page")
};
para
}
// The width of the word: the sum of its advances, its last glyph's right edge.
let width = |d: &Document| {
let l = lay(d);
let para = body(&l);
let ln = ¶.lines[0];
let last = ln.c1 - 1;
ln.xs[last - ln.c0] + para.clusters[last].adv
};
let plain = width(&word(0.0));
let pulled = width(&word(-30.0));
assert!(pulled < plain, "a font that pulls a glyph back makes the word narrower: {pulled} against {plain}");
// The strip the object leaves is half way between the two widths: the word fits it with the
// glyph pulled back, and does not fit it without.
let strip = (plain + pulled) / 2.0;
// The lines of the word laid out beside an object that leaves a strip of that width: (top,
// left, the clusters it covers, where its text ends, whether it ends inside a word).
let beside = |d: Document| {
let float = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 0.0, ..Default::default() };
let shape = InlineObject::Shape {
kind: ShapeKind::Rectangle,
w: 468.0 - strip,
h: 150.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
effects: Default::default(),
freeform: None,
extra: Default::default(),
};
let mut d = d;
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let l = lay(&d);
let para = body(&l);
para.lines
.iter()
.map(|ln| {
let inside = ln.c1 > ln.c0 && ln.end == para::LineEnd::Wrap && !para.clusters[ln.c1 - 1].break_after;
(ln.top, ln.left, ln.c1, ink_end(para, ln), inside)
})
.collect::<Vec<_>>()
};
// The narrower word fits the strip beside the object and stays there.
let fits = beside(word(-30.0));
assert_eq!(fits.len(), 1, "the word fits the strip beside the object: {fits:?}");
assert!(fits[0].1 >= 468.0 - strip - 0.01, "the word is in the strip beside the object: {fits:?}");
assert!(fits[0].3 <= 468.0 + 0.01, "the word ends inside the strip: {fits:?}");
assert!(!fits[0].4, "the word is not split across the strip: {fits:?}");
// The wider one does not: it moves on whole, below the object, rather than being split
// across the strip.
let moves_on = beside(word(0.0));
assert!(moves_on.iter().any(|l| l.0 >= 150.0 - 0.01 && l.1 < 1.0), "the wider word is laid out below the object: {moves_on:?}");
assert!(moves_on.iter().all(|l| !l.4), "the word is not split across the strip: {moves_on:?}");
}
/// The words after a break are words of their own: their advances are not counted in the word
/// before them, or a long word followed by a word that pulls the width back would be measured
/// as if the two were one.
#[test]
fn the_words_after_a_break_are_not_counted_in_the_word_before_it() {
// A word of two ordinary clusters, then a break, then a word that pulls a hundred points
// back.
let clusters = vec![
word_cluster(para::ClKind::Text, 10.0, false),
word_cluster(para::ClKind::Text, 10.0, true),
word_cluster(para::ClKind::Text, -100.0, true),
];
let widths = para::word_widths(&clusters, &[]);
assert_eq!(widths[0], 20.0, "the word after the break must not hold up the word before it");
assert_eq!(widths[1], 10.0, "the word that ends at the break is a word of its own");
assert_eq!(widths[2], -100.0);
}
/// A word whose advances alternate in sign is measured by their sum: a font that pulls some
/// glyphs back must not make the measurement walk the word to find out how wide it is.
#[test]
fn a_word_whose_advances_alternate_is_measured_by_its_sum() {
// A thousand points forward, nine hundred and ninety-nine back: the word is one point wider
// per pair, so it is far wider than the room even though it is never wider than a thousand
// points at a time.
let mut clusters = Vec::new();
for i in 0..1_000 {
clusters.push(word_cluster(para::ClKind::Text, if i % 2 == 0 { 1000.0 } else { -999.0 }, false));
}
clusters.push(word_cluster(para::ClKind::Text, 0.0, true));
let widths = para::word_widths(&clusters, &[]);
assert_eq!(widths[0], 500.0, "the word is the sum of its advances");
}
/// The width of a word is the sum of its advances: the same sum the scan this replaces took, over
/// every shape of word — negative advances, spaces, break opportunities and hyphenation points
/// included.
#[test]
fn a_word_is_measured_by_the_sum_of_its_advances() {
// The measurement as the scan this replaces took it: the clusters up to the first break
// opportunity that isn't a hyphenation point, their advance, spaces aside.
let scan = |clusters: &[para::Cluster], hyph: &[u32], c0: usize| -> f32 {
let mut done = false;
let mut word = 0.0f32;
for (k, c) in (c0..clusters.len()).map(|k| (k, &clusters[k])) {
let end = c.break_after && hyph.binary_search(&(k as u32)).is_err();
if done {
break;
}
done = end;
if c.kind != para::ClKind::Space {
word += c.adv;
}
}
word
};
// A deterministic spread of advances, spaces, breaks and hyphenation points.
let mut seed = 0x2545_f491_4f6c_dd1du64;
let mut next = move || {
seed = seed.wrapping_mul(6364136223846793005).wrapping_add(1442695040888963407);
(seed >> 33) as i32
};
for _ in 0..2_000 {
let n = 1 + next().unsigned_abs() as usize % 40;
let clusters: Vec<para::Cluster> = (0..n)
.map(|_| {
let kind = if next() % 7 == 0 { para::ClKind::Space } else { para::ClKind::Text };
word_cluster(kind, (next() % 4000) as f32 / 100.0 - 20.0, next() % 3 == 0)
})
.collect();
let mut hyph = Vec::new();
if next() % 2 == 0 {
for _ in 0..next().unsigned_abs() as usize % 4 {
hyph.push(next().unsigned_abs() % n as u32);
}
hyph.sort_unstable();
hyph.dedup();
}
let widths = para::word_widths(&clusters, &hyph);
for (c0, &width) in widths.iter().enumerate().take(n) {
// The two sums are the same number, added in a different order: one adds the word's
// advances from its start and the other from its end, and a float sum depends on
// the order it is added in. The difference is far below the tenth of a point the
// comparison that uses the width allows.
let scan = scan(&clusters, &hyph, c0);
assert!((width - scan).abs() < 0.001, "the word at cluster {c0} of {clusters:?} is {width}, the scan says {scan}");
}
}
}
/// A word with no break opportunity in it whose advances alternate in sign: a run with wide
/// character spacing and a run with condensed spacing, so that half the glyphs are pulled back.
/// The word is wider than the line it is laid out on, so it takes a line per few characters, and
/// measuring it must not walk it again for every one of those lines.
fn long_word_with_alternating_advances_beside_a_float(n: usize) -> Document {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&"a".repeat(n));
// One run per block of characters, alternating the spacing: half the glyphs are pulled back.
let block = 64;
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.runs = (0..n.div_ceil(block))
.map(|i| wordcraft_doc::Run {
len: block.min(n - i * block),
props: wordcraft_doc::CharProps { spacing: Some(if i % 2 == 0 { 50.0 } else { -50.0 }), ..Default::default() },
})
.collect();
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(0, 0), rect_shape(144.0, 100.0, f), &Default::default()).unwrap();
d
}
/// A word whose advances alternate in sign lays out in linear time: the measurement that asks
/// whether it would fit the full line must not walk the word again for every line it takes.
#[test]
#[cfg_attr(coverage, ignore = "coverage instrumentation skews the time ratio")]
fn a_word_with_alternating_advances_lays_out_in_linear_time() {
let (t1, tk, ratio) = layout_time_ratio(long_word_with_alternating_advances_beside_a_float, 50_000, &LayoutOptions::default());
eprintln!("t(n) {t1:.4} s, t(8n) {tk:.4} s, ratio {ratio:.1}");
assert!(ratio < 24.0, "8x the word took {ratio:.1}x the time ({t1:.4} s → {tk:.4} s): not linear");
}
#[test]
#[cfg_attr(coverage, ignore = "coverage instrumentation skews the measured time")]
fn hidden_separators_with_automatic_hyphenation_lay_out_in_linear_time() {
crate::test_fonts();
// "hyphenation " n times with every space hidden: one joined word of 11n letters reaches the
// hyphenator, whose limit checks once rescanned the word for every candidate point.
let doc = |n: usize| {
let mut d = Document::from_text(&"hyphenation ".repeat(n));
d.settings.auto_hyphenation = true;
for k in 0..n {
let at = 12 * k + 11;
d.format_range(&Pos::body(0, at), &Pos::body(0, at + 1), &|c| c.hidden = Some(true)).unwrap();
}
d
};
let (t1, tk, ratio) = layout_time_ratio(doc, 800, &LayoutOptions::default());
eprintln!("t(n) {t1:.4} s, t(8n) {tk:.4} s, ratio {ratio:.1}");
assert!(ratio < 24.0, "8x the text took {ratio:.1}x the time ({t1:.4} s → {tk:.4} s): not linear");
}
/// n one-line paragraphs, each starting a page.
fn page_break_paragraphs(n: usize) -> Document {
let mut d = Document::from_text(&"hello\n".repeat(n));
for i in 0..n {
d.para_mut(StoryRef::Body, &Path::top(i)).unwrap().props.page_break_before = Some(true);
}
d
}
/// A document of many paragraphs lays out in linear time. Every page asks the layout for the
/// section properties (for the wrap areas of the headers and footers), and that used to rebuild
/// the section list by walking the whole body, so a document of n paragraphs paid n body-length
/// scans: a two-megabyte file took half a minute before the first page was drawn.
#[test]
#[cfg_attr(coverage, ignore = "coverage instrumentation skews the measured time")]
fn a_document_of_many_paragraphs_lays_out_in_linear_time() {
let (t1, tk, ratio) = layout_time_ratio(page_break_paragraphs, 2_500, &LayoutOptions::default());
eprintln!("t(n) {t1:.4} s, t(8n) {tk:.4} s, ratio {ratio:.1}");
assert!(ratio < 24.0, "8x the paragraphs took {ratio:.1}x the time ({t1:.4} s → {tk:.4} s): not linear");
}
#[test]
#[cfg_attr(coverage, ignore = "coverage instrumentation skews the measured time")]
fn many_hidden_float_anchors_lay_out_in_linear_time() {
crate::test_fonts();
// n square-wrapped shapes, each anchored in its own hidden run (bold alternating, so runs do not
// merge), markup on: finding each anchor's formatting once rescanned the runs from the start.
let doc = |n: usize| {
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x: 0.0,
y: 0.0,
dist: 9.0,
dist_top: 9.0,
dist_bottom: 9.0,
..Default::default()
};
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 20.0,
h: 20.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
let obj = wordcraft_doc::para::OBJ.to_string();
let mut p = wordcraft_doc::Paragraph::with_text("Text ", Default::default());
p.text.push_str(&obj.repeat(n));
p.objects = vec![shape; n];
p.runs = std::iter::once(wordcraft_doc::Run { len: 5, props: Default::default() })
.chain((0..n).map(|i| wordcraft_doc::Run {
len: obj.len(),
props: wordcraft_doc::CharProps { hidden: Some(true), bold: Some(i % 2 == 0), ..Default::default() },
}))
.collect();
let mut d = Document::from_text("");
d.body = vec![wordcraft_doc::para_block(p)];
d
};
// Correct first: hidden anchors place no shape, shown ones do.
let shapes = |show_hidden: bool| {
let l = layout(&doc(50), &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
l.pages.iter().flat_map(|p| p.items.iter()).filter(|i| matches!(i, Placed::Shape { .. })).count()
};
assert_eq!((shapes(false), shapes(true)), (0, 50));
let (t1, tk, ratio) = layout_time_ratio(doc, 10_000, &LayoutOptions::default());
eprintln!("t(n) {t1:.4} s, t(8n) {tk:.4} s, ratio {ratio:.1}");
assert!(ratio < 24.0, "8x the anchors took {ratio:.1}x the time ({t1:.4} s → {tk:.4} s): not linear");
}
#[test]
fn fragmented_hidden_text_lays_out_like_the_visible_text() {
crate::test_fonts();
// Visible words with a hidden multi-byte char after every visible one, formatted in alternating
// runs (bold on and off) so no two left-out runs are adjacent or merge. The plain paragraph has
// the same visible runs without the hidden chars, so both lay out the same widths whatever font
// the default font resolves to.
let words = "Hyphenation wraps international words across narrow columns of text ".repeat(6);
let mut d = Document::from_text("");
d.settings.auto_hyphenation = true;
let mut plain = Document::from_text("");
plain.settings.auto_hyphenation = true;
let mut text = String::new();
let mut kept = Vec::new();
for (i, c) in words.chars().enumerate() {
kept.push(text.len());
text.push(c);
let at = text.len();
text.push('é');
let n = d.para(StoryRef::Body, &Path::top(0)).unwrap().len();
let bold = wordcraft_doc::CharProps { bold: Some(i % 2 == 0), ..Default::default() };
d.insert_text(&Pos::body(0, n), &c.to_string(), &bold).unwrap();
let hidden = wordcraft_doc::CharProps { hidden: Some(true), bold: Some(i % 2 == 1), ..Default::default() };
d.insert_text(&Pos::body(0, at), "é", &hidden).unwrap();
let n = plain.para(StoryRef::Body, &Path::top(0)).unwrap().len();
plain.insert_text(&Pos::body(0, n), &c.to_string(), &bold).unwrap();
}
assert_eq!(d.para(StoryRef::Body, &Path::top(0)).unwrap().text, text);
assert_eq!(plain.para(StoryRef::Body, &Path::top(0)).unwrap().text, words);
for doc in [&mut d, &mut plain] {
doc.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.indent_right = Some(468.0 - 90.0)).unwrap();
}
// Line starts and hyphenation points, as paragraph offsets.
let shape = |d: &Document| {
let l = layout(d, &mut LayoutCache::new(), &LayoutOptions::default());
let paras: Vec<_> = l
.pages
.iter()
.flat_map(|p| p.items.iter())
.filter_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None })
.collect();
let para = ¶s[0];
let starts: Vec<usize> = para.lines.iter().map(|l| para.clusters.get(l.c0).map_or(usize::MAX, |c| c.start)).collect();
let hyph: Vec<usize> = para.hyph_after.iter().map(|k| para.clusters[*k as usize].end).collect();
(starts, hyph)
};
let (starts, hyph) = shape(&plain);
assert!(starts.len() > 5 && !hyph.is_empty(), "{starts:?} {hyph:?}");
// Mapped to the fragmented paragraph: a line starts after the previous visible char (with the
// hidden one that follows it, which takes no room), a hyphen point is after its char.
let want_starts: Vec<usize> = starts.iter().map(|s| if *s == 0 { 0 } else { kept[s - 1] + 1 }).collect();
let want_hyph: Vec<usize> = hyph.iter().map(|e| kept[e - 1] + 1).collect();
assert_eq!(shape(&d), (want_starts, want_hyph));
}
#[test]
fn automatic_hyphenation_sees_only_the_text_laid_out() {
crate::test_fonts();
// Paragraph-text ends of the clusters after which a line may end with a hyphen.
let hyph_ends = |d: &Document, opts: &LayoutOptions| {
let l = layout(d, &mut LayoutCache::new(), opts);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
para.hyph_after.iter().map(|k| para.clusters[*k as usize].end).collect::<Vec<_>>()
};
let doc = |text: &str| {
let mut d = Document::from_text(text);
d.settings.auto_hyphenation = true;
d
};
// (text, hidden bytes, deleted bytes, the text as laid out without them).
let cases = [
// A hidden prefix: "table" must not break after its first letter as "acceptable" may.
("acceptable", 0..5, 0..0, "table"),
// A hidden separator joins two words into one.
("foot ball", 4..5, 0..0, "football"),
// Hidden text and a tracked deletion together.
("accXeptYable", 7..8, 3..4, "acceptable"),
];
let hidden_opts = LayoutOptions { hide_deleted: true, ..Default::default() };
for (text, hidden, deleted, visible) in cases {
let mut d = doc(text);
d.format_range(&Pos::body(0, hidden.start), &Pos::body(0, hidden.end), &|c| c.hidden = Some(true)).unwrap();
if !deleted.is_empty() {
d.format_range(&Pos::body(0, deleted.start), &Pos::body(0, deleted.end), &|c| c.del = Some(0)).unwrap();
}
// The same points as the visible text alone, at the matching paragraph offsets.
let kept: Vec<usize> = (0..text.len()).filter(|i| !hidden.contains(i) && !deleted.contains(i)).collect();
let want: Vec<usize> = hyph_ends(&doc(visible), &hidden_opts).iter().map(|e| kept[e - 1] + 1).collect();
assert_eq!(hyph_ends(&d, &hidden_opts), want, "{text:?} as {visible:?}");
// Hidden text shown and markup shown: the whole text is hyphenated as before.
let all = LayoutOptions { show_hidden: true, ..Default::default() };
assert_eq!(hyph_ends(&d, &all), hyph_ends(&doc(text), &all), "{text:?} shown");
}
}
#[test]
fn page_break_char_starts_new_page() {
crate::test_fonts();
let mut d = Document::from_text("one");
d.insert_text(&Pos::body(0, 3), "\u{000C}", &Default::default()).unwrap();
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
}
/// Legacy form fields are drawn as Word draws them: a check box is a square as tall as the text's
/// line, inset 1.16 pt, taking that line height of room, with an X when checked (`w:checked`
/// beating `w:default`); a drop-down shows its selected entry whatever result was saved.
#[test]
fn legacy_form_fields_are_drawn() {
crate::test_fonts();
let field = |form: &str| InlineObject::Field {
instr: "FORMCHECKBOX".into(),
result: String::new(),
locked: false,
dirty: false,
code: false,
form: form.into(),
};
let check_box = |state: &str| format!(r#"<w:ffData><w:name w:val="Box"/><w:checkBox><w:sizeAuto/>{state}</w:checkBox></w:ffData>"#);
let draws_of = |o: InlineObject| {
let mut d = Document::from_text("ab");
d.insert_object(&Pos::body(0, 1), o, &Default::default()).unwrap();
let l = lay(&d);
let b_x = l.caret(&Pos::body(0, 1 + wordcraft_doc::para::OBJ.len_utf8())).unwrap().x;
let a_x = l.caret(&Pos::body(0, 1)).unwrap().x;
(display::page_display(&d, &l.pages[0], &display::DisplayOptions::default()), b_x - a_x)
};
let squares = |items: &[display::Draw]| -> Vec<wordcraft_geom::Rect> {
items
.iter()
.filter_map(|i| {
if let display::Draw::Shape { rect, kind: wordcraft_doc::para::ShapeKind::Rectangle, stroke: Some(_), .. } = i {
Some(*rect)
} else {
None
}
})
.collect()
};
let diagonals = |items: &[display::Draw]| {
items.iter().filter(|i| matches!(i, display::Draw::Line { x0, x1, y0, y1, .. } if (x1 - x0).abs() > 1.0 && (y1 - y0).abs() > 1.0)).count()
};
let (items, room) = draws_of(field(&check_box(r#"<w:default w:val="0"/>"#)));
let sq = squares(&items);
assert_eq!(sq.len(), 1, "one square: {items:?}");
assert!((sq[0].w - sq[0].h).abs() < 0.01 && (room - sq[0].w - 2.0 * display::CHECK_BOX_INSET).abs() < 0.01, "{:?} in {room}", sq[0]);
assert!(sq[0].w > 8.0 && sq[0].w < 14.0, "about the line's height: {}", sq[0].w);
assert_eq!(diagonals(&items), 0, "unchecked");
assert_eq!(diagonals(&draws_of(field(&check_box(r#"<w:default w:val="1"/>"#))).0), 2, "checked by default");
assert_eq!(diagonals(&draws_of(field(&check_box(r#"<w:default w:val="1"/><w:checked w:val="0"/>"#))).0), 0, "w:checked wins");
// An explicit size: 20 pt is about twice the 10-11 pt text's square.
let (big, _) = draws_of(field(&check_box(r#"<w:size w:val="40"/><w:default w:val="0"/>"#)));
assert!(squares(&big)[0].w > sq[0].w * 1.6, "{:?} vs {:?}", squares(&big), sq);
// A drop-down shows its selected entry.
let dd = InlineObject::Field {
instr: "FORMDROPDOWN".into(),
result: String::new(),
locked: false,
dirty: false,
code: false,
form: r#"<w:ffData><w:name w:val="List"/><w:ddList><w:result w:val="1"/><w:listEntry w:val="Alpha"/><w:listEntry w:val="Beta"/></w:ddList></w:ffData>"#.into(),
};
let (items, _) = draws_of(dd);
let text: String = items.iter().filter_map(|i| if let display::Draw::Glyphs { text, .. } = i { Some(text.as_str()) } else { None }).collect();
assert!(text.contains("Beta") && !text.contains("Alpha"), "{text}");
}
#[test]
fn a_missing_roman_font_is_drawn_as_word_draws_it() {
crate::test_fonts();
// Measured in Word: a font that isn't installed is drawn in Cambria when the font table calls
// it roman, in Calibri otherwise.
let face = |roman: bool| {
let mut d = Document::from_text("Serif");
if roman {
d.settings.roman_fonts = vec!["No Such Brand Font".into()];
}
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.runs[0].props.font = Some("No Such Brand Font".into());
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!("no text") };
let first = para.clusters.first().expect("a cluster");
para.styles[first.style as usize].face
};
let cambria = wordcraft_fonts::word::resolve("Cambria", false, false).face;
assert_eq!(face(true), cambria);
assert_ne!(face(false), cambria);
}
#[test]
fn a_missing_font_is_drawn_in_its_font_table_alternate() {
crate::test_fonts();
// Measured in Word 2024 and Word for Windows 16.0.20527 (#2702): a font that isn't installed is
// drawn in the alternate its font table names (`w:altName`), before the roman rule; an
// alternate that can't be drawn either leaves the family class in charge: Cambria for a roman
// or modern font, the generic substitutes (Calibri in Word) for a swiss one.
#[derive(Clone, Copy)]
enum Family {
Swiss,
Roman,
Modern,
}
let face_of = |alt: Option<&str>, family: Family| {
let mut d = Document::from_text("Lanterns");
if let Some(alt) = alt {
d.settings.font_alt_names = vec![("No Such Brand Font".into(), alt.into())];
}
match family {
Family::Roman => d.settings.roman_fonts = vec!["No Such Brand Font".into()],
Family::Modern => d.settings.modern_fonts = vec!["No Such Brand Font".into()],
Family::Swiss => {}
}
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.runs[0].props.font = Some("No Such Brand Font".into());
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!("no text") };
let first = para.clusters.first().expect("a cluster");
para.styles[first.style as usize].face
};
let face = |alt: Option<&str>, roman: bool| face_of(alt, if roman { Family::Roman } else { Family::Swiss });
let resolve = |f: &str| wordcraft_fonts::word::resolve(f, false, false).face;
let (courier, times, calibri, cambria) = (resolve("Courier New"), resolve("Times New Roman"), resolve("Calibri"), resolve("Cambria"));
let generic = face(None, false);
// Serif and sans faces are bundled, so these differ on any machine.
assert_ne!(times, generic);
assert_ne!(cambria, generic);
// A, B: a missing font with an alternate.
assert_eq!(face(Some("Times New Roman"), false), times);
assert_eq!(face(Some("Courier New"), false), courier);
// go_math (docxide-pdf corpus): Museo Sans 300 → Calibri.
assert_eq!(face(Some("Calibri"), false), calibri);
// D: the alternate beats the roman rule.
assert_eq!(face(Some("Times New Roman"), true), times);
assert_eq!(face(Some("Courier New"), true), courier);
// E: an alternate that is missing too, with no substitutes of its own: the roman rule, or the
// generic substitutes for a font that isn't roman.
assert_eq!(face(Some("No Such Alternate"), true), cambria);
assert_eq!(face(Some("No Such Alternate"), false), generic);
// Word reads a value with a comma as one name, not a list (MS-OE376 2.1.264): no font is
// called that, so the roman rule or the generic substitutes draw it.
assert_eq!(face(Some("No Such Alternate, Times New Roman"), false), generic);
assert_eq!(face(Some("No Such Alternate, Times New Roman"), true), cambria);
// A modern font: its installed alternate draws it, a missing alternate leaves it in Cambria,
// and with no alternate at all it takes the generic substitutes (Calibri in Word).
assert_eq!(face_of(Some("Courier New"), Family::Modern), courier);
assert_eq!(face_of(Some("No Such Alternate"), Family::Modern), cambria);
assert_eq!(face_of(None, Family::Modern), generic);
// An alternate that names another missing font with an alternate of its own: the chain isn't
// followed.
let mut d = Document::from_text("Lanterns");
d.settings.font_alt_names = vec![("No Such Brand Font".into(), "No Such Alternate".into()), ("No Such Alternate".into(), "Courier New".into())];
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.runs[0].props.font = Some("No Such Brand Font".into());
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!("no text") };
let first = para.clusters.first().expect("a cluster");
assert_eq!(para.styles[first.style as usize].face, generic, "the chain isn't followed");
}
#[test]
fn an_installed_font_ignores_its_font_table_alternate() {
// The alternate is only for a font that isn't there: an installed (here bundled) font keeps its
// own face.
let font = wordcraft_fonts::FALLBACK_FAMILY;
let mut d = Document::from_text("Lanterns");
d.settings.font_alt_names = vec![(font.into(), "Times New Roman".into())];
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.runs[0].props.font = Some(font.into());
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!("no text") };
let first = para.clusters.first().expect("a cluster");
let own = wordcraft_fonts::word::resolve(font, false, false).face;
assert_ne!(own, wordcraft_fonts::word::resolve("Times New Roman", false, false).face);
assert_eq!(para.styles[first.style as usize].face, own);
}
#[test]
fn a_missing_roman_font_with_its_own_substitute_keeps_it() {
crate::test_fonts();
// Times New Roman is roman in every font table. Where it isn't installed it keeps its metric
// clone (Liberation Serif), not Cambria: Word, which always has it, never draws it missing.
let mut d = Document::from_text("Serif");
d.settings.roman_fonts = vec!["Times New Roman".into()];
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.runs[0].props.font = Some("Times New Roman".into());
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!("no text") };
let first = para.clusters.first().expect("a cluster");
assert_eq!(para.styles[first.style as usize].face, wordcraft_fonts::word::resolve("Times New Roman", false, false).face);
}
#[test]
fn an_empty_section_mark_stays_on_a_full_page() {
crate::test_fonts();
use wordcraft_doc::section::SectionProps;
// Measured in Word: a page filled to the bottom, then an empty paragraph carrying a next-page
// section break, makes no page for the mark; the next section starts on page 2. A plain empty
// paragraph moves on as usual.
let pages = |carries_section: bool| {
let lines: Vec<String> = (1..=200).map(|i| format!("Line {i}")).collect();
let d = Document::from_text(&lines.join("\n"));
let one_page = lay(&d).pages[0].items.iter().filter(|i| matches!(i, Placed::Lines { .. })).count();
let mut d = Document::from_text(&format!("{}\n\nNext", lines[..one_page].join("\n")));
let mark = d.para_mut(StoryRef::Body, &Path::top(one_page)).unwrap();
if carries_section {
mark.section = Some(Box::new(SectionProps::default()));
} else {
d.para_mut(StoryRef::Body, &Path::top(one_page + 1)).unwrap().props.page_break_before = Some(true);
}
lay(&d).pages.len()
};
assert_eq!(pages(true), 2);
assert_eq!(pages(false), 3);
}
#[test]
fn a_bookmark_after_a_page_break_takes_no_line() {
crate::test_fonts();
// "Before", a page break, then a bookmark start (Word writes the next heading's TOC bookmark
// there): the bookmark takes no room, so "After" starts at the top of page 2, as in Word.
let top_of_after = |bookmark: bool| {
let mut d = Document::from_text("Before\nAfter");
d.insert_text(&Pos::body(0, 6), "\u{000C}", &Default::default()).unwrap();
if bookmark {
let mark = InlineObject::BookmarkStart { name: "_Toc1".into() };
d.insert_object(&Pos::body(0, 7), mark, &Default::default()).unwrap();
}
let l = lay(&d);
let page = l.pages.last().unwrap();
let after = page.items.iter().find_map(|i| match i {
Placed::Lines { path, y, .. } if path.0 == [1] => Some(*y),
_ => None,
});
(l.pages.len(), after.map(|y| y - page.body.y))
};
assert_eq!(top_of_after(true), top_of_after(false));
}
#[test]
fn a_page_break_then_a_new_page_makes_one_page() {
crate::test_fonts();
use wordcraft_doc::section::SectionProps;
// "Before", a paragraph of only a page break, then "After" starting a page by itself: a page
// break before, or a next-page section break carried by the break's own paragraph. Word's
// output for a report: the break's mark stays on the old page, and "After" starts the next.
let doc = |section_on_break: bool| {
let mut d = Document::from_text("Before\n\u{000C}\nAfter");
if section_on_break {
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().section = Some(Box::new(SectionProps::default()));
} else {
d.para_mut(StoryRef::Body, &Path::top(2)).unwrap().props.page_break_before = Some(true);
}
d
};
for section_on_break in [false, true] {
let l = lay(&doc(section_on_break));
let firsts: Vec<usize> = l.pages.iter().map(|p| p.first_block).collect();
assert_eq!(l.pages.len(), 2, "section break on the page break: {section_on_break}; pages start at blocks {firsts:?}");
}
}
#[test]
fn page_numbers_can_restart_at_zero() {
crate::test_fonts();
// `w:pgNumType w:start="0"`: a cover page numbered 0, so the page after it reads 1.
let mut d = Document::from_text("Cover\u{000C}Contents");
d.last_section.page_num_start = Some(0);
let numbers: Vec<u32> = lay(&d).pages.iter().map(|p| p.number).collect();
assert_eq!(numbers, [0, 1]);
}
#[test]
fn center_and_right_alignment() {
crate::test_fonts();
let mut d = Document::from_text("abc\nabc\nabc");
d.format_paragraphs(&Pos::body(1, 0), &Pos::body(1, 0), &|p| p.align = Some(Align::Center)).unwrap();
d.format_paragraphs(&Pos::body(2, 0), &Pos::body(2, 0), &|p| p.align = Some(Align::Right)).unwrap();
let l = lay(&d);
let x0 = l.caret(&Pos::body(0, 0)).unwrap().x;
let x1 = l.caret(&Pos::body(1, 0)).unwrap().x;
let x2 = l.caret(&Pos::body(2, 3)).unwrap().x;
assert!((x0 - 72.0).abs() < 0.5);
assert!(x1 > 250.0 && x1 < 320.0, "{x1}");
assert!((x2 - 540.0).abs() < 1.0, "{x2}");
}
#[test]
fn caret_on_an_empty_line_after_a_break_follows_alignment() {
// "BAB I", Shift+Enter: the empty line's caret sits where its alignment puts it (#4283).
let text = format!("BAB I{}", wordcraft_doc::para::LINE_BREAK);
for rtl in [false, true] {
for (align, ltr_x) in [(Align::Left, 72.0), (Align::Center, 306.0), (Align::Right, 540.0), (Align::Justify, 72.0)] {
let mut d = Document::new();
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&text, Default::default()))];
let at = Pos::body(0, 0);
d.format_paragraphs(&at, &at, &|p: &mut ParaProps| {
p.align = Some(align);
p.bidi = Some(rtl);
})
.unwrap();
let expected = if rtl { 612.0 - ltr_x } else { ltr_x };
let x = lay(&d).caret(&Pos::body(0, text.len())).unwrap().x;
assert!((x - expected).abs() < 1.0, "{align:?} rtl={rtl}: {x}, expected {expected}");
}
}
// An empty centred paragraph without a break was already centred.
let mut d = Document::from_text("");
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.align = Some(Align::Center)).unwrap();
let x = lay(&d).caret(&Pos::body(0, 0)).unwrap().x;
assert!((x - 306.0).abs() < 1.0, "{x}");
}
#[test]
fn tabs_land_on_default_stops() {
crate::test_fonts();
let d = Document::from_text("a\tb");
let l = lay(&d);
let xb = l.caret(&Pos::body(0, 2)).unwrap().x;
assert!((xb - (72.0 + 36.0)).abs() < 0.5, "{xb}");
}
/// Left of the margin Word's next default tab stop is the first multiple of the interval at or
/// after the position (its arithmetic truncates toward zero), so a tab already on a stop stays
/// put. Measured on Word: "a\t\tX" at -60 pt puts X at -36 pt (not 0), "\tX" starting at -72 pt
/// leaves X at -72, at -60 moves it to -36; right of the margin the stops are as usual.
/// Letterheads that line up a footer with tabs under a negative indent rely on it.
#[test]
fn tabs_left_of_the_margin_stay_on_a_default_stop() {
crate::test_fonts();
let x_of = |text: &str, indent: f32, off: usize| {
let mut d = Document::from_text(text);
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.indent_left = Some(indent)).unwrap();
lay(&d).caret(&Pos::body(0, off)).unwrap().x - 72.0
};
assert!((x_of("a\t\tX", -60.0, 3) - -36.0).abs() < 0.5, "second tab from a stop left of the margin: {}", x_of("a\t\tX", -60.0, 3));
assert!((x_of("\tX", -72.0, 1) - -72.0).abs() < 0.5, "leading tab on a stop: {}", x_of("\tX", -72.0, 1));
assert!((x_of("\tX", -60.0, 1) - -36.0).abs() < 0.5, "leading tab between stops: {}", x_of("\tX", -60.0, 1));
assert!((x_of("\t \tX", -60.0, 3) - 0.0).abs() < 0.5, "a space between the tabs: {}", x_of("\t \tX", -60.0, 3));
assert!((x_of("a\t\tX", 0.0, 3) - 72.0).abs() < 0.5, "right of the margin: {}", x_of("a\t\tX", 0.0, 3));
}
#[test]
fn right_tab_aligns_text_end() {
crate::test_fonts();
let mut d = Document::from_text("left\tright");
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.tabs = Some(vec![wordcraft_doc::props::TabStop { pos: 400.0, align: wordcraft_doc::props::TabAlign::Right, leader: Default::default() }])
})
.unwrap();
let l = lay(&d);
let end = l.caret(&Pos::body(0, 10)).unwrap().x;
assert!((end - 472.0).abs() < 1.0, "{end}");
}
/// Native Word moves every ordinary-tab group with centered or right paragraph alignment.
#[test]
fn ordinary_tabs_move_as_line() {
use wordcraft_doc::props::{TabAlign, TabLeader, TabStop};
for stops in [
vec![(180.0, TabAlign::Left)],
vec![(234.0, TabAlign::Center)],
vec![(234.0, TabAlign::Center), (364.5, TabAlign::Right)],
vec![(234.0, TabAlign::Center), (468.0, TabAlign::Right)],
] {
let text = if stops.len() == 1 { "Label\tfilename" } else { "Label\tfilename\ttime" };
let mut d = Document::from_text(text);
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.tabs = Some(stops.iter().map(|(pos, align)| TabStop { pos: *pos, align: *align, leader: TabLeader::None }).collect());
})
.unwrap();
let left = lay(&d);
let end = left.caret(&Pos::body(0, text.len())).unwrap().x;
let slack = 540.0 - end;
for (align, fraction) in [(Align::Center, 0.5), (Align::Right, 1.0)] {
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.align = Some(align)).unwrap();
let aligned = lay(&d);
for off in [0, 6, text.len()] {
let before = left.caret(&Pos::body(0, off)).unwrap().x;
let after = aligned.caret(&Pos::body(0, off)).unwrap().x;
assert!((after - before - slack * fraction).abs() < 0.1, "{align:?} {stops:?} offset {off}: {before} -> {after}, slack {slack}");
}
}
}
}
/// A paragraph `before` + positional tab + `after`, with left and right indents and a custom
/// left tab stop at 50 pt that the positional tab must ignore.
fn ptab_doc(before: &str, after: &str, ptab: InlineObject, indents: (f32, f32)) -> Document {
let mut d = Document::from_text(&format!("{before}{after}"));
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.indent_left = Some(indents.0);
p.indent_right = Some(indents.1);
p.tabs = Some(vec![wordcraft_doc::props::TabStop { pos: 50.0, align: Default::default(), leader: Default::default() }]);
})
.unwrap();
d.insert_object(&Pos::body(0, before.len()), ptab, &Default::default()).unwrap();
d
}
fn ptab(align: wordcraft_doc::para::PTabAlign, relative_to: wordcraft_doc::para::PTabBase, leader: wordcraft_doc::props::TabLeader) -> InlineObject {
InlineObject::PositionalTab { align, relative_to, leader }
}
/// ECMA-376 §17.3.3.23: a right positional tab relative to the margin ends the text after it on
/// the right margin, past the right indent, whatever the paragraph's tab stops; its leader fills
/// the gap.
#[test]
fn right_positional_tab_ends_text_on_the_right_margin() {
crate::test_fonts();
use wordcraft_doc::para::{PTabAlign, PTabBase};
let d = ptab_doc("Left", "Right", ptab(PTabAlign::Right, PTabBase::Margin, wordcraft_doc::props::TabLeader::Dot), (0.0, 36.0));
let l = lay(&d);
let end = l.caret(&Pos::body(0, d.body[0].as_para().unwrap().len())).unwrap().x;
assert!((end - 540.0).abs() < 1.0, "end of the text after the tab: {end}");
let para = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None }).unwrap();
assert!(para.lines[0].leaders.iter().any(|(_, ld)| *ld == wordcraft_doc::props::TabLeader::Dot), "{:?}", para.lines[0].leaders);
}
/// Relative to the indents, a centre positional tab centres the text after it between the left
/// and right indents, not between the margins.
#[test]
fn center_positional_tab_relative_to_indents_centres_between_them() {
crate::test_fonts();
use wordcraft_doc::para::{PTabAlign, PTabBase};
let d = ptab_doc("a", "Mid", ptab(PTabAlign::Center, PTabBase::Indent, wordcraft_doc::props::TabLeader::None), (36.0, 108.0));
let l = lay(&d);
let from = l.caret(&Pos::body(0, 1 + wordcraft_doc::para::OBJ.len_utf8())).unwrap().x;
let to = l.caret(&Pos::body(0, d.body[0].as_para().unwrap().len())).unwrap().x;
// Indents at 36 and 468 - 108 = 360 from the margin: centre 198, page x 270.
assert!(((from + to) / 2.0 - 270.0).abs() < 1.0, "centre of the text after the tab: {}", (from + to) / 2.0);
}
/// Text already past the positional tab's place sends it to the next line, where it goes to
/// that place.
#[test]
fn positional_tab_behind_the_text_moves_to_the_next_line() {
crate::test_fonts();
use wordcraft_doc::para::{PTabAlign, PTabBase};
let before = "word ".repeat(14);
let d = ptab_doc(&before, "X", ptab(PTabAlign::Left, PTabBase::Margin, wordcraft_doc::props::TabLeader::None), (0.0, 0.0));
let l = lay(&d);
let first = l.caret(&Pos::body(0, 0)).unwrap();
let x = l.caret(&Pos::body(0, before.len() + wordcraft_doc::para::OBJ.len_utf8())).unwrap();
assert!(x.top > first.top + 1.0, "X on the next line: {} vs {}", x.top, first.top);
assert!((x.x - 72.0).abs() < 0.5, "X at the left margin: {}", x.x);
}
/// A line holding only markers (a bookmark) before the positional tab is still empty: the tab
/// doesn't leave it blank to go to the next line, even when its place is behind the indent.
#[test]
fn positional_tab_after_only_a_bookmark_stays_on_its_line() {
crate::test_fonts();
use wordcraft_doc::para::{PTabAlign, PTabBase};
let mut d = ptab_doc("", "X", ptab(PTabAlign::Left, PTabBase::Margin, wordcraft_doc::props::TabLeader::None), (36.0, 0.0));
d.insert_object(&Pos::body(0, 0), InlineObject::BookmarkStart { name: "top".into() }, &Default::default()).unwrap();
let l = lay(&d);
let para = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None }).unwrap();
assert_eq!(para.lines.len(), 1);
let x = l.caret(&Pos::body(0, 2 * wordcraft_doc::para::OBJ.len_utf8())).unwrap().x;
assert!((x - 108.0).abs() < 0.5, "X at the indent: {x}");
}
#[test]
fn narrow_cells_keep_their_width() {
crate::test_fonts();
let mut p = wordcraft_doc::Paragraph::with_text("WW", wordcraft_doc::CharProps { size: Some(6.0), ..Default::default() });
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
let mut d = Document::new();
d.body = vec![wordcraft_doc::para_block(p.clone())];
let wide = lay(&d);
let advance = wide.pages[0]
.items
.iter()
.find_map(|item| match item {
Placed::Lines { para, .. } => Some(para.clusters.iter().map(|c| c.adv).sum::<f32>()),
_ => None,
})
.unwrap();
let narrow = advance - 0.25;
assert!(narrow > 6.0 && advance < 12.0, "probe width {advance}");
for (width, expected_lines) in [(narrow, 2), (1.0, 2), (12.0, 1)] {
let mut table = Table::new(1, 1, width);
table.props.style = None;
table.props.fixed = true;
table.props.cell_margins = Some([0.0; 4]);
table.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p.clone())];
d.body = vec![std::sync::Arc::new(Block::Table(table))];
let l = lay(&d);
let lines = l.pages[0]
.items
.iter()
.find_map(|item| match item {
Placed::Lines { para, .. } => Some(para.lines.len()),
_ => None,
})
.unwrap();
assert_eq!(lines, expected_lines, "cell width {width}, text width {advance}");
}
}
#[test]
fn right_tab_whose_text_does_not_fit_moves_to_the_next_line_with_it() {
// A TOC-like entry: text, then a right tab with a dot leader and a page number. Whatever the
// text's length, the number is on the tab's line and ends at the stop (or past it, inside the
// margin). With the stop short of the margin, text can also end past the stop, where the next
// default stop is past the margin: then the tab wraps too.
use wordcraft_doc::props::{TabAlign, TabLeader, TabStop};
for pos in [468.0, 400.0] {
for m in 20..40 {
for r in 0..4 {
let text = format!("{}{}\t63", "abc ".repeat(m), "y".repeat(r));
let n = text.chars().count();
let mut d = Document::from_text(&text);
d.settings.default_tab = 100.0;
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.tabs = Some(vec![TabStop { pos, align: TabAlign::Right, leader: TabLeader::Dot }])
})
.unwrap();
let l = lay(&d);
let end = l.caret(&Pos::body(0, n)).unwrap().x;
// At the stop, or (when the text before the tab already reaches it) right after the text,
// inside the margin.
assert!(end > 72.0 + pos - 1.0 && end < 541.0, "stop {pos}, {m} words + {r}: number ends at {end}");
let Some(para) = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None })
else {
panic!("no lines")
};
let tab = n - 3;
let line = para.lines.iter().find(|l| l.c0 <= tab && tab < l.c1).unwrap();
assert!(line.c1 >= n, "stop {pos}, {m} words + {r}: the tab and its number are on different lines");
assert!(line.leaders.iter().any(|(k, _)| *k == tab), "stop {pos}, {m} words + {r}: no leader");
}
}
}
}
/// Measured in Word: leader dots are spaced by the dot's advance in whole 600-dpi pixels, sit on
/// the page's grid of that pitch from the first place after the text before the tab, and stop at
/// the last one that ends before the text after it.
#[test]
fn leader_dots_are_spaced_and_placed_as_in_word() {
use wordcraft_doc::props::{TabAlign, TabLeader, TabStop};
// TH SarabunPSK at 16 pt, Tahoma at 22 pt, Times New Roman at 12 pt and Arial at 10 pt; Arial
// at 14 pt and Tahoma at 20 pt, whose sizes (116.7 and 166.7 pixels) round up to 117 and 167.
let pitch = |units, upem, size| display::leader_pitch(units, upem, size);
for (got, want) in [
(pitch(162.0, 1000.0, 16.0), 2.64),
(pitch(620.0, 2048.0, 22.0), 6.6),
(pitch(512.0, 2048.0, 12.0), 3.0),
(pitch(569.0, 2048.0, 10.0), 2.76),
(pitch(569.0, 2048.0, 14.0), 3.96),
(pitch(620.0, 2048.0, 20.0), 6.12),
] {
assert!((got - want).abs() < 1e-4, "pitch {got}, not {want}");
}
// A leader across most of the page keeps its last dot: from 72 to 528 pt at 2.64 pt the dots
// go from 73.92 to 525.36, the last ending on 528, each place worked out from its grid index.
let xs = display::leader_xs(72.0, 528.0, pitch(162.0, 1000.0, 16.0));
assert_eq!(xs.len(), 172, "{} dots, from {:?} to {:?}", xs.len(), xs.first(), xs.last());
assert!((xs[0] - 73.92).abs() < 1e-3 && (xs[171] - 525.36).abs() < 1e-3, "{:?} to {:?}", xs.first(), xs.last());
assert!(display::leader_xs(72.0, 528.0, f32::NAN).is_empty() && display::leader_xs(72.0, 528.0, 0.0).is_empty());
// Labels of several lengths and stops at several places: the text before the tab and the
// number after it end and start anywhere against the grid.
for label in ["E", "Entr", "Entry one", "Entry number two"] {
for k in 0..12 {
let pos = 300.0 + 9.7 * k as f32;
let mut d = Document::from_text(&format!("{label}\t12"));
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.tabs = Some(vec![TabStop { pos, align: TabAlign::Right, leader: TabLeader::Dot }]);
})
.unwrap();
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let dots: Vec<f32> = items
.iter()
.filter_map(|i| {
if let display::Draw::Glyphs { text, glyphs, .. } = i {
text.is_empty().then(|| glyphs.iter().map(|g| g.1).collect::<Vec<_>>())
} else {
None
}
})
.next()
.expect("a leader");
let step = dots[1] - dots[0];
let case = format!("{label:?} stop {pos}");
assert!(dots.windows(2).all(|w| (w[1] - w[0] - step).abs() < 1e-3), "{case}: evenly spaced: {dots:?}");
assert!((step * 600.0 / 72.0 - (step * 600.0 / 72.0).round()).abs() < 1e-3, "{case}: {step} pt is a whole number of 600-dpi pixels");
let n = label.len();
let (text_end, number) = (l.caret(&Pos::body(0, n)).unwrap().x, l.caret(&Pos::body(0, n + 1)).unwrap().x);
let first = (text_end / step - 0.001).ceil() * step;
let last = ((number - step) / step + 0.001).floor() * step;
assert!((dots[0] - first).abs() < 1e-2, "{case}: the first dot is at {}, not the first grid place after {text_end}: {first}", dots[0]);
let end = *dots.last().unwrap();
assert!((end - last).abs() < 1e-2, "{case}: the last dot is at {end}, not the last that ends before {number}: {last}");
}
}
}
/// A left tab whose only stop is past the right indent wraps; on the next line it still can't
/// reach that stop, so it takes no room there and its text starts at the indent instead of
/// going to a line of its own.
#[test]
fn left_tab_past_the_right_indent_does_not_add_a_line() {
use wordcraft_doc::props::{TabAlign, TabLeader, TabStop};
let text = "Name\tPage";
let mut d = Document::from_text(text);
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.tabs = Some(vec![TabStop { pos: 500.0, align: TabAlign::Left, leader: TabLeader::None }])
})
.unwrap();
let l = lay(&d);
let Some(para) = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None }) else {
panic!("no lines")
};
assert_eq!(para.lines.len(), 2, "{:?}", para.lines.iter().map(|l| (l.c0, l.c1)).collect::<Vec<_>>());
let page = l.caret(&Pos::body(0, 5)).unwrap();
assert!((page.x - 72.0).abs() < 0.5, "the text after the tab starts at the indent: {}", page.x);
}
/// A bookmark before such a tab is not text: the tab does not wrap away from it, and the
/// paragraph breaks as it does without the bookmark (no line holding only the bookmark).
#[test]
fn a_bookmark_before_a_left_tab_past_the_right_indent_is_not_a_line() {
use wordcraft_doc::props::{TabAlign, TabLeader, TabStop};
let lines = |mark: bool| {
let mut d = Document::from_text("\tPage");
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.tabs = Some(vec![TabStop { pos: 500.0, align: TabAlign::Left, leader: TabLeader::None }])
})
.unwrap();
if mark {
d.insert_object(&Pos::body(0, 0), InlineObject::BookmarkStart { name: "top".into() }, &Default::default()).unwrap();
}
let l = lay(&d);
let Some(para) = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None }) else {
panic!("no lines")
};
// The lines' clusters, not counting the bookmark's.
let m = usize::from(mark);
para.lines.iter().map(|l| (l.c0.saturating_sub(m), l.c1 - m)).collect::<Vec<_>>()
};
assert_eq!(lines(true), lines(false));
}
/// A bookmark is not text: where a line breaks is the same with it as without it. U+FFFC has the
/// line-break class CB, which on its own would allow a break before and after it.
#[test]
fn a_bookmark_is_no_line_break_opportunity() {
// (the bookmark's offset in "Oremus", or none) -> the lines' clusters, not counting the bookmarks'
let lines = |marks: &[usize]| {
let mut d = Document::from_text("Oremus");
// A column too narrow for the word, which then breaks inside it.
d.last_section.page_w = d.last_section.margin_left + d.last_section.margin_right + 30.0;
// From the end, so the offsets stay those of "Oremus".
for (n, &at) in marks.iter().enumerate().rev() {
let mark = InlineObject::BookmarkStart { name: format!("b{n}") };
d.insert_object(&Pos::body(0, at), mark, &Default::default()).unwrap();
}
let l = lay(&d);
let Some(para) = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None }) else {
panic!("no lines")
};
para.lines
.iter()
.map(|l| para.clusters.get(l.c0..l.c1).map_or(0, |cs| cs.iter().filter(|c| c.kind != para::ClKind::Marker).count()))
.collect::<Vec<_>>()
};
let plain = lines(&[]);
assert!(plain.len() > 1, "the word is meant to break inside: {plain:?}");
assert_eq!(lines(&[0, 0]), plain, "two bookmarks before the word leave no line of their own");
assert_eq!(lines(&[3]), plain, "a bookmark inside the word is no place to wrap");
}
#[test]
fn lists_get_labels_and_indent() {
crate::test_fonts();
let mut d = Document::from_text("one\ntwo\nthree");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(2, 5), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
let l = lay(&d);
let labels: Vec<String> = l.pages[0]
.items
.iter()
.filter_map(|it| if let Placed::Lines { para, .. } = it { para.label.as_ref().map(|x| x.text.clone()) } else { None })
.collect();
assert_eq!(labels, vec!["1.", "2.", "3."]);
let x = l.caret(&Pos::body(0, 0)).unwrap().x;
assert!((x - 108.0).abs() < 0.5, "{x}");
}
#[test]
fn a_none_format_label_shows_its_text_and_tabs_to_the_indent() {
crate::test_fonts();
// #4985: Word draws a "none" level's literal text ("RESPONSE:"), and an empty one still tabs
// the text to a hanging indent, as a numbered item's. An empty label already at the left indent
// takes no tab (Word's Chapter 1 list: Heading 2 starts at the margin, not at 0.5").
use wordcraft_doc::section::NumFormat;
for (text, indent, hanging, want) in [("RESPONSE:", 72.0, 72.0, 144.0), ("", 72.0, 72.0, 144.0), ("", 0.0, 0.0, 72.0), ("", 50.0, 0.0, 122.0)] {
let mut d = Document::from_text("X");
let id = std::sync::Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
for a in &mut std::sync::Arc::make_mut(&mut d.numbering).abstracts {
if let Some(l) = a.levels.first_mut() {
l.format = NumFormat::None;
l.text = text.into();
(l.indent, l.hanging) = (indent, hanging);
}
}
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 1), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
let l = lay(&d);
assert_eq!(labels(&l), [text]);
let x = l.caret(&Pos::body(0, 0)).unwrap().x;
assert!((x - want).abs() < 0.5, "{text:?} at {indent}/{hanging}: {x}, not {want}");
}
}
#[test]
fn break_only_list_has_no_label() {
crate::test_fonts();
use wordcraft_doc::ListKind;
for kind in [ListKind::Numbered, ListKind::Bullet] {
let mut d = Document::from_text("First\n\u{000C}\nLast\n\nAfter");
let id = Arc::make_mut(&mut d.numbering).add_list(kind);
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(4, 5), &|p| {
p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 });
})
.unwrap();
let l = lay(&d);
let labels: Vec<_> = l
.pages
.iter()
.flat_map(|p| &p.items)
.filter_map(|it| {
let Placed::Lines { path, para, .. } = it else { return None };
Some((path.clone(), para.label.as_ref().map(|label| label.text.clone())))
})
.collect();
let label = |n| Some(if kind == ListKind::Numbered { format!("{n}.") } else { "•".to_string() });
// Word hides the break's label but counts it; a plain empty item still has a label.
assert_eq!(
labels,
vec![(Path::top(0), label(1)), (Path::top(1), None), (Path::top(2), label(3)), (Path::top(3), label(4)), (Path::top(4), label(5)),],
"{kind:?}"
);
}
}
/// #4828: a list item deleted whole (its text and its mark) under Track Changes shows its number
/// as deleted text, in the deletion's colour and struck through, with markup shown; without
/// markup the number is drawn no more than the text.
#[test]
fn a_deleted_list_items_number_is_drawn_as_deleted_text() {
let mut d = Document::from_text("Intro\nChapter two\nBody");
d.revisions.push(wordcraft_doc::Revision {
kind: wordcraft_doc::RevisionKind::Delete,
author: "Ana".into(),
date: String::new(),
move_name: None,
});
let id = std::sync::Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
d.format_paragraphs(&Pos::body(1, 0), &Pos::body(1, 3), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
d.format_range(&Pos::body(1, 0), &Pos::body(1, 11), &|c| c.del = Some(0)).unwrap();
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().mark.del = Some(0);
let l = lay(&d);
let draws = |markup: bool| display::page_display(&d, &l.pages[0], &display::DisplayOptions { markup, ..Default::default() });
let glyph_color = |items: &[display::Draw], want: &str| {
items.iter().find_map(|i| match i {
display::Draw::Glyphs { text, color, glyphs, .. } if text.contains(want) => Some((*color, glyphs.first().map_or(0.0, |g| g.1))),
_ => None,
})
};
let marked = draws(true);
let (number, nx) = glyph_color(&marked, "1.").expect("the number is drawn with markup");
let (text, _) = glyph_color(&marked, "Chapter").expect("the deleted text is drawn with markup");
assert_eq!(number, text, "the number takes the deletion's colour");
let struck = marked
.iter()
.any(|i| matches!(i, display::Draw::Line { x0, x1, y0, y1, .. } if (y0 - y1).abs() < 0.01 && *x0 <= nx + 0.01 && *x1 > nx + 1.0));
assert!(struck, "the number is struck through");
// The number takes the other deletion marks as its text does.
let with_mark = |mark: display::DeleteMark| {
let mut o = display::DisplayOptions { markup: true, ..Default::default() };
o.revisions.delete_mark = mark;
display::page_display(&d, &l.pages[0], &o)
};
let caret = with_mark(display::DeleteMark::Caret);
assert!(glyph_color(&caret, "1.").is_none(), "a caret replaces the number");
assert!(caret.iter().any(|i| matches!(i, display::Draw::Line { x1, .. } if (*x1 - nx).abs() < 0.01)), "the caret is where the number was");
let bold = with_mark(display::DeleteMark::Bold);
assert!(bold.iter().any(|i| matches!(i, display::Draw::Glyphs { text, synth_bold: true, .. } if text.contains("1."))));
let hashed = with_mark(display::DeleteMark::Hash);
let ids = |items: &[display::Draw], want: &str| {
items.iter().find_map(|i| match i {
display::Draw::Glyphs { text, glyphs, .. } if text.contains(want) => Some(glyphs.iter().map(|g| g.0).collect::<Vec<_>>()),
_ => None,
})
};
let (numbers, hashes) = (ids(&marked, "1.").unwrap(), ids(&hashed, "1.").unwrap());
assert!(hashes.len() == numbers.len() && hashes.windows(2).all(|w| w[0] == w[1]) && hashes != numbers, "each character shows as #");
let plain_label = |items: &[display::Draw]| {
items.iter().any(|i| matches!(i, display::Draw::Line { x0, x1, y0, y1, .. } if (y0 - y1).abs() < 0.01 && *x0 <= nx + 0.01 && *x1 > nx + 1.0))
};
assert!(!plain_label(&with_mark(display::DeleteMark::ColorOnly)), "colour only: no line through or under the number");
// Moved-away text marked (none) is plain, its number too.
let mut moved = d.clone();
if let Some(r) = moved.revisions.get_mut(0) {
r.move_name = Some("move1".into());
}
let mut o = display::DisplayOptions { markup: true, ..Default::default() };
o.revisions.move_from_mark = display::DeleteMark::None;
let shown = display::page_display(&moved, &l.pages[0], &o);
let (moved_number, _) = glyph_color(&shown, "1.").expect("the moved number is drawn");
let (moved_text, _) = glyph_color(&shown, "Chapter").expect("the moved text is drawn");
assert_eq!(moved_number, moved_text, "plain, like its text");
assert!(!plain_label(&shown));
// With markup but deletions hidden in Track Changes Options, the number isn't drawn either.
assert!(glyph_color(&with_mark(display::DeleteMark::Hidden), "1.").is_none(), "deletions marked hidden");
let mut o = display::DisplayOptions { markup: true, ..Default::default() };
o.revisions.insertions_deletions = false;
assert!(glyph_color(&display::page_display(&d, &l.pages[0], &o), "1.").is_none(), "insertions and deletions not shown");
// Without markup neither the text nor its number is drawn.
let plain = draws(false);
assert!(glyph_color(&plain, "Chapter").is_none() && glyph_color(&plain, "1.").is_none());
// A number whose paragraph mark isn't deleted is drawn as before.
let mut kept = Document::from_text("Intro\nChapter two\nBody");
let id = std::sync::Arc::make_mut(&mut kept.numbering).add_list(wordcraft_doc::ListKind::Numbered);
kept.format_paragraphs(&Pos::body(1, 0), &Pos::body(1, 3), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
let kl = lay(&kept);
let plain = display::page_display(&kept, &kl.pages[0], &display::DisplayOptions { markup: false, ..Default::default() });
assert!(glyph_color(&plain, "1.").is_some());
// #4828 review: only the paragraph mark deleted (Delete at the end of the item): the text
// stays, and so does its number, plain, with markup and without (and in print, where markup
// is off).
let mut joined = kept.clone();
joined.revisions = d.revisions.clone();
joined.para_mut(StoryRef::Body, &Path::top(1)).unwrap().mark.del = Some(0);
let jl = lay(&joined);
for markup in [false, true] {
let shown = display::page_display(&joined, &jl.pages[0], &display::DisplayOptions { markup, ..Default::default() });
let (number, jx) = glyph_color(&shown, "1.").unwrap_or_else(|| panic!("markup {markup}: the number stays"));
let (text, _) = glyph_color(&shown, "Chapter").unwrap_or_else(|| panic!("markup {markup}: the text stays"));
assert_eq!(number, text, "markup {markup}: in the text's colour");
let struck = shown
.iter()
.any(|i| matches!(i, display::Draw::Line { x0, x1, y0, y1, .. } if (y0 - y1).abs() < 0.01 && *x0 <= jx + 0.01 && *x1 > jx + 1.0));
assert!(!struck, "markup {markup}: not struck through");
}
}
#[test]
fn empty_list_paragraph_with_a_hidden_mark_counts_but_shows_nothing() {
// Word (#3982): a list item whose paragraph mark is hidden, and whose text is empty or hidden
// too, takes no room and draws no number, but it is counted: "1. Alpha", then "3. Beta". In a
// table cell as in the body.
let doc = |hidden: Option<&str>, in_cell: bool| {
let text = match hidden {
Some(item) => format!("Alpha\n{item}\nBeta\nGamma"),
None => "Alpha\nBeta\nGamma".to_string(),
};
let mut d = Document::from_text(&text);
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
let last = d.body.len() - 1;
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(last, 5), &|p| {
p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 });
})
.unwrap();
if let Some(item) = hidden {
if !item.is_empty() {
d.format_range(&Pos::body(1, 0), &Pos::body(1, item.len()), &|c| c.hidden = Some(true)).unwrap();
}
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().mark.hidden = Some(true);
}
if in_cell {
let mut table = Table::new(1, 1, 400.0);
table.rows[0].cells[0].blocks = std::mem::take(&mut d.body);
d.body = vec![std::sync::Arc::new(Block::Table(table))];
}
d
};
let laid = |d: &Document, show_hidden: bool| {
let l = layout(d, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
let lines: Vec<(Option<String>, f32)> = l
.pages
.iter()
.flat_map(|p| &p.items)
.filter_map(|it| match it {
Placed::Lines { para, y, .. } => Some((para.label.as_ref().map(|label| label.text.clone()), *y)),
_ => None,
})
.collect();
lines
};
for (item, in_cell) in [("", false), ("", true), ("Secret", false), ("Secret", true)] {
let case = format!("item={item:?} in_cell={in_cell}");
let shown = laid(&doc(Some(item), in_cell), false);
let labels: Vec<_> = shown.iter().map(|(label, _)| label.as_deref()).collect();
assert_eq!(labels, vec![Some("1."), None, Some("3."), Some("4.")], "{case}");
let plain = laid(&doc(None, in_cell), false);
assert!((shown[2].1 - plain[1].1).abs() < 0.01, "{case}: Beta at {} instead of {}", shown[2].1, plain[1].1);
// Shown hidden text brings the paragraph and its number back.
let all = laid(&doc(Some(item), in_cell), true);
let labels: Vec<_> = all.iter().map(|(label, _)| label.as_deref()).collect();
assert_eq!(labels, vec![Some("1."), Some("2."), Some("3."), Some("4.")], "{case}");
assert!(all[2].1 > plain[1].1 + 5.0, "{case}: the shown paragraph takes its line");
}
}
#[test]
fn a_numbered_heading_opening_with_a_page_break_takes_its_number_along() {
crate::test_fonts();
// "Before", then a numbered paragraph whose text opens with a page break: Word draws its
// number on the next page with the text, not alone at the bottom of the first.
let mut d = Document::from_text("Before\n\u{000C}Heading");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
d.format_paragraphs(&Pos::body(1, 0), &Pos::body(1, 1), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
let l = lay(&d);
let label_pages: Vec<usize> = l
.pages
.iter()
.enumerate()
.filter(|(_, pg)| {
flat(display::page_display(&d, pg, &Default::default())).iter().any(|x| matches!(x, display::Draw::Glyphs { text, .. } if text == "1."))
})
.map(|(i, _)| i)
.collect();
assert_eq!(label_pages, [1]);
}
#[test]
fn russian_letter_list_labels_draw_cyrillic() {
crate::test_fonts();
// russianLower labelled items 1, 2, 3 instead of а), б), в).
use wordcraft_doc::section::NumFormat;
let mut d = Document::from_text("один\nдва\nтри");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
for a in &mut Arc::make_mut(&mut d.numbering).abstracts {
if let Some(l) = a.levels.first_mut() {
l.format = NumFormat::RussianLower;
l.text = "%1)".into();
}
}
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(2, 3), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
let l = lay(&d);
let labels: Vec<(String, bool)> = l.pages[0]
.items
.iter()
.filter_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None })
.filter_map(|pl| {
let lab = pl.label.as_ref()?;
let drawn = lab.runs.iter().all(|r| {
let face = &pl.styles[r.style as usize].face;
let gids: Vec<u32> = lab.glyphs[r.glyphs.clone()].iter().map(|g| g.gid).collect();
r.text.chars().all(|c| gids.contains(&face.glyph_for(c)) && face.glyph_for(c) != 0)
});
Some((lab.text.clone(), drawn))
})
.collect();
assert_eq!(labels, [("а)".to_string(), true), ("б)".to_string(), true), ("в)".to_string(), true)]);
}
#[test]
fn chinese_counting_list_labels_and_their_font_runs() {
crate::test_fonts();
// Issue #534: a "一、" list showed digits, drawn with glyph ids of another font.
use wordcraft_doc::section::NumFormat;
let mut d = Document::from_text("甲\n乙\n丙");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
for a in &mut Arc::make_mut(&mut d.numbering).abstracts {
if let Some(l) = a.levels.first_mut() {
l.format = NumFormat::ChineseCounting;
l.text = "%1、".into();
}
}
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(2, 3), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
let labels = |d: &Document| -> Vec<(String, Vec<(String, bool)>)> {
let l = lay(d);
l.pages[0]
.items
.iter()
.filter_map(|it| if let Placed::Lines { para, .. } = it { Some(para.clone()) } else { None })
.filter_map(|pl| {
let lab = pl.label.clone()?;
// Every run draws glyphs of its own face.
let runs = lab
.runs
.iter()
.map(|r| {
let face = &pl.styles[r.style as usize].face;
let gids: Vec<u32> = lab.glyphs[r.glyphs.clone()].iter().map(|g| g.gid).collect();
(r.text.clone(), r.text.chars().all(|c| gids.contains(&face.glyph_for(c))))
})
.collect();
Some((lab.text, runs))
})
.collect()
};
let got = labels(&d);
assert_eq!(got.iter().map(|(t, _)| t.as_str()).collect::<Vec<_>>(), ["一、", "二、", "三、"]);
// A decimal label next to a CJK comma mixes faces when the Latin face lacks the comma.
for a in &mut Arc::make_mut(&mut d.numbering).abstracts {
if let Some(l) = a.levels.first_mut() {
l.format = NumFormat::Decimal;
}
}
for (text, runs) in labels(&d).into_iter().chain(got) {
assert_eq!(runs.iter().map(|(t, _)| t.as_str()).collect::<String>(), text);
assert!(runs.iter().all(|(_, own)| *own), "{text}: {runs:?}");
}
}
#[test]
fn symbol_font_bullet_without_the_font_draws_a_bullet() {
crate::test_fonts();
// Word's default bullet: U+F0B7 in Symbol.
let mut d = Document::from_text("one");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::BulletChar('\u{F0B7}'));
for a in &mut Arc::make_mut(&mut d.numbering).abstracts {
if let Some(l) = a.levels.first_mut() {
l.chr.font = Some("Symbol".into());
}
}
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
let l = lay(&d);
let label = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { para.label.clone() } else { None }).unwrap();
// The label reads as the Unicode bullet (drawn from a real Symbol font where one is installed).
assert_eq!(label.text, "\u{2022}");
assert_eq!(label.glyphs.len(), 1);
}
/// The label's ascent, the text size, and the first line's height and text ascent of a one-line
/// bulleted paragraph whose bullet is in `label_font`; no label font = no bullet.
fn bullet_first_line(label_font: Option<&str>) -> (f32, f32, f32, f32) {
let mut d = Document::from_text("one");
if let Some(label_font) = label_font {
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::BulletChar('\u{F0B7}'));
for a in &mut Arc::make_mut(&mut d.numbering).abstracts {
if let Some(l) = a.levels.first_mut() {
l.chr.font = Some(label_font.into());
}
}
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 })).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!("no text") };
let size = para.styles.iter().map(|s| s.size).fold(0.0f32, f32::max);
(para.label.as_ref().map_or(0.0, |lab| lab.ascent), size, para.lines[0].height, para.lines[0].text_asc)
}
#[test]
fn a_symbol_bullet_sizes_its_line_by_the_symbol_font() {
crate::test_fonts();
// Measured in Word: a Symbol bullet makes its line taller than the text alone (Calibri 11 pt
// at 1.08 spacing: 15.1 pt, not 14.5 pt), the extra ascent added unscaled. Symbol isn't an open
// font; without it the bullet is drawn from another face but its line keeps Symbol's height.
if !wordcraft_fonts::word::resolve("Symbol", false, false).substituted {
return;
}
let (ascent, size, height, text_asc) = bullet_first_line(Some("Symbol"));
let want = (1.005 * f64::from(size)) as f32;
assert!((ascent - want).abs() < 0.01, "{ascent} vs {want}");
// The line is the text's own height plus the bullet's extra ascent, unscaled.
let (_, _, plain, _) = bullet_first_line(None);
let extra = ascent - text_asc;
assert!(extra > 0.0, "Symbol's ascent {ascent} is above the text's {text_asc}");
assert!((height - (plain + extra)).abs() < 0.01, "{height} vs {plain} + {extra}");
}
#[test]
fn a_pcl6_symbol_bullet_sizes_its_line_as_symbol() {
// `Symbol (PCL6)` is drawn with Symbol: an installed Symbol gives both their own face's height,
// a missing one gives both Symbol's.
assert_eq!(bullet_first_line(Some("Symbol (PCL6)")), bullet_first_line(Some("Symbol")));
}
#[test]
fn pcl6_symbol_draws_greater_equal() {
crate::test_fonts();
let mut d = Document::from_text("\u{F0B3}");
d.format_range(&Pos::body(0, 0), &Pos::body(0, 3), &|c| c.font = Some("Symbol (PCL6)".into())).unwrap();
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let text: String = items.iter().filter_map(|i| if let display::Draw::Glyphs { text, .. } = i { Some(text.as_str()) } else { None }).collect();
assert_eq!(text, "≥");
assert_eq!(d.plain_text(StoryRef::Body), "\u{F0B3}");
}
#[test]
fn private_use_bullet_no_font_draws_shows_the_levels_default_bullet() {
crate::test_fonts();
// #1683: a level-2 bullet stored as a private-use code in a font that isn't installed was
// drawn from an installed icon font (U+F081 is the Twitter logo in Font Awesome).
let mut d = Document::from_text("one");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Bullet);
for a in &mut Arc::make_mut(&mut d.numbering).abstracts {
if let Some(l) = a.levels.get_mut(1) {
l.text = "\u{F081}".into();
l.chr.font = Some("WordCraft Missing Font 1683".into());
}
}
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 1 })).unwrap();
let l = lay(&d);
let label = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { para.label.clone() } else { None }).unwrap();
assert_eq!(label.text, "\u{25CB}");
assert_eq!(label.glyphs.len(), 1);
}
#[test]
fn wingdings_text_draws_and_reads_as_its_unicode_symbols() {
crate::test_fonts();
// Word stores symbol-font text both ways: plain codes ("J" = smiley) and private-use codes
// (U+F0FC = check mark, what `w:sym` writes).
let mut d = Document::from_text("Hi J\u{F0FC} ok");
d.format_range(&Pos::body(0, 3), &Pos::body(0, 7), &|c| c.font = Some("Wingdings".into())).unwrap();
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let text: String = items.iter().filter_map(|i| if let display::Draw::Glyphs { text, .. } = i { Some(text.as_str()) } else { None }).collect();
assert_eq!(text, "Hi \u{263A}\u{2713} ok");
// The stored text is unchanged.
assert_eq!(d.plain_text(StoryRef::Body), "Hi J\u{F0FC} ok");
// Without Wingdings, each symbol is drawn from a face that has its Unicode character (never
// the substitute's "J" or a missing glyph).
if wordcraft_fonts::word::resolve("Wingdings", false, false).substituted {
for want in ['\u{263A}', '\u{2713}'] {
let run = items.iter().find_map(|i| match i {
display::Draw::Glyphs { face, glyphs, text, .. } if text.contains(want) => Some((*face, glyphs.clone())),
_ => None,
});
let Some((face, glyphs)) = run else { panic!("no run for {want}") };
if face.covers(want) {
assert!(glyphs.iter().any(|g| g.0 == face.glyph_for(want)), "{want}");
} else {
// No installed face has it (a bare CI machine): never the letter J's glyph.
assert!(!glyphs.iter().any(|g| g.0 != 0 && g.0 == face.glyph_for('J')), "{want}");
}
}
}
}
#[test]
fn tables_lay_out_cells() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 3, 468.0);
t.rows[0].cells[1].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("cell text", Default::default()))];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let pos = Pos { story: StoryRef::Body, path: Path(vec![1, 0, 1, 0]), off: 0 };
let c = l.caret(&pos).unwrap();
assert!(c.x > 72.0 + 150.0 && c.x < 72.0 + 170.0, "{c:?}");
let after = l.caret(&Pos::body(2, 0)).unwrap();
assert!(after.top > c.top + 20.0);
let rules = l.pages[0].items.iter().filter(|i| matches!(i, Placed::Rule { .. })).count();
assert!(rules >= 12, "rules {rules}");
assert!(l.cell_at(0, c.x, c.top + 2.0).is_some());
}
#[test]
fn a_tables_own_space_above_and_below_moves_the_text() {
// ODT tables' `fo:margin-top`/`fo:margin-bottom`: added to the spacing around the table.
let lay_with = |space: Option<(f32, f32)>| {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(1, 2, 468.0);
if let Some((a, b)) = space {
(t.props.space_before, t.props.space_after) = (Some(a), Some(b));
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let top = l.pages[0].items.iter().find_map(|i| if let Placed::Cell { rect, .. } = i { Some(rect.y) } else { None }).unwrap();
(top, l.caret(&Pos::body(2, 0)).unwrap().top)
};
let (top, after) = lay_with(None);
let (spaced_top, spaced_after) = lay_with(Some((10.0, 20.0)));
assert!((spaced_top - top - 10.0).abs() < 0.01, "{top} {spaced_top}");
assert!((spaced_after - after - 30.0).abs() < 0.01, "{after} {spaced_after}");
// Junk is ignored.
assert_eq!(lay_with(Some((f32::NAN, -5.0))), (top, after));
}
/// A vertical merge is one cell: its box spans the rows, a click anywhere in it finds it, and the
/// continuation row's box is `covered` (no gridline, not a hit).
#[test]
fn a_vertical_merge_lays_out_as_one_cell() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(3, 2, 468.0);
t.rows[0].cells[0].props.vmerge = wordcraft_doc::props::VMerge::Restart;
t.rows[1].cells[0].props.vmerge = wordcraft_doc::props::VMerge::Continue;
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let cells: Vec<_> = l.pages[0]
.items
.iter()
.filter_map(|i| if let Placed::Cell { rect, row, cell: 0, covered, .. } = i { Some((*row, *rect, *covered)) } else { None })
.collect();
let (r0, r1) = (cells[0].1, cells[1].1);
assert!(!cells[0].2 && cells[1].2 && !cells[2].2, "{cells:?}");
assert!((r0.bottom() - r1.bottom()).abs() < 0.01 && r0.h > r1.h * 1.9, "{r0:?} {r1:?}");
// The lower half of the merge hits the restart cell (row 0), not the continuation row.
let hit = l.cell_at(0, r1.x + 5.0, r1.y + r1.h / 2.0).unwrap();
assert_eq!((hit.2, hit.3), (0, 0));
}
/// A 1×3 table after "before" whose middle cell holds `text` running `dir`.
fn turned_table(dir: TextDirection, text: &str, row: Option<f32>) -> Document {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(1, 3, 468.0);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("plain", Default::default()))];
t.rows[0].cells[1].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))];
t.rows[0].cells[1].props.text_direction = dir;
if let Some(h) = row {
t.rows[0].props.height = Some(h);
t.rows[0].props.height_rule = wordcraft_doc::props::HeightRule::Exact;
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
d
}
fn turned_lines(l: &DocLayout) -> &Placed {
l.pages[0].items.iter().find(|it| matches!(it, Placed::Lines { path, .. } if path.0 == [1, 0, 1, 0])).unwrap()
}
/// Table Layout › Text Direction (#226): turned cell text runs along the cell's height, the row
/// grows to fit it, and caret, clicks and drawing follow the turn.
#[test]
fn turned_cell_text_runs_down_the_cell() {
crate::test_fonts();
let text = "Turned cell text";
let d = turned_table(TextDirection::Down, text, None);
let l = lay(&d);
let it = turned_lines(&l);
assert!(matches!(it, Placed::Lines { turn: TextDirection::Down, l0: 0, l1: 1, .. }), "one unwrapped line: {it:?}");
let b = it.turned_bounds().unwrap();
// Tall and narrow, against the cell's right edge (cell 2 spans x 228..384, 5.4pt margins).
assert!(b.h > 60.0 && b.w < 20.0, "{b:?}");
assert!((b.right() - (72.0 + 312.0 - 5.4)).abs() < 1.0 && b.x > 72.0 + 156.0, "{b:?}");
// The row grew to hold the text: the next paragraph starts below it.
let after = l.caret(&Pos::body(2, 0)).unwrap();
assert!(after.top > b.bottom(), "{after:?} vs {b:?}");
let cell = l.pages[0].items.iter().find_map(|i| if let Placed::Cell { rect, cell: 1, .. } = i { Some(*rect) } else { None }).unwrap();
assert!(cell.h >= b.h, "{cell:?}");
// The caret lies across the page and moves down as the text goes on.
let pos = |off| Pos { story: StoryRef::Body, path: Path(vec![1, 0, 1, 0]), off };
let c0 = l.caret(&pos(0)).unwrap();
let c1 = l.caret(&pos(text.len())).unwrap();
assert!(c0.width > 5.0 && c0.height == 0.0, "{c0:?}");
assert!((c0.top - b.y).abs() < 1.0 && c1.top > c0.top + 50.0, "{c0:?} {c1:?}");
assert!(c0.x >= b.x - 0.5 && c0.x + c0.width <= b.right() + 0.5, "{c0:?} {b:?}");
// A click on the turned text lands in it, by how far down the click is.
let hit = l.hit(0, b.x + b.w / 2.0, b.y + b.h * 0.6, StoryRef::Body).unwrap();
assert_eq!(hit.path, Path(vec![1, 0, 1, 0]));
assert!(hit.off > 3 && hit.off < text.len(), "{hit:?}");
// Selection highlights are turned too: tall, inside the text's area.
let sel = l.selection_rects(&d, &pos(0), &pos(text.len()), 0);
assert!(sel.iter().all(|(_, r)| r.h > r.w && r.x >= b.x - 1.0 && r.right() <= b.right() + 1.0), "{sel:?}");
// Drawn in a turned frame.
let draws = display::page_display(&d, &l.pages[0], &Default::default());
let turned = draws.iter().find_map(|x| if let display::Draw::Turned { turn, items, .. } = x { Some((*turn, items)) } else { None });
let (turn, items) = turned.expect("turned draw");
assert_eq!(turn, TextDirection::Down);
assert!(items.iter().any(|x| matches!(x, display::Draw::Glyphs { text, .. } if text.contains("Turned"))), "{items:?}");
}
#[test]
fn turned_up_cell_text_reads_bottom_to_top() {
crate::test_fonts();
let text = "Bottom to top";
let d = turned_table(TextDirection::Up, text, None);
let l = lay(&d);
let b = turned_lines(&l).turned_bounds().unwrap();
// Against the cell's left edge; the text starts at the bottom and climbs.
assert!((b.x - (72.0 + 156.0 + 5.4)).abs() < 1.0, "{b:?}");
let pos = |off| Pos { story: StoryRef::Body, path: Path(vec![1, 0, 1, 0]), off };
let (c0, c1) = (l.caret(&pos(0)).unwrap(), l.caret(&pos(text.len())).unwrap());
assert!((c0.top - b.bottom()).abs() < 1.0 && c1.top < c0.top - 50.0, "{c0:?} {c1:?} {b:?}");
let hit = l.hit(0, b.x + b.w / 2.0, b.bottom() - 2.0, StoryRef::Body).unwrap();
assert_eq!((hit.path, hit.off), (Path(vec![1, 0, 1, 0]), 0));
}
/// #2038 with turned cell text: a click just outside a floating table, in the 2pt around turned
/// text that still takes a click, goes to the text beside or after the table, not into a cell; a
/// click on the table's edge still lands in one. A table that doesn't float keeps such a click.
#[test]
fn a_click_just_outside_a_floating_table_skips_its_turned_cell_text() {
use TextDirection::{Down, Horizontal, Up};
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
// (the section's direction, the cells' direction, whether the table floats)
let cases = [
(Horizontal, Down, true),
(Horizontal, Up, true),
(Down, Horizontal, true),
(Up, Horizontal, true),
(Horizontal, Down, false),
(Horizontal, Up, false),
];
for (section, cells, floats) in cases {
let case = format!("section {section:?}, cells {cells:?}, floating {floats}");
let mut d = Document::from_text("before\nafter");
d.last_section.text_direction = section;
let mut t = Table::new(2, 2, 200.0);
for c in t.rows.iter_mut().flat_map(|r| r.cells.iter_mut()) {
c.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Turned", Default::default()))];
c.props.text_direction = cells;
}
if floats {
t.props.float = Some(TableFloat {
h_rel: Anchor::Column,
v_rel: Anchor::Paragraph,
x: 150.0,
dist: [9.0, 0.0, 9.0, 0.0],
overlap: true,
..Default::default()
});
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let page = &l.pages[0];
assert_eq!(page.float_tables.len(), usize::from(floats), "{case}");
let area = page
.items
.iter()
.filter_map(|it| if let Placed::Cell { rect, .. } = it { Some(*rect) } else { None })
.reduce(|a, b| a.union(&b))
.unwrap();
let turned: Vec<Rect> = page
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story: StoryRef::Body, path, .. } if path.0.len() > 1 => it.turned_bounds(),
_ => None,
})
.collect();
assert!(!turned.is_empty(), "{case}: the cells' text is turned");
// Points on each side of the table (on its edge, and 1 and 2pt outside) across from turned
// cell text, which takes a click up to 2pt from its bounds.
let near = |p: &Point| turned.iter().any(|r| r.expand(2.0).contains(*p));
let side = |r: &Rect, out: f32| {
let (cx, cy) = (r.x + r.w / 2.0, r.y + r.h / 2.0);
[Point::new(cx, area.y - out), Point::new(cx, area.bottom() + out), Point::new(area.x - out, cy), Point::new(area.right() + out, cy)]
};
let outside: Vec<Point> = turned.iter().flat_map(|r| [side(r, 1.0), side(r, 2.0)]).flatten().filter(near).collect();
let edge: Vec<Point> = turned.iter().flat_map(|r| side(r, 0.0)).filter(near).collect();
assert!(!outside.is_empty() && !edge.is_empty(), "{case}: turned text within 2pt of the edge {area:?}: {turned:?}");
for p in outside {
let hit = l.hit(0, p.x, p.y, StoryRef::Body).unwrap();
assert_eq!(hit.path.0.len() == 1, floats, "{case}: a click at {p:?} landed in {:?}", hit.path);
}
for p in edge {
let hit = l.hit(0, p.x, p.y, StoryRef::Body).unwrap();
assert!(hit.path.0.len() > 1, "{case}: a click on the edge at {p:?} landed in {:?}", hit.path);
}
}
}
/// The same rule when nothing upright but a floating table's cells is on the page (the page's
/// paragraphs taken off the laid-out page): a click outside the table goes to other turned text
/// there, and one by turned text of the table's own still lands in that cell, not in the nearest
/// upright one.
#[test]
fn a_click_by_a_floating_table_with_no_upright_text_beside_it_prefers_turned_text() {
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let table = |dirs: [TextDirection; 2], floats: bool| {
let mut t = Table::new(1, 2, 200.0);
for (c, dir) in t.rows[0].cells.iter_mut().zip(dirs) {
c.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Cell text", Default::default()))];
c.props.text_direction = dir;
}
if floats {
t.props.float = Some(TableFloat {
h_rel: Anchor::Column,
v_rel: Anchor::Paragraph,
x: 150.0,
dist: [9.0, 0.0, 9.0, 0.0],
overlap: true,
..Default::default()
});
}
wordcraft_doc::Block::Table(t)
};
let lay_bare = |d: &Document| {
let mut l = lay(d);
l.pages[0].items.retain(|it| !matches!(it, Placed::Lines { path, .. } if path.0.len() == 1));
l
};
let cell_area = |l: &DocLayout, t: u32| {
l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Cell { rect, table, .. } if table.0 == [t] => Some(*rect),
_ => None,
})
.reduce(|a, b| a.union(&b))
.unwrap()
};
// A floating table with an upright cell and a turned one: a click 1pt above the turned
// text lands in it, as it did before the floating-table rule.
let mut d = Document::from_text("before\nafter");
d.insert_block(StoryRef::Body, &Path::top(1), table([TextDirection::Horizontal, TextDirection::Down], true)).unwrap();
let l = lay_bare(&d);
assert_eq!(l.pages[0].float_tables, [Path::top(1)]);
let area = cell_area(&l, 1);
let turned = turned_lines(&l).turned_bounds().unwrap();
let p = Point::new(turned.x + turned.w / 2.0, area.y - 1.0);
assert!(turned.expand(2.0).contains(p) && !area.contains(p), "{p:?} {turned:?} {area:?}");
assert_eq!(l.hit(0, p.x, p.y, StoryRef::Body).unwrap().path, Path(vec![1, 0, 1, 0]));
// An upright floating table and, below it, a table in the text flow with turned cells: a
// click below the floating one goes to that turned text, not to the floating table.
let mut d = Document::from_text("before\nbeside\nbeside\nbeside\nafter");
d.insert_block(StoryRef::Body, &Path::top(1), table([TextDirection::Horizontal; 2], true)).unwrap();
d.insert_block(StoryRef::Body, &Path::top(5), table([TextDirection::Down; 2], false)).unwrap();
let l = lay_bare(&d);
assert_eq!(l.pages[0].float_tables, [Path::top(1)]);
let (area, flow) = (cell_area(&l, 1), cell_area(&l, 5));
assert!(flow.y > area.bottom() + 12.0, "{area:?} {flow:?}");
let hit = l.hit(0, area.x + area.w / 2.0, area.bottom() + 6.0, StoryRef::Body).unwrap();
assert_eq!(hit.path.0.first(), Some(&5), "{hit:?}");
// Both: a click 1pt above the floating table's turned cell goes to the other turned text,
// which comes before the table's own.
let mut d = Document::from_text(&format!("before\n{}after", "beside\n".repeat(6)));
d.insert_block(StoryRef::Body, &Path::top(1), table([TextDirection::Horizontal, TextDirection::Down], true)).unwrap();
d.insert_block(StoryRef::Body, &Path::top(8), table([TextDirection::Down; 2], false)).unwrap();
let l = lay_bare(&d);
assert_eq!(l.pages[0].float_tables, [Path::top(1)]);
let (area, flow) = (cell_area(&l, 1), cell_area(&l, 8));
assert!(flow.y > area.bottom() + 12.0, "{area:?} {flow:?}");
let turned = turned_lines(&l).turned_bounds().unwrap();
let p = Point::new(turned.x + turned.w / 2.0, area.y - 1.0);
assert!(turned.expand(2.0).contains(p) && !area.contains(p), "{p:?} {turned:?} {area:?}");
let hit = l.hit(0, p.x, p.y, StoryRef::Body).unwrap();
assert_eq!(hit.path.0.first(), Some(&8), "{hit:?}");
}
#[test]
fn turned_text_wraps_in_an_exact_row() {
crate::test_fonts();
let d = turned_table(TextDirection::Down, &"word ".repeat(30), Some(72.0));
let l = lay(&d);
let it = turned_lines(&l);
let lines = if let Placed::Lines { l0, l1, .. } = it { l1 - l0 } else { 0 };
assert!(lines > 2, "the text wraps at the row height");
let b = it.turned_bounds().unwrap();
assert!(b.h <= 72.0 && b.w > 30.0, "{b:?}");
let after = l.caret(&Pos::body(2, 0)).unwrap();
assert!(after.top < b.y + 72.0 + 30.0, "the row keeps its exact height: {after:?}");
}
#[test]
fn hostile_turned_cells_never_panic() {
crate::test_fonts();
// Empty, huge and nested turned cells, in exact rows too small for anything.
for dir in [TextDirection::Down, TextDirection::Up] {
for row in [None, Some(0.5), Some(1e9)] {
let mut d = turned_table(dir, "", row);
let l = lay(&d);
let _ = l.caret(&Pos { story: StoryRef::Body, path: Path(vec![1, 0, 1, 0]), off: 0 });
let mut inner = Table::new(1, 1, 20.0);
inner.rows[0].cells[0].props.text_direction = dir;
if let Some(Block::Table(t)) = d.body.get_mut(1).map(Arc::make_mut) {
t.rows[0].cells[1].blocks.insert(0, Arc::new(Block::Table(inner)));
}
let l = lay(&d);
for p in &l.pages {
let _ = display::page_display(&d, p, &Default::default());
}
}
}
let l = lay(&turned_table(TextDirection::Down, &"long ".repeat(5000), None));
assert!(!l.pages.is_empty());
}
fn rules_on_page0(l: &DocLayout) -> Vec<f32> {
l.pages[0].items.iter().filter_map(|i| if let Placed::Rule { border, .. } = i { Some(border.width) } else { None }).collect()
}
#[test]
fn table_style_borders_survive_empty_tbl_borders() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 2, 468.0); // defaults to the TableGrid style
t.props.borders = Some(Borders::default()); // what an empty <w:tblBorders/> parses to
for r in &mut t.rows {
for c in &mut r.cells {
c.props.borders = Some(Borders::default());
}
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
assert!(rules_on_page0(&l).len() >= 8, "rules {:?}", rules_on_page0(&l));
}
/// Thick borders meet in closed corners: a horizontal edge starts at the outer side of the
/// vertical edge it meets, not at its centre line.
#[test]
fn table_border_corners_close() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 2, 468.0);
let thick = Some(Border::single(3.0));
for r in &mut t.rows {
for c in &mut r.cells {
c.props.borders = Some(Borders { top: thick, left: thick, bottom: thick, right: thick, ..Borders::default() });
}
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let (mut h_left, mut v_left) = (f32::MAX, f32::MAX);
for it in &l.pages[0].items {
if let Placed::Rule { x0, y0, x1, y1, .. } = it {
if y0 == y1 {
h_left = h_left.min(x0.min(*x1));
} else if x0 == x1 {
v_left = v_left.min(*x0);
}
}
}
assert!((h_left - (v_left - 1.5)).abs() < 0.01, "horizontal starts at {h_left}, vertical centre line at {v_left}");
}
/// A row with `w:gridBefore` starts at the grid column after the skipped ones, not at the first.
#[test]
fn grid_before_row_starts_after_skipped_columns() {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 3, 468.0);
t.rows[1].cells.remove(0);
t.rows[1].props.grid_before = 1;
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let x_of = |r: usize, c: usize| {
l.pages[0].items.iter().find_map(|i| match i {
Placed::Cell { rect, row, cell, .. } if *row == r && *cell == c => Some(rect.x),
_ => None,
})
};
let (shifted, second) = (x_of(1, 0).unwrap(), x_of(0, 1).unwrap());
assert!((shifted - second).abs() < 0.01, "row 1 starts at {shifted}, grid column 1 at {second}");
}
/// The area of cell `c` of row `r` of the table on page `page`.
fn cell_rect(l: &DocLayout, page: usize, r: usize, c: usize) -> Option<wordcraft_geom::Rect> {
l.pages.get(page)?.items.iter().find_map(|i| match i {
Placed::Cell { rect, row, cell, .. } if *row == r && *cell == c => Some(*rect),
_ => None,
})
}
/// Rows that skip grid columns at the start and at the end (`w:gridBefore`, `w:gridAfter`, as in
/// #1174): the cells sit on their own grid columns, the middle one keeps its width, and a merge
/// down the last column matches by the shifted column.
#[test]
fn grid_before_and_after_rows_keep_their_columns_and_merges() {
let mut d = Document::from_text("before\nafter");
let grid = [239.0f32, 679.0, 101.0, 3790.0, 2312.0, 1189.0].map(|w| w / 20.0);
let mut t = Table::new(3, 4, 468.0);
t.props.fixed = true;
t.grid = grid.to_vec();
for (ri, row) in t.rows.iter_mut().enumerate() {
row.cells.truncate(3);
row.props.grid_before = 1;
row.props.w_before = Some(grid[0]);
for (c, span) in row.cells.iter_mut().zip([2, 1, 2]) {
c.props.span = span;
c.props.width = None;
}
row.cells[1] = wordcraft_doc::Cell::with_text("Middle cell, wide enough for a few words on a line.");
row.cells[2].props.span = 2;
row.cells[2].props.vmerge = if ri == 0 { wordcraft_doc::props::VMerge::Restart } else { wordcraft_doc::props::VMerge::Continue };
}
// A row without the gap, and one skipping the last column instead.
t.rows[1].props = Default::default();
t.rows[1].cells.insert(0, wordcraft_doc::Cell::empty());
t.rows[2].props.grid_before = 0;
t.rows[2].props.grid_after = 1;
t.rows[2].cells[0].props.span = 3;
t.rows[2].cells[2].props.span = 1;
let colx = |g: usize| grid[..g].iter().sum::<f32>();
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let rect = |r, c| cell_rect(&l, 0, r, c).unwrap();
let x0 = rect(1, 0).x;
let middle = rect(0, 1);
assert!((rect(0, 0).x - x0 - colx(1)).abs() < 0.01, "row 0 starts at {}", rect(0, 0).x - x0);
assert!((middle.x - x0 - colx(3)).abs() < 0.01 && (middle.w - grid[3]).abs() < 0.01, "middle cell {middle:?}");
assert!((rect(2, 2).x - x0 - colx(4)).abs() < 0.01 && (rect(2, 2).w - grid[4]).abs() < 0.01, "row 2's last cell {:?}", rect(2, 2));
// The merge runs down all three rows.
let merged = rect(0, 2);
let rows_h = rect(0, 0).h + rect(1, 0).h + rect(2, 0).h;
assert!((merged.h - rows_h).abs() < 0.01, "merged cell {} tall, rows {rows_h}", merged.h);
}
/// A row's own first and last cell carry the table's outer side borders when it skips the grid
/// columns beyond them.
#[test]
fn skipped_columns_put_the_side_borders_on_the_rows_cells() {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(3, 3, 468.0);
t.props.style = None;
let thick = Some(Border::single(3.0));
t.props.borders = Some(Borders { left: thick, right: thick, ..Borders::default() });
t.rows[1].cells.remove(0);
t.rows[1].props.grid_before = 1;
t.rows[2].cells.pop();
t.rows[2].props.grid_after = 1;
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let rect = |r, c| cell_rect(&l, 0, r, c).unwrap();
let vertical_at = |x: f32, y: f32| {
l.pages[0].items.iter().any(|i| matches!(i, Placed::Rule { x0, y0, x1, y1, .. } if x0 == x1 && (x0 - x).abs() < 0.01 && *y0 <= y && *y1 >= y))
};
let (r1, r2) = (rect(1, 0), rect(2, 1));
assert!(vertical_at(r1.x, r1.y + r1.h / 2.0), "no left border at row 1's first cell {r1:?}");
assert!(vertical_at(r2.x + r2.w, r2.y + r2.h / 2.0), "no right border at row 2's last cell {r2:?}");
}
/// AutoFit makes the skipped columns as wide as the row says (`w:wBefore`).
#[test]
fn autofit_gives_skipped_columns_their_width() {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 2, 468.0);
t.props.style = None;
for row in &mut t.rows {
for c in &mut row.cells {
*c = wordcraft_doc::Cell::with_text("A");
}
}
t.rows[1].cells.remove(0);
t.rows[1].props.grid_before = 1;
t.rows[1].props.w_before = Some(150.0);
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let gap = cell_rect(&l, 0, 1, 0).unwrap().x - cell_rect(&l, 0, 0, 0).unwrap().x;
assert!((gap - 150.0).abs() < 0.01, "skipped column {gap} wide");
}
/// Rows skipping a grid column keep it skipped on every page, under the repeated header row.
#[test]
fn grid_before_rows_stay_shifted_across_pages() {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(80, 3, 468.0);
t.rows[0].props.header = true;
for row in t.rows.iter_mut().skip(1) {
row.cells.remove(0);
row.props.grid_before = 1;
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
assert!(l.pages.len() >= 2, "pages {}", l.pages.len());
let column1 = cell_rect(&l, 0, 0, 1).unwrap().x;
for (pi, p) in l.pages.iter().enumerate() {
assert!(cell_rect(&l, pi, 0, 1).is_some_and(|r| (r.x - column1).abs() < 0.01), "no header on page {pi}");
for i in &p.items {
if let Placed::Cell { rect, row, cell: 0, .. } = i
&& *row > 0
{
assert!((rect.x - column1).abs() < 0.01, "row {row} on page {pi} starts at {}", rect.x);
}
}
}
}
#[test]
fn table_own_border_overrides_only_that_side() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 2, 468.0);
t.props.borders = Some(Borders { top: Some(Border::single(2.0)), ..Default::default() });
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let w = rules_on_page0(&l);
assert!(w.contains(&2.0), "own top missing: {w:?}");
assert!(w.iter().filter(|x| (**x - 0.5).abs() < 1e-6).count() >= 6, "style sides missing: {w:?}");
}
#[test]
fn table_nil_border_hides_style_side() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(1, 1, 468.0); // 1×1: no inside edges
t.props.borders = Some(Borders::all(Border { style: BorderStyle::None, width: 0.0, color: None, space: 0.0 }));
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
assert!(rules_on_page0(&lay(&d)).is_empty());
}
#[test]
fn table_without_style_stays_borderless() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 2, 468.0);
t.props.style = None;
t.props.borders = Some(Borders::default());
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
assert!(rules_on_page0(&lay(&d)).is_empty());
}
#[test]
fn headers_and_page_fields() {
crate::test_fonts();
let mut d = Document::from_text(&"para\n".repeat(120));
let mut hp = wordcraft_doc::Paragraph::new();
hp.insert_object(
0,
InlineObject::Field { instr: "PAGE".into(), result: String::new(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
let id = d.add_part(wordcraft_doc::PartKind::Footer, vec![wordcraft_doc::para_block(hp)]);
d.last_section.footers.default = Some(id);
let l = lay(&d);
assert!(l.pages.len() >= 2);
for (i, p) in l.pages.iter().enumerate() {
assert_eq!(p.footer_story, Some(id));
let label = p.footer.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para.clusters.len()) } else { None });
assert!(label.is_some(), "page {i}");
}
let c = l.caret_on(&Pos { story: StoryRef::Part(id), path: Path::top(0), off: 0 }, 1).unwrap();
assert_eq!(c.page, 1);
assert!(c.top > 700.0);
}
/// Spaces typed at the end of a line hang past the right margin (they don't wrap), but the caret
/// after them stays at the margin, as in Word, instead of running off the page (#2146). A letter
/// typed after them wraps to the next line. Same in the body and in a header.
#[test]
fn caret_after_hanging_spaces_stays_at_the_margin() {
crate::test_fonts();
let spaces = format!("a{}", " ".repeat(200));
for header in [false, true] {
for text in [spaces.clone(), format!("{spaces}b")] {
let mut d = Document::new();
let p = wordcraft_doc::Paragraph::with_text(&text, Default::default());
let pos = if header {
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(p)]);
d.last_section.headers.default = Some(id);
Pos { story: StoryRef::Part(id), path: Path::top(0), off: text.len() }
} else {
d.body = vec![wordcraft_doc::para_block(p)];
Pos::body(0, text.len())
};
let right = d.last_section.page_w - d.last_section.margin_right;
let l = lay(&d);
let items = if header { &l.pages[0].header } else { &l.pages[0].items };
let lines = items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para.lines.len()) } else { None }).unwrap();
let c = l.caret(&pos).unwrap();
let typed = text.ends_with('b');
assert_eq!(lines, if typed { 2 } else { 1 }, "header {header}, letter typed {typed}");
assert!(c.x <= right + 0.5, "header {header}, letter typed {typed}: caret at {} past the margin at {right}", c.x);
if !typed {
assert!(c.x >= right - 0.5, "header {header}: the caret sits at the margin, after the spaces ({})", c.x);
}
}
}
}
#[test]
fn tall_first_page_header_pushes_body_down() {
crate::test_fonts();
let mut d = Document::from_text(&"para\n".repeat(120));
let tall: Vec<_> = (0..12).map(|_| wordcraft_doc::para_block(wordcraft_doc::Paragraph::new())).collect();
let id = d.add_part(wordcraft_doc::PartKind::Header, tall);
d.last_section.headers.first = Some(id);
d.last_section.title_page = true;
let l = lay(&d);
let first = l.caret(&Pos::body(0, 0)).unwrap();
assert!(first.top > d.last_section.margin_top + 50.0, "{first:?}");
// The first paragraph on page 2 (which has no header) sits higher than page 1's first line,
// whatever the installed fonts do to pagination.
let later = (0..120).filter_map(|i| l.caret(&Pos::body(i, 0))).find(|c| c.page == 1).unwrap();
assert!(later.top < first.top, "{later:?}");
}
#[test]
fn cache_reuses_unchanged_paragraphs() {
crate::test_fonts();
let d = Document::from_text(&"some text here\n".repeat(50));
let mut c = LayoutCache::new();
layout(&d, &mut c, &LayoutOptions::default());
let misses = c.misses;
let mut d2 = d.clone();
d2.insert_text(&Pos::body(10, 0), "x", &Default::default()).unwrap();
layout(&d2, &mut c, &LayoutOptions::default());
assert_eq!(c.misses, misses + 1);
}
/// The paragraph after a heading kept with it is measured before the heading is placed. That
/// layout goes into the cache under the key it is placed with, so it is laid out once, with
/// proofing off or on, and proofing moves nothing.
#[test]
fn kept_headings_measure_the_next_paragraph_through_the_cache() {
let mut d = Document::new();
let kept = ParaProps { keep_next: Some(true), ..Default::default() };
for i in 0..40 {
let mut heading = wordcraft_doc::Paragraph::with_text(&format!("Heading {i}"), Default::default());
heading.props = kept.clone();
d.body.push(wordcraft_doc::para_block(heading));
let body = format!("Body text {i} under its heading, long enough to wrap onto a second line in the column. ").repeat(3);
d.body.push(wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&body, Default::default())));
}
let mut c = LayoutCache::new();
let l = layout(&d, &mut c, &LayoutOptions::default());
assert!(l.pages.len() > 2, "{}", l.pages.len());
assert_eq!(c.len(), d.body.len(), "one layout per paragraph");
assert_eq!(c.misses, d.body.len() as u64, "each paragraph laid out once");
let mut c = LayoutCache::new();
let proofed = layout(&d, &mut c, &LayoutOptions { proofing: true, ..Default::default() });
assert_eq!(c.misses, d.body.len() as u64, "each paragraph laid out once with proofing on");
assert!(c.hits >= 40, "each kept heading should reuse its following paragraph layout with proofing on; got {} cache hits", c.hits);
let starts = |l: &DocLayout| (0..d.body.len()).map(|i| l.caret(&Pos::body(i, 0)).map(|c| (c.page, c.top.to_bits()))).collect::<Vec<_>>();
assert_eq!(starts(&l), starts(&proofed));
}
/// Autofit measures every cell at an unbounded width; the cache keeps what it measured, not
/// those layouts, so a long table holds one layout per cell paragraph. Laying the document out
/// again after an edit elsewhere measures nothing again.
#[test]
fn cache_keeps_one_layout_per_table_cell() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(4, 3, 468.0);
for (r, row) in t.rows.iter_mut().enumerate() {
for (k, cell) in row.cells.iter_mut().enumerate() {
cell.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("row {r} cell {k}"), Default::default()))];
}
}
assert!(!t.props.fixed);
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let mut c = LayoutCache::new();
layout(&d, &mut c, &LayoutOptions::default());
assert_eq!(c.len(), 2 + 12);
let misses = c.misses;
d.insert_text(&Pos::body(0, 0), "x", &Default::default()).unwrap();
layout(&d, &mut c, &LayoutOptions::default());
assert_eq!(c.misses, misses + 1);
}
#[test]
fn selection_rects_cover_range() {
crate::test_fonts();
let d = Document::from_text("Hello world\nSecond line");
let l = lay(&d);
let r = l.selection_rects(&d, &Pos::body(0, 6), &Pos::body(1, 6), 0);
assert_eq!(r.len(), 2);
assert!(r[0].1.w > 20.0);
}
#[test]
fn column_segments_take_the_same_x_range_on_every_line() {
crate::test_fonts();
let d = Document::from_text("abcdef\nabcdef\nab");
let l = lay(&d);
let left = l.caret(&Pos::body(0, 2)).unwrap().x;
let right = l.caret(&Pos::body(0, 4)).unwrap().x;
let (start, end) = (Pos::body(2, 2), Pos::body(0, 2));
let segs = l.column_segments(&d, hit::ColumnSelection { start: &start, end: &end, left: right, right: left, page_hint: 0, max_lines: 100 });
let offs: Vec<(u32, usize, usize)> = segs.iter().map(|(a, b)| (a.path.0[0], a.off, b.off)).collect();
assert_eq!(offs, vec![(0, 2, 4), (1, 2, 4), (2, 2, 2)]);
// Capped, and junk x gives nothing.
assert_eq!(l.column_segments(&d, hit::ColumnSelection { start: &start, end: &end, left, right, page_hint: 0, max_lines: 2 }).len(), 2);
assert!(l.column_segments(&d, hit::ColumnSelection { start: &start, end: &end, left: f32::NAN, right, page_hint: 0, max_lines: 100 }).is_empty());
}
#[test]
fn display_has_glyphs_and_marks() {
crate::test_fonts();
let mut d = Document::from_text("Hello\tworld");
d.format_range(&Pos::body(0, 0), &Pos::body(0, 5), &|c| c.underline = Some(wordcraft_doc::props::Underline::Single)).unwrap();
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions { marks: true, ..Default::default() });
assert!(items.iter().any(|i| matches!(i, display::Draw::Glyphs { .. })));
assert!(items.iter().any(|i| matches!(i, display::Draw::Line { .. })));
assert!(items.iter().any(|i| matches!(i, display::Draw::Mark { ch: '¶', .. })));
assert!(items.iter().any(|i| matches!(i, display::Draw::Mark { ch: '→', .. })));
}
#[test]
fn a_tracked_paragraph_mark_shows_in_its_authors_colour() {
crate::test_fonts();
let mut d = Document::from_text("Split\nhere");
d.revisions.push(wordcraft_doc::Revision {
kind: wordcraft_doc::RevisionKind::Insert,
author: "Ana".into(),
date: String::new(),
move_name: None,
});
d.para_mut(wordcraft_doc::StoryRef::Body, &wordcraft_doc::Path::top(0)).unwrap().mark.ins = Some(0);
let l = lay(&d);
let marks = |markup: bool| -> Vec<Option<wordcraft_doc::props::Rgb>> {
display::page_display(&d, &l.pages[0], &display::DisplayOptions { marks: true, markup, ..Default::default() })
.into_iter()
.filter_map(|i| if let display::Draw::Mark { ch: '¶', color, .. } = i { Some(color) } else { None })
.collect()
};
assert_eq!(marks(true), [Some(display::revision_color(0)), None]);
assert_eq!(marks(false), [None, None]);
}
#[test]
fn section_breaks_show_with_formatting_marks() {
crate::test_fonts();
use wordcraft_doc::section::{SectionProps, SectionStart};
// Two sections: "One" ends the first; the second starts as `start`.
let doc = |start: SectionStart| {
let mut d = Document::from_text("One\nTwo");
d.para_mut(wordcraft_doc::StoryRef::Body, &wordcraft_doc::Path::top(0)).unwrap().section = Some(Box::new(SectionProps::default()));
d.last_section.start = start;
d
};
let labels = |d: &Document, marks: bool| -> (Vec<String>, usize) {
let l = lay(d);
let items = display::page_display(d, &l.pages[0], &display::DisplayOptions { marks, ..Default::default() });
let texts = items.iter().filter_map(|i| if let display::Draw::MarkText { text, .. } = i { Some(text.clone()) } else { None }).collect();
let pilcrows = items.iter().filter(|i| matches!(i, display::Draw::Mark { ch: '¶', .. })).count();
(texts, pilcrows)
};
let d = doc(SectionStart::Continuous);
// The break replaces the first paragraph's ¶; the last paragraph keeps its own.
assert_eq!(labels(&d, true), (vec!["Section Break (Continuous)".to_string()], 1));
assert_eq!(labels(&d, false), (vec![], 0));
assert_eq!(labels(&doc(SectionStart::NextPage), true).0, ["Section Break (Next Page)"]);
assert_eq!(labels(&doc(SectionStart::EvenPage), true).0, ["Section Break (Even Page)"]);
assert_eq!(labels(&doc(SectionStart::OddPage), true).0, ["Section Break (Odd Page)"]);
// A document with one section has no break.
assert_eq!(labels(&Document::from_text("One\nTwo"), true), (vec![], 2));
}
/// A paragraph kept together counts its border room: one that fits on the page only without it
/// moves to the next page whole rather than splitting.
#[test]
fn a_kept_together_paragraph_counts_its_border_room() {
use wordcraft_doc::props::LineSpacing;
let plain = ParaProps { space_before: Some(0.0), space_after: Some(0.0), line_spacing: Some(LineSpacing::Exactly(12.0)), ..Default::default() };
let doc = |filler: f32| {
let mut d = Document::from_text(&format!("Filler\n{}", "word ".repeat(200)));
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props = ParaProps { line_spacing: Some(LineSpacing::Exactly(filler)), ..plain.clone() };
let top = Some(Border { space: 20.0, ..Border::single(4.0) });
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().props =
ParaProps { keep_lines: Some(true), borders: Some(Borders { top, ..Borders::default() }), ..plain.clone() };
d
};
let lines = |l: &DocLayout| -> Vec<usize> {
l.pages
.iter()
.enumerate()
.flat_map(|(pi, p)| p.items.iter().filter(|i| matches!(i, Placed::Lines { path, .. } if path.0 == [1])).map(move |_| pi))
.collect()
};
let l = lay(&doc(12.0));
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { path, .. } if path.0 == [1])) else {
panic!()
};
let h = para.height;
assert!(para.lines.len() >= 3, "{}", para.lines.len());
// Room for its lines and 10 pt more, not for its 24 pt top border as well.
let l = lay(&doc(648.0 - h - 10.0));
assert_eq!(lines(&l), [1], "kept together on the next page");
}
/// A bordered paragraph whose mark stays with its closing page break leaves its bottom border on
/// that page: the next page starts with the next paragraph at the top.
#[test]
fn a_bottom_border_stays_with_a_closing_page_break() {
let brk = wordcraft_doc::para::PAGE_BREAK;
let top = |border: bool| {
let mut d = Document::from_text(&format!("First{brk}\nNext"));
if border {
let bottom = Some(Border { space: 10.0, ..Border::single(4.0) });
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.borders = Some(Borders { bottom, ..Borders::default() });
}
let l = lay(&d);
let c = l.caret(&Pos::body(1, 0)).unwrap();
(c.page, c.top)
};
let (plain, bordered) = (top(false), top(true));
assert_eq!(plain.0, 1);
assert_eq!(bordered.0, 1);
assert!((bordered.1 - plain.1).abs() < 0.05, "{bordered:?} vs {plain:?}");
}
/// In Outline view a paragraph's borders take their room as well: the next paragraph starts
/// below them.
#[test]
fn outline_view_makes_room_for_paragraph_borders() {
let lines = |border: bool| {
let mut d = Document::from_text("One\nTwo");
if border {
let b = Some(Border { space: 4.0, ..Border::single(2.0) });
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.borders = Some(Borders { top: b, bottom: b, ..Borders::default() });
}
let opts = LayoutOptions { view: ViewMode::Outline, ..Default::default() };
let l = layout(&d, &mut LayoutCache::new(), &opts);
let ys: Vec<f32> = l.pages[0].items.iter().filter_map(|i| if let Placed::Lines { y, .. } = i { Some(*y) } else { None }).collect();
(ys[0], ys[1])
};
let (plain, bordered) = (lines(false), lines(true));
// Its line moves down by the top border's room, the next one by both borders' rooms.
assert!((bordered.0 - plain.0 - 6.0).abs() < 0.05, "{bordered:?} vs {plain:?}");
assert!((bordered.1 - plain.1 - 12.0).abs() < 0.05, "{bordered:?} vs {plain:?}");
}
/// Shaded paragraphs with a bar on the left (a call-out box): the top border's room pushes the
/// first line down and is shaded, and paragraphs with the same borders make one box whose shading
/// and bar run on through the space between them; a paragraph whose borders differ (here the
/// first, with its top border) is a box of its own (Word).
#[test]
fn paragraphs_with_the_same_borders_join_in_one_shaded_box() {
let fill = wordcraft_doc::props::Rgb(0xFF, 0xF2, 0xCC);
let bar = Some(Border { width: 2.5, space: 8.0, ..Border::single(2.5) });
let top = Some(Border { color: Some(fill), space: 6.0, ..Border::single(0.25) });
let mut d = Document::from_text("Before\nTitle\nOne\nTwo\nAfter");
for i in 1..4 {
let p = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
p.props.borders = Some(Borders { top: if i == 1 { top } else { None }, left: bar, ..Borders::default() });
p.props.shading = Some(fill);
(p.props.space_before, p.props.space_after) = (Some(6.0), Some(6.0));
}
let l = lay(&d);
let items = &l.pages[0].items;
let line_y: Vec<f32> = items.iter().filter_map(|i| if let Placed::Lines { y, .. } = i { Some(*y) } else { None }).collect();
let fills: Vec<Rect> = items.iter().filter_map(|i| if let Placed::Fill { rect, .. } = i { Some(*rect) } else { None }).collect();
let bars: Vec<(f32, f32)> =
items.iter().filter_map(|i| if let Placed::Rule { x0, x1, y0, y1, .. } = i { (x0 == x1).then_some((*y0, *y1)) } else { None }).collect();
assert_eq!(fills.len(), 3, "{fills:?}");
// The title: shaded from the top border's outer edge, its line below the border's room.
assert!((line_y[1] - fills[0].y - 6.25).abs() < 0.01, "{line_y:?} {fills:?}");
assert!((bars[0].0 - fills[0].y).abs() < 0.01, "{bars:?}");
// Its box ends at its text: the space below it is not shaded (the next paragraph's borders differ).
assert!(fills[1].y - fills[0].bottom() > 5.9, "{fills:?}");
// One and Two are one box: no gap between their shading or their bars.
assert!((fills[2].y - fills[1].bottom()).abs() < 0.01, "{fills:?}");
assert!((bars[2].0 - bars[1].1).abs() < 0.01, "{bars:?}");
}
#[test]
fn side_borders_lie_beyond_their_distance_from_the_text() {
// #5036: a thick border at no distance covered the first letter, in the shading's colour.
let fill = wordcraft_doc::props::Rgb(0x4F, 0x81, 0xBD);
for space in [0.0, 4.0] {
let bar = Some(Border { color: Some(fill), space, ..Border::single(3.0) });
let mut d = Document::from_text("Requirements");
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.props.borders = Some(Borders { top: bar, left: bar, right: bar, ..Borders::default() });
p.props.shading = Some(fill);
let l = lay(&d);
let items = &l.pages[0].items;
let (text, end) = items
.iter()
.find_map(|i| if let Placed::Lines { x, para, .. } = i { para.lines.first().map(|l| (*x, *x + l.right)) } else { None })
.unwrap();
let shade = items.iter().find_map(|i| if let Placed::Fill { rect, .. } = i { Some(*rect) } else { None }).unwrap();
let rules: Vec<(f32, f32)> = items.iter().filter_map(|i| if let Placed::Rule { x0, x1, .. } = i { Some((*x0, *x1)) } else { None }).collect();
assert_eq!(rules.len(), 3, "{rules:?}");
let (above, left, right) = (rules[0], rules[1], rules[2]);
assert!((left.0 + 1.5 - (text - space)).abs() < 0.01, "{left:?} {text}");
assert!((right.0 - 1.5 - (end + space)).abs() < 0.01, "{right:?} {end}");
// The top line and the shading reach the outer edges, so nothing shows through the joins.
assert!((above.0 - (left.0 - 1.5)).abs() < 0.01 && (above.1 - (right.0 + 1.5)).abs() < 0.01, "{rules:?}");
assert!((shade.x - above.0).abs() < 0.01 && (shade.right() - above.1).abs() < 0.01, "{rules:?} {shade:?}");
}
}
#[test]
fn space_between_paragraphs_is_the_larger_of_after_and_before() {
crate::test_fonts();
// (space after the first, space before the second, contextual spacing on both) -> gap
let gap = |after: f32, before: f32, contextual: bool| -> f32 {
let mut d = Document::from_text("One\nTwo");
for (i, (a, b)) in [(after, 0.0), (0.0, before)].into_iter().enumerate() {
let p = d.para_mut(wordcraft_doc::StoryRef::Body, &wordcraft_doc::Path::top(i)).unwrap();
(p.props.space_after, p.props.space_before, p.props.contextual_spacing) = (Some(a), Some(b), Some(contextual));
}
let l = lay(&d);
let ys: Vec<(f32, f32)> =
l.pages[0].items.iter().filter_map(|i| if let Placed::Lines { y, para, .. } = i { Some((*y, para.height)) } else { None }).collect();
ys[1].0 - (ys[0].0 + ys[0].1)
};
// Word's output for docxide-pdf's clean_energy_regulator_guidelines: 6pt after and 6pt before
// leave 6pt, not 12pt.
assert!((gap(6.0, 6.0, false) - 6.0).abs() < 0.01);
assert!((gap(6.0, 12.0, false) - 12.0).abs() < 0.01);
assert!((gap(12.0, 6.0, false) - 12.0).abs() < 0.01);
assert!((gap(0.0, 6.0, false) - 6.0).abs() < 0.01);
// Contextual spacing drops both between paragraphs of one style.
assert!(gap(6.0, 12.0, true).abs() < 0.01);
}
#[test]
fn space_between_paragraphs_is_their_sum_when_html_auto_spacing_is_off() {
crate::test_fonts();
// Measured in Word (compatibility modes 14 and 15): with `w:doNotUseHTMLParagraphAutoSpacing`,
// 12 pt after and 12 pt before leave 24 pt; without it, 12 pt.
let gaps = |sum: bool| -> (f32, f32) {
let mut d = Document::from_text("One\nTwo");
d.settings.sum_paragraph_spacing = sum;
for i in 0..2 {
let p = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
(p.props.space_after, p.props.space_before) = (Some(12.0), Some(12.0));
}
let mut t = Table::new(1, 1, 468.0);
t.rows[0].cells[0].blocks = d.body.clone();
d.insert_block(StoryRef::Body, &Path::top(2), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let tops = |cell: bool| -> Vec<(f32, f32)> {
l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { path, y, para, .. } if (path.0.len() == 4) == cell => Some((*y, para.height)),
_ => None,
})
.collect()
};
let gap = |ys: Vec<(f32, f32)>| ys[1].0 - (ys[0].0 + ys[0].1);
(gap(tops(false)), gap(tops(true)))
};
let near = |(a, b): (f32, f32), want: f32| (a - want).abs() < 0.01 && (b - want).abs() < 0.01;
assert!(near(gaps(true), 24.0), "{:?}", gaps(true));
assert!(near(gaps(false), 12.0), "{:?}", gaps(false));
}
#[test]
fn space_between_paragraphs_in_a_cell_follows_the_body_rule() {
crate::test_fonts();
// Three paragraphs in a cell, each 6pt before and 6pt after -> the gaps between them.
let gaps = |contextual: bool| -> Vec<f32> {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(1, 1, 468.0);
t.rows[0].cells[0].blocks = (0..3)
.map(|k| {
let mut p = wordcraft_doc::Paragraph::with_text(&format!("p{k}"), Default::default());
(p.props.space_after, p.props.space_before, p.props.contextual_spacing) = (Some(6.0), Some(6.0), Some(contextual));
wordcraft_doc::para_block(p)
})
.collect();
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let mut ys: Vec<(u32, f32, f32)> = l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { path, y, para, .. } if path.0.len() == 4 => Some((path.0[3], *y, para.height)),
_ => None,
})
.collect();
ys.sort_by_key(|v| v.0);
ys.windows(2).map(|w| w[1].1 - (w[0].1 + w[0].2)).collect()
};
let near = |got: Vec<f32>, want: [f32; 2]| got.len() == 2 && got.iter().zip(want).all(|(g, w)| (g - w).abs() < 0.01);
// The larger of after and before, not their sum.
assert!(near(gaps(false), [6.0, 6.0]), "{:?}", gaps(false));
// Contextual spacing drops the space between every pair, not just the first.
assert!(near(gaps(true), [0.0, 0.0]), "{:?}", gaps(true));
}
#[test]
fn sections_land_on_the_side_their_break_and_numbering_ask_for() {
crate::test_fonts();
use wordcraft_doc::section::{SectionProps, SectionStart};
// "One" ends the first section on page 1; the second section starts as `start`.
let pages = |start: SectionStart, restart: Option<u32>, even_odd: bool| -> Vec<(usize, u32)> {
let mut d = Document::from_text("One\nTwo");
d.para_mut(wordcraft_doc::StoryRef::Body, &wordcraft_doc::Path::top(0)).unwrap().section = Some(Box::new(SectionProps::default()));
d.last_section.start = start;
d.last_section.page_num_start = restart;
d.settings.even_odd_headers = even_odd;
lay(&d).pages.iter().map(|p| (p.section, p.number)).collect()
};
// An odd-page break after page 1 leaves page 2 blank; the blank page ends the first section.
assert_eq!(pages(SectionStart::OddPage, None, false), [(0, 1), (0, 2), (1, 3)]);
assert_eq!(pages(SectionStart::EvenPage, None, false), [(0, 1), (1, 2)]);
// Restarting at 1 needs no blank page unless both sides print; at 2 it takes the next number.
assert_eq!(pages(SectionStart::OddPage, Some(1), false), [(0, 1), (1, 1)]);
assert_eq!(pages(SectionStart::OddPage, Some(2), false), [(0, 1), (1, 3)]);
assert_eq!(pages(SectionStart::OddPage, Some(1), true), [(0, 1), (0, 2), (1, 1)]);
// With different odd and even headers, a next-page break restarting at 1 starts on an odd
// sheet (Word's output for docxide-pdf's bush_fires_act_comparison).
assert_eq!(pages(SectionStart::NextPage, Some(1), true), [(0, 1), (0, 2), (1, 1)]);
assert_eq!(pages(SectionStart::NextPage, Some(2), true), [(0, 1), (1, 2)]);
assert_eq!(pages(SectionStart::NextPage, Some(1), false), [(0, 1), (1, 1)]);
assert_eq!(pages(SectionStart::NextPage, None, true), [(0, 1), (1, 2)]);
}
#[test]
fn a_section_starting_a_page_flushes_the_page_before_with_its_own_margins() {
use wordcraft_doc::section::{SectionProps, SectionStart};
// Section one ends its last page with a footnote pending; section two starts a new page
// with a wider left margin. The footnotes on the page before keep section one's margin,
// whichever way the new page starts (#5289).
let note_x = |start: SectionStart| {
let mut d = Document::from_text("Section one text.\nTwo");
let note = wordcraft_doc::Paragraph::with_text("The note text.", Default::default());
let id = d.add_part(wordcraft_doc::PartKind::Footnote, vec![wordcraft_doc::para_block(note)]);
d.insert_object(
&Pos::body(0, 5),
InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: String::new() },
&Default::default(),
)
.unwrap();
d.para_mut(wordcraft_doc::StoryRef::Body, &wordcraft_doc::Path::top(0)).unwrap().section = Some(Box::new(SectionProps::default()));
d.last_section.start = start;
d.last_section.margin_left = 144.0;
let l = lay(&d);
let x = l
.pages
.iter()
.flat_map(|p| p.items.iter())
.find_map(|it| match it {
Placed::Lines { story: StoryRef::Part(n), x, .. } if *n == id => Some(*x),
_ => None,
})
.unwrap_or_else(|| panic!("the footnote is placed ({start:?})"));
(x, l.pages.len())
};
for start in [SectionStart::NextPage, SectionStart::EvenPage, SectionStart::OddPage] {
let (x, pages) = note_x(start);
assert!((x - 72.0).abs() < 0.01, "{start:?}: the footnote sits at section one's margin, not {x}");
assert!(pages >= 2, "{start:?}: the section starts a page");
}
}
#[test]
fn paragraph_marks_sit_past_text_running_the_other_way() {
crate::test_fonts();
// A left-to-right paragraph ending in Hebrew, and a right-to-left one ending in Latin: the
// logically last letters are at the wrong edge, but the ¶ still goes past every glyph.
let mut d = Document::from_text("Hello \u{5e9}\u{5dc}\u{5d5}\u{5dd}\n\u{5e9}\u{5dc}\u{5d5}\u{5dd} abc");
let at = Pos::body(1, 0);
d.format_paragraphs(&at, &at, &|p: &mut ParaProps| p.bidi = Some(true)).unwrap();
let l = lay(&d);
// Leftmost and rightmost glyph edges (page x) of each paragraph's single line.
let extents: Vec<(f32, f32)> = l.pages[0]
.items
.iter()
.filter_map(|it| if let Placed::Lines { para, x, .. } = it { Some((para, *x)) } else { None })
.map(|(pl, x)| {
let ln = &pl.lines[0];
let edges = (ln.c0..ln.c1).filter_map(|k| Some((ln.cl_left(k)?, ln.cl_right(k)?)));
edges.fold((f32::MAX, f32::MIN), |(a, b), (l, r)| (a.min(x + l), b.max(x + r)))
})
.collect();
let marks: Vec<(f32, f32)> = display::page_display(&d, &l.pages[0], &display::DisplayOptions { marks: true, ..Default::default() })
.into_iter()
.filter_map(|i| if let display::Draw::Mark { ch: '¶', x, size, .. } = i { Some((x, size)) } else { None })
.collect();
assert_eq!((extents.len(), marks.len()), (2, 2));
let ((ltr_x, _), (rtl_x, size)) = (marks[0], marks[1]);
assert!(ltr_x >= extents[0].1, "LTR ¶ at {ltr_x} should be right of all glyphs {:?}", extents[0]);
assert!(rtl_x + size * 0.5 <= extents[1].0, "RTL ¶ at {rtl_x} should be left of all glyphs {:?}", extents[1]);
}
fn border_lines(d: &Document) -> Vec<(f32, f32, f32, f32)> {
border_lines_in(d, &lay(d))
}
fn border_lines_in(d: &Document, l: &DocLayout) -> Vec<(f32, f32, f32, f32)> {
display::page_display(d, &l.pages[0], &display::DisplayOptions::default())
.into_iter()
.filter_map(|i| if let display::Draw::Line { x0, y0, x1, y1, .. } = i { Some((x0, y0, x1, y1)) } else { None })
.collect()
}
#[test]
fn character_border_draws_one_box_around_run() {
crate::test_fonts();
use wordcraft_doc::props::Border;
let mut d = Document::from_text("Hello world");
assert!(border_lines(&d).is_empty());
d.format_range(&Pos::body(0, 0), &Pos::body(0, 5), &|c| c.border = Some(Border::single(0.5))).unwrap();
// One layout for both the draw list and the expected geometry: the background font scan can change metrics between layouts.
let l = lay(&d);
let lines = border_lines_in(&d, &l);
assert_eq!(lines.len(), 4, "{lines:?}");
let Some(Placed::Lines { para, x, y, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let (gx0, gx1) = (x + para.x_of(0, 0).unwrap(), x + para.x_of(0, 5).unwrap());
let (top, bottom) = (*y, y + para.lines[0].height);
let horiz: Vec<_> = lines.iter().filter(|l| l.1 == l.3).collect();
let vert: Vec<_> = lines.iter().filter(|l| l.0 == l.2).collect();
assert_eq!(horiz.len(), 2);
assert_eq!(vert.len(), 2);
assert!(horiz.iter().any(|h| (h.1 - top).abs() < 0.01) && horiz.iter().any(|h| (h.1 - bottom).abs() < 0.01), "{lines:?}");
// Top and bottom run on over half the 0.5 pt side lines, closing the corners.
assert!(horiz.iter().all(|h| (h.0 - (gx0 - 0.25)).abs() < 0.01 && (h.2 - (gx1 + 0.25)).abs() < 0.01), "{lines:?} {gx0} {gx1}");
}
#[test]
fn words_underline_draws_one_line_per_word() {
let mut d = Document::from_text("ab cd");
d.format_range(&Pos::body(0, 0), &Pos::body(0, 5), &|c| c.underline = Some(wordcraft_doc::props::Underline::Words)).unwrap();
assert_eq!(border_lines(&d).len(), 2, "{:?}", border_lines(&d));
// A space condensed to no width still parts the words.
d.format_range(&Pos::body(0, 0), &Pos::body(0, 5), &|c| c.spacing = Some(-4.0)).unwrap();
assert_eq!(border_lines(&d).len(), 2, "{:?}", border_lines(&d));
// A bookmark between two letters doesn't part them.
let mut d = Document::from_text("ab cd");
d.insert_object(&Pos::body(0, 1), InlineObject::BookmarkStart { name: "x".into() }, &Default::default()).unwrap();
let end = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().text.len();
d.format_range(&Pos::body(0, 0), &Pos::body(0, end), &|c| c.underline = Some(wordcraft_doc::props::Underline::Words)).unwrap();
assert_eq!(border_lines(&d).len(), 2, "{:?}", border_lines(&d));
}
#[test]
fn paragraph_border_lines_meet_in_square_corners() {
use wordcraft_doc::props::{Border, Borders};
let mut d = Document::from_text("Boxed");
let (thick, thin) = (Some(Border::single(3.0)), Some(Border::single(1.0)));
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.borders = Some(Borders { top: thick, left: thin, bottom: thick, ..Borders::default() });
let lines = border_lines(&d);
let [left] = lines.iter().filter(|l| l.0 == l.2).collect::<Vec<_>>()[..] else { panic!("{lines:?}") };
let horiz: Vec<_> = lines.iter().filter(|l| l.1 == l.3).collect();
assert_eq!(horiz.len(), 2, "{lines:?}");
// Word: the 3 pt lines run on over half the 1 pt left line, and end half their own width past
// the right edge, where there is no line (docxide-pdf's samtale and english_town_council_report).
let right = d.last_section.page_w - d.last_section.margin_right;
for h in &horiz {
assert!((h.0 - (left.0 - 0.5)).abs() < 0.01 && (h.2 - (right + 1.5)).abs() < 0.01, "{lines:?} {right}");
}
// The left line runs on to the top and bottom lines' outer edges; with no top line it ends square.
assert!((left.1 - (horiz[0].1.min(horiz[1].1) - 1.5)).abs() < 0.01 && (left.3 - (horiz[0].1.max(horiz[1].1) + 1.5)).abs() < 0.01, "{lines:?}");
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.borders = Some(Borders { left: thin, bottom: thick, ..Borders::default() });
let lines = border_lines(&d);
let [left] = lines.iter().filter(|l| l.0 == l.2).collect::<Vec<_>>()[..] else { panic!("{lines:?}") };
let [bottom] = lines.iter().filter(|l| l.1 == l.3).collect::<Vec<_>>()[..] else { panic!("{lines:?}") };
assert!((left.3 - (bottom.1 + 1.5)).abs() < 0.01, "{lines:?}");
let first = lay(&d).pages[0].items.iter().find_map(|i| if let Placed::Lines { y, .. } = i { Some(*y) } else { None }).unwrap();
assert!((left.1 - (first - 0.5)).abs() < 0.01, "{lines:?} {first}");
}
#[test]
fn equal_adjacent_borders_share_a_box() {
crate::test_fonts();
use wordcraft_doc::props::Border;
let mut d = Document::from_text("ab");
d.format_range(&Pos::body(0, 0), &Pos::body(0, 2), &|c| c.border = Some(Border::single(0.5))).unwrap();
d.format_range(&Pos::body(0, 1), &Pos::body(0, 2), &|c| c.bold = Some(true)).unwrap();
assert_eq!(border_lines(&d).len(), 4);
d.format_range(&Pos::body(0, 1), &Pos::body(0, 2), &|c| c.border = Some(Border::single(1.0))).unwrap();
assert_eq!(border_lines(&d).len(), 8);
}
#[test]
fn wrapped_border_boxes_each_line() {
crate::test_fonts();
use wordcraft_doc::props::Border;
let text = "boxed ".repeat(20);
let mut d = Document::from_text(text.trim_end());
let n = d.para_at(&Pos::body(0, 0)).unwrap().len();
d.format_range(&Pos::body(0, 0), &Pos::body(0, n), &|c| c.border = Some(Border::single(0.5))).unwrap();
assert_eq!(lines_of(&lay(&d)), 2);
assert_eq!(border_lines(&d).len(), 8);
}
#[test]
fn runs_differing_only_in_link_or_decoration_keep_their_own_style() {
crate::test_fonts();
let mut d = Document::from_text("Alpha Beta Gamma Delta");
let set = |d: &mut Document, a: usize, b: usize, f: &dyn Fn(&mut wordcraft_doc::props::CharProps)| {
d.format_range(&Pos::body(0, a), &Pos::body(0, b), f).unwrap();
};
set(&mut d, 0, 5, &|c| c.link = Some("https://a.example/".into()));
set(&mut d, 6, 10, &|c| c.link = Some("https://b.example/".into()));
set(&mut d, 11, 16, &|c| c.strike = Some(true));
set(&mut d, 17, 22, &|c| c.double_strike = Some(true));
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let link_of = |word: &str| {
items.iter().find_map(|i| if let display::Draw::Glyphs { text, link, .. } = i { text.contains(word).then(|| link.clone()) } else { None })
};
assert_eq!(link_of("Alpha"), Some(Some("https://a.example/".into())));
assert_eq!(link_of("Beta"), Some(Some("https://b.example/".into())));
let strokes: Vec<_> = items.iter().filter_map(|i| if let display::Draw::Line { stroke, .. } = i { Some(*stroke) } else { None }).collect();
assert!(strokes.contains(&display::Stroke::Solid) && strokes.contains(&display::Stroke::Double), "{strokes:?}");
// Underline colour is per run too.
let mut d = Document::from_text("Red Blue");
let red = wordcraft_doc::props::Rgb(0xFF, 0, 0);
let blue = wordcraft_doc::props::Rgb(0, 0, 0xFF);
for (a, b, c) in [(0, 3, red), (4, 8, blue)] {
d.format_range(&Pos::body(0, a), &Pos::body(0, b), &|p| {
p.underline = Some(wordcraft_doc::props::Underline::Single);
p.underline_color = Some(c);
})
.unwrap();
}
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let colors: Vec<_> = items.iter().filter_map(|i| if let display::Draw::Line { color, .. } = i { Some(*color) } else { None }).collect();
assert!(colors.contains(&red) && colors.contains(&blue), "{colors:?}");
}
#[test]
fn web_view_is_one_page() {
crate::test_fonts();
let d = Document::from_text(&"text ".repeat(3000));
let mut c = LayoutCache::new();
let l = layout(&d, &mut c, &LayoutOptions { view: ViewMode::Web, web_width: 800.0, ..Default::default() });
assert_eq!(l.pages.len(), 1);
assert!(l.pages[0].h > 800.0);
}
#[test]
fn hostile_props_do_not_panic() {
crate::test_fonts();
let mut d = Document::from_text("x\ny");
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(1, 0), &|p| {
*p = ParaProps { indent_left: Some(1e9), indent_right: Some(1e9), indent_first: Some(-1e9), ..Default::default() }
})
.unwrap();
d.last_section.page_w = 1.0;
d.last_section.margin_left = 500.0;
let l = lay(&d);
assert!(!l.pages.is_empty());
}
#[test]
fn layout_is_fast() {
crate::test_fonts();
let d =
Document::from_text(&"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore.\n".repeat(3000));
let mut c = LayoutCache::new();
let t0 = now_ms();
let l = layout(&d, &mut c, &LayoutOptions::default());
let cold = now_ms() - t0;
let mut d2 = d.clone();
d2.insert_text(&Pos::body(1500, 0), "x", &Default::default()).unwrap();
let t1 = now_ms();
let _ = layout(&d2, &mut c, &LayoutOptions::default());
let warm = now_ms() - t1;
eprintln!("3000 paragraphs, {} pages: cold {cold:.1} ms, warm {warm:.1} ms", l.pages.len());
assert!(warm < cold);
}
#[test]
fn empty_center_tab_then_right_tab() {
crate::test_fonts();
let mut d = Document::from_text("left\t\tright");
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.style = Some("Header".into())).unwrap();
let l = lay(&d);
let end = l.caret(&Pos::body(0, 11)).unwrap().x;
assert!((end - (72.0 + 468.0)).abs() < 1.0, "{end}");
}
#[test]
fn footnotes_sit_at_page_bottom() {
crate::test_fonts();
let mut d = Document::from_text(&"Body text line.\n".repeat(30));
let mut note = wordcraft_doc::Paragraph::with_text("The note text.", Default::default()).styled("FootnoteText");
note.props.space_after = Some(0.0);
let id = d.add_part(wordcraft_doc::PartKind::Footnote, vec![wordcraft_doc::para_block(note)]);
d.insert_object(
&Pos::body(3, 4),
InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: String::new() },
&Default::default(),
)
.unwrap();
let eid = d.add_part(
wordcraft_doc::PartKind::Endnote,
vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("An endnote.", Default::default()))],
);
d.insert_object(
&Pos::body(5, 2),
InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Endnote, id: eid, custom: String::new() },
&Default::default(),
)
.unwrap();
let l = lay(&d);
let c = l.caret_on(&Pos { story: StoryRef::Part(id), path: Path::top(0), off: 0 }, 0).unwrap();
assert_eq!(c.page, 0);
assert!(c.top > 650.0 && c.top < 720.0, "{c:?}");
let body_bottom = l.pages[0]
.items
.iter()
.filter_map(|it| if let Placed::Lines { story: StoryRef::Body, y, para, l0, l1, .. } = it { item_bottom(*y, para, *l0, *l1) } else { None })
.fold(0.0f32, f32::max);
assert!(body_bottom < c.top, "{body_bottom} {}", c.top);
assert!(l.caret_on(&Pos { story: StoryRef::Part(eid), path: Path::top(0), off: 0 }, 0).is_some());
}
#[test]
fn deleted_note_anchors_take_no_number_and_print_no_note() {
crate::test_fonts();
use wordcraft_doc::para::NoteKind;
let mut d = Document::from_text("Alpha Beta Gamma");
let mut ids = Vec::new();
// Footnotes after "Alpha" and "Beta", an endnote after "Gamma" (inserted back to front).
for (off, kind, part) in [
(16, NoteKind::Endnote, wordcraft_doc::PartKind::Endnote),
(10, NoteKind::Footnote, wordcraft_doc::PartKind::Footnote),
(5, NoteKind::Footnote, wordcraft_doc::PartKind::Footnote),
] {
let id = d.add_part(part, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("A note.", Default::default()))]);
d.insert_object(&Pos::body(0, off), InlineObject::NoteRef { kind, id, custom: String::new() }, &Default::default()).unwrap();
ids.push(id);
}
let [end_id, second, first] = ids[..] else { panic!() };
// Track-delete the first footnote's anchor and the endnote's anchor.
let obj = wordcraft_doc::para::OBJ.len_utf8();
d.format_range(&Pos::body(0, 5), &Pos::body(0, 5 + obj), &|c| c.del = Some(0)).unwrap();
let end = d.para(StoryRef::Body, &Path::top(0)).unwrap().len();
d.format_range(&Pos::body(0, end - obj), &Pos::body(0, end), &|c| c.del = Some(0)).unwrap();
// The glyphs of each note mark in the body, and whether the endnote's text is placed.
let marks = |hide_deleted: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { hide_deleted, ..Default::default() });
let items: Vec<&Placed> = l.pages.iter().flat_map(|p| p.items.iter()).collect();
let mut marks = HashMap::new();
for it in &items {
if let Placed::Lines { story: StoryRef::Body, para, .. } = it {
for (ci, id) in ¶.notes {
let c = ¶.clusters[*ci];
marks.insert(*id, para.glyphs[c.g0 as usize..c.g1 as usize].iter().map(|g| g.gid).collect::<Vec<_>>());
}
}
}
let endnote = items.iter().any(|i| matches!(i, Placed::Lines { story: StoryRef::Part(p), .. } if *p == end_id));
(marks, endnote)
};
// Markup: footnotes 1 and 2, and the endnote prints.
let (full, endnote) = marks(false);
assert!(full[&first] != full[&second] && endnote, "{full:?}");
// Final text: the surviving footnote is number 1, and the deleted endnote anchor prints no note.
let (fin, endnote) = marks(true);
assert_eq!(fin.get(&second), full.get(&first), "the surviving footnote keeps number 2");
assert!(!endnote, "the endnote of a deleted anchor is printed");
}
#[test]
fn hidden_note_anchors_keep_their_number_and_their_note() {
crate::test_fonts();
// Measured in Word (hidden text not printed): a hidden footnote or endnote reference mark still
// takes its number, so the visible footnote after it is 2, and both notes are still printed.
use wordcraft_doc::para::NoteKind;
let mut d = Document::from_text("Alpha Beta Gamma");
let mut ids = Vec::new();
for (off, kind, part) in [
(16, NoteKind::Endnote, wordcraft_doc::PartKind::Endnote),
(10, NoteKind::Footnote, wordcraft_doc::PartKind::Footnote),
(5, NoteKind::Footnote, wordcraft_doc::PartKind::Footnote),
] {
let id = d.add_part(part, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("A note.", Default::default()))]);
d.insert_object(&Pos::body(0, off), InlineObject::NoteRef { kind, id, custom: String::new() }, &Default::default()).unwrap();
ids.push(id);
}
let [end_id, second, first] = ids[..] else { panic!() };
// Hide the first footnote's anchor and the endnote's anchor.
let obj = wordcraft_doc::para::OBJ.len_utf8();
d.format_range(&Pos::body(0, 5), &Pos::body(0, 5 + obj), &|c| c.hidden = Some(true)).unwrap();
let end = d.para(StoryRef::Body, &Path::top(0)).unwrap().len();
d.format_range(&Pos::body(0, end - obj), &Pos::body(0, end), &|c| c.hidden = Some(true)).unwrap();
// The glyphs of each visible note mark in the body, and which notes' text is placed.
let marks = |show_hidden: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
let items: Vec<&Placed> = l.pages.iter().flat_map(|p| p.items.iter()).collect();
let mut marks = HashMap::new();
for it in &items {
if let Placed::Lines { story: StoryRef::Body, para, .. } = it {
for (ci, id) in ¶.notes {
let c = ¶.clusters[*ci];
marks.insert(*id, para.glyphs[c.g0 as usize..c.g1 as usize].iter().map(|g| g.gid).collect::<Vec<_>>());
}
}
}
let printed = |id: u32| items.iter().any(|i| matches!(i, Placed::Lines { story: StoryRef::Part(p), .. } if *p == id));
(marks, [first, second, end_id].map(printed))
};
let (shown, printed) = marks(true);
assert!(shown[&first] != shown[&second] && printed == [true; 3], "{shown:?} {printed:?}");
// Not shown: the visible footnote is still number 2, and every note is printed.
let (fin, printed) = marks(false);
assert_eq!(fin.get(&second), shown.get(&second), "the visible footnote is renumbered");
assert_eq!(printed, [true; 3], "a note whose reference is hidden is not printed");
}
#[test]
fn text_wraps_around_square_float() {
crate::test_fonts();
let mut d = Document::from_text(&"Words flow around the picture here. ".repeat(30));
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x: 0.0,
y: 0.0,
dist: 9.0,
..Default::default()
};
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 144.0,
h: 100.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let l = lay(&d);
let Placed::Lines { para, x, .. } = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })).unwrap() else { panic!() };
let first = ¶.lines[0];
assert!(first.left >= 144.0, "first line starts beside the float: {}", first.left);
let later = para.lines.iter().find(|ln| ln.top > 120.0).unwrap();
assert!(later.left < 1.0, "lines below the float use the full width: {}", later.left);
assert!(x + first.left > 72.0 + 144.0);
assert!(l.pages[0].items.iter().any(|i| matches!(i, Placed::Shape { .. })));
}
/// The left edges of a paragraph's lines beside a 144 × 100 pt square-wrapped rectangle at the
/// column's top left (9 pt from text), and of its first line below the rectangle, in
/// compatibility `mode` with Word 2003's indent rules on or off. The paragraph is indented
/// 216 pt; `float` adjusts the object, `para` the paragraph, and `numbered` makes it a list item.
fn word_2003_indent_lefts(
mode: u32,
rules: bool,
float: &dyn Fn(&mut wordcraft_doc::para::Float),
numbered: bool,
para: &dyn Fn(&mut ParaProps),
) -> (Vec<f32>, Option<f32>) {
let mut d = Document::from_text(&"Words beside the picture here. ".repeat(20));
d.settings.compat_mode = mode;
d.settings.do_not_suppress_indentation = rules;
let num = numbered.then(|| Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered));
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.indent_left = Some(216.0);
p.indent_first = Some(0.0);
p.numbering = num.map(|num| wordcraft_doc::props::NumRef { num, level: 0 });
para(p);
})
.unwrap();
let mut f = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x: 0.0,
y: 0.0,
dist: 9.0,
..Default::default()
};
float(&mut f);
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 144.0,
h: 100.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float: f,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
// After the first word, so a drop cap takes the paragraph's first letter.
d.insert_object(&Pos::body(0, 6), shape, &Default::default()).unwrap();
let l = lay(&d);
let Placed::Lines { para, .. } = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { story: StoryRef::Body, .. })).unwrap() else {
panic!()
};
let beside = para.lines.iter().filter(|ln| ln.top < 100.0).map(|ln| ln.left).collect();
let below = para.lines.iter().find(|ln| ln.top > 120.0).map(|ln| ln.left);
(beside, below)
}
/// Word 2003's indent rules (`w:doNotSuppressIndentation`, a `.doc`'s `Copts.fWW11IndentRules`): an
/// unnumbered paragraph indented past a floating object on its left starts its lines right after
/// the object, its indent ignored (ECMA-376 Part 4 §14.8.3.12). In a Word 2003-mode `.doc` saved
/// by Word, empty paragraphs indented 216 pt sit right after a text box ending 165 pt into the
/// column, in the 71 pt gap before a second box where the indent would leave under 20 pt. Below
/// the object, and in Word 2013's layout, the indent applies.
#[test]
fn word_2003_indent_rules_start_lines_right_after_a_float_before_the_indent() {
let lefts = |mode: u32, rules: bool| word_2003_indent_lefts(mode, rules, &|_| {}, false, &|_| {});
for mode in [11, 12, 14] {
let (beside, below) = lefts(mode, true);
assert!(
!beside.is_empty() && beside.iter().all(|x| (x - 153.0).abs() < 0.01),
"mode {mode}: lines start after the object and its 9 pt distance: {beside:?}"
);
assert_eq!(below, Some(216.0), "mode {mode}: below the object the indent applies");
}
assert_eq!(lefts(11, false).0[0], 216.0, "without the option the indent applies beside the object");
assert_eq!(lefts(15, true).0[0], 216.0, "Word 2013's layout keeps the indent");
}
/// Under Word 2003's indent rules a line starts after a Tight or Through-wrapped object's outline
/// where the line meets it, not after the outline's widest point: here a right triangle, its
/// point at the top left, 144 pt wide (and 9 pt from text) only at its foot.
#[test]
fn word_2003_indent_rules_follow_a_tight_objects_outline() {
use wordcraft_doc::para::Wrap;
use wordcraft_doc::wrap::WrapPolygon;
let poly = WrapPolygon::new(true, [(0, 0), (0, 21_600), (21_600, 21_600)]).map(Arc::new);
for wrap in [Wrap::Tight, Wrap::Through] {
let (beside, _) = word_2003_indent_lefts(11, true, &|f| (f.wrap, f.wrap_polygon) = (wrap, poly.clone()), false, &|_| {});
assert!(beside.len() > 2 && beside[0] < 60.0, "{wrap:?}: the first line starts near the point: {beside:?}");
assert!(beside.windows(2).all(|w| w[0] < w[1]) && beside.iter().all(|&x| x <= 153.0 + 0.01), "{wrap:?}: each line further out: {beside:?}");
}
}
/// Word 2003's indent rules leave the indent alone for a numbered paragraph (its number sits at
/// the indent) and for one with a drop cap (the letter does), and never start a line left of the
/// paragraph's own edge after an object out in the margin.
#[test]
fn word_2003_indent_rules_keep_the_indent_where_they_do_not_apply() {
let (numbered, _) = word_2003_indent_lefts(11, true, &|_| {}, true, &|_| {});
assert!(numbered.iter().all(|&x| x >= 216.0 - 0.01), "a numbered paragraph keeps its indent: {numbered:?}");
let (dropped, _) = word_2003_indent_lefts(11, true, &|_| {}, false, &|p| p.drop_cap = Some(3));
assert!(dropped.iter().all(|&x| x >= 216.0 - 0.01), "lines beside a drop cap stay right of it: {dropped:?}");
// An object in the left margin, its right side and distance from text 44 pt short of the column.
let (margin, _) = word_2003_indent_lefts(11, true, &|f| f.x = -197.0, false, &|_| {});
assert!(margin.iter().all(|&x| x >= -0.01), "no line starts in the margin: {margin:?}");
assert!((margin[0] - 0.0).abs() < 0.01, "the line starts at the paragraph's edge: {margin:?}");
}
#[test]
fn a_lines_arrowheads_sit_at_its_ends() {
// A line runs from its frame's top left to its bottom right (DrawingML's `line`, as it is
// drawn); its arrowheads point out of those two ends, not the other diagonal's.
use wordcraft_doc::connector::ShapeExtra;
use wordcraft_doc::graphic::PathSeg;
use wordcraft_doc::para::{Float, ShapeKind};
use wordcraft_doc::props::Rgb;
let shape = InlineObject::Shape {
kind: ShapeKind::Line,
w: 60.0,
h: 40.0,
fill: None,
stroke: Some(Rgb::BLACK),
stroke_width: 1.0,
float: Float::default(),
story: None,
freeform: None,
effects: Default::default(),
extra: ShapeExtra { arrow_start: true, arrow_end: true, ..Default::default() },
};
let mut doc = Document::from_text("Scan");
doc.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let draws = flat(display::page_display(&doc, &lay(&doc).pages[0], &Default::default()));
let rect = draws
.iter()
.find_map(|d| match d {
display::Draw::Shape { rect, kind: ShapeKind::Line, .. } => Some(*rect),
_ => None,
})
.expect("the line");
let tips: Vec<(f32, f32)> = draws
.iter()
.filter_map(|d| match d {
display::Draw::Path { fill: Some(display::Paint::Solid(Rgb::BLACK, _)), segs, .. } if segs.len() == 4 => match segs.first() {
Some(PathSeg::Move(x, y)) => Some((*x, *y)),
_ => None,
},
_ => None,
})
.collect();
assert_eq!(tips, [(rect.x, rect.y), (rect.right(), rect.bottom())]);
}
#[test]
fn freeform_arrow_end_draws_at_the_last_point() {
crate::test_fonts();
use std::sync::Arc;
use wordcraft_doc::connector::ShapeExtra;
use wordcraft_doc::freeform::{FreePath, Freeform};
use wordcraft_doc::graphic::PathSeg;
use wordcraft_doc::para::{Float, ShapeKind};
use wordcraft_doc::props::Rgb;
let shape = InlineObject::Shape {
kind: ShapeKind::Freeform,
w: 60.0,
h: 40.0,
fill: None,
stroke: Some(Rgb::BLACK),
stroke_width: 1.0,
float: Float::default(),
story: None,
freeform: Some(Arc::new(Freeform {
w: 60.0,
h: 40.0,
paths: vec![FreePath { pts: vec![[0.0, 40.0], [60.0, 0.0]], closed: false }],
..Default::default()
})),
effects: Default::default(),
extra: ShapeExtra { arrow_end: true, ..Default::default() },
};
let mut doc = Document::from_text("Scan");
doc.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let draws = flat(display::page_display(&doc, &lay(&doc).pages[0], &Default::default()));
let endpoint = draws.iter().find_map(|draw| match draw {
display::Draw::Ink { pts, color: Rgb::BLACK, .. } => pts.last().copied(),
_ => None,
});
let arrow_tip = draws.iter().find_map(|draw| match draw {
display::Draw::Path { fill: Some(display::Paint::Solid(Rgb::BLACK, _)), segs, .. } if segs.len() == 4 => match segs.first() {
Some(PathSeg::Move(x, y)) => Some((*x, *y)),
_ => None,
},
_ => None,
});
assert_eq!(arrow_tip, endpoint, "the arrowhead tip meets the custom path's final point");
}
#[test]
fn an_arrowhead_is_as_long_and_wide_as_its_sizes_make_it() {
// Word draws an arrowhead 2, 3 or 5 times the line's width long and wide (small, medium,
// large), and a line thinner than 2 points as if it were 2 points (measured in Word's PDFs).
use wordcraft_doc::connector::{ArrowKind, ArrowSize, ArrowStyle, ShapeExtra};
use wordcraft_doc::graphic::PathSeg;
use wordcraft_doc::para::{Float, ShapeKind};
use wordcraft_doc::props::Rgb;
let style = |width, length| ArrowStyle { kind: ArrowKind::Triangle, width, length };
let cases = [
(0.75, style(ArrowSize::Small, ArrowSize::Large), style(ArrowSize::Large, ArrowSize::Small), (10.0, 4.0), (4.0, 10.0)),
(0.75, ArrowStyle::default(), ArrowStyle::default(), (6.0, 6.0), (6.0, 6.0)),
(3.0, style(ArrowSize::Medium, ArrowSize::Large), style(ArrowSize::Small, ArrowSize::Medium), (15.0, 9.0), (9.0, 6.0)),
(6.0, style(ArrowSize::Large, ArrowSize::Large), style(ArrowSize::Small, ArrowSize::Small), (30.0, 30.0), (12.0, 12.0)),
];
for (line_width, start_style, end_style, start_dims, end_dims) in cases {
let shape = InlineObject::Shape {
kind: ShapeKind::Line,
w: 100.0,
h: 0.0,
fill: None,
stroke: Some(Rgb::BLACK),
stroke_width: line_width,
float: Float::default(),
story: None,
freeform: None,
effects: Default::default(),
extra: ShapeExtra { arrow_start: true, arrow_end: true, start_style, end_style, ..Default::default() },
};
let mut doc = Document::from_text("Scan");
doc.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let draws = flat(display::page_display(&doc, &lay(&doc).pages[0], &Default::default()));
// Each arrowhead: its length (tip to the middle of its base) and width (across its base),
// the start's first.
let heads: Vec<(f32, f32)> = draws
.iter()
.filter_map(|draw| match draw {
display::Draw::Path { fill: Some(display::Paint::Solid(Rgb::BLACK, _)), segs, .. } => match segs.as_slice() {
[PathSeg::Move(tx, ty), PathSeg::Line(ax, ay), PathSeg::Line(bx, by), PathSeg::Close] => {
let (mx, my) = ((ax + bx) / 2.0, (ay + by) / 2.0);
Some(((tx - mx).hypot(ty - my), (ax - bx).hypot(ay - by)))
}
_ => None,
},
_ => None,
})
.collect();
assert_eq!(heads.len(), 2, "{line_width}: {heads:?}");
for ((got, want), end) in heads.iter().zip([start_dims, end_dims]).zip(["start", "end"]) {
assert!((got.0 - want.0).abs() < 0.01 && (got.1 - want.1).abs() < 0.01, "{line_width} pt line, {end}: got {got:?}, want {want:?}");
}
}
}
#[test]
fn hidden_drawings_are_neither_drawn_nor_take_room() {
crate::test_fonts();
// A hidden floating shape (VML `visibility:hidden`, `wp:docPr/@hidden`): no wrap area, nothing
// drawn, as in Word for Windows. A hidden inline one takes no room in its line.
let mut d = Document::from_text(&"Words flow around the picture here. ".repeat(30));
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
hidden: true,
..Default::default()
};
let inline = wordcraft_doc::para::Float { hidden: true, ..Default::default() };
d.insert_object(&Pos::body(0, 0), picture(200.0, 200.0, inline), &Default::default()).unwrap();
d.insert_object(&Pos::body(0, 0), picture(144.0, 100.0, float), &Default::default()).unwrap();
let l = lay(&d);
let Placed::Lines { para, .. } = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })).unwrap() else { panic!() };
let first = ¶.lines[0];
assert!(first.left < 1.0, "the first line uses the full width: {}", first.left);
assert!(first.baseline - first.top < 20.0, "the hidden inline shape doesn't raise the line: {first:?}");
assert!(!l.pages[0].items.iter().any(|i| matches!(i, Placed::Shape { .. } | Placed::Object { .. })));
let draws = flat(display::page_display(&d, &l.pages[0], &Default::default()));
assert!(!draws.iter().any(|x| matches!(x, display::Draw::Shape { .. })), "nothing drawn");
// Showing hidden text doesn't show hidden drawings.
let shown = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden: true, ..Default::default() });
let Placed::Lines { para, .. } = shown.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })).unwrap() else { panic!() };
assert!(para.lines[0].left < 1.0 && !shown.pages[0].items.iter().any(|i| matches!(i, Placed::Shape { .. } | Placed::Object { .. })));
// A group draws its members but a hidden one.
let mut d = Document::from_text("");
let member = |hidden: bool, x: f32| wordcraft_doc::para::GroupChild {
x,
y: 0.0,
obj: picture(50.0, 50.0, wordcraft_doc::para::Float { hidden, ..Default::default() }),
};
let group = InlineObject::Group {
w: 100.0,
h: 50.0,
float: Default::default(),
ch_w: 100.0,
ch_h: 50.0,
children: vec![member(true, 0.0), member(false, 50.0)],
canvas: None,
};
d.insert_object(&Pos::body(0, 0), group, &Default::default()).unwrap();
let l = lay(&d);
let draws = flat(display::page_display(&d, &l.pages[0], &Default::default()));
assert_eq!(draws.iter().filter(|x| matches!(x, display::Draw::Shape { .. })).count(), 1, "{draws:?}");
}
/// #6027: a text box inside a group (Word's cards of a coloured bar and a text box) is text to
/// a click, as a text box on its own is: the click edits its text instead of grabbing the
/// group. The group's other members still grab the group.
#[test]
fn a_grouped_text_box_is_text_to_a_click() {
crate::test_fonts();
let mut d = Document::from_text("body text");
let id = d.add_part(
wordcraft_doc::PartKind::TextBox,
vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("inside", Default::default()))],
);
let shape = |kind, w, h, story| InlineObject::Shape {
kind,
w,
h,
fill: None,
stroke: None,
stroke_width: 1.0,
float: Default::default(),
story,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::InFrontOfText,
h_rel: wordcraft_doc::para::Anchor::Page,
v_rel: wordcraft_doc::para::Anchor::Page,
x: 100.0,
y: 300.0,
..Default::default()
};
let group = InlineObject::Group {
w: 200.0,
h: 100.0,
float,
ch_w: 200.0,
ch_h: 100.0,
children: vec![
wordcraft_doc::para::GroupChild { x: 0.0, y: 0.0, obj: shape(wordcraft_doc::para::ShapeKind::Rectangle, 200.0, 30.0, None) },
wordcraft_doc::para::GroupChild { x: 0.0, y: 40.0, obj: shape(wordcraft_doc::para::ShapeKind::TextBox, 200.0, 60.0, Some(id)) },
],
canvas: None,
};
d.insert_object(&Pos::body(0, 0), group, &Default::default()).unwrap();
let l = lay(&d);
// Inside the text box: its story, and no object to grab.
assert_eq!(l.story_at(0, 200.0, 370.0), Some(StoryRef::Part(id)));
assert_eq!(l.object_at(0, 200.0, 370.0, 4.0), None);
assert_eq!(l.text_box_story(id, 0), Some(StoryRef::Body), "the box's text sits in the body");
// On the bar, and on the text box's border: the group.
for (x, y) in [(200.0, 315.0), (200.0, 340.5)] {
let hit = l.object_at(0, x, y, 4.0).unwrap_or_else(|| panic!("the group at {x}, {y}"));
assert_eq!((hit.path.clone(), hit.text_box), (Path::top(0), None));
}
assert_ne!(l.story_at(0, 200.0, 315.0), Some(StoryRef::Part(id)));
// The group keeps its text box's area relative to itself, so the area moves with it.
let Some(Placed::Object { rect, group_boxes, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Object { .. })) else { panic!() };
assert_eq!((rect.x, rect.y), (100.0, 300.0));
assert_eq!(group_boxes.as_slice(), [(wordcraft_geom::Rect::new(0.0, 40.0, 200.0, 60.0), id)]);
}
/// #6027: a group's text box areas turn with the group (a group in a cell or text box whose
/// text runs down the page) and are found in headers and footers too.
#[test]
fn grouped_text_box_areas_turn_with_the_group_and_work_in_headers() {
let id = 7;
let group = |rect| Placed::Object {
rect,
spin: Default::default(),
story: StoryRef::Part(1),
path: Path::top(0),
off: 0,
text_box: None,
wrap: Default::default(),
origin: Default::default(),
group_boxes: vec![(wordcraft_geom::Rect::new(0.0, 40.0, 200.0, 60.0), id)],
};
let mut g = group(wordcraft_geom::Rect::new(0.0, 0.0, 200.0, 100.0));
g.turn(TextDirection::Down, 300.0, 50.0);
let Placed::Object { rect, group_boxes, .. } = &g else { panic!() };
let want = crate::placed::turn_rect(TextDirection::Down, 300.0, 50.0, wordcraft_geom::Rect::new(0.0, 40.0, 200.0, 60.0));
let (r, _) = group_boxes[0];
assert_eq!(wordcraft_geom::Rect::new(rect.x + r.x, rect.y + r.y, r.w, r.h), want);
// A header's group: its box is where a click in the header edits text.
let page = Page { header: vec![group(wordcraft_geom::Rect::new(100.0, 30.0, 200.0, 100.0))], ..Default::default() };
let l = DocLayout { pages: vec![page], ..Default::default() };
assert_eq!(l.header_footer_text_box_at(0, 150.0, 100.0), Some(id));
assert_eq!(l.header_footer_text_box_at(0, 150.0, 40.0), None, "the group's bar is not text");
}
/// #6027: where two text boxes of one group overlap, a click enters the one painted on top (the
/// last member), in the body and in a header alike.
#[test]
fn click_in_overlapping_grouped_text_boxes_enters_the_top_one() {
let (low, top) = (3, 4);
let group = |rect| Placed::Object {
rect,
spin: Default::default(),
story: StoryRef::Part(1),
path: Path::top(0),
off: 0,
text_box: None,
wrap: Default::default(),
origin: Default::default(),
group_boxes: vec![(wordcraft_geom::Rect::new(0.0, 0.0, 100.0, 100.0), low), (wordcraft_geom::Rect::new(50.0, 50.0, 100.0, 100.0), top)],
};
let page = Page {
items: vec![group(wordcraft_geom::Rect::new(100.0, 100.0, 150.0, 150.0))],
header: vec![group(wordcraft_geom::Rect::new(100.0, 100.0, 150.0, 150.0))],
..Default::default()
};
let l = DocLayout { pages: vec![page], ..Default::default() };
// Overlap (page 175, 175 is inside both boxes): the top box takes the click, and typing.
assert_eq!(l.story_at(0, 175.0, 175.0), Some(StoryRef::Part(top)));
assert_eq!(l.header_footer_text_box_at(0, 175.0, 175.0), Some(top));
// Outside the overlap each box still answers for itself.
assert_eq!(l.story_at(0, 110.0, 110.0), Some(StoryRef::Part(low)));
assert_eq!(l.story_at(0, 240.0, 240.0), Some(StoryRef::Part(top)));
}
#[test]
fn deleted_float_leaves_no_wrap_area_without_markup() {
crate::test_fonts();
// A square-wrapped shape anchored at the start of the paragraph, its anchor track-deleted.
let text = "Words flow around the picture here. ".repeat(30);
let mut d = Document::from_text(&text);
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x: 0.0,
y: 0.0,
dist: 9.0,
dist_top: 9.0,
dist_bottom: 9.0,
..Default::default()
};
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 144.0,
h: 100.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let obj = wordcraft_doc::para::OBJ.len_utf8();
d.format_range(&Pos::body(0, 0), &Pos::body(0, obj), &|c| c.del = Some(0)).unwrap();
// Where the first line starts, and whether the shape is placed.
let first = |hide_deleted: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { hide_deleted, ..Default::default() });
let p = &l.pages[0];
let Some(Placed::Lines { para, .. }) = p.items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
(para.lines[0].left, p.items.iter().any(|i| matches!(i, Placed::Shape { .. })))
};
// With markup the deleted shape is shown and the text flows beside it.
let (left, shown) = first(false);
assert!(left >= 144.0 && shown, "{left} {shown}");
// Final text: no shape, and no gap where it was.
assert_eq!(first(true), (0.0, false));
}
#[test]
fn hidden_float_leaves_no_wrap_area_when_hidden_text_is_not_shown() {
crate::test_fonts();
// A square-wrapped shape whose anchor is hidden text, through a character style (so only the
// resolved formatting says so). Measured in Word: not printed, and the text runs full width.
let text = "Words flow around the picture here. ".repeat(30);
let mut d = Document::from_text(&text);
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "Secret".into(),
name: "Secret".into(),
kind: wordcraft_doc::StyleKind::Character,
chr: wordcraft_doc::CharProps { hidden: Some(true), ..Default::default() },
..Default::default()
});
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x: 0.0,
y: 0.0,
dist: 9.0,
dist_top: 9.0,
dist_bottom: 9.0,
..Default::default()
};
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 144.0,
h: 100.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let obj = wordcraft_doc::para::OBJ.len_utf8();
d.format_range(&Pos::body(0, 0), &Pos::body(0, obj), &|c| c.style = Some("Secret".into())).unwrap();
// Where the first line starts, and whether the shape is placed.
let first = |show_hidden: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
let p = &l.pages[0];
let Some(Placed::Lines { para, .. }) = p.items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
(para.lines[0].left, p.items.iter().any(|i| matches!(i, Placed::Shape { .. })))
};
// Hidden text shown: the shape is placed and the text flows beside it.
let (left, shown) = first(true);
assert!(left >= 144.0 && shown, "{left} {shown}");
// Not shown: no shape, and no gap where it was.
assert_eq!(first(false), (0.0, false));
}
/// A page-number start or a line-number start near `u32::MAX` (accepted from files and commands)
/// overflowed when the next page or line was counted: a panic with overflow checks on.
#[test]
fn extreme_page_and_line_number_starts_do_not_overflow() {
crate::test_fonts();
let mut d = Document::from_text("one\ntwo\nthree");
for b in d.body.iter_mut() {
if let wordcraft_doc::Block::Para(p) = std::sync::Arc::make_mut(b) {
p.props.page_break_before = Some(true);
}
}
d.last_section.page_num_start = Some(u32::MAX);
d.last_section.line_numbers = Some(wordcraft_doc::section::LineNumbering { start: u32::MAX, ..Default::default() });
let l = lay(&d);
assert!(l.pages.len() >= 3, "{} pages", l.pages.len());
}
/// Line numbers take the document's character formatting through the "Line Number" style, as in
/// Word (Aptos 12 pt black in a document whose defaults are Aptos 12 pt), not a fixed small grey.
#[test]
fn line_numbers_follow_the_line_number_style() {
let number_runs = |d: &Document| {
let l = lay(d);
l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story, para, .. } if *story == DECOR_STORY => para.styles.first().map(|s| (s.size, s.rc.color)),
_ => None,
})
.collect::<Vec<_>>()
};
let mut d = Document::from_text("one\ntwo\nthree");
d.last_section.line_numbers = Some(Default::default());
Arc::make_mut(&mut d.styles).default_chr.size = Some(12.0);
let plain = number_runs(&d);
assert_eq!(plain.len(), 3);
assert!(plain.iter().all(|(size, color)| *size == 12.0 && *color == wordcraft_doc::TextColor::Auto), "{plain:?}");
let red = wordcraft_doc::TextColor::Rgb(wordcraft_doc::Rgb(0xC0, 0, 0));
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "LineNumber".into(),
name: "line number".into(),
kind: wordcraft_doc::StyleKind::Character,
chr: CharProps { size: Some(8.0), color: Some(red), ..Default::default() },
..Default::default()
});
let styled = number_runs(&d);
assert!(styled.iter().all(|(size, color)| *size == 8.0 && *color == red), "{styled:?}");
}
/// #6018: German Word saves the "line number" style as `Zeilennummer`; the numbers still take
/// its formatting, found by the built-in name.
#[test]
fn line_numbers_follow_a_localised_line_number_style() {
let mut d = Document::from_text("one\ntwo\nthree");
d.last_section.line_numbers = Some(Default::default());
let red = wordcraft_doc::TextColor::Rgb(wordcraft_doc::Rgb(0xC0, 0, 0));
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "Zeilennummer".into(),
name: "Line Number".into(),
kind: wordcraft_doc::StyleKind::Character,
chr: CharProps { size: Some(8.0), color: Some(red), ..Default::default() },
..Default::default()
});
let l = lay(&d);
let runs: Vec<_> = l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story, para, .. } if *story == DECOR_STORY => para.styles.first().map(|s| (s.size, s.rc.color)),
_ => None,
})
.collect();
assert_eq!(runs.len(), 3);
assert!(runs.iter().all(|(size, color)| *size == 8.0 && *color == red), "{runs:?}");
}
/// #6018: in two columns each column has its numbers at its own left edge, as in Word; the
/// second column's used to be drawn in the page margin over the first column's.
#[test]
fn line_numbers_stand_beside_each_column() {
crate::test_fonts();
let text = (1..=120).map(|i| format!("line {i}")).collect::<Vec<_>>().join("\n");
let mut d = Document::from_text(&text);
d.last_section.line_numbers = Some(Default::default());
d.last_section.columns = wordcraft_doc::section::Columns { count: 2, space: 36.0, separator: false, widths: Vec::new() };
let s = d.last_section.clone();
let col2 = s.margin_left + s.gutter + (s.text_width() - 36.0) / 2.0 + 36.0;
let l = lay(&d);
let p = &l.pages[0];
// Right edge and top of every number.
let numbers: Vec<(f32, f32)> = p
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story, para, x, y, .. } if *story == DECOR_STORY => {
Some((x + para.lines.first().and_then(|l| l.xs.last().copied()).unwrap_or(0.0), *y))
}
_ => None,
})
.collect();
let body_xs: Vec<f32> = p
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story: StoryRef::Body, x, .. } => Some(*x),
_ => None,
})
.collect();
assert!(body_xs.iter().any(|x| (x - col2).abs() < 0.5), "the text runs into the second column: {body_xs:?}");
let in_col2 = body_xs.iter().filter(|x| (*x - col2).abs() < 0.5).count();
let right: Vec<_> = numbers.iter().filter(|(r, _)| *r > s.margin_left + 1.0).collect();
assert_eq!(right.len(), in_col2, "one number per second-column line");
// Numbers end 18 pt (auto distance) left of their column.
assert!(right.iter().all(|(r, _)| (r - (col2 - 18.0)).abs() < 0.5), "{right:?}");
let left = numbers.len() - right.len();
assert!(numbers.iter().filter(|(r, _)| *r <= s.margin_left + 1.0).all(|(r, _)| (r - (s.margin_left - 18.0)).abs() < 0.5));
assert!(left > 0);
}
#[test]
fn line_numbers_borders_text_boxes() {
crate::test_fonts();
let mut d = Document::from_text("one\ntwo\nthree");
d.last_section.line_numbers = Some(Default::default());
d.last_section.page_borders = Some(wordcraft_doc::props::Borders::box_(wordcraft_doc::props::Border::single(1.0)));
let id = d.add_part(
wordcraft_doc::PartKind::TextBox,
vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("inside the box", Default::default()))],
);
let tb = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::TextBox,
w: 144.0,
h: 72.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float: Default::default(),
story: Some(id),
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(2, 5), tb, &Default::default()).unwrap();
let l = lay(&d);
let p = &l.pages[0];
let numbers = p.items.iter().filter(|i| matches!(i, Placed::Lines { story: StoryRef::Part(u32::MAX), .. })).count();
assert_eq!(numbers, 3);
assert!(p.items.iter().filter(|i| matches!(i, Placed::Rule { .. })).count() >= 4);
assert!(l.caret(&Pos { story: StoryRef::Part(id), path: Path::top(0), off: 0 }).is_some());
}
#[test]
fn tall_rows_split_across_pages() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 2, 468.0);
let long = "Row text that keeps going and going so the cell grows taller than a page. ".repeat(120);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&long, Default::default()))];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t.clone())).unwrap();
let l = lay(&d);
assert!(l.pages.len() >= 2, "pages {}", l.pages.len());
// The cell's lines start on page 1 (row split, not moved) and continue on page 2.
let cell_lines = |p: &Page| p.items.iter().filter(|i| matches!(i, Placed::Lines { path, .. } if path.0 == vec![1, 0, 0, 0])).count();
assert!(cell_lines(&l.pages[0]) > 0);
assert!(cell_lines(&l.pages[1]) > 0);
// Nothing runs past the bottom margin.
for p in &l.pages[..l.pages.len() - 1] {
for it in &p.items {
if let Placed::Lines { y, para, l0, l1, .. } = it {
let b = item_bottom(*y, para, *l0, *l1).unwrap_or(0.0);
assert!(b <= 792.0 - 72.0 + 0.5, "line bottom {b}");
}
}
}
// Every line of the long paragraph is placed exactly once.
let total: usize = l
.pages
.iter()
.flat_map(|p| p.items.iter())
.filter_map(|i| if let Placed::Lines { path, l0, l1, .. } = i { (path.0 == vec![1, 0, 0, 0]).then_some(l1 - l0) } else { None })
.sum();
let n = l
.pages
.iter()
.flat_map(|p| p.items.iter())
.find_map(|i| if let Placed::Lines { path, para, .. } = i { (path.0 == vec![1, 0, 0, 0]).then_some(para.lines.len()) } else { None })
.unwrap_or(0);
assert_eq!(total, n);
// "Can't split" rows move whole instead.
let mut d2 = Document::from_text("before\nafter");
t.rows[0].props.cant_split = true;
d2.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l2 = lay(&d2);
assert!(l2.pages.len() >= 2);
}
/// A table row that starts `push` points lower on a page: one cell with a 4pt bottom margin
/// holding `paras` (text, space after) with no space before. Returns the layout and each cell
/// paragraph's lines per page.
fn row_at_page_bottom(push: f32, paras: &[(&str, f32)], widow: bool) -> (DocLayout, Vec<Vec<usize>>) {
let mut d = Document::from_text("Filler");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.first_mut().map(std::sync::Arc::make_mut) {
p.props.space_before = Some(push);
p.props.space_after = Some(0.0);
}
let mut t = Table::new(1, 1, 200.0);
t.props.cell_margins = Some([0.0, 5.4, 4.0, 5.4]);
t.rows[0].cells[0].blocks = paras
.iter()
.map(|(text, after)| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props.space_before = Some(0.0);
p.props.space_after = Some(*after);
p.props.widow_control = Some(widow);
wordcraft_doc::para_block(p)
})
.collect();
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let per_page = (0..paras.len())
.map(|i| {
l.pages
.iter()
.map(|pg| {
pg.items
.iter()
.filter_map(|it| match it {
Placed::Lines { path, l0, l1, .. } if path.0 == vec![1, 0, 0, i as u32] => Some(l1 - l0),
_ => None,
})
.sum()
})
.collect()
})
.collect();
(l, per_page)
}
/// The bottom of the last line of cell paragraph `i` when the row starts at the top of the
/// page's body (no push).
fn cell_line_bottoms(paras: &[(&str, f32)], i: usize) -> Vec<f32> {
let (l, _) = row_at_page_bottom(0.0, paras, true);
let mut out = Vec::new();
for it in &l.pages[0].items {
if let Placed::Lines { path, para, l0, l1, y, .. } = it
&& path.0 == vec![1, 0, 0, i as u32]
{
for k in *l0..*l1 {
out.push(item_bottom(*y, para, *l0, k + 1).unwrap_or(0.0));
}
}
}
out
}
/// Word splits a row whose text fits above the page bottom but whose bottom cell margin does
/// not: the last line moves on, and widow control takes the line before it along (an eight-line
/// cell paragraph breaks 6 + 2). It used to move the whole row to the next page.
#[test]
fn a_split_row_keeps_its_bottom_margin_and_widow_control() {
crate::test_fonts();
let text = "Dotted leader lines to fill in by hand later on. ".repeat(14);
let paras = [(text.as_str(), 0.0)];
let bottoms = cell_line_bottoms(¶s, 0);
let n = bottoms.len();
assert!(n >= 6, "{n} lines");
// Put the last line 2pt above the page bottom (720): the 4pt margin under it doesn't fit.
let push = 720.0 - 2.0 - bottoms[n - 1];
let (_, lines) = row_at_page_bottom(push, ¶s, true);
assert_eq!(lines[0], vec![n - 2, 2], "widow control: two lines move on");
let (_, lines) = row_at_page_bottom(push, ¶s, false);
assert_eq!(lines[0], vec![n - 1, 1], "without widow control only the last line moves on");
// With the margin room to spare, the whole row stays.
let (_, lines) = row_at_page_bottom(push - 3.0, ¶s, true);
assert_eq!(lines[0], vec![n], "the row fits with its margin");
// Only the first line fits: an orphan, so the paragraph moves on whole.
let push = 720.0 - 4.0 - 1.0 - bottoms[0];
let (l, lines) = row_at_page_bottom(push, ¶s, true);
assert_eq!(lines[0], vec![0, n], "orphan control moves the paragraph");
assert!(l.pages[0].items.iter().all(|it| !matches!(it, Placed::Cell { .. })), "and the row with it");
}
/// When widow/orphan control leaves a cell of a row split across pages with nothing on the page,
/// though its first line would fit, the whole row moves on: Word doesn't leave the other cells
/// behind beside an empty one (observed with synthetic documents). A cell that keeps lines splits
/// as usual.
#[test]
fn a_cell_emptied_by_widow_control_takes_its_row_to_the_next_page() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
// Letter, 1 inch margins: 648 pt of text. `filler` lines of exactly 14 pt, then a row whose
// second cell holds one paragraph of `lines` lines, 14 pt each.
let pages_of = |filler: usize, lines: usize, widow: bool| {
let exact =
ParaProps { line_spacing: Some(LineSpacing::Exactly(14.0)), space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
let text: Vec<String> = (0..filler).map(|i| format!("Filler {i}")).collect();
let mut d = Document::from_text(&format!("{}\nAfter", text.join("\n")));
for i in 0..=filler {
*para_props(&mut d, i) = exact.clone();
}
let mut t = Table::new(1, 2, 400.0);
t.props.cell_margins = Some([0.0, 5.4, 0.0, 5.4]);
let cell_para = |s: &str| {
let mut p = wordcraft_doc::Paragraph::with_text(s, Default::default());
p.props = ParaProps { widow_control: Some(widow), ..exact.clone() };
wordcraft_doc::para_block(p)
};
t.rows[0].cells[0].blocks = vec![cell_para("A1")];
let b: Vec<String> = (1..=lines).map(|i| format!("B{i}")).collect();
t.rows[0].cells[1].blocks = vec![cell_para(&b.join(&wordcraft_doc::para::LINE_BREAK.to_string()))];
d.insert_block(StoryRef::Body, &Path::top(filler), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
// Lines of each cell per page: (first cell, second cell).
l.pages
.iter()
.map(|p| {
let count = |cell: u32| {
p.items
.iter()
.filter_map(|i| {
if let Placed::Lines { path, l0, l1, .. } = i { (path.0 == [filler as u32, 0, cell, 0]).then_some(l1 - l0) } else { None }
})
.sum::<usize>()
};
(count(0), count(1))
})
.collect::<Vec<_>>()
};
// 44 filler lines leave 32 pt: two lines fit.
assert_eq!(pages_of(44, 4, true)[..2], [(1, 2), (0, 2)], "four lines split two and two");
assert_eq!(pages_of(44, 3, true)[..2], [(0, 0), (1, 3)], "two and a widow: the whole row moves");
assert_eq!(pages_of(44, 3, false)[..2], [(1, 2), (0, 1)], "without widow control it splits where it falls");
// 45 filler lines leave 18 pt: one line fits, an orphan.
assert_eq!(pages_of(45, 4, true)[..2], [(0, 0), (1, 4)], "an orphan: the whole row moves");
}
// Use real paragraph and table layout to distinguish content from trailing spacing.
fn row_content_pieces(text: &str, props: ParaProps, room: f32) -> Vec<(usize, usize)> {
use wordcraft_doc::props::LineSpacing;
let exact = ParaProps { line_spacing: Some(LineSpacing::Exactly(14.0)), space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
let mut d = Document::from_text("Filler");
*para_props(&mut d, 0) = ParaProps { line_spacing: Some(LineSpacing::Exactly(d.last_section.text_height() - room)), ..exact.clone() };
let mut table = Table::new(1, 2, 400.0);
table.props.style = None;
table.props.cell_margins = Some([0.0; 4]);
let neighbor = ["First", "Second", "Third", "Fourth"].join(&wordcraft_doc::para::LINE_BREAK.to_string());
for (cell, text) in [text, neighbor.as_str()].into_iter().enumerate() {
let mut p = Paragraph::with_text(text, Default::default());
p.props = exact.clone();
if cell == 0 {
p.props.space_after = props.space_after;
p.props.widow_control = props.widow_control;
} else {
p.props.widow_control = Some(false);
}
table.rows[0].cells[cell].blocks = vec![wordcraft_doc::para_block(p)];
}
d.body.push(std::sync::Arc::new(Block::Table(table)));
lay(&d)
.pages
.iter()
.map(|page| {
let count = |cell| {
page.items
.iter()
.filter_map(|item| match item {
Placed::Lines { path, l0, l1, .. } if path.0 == [1, 0, cell, 0] => Some(l1 - l0),
_ => None,
})
.sum::<usize>()
};
(count(0), count(1))
})
.collect()
}
#[test]
fn row_split_ignores_afterspace() {
crate::test_fonts();
let two = ["Top", "Bottom"].join(&wordcraft_doc::para::LINE_BREAK.to_string());
for (text, room, expected) in [("Label", 18.0, vec![(0, 1), (1, 3)]), (two.as_str(), 32.0, vec![(0, 2), (2, 2)])] {
let props = ParaProps { space_after: Some(8.0), widow_control: Some(true), ..Default::default() };
assert_eq!(row_content_pieces(text, props, room), expected, "text={text:?}, room={room}");
}
}
#[test]
fn row_split_respects_widows() {
crate::test_fonts();
let two = ["Top", "Bottom"].join(&wordcraft_doc::para::LINE_BREAK.to_string());
let three = ["Top", "Middle", "Bottom"].join(&wordcraft_doc::para::LINE_BREAK.to_string());
for (text, widow, room, expected) in [
(two.as_str(), true, 18.0, vec![(0, 0), (2, 4)]),
(two.as_str(), false, 18.0, vec![(1, 1), (1, 3)]),
(three.as_str(), true, 32.0, vec![(0, 0), (3, 4)]),
(three.as_str(), false, 32.0, vec![(2, 2), (1, 2)]),
] {
let props = ParaProps { space_after: Some(0.0), widow_control: Some(widow), ..Default::default() };
assert_eq!(row_content_pieces(text, props, room), expected, "text={text:?}, widow={widow}, room={room}");
}
}
/// The cell's last paragraph needs its space after on the page too: a row ending in an empty
/// paragraph with 8pt after, whose text fits but whose space after doesn't, splits before it
/// (Word keeps the "Remarks:" line on the page) instead of moving whole.
#[test]
fn a_split_row_keeps_the_last_paragraphs_space_after() {
crate::test_fonts();
let paras = [("Remarks:", 0.0), ("", 8.0)];
let bottom = cell_line_bottoms(¶s, 1).last().copied().unwrap_or(0.0);
// The empty paragraph's line ends 6pt above the page bottom (720): 8pt after + 4pt margin
// don't fit.
let (_, lines) = row_at_page_bottom(720.0 - 6.0 - bottom, ¶s, true);
assert_eq!(lines, vec![vec![1, 0], vec![0, 1]], "split between the paragraphs");
}
/// Each cell of a split row goes on at the top of the continuation: widow control moves two
/// lines of one cell's paragraph on, a neighbour of one-line paragraphs only its last line, and
/// both start level on the next page (the neighbour used to start a line lower). The
/// continuation is as tall as the cell needing the most room.
#[test]
fn split_row_cells_each_continue_at_the_top() {
crate::test_fonts();
let text = "Dotted leader lines to fill in by hand later on. ".repeat(14);
let row = |push: f32, singles: usize| {
let mut d = Document::from_text("Filler");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.first_mut().map(std::sync::Arc::make_mut) {
p.props.space_before = Some(push);
p.props.space_after = Some(0.0);
}
let mut t = Table::new(1, 2, 400.0);
t.props.cell_margins = Some([0.0, 5.4, 4.0, 5.4]);
let para = |s: &str| {
let mut p = wordcraft_doc::Paragraph::with_text(s, Default::default());
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p.props.widow_control = Some(true);
wordcraft_doc::para_block(p)
};
t.rows[0].cells[0].blocks = vec![para(&text)];
t.rows[0].cells[1].blocks = (0..singles).map(|i| para(&format!("Item {i}"))).collect();
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
lay(&d)
};
// The long paragraph's line bottoms with the row at the top of the page; the neighbour gets
// as many one-line paragraphs.
let l = row(0.0, 1);
let Some((y, para, n)) = l.pages[0].items.iter().find_map(|it| match it {
Placed::Lines { path, y, para, l1, .. } if path.0 == vec![1, 0, 0, 0] => Some((*y, para.clone(), *l1)),
_ => None,
}) else {
panic!("no cell text")
};
assert!(n >= 6, "{n} lines");
let bottoms: Vec<f32> = (1..=n).map(|k| item_bottom(y, ¶, 0, k).unwrap()).collect();
let line = bottoms[1] - bottoms[0];
// The last lines end 2pt above the page bottom (720): the 4pt margin under them doesn't fit.
let l = row(720.0 - 2.0 - bottoms[n - 1], n);
assert_eq!(l.pages.len(), 2);
let tops: Vec<(usize, u32, f32)> = l.pages[1]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { path, l1, l0, y, .. } if path.0.len() == 4 => Some((l1 - l0, path.0[2], *y)),
_ => None,
})
.collect();
assert_eq!(tops.iter().map(|t| (t.0, t.1)).collect::<Vec<_>>(), vec![(2, 0), (1, 1)], "{tops:?}");
assert!((tops[0].2 - tops[1].2).abs() < 0.01, "both cells go on at the top: {tops:?}");
let cells: Vec<Rect> = l.pages[1].items.iter().filter_map(|it| if let Placed::Cell { rect, .. } = it { Some(*rect) } else { None }).collect();
assert_eq!(cells.len(), 2);
for c in &cells {
assert!((c.y - (tops[0].2 - 0.5)).abs() < 0.01, "{cells:?} {tops:?}");
// Two lines, a 0.5pt top border and the 4pt bottom margin plus its border band.
assert!(c.h >= 2.0 * line + 5.0 - 0.05 && c.h <= 2.0 * line + 5.0 + 0.05, "{} vs {}", c.h, 2.0 * line + 5.0);
}
}
/// Word never splits a row of an exact height: one the page bottom cuts through, its text
/// included, moves to the next page whole. An at-least row also moves when the remaining
/// room is less than its minimum height.
#[test]
fn exact_rows_move_on_whole() {
crate::test_fonts();
let text = "Dotted leader lines to fill in by hand later on. ".repeat(14);
let lay_row = |rule: wordcraft_doc::props::HeightRule| {
let mut d = Document::from_text("Filler");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.first_mut().map(std::sync::Arc::make_mut) {
p.props.space_before = Some(560.0);
p.props.space_after = Some(0.0);
}
let mut t = Table::new(1, 1, 200.0);
t.props.cell_margins = Some([0.0, 5.4, 4.0, 5.4]);
t.rows[0].props.height = Some(120.0);
t.rows[0].props.height_rule = rule;
let mut p = wordcraft_doc::Paragraph::with_text(&text, Default::default());
p.props.space_after = Some(0.0);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
l.pages
.iter()
.map(|pg| {
pg.items
.iter()
.filter_map(|it| if let Placed::Lines { path, l0, l1, .. } = it { (path.0.len() == 4).then_some(l1 - l0) } else { None })
.sum()
})
.collect::<Vec<usize>>()
};
let exact = lay_row(wordcraft_doc::props::HeightRule::Exact);
assert_eq!(exact.len(), 2);
assert_eq!(exact[0], 0, "the exact row moves on whole: {exact:?}");
let at_least = lay_row(wordcraft_doc::props::HeightRule::AtLeast);
assert_eq!(at_least[0], 0, "less than the minimum height remains: {at_least:?}");
assert!(at_least.get(1).is_some_and(|n| *n > 0), "the at-least row moves: {at_least:?}");
}
/// A nested table's cell the page bottom cuts through goes on at the top of the next page with
/// what is left of it, and the paragraph after the nested table below it, while its neighbour's
/// text runs on too. The cell's shift used to come from that paragraph (below the page bottom),
/// which squashed the nested cell to 2pt on the next page.
#[test]
fn a_nested_cell_cut_by_the_page_bottom_keeps_its_rest() {
crate::test_fonts();
let mut d = Document::from_text("Filler");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.first_mut().map(std::sync::Arc::make_mut) {
p.props.space_before = Some(400.0);
p.props.space_after = Some(0.0);
}
let mut inner = Table::new(1, 1, 150.0);
inner.rows[0].props.height = Some(300.0);
inner.rows[0].props.height_rule = wordcraft_doc::props::HeightRule::Exact;
let mut t = Table::new(1, 2, 400.0);
let text = "Dotted leader lines to fill in by hand later on. ".repeat(40);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&text, Default::default()))];
t.rows[0].cells[1].blocks =
vec![std::sync::Arc::new(Block::Table(inner)), wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("After", Default::default()))];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
assert!(l.pages.len() >= 2);
let nested = |pg: usize| {
l.pages[pg].items.iter().find_map(|it| if let Placed::Cell { rect, table, .. } = it { (table.0.len() > 1).then_some(*rect) } else { None })
};
let (Some(a), Some(b)) = (nested(0), nested(1)) else { panic!("the nested cell is on both pages") };
assert!((a.bottom() - 720.0).abs() < 0.5, "cut at the page bottom: {a:?}");
assert!(a.h + b.h >= 300.0 - 0.5 && a.h + b.h <= 300.0 + 2.5, "the nested cell keeps its height: {a:?} + {b:?}");
let after = l.pages[1].items.iter().find_map(|it| match it {
Placed::Lines { path, y, .. } if path.0 == vec![1, 0, 1, 1] => Some(*y),
_ => None,
});
assert!(after.is_some_and(|y| y >= b.bottom() - 0.01), "the paragraph after it follows it: {after:?} {b:?}");
// The neighbour's text goes on at the top too, every line once.
let lines: usize = l
.pages
.iter()
.flat_map(|pg| &pg.items)
.map(|it| if let Placed::Lines { path, l0, l1, .. } = it { if path.0 == vec![1, 0, 0, 0] { l1 - l0 } else { 0 } } else { 0 })
.sum();
let total = l.pages[0].items.iter().find_map(|it| match it {
Placed::Lines { path, para, .. } if path.0 == vec![1, 0, 0, 0] => Some(para.lines.len()),
_ => None,
});
assert_eq!(Some(lines), total);
}
/// A row of a minimum ("at least") height taller than its text that splits across pages keeps
/// its height over them: the continuation holds the rest of the row, not just the rest of the
/// text (no public Word reference crosses a page with such a row; this keeps the earlier
/// behaviour).
#[test]
fn a_split_at_least_row_keeps_its_height() {
crate::test_fonts();
let mut d = Document::from_text("Filler");
let mut t = Table::new(1, 1, 400.0);
t.rows[0].props.height = Some(1200.0);
t.rows[0].props.height_rule = wordcraft_doc::props::HeightRule::AtLeast;
let text = "Dotted leader lines to fill in by hand later on. ".repeat(80);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&text, Default::default()))];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let parts: Vec<f32> = l
.pages
.iter()
.flat_map(|pg| &pg.items)
.filter_map(|it| if let Placed::Cell { rect, table, .. } = it { (table.0.len() == 1).then_some(rect.h) } else { None })
.collect();
assert_eq!(parts.len(), 2, "{parts:?}");
// 1200pt and the 0.5pt top and bottom border bands.
let sum: f32 = parts.iter().sum();
assert!((sum - 1201.0).abs() < 0.05, "{parts:?}");
}
/// A cut that is NaN or infinite, or a row of a NaN height, splits nothing (`clamp` used to panic
/// on a NaN cut).
#[test]
fn split_row_rejects_a_hostile_cut() {
crate::test_fonts();
use crate::table::{CellPart, RowLayout, split_row};
let d = Document::from_text("Line");
let l = lay(&d);
let Some(Placed::Lines { story, path, para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })).cloned() else {
panic!("no line")
};
let line = |y: f32| Placed::Lines { story, path: path.clone(), para: para.clone(), l0: 0, l1: 1, x: 0.0, y, turn: TextDirection::Horizontal };
let row = |height: f32, bottom: f32| RowLayout {
edge: 0.0,
height,
items: vec![line(0.0), line(150.0)],
bottom,
cells: vec![CellPart { top: 2.0, items: 0..2, end: Some(170.0), align: None }],
};
for cut in [f32::NAN, f32::INFINITY, f32::NEG_INFINITY, 0.0, -1.0, 200.0] {
assert!(split_row(&row(200.0, 4.0), cut).is_none(), "{cut}");
}
assert!(split_row(&row(f32::NAN, 4.0), 100.0).is_none());
assert!(split_row(&row(f32::INFINITY, 4.0), f32::INFINITY).is_none());
// A NaN or infinite bottom margin doesn't panic either.
for bottom in [f32::NAN, f32::INFINITY, f32::NEG_INFINITY] {
let _ = split_row(&row(200.0, bottom), 100.0);
let _ = split_row(&row(f32::INFINITY, bottom), 100.0);
}
// Cell ranges past the items are ignored.
let mut r = row(200.0, 4.0);
r.cells.push(CellPart { top: 2.0, items: 5..9, end: None, align: None });
r.cells.push(CellPart { top: 2.0, items: std::ops::Range { start: 2, end: 1 }, end: None, align: None });
assert!(split_row(&r, 100.0).is_some());
}
#[test]
fn repeated_header_is_followed_by_the_next_row_even_when_it_overflows() {
crate::test_fonts();
// A one-column table at the top of a letter page (body 648 pt), then an empty paragraph. Returns
// the table rows on each page, in order.
let rows_per_page = |t: Table| -> Vec<Vec<usize>> {
let mut d = Document::new();
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
l.pages
.iter()
.map(|p| p.items.iter().filter_map(|i| if let Placed::Cell { row, cell: 0, .. } = i { Some(*row) } else { None }).collect())
.collect()
};
// A header row of `header` points and body rows of `rows` points (at least), one line of text each.
let table = |header: f32, rows: &[f32]| {
let mut t = Table::new(rows.len() + 1, 1, 468.0);
t.rows[0].props.header = true;
for (row, h) in t.rows.iter_mut().zip(std::iter::once(&header).chain(rows)) {
row.props.height = Some(*h);
row.props.height_rule = wordcraft_doc::props::HeightRule::AtLeast;
}
t
};
// Header and row fit together: one row per page, under the header.
assert_eq!(rows_per_page(table(100.0, &[400.0; 3])), vec![vec![0, 1], vec![0, 2], vec![0, 3]]);
// A 300 pt header and 400 pt rows never fit together. As in Word, the first row moves to a new
// page, goes under the repeated header and runs into the bottom margin; so does every later row.
assert_eq!(rows_per_page(table(300.0, &[400.0; 4])), vec![vec![0], vec![0, 1], vec![0, 2], vec![0, 3], vec![0, 4], vec![]]);
// A header that almost fills the page still repeats, with one row under it on each page.
assert_eq!(rows_per_page(table(640.0, &[100.0; 3])), vec![vec![0], vec![0, 1], vec![0, 2], vec![0, 3], vec![]]);
// A 20-row table under a 640 pt header: one page per row, never a runaway.
assert_eq!(rows_per_page(table(640.0, &[12.0; 19])).len(), 21);
// A row of text that is taller than the room under the header still splits across pages.
let mut t = table(100.0, &[12.0]);
let long = "Row text that keeps going and going so the cell grows taller than a page. ".repeat(120);
t.rows[1].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&long, Default::default()))];
let pages = rows_per_page(t);
assert!(pages.len() >= 3, "{pages:?}");
assert!(pages.iter().all(|p| p.first() == Some(&0) && p.contains(&1)), "{pages:?}");
// An ordinary header still repeats on every page the table reaches.
let mut t = Table::new(80, 2, 468.0);
t.rows[0].props.header = true;
let pages = rows_per_page(t);
assert!(pages.len() >= 2, "{pages:?}");
assert!(pages.iter().all(|p| p.first() == Some(&0)), "{pages:?}");
}
#[test]
fn repeated_header_moves_with_the_first_row_that_does_not_fit() {
crate::test_fonts();
// A paragraph that leaves `room` points of the letter page's 648 pt body, then a table with a
// 20 pt header row and 40 pt one-line rows. Returns the table rows on each page.
let rows_per_page = |room: f32| -> Vec<Vec<usize>> {
let mut d = Document::from_text("Text above the table");
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.space_after = Some(648.0 - room - 14.0);
let mut t = Table::new(3, 1, 468.0);
t.rows[0].props.header = true;
for (row, h) in t.rows.iter_mut().zip([20.0, 40.0, 40.0]) {
row.props.height = Some(h);
row.props.height_rule = wordcraft_doc::props::HeightRule::AtLeast;
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
lay(&d)
.pages
.iter()
.map(|p| p.items.iter().filter_map(|i| if let Placed::Cell { row, cell: 0, .. } = i { Some(*row) } else { None }).collect())
.collect()
};
// Header and first row fit: the table starts on the first page.
assert_eq!(rows_per_page(80.0)[0], vec![0, 1]);
// Only the header fits: it goes to the next page with the first row instead of staying alone.
assert_eq!(rows_per_page(40.0), vec![vec![], vec![0, 1, 2]]);
}
#[test]
fn a_repeated_header_is_never_left_alone_when_the_table_starts_mid_page() {
// #1704: a table whose repeated header row fits at the bottom of a page while a body row
// does not must not leave the header row there alone. Sweeps filler counts across the page
// boundary for several table geometries (height ratios, a cantSplit body row, an exact
// height body row, two header rows) and pins, for every configuration while the table
// continues onto a next page: no page ends with only header rows, and no row is dropped.
// A table that starts at the very top of a page is exempt (#1705): there the header is the
// table's own beginning, so fillers = 0 skips that assertion.
#[derive(Debug)]
struct Geo {
header: f32,
body: f32,
body_cant_split: bool,
body_exact: bool,
header_rows: usize,
}
let geos = [
(Geo { header: 100.0, body: 400.0, body_cant_split: false, body_exact: false, header_rows: 1 }, 1usize),
(Geo { header: 300.0, body: 100.0, body_cant_split: false, body_exact: false, header_rows: 1 }, 4),
(Geo { header: 50.0, body: 250.0, body_cant_split: false, body_exact: false, header_rows: 1 }, 4),
(Geo { header: 100.0, body: 400.0, body_cant_split: true, body_exact: false, header_rows: 1 }, 4),
(Geo { header: 100.0, body: 400.0, body_cant_split: false, body_exact: true, header_rows: 1 }, 4),
(Geo { header: 100.0, body: 400.0, body_cant_split: false, body_exact: false, header_rows: 2 }, 4),
];
// The table, after `fillers` paragraphs: the same table in every configuration.
let table_doc = |fillers: usize, geo: &Geo| -> Document {
let mut d = Document::new();
for i in 0..fillers {
let mut p = wordcraft_doc::Paragraph::with_text(&format!("Filler {i}"), Default::default());
p.props.space_after = Some(0.0);
d.body.push(wordcraft_doc::para_block(p));
}
let mut t = Table::new(geo.header_rows + 2, 1, 468.0);
for (ri, row) in t.rows.iter_mut().enumerate() {
row.props.header = ri < geo.header_rows;
row.props.height = Some(if ri < geo.header_rows { geo.header } else { geo.body });
row.props.height_rule = wordcraft_doc::props::HeightRule::AtLeast;
if ri >= geo.header_rows && geo.body_cant_split {
row.props.cant_split = true;
}
if ri >= geo.header_rows && geo.body_exact {
row.props.height_rule = wordcraft_doc::props::HeightRule::Exact;
}
}
d.insert_block(StoryRef::Body, &Path::top(d.body.len()), wordcraft_doc::Block::Table(t)).unwrap();
d
};
let pages_with = |fillers: usize, geo: &Geo| -> Vec<Vec<usize>> {
let l = lay(&table_doc(fillers, geo));
l.pages
.iter()
.map(|p| p.items.iter().filter_map(|i| if let Placed::Cell { row, cell: 0, .. } = i { Some(*row) } else { None }).collect())
.collect()
};
// The same table, with the geometry: the (row, frame) of each row's first cell per page,
// and the page's body area, so the room under the header can be measured.
let pages_geom = |fillers: usize, geo: &Geo| -> Vec<(Vec<(usize, Rect)>, Rect)> {
let l = lay(&table_doc(fillers, geo));
l.pages
.iter()
.map(|p| {
let cells = p
.items
.iter()
.filter_map(|i| match i {
Placed::Cell { rect, row, cell: 0, .. } => Some((*row, *rect)),
_ => None,
})
.collect();
(cells, p.body)
})
.collect()
};
for (geo, coarse) in &geos {
for fillers in (0..60).step_by(*coarse) {
let pages = pages_with(fillers, geo);
for w in pages.windows(2) {
// While the table continues on the next page, a page never ends with only
// header rows. (fillers = 0 starts the table at the top of a page: exempt.)
if !w[1].is_empty() && fillers > 0 {
assert!(
w[0].is_empty() || w[0].iter().any(|&r| r >= geo.header_rows),
"fillers {fillers}, geo {geo:?}: a page ends with header rows alone: {pages:?}"
);
}
}
// No configuration drops rows: every row of the table is placed somewhere.
let placed: std::collections::HashSet<usize> = pages.iter().flatten().copied().collect();
assert_eq!(placed.len(), geo.header_rows + 2, "fillers {fillers}, geo {geo:?}: rows placed: {pages:?}");
}
}
// Room for the header and the first body row together keeps them on the page, and keeps
// the body row *there*: where the row would fit under the header, it is placed on that
// page instead of being carried over. This is the position, not only the presence -- a
// table that carried a body row over although the page had room for it is the
// unnecessary move the sweep above cannot see.
let mut paired = 0;
for fillers in 1..60 {
let geo = &geos[0].0;
let geom = pages_geom(fillers, geo);
let Some((first_cells, body)) = geom.first() else { continue };
let Some((_, header_rect)) = first_cells.iter().find(|(r, _)| *r == 0) else {
// The header itself moved to a later page: there is nothing to pair it with here.
continue;
};
// The room left on the first page under the header.
let room = body.bottom() - header_rect.bottom();
// The body row's own height, wherever it was placed.
let body_h = geom.iter().flat_map(|(cells, _)| cells.iter()).find(|(r, _)| *r == geo.header_rows).map(|(_, rect)| rect.h).unwrap_or(geo.body);
if room >= body_h {
assert!(
first_cells.iter().any(|(r, _)| *r == geo.header_rows),
"fillers {fillers}: the first body row fits in the {room} pt left under the header \
(it is {body_h} pt tall) but was carried over to the next page"
);
paired += 1;
}
}
assert!(paired > 0, "no configuration left room for the header and a body row together");
}
/// A drop-cap paragraph in a font larger than 1000 pt used to panic in layout (`clamp` with min > max).
#[test]
fn drop_cap_with_a_huge_font_lays_out() {
crate::test_fonts();
for size in [999.0, 1000.0, 1001.0, 1638.0] {
let cp = wordcraft_doc::CharProps { size: Some(size), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::with_text("Hello drop cap world", cp);
p.props.drop_cap = Some(3);
let mut d = Document::from_text("x");
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
let Some(pl) = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None }) else {
panic!("no lines at size {size}")
};
let (nc, lines, _) = pl.drop_cap.unwrap_or((0, 0, 0.0));
assert_eq!((nc, lines), (1, 3), "size {size}");
}
}
#[test]
fn drop_cap_indents_its_lines() {
crate::test_fonts();
let mut p =
wordcraft_doc::Paragraph::with_text(&"Every line of this paragraph wraps around a large first letter. ".repeat(6), Default::default());
p.props.drop_cap = Some(3);
let mut d = Document::from_text("x");
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
let Some(pl) = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None }) else {
panic!("no lines")
};
let (nc, lines, w) = pl.drop_cap.unwrap_or((0, 0, 0.0));
assert_eq!((nc, lines), (1, 3));
assert!(w > 20.0, "drop cap width {w}");
assert!(pl.lines.len() > 4);
for (k, line) in pl.lines.iter().enumerate() {
let x = line.xs.first().copied().unwrap_or(0.0);
if k < 3 {
assert!(x >= w - 0.5, "line {k} at {x}");
} else {
assert!(x < 1.0, "line {k} at {x}");
}
}
// The letter's glyphs are lowered toward the third line's baseline.
let g = pl.glyphs.first().map(|g| g.dy).unwrap_or(0.0);
assert!(g < -20.0, "dy {g}");
}
/// The first laid-out paragraph of a one-paragraph document with a drop cap set by `set`.
fn drop_cap_layout(set: impl Fn(&mut wordcraft_doc::props::ParaProps)) -> std::sync::Arc<crate::para::ParaLayout> {
let mut p =
wordcraft_doc::Paragraph::with_text(&"Every line of this paragraph wraps around a large first letter. ".repeat(6), Default::default());
p.props.drop_cap = Some(3);
set(&mut p.props);
let mut d = Document::from_text("x");
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
let Some(pl) = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None }) else {
panic!("no lines")
};
pl
}
/// #2601: Drop Cap Options. Dropped indents the first lines by the letter's width plus the
/// distance from the text; In margin leaves every line at the paragraph's indent and hangs the
/// letter left of it, the distance away; the letter takes the chosen font.
#[test]
fn drop_cap_options_place_the_letter() {
crate::test_fonts();
let x0 = |pl: &crate::para::ParaLayout, k: usize| pl.lines.get(k).and_then(|l| l.xs.first().copied()).unwrap_or(f32::NAN);
let letter_x = |pl: &crate::para::ParaLayout| x0(pl, 0) + pl.glyphs.first().map(|g| g.dx).unwrap_or(f32::NAN);
let plain = drop_cap_layout(|_| {});
let w = plain.drop_cap_w;
assert!(w > 20.0, "letter width {w}");
assert!((letter_x(&plain)).abs() < 0.5, "a dropped letter sits at the indent: {}", letter_x(&plain));
let far = drop_cap_layout(|p| p.drop_cap_distance = Some(18.0));
for k in 0..3 {
assert!((x0(&far, k) - (w + 18.0)).abs() < 0.5, "dropped line {k} at {} (letter {w} + 18)", x0(&far, k));
}
assert!(x0(&far, 3).abs() < 0.5, "line 4 is back at the indent: {}", x0(&far, 3));
assert!((letter_x(&far)).abs() < 0.5, "the letter stays at the indent: {}", letter_x(&far));
let margin = drop_cap_layout(|p| {
p.drop_cap_margin = Some(true);
p.drop_cap_distance = Some(9.0);
});
for k in 0..4 {
assert!(x0(&margin, k).abs() < 0.5, "in margin, line {k} is not indented: {}", x0(&margin, k));
}
assert!((letter_x(&margin) + margin.drop_cap_w + 9.0).abs() < 0.5, "the letter hangs left of the text: {}", letter_x(&margin));
assert!(margin.glyphs.first().is_some_and(|g| g.dy < -20.0), "still dropped toward the third line");
let font = drop_cap_layout(|p| p.drop_cap_font = Some("Liberation Mono".into()));
let cap_style = font.clusters.first().and_then(|c| font.styles.get(c.style as usize)).map(|s| s.rc.font.clone());
assert_eq!(cap_style.as_deref(), Some("Liberation Mono"));
let text_style = font.clusters.get(1).and_then(|c| font.styles.get(c.style as usize)).map(|s| s.rc.font.clone());
assert_ne!(text_style.as_deref(), Some("Liberation Mono"), "only the letter");
}
/// #2601: the letter's own font applies to complex-script and East Asian first letters too. In
/// margin, the letter sits in the left margin for any alignment or first-line indent: its right
/// edge is the distance left of the text column (of the first line's start, if that hangs further
/// left), never beside centred text or inside the column.
#[test]
fn drop_cap_font_covers_scripts_and_alignment_keeps_the_gap() {
use wordcraft_doc::props::Align;
let font = drop_cap_layout(|p| p.drop_cap_font = Some("Liberation Mono".into()));
let rc = font.clusters.first().and_then(|c| font.styles.get(c.style as usize)).map(|s| s.rc.clone());
let Some(rc) = rc else { panic!("no style") };
assert_eq!(rc.font_cs, "Liberation Mono");
assert_eq!(rc.font_ea.as_deref(), Some("Liberation Mono"));
// (alignment, left indent, first-line indent, the column's edge the letter hangs from)
let cases = [
(Align::Left, 0.0, 0.0, 0.0),
(Align::Center, 0.0, 0.0, 0.0),
(Align::Right, 0.0, 0.0, 0.0),
(Align::Left, 0.0, 36.0, 0.0),
(Align::Center, 18.0, 36.0, 18.0),
(Align::Left, 36.0, -36.0, 0.0),
];
for (align, left, first, edge) in cases {
let pl = drop_cap_layout(|p| {
p.align = Some(align);
p.indent_left = Some(left);
p.indent_first = Some(first);
p.drop_cap_margin = Some(true);
p.drop_cap_distance = Some(9.0);
});
let text_x = pl.lines.first().and_then(|l| l.xs.first().copied()).unwrap_or(f32::NAN);
let letter_right = text_x + pl.glyphs.first().map(|g| g.dx).unwrap_or(f32::NAN) + pl.drop_cap_w;
assert!(
(letter_right - (edge - 9.0)).abs() < 0.5,
"{align:?}, indents {left}/{first}: letter's right edge {letter_right}, expected {} (text at {text_x})",
edge - 9.0
);
}
}
#[test]
fn auto_hyphenation_breaks_long_words() {
crate::test_fonts();
let text = "Internationalization considerations notwithstanding, administrators systematically reconsidered extraordinarily uncharacteristic responsibilities. ".repeat(4);
let mut d = Document::from_text(&text);
let off = lay(&d);
let hyphens = |l: &DocLayout| {
l.pages[0]
.items
.iter()
.filter_map(|i| if let Placed::Lines { para, .. } = i { Some(para.lines.iter().filter(|x| x.hyphen.is_some()).count()) } else { None })
.sum::<usize>()
};
assert_eq!(hyphens(&off), 0);
d.settings.auto_hyphenation = true;
let on = lay(&d);
assert!(hyphens(&on) > 0, "no hyphenated lines");
// Hyphenated lines stay inside the margins.
for it in &on.pages[0].items {
if let Placed::Lines { para, .. } = it {
for l in para.lines.iter().filter(|l| l.hyphen.is_some()) {
assert!(l.xs.last().copied().unwrap_or(0.0) <= l.right + 0.5, "{} > {}", l.xs.last().copied().unwrap_or(0.0), l.right);
}
}
}
// Soft hyphens break even without auto hyphenation, and show a hyphen.
let soft = format!("{}extra\u{ad}ordinary", "word ".repeat(13));
let d2 = Document::from_text(&soft);
let l2 = lay(&d2);
let _ = hyphens(&l2);
}
/// Hyphenation Options (#407): a consecutive-hyphen limit of 1 never lets two lines in a row end
/// with a hyphen, and words in capitals stay whole when the document says so.
#[test]
fn hyphenation_options_limit_hyphens_and_spare_capitals() {
crate::test_fonts();
let text = "Internationalization considerations notwithstanding, administrators systematically reconsidered extraordinarily uncharacteristic responsibilities. ".repeat(6);
let lines = |d: &Document| -> Vec<bool> {
lay(d).pages[0]
.items
.iter()
.filter_map(|i| {
if let Placed::Lines { para, .. } = i { Some(para.lines.iter().map(|x| x.hyphen.is_some()).collect::<Vec<_>>()) } else { None }
})
.flatten()
.collect()
};
let mut d = Document::from_text(&text);
d.settings.auto_hyphenation = true;
d.settings.consecutive_hyphen_limit = 1;
let hy = lines(&d);
assert!(hy.windows(2).all(|w| !(w[0] && w[1])), "two hyphenated lines in a row: {hy:?}");
let mut caps = Document::from_text(&text.to_uppercase());
caps.settings.auto_hyphenation = true;
caps.settings.hyphenate_caps = false;
assert!(lines(&caps).iter().all(|h| !h), "a word in capitals was hyphenated");
}
/// A table of `rows` x 2 with text in every cell, after a "before" paragraph.
fn styled_table_doc(style: Option<&str>, rows: usize) -> Document {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(rows, 2, 468.0);
t.props.style = style.map(str::to_string);
for (r, row) in t.rows.iter_mut().enumerate() {
for (c, cell) in row.cells.iter_mut().enumerate() {
cell.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("R{r} C{c}"), Default::default()))];
}
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
d
}
fn row_height(l: &DocLayout, row: usize) -> f32 {
l.pages[0].items.iter().find_map(|i| if let Placed::Cell { rect, row: r, .. } = i { (*r == row).then_some(rect.h) } else { None }).unwrap()
}
/// The laid-out paragraph in cell (row, col) of the table at body index 1.
fn cell_para(l: &DocLayout, row: u32, col: u32) -> Arc<ParaLayout> {
l.pages[0]
.items
.iter()
.find_map(|i| if let Placed::Lines { path, para, .. } = i { (path.0 == vec![1, row, col, 0]).then(|| para.clone()) } else { None })
.unwrap()
}
/// Text in a table cell takes its table style's paragraph and run formatting over the document
/// defaults (ECMA-376 §17.7.2): Table Grid's single spacing and no space after, not the defaults'
/// 8 pt after and 1.15 lines.
#[test]
fn table_style_paragraph_props_beat_document_defaults() {
crate::test_fonts();
let d = styled_table_doc(Some("TableGrid"), 3);
let plain = styled_table_doc(None, 3);
let (lg, lp) = (lay(&d), lay(&plain));
let p = cell_para(&lg, 1, 0);
assert_eq!((p.rp.space_after, p.rp.line_spacing), (0.0, wordcraft_doc::props::LineSpacing::Multiple(1.0)));
let q = cell_para(&lp, 1, 0);
assert_eq!((q.rp.space_after, q.rp.line_spacing), (8.0, wordcraft_doc::props::LineSpacing::Multiple(1.15)));
let (g, n) = (row_height(&lg, 1), row_height(&lp, 1));
assert!(g + 8.0 < n, "Table Grid row {g}, unstyled row {n}");
assert!(g < 18.0, "one 12 pt line, single spaced: {g}");
}
/// #3415: row bands shade only where the table style has a band size. Word reads a style without
/// `w:tblStyleRowBandSize` as having no bands; our Grid Table 4 sets one, so with a header row its
/// first and third body rows shade.
#[test]
fn row_bands_shade_only_with_a_band_size() {
let band = wordcraft_doc::props::Rgb(0xC1, 0xE4, 0xF5);
let shaded_rows = |d: &Document| {
let l = lay(d);
let cells: Vec<(usize, wordcraft_geom::Rect)> =
l.pages[0].items.iter().filter_map(|i| if let Placed::Cell { rect, row, .. } = i { Some((*row, *rect)) } else { None }).collect();
let mut rows: Vec<usize> = l.pages[0]
.items
.iter()
.filter_map(|i| if let Placed::Fill { rect, color } = i { (*color == band).then_some(*rect) } else { None })
.filter_map(|f| cells.iter().find(|(_, c)| c.y <= f.y + f.h / 2.0 && f.y + f.h / 2.0 <= c.bottom()).map(|(r, _)| *r))
.collect();
rows.dedup();
rows
};
let mut d = styled_table_doc(Some("GridTable4AccentBlue"), 5);
assert_eq!(shaded_rows(&d), vec![1, 3], "Grid Table 4 bands one row at a time");
if let Some(t) = Arc::make_mut(&mut d.styles).get_mut("GridTable4AccentBlue").and_then(|s| s.table.as_mut()) {
t.band_size = None;
}
assert_eq!(shaded_rows(&d), Vec::<usize>::new(), "no band size, no bands");
if let Some(t) = Arc::make_mut(&mut d.styles).get_mut("GridTable4AccentBlue").and_then(|s| s.table.as_mut()) {
t.band_size = Some(2);
}
assert_eq!(shaded_rows(&d), vec![1, 2], "bands of two rows");
}
/// The paragraph's own style (Normal included) and direct formatting beat the table style; the
/// table style only fills in what they leave unset.
#[test]
fn paragraph_style_and_direct_formatting_beat_table_style() {
crate::test_fonts();
let mut d = styled_table_doc(Some("TableGrid"), 3);
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "Spaced".into(),
name: "Spaced".into(),
based_on: Some("Normal".into()),
para: ParaProps { space_after: Some(12.0), ..Default::default() },
..Default::default()
});
d.format_paragraphs(
&Pos { story: StoryRef::Body, path: Path(vec![1, 0, 0, 0]), off: 0 },
&Pos { story: StoryRef::Body, path: Path(vec![1, 0, 0, 0]), off: 0 },
&|p| p.style = Some("Spaced".into()),
)
.unwrap();
d.format_paragraphs(
&Pos { story: StoryRef::Body, path: Path(vec![1, 1, 0, 0]), off: 0 },
&Pos { story: StoryRef::Body, path: Path(vec![1, 1, 0, 0]), off: 0 },
&|p| p.space_after = Some(3.0),
)
.unwrap();
let l = lay(&d);
let styled = cell_para(&l, 0, 0);
assert_eq!(styled.rp.space_after, 12.0, "paragraph style");
assert_eq!(styled.rp.line_spacing, wordcraft_doc::props::LineSpacing::Multiple(1.0), "unset by the style: from the table style");
assert_eq!(cell_para(&l, 1, 0).rp.space_after, 3.0, "direct formatting");
assert_eq!(cell_para(&l, 2, 0).rp.space_after, 0.0, "table style");
// Normal setting its own spacing wins too, even where it equals nothing in the defaults.
if let Some(n) = Arc::make_mut(&mut d.styles).get_mut("Normal") {
n.para.space_after = Some(10.0);
}
assert_eq!(cell_para(&lay(&d), 2, 0).rp.space_after, 10.0, "Normal");
}
/// A table style based on another keeps the base style's borders and cell text formatting, and
/// adds its own run formatting and conditional formats.
#[test]
fn derived_table_style_merges_its_base() {
crate::test_fonts();
use wordcraft_doc::styles::TableStyleParts;
let red = wordcraft_doc::Rgb(0xC0, 0, 0);
let mut d = styled_table_doc(Some("RedGrid"), 3);
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "RedGrid".into(),
name: "Red Grid".into(),
kind: wordcraft_doc::StyleKind::Table,
based_on: Some("TableGrid".into()),
chr: CharProps { bold: Some(true), color: Some(wordcraft_doc::TextColor::Rgb(red)), ..Default::default() },
table: Some(TableStyleParts { header_chr: CharProps { italic: Some(true), ..Default::default() }, ..Default::default() }),
..Default::default()
});
let l = lay(&d);
let rules = l.pages[0].items.iter().filter(|i| matches!(i, Placed::Rule { .. })).count();
assert!(rules >= 18, "Table Grid's borders: {rules}");
let body = cell_para(&l, 1, 1);
let rc = &body.styles[0].rc;
assert!(rc.bold && !rc.italic, "{rc:?}");
assert_eq!(rc.color, wordcraft_doc::TextColor::Rgb(red));
assert_eq!(body.rp.space_after, 0.0, "Table Grid's paragraph formatting");
let head = &cell_para(&l, 0, 0).styles[0].rc;
assert!(head.bold && head.italic, "{head:?}");
// Direct formatting still wins over the table style.
let mut d2 = d.clone();
let path = Path(vec![1, 2, 0, 0]);
d2.format_range(&Pos { story: StoryRef::Body, path: path.clone(), off: 0 }, &Pos { story: StoryRef::Body, path, off: 5 }, &|c| {
c.bold = Some(false)
})
.unwrap();
assert!(!cell_para(&lay(&d2), 2, 0).styles[0].rc.bold);
}
fn text_box(d: &mut Document, at: usize, text: &str, w: f32, h: f32, float: wordcraft_doc::para::Float) -> u32 {
text_box_at(d, &Pos::body(0, at), text, w, h, float)
}
fn text_box_at(d: &mut Document, pos: &Pos, text: &str, w: f32, h: f32, float: wordcraft_doc::para::Float) -> u32 {
let id =
d.add_part(wordcraft_doc::PartKind::TextBox, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))]);
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::TextBox,
w,
h,
fill: None,
stroke: None,
stroke_width: 0.75,
float,
story: Some(id),
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(pos, shape, &Default::default()).unwrap();
id
}
#[test]
fn a_turned_text_box_turns_its_text_with_it() {
// Word turns a text box's text with the box (and turns it upside down when the box is
// flipped across, but never mirrors it): its lines are drawn inside the box's rotation.
let rotated_text = |rot: f32, flip_h: bool, flip_v: bool| {
let mut d = Document::from_text("Body text.");
let float =
wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, x: 20.0, y: 20.0, rot, flip_h, flip_v, ..Default::default() };
text_box(&mut d, 0, "Turned words", 140.0, 50.0, float);
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
items.iter().find_map(|x| match x {
display::Draw::Rotated { spin, items, .. }
if items.iter().any(|g| matches!(g, display::Draw::Glyphs { text, .. } if text.contains("Turned"))) =>
{
Some(*spin)
}
_ => None,
})
};
assert_eq!(rotated_text(0.0, false, false), None, "an upright box's text is drawn as it is");
let s = rotated_text(30.0, false, false).expect("turned with the box");
assert_eq!((s.deg, s.flip_h, s.flip_v), (30.0, false, false));
// Flipped side to side: readable, not mirrored.
assert_eq!(rotated_text(0.0, true, false), None);
// Flipped across: upside down.
let s = rotated_text(0.0, false, true).expect("upside down");
assert_eq!((s.deg, s.flip_h, s.flip_v), (180.0, false, false)); // Drawn item by item (as PDF export draws, to tag each paragraph): the same.
let mut d = Document::from_text("Body text.");
let float = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, x: 20.0, y: 20.0, rot: 30.0, ..Default::default() };
text_box(&mut d, 0, "Turned words", 140.0, 50.0, float);
let l = lay(&d);
let shown = display::ItemDisplay::new(&d, &l.pages[0]);
let turned = l.pages[0].items.iter().flat_map(|it| shown.draws(it, &Default::default())).any(|x| {
matches!(&x, display::Draw::Rotated { items, .. } if items.iter().any(|g| matches!(g, display::Draw::Glyphs { text, .. } if text.contains("Turned"))))
});
assert!(turned);
}
fn box_rect(l: &DocLayout, id: u32) -> wordcraft_geom::Rect {
l.pages[0]
.items
.iter()
.find_map(|i| if let Placed::Object { rect, text_box, .. } = i { (*text_box == Some(id)).then_some(*rect) } else { None })
.unwrap()
}
#[test]
fn clicks_inside_a_text_box_hit_its_story() {
crate::test_fonts();
let mut d = Document::from_text("Before after");
let id = text_box(&mut d, 7, "Inside the box", 144.0, 72.0, Default::default());
let l = lay(&d);
let r = box_rect(&l, id);
assert!((r.w - 144.0).abs() < 0.5 && (r.h - 72.0).abs() < 0.5, "{r:?}");
let box_story = StoryRef::Part(id);
// Anywhere inside the box, even below its text, is the box.
for (x, y) in [(r.x + 20.0, r.y + 10.0), (r.x + r.w - 4.0, r.y + r.h - 4.0)] {
assert_eq!(l.story_at(0, x, y), Some(box_story), "({x}, {y}) in {r:?}");
assert_eq!(l.hit(0, x, y, box_story).map(|p| p.story), Some(box_story));
}
// The body text beside it is the body; so is the margin just right of the box, although the
// box's own lines are within reach there.
let c = l.caret(&Pos::body(0, 2)).unwrap();
assert_eq!(l.story_at(0, c.x, c.top + c.height / 2.0), Some(StoryRef::Body));
assert_ne!(l.story_at(0, r.right() + 8.0, r.y + 10.0), Some(box_story));
// The caret in the box sits inside it.
let bc = l.caret(&Pos { story: box_story, path: Path::top(0), off: 0 }).unwrap();
assert!(r.contains(wordcraft_geom::Point::new(bc.x, bc.top)), "{bc:?} outside {r:?}");
}
#[test]
fn body_text_wins_over_a_text_box_behind_it() {
crate::test_fonts();
let mut d = Document::from_text("Hi");
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::BehindText,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x: 0.0,
y: 0.0,
dist: 0.0,
..Default::default()
};
let id = text_box(&mut d, 0, "Behind", 200.0, 150.0, float);
let l = lay(&d);
let r = box_rect(&l, id);
let c = l.caret(&Pos::body(0, 0)).unwrap();
assert!(r.contains(wordcraft_geom::Point::new(c.x + 2.0, c.top + 2.0)), "box covers the text: {r:?} {c:?}");
assert_eq!(l.story_at(0, c.x + 2.0, c.top + c.height / 2.0), Some(StoryRef::Body));
assert_eq!(l.story_at(0, r.right() - 10.0, r.bottom() - 10.0), Some(StoryRef::Part(id)));
}
#[test]
fn presses_grab_pictures_anywhere_and_text_boxes_by_their_border() {
crate::test_fonts();
let mut d = Document::from_text("Words before the objects.");
let id = text_box(&mut d, 0, "Inside", 144.0, 72.0, Default::default());
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 60.0,
h: 40.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float: Default::default(),
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let l = lay(&d);
let b = box_rect(&l, id);
// The text box: its border grabs it, inside is its text.
let edge = l.object_at(0, b.x + 1.0, b.y + b.h / 2.0, 4.0).unwrap();
assert_eq!(edge.text_box, Some(id));
assert_eq!(l.object(&edge.pos(), 0).map(|o| o.rect), Some(b));
assert_eq!(l.text_box(id, 5).map(|o| o.rect), Some(b), "a bad hint still finds it");
assert!(l.object_at(0, b.x + b.w / 2.0, b.y + b.h / 2.0, 4.0).is_none());
// The shape: anywhere on it.
let s = l.find_object(0, |o| o.text_box.is_none()).unwrap();
let hit = l.object_at(0, s.rect.x + s.rect.w / 2.0, s.rect.y + s.rect.h / 2.0, 4.0).unwrap();
assert_eq!((hit.off, hit.text_box, hit.floating()), (0, None, false));
// Plain text: nothing.
let c = l.caret(&Pos::body(0, 10)).unwrap();
assert!(l.object_at(0, c.x, c.top + 2.0, 4.0).is_none());
}
#[test]
fn a_press_inside_a_text_box_over_a_picture_goes_to_its_text() {
// A form scanned as a picture, with text boxes laid over it to fill in: a press inside a box
// grabbed the picture under it, so the box's text could not be reached.
use wordcraft_doc::para::{Anchor, Float, Wrap};
let float =
|wrap: Wrap, z: u32| Float { wrap, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 0.0, y: 0.0, dist: 0.0, z, ..Default::default() };
let form = |wrap: Wrap, picture_z: u32, rot: f32| {
let mut d = Document::from_text("Form");
let picture = InlineObject::Image {
media: "form".into(),
w: 300.0,
h: 400.0,
alt: String::new(),
float: float(wrap, picture_z),
crop: [0.0; 4],
ole: None,
fx: Default::default(),
};
d.insert_object(&Pos::body(0, 0), picture, &Default::default()).unwrap();
let id = text_box(&mut d, 0, "Name", 200.0, 100.0, Float { x: 50.0, y: 150.0, rot, ..float(wrap, 2) });
(lay(&d), id)
};
let (l, id) = form(Wrap::InFrontOfText, 1, 0.0);
let b = box_rect(&l, id);
let (cx, cy) = (b.x + b.w / 2.0, b.y + b.h / 2.0);
// Inside the box: its text, not the picture under it.
assert!(l.object_at(0, cx, cy, 4.0).is_none());
assert_eq!(l.story_at(0, cx, cy), Some(StoryRef::Part(id)));
// The box's border grabs the box; the picture around the box grabs the picture.
assert_eq!(l.object_at(0, b.x + 1.0, cy, 4.0).map(|o| o.text_box), Some(Some(id)));
assert_eq!(l.object_at(0, cx, b.y - 40.0, 4.0).map(|o| o.text_box), Some(None));
// A picture in front of the box still grabs where it covers it.
let (l, id) = form(Wrap::InFrontOfText, 3, 0.0);
let b = box_rect(&l, id);
assert_eq!(l.object_at(0, b.x + b.w / 2.0, b.y + b.h / 2.0, 4.0).map(|o| o.text_box), Some(None));
// A box turned a quarter covers a tall strip: a press in it, below its unturned frame, is its
// text for both the object and the story hit test.
let (l, id) = form(Wrap::InFrontOfText, 1, 90.0);
let b = box_rect(&l, id);
let (cx, y) = (b.x + b.w / 2.0, b.y + b.h / 2.0 + 80.0);
assert!(!b.contains(wordcraft_geom::Point::new(cx, y)), "{b:?}");
assert!(l.object_at(0, cx, y, 4.0).is_none());
assert_eq!(l.story_at(0, cx, y), Some(StoryRef::Part(id)));
assert_eq!(l.hit(0, cx, y, StoryRef::Part(id)).map(|p| p.story), Some(StoryRef::Part(id)));
// Both behind the text, away from the body text: the same, and a picture stacked above the
// box still grabs.
let (l, id) = form(Wrap::BehindText, 1, 0.0);
let b = box_rect(&l, id);
let (cx, cy) = (b.x + b.w / 2.0, b.y + b.h / 2.0);
assert!(l.object_at(0, cx, cy, 4.0).is_none());
assert_eq!(l.story_at(0, cx, cy), Some(StoryRef::Part(id)));
let (l, id) = form(Wrap::BehindText, 3, 0.0);
let b = box_rect(&l, id);
assert_eq!(l.object_at(0, b.x + b.w / 2.0, b.y + b.h / 2.0, 4.0).map(|o| o.text_box), Some(None));
}
/// (lines placed, lines laid out) of a text box's story, and its area.
fn box_lines(l: &DocLayout, id: u32) -> (usize, usize, wordcraft_geom::Rect) {
let mut shown = 0;
let mut total = 0;
for it in &l.pages[0].items {
if let Placed::Lines { story: StoryRef::Part(p), para, l0, l1, y, .. } = it
&& *p == id
{
shown += l1 - l0;
total += para.lines.len();
let first = ¶.lines[*l0];
let last = ¶.lines[l1 - 1];
let bottom = y + last.top + last.height - first.top;
let r = box_rect(l, id);
assert!(bottom <= r.bottom() + 0.5 || shown == 1, "a placed line overflows: {bottom} > {}", r.bottom());
}
}
(shown, total, box_rect(l, id))
}
#[test]
fn text_box_hides_text_that_does_not_fit() {
crate::test_fonts();
let long = "The quick brown fox jumps over the lazy dog. ".repeat(12);
let mut d = Document::from_text("Body");
let id = text_box(&mut d, 0, &long, 144.0, 72.0, Default::default());
let (shown, total, r) = box_lines(&lay(&d), id);
assert!(shown >= 2 && shown < total, "{shown} of {total} lines shown in {r:?}");
// Nothing below the box belongs to it.
let l = lay(&d);
assert_ne!(l.story_at(0, r.x + 20.0, r.bottom() + 6.0), Some(StoryRef::Part(id)));
// A taller box shows more; a tiny one still shows its first line.
let mut d2 = Document::from_text("Body");
let id2 = text_box(&mut d2, 0, &long, 144.0, 1500.0, Default::default());
let (shown2, total2, _) = box_lines(&lay(&d2), id2);
assert_eq!(shown2, total2);
let mut d3 = Document::from_text("Body");
let id3 = text_box(&mut d3, 0, &long, 144.0, 18.0, Default::default());
assert_eq!(box_lines(&lay(&d3), id3).0, 1);
}
#[test]
fn square_wrap_flows_text_on_both_sides() {
crate::test_fonts();
let float = |x: f32| wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x,
y: 0.0,
dist: 9.0,
..Default::default()
};
let text = "Words flow on both sides of the box in the middle here. ".repeat(20);
let mut d = Document::from_text(&text);
let id = text_box(&mut d, 0, "Middle", 144.0, 100.0, float(160.0));
let l = lay(&d);
let r = box_rect(&l, id);
let Placed::Lines { para, x, y, .. } = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { story: StoryRef::Body, .. })).unwrap() else {
panic!()
};
let beside: Vec<¶::Line> = para.lines.iter().filter(|ln| ln.beside).collect();
assert!(beside.len() >= 4, "{} rows have text on the far side", beside.len());
for (k, ln) in para.lines.iter().enumerate().filter(|(_, ln)| ln.beside) {
let prev = ¶.lines[k - 1];
assert_eq!((prev.top, prev.height), (ln.top, ln.height), "one row");
assert!(x + ink_end(para, prev) <= r.x + 0.01, "left part stops before the box");
assert!(x + ln.xs[0] >= r.right(), "right part starts after it");
assert_eq!(prev.stop, ln.start, "text runs left part, then right part");
}
// Below the box: full-width rows again.
let below = para.lines.iter().find(|ln| y + ln.top > r.bottom() + 10.0).unwrap();
assert!(!below.beside && below.right - below.left > 400.0);
// The right-hand part is hittable and has a caret.
let ln = beside[0];
let pos = l.hit(0, x + ln.xs[1], y + ln.top + 2.0, StoryRef::Body).unwrap();
assert!(pos.off >= ln.start && pos.off <= ln.stop, "{pos:?}");
assert!(l.caret(&pos).unwrap().x >= r.right());
// A gap too narrow for text stays empty.
let mut d2 = Document::from_text(&text);
let id2 = text_box(&mut d2, 0, "Edge", 144.0, 100.0, float(468.0 - 144.0 - 20.0));
let l2 = lay(&d2);
let r2 = box_rect(&l2, id2);
let Placed::Lines { para, x, .. } = l2.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { story: StoryRef::Body, .. })).unwrap() else {
panic!()
};
assert!(para.lines.iter().all(|ln| !ln.beside && ink_end(para, ln) <= (r2.x - x).max(ln.right) + 0.01));
}
/// #1376: a word too long for the strip beside a square-wrapped object moves on whole (to the
/// row's next strip, or the next row) instead of being split across the strip; words that fit
/// still use it, and a word wider than the whole line still breaks where it is.
#[test]
fn a_word_too_wide_for_the_strip_beside_a_float_moves_on_whole() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, ShapeKind, Wrap};
// A `w` x 150pt square at `x` in the 468pt column, leaving a 32pt strip on its right. Each
// line: (top, left, beside the object's far side, ends inside a word, where its text ends).
let lines = |text: &str, x: f32, w: f32| {
let mut d = Document::from_text(&text.repeat(6));
let float = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x, ..Default::default() };
let shape = InlineObject::Shape {
kind: ShapeKind::Rectangle,
w,
h: 150.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
effects: Default::default(),
freeform: None,
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { story: StoryRef::Body, .. })) else {
panic!()
};
let split = |ln: ¶::Line| ln.end == para::LineEnd::Wrap && ln.c1 > ln.c0 && !para.clusters[ln.c1 - 1].break_after;
para.lines.iter().map(|ln| (ln.top, ln.left, ln.beside, split(ln), ink_end(para, ln))).collect::<Vec<_>>()
};
let long = "La presente procedura descrive le modalità della documentazione sanitaria del reparto e delle responsabilità degli operatori. ";
// The strip right of the object, after the text on its left.
let right = lines(long, 468.0 - 150.0 - 32.0, 150.0);
assert!(right.iter().all(|l| !l.3 && l.4 <= 468.01), "{right:?}");
let short = lines("It is so, as it is to be, if we go on. ", 468.0 - 150.0 - 32.0, 150.0);
assert!(short.iter().any(|l| l.2) && short.iter().all(|l| !l.3), "{short:?}");
// The strip is the row's only span: long words go below the object.
let only = lines(long, 0.0, 468.0 - 32.0);
assert!(only.iter().all(|l| !l.3 && (l.0 >= 150.0 - 0.01 || l.1 >= 468.0 - 32.0 - 0.01)), "{only:?}");
assert!(only.iter().any(|l| l.0 >= 150.0 - 0.01 && l.1 < 1.0), "{only:?}");
// A word wider than the whole line breaks where it is, beside the object.
let huge = lines(&format!("{} ", "x".repeat(120)), 468.0 - 150.0 - 32.0, 150.0);
assert!(huge[0].0 < 1.0 && huge.iter().any(|l| l.3), "{huge:?}");
// The strip left of the object: a skipped strip leaves the row's other span its first line.
let left = lines(long, 32.0, 150.0);
assert!(left.iter().all(|l| !l.3) && left.iter().any(|l| l.0 < 150.0 && l.1 >= 182.0 - 0.01 && !l.2), "{left:?}");
// Rows go down the page, and a line beside the object shares its row with the line before it.
for ls in [&right, &short, &only, &huge, &left] {
assert!(ls.windows(2).all(|w| if w[1].2 { w[1].0 == w[0].0 } else { w[1].0 > w[0].0 }), "{ls:?}");
}
}
/// Where a line's text ends (its last non-space cluster's right edge; trailing spaces may hang
/// past the margin), relative to the column.
fn ink_end(pl: &ParaLayout, ln: ¶::Line) -> f32 {
(ln.c0..ln.c1)
.filter_map(|k| {
let c = pl.clusters.get(k)?;
(c.kind != para::ClKind::Space).then_some(ln.xs.get(k - ln.c0)? + c.adv)
})
.fold(0.0, f32::max)
}
fn footnote(d: &mut Document, pos: &Pos, text: &str) -> u32 {
let id =
d.add_part(wordcraft_doc::PartKind::Footnote, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))]);
d.insert_object(pos, InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: String::new() }, &Default::default())
.unwrap();
id
}
fn page_float(x: f32, y: f32) -> wordcraft_doc::para::Float {
wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::InFrontOfText,
h_rel: wordcraft_doc::para::Anchor::Page,
v_rel: wordcraft_doc::para::Anchor::Page,
x,
y,
dist: 0.0,
..Default::default()
}
}
#[test]
fn text_boxes_show_in_headers_footers_cells_and_notes() {
crate::test_fonts();
let mut d = Document::from_text(&"Body paragraph.\n".repeat(4));
// Header: an inline box and a box placed on the page.
let hid =
d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Head", Default::default()))]);
d.last_section.headers.default = Some(hid);
let e = d.end_of(StoryRef::Part(hid));
let inline = text_box_at(&mut d, &e, "Inline in header", 100.0, 30.0, Default::default());
let e = d.end_of(StoryRef::Part(hid));
let placed = text_box_at(&mut d, &e, "On the page", 100.0, 40.0, page_float(400.0, 20.0));
// Footer: a box placed on the page (the footer is laid out twice to find it).
let fid =
d.add_part(wordcraft_doc::PartKind::Footer, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Foot", Default::default()))]);
d.last_section.footers.default = Some(fid);
let e = d.end_of(StoryRef::Part(fid));
let in_footer = text_box_at(&mut d, &e, "Footer box", 100.0, 30.0, page_float(300.0, 740.0));
// A table cell and a footnote.
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(wordcraft_doc::Table::new(1, 1, 300.0))).unwrap();
let cell = Pos { story: StoryRef::Body, path: Path(vec![1, 0, 0, 0]), off: 0 };
let in_cell = text_box_at(&mut d, &cell, "In a cell", 120.0, 30.0, Default::default());
let note = footnote(&mut d, &Pos::body(0, 4), "Note: ");
let e = d.end_of(StoryRef::Part(note));
let in_note = text_box_at(&mut d, &e, "In a note", 120.0, 30.0, Default::default());
let l = lay(&d);
let p = &l.pages[0];
let shows =
|id: u32| p.header.iter().chain(&p.footer).chain(&p.items).any(|i| matches!(i, Placed::Lines { story: StoryRef::Part(s), .. } if *s == id));
for (name, id) in
[("inline header box", inline), ("page header box", placed), ("footer box", in_footer), ("cell box", in_cell), ("note box", in_note)]
{
assert!(shows(id), "{name}: no text");
assert!(l.caret(&d.start_of(StoryRef::Part(id))).is_some(), "{name}: no caret");
}
// Page-anchored boxes land where they say, header and footer alike; their shapes are drawn.
assert_eq!(l.text_box(placed, 0).map(|o| (o.rect.x, o.rect.y)), Some((400.0, 20.0)));
assert_eq!(l.text_box(in_footer, 0).map(|o| (o.rect.x, o.rect.y)), Some((300.0, 740.0)));
assert!(p.header.iter().any(|i| matches!(i, Placed::Shape { rect, .. } if rect.x == 400.0)));
// Header boxes are found for clicks while editing the header.
let r = l.text_box(inline, 0).unwrap().rect;
assert_eq!(l.header_footer_text_box_at(0, r.x + 5.0, r.y + 5.0), Some(inline));
}
#[test]
fn footnotes_inside_text_boxes_are_numbered_and_placed() {
crate::test_fonts();
let mut d = Document::from_text(&"Body text line.\n".repeat(30));
let id = text_box_at(&mut d, &Pos::body(2, 0), "Box text", 144.0, 40.0, Default::default());
let e = d.end_of(StoryRef::Part(id));
let in_box = footnote(&mut d, &e, "Note from the box.");
let after = footnote(&mut d, &Pos::body(5, 4), "Note from the body.");
let l = lay(&d);
// Both notes are at the bottom of page 1, the box's first (reading order).
let a = l.caret(&d.start_of(StoryRef::Part(in_box))).expect("the box's footnote is placed");
let b = l.caret(&d.start_of(StoryRef::Part(after))).unwrap();
assert_eq!((a.page, b.page), (0, 0));
assert!(a.top > 600.0 && a.top < b.top, "{a:?} {b:?}");
let nums = note_numbers(&d, HideDeleted::default());
assert_eq!((nums.get(&in_box), nums.get(&after)), (Some(&1), Some(&2)));
}
/// A document whose text box `ids[k]` holds `fan` shapes showing `ids[k + 1]` (the last one shows
/// itself, `fan` times): crafted, since the app never builds these.
fn box_fan_out(levels: usize, fan: usize) -> Document {
let (w, h) = (40.0, 20.0);
let mut d = Document::from_text("Body");
let ids: Vec<u32> = (0..levels)
.map(|k| {
d.add_part(
wordcraft_doc::PartKind::TextBox,
vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("Level {k}"), Default::default()))],
)
})
.collect();
let shape = |story| InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::TextBox,
w,
h,
fill: None,
stroke: None,
stroke_width: 0.0,
float: Default::default(),
story: Some(story),
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
for (k, id) in ids.iter().enumerate() {
let next = *ids.get(k + 1).unwrap_or(id);
for _ in 0..fan {
d.insert_object(&Pos { story: StoryRef::Part(*id), path: Path::top(0), off: 0 }, shape(next), &Default::default()).unwrap();
}
}
d.insert_object(&Pos::body(0, 0), shape(ids[0]), &Default::default()).unwrap();
d
}
#[test]
fn self_showing_and_fanned_out_text_boxes_stay_bounded() {
crate::test_fonts();
// A box whose 30 shapes all show itself: laid out once.
assert_eq!(lay(&box_fan_out(1, 30)).text_boxes, 1);
// Chains of boxes each showing the next 30 times (30^4 expansions unbounded).
let d = box_fan_out(5, 30);
let l = lay(&d);
assert!(l.text_boxes <= 1 + wordcraft_doc::BoxBudget::MAX_NESTED, "{} boxes laid out", l.text_boxes);
// Footnote numbering's walk is bounded the same way.
let mut visits = 0usize;
d.objects_in_reading_order(&mut |_| visits += 1);
assert!(visits < 5_000, "{visits} visits");
}
#[test]
fn many_text_boxes_and_a_header_box_all_show() {
crate::test_fonts();
// Outermost boxes aren't budgeted: a long document's boxes, and its header's on every page,
// all get their text.
let mut d = Document::from_text("Paragraph with a box.");
for _ in 1..400 {
let end = d.end_of(StoryRef::Body);
d.split_paragraph(&end).unwrap();
}
let ids: Vec<u32> = (0..400).map(|k| text_box_at(&mut d, &Pos::body(k, 0), &format!("Box {k}"), 100.0, 30.0, Default::default())).collect();
let hid =
d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Head", Default::default()))]);
d.last_section.headers.default = Some(hid);
let e = d.end_of(StoryRef::Part(hid));
let in_header = text_box_at(&mut d, &e, "Header box", 100.0, 30.0, Default::default());
let l = lay(&d);
assert!(l.pages.len() >= 10, "{} pages", l.pages.len());
for id in ids {
assert!(l.caret(&d.start_of(StoryRef::Part(id))).is_some(), "box {id} has no text");
}
for (i, p) in l.pages.iter().enumerate() {
let shown = p.header.iter().any(|it| matches!(it, Placed::Lines { story: StoryRef::Part(s), .. } if *s == in_header));
assert!(shown, "page {i}: the header box has no text");
}
}
#[test]
fn a_text_box_inside_a_text_box_still_shows_its_text() {
crate::test_fonts();
let mut d = Document::from_text("Body");
let outer = text_box(&mut d, 0, "Outer ", 300.0, 200.0, Default::default());
let e = d.end_of(StoryRef::Part(outer));
let inner = text_box_at(&mut d, &e, "Inner", 120.0, 40.0, Default::default());
let l = lay(&d);
assert_eq!(l.text_boxes, 2);
assert!(l.caret(&d.start_of(StoryRef::Part(inner))).is_some(), "the inner box's text is laid out");
}
fn picture(w: f32, h: f32, float: wordcraft_doc::para::Float) -> InlineObject {
InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w,
h,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
}
}
#[test]
fn line_spacing_does_not_scale_pictures() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
let mut d = Document::from_text("");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.props.line_spacing = Some(LineSpacing::Multiple(1.15));
p.insert_object(0, picture(144.0, 144.0, Default::default()), &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let line = ¶.lines[0];
let natural = para.styles[0].ascent + para.styles[0].descent;
// Word, measured (Aptos, Arial, Times; 10 and 20 pt; single, 1.15, 1.5): a line of only a
// picture is the picture plus the spacing's share of the text's height, with no descent below
// it, not (picture + descent) x 1.15.
assert!((line.height - (144.0 + 0.15 * natural)).abs() < 0.01, "line {} for a 144pt picture (text {natural})", line.height);
assert!((line.baseline - line.top - 144.0).abs() < 0.01, "the picture stands on the baseline");
}
#[test]
fn multiple_line_spacing_adds_its_leading_below_the_text() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
// (spacing, expected baseline below the line top as a share of the ascent)
for (spacing, share) in [(LineSpacing::Multiple(1.15), 1.0), (LineSpacing::Multiple(2.0), 1.0), (LineSpacing::Multiple(0.8), 0.8)] {
let mut d = Document::from_text(&"Several words wrap onto more lines. ".repeat(30));
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.props.line_spacing = Some(spacing);
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let asc = para.styles[0].ascent;
assert!(para.lines.len() > 1);
for line in ¶.lines {
// Word's 1.15-spaced Times New Roman 12pt sits one ascent below the line top; the
// 0.15 extra goes below the descent (docxide-pdf's hyphenation fixtures).
assert!(
(line.baseline - line.top - asc * share).abs() < 0.01,
"{spacing:?}: baseline {} below the top, ascent {asc}",
line.baseline - line.top
);
}
}
// Exact spacing still keeps the descent below the baseline.
let mut d = Document::from_text("Exact");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.props.line_spacing = Some(LineSpacing::Exactly(30.0));
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let line = ¶.lines[0];
assert!((line.top + line.height - line.baseline - para.styles[0].descent).abs() < 0.01);
}
#[test]
fn list_label_does_not_inflate_an_inline_picture_floor() {
crate::test_fonts();
use wordcraft_doc::props::{LineSpacing, NumRef};
for spacing in [LineSpacing::Multiple(1.25), LineSpacing::AtLeast(12.0)] {
let mut d = Document::from_text("");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Bullet);
Arc::make_mut(&mut d.numbering).abstracts[0].levels[0].chr.size = Some(24.0);
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.props.line_spacing = Some(spacing);
p.props.numbering = Some(NumRef { num: id, level: 0 });
p.insert_object(0, picture(144.0, 144.0, Default::default()), &Default::default()).unwrap();
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let line = ¶.lines[0];
let st = ¶.styles[para.clusters[0].style as usize];
let label = para.label.as_ref().unwrap().runs.iter().map(|r| ¶.styles[r.style as usize]);
let (a, d) = label.fold((st.ascent, st.descent), |(a, d), s| (a.max(s.ascent), d.max(s.descent)));
// Multiple spacing: the picture plus its share of the font's height, the label's being a
// font too (Word, measured: 144 pt at 1.25 with a 24 pt label takes 144 + 0.25 * 27.6);
// at least: the picture and the descent.
let want = match spacing {
LineSpacing::Multiple(m) => 144.0 + (m - 1.0) * (a + d),
_ => 144.0 + st.descent,
};
assert!((line.height - want).abs() < 0.01, "{spacing:?}: {} (want {want})", line.height);
assert!((line.baseline - line.top - 144.0).abs() < 0.01);
}
}
#[test]
fn a_line_of_only_pictures_keeps_its_fonts_height_in_odt_documents() {
// The standard has no line-height algorithm: as in Word, the line keeps the font's height, and
// takes a taller picture's.
let height = |h: f32| {
let mut d = Document::from_text("");
d.settings.odf = Some(wordcraft_doc::OdfLayout::default());
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.props.space_after = Some(0.0);
p.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Multiple(1.0));
p.insert_object(0, picture(200.0, h, Default::default()), &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
para.lines[0].height
};
assert!(height(3.5) > 10.0);
assert!((height(40.0) - 40.0).abs() < 0.01, "{}", height(40.0));
}
#[test]
fn padding_without_a_border_takes_room_in_odt_documents() {
// LibreOffice keeps a paragraph's padding on a side without a line; Word drops it.
let place = |odf: bool| {
let mut d = Document::from_text("Above\nPadded\nBelow");
d.settings.odf = odf.then_some(wordcraft_doc::OdfLayout::default());
for b in d.body.iter_mut() {
if let wordcraft_doc::Block::Para(p) = std::sync::Arc::make_mut(b) {
(p.props.space_before, p.props.space_after) = (Some(0.0), Some(0.0));
}
}
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(1).map(std::sync::Arc::make_mut) {
let pad = wordcraft_doc::props::Border { style: wordcraft_doc::props::BorderStyle::None, width: 0.0, color: None, space: 20.0 };
p.props.borders = Some(wordcraft_doc::props::Borders::box_(pad));
}
let l = lay(&d);
let padded = l.caret(&Pos::body(1, 0)).unwrap();
(padded.x, padded.top, l.caret(&Pos::body(2, 0)).unwrap().top)
};
let (x, top, below) = place(false);
let (px, ptop, pbelow) = place(true);
assert!((px - x - 20.0).abs() < 0.01 && (ptop - top - 20.0).abs() < 0.01, "{x} {top} → {px} {ptop}");
assert!((pbelow - below - 40.0).abs() < 0.01, "{below} → {pbelow}");
}
#[test]
fn body_starts_right_below_a_tall_header() {
crate::test_fonts();
let mut d = Document::from_text("Body");
let mut hp = wordcraft_doc::Paragraph::with_text("", Default::default());
hp.insert_object(0, picture(100.0, 80.0, Default::default()), &Default::default()).unwrap();
hp.props.space_after = Some(0.0);
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(hp)]);
d.last_section.headers.default = Some(id);
let l = lay(&d);
let Some(Placed::Lines { para, y, .. }) = l.pages[0].header.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let header_bottom = y + para.height;
assert!(header_bottom > d.last_section.margin_top, "the header reaches past the top margin");
// No gap: the body's first paragraph starts where the header ends (Word).
let body_y = |l: &DocLayout| {
l.pages[0].items.iter().find_map(|i| if let Placed::Lines { y, story: StoryRef::Body, .. } = i { Some(*y) } else { None }).unwrap()
};
let body = body_y(&l);
assert!((body - header_bottom).abs() < 0.01, "body at {body}, header ends at {header_bottom}");
// ODF's header spacing stays below it.
d.last_section.header_gap = 14.0;
let body = body_y(&lay(&d));
assert!((body - header_bottom - 14.0).abs() < 0.01, "body at {body}, header ends at {header_bottom}");
}
#[test]
fn inline_picture_keeps_room_for_its_effects() {
crate::test_fonts();
let mut d = Document::from_text("");
let shadow = wordcraft_doc::para::Float { effect: [6.0, 12.0, 18.0, 27.0], ..Default::default() };
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.insert_object(0, picture(100.0, 50.0, shadow.clone()), &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let c = para.clusters.iter().find(|c| matches!(c.kind, para::ClKind::Object(_))).unwrap();
assert_eq!((c.adv, c.obj_h), (124.0, 89.0), "picture plus effect extents");
// Drawn inside that room.
let obj = picture(100.0, 50.0, shadow);
let r = display::inline_rect(Some(&obj), 10.0, 200.0, c.adv, (c.obj_h, c.obj_d), c.adv, true);
assert_eq!((r.x, r.y, r.w, r.h), (16.0, 123.0, 100.0, 50.0));
}
#[test]
fn an_inline_picture_moves_with_its_runs_position() {
// Word moves an inline picture up or down with its run's position (`w:position`): lowered,
// it reaches below the baseline and the line grows down to hold it; raised, it rises off it.
let line_of = |position: f32| {
let mut d = Document::from_text("");
let props = wordcraft_doc::CharProps { position: Some(position), ..Default::default() };
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.insert_object(0, picture(40.0, 30.0, Default::default()), &props).unwrap();
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let c = para.clusters.iter().find(|c| matches!(c.kind, para::ClKind::Object(_))).unwrap().clone();
let line = para.lines[0].clone();
let desc = para.styles[c.style as usize].descent;
(c, line, desc)
};
// On the baseline.
let (c, _, _) = line_of(0.0);
assert_eq!((c.obj_h, c.obj_d), (30.0, 0.0));
// Lowered by its whole height: its top on the baseline, the line deep enough for it.
let (c, line, _) = line_of(-30.0);
assert_eq!((c.obj_h, c.obj_d), (0.0, 30.0));
assert!(line.top + line.height - line.baseline >= 30.0 - 0.01, "{line:?}");
let r = display::inline_rect(Some(&picture(40.0, 30.0, Default::default())), 0.0, 100.0, c.adv, (c.obj_h, c.obj_d), c.adv, true);
assert_eq!((r.y, r.h), (100.0, 30.0));
// Lowered further than that: the line reaches as far down, the picture's top staying on the
// baseline (Word).
let (c, line, _) = line_of(-500.0);
assert_eq!((c.obj_h, c.obj_d), (-470.0, 500.0));
assert!(line.top + line.height - line.baseline >= 500.0 - 0.01, "{line:?}");
let r = display::inline_rect(Some(&picture(40.0, 30.0, Default::default())), 0.0, 100.0, c.adv, (c.obj_h, c.obj_d), c.adv, true);
assert_eq!((r.y, r.h), (100.0, 30.0));
// Raised: it stands clear of the baseline, as tall as before.
let (c, _, _) = line_of(6.0);
assert_eq!((c.obj_h, c.obj_d), (36.0, -6.0));
let r = display::inline_rect(Some(&picture(40.0, 30.0, Default::default())), 0.0, 100.0, c.adv, (c.obj_h, c.obj_d), c.adv, true);
assert_eq!((r.y, r.h), (64.0, 30.0));
}
/// A turned inline picture whose file kept no room for the turn: Word keeps its line to the frame
/// (Word 2007 layout) or to the frame with width and height exchanged near a quarter turn (Word
/// 2013+), and the picture overhangs it. One with room recorded takes its rotated bounds.
#[test]
fn bare_turned_inline_picture_keeps_its_frame() {
let room = |rot: f32, bare_turn: bool, compat: u32| {
let mut d = Document::from_text("");
d.settings.compat_mode = compat;
let float = wordcraft_doc::para::Float { rot, bare_turn, ..Default::default() };
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.insert_object(0, picture(120.0, 60.0, float), &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let c = para.clusters.iter().find(|c| matches!(c.kind, para::ClKind::Object(_))).unwrap();
// Drawn unscaled, centred in that room.
let obj = picture(120.0, 60.0, wordcraft_doc::para::Float { rot, bare_turn, ..Default::default() });
let r = display::inline_rect(Some(&obj), 0.0, 200.0, c.adv, (c.obj_h, c.obj_d), c.adv, compat >= 15);
assert_eq!((r.w, r.h), (120.0, 60.0), "{rot}° bare {bare_turn} compat {compat}");
assert_eq!((r.x + r.w / 2.0, r.y + r.h / 2.0), (c.adv / 2.0, 200.0 - c.obj_h / 2.0));
// Only a bare turn that overhangs its line is cut, at the line's top and bottom.
let overhangs =
bare_turn && (c.obj_h as f64) < 120.0 * (rot as f64).to_radians().sin().abs() + 60.0 * (rot as f64).to_radians().cos().abs() - 0.1;
let clips: Vec<Rect> = display::page_display(&d, &l.pages[0], &Default::default())
.iter()
.filter_map(|i| if let display::Draw::Clip { rect, .. } = i { Some(*rect) } else { None })
.collect();
assert_eq!(clips.len(), usize::from(overhangs), "{rot}° bare {bare_turn} compat {compat}: {clips:?}");
if let Some(band) = clips.first() {
assert!(band.h >= c.obj_h && band.w > 4000.0, "{band:?}");
}
(c.adv.round(), c.obj_h.round())
};
assert_eq!(room(90.0, true, 12), (120.0, 60.0));
assert_eq!(room(45.0, true, 12), (120.0, 60.0));
assert_eq!(room(180.0, true, 12), (120.0, 60.0));
assert_eq!(room(90.0, true, 15), (60.0, 120.0));
assert_eq!(room(45.0, true, 15), (60.0, 120.0));
assert_eq!(room(135.0, true, 15), (120.0, 60.0));
assert_eq!(room(270.0, true, 15), (60.0, 120.0));
// Room recorded (Word's own files, WordCraft's turns): the rotated bounds, in any layout.
assert_eq!(room(90.0, false, 12), (60.0, 120.0));
assert_eq!(room(45.0, false, 15), (127.0, 127.0));
}
/// Tops of the body text lines drawn on page one, in order.
fn line_tops(l: &DocLayout) -> Vec<f32> {
l.pages[0].items.iter().filter_map(|i| if let Placed::Lines { y, story: StoryRef::Body, .. } = i { Some(*y) } else { None }).collect()
}
#[test]
fn at_least_rows_add_cell_margins_and_border_bands() {
crate::test_fonts();
use wordcraft_doc::props::{Border, BorderStyle, Borders, HeightRule};
let mut d = Document::from_text("");
let line = Some(Border { style: BorderStyle::Single, width: 0.5, color: None, space: 0.0 });
let mut t = Table::new(2, 1, 200.0);
t.props.borders = Some(Borders { top: line, left: line, bottom: line, right: line, between: line, inside_v: line });
t.props.cell_margins = Some([5.0, 5.4, 5.0, 5.4]);
for (r, text) in t.rows.iter_mut().zip(["one", "two"]) {
r.props.height = Some(30.0);
r.props.height_rule = HeightRule::AtLeast;
r.cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))];
}
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t))];
let tops = line_tops(&lay(&d));
// Word: a 30pt at-least row with 5pt margins and 0.5pt borders steps 40.5pt, and the text
// starts below the top border and the top margin.
assert!((tops[1] - tops[0] - 40.5).abs() < 0.01, "row pitch {}", tops[1] - tops[0]);
assert!((tops[0] - (72.0 + 0.5 + 5.0)).abs() < 0.01, "first cell text at {}", tops[0]);
}
/// Word gives every cell in a row the row's largest top and bottom margins: a cell without its
/// own lines up with a neighbour that has them, and the row is as tall as if all had them.
#[test]
fn a_row_shares_its_largest_top_and_bottom_margins() {
crate::test_fonts();
let mut d = Document::from_text("");
let mut t = Table::new(3, 2, 300.0);
t.props.cell_margins = Some([0.0, 5.4, 0.0, 5.4]);
t.rows[0].cells[0].props.margins = Some([6.0, 5.4, 3.0, 5.4]);
t.rows[0].cells[1].props.margins = Some([2.0, 5.4, 7.0, 5.4]);
for (ri, row) in t.rows.iter_mut().enumerate() {
for (c, text) in row.cells.iter_mut().zip(["one", "two"]) {
c.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("{text}{ri}"), Default::default()))];
}
}
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t))];
let tops = line_tops(&lay(&d));
assert_eq!(tops.len(), 6, "{tops:?}");
assert!((tops[0] - tops[1]).abs() < 0.01, "both cells start 6pt down: {tops:?}");
assert!((tops[0] - (72.0 + 0.5 + 6.0)).abs() < 0.01, "below the 0.5pt top border: {tops:?}");
// The rows below have no margins: the second is one line tall, and the first is a line plus
// 6pt above and 7pt below it.
let line = tops[4] - tops[2];
assert!((tops[2] - tops[0] - (line + 7.0)).abs() < 0.01, "{tops:?}");
}
/// An exact row height gains only the bottom cell margin (Word: a 35pt exact row with 4pt top
/// and bottom margins steps 39pt; the text starts 4pt below its top).
#[test]
fn exact_rows_add_only_the_bottom_margin() {
crate::test_fonts();
use wordcraft_doc::props::HeightRule;
let mut d = Document::from_text("");
let mut t = Table::new(2, 1, 200.0);
t.props.cell_margins = Some([4.0, 5.4, 4.0, 5.4]);
for (r, text) in t.rows.iter_mut().zip(["one", "two"]) {
r.props.height = Some(35.0);
r.props.height_rule = HeightRule::Exact;
r.cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))];
}
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t))];
let tops = line_tops(&lay(&d));
assert!((tops[1] - tops[0] - 39.0).abs() < 0.01, "row pitch {}", tops[1] - tops[0]);
assert!((tops[0] - (72.0 + 0.5 + 4.0)).abs() < 0.01, "first cell text at {}", tops[0]);
}
/// A 63.6 pt exact row moves whole to page two with only 50 pt left and stays on page one with
/// 90 pt.
#[test]
fn exact_row_moves_whole() {
crate::test_fonts();
use wordcraft_doc::props::HeightRule;
let mut t = Table::new(1, 1, 400.0);
t.rows[0].props.height = Some(63.6);
t.rows[0].props.height_rule = HeightRule::Exact;
for height in [40.0, 50.0] {
let mut p = wordcraft_doc::Paragraph::with_text("", Default::default());
p.insert_object(0, picture(30.0, height, Default::default()), &Default::default()).unwrap();
t.rows[0].cells[0].blocks.push(wordcraft_doc::para_block(p));
}
// The same intact row moves with only 50pt left, and stays when 90pt is available.
for (room, expected_page) in [(50.0, 1), (90.0, 0)] {
assert_eq!(room < 63.6, expected_page == 1);
let mut d = pagination_filler_leaving(room);
let end = d.body.len();
d.insert_block(StoryRef::Body, &Path::top(end), wordcraft_doc::Block::Table(t.clone())).unwrap();
let l = lay(&d);
assert_pagination_fixture_font(&l);
let row_pages: Vec<_> = l
.pages
.iter()
.enumerate()
.flat_map(|(page, p)| p.items.iter().filter_map(move |i| matches!(i, Placed::Cell { row: 0, .. }).then_some(page)))
.collect();
assert_eq!(
row_pages,
vec![expected_page],
"Word keeps an exact row whole; available={room} height=63.6{}",
pagination_fixture_diagnostics("exact_row_moves_whole", Some(&d), &l)
);
}
}
/// `cell_margins` is what the layout uses: a cell's own margins, else the table's, else Word's;
/// each cell's text starts its left margin inside the cell.
#[test]
fn cell_margins_are_where_cell_text_starts() {
crate::test_fonts();
let mut d = Document::from_text("");
let mut t = Table::new(1, 2, 300.0);
t.props.cell_margins = Some([0.0, 9.0, 0.0, 3.0]);
t.rows[0].cells[1].props.margins = Some([0.0, 20.0, 0.0, 4.0]);
for (c, text) in t.rows[0].cells.iter_mut().zip(["one", "two"]) {
c.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))];
}
assert_eq!(cell_margins(&d, &t, 0, 0), [0.0, 9.0, 0.0, 3.0]);
assert_eq!(cell_margins(&d, &t, 0, 1), [0.0, 20.0, 0.0, 4.0]);
assert_eq!(cell_margins(&d, &t, 5, 9), [0.0, 9.0, 0.0, 3.0], "no such cell: the table's");
assert_eq!(cell_margins(&d, &Table::new(1, 1, 100.0), 0, 0), [0.0, 5.4, 0.0, 5.4], "Word's");
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t.clone()))];
let l = lay(&d);
let items = &l.pages[0].items;
for c in 0..2 {
let boxed = items.iter().find_map(|it| match it {
Placed::Cell { rect, cell, .. } if *cell == c => Some(*rect),
_ => None,
});
let text_x = items.iter().find_map(|it| match it {
Placed::Lines { path, x, .. } if path.0.get(2) == Some(&(c as u32)) => Some(*x),
_ => None,
});
let (boxed, text_x) = (boxed.unwrap(), text_x.unwrap());
assert!((text_x - boxed.x - cell_margins(&d, &t, 0, c)[1]).abs() < 0.01, "cell {c}: text at {text_x}, cell at {}", boxed.x);
}
}
/// Line count and, per line, how far the text (trailing spaces excluded) reaches.
fn justified_lines(text: &str, compat_mode: u32, align: Align) -> (usize, Vec<f32>) {
let mut d = Document::from_text(text);
d.settings.compat_mode = compat_mode;
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.align = Some(align)).unwrap();
let l = lay(&d);
let mut ends = Vec::new();
for p in &l.pages {
for it in &p.items {
if let Placed::Lines { para, l0, l1, x, .. } = it {
for li in *l0..*l1 {
let line = ¶.lines[li];
let content = text[line.start..line.stop].trim_end().len();
ends.push(para.x_of(li, line.start + content).unwrap() + x);
}
}
}
}
(lines_of(&l), ends)
}
#[test]
fn justified_lines_shrink_spaces_in_word_2013_mode() {
crate::test_fonts();
let text = "We tie the spend to a pipe and to the books, so it is in an ad hoc view of all of it. ".repeat(40);
let (modern, ends) = justified_lines(&text, 15, Align::Justify);
let (legacy, legacy_ends) = justified_lines(&text, 14, Align::Justify);
assert!(modern < legacy, "mode 15 fits more per line: {modern} vs {legacy} lines");
// Shrinking only ever pulls a line back inside the margin.
for e in ends.iter().chain(&legacy_ends) {
assert!(*e <= 540.0 + 0.05, "line ends past the right margin: {e}");
}
// Justified lines still reach the margin; the last line is the only short one.
for e in &ends[..ends.len() - 1] {
assert!((*e - 540.0).abs() < 0.05, "justified line ends at {e}");
}
}
/// Spaces before a line's first character keep their width in justified and distributed lines:
/// Thai official letters indent their paragraphs with a run of spaces. Measured in Word (left,
/// `both`, `distribute` and `thaiDistribute`, Thai and Latin text, spaces at the paragraph start,
/// after a line break and after a tab): the first character sits where it does left-aligned, and
/// only the spaces between words stretch. WordCraft stretched the leading spaces too, so the
/// first character of a justified line moved right by up to the line's whole slack. A
/// distributed line also counted the space it wrapped at, so its text stopped short of the margin.
#[test]
fn leading_spaces_keep_their_width_in_justified_lines() {
let spaces = " ".repeat(20);
let body = "We tie the spend to a pipe and to the books, so it is in an ad hoc view of all of it. ".repeat(4);
// `hidden` (zero-width hidden text before the spaces) and `float` (a floating shape anchored
// before them): Word ignores those, and a bookmark, there too; the first character is still
// the one after the spaces.
let first_x = |align: Align, hidden: &str, float: bool| {
let mut d = Document::from_text(&format!("{hidden}{spaces}{body}"));
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.align = Some(align)).unwrap();
if !hidden.is_empty() {
d.format_range(&Pos::body(0, 0), &Pos::body(0, hidden.len()), &|c| c.hidden = Some(true)).unwrap();
}
if float {
d.insert_object(&Pos::body(0, 0), rect_shape(20.0, 20.0, page_float(400.0, 600.0)), &Default::default()).unwrap();
}
let text = d.body[0].as_para().unwrap().text.clone();
let lead = text.len() - body.len();
let l = lay(&d);
let (para, x0) =
l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, x, .. } = it { Some((para.clone(), *x)) } else { None }).unwrap();
assert!(para.lines.len() > 1, "the paragraph wraps");
let line = ¶.lines[0];
// The first line's last character (ASCII here): its index and left and right positions.
let end = line.start + text[line.start..line.stop].trim_end().len();
(para.x_of(0, lead).unwrap(), end, para.x_of(0, end - 1).unwrap() + x0, para.x_of(0, end).unwrap() + x0)
};
for (hidden, float) in [("", false), ("hidden", false), ("", true)] {
let (left, left_end, left_from, left_to) = first_x(Align::Left, hidden, float);
for align in [Align::Justify, Align::Distribute] {
let (x, end, from, _) = first_x(align, hidden, float);
let case = format!("{align:?} hidden {hidden:?} float {float}");
assert!((x - left).abs() < 0.01, "{case}: the first character is at {x}, left-aligned at {left}");
assert_eq!(end, left_end, "{case}: the line breaks where it does left-aligned");
assert!(from > left_from + 1.0, "{case}: the line is still stretched ({from} vs {left_from})");
// The line ends with the space it wrapped at; its last character, keeping its own
// advance, still ends at the margin: no gap is left after it.
let ink_end = from + (left_to - left_from);
assert!((ink_end - 540.0).abs() < 0.05, "{case}: the line's last character ends at {ink_end}, not the margin");
}
}
}
/// Measured in Word for Mac (compatibility mode 15, justified paragraphs of one repeated word,
/// the right indent leaving room for N words plus one more that fits only if the spaces shrink):
/// the spaces give up at most a quarter of their width, and a word with the space before it may
/// overrun the line by at most 0.355 of its own width ("nn" fitted with its line's spaces 14.5%
/// shrunk, "nnnn" with 25%). WordCraft allowed 20% whatever the word, so long words wrapped too
/// early and short ones too late.
#[test]
fn justified_spaces_shrink_a_quarter_at_most_and_by_the_word() {
let chr = wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(12.0), ..Default::default() };
let para = |text: &str, align: Align, right: f32| {
let mut d = Document::new();
d.settings.compat_mode = 15;
let mut p = wordcraft_doc::Paragraph::with_text(text, chr.clone());
p.props = ParaProps { align: Some(align), indent_right: Some(right), ..Default::default() };
d.body = vec![wordcraft_doc::para_block(p)];
d
};
// Words on the first line.
let first = |d: &Document| {
let l = lay(d);
let para = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None }).unwrap();
let line = ¶.lines[0];
d.para(StoryRef::Body, &Path::top(0)).unwrap().text[line.start..line.stop].split_whitespace().count()
};
let n = 12;
for word in ["nn", "nnnn", "nnnnnnnn"] {
// The word's and the space's widths, from a left-aligned line.
let probe = para(&format!("{word} {word}"), Align::Left, 0.0);
let l = lay(&probe);
let pl = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None }).unwrap();
let w = pl.x_of(0, word.len()).unwrap() - pl.x_of(0, 0).unwrap();
let sw = pl.x_of(0, word.len() + 1).unwrap() - pl.x_of(0, word.len()).unwrap();
let spaces = n as f32 * sw;
let room = (0.25 * spaces).min(0.355 * (w + sw));
let width = |overrun: f32| (n + 1) as f32 * w + spaces - overrun;
let text = vec![word; 3 * n].join(" ");
let full = probe.last_section.text_width();
for (overrun, words) in [(room - 0.1, n + 1), (room + 0.1, n)] {
let d = para(&text, Align::Justify, full - width(overrun));
assert_eq!(first(&d), words, "'{word}': overrun {overrun:.2} of {room:.2} allowed");
}
// Left-aligned text never shrinks.
assert_eq!(first(¶(&text, Align::Left, full - width(0.1))), n, "'{word}' left-aligned");
}
}
#[test]
fn space_shrinking_is_only_for_justified_text() {
crate::test_fonts();
let text = "We tie the spend to a pipe and to the books, so it is in an ad hoc view of all of it. ".repeat(40);
for align in [Align::Left, Align::Center, Align::Right] {
assert_eq!(justified_lines(&text, 15, align).0, justified_lines(&text, 14, align).0, "{align:?}");
}
}
/// #3924: a justified line that ends in a manual line break is stretched to the margin like a
/// wrapped one; the last line of the paragraph stays short. `w:doNotExpandShiftReturn` keeps it short.
#[test]
fn justified_line_ending_in_line_break_is_stretched() {
let text = "We tie the spend\nto a pipe";
let ends = |no_expand: bool| {
let mut d = Document::from_text("");
d.settings.do_not_expand_shift_return = no_expand;
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props = ParaProps { align: Some(Align::Justify), ..Default::default() };
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
let mut out = Vec::new();
for pg in &l.pages {
for it in &pg.items {
if let Placed::Lines { para, l0, l1, x, .. } = it {
for li in *l0..*l1 {
let line = ¶.lines[li];
let content = text[line.start..line.stop].trim_end().len();
out.push(para.x_of(li, line.start + content).unwrap() + x);
}
}
}
}
out
};
let stretched = ends(false);
assert_eq!(stretched.len(), 2, "{stretched:?}");
assert!((stretched[0] - 540.0).abs() < 0.05, "the line before the break ends at {}", stretched[0]);
assert!(stretched[1] < 400.0, "the last line stays short: {}", stretched[1]);
let kept = ends(true);
assert_eq!(kept.len(), 2, "{kept:?}");
assert!(kept[0] < 400.0, "doNotExpandShiftReturn keeps the line before the break short: {}", kept[0]);
}
/// A distributed line that ends in a manual line break stretches its characters to the margin, as
/// in Word (measured with a synthetic `distribute` paragraph): the break itself takes no gap.
#[test]
fn distributed_line_ending_in_line_break_reaches_the_margin() {
let first = "We tie the spend";
let text = format!("{first}\nto a pipe");
// The left edge of the first line's last character and the position after it, on the page.
let last = |align: Align| {
let mut d = Document::from_text("");
let mut p = wordcraft_doc::Paragraph::with_text(&text, Default::default());
p.props = ParaProps { align: Some(align), ..Default::default() };
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
let (para, x) =
l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, x, .. } = it { Some((para.clone(), *x)) } else { None }).unwrap();
(para.x_of(0, first.len() - 1).unwrap() + x, para.x_of(0, first.len()).unwrap() + x)
};
let (left_from, left_to) = last(Align::Left);
let (from, _) = last(Align::Distribute);
// The last character keeps its own advance and ends at the margin: no gap is left after it.
let ink_end = from + (left_to - left_from);
assert!((ink_end - 540.0).abs() < 0.05, "the line's last character ends at {ink_end}, not the margin");
}
#[test]
fn lines_with_tabs_never_shrink() {
crate::test_fonts();
let text = "Item\tWe tie the spend to a pipe and to the books, so it is in an ad hoc view of all of it. ".repeat(30);
let (modern, _) = justified_lines(&text, 15, Align::Justify);
let (legacy, _) = justified_lines(&text, 14, Align::Justify);
assert!(modern <= legacy);
let (_, ends) = justified_lines(&text, 15, Align::Justify);
for e in &ends {
assert!(*e <= 540.0 + 0.05, "{e}");
}
}
pub(super) fn rect_shape(w: f32, h: f32, float: wordcraft_doc::para::Float) -> InlineObject {
InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w,
h,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
}
}
pub(super) fn shapes(items: &[Placed]) -> Vec<Rect> {
items.iter().filter_map(|i| if let Placed::Shape { rect, .. } = i { Some(*rect) } else { None }).collect()
}
/// Top of the first body line drawn on a page.
fn first_line_top(items: &[Placed]) -> f32 {
items.iter().find_map(|i| if let Placed::Lines { y, story: StoryRef::Body, .. } = i { Some(*y) } else { None }).unwrap()
}
#[test]
fn floats_align_within_their_reference_area() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, FloatAlign, Wrap};
let mut d = Document::from_text("Some text beside the pictures.");
let centred = Float { wrap: Wrap::InFrontOfText, h_rel: Anchor::Margin, h_align: Some(FloatAlign::Center), x: 999.0, ..Default::default() };
let right = Float { wrap: Wrap::InFrontOfText, h_rel: Anchor::Page, h_align: Some(FloatAlign::End), ..Default::default() };
let in_left_margin = Float { wrap: Wrap::InFrontOfText, h_rel: Anchor::LeftMargin, x: 10.0, ..Default::default() };
let bottom = Float { wrap: Wrap::InFrontOfText, v_rel: Anchor::BottomMargin, v_align: Some(FloatAlign::Start), ..Default::default() };
for f in [centred, right, in_left_margin, bottom] {
d.insert_object(&Pos::body(0, 0), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
}
let l = lay(&d);
// Objects are inserted at the start, so they come out in reverse order.
let r = shapes(&l.pages[0].items);
assert_eq!(r.len(), 4, "{r:?}");
assert!((r[3].x - (72.0 + (468.0 - 100.0) / 2.0)).abs() < 0.01, "centred in the margins: {:?}", r[3]);
assert!((r[2].right() - 612.0).abs() < 0.01, "right edge of the page: {:?}", r[2]);
assert!((r[1].x - 10.0).abs() < 0.01, "measured from the page's left edge: {:?}", r[1]);
assert!((r[0].y - (792.0 - 72.0)).abs() < 0.01, "top of the bottom margin: {:?}", r[0]);
}
#[test]
fn top_and_bottom_float_pushes_its_own_first_line_down() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&"Text that starts below the picture. ".repeat(10));
let f = Float { wrap: Wrap::TopAndBottom, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist_bottom: 6.0, ..Default::default() };
d.insert_object(&Pos::body(0, 0), rect_shape(144.0, 100.0, f), &Default::default()).unwrap();
let l = lay(&d);
let r = shapes(&l.pages[0].items)[0];
let top = first_line_top(&l.pages[0].items);
assert!(top >= r.bottom() + 6.0 - 0.01, "first line {top} drawn under the picture ending at {}", r.bottom());
// The caret agrees with what is drawn.
let c = l.caret(&Pos::body(0, 4)).unwrap();
assert!((c.top - top).abs() < 2.0, "{c:?} vs {top}");
}
#[test]
fn float_follows_its_paragraph_to_the_next_page() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&format!("First page.\n{}", "Text beside the picture on page two. ".repeat(20)));
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(1, 0), rect_shape(144.0, 100.0, f), &Default::default()).unwrap();
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(1).map(std::sync::Arc::make_mut) {
p.props.page_break_before = Some(true);
}
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
assert!(shapes(&l.pages[0].items).is_empty());
let r = shapes(&l.pages[1].items)[0];
assert!((r.y - 72.0).abs() < 0.5, "at the top of page two: {r:?}");
let Placed::Lines { para, .. } = l.pages[1].items.iter().find(|i| matches!(i, Placed::Lines { .. })).unwrap() else { panic!() };
assert!(para.lines[0].left >= 144.0, "text wraps beside it: {}", para.lines[0].left);
}
/// A Word cover page is one paragraph holding a page break and then the page-anchored text box
/// with the title: with nothing after its anchor, the box stays on the cover.
#[test]
fn a_float_anchored_after_a_page_break_stays_on_its_paragraph_s_first_page() {
crate::test_fonts();
let mut d = Document::from_text(&format!("{}\nAfter the cover", wordcraft_doc::para::PAGE_BREAK));
d.insert_object(&Pos::body(0, 1), rect_shape(200.0, 100.0, page_float(100.0, 300.0)), &Default::default()).unwrap();
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
let on_cover = shapes(&l.pages[0].items);
assert_eq!(on_cover.len(), 1, "the shape is drawn on the cover: {on_cover:?}");
assert!((on_cover[0].y - 300.0).abs() < 0.5, "{:?}", on_cover[0]);
assert!(shapes(&l.pages[1].items).is_empty(), "and not again on page two");
}
/// #4262: a bookmark after the box's anchor (or a comment's end, a field's) takes no room: the box
/// still stays on the cover. An inline picture after it does take room: it goes on to page two,
/// and the box with it.
#[test]
fn a_cover_box_stays_on_the_cover_with_a_bookmark_after_it_but_not_with_a_picture() {
let cover = |after: InlineObject| {
let mut d = Document::from_text(&format!("{}\nAfter the cover", wordcraft_doc::para::PAGE_BREAK));
d.insert_object(&Pos::body(0, 1), after, &Default::default()).unwrap();
d.insert_object(&Pos::body(0, 1), rect_shape(200.0, 100.0, page_float(100.0, 300.0)), &Default::default()).unwrap();
let l = lay(&d);
// The floating box; the inline picture is 20 pt wide.
let boxes = |pi: usize| shapes(&l.pages[pi].items).iter().filter(|r| r.w > 100.0).count();
(boxes(0), boxes(1))
};
assert_eq!(cover(InlineObject::BookmarkEnd { name: "_GoBack".into() }), (1, 0), "with a bookmark: on the cover");
assert_eq!(cover(rect_shape(20.0, 20.0, Default::default())), (0, 1), "with an inline picture: on page two");
}
/// #4262: with text after the anchor, though, the line after the break is on the next page, and
/// so is the float anchored at its start. Observed in Word for Mac: a shape dragged beside the
/// first line after a page break inside a paragraph is anchored right after the break and stays
/// on the new page, positioned from the paragraph's top there.
#[test]
fn a_float_anchored_before_text_after_a_page_break_is_drawn_on_the_next_page() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let text = "The quick brown fox jumps over the lazy dog. ";
let mut d = Document::from_text(&format!("{}{}{}", text.repeat(5), wordcraft_doc::para::PAGE_BREAK, text.repeat(5)));
let at = text.len() * 5 + wordcraft_doc::para::PAGE_BREAK.len_utf8();
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 60.0, y: 1.0, ..Default::default() };
d.insert_object(&Pos::body(0, at), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
assert!(shapes(&l.pages[0].items).is_empty(), "not on page one");
let (top, ..) = lines_on(&l, 1)[0];
assert_eq!(shapes(&l.pages[1].items).len(), 1, "drawn once");
let r = shapes(&l.pages[1].items)[0];
assert!((r.y - (top + 1.0)).abs() < 0.5, "1 pt below the paragraph's top on page two ({top}): {r:?}");
}
/// The lines of body paragraph 0 on page `pi`: each one's (top on the page, left, start).
fn lines_on(l: &DocLayout, pi: usize) -> Vec<(f32, f32, usize)> {
let mut out = Vec::new();
for it in &l.pages[pi].items {
if let Placed::Lines { para, l0, l1, y, story: StoryRef::Body, path, .. } = it
&& path.0 == [0]
{
let first = para.lines[*l0].top;
out.extend(para.lines[*l0..*l1].iter().map(|li| (y + li.top - first, li.left, li.start)));
}
}
out
}
/// #4250: a floating object anchored in a line of a long paragraph on a later page is drawn on
/// that page, as Word does (its anchor line's page), not on the page the paragraph starts on.
/// That page's text wraps around it; the page before is laid out as without it.
#[test]
fn a_float_anchored_on_a_later_page_of_its_paragraph_is_drawn_on_that_page() {
use wordcraft_doc::para::Wrap;
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(400));
let plain = lay(&d);
assert!(plain.pages.len() >= 3, "pages {}", plain.pages.len());
let anchor = lines_on(&plain, 1)[5].2;
let f = wordcraft_doc::para::Float { wrap: Wrap::Square, ..page_float(72.0, 300.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
let l = lay(&d);
assert!(shapes(&l.pages[0].items).is_empty(), "not on the page the paragraph starts on");
assert_eq!(l.pages.iter().map(|p| shapes(&p.items).len()).sum::<usize>(), 1, "drawn once");
let on_two = shapes(&l.pages[1].items);
assert_eq!(on_two.len(), 1, "{on_two:?}");
assert!((on_two[0].x - 72.0).abs() < 0.5 && (on_two[0].y - 300.0).abs() < 0.5, "{:?}", on_two[0]);
let beside: Vec<_> = lines_on(&l, 1).into_iter().filter(|(y, ..)| *y > 300.0 && *y < 350.0).collect();
assert!(!beside.is_empty() && beside.iter().all(|(_, left, _)| *left >= 100.0), "the text beside it wraps: {beside:?}");
let starts = |l: &DocLayout| lines_on(l, 0).iter().map(|(_, left, start)| (*left, *start)).collect::<Vec<_>>();
assert_eq!(starts(&l), starts(&plain), "page one is as without it");
// Its hit area is there too, for selecting and dragging it.
let hit = l.object(&Pos::body(0, anchor), 0).expect("laid out");
assert_eq!(hit.page, 1);
}
/// #4250: positioned from its paragraph, a float anchored on a later page of the paragraph is
/// measured from where the paragraph continues on that page (Word saves such a picture dragged
/// onto page two as `relativeFrom="paragraph"` with its offset from that page's top line).
#[test]
fn a_float_from_its_paragraph_on_a_later_page_is_measured_from_the_paragraph_s_top_there() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(400));
let plain = lay(&d);
let (top, _, _) = lines_on(&plain, 1)[0];
let anchor = lines_on(&plain, 1)[8].2;
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 120.0, y: 150.0, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(0, anchor), rect_shape(130.0, 100.0, f), &Default::default()).unwrap();
let l = lay(&d);
assert!(shapes(&l.pages[0].items).is_empty());
let r = shapes(&l.pages[1].items)[0];
assert!((r.y - (top + 150.0)).abs() < 0.5, "150 pt below the paragraph's top on page two ({top}): {r:?}");
assert!((r.x - 192.0).abs() < 0.5, "{r:?}");
let hit = l.object(&Pos::body(0, anchor), 1).expect("laid out");
assert!((hit.origin.y - top).abs() < 0.5, "dragging measures from there too: {:?}", hit.origin);
}
/// #4250: a paragraph starting with a page break has its space before on the new page; a float
/// from its paragraph anchored there is still measured from the paragraph's top, above that
/// space, as on its first page.
#[test]
fn a_float_after_a_leading_page_break_is_measured_from_above_the_space_before() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let text = format!("Page one.\n{}{}", wordcraft_doc::para::PAGE_BREAK, "The quick brown fox jumps over the lazy dog. ".repeat(20));
let mut d = Document::from_text(&text);
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(1).map(std::sync::Arc::make_mut) {
p.props.space_before = Some(24.0);
}
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, y: 150.0, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(1, 200), rect_shape(130.0, 100.0, f), &Default::default()).unwrap();
let l = lay(&d);
assert!(shapes(&l.pages[0].items).is_empty());
let r = shapes(&l.pages[1].items)[0];
assert!((r.y - (72.0 + 150.0)).abs() < 0.5, "150 pt below the top margin: {r:?}");
}
/// #4250, as observed in Word for Mac: lines added at the top of page one push the text down,
/// but a picture positioned from its paragraph on page two stays where it is there.
#[test]
fn text_added_on_page_one_leaves_a_float_on_page_two_where_it_is() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(400));
let anchor = lines_on(&lay(&d), 1)[8].2;
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, y: 150.0, ..Default::default() };
d.insert_object(&Pos::body(0, anchor), rect_shape(130.0, 100.0, f), &Default::default()).unwrap();
let before = shapes(&lay(&d).pages[1].items);
for _ in 0..3 {
d.body.insert(0, wordcraft_doc::para_block(wordcraft_doc::Paragraph::new()));
}
let l = lay(&d);
assert!(shapes(&l.pages[0].items).is_empty());
assert_eq!(shapes(&l.pages[1].items), before);
}
/// #4250: anchored on the third page of a paragraph, a float is drawn on the third page.
#[test]
fn a_float_anchored_two_pages_into_its_paragraph_is_drawn_on_that_page() {
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(600));
let plain = lay(&d);
assert!(plain.pages.len() >= 4, "pages {}", plain.pages.len());
let anchor = lines_on(&plain, 2)[3].2;
let f = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, 300.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
let l = lay(&d);
let per_page: Vec<usize> = l.pages.iter().map(|p| shapes(&p.items).len()).collect();
assert_eq!(&per_page[..3], [0, 0, 1], "{per_page:?}");
assert_eq!(per_page.iter().sum::<usize>(), 1);
}
/// A long paragraph with a long footnote on page one, and a page-placed square float anchored at
/// line `k` of page two as laid out without it.
fn footnoted_float(k: usize) -> DocLayout {
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(400));
let mut note = wordcraft_doc::Paragraph::with_text(&"The note text runs on for a while. ".repeat(30), Default::default()).styled("FootnoteText");
note.props.space_after = Some(0.0);
let id = d.add_part(wordcraft_doc::PartKind::Footnote, vec![wordcraft_doc::para_block(note)]);
d.insert_object(
&Pos::body(0, 4),
InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: String::new() },
&Default::default(),
)
.unwrap();
let anchor = lines_on(&lay(&d), 1)[k].2;
let f = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, 300.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
lay(&d)
}
/// #4250: a footnote on page one leaves less room there than its lines alone suggest; a float
/// anchored a few lines into page two is drawn on page two all the same.
#[test]
fn a_float_anchored_just_past_a_page_of_footnotes_is_drawn_on_the_next_page() {
let l = footnoted_float(3);
assert!(shapes(&l.pages[0].items).is_empty(), "not on page one");
assert_eq!(shapes(&l.pages[1].items).len(), 1);
}
/// #4250: anchored in page two's first line, which goes back to page one once the float no longer
/// wraps the text there, a float stays on page one with the text wrapping around it, not over it.
#[test]
fn a_float_whose_anchor_comes_back_to_page_one_stays_there_with_the_text_around_it() {
let l = footnoted_float(0);
assert_eq!(l.pages.iter().map(|p| shapes(&p.items).len()).collect::<Vec<_>>()[..2], [1, 0]);
let beside: Vec<_> = lines_on(&l, 0).into_iter().filter(|(y, ..)| *y > 300.0 && *y < 350.0).collect();
assert!(!beside.is_empty() && beside.iter().all(|(_, left, _)| *left >= 100.0), "the text wraps around it: {beside:?}");
}
/// #4250: the text wrapping around that float again pushes a footnote reference beside its anchor
/// back to page two; the note goes with it, once, not left on page one as well.
#[test]
fn a_footnote_pushed_on_by_a_float_coming_back_is_on_its_reference_s_page_only() {
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(400));
let note = |text: &str| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default()).styled("FootnoteText");
p.props.space_after = Some(0.0);
vec![wordcraft_doc::para_block(p)]
};
let noteref = |id| InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: String::new() };
let long = d.add_part(wordcraft_doc::PartKind::Footnote, note(&"The note text runs on for a while. ".repeat(25)));
d.insert_object(&Pos::body(0, 4), noteref(long), &Default::default()).unwrap();
let anchor = lines_on(&lay(&d), 1)[0].2;
let short = d.add_part(wordcraft_doc::PartKind::Footnote, note("A short note."));
d.insert_object(&Pos::body(0, anchor), noteref(short), &Default::default()).unwrap();
let f = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, 300.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
let l = lay(&d);
assert_eq!(shapes(&l.pages[0].items).len(), 1, "the float stays on page one");
let at = anchor + wordcraft_doc::para::OBJ.len_utf8();
let ref_page = (0..l.pages.len()).rfind(|&pi| lines_on(&l, pi).first().is_some_and(|f| f.2 <= at));
assert_eq!(ref_page, Some(1), "the reference is pushed on to page two");
let notes: Vec<usize> = l
.pages
.iter()
.map(|pg| pg.items.iter().filter(|i| matches!(i, Placed::Lines { story: StoryRef::Part(p), .. } if *p == short)).count())
.collect();
assert_eq!(notes[..2], [0, 1], "the note is on its reference's page, once");
}
/// #4250: of two floats held back for page two, the one whose anchor comes back to page one stays
/// there; the other is still drawn on page two.
#[test]
fn of_two_floats_held_back_only_the_one_whose_anchor_comes_back_stays_on_page_one() {
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(400));
let mut note = wordcraft_doc::Paragraph::with_text(&"The note text runs on for a while. ".repeat(30), Default::default()).styled("FootnoteText");
note.props.space_after = Some(0.0);
let id = d.add_part(wordcraft_doc::PartKind::Footnote, vec![wordcraft_doc::para_block(note)]);
let noteref = InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: String::new() };
d.insert_object(&Pos::body(0, 4), noteref, &Default::default()).unwrap();
let lines = lines_on(&lay(&d), 1);
let f = |y| wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, y) };
d.insert_object(&Pos::body(0, lines[3].2), rect_shape(100.0, 50.0, f(400.0)), &Default::default()).unwrap();
d.insert_object(&Pos::body(0, lines[0].2), rect_shape(100.0, 50.0, f(300.0)), &Default::default()).unwrap();
let l = lay(&d);
let ys = |pi: usize| shapes(&l.pages[pi].items).iter().map(|r| r.y).collect::<Vec<_>>();
assert_eq!((ys(0).len(), ys(1).len()), (1, 1), "one on each page: {:?} {:?}", ys(0), ys(1));
}
/// #4250: a footnote referenced on page two leaves less room there than its lines alone suggest;
/// a float anchored on the first line it pushes on to page three is drawn on page three.
#[test]
fn a_float_anchored_on_a_line_a_footnote_pushes_on_is_drawn_on_the_next_page() {
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(600));
let mut note = wordcraft_doc::Paragraph::with_text(&"The note text runs on for a while. ".repeat(30), Default::default()).styled("FootnoteText");
note.props.space_after = Some(0.0);
let id = d.add_part(wordcraft_doc::PartKind::Footnote, vec![wordcraft_doc::para_block(note)]);
let noteref = InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: String::new() };
let at = lines_on(&lay(&d), 1)[1].2;
d.insert_object(&Pos::body(0, at), noteref, &Default::default()).unwrap();
// A word into the line: an anchor at its very start goes with the line before.
let anchor = lines_on(&lay(&d), 2)[0].2 + "The ".len();
let f = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, 300.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
let l = lay(&d);
let anchor_page = (0..l.pages.len()).rfind(|&pi| lines_on(&l, pi).first().is_some_and(|f| f.2 <= anchor));
let per_page: Vec<usize> = l.pages.iter().map(|p| shapes(&p.items).len()).collect();
assert_eq!(anchor_page, Some(2), "the anchor is on page three");
assert_eq!(&per_page[..3], [0, 0, 1], "{per_page:?}");
let beside: Vec<_> = lines_on(&l, 1).into_iter().filter(|(y, ..)| *y > 300.0 && *y < 350.0).collect();
assert!(!beside.is_empty() && beside.iter().all(|(_, left, _)| *left < 1.0), "page two doesn't wrap around it: {beside:?}");
}
/// #4250: widow control takes the line before a paragraph's last on to the next page with it; a
/// float anchored there is drawn on that page.
#[test]
fn a_float_anchored_on_a_line_widow_control_takes_on_is_drawn_on_the_next_page() {
// A paragraph of three pages whose last two lines are on the third only by widow control.
let (mut d, l) = (100..300)
.map(|k| Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(k)))
.map(|d| {
let l = lay(&d);
(d, l)
})
.find(|(_, l)| l.pages.len() == 3 && lines_on(l, 2).len() == 2 && lines_on(l, 1).len() < lines_on(l, 0).len())
.expect("a paragraph ending in a widow");
let anchor = lines_on(&l, 2)[0].2 + "The ".len();
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, page_float(72.0, 300.0)), &Default::default()).unwrap();
let per_page: Vec<usize> = lay(&d).pages.iter().map(|p| shapes(&p.items).len()).collect();
assert_eq!(per_page, [0, 0, 1]);
}
/// #4250: a float whose own wrap pushes its anchor line on to the next page stays on the page
/// whose lines it was placed with, as before, with the text there wrapping around it.
#[test]
fn a_float_whose_wrap_pushes_its_own_line_on_stays_with_the_text_around_it() {
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(600));
let last = *lines_on(&lay(&d), 1).last().unwrap();
let anchor = last.2 + "The ".len();
let f = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, 300.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(200.0, 100.0, f), &Default::default()).unwrap();
let l = lay(&d);
let anchor_page = (0..l.pages.len()).rfind(|&pi| lines_on(&l, pi).first().is_some_and(|f| f.2 <= anchor));
assert_eq!(anchor_page, Some(2), "its wrap pushes the anchor on to page three");
let per_page: Vec<usize> = l.pages.iter().map(|p| shapes(&p.items).len()).collect();
assert_eq!(&per_page[..3], [0, 1, 0], "{per_page:?}");
let beside: Vec<_> = lines_on(&l, 1).into_iter().filter(|(y, ..)| *y > 300.0 && *y < 400.0).collect();
assert!(!beside.is_empty() && beside.iter().all(|(_, left, _)| *left >= 200.0), "the text wraps around it: {beside:?}");
}
/// #4250: holding back a float for a later page lays its paragraph out again; its automatic
/// equation numbers aren't counted twice: they read (1), (2).
#[test]
fn a_paragraph_with_a_float_for_a_later_page_keeps_its_equation_numbers() {
let eq = |s: &str| InlineObject::Equation {
linear: s.into(),
display: true,
math: wordcraft_doc::math::Math { nodes: wordcraft_doc::math::parse_linear(s), ..Default::default() },
};
let mut d = Document::from_text(&format!("{}\n", "The quick brown fox jumps over the lazy dog. ".repeat(400)));
let anchor = lines_on(&lay(&d), 1)[5].2;
let f = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, 300.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
let n = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().len();
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().insert_object(n, eq("a=b#"), &Default::default()).unwrap();
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().insert_object(0, eq("c=d#"), &Default::default()).unwrap();
let l = lay(&d);
assert_eq!(shapes(&l.pages[1].items).len(), 1, "held back for page two");
assert_eq!(equation_numbers(&l), ["(1)", "(2)"]);
}
/// #4250: in two columns, a float anchored where the paragraph continues in the second column of
/// the same page is placed with its first piece, as before, so the first column wraps around it.
#[test]
fn a_float_anchored_in_the_next_column_of_the_page_stays_with_its_first_piece() {
let mut d = Document::from_text(&"The quick brown fox jumps over the lazy dog. ".repeat(120));
d.last_section.columns.count = 2;
let plain = lay(&d);
let lines = lines_on(&plain, 0);
let second = lines.iter().position(|w| w.0 < lines[0].0 + 0.5 && w.2 > 0).expect("a second column on page one");
let anchor = lines[second + 2].2;
let f = wordcraft_doc::para::Float { wrap: wordcraft_doc::para::Wrap::Square, ..page_float(72.0, 200.0) };
d.insert_object(&Pos::body(0, anchor), rect_shape(100.0, 50.0, f), &Default::default()).unwrap();
let l = lay(&d);
assert_eq!(shapes(&l.pages[0].items).len(), 1, "on page one");
let beside: Vec<_> = lines_on(&l, 0).into_iter().filter(|(y, left, start)| *y > 200.0 && *y < 250.0 && *start < anchor && *left >= 0.0).collect();
assert!(!beside.is_empty() && beside.iter().all(|(_, left, _)| *left >= 100.0), "the first column wraps around it: {beside:?}");
}
/// Floating objects are drawn in their stacking order (`relativeHeight`), not in the order of
/// their anchors: a panel anchored after the text box it frames, but lower in the stack, is
/// drawn first so the box stays visible over it. Objects without an order keep theirs.
#[test]
fn floats_are_drawn_in_their_stacking_order() {
let at = |x: f32, z: u32| rect_shape(50.0, 50.0, wordcraft_doc::para::Float { z, ..page_float(x, 100.0) });
let mut d = Document::from_text("Text");
for (x, z) in [(100.0, 30), (200.0, 10), (300.0, 20)] {
d.insert_object(&Pos::body(0, 4), at(x, z), &Default::default()).unwrap();
}
let xs: Vec<f32> = shapes(&lay(&d).pages[0].items).iter().map(|r| r.x).collect();
assert_eq!(xs, [200.0, 300.0, 100.0], "lowest first");
let mut d = Document::from_text("Text");
for (i, x) in [100.0, 200.0].into_iter().enumerate() {
let off = 4 + i * wordcraft_doc::para::OBJ.len_utf8();
d.insert_object(&Pos::body(0, off), at(x, 0), &Default::default()).unwrap();
}
let xs: Vec<f32> = shapes(&lay(&d).pages[0].items).iter().map(|r| r.x).collect();
assert_eq!(xs, [100.0, 200.0], "no order: as anchored");
// Behind the text too: the higher one comes first in the XML and stays on top.
let behind = |x: f32, z: u32| {
rect_shape(50.0, 50.0, wordcraft_doc::para::Float { z, wrap: wordcraft_doc::para::Wrap::BehindText, ..page_float(x, 100.0) })
};
let mut d = Document::from_text("Text");
for (i, (x, z)) in [(100.0, 20), (200.0, 10)].into_iter().enumerate() {
let off = 4 + i * wordcraft_doc::para::OBJ.len_utf8();
d.insert_object(&Pos::body(0, off), behind(x, z), &Default::default()).unwrap();
}
let xs: Vec<f32> = shapes(&lay(&d).pages[0].items).iter().map(|r| r.x).collect();
assert_eq!(xs, [200.0, 100.0], "behind the text: lowest first");
// One without an order, anchored after ordered ones, is drawn above them.
let mut d = Document::from_text("Text");
for (i, (x, z)) in [(100.0, 30), (200.0, 10), (300.0, 0)].into_iter().enumerate() {
let off = 4 + i * wordcraft_doc::para::OBJ.len_utf8();
d.insert_object(&Pos::body(0, off), at(x, z), &Default::default()).unwrap();
}
let xs: Vec<f32> = shapes(&lay(&d).pages[0].items).iter().map(|r| r.x).collect();
assert_eq!(xs, [200.0, 100.0, 300.0], "no order after ordered ones: drawn last");
}
#[test]
fn floats_in_headers_and_table_cells_are_drawn() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text("Body text.");
let logo = Float { wrap: Wrap::BehindText, h_rel: Anchor::Page, v_rel: Anchor::Page, x: 400.0, y: 20.0, ..Default::default() };
let mut hp = wordcraft_doc::Paragraph::with_text("Header", Default::default());
hp.insert_object(0, rect_shape(120.0, 60.0, logo), &Default::default()).unwrap();
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(hp)]);
d.last_section.headers.default = Some(id);
let mut t = Table::new(1, 2, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text("cell", Default::default());
let in_cell = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 5.0, ..Default::default() };
cp.insert_object(0, rect_shape(40.0, 20.0, in_cell), &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cp)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let h = shapes(&l.pages[0].header);
assert_eq!(h.len(), 1, "header float drawn");
assert!((h[0].x - 400.0).abs() < 0.01 && (h[0].y - 20.0).abs() < 0.01, "page coordinates: {:?}", h[0]);
assert!(matches!(l.pages[0].header.first(), Some(Placed::Shape { .. })), "behind the header text");
let c = shapes(&l.pages[0].items);
assert_eq!(c.len(), 1, "cell float drawn");
assert!(c[0].x > 72.0 && c[0].x < 72.0 + 234.0, "inside the first cell: {:?}", c[0]);
}
/// A float laid out in its cell (`layoutInCell`) whose offset would take it out of the cell is
/// moved in to the cell's outer side (a letterhead logo anchored left of its header cell). One laid out on the page (`layoutInCell="0"`) keeps its offset.
#[test]
fn cell_floats_laid_out_in_the_cell_stay_in_it() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let cell_w = 234.0;
let place = |x: f32, outside_cell: bool, wrap: Wrap| {
let mut d = Document::from_text("Body text.");
let mut t = Table::new(1, 2, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text("cell", Default::default());
let f = Float { wrap, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x, dist: 9.0, outside_cell, ..Default::default() };
cp.insert_object(0, rect_shape(80.0, 48.0, f), &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cp)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let c = shapes(&lay(&d).pages[0].items);
assert_eq!(c.len(), 1, "cell float drawn");
c[0].x
};
// An offset inside the cell is kept: the cell's text starts 20 pt left of this one.
let text_left = place(20.0, false, Wrap::Tight) - 20.0;
assert!(text_left > 72.0 && text_left < 72.0 + 12.0, "the cell's text starts past its margin: {text_left}");
let cell_left = text_left - 5.4;
// Anchored 95 pt left of the column: moved in to the cell's outer left side.
let left = place(-95.0, false, Wrap::Tight);
assert!((left - cell_left).abs() < 0.5, "pulled in to the left side: {left} vs {text_left}");
// Past the right side: moved in to it.
let right = place(cell_w + 40.0, false, Wrap::Tight);
// (within a point: the cell's border room is not split evenly between its two sides)
assert!((right - (cell_left + cell_w - 80.0)).abs() < 1.0, "pulled in to the right side: {right}");
// Not laid out in the cell: the offset is kept, off the cell or not.
let out = place(-95.0, true, Wrap::Tight);
assert!((out - (text_left - 95.0)).abs() < 0.5, "layoutInCell=0 keeps the offset: {out}");
// Front-of-text shapes do not wrap and keep their offsets even with layoutInCell on.
for offset in [-95.0, cell_w + 40.0] {
let front = place(offset, false, Wrap::InFrontOfText);
assert!((front - (text_left + offset)).abs() < 0.5, "front-of-text offset preserved: {front}");
}
}
/// Cell confinement uses the finite, nonnegative width that float placement actually draws.
#[test]
fn cell_float_bounds_use_the_placed_width() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let place = |width, x, wrap, outside_cell| {
let mut d = Document::from_text("Body");
let mut t = Table::new(1, 2, 468.0);
let mut p = wordcraft_doc::Paragraph::with_text("cell", Default::default());
let f = Float { wrap, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x, dist: 9.0, outside_cell, ..Default::default() };
p.insert_object(0, rect_shape(width, 48.0, f), &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let objects = shapes(&lay(&d).pages[0].items);
assert_eq!(objects.len(), 1);
objects[0]
};
// Invalid stored widths are placed as zero-width objects; offsets at either side must
// match an explicitly zero-width object, rather than inventing extra room in the cell.
for offset in [-95.0, 300.0] {
let zero = place(0.0, offset, Wrap::Tight, false);
for stored in [-100.0, f32::NEG_INFINITY, f32::NAN, f32::INFINITY] {
let placed = place(stored, offset, Wrap::Tight, false);
assert_eq!(placed.w, 0.0);
assert!((placed.x - zero.x).abs() < 0.01, "stored width {stored}, offset {offset}: {placed:?} vs {zero:?}");
}
// Neither opt-out path gains confinement from the width normalization.
for (wrap, outside_cell) in [(Wrap::InFrontOfText, false), (Wrap::Tight, true)] {
let zero = place(0.0, offset, wrap, outside_cell);
let negative = place(-100.0, offset, wrap, outside_cell);
assert_eq!(negative.w, zero.w);
assert!((negative.x - zero.x).abs() < 0.01);
}
}
}
#[test]
fn keep_in_cell_bounds() {
use super::boxes::keep_in_cell;
assert_eq!(keep_in_cell(-95.0, 80.0, 0.0, 234.0), 0.0);
assert_eq!(keep_in_cell(300.0, 80.0, 0.0, 234.0), 234.0 - 80.0);
assert_eq!(keep_in_cell(20.0, 80.0, 0.0, 234.0), 20.0);
// Wider than the cell, or exactly its width: starts at the outer left side.
assert_eq!(keep_in_cell(50.0, 300.0, 0.0, 234.0), 0.0);
assert_eq!(keep_in_cell(50.0, 234.0, 0.0, 234.0), 0.0);
// Nearly full: no clearance is added to the object's position.
assert_eq!(keep_in_cell(-95.0, 230.0, 0.0, 234.0), 0.0);
assert_eq!(keep_in_cell(300.0, 230.0, 0.0, 234.0), 4.0);
// Cell edges include its margins; negative offsets can be wholly inside the cell.
assert_eq!(keep_in_cell(-5.0, 80.0, 0.0, 234.0), 0.0);
assert_eq!(keep_in_cell(-5.0, 80.0, -4.0, 234.0), -4.0);
assert_eq!(keep_in_cell(-5.15, 63.75, -5.4, 448.2), -5.15);
assert_eq!(keep_in_cell(395.95, 47.25, -5.4, 448.2), 395.95);
// Clamp limits stay finite and ordered even at small scales or with malformed geometry.
for width in [0.1_f32, 0.3, 1.0, 234.0] {
let object = width * 0.98;
for offset in [-width, 0.0, width, f32::NAN, f32::INFINITY] {
let x = keep_in_cell(offset, object, 0.0, width);
assert!(x.is_finite() && x >= 0.0 && x + object <= width + f32::EPSILON * width.max(1.0));
}
}
assert_eq!(keep_in_cell(10.0, 80.0, 0.0, f32::NAN), 0.0);
assert_eq!(keep_in_cell(10.0, f32::NAN, 0.0, 234.0), 0.0);
assert_eq!(keep_in_cell(10.0, 80.0, f32::NAN, 234.0), 10.0);
}
/// Paragraph anchors exclude space-before; line and frameless page/margin anchors retain it.
#[test]
fn box_float_origins_respect_vertical_anchor_with_space_before() {
use wordcraft_doc::{
PartKind,
para::{Anchor, Float, Wrap},
};
for context in ["header", "footer", "cell", "textbox"] {
for anchor in [
Anchor::Paragraph,
Anchor::Line,
Anchor::Page,
Anchor::Margin,
Anchor::TopMargin,
Anchor::BottomMargin,
Anchor::InsideMargin,
Anchor::OutsideMargin,
] {
if matches!(context, "header" | "footer") && !matches!(anchor, Anchor::Paragraph | Anchor::Line) {
continue;
}
let gap = |before| {
let mut d = Document::from_text("Body");
let mut p = wordcraft_doc::Paragraph::with_text("Anchor", Default::default());
p.props.space_before = Some(before);
let float = Float { wrap: Wrap::BehindText, v_rel: anchor, y: 7.0, ..Default::default() };
p.insert_object(0, rect_shape(37.0, 9.0, float), &Default::default()).unwrap();
let story = match context {
"header" | "footer" => {
let kind = if context == "header" { PartKind::Header } else { PartKind::Footer };
let id = d.add_part(kind, vec![wordcraft_doc::para_block(p)]);
if context == "header" {
d.last_section.headers.default = Some(id);
} else {
d.last_section.footers.default = Some(id);
}
StoryRef::Part(id)
}
"cell" => {
let mut t = Table::new(1, 1, 468.0);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
StoryRef::Body
}
_ => {
let id = text_box(&mut d, 0, "", 200.0, 100.0, page_float(100.0, 200.0));
d.parts.get_mut(&id).unwrap().blocks = vec![wordcraft_doc::para_block(p)];
StoryRef::Part(id)
}
};
let l = lay(&d);
let page = &l.pages[0];
let items = match context {
"header" => &page.header,
"footer" => &page.footer,
_ => &page.items,
};
let y = items
.iter()
.find_map(|i| match i {
Placed::Lines { story: s, y, path, .. } if *s == story && (context != "cell" || path.0.len() > 1) => Some(*y),
_ => None,
})
.unwrap();
let r = shapes(items).into_iter().find(|r| (r.w - 37.0).abs() < 0.01).unwrap();
r.y - y
};
let expected = if anchor == Anchor::Paragraph { -24.0 } else { 0.0 };
assert!((gap(24.0) - gap(0.0) - expected).abs() < 0.01, "{context} {anchor:?}: float/text gap must change by {expected}");
}
}
}
/// Inside a text box whose shape style gives its text a colour (`a:fontRef`, typically white on
/// the accent fill), automatic text takes that colour instead of black; text with a colour of
/// its own keeps it (Word, observed with synthetic documents).
#[test]
fn automatic_text_in_a_styled_text_box_takes_the_box_s_colour() {
crate::test_fonts();
let glyph_colors = |auto_color: Option<Rgb>| {
let mut d = Document::from_text("Body");
let id = text_box(&mut d, 4, "Auto", 200.0, 60.0, page_float(100.0, 300.0));
if let Some(p) = d.parts.get_mut(&id) {
p.body.auto_color = auto_color;
if let Some(wordcraft_doc::Block::Para(q)) = p.blocks.first_mut().map(std::sync::Arc::make_mut) {
let mut own = wordcraft_doc::Paragraph::with_text("Green", Default::default());
own.runs[0].props.color = Some(wordcraft_doc::props::TextColor::Rgb(Rgb(0, 0x80, 0)));
q.text.push_str(&own.text);
q.runs.extend(own.runs);
}
}
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let color_of = |want: &str| {
items.iter().find_map(|i| if let display::Draw::Glyphs { text, color, .. } = i { text.contains(want).then_some(*color) } else { None })
};
(color_of("Body"), color_of("Auto"), color_of("Green"))
};
let white = Rgb(0xFF, 0xFF, 0xFF);
assert_eq!(glyph_colors(Some(white)), (Some(Rgb::BLACK), Some(white), Some(Rgb(0, 0x80, 0))));
assert_eq!(glyph_colors(None), (Some(Rgb::BLACK), Some(Rgb::BLACK), Some(Rgb(0, 0x80, 0))));
}
/// Issue #1775: a picture watermark anchored in a header that starts with a table sits in a cell;
/// placed on the page (`o:allowincell="f"`, `layoutInCell="0"`), it's centred on the margins
/// behind the body text on every page, not drawn in the header's cell. One laid out in the cell
/// stays there.
#[test]
fn header_cell_float_placed_on_the_page() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, FloatAlign, Wrap};
let mut d = Document::from_text(&"Body text of the contract. ".repeat(400));
let wm = |outside_cell: bool| Float {
wrap: Wrap::BehindText,
h_rel: Anchor::Margin,
v_rel: Anchor::Margin,
h_align: Some(FloatAlign::Center),
v_align: Some(FloatAlign::Center),
outside_cell,
..Default::default()
};
let header = |d: &mut Document, outside_cell: bool| {
let mut t = Table::new(1, 2, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text("Right cell", Default::default());
// This page-centering control keeps its header within the declared margin.
cp.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(12.0));
cp.props.space_before = Some(0.0);
cp.props.space_after = Some(0.0);
let tail = wordcraft_doc::Paragraph { props: cp.props.clone(), ..Default::default() };
cp.insert_object(0, rect_shape(360.0, 288.0, wm(outside_cell)), &Default::default()).unwrap();
t.rows[0].cells[1].blocks = vec![wordcraft_doc::para_block(cp)];
let id =
d.add_part(wordcraft_doc::PartKind::Header, vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t)), wordcraft_doc::para_block(tail)]);
d.last_section.headers.default = Some(id);
};
header(&mut d, true);
let l = lay(&d);
assert!(l.pages.len() > 1);
// Letter, 1" margins: the margins' box is 468 x 648 from (72, 72).
let (x, y) = (72.0 + (468.0 - 360.0) / 2.0, 72.0 + (648.0 - 288.0) / 2.0);
for (n, page) in l.pages.iter().enumerate() {
let s = shapes(&page.header);
assert_eq!(s.len(), 1, "page {n}: {s:?}");
assert!((s[0].x - x).abs() < 0.01 && (s[0].y - y).abs() < 0.01, "page {n}: centred on the page, not in the cell: {:?}", s[0]);
assert!(matches!(page.header.first(), Some(Placed::Shape { .. })), "page {n}: behind the header text");
let o = page.header.iter().find_map(|i| if let Placed::Object { rect, .. } = i { Some(*rect) } else { None }).unwrap();
assert!((o.x - x).abs() < 0.01 && (o.y - y).abs() < 0.01, "page {n}: its area for selection: {o:?}");
assert!(first_line_top(&page.items) < 80.0, "page {n}: the body isn't pushed down");
}
// Laid out in the cell: it stays centred on the right cell (centre x 72 + 234 + 117), at the
// top of the page.
header(&mut d, false);
let s = shapes(&lay(&d).pages[0].header);
assert_eq!(s.len(), 1);
assert!((s[0].x + 180.0 - 423.0).abs() < 1.0 && s[0].y < 72.0, "in the cell: {:?}", s[0]);
}
#[test]
fn a_centred_float_in_a_cell_is_not_pushed_above_its_anchor_line() {
use wordcraft_doc::para::{Anchor, Float, FloatAlign, Wrap};
for align in [FloatAlign::Center, FloatAlign::End] {
let mut d = Document::from_text("Before.");
let mut t = Table::new(1, 1, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text("cell", Default::default());
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Margin, v_align: Some(align), ..Default::default() };
cp.insert_object(0, rect_shape(100.0, 200.0, f), &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cp)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let c = shapes(&l.pages[0].items);
assert_eq!(c.len(), 1, "cell float drawn");
// The first line sits at the top margin (72 pt); the table is below the "Before." line.
assert!(c[0].y >= 72.0 + 10.0, "{align:?}: float not above the anchor line: {:?}", c[0]);
}
}
#[test]
fn wrap_area_uses_each_distance() {
crate::test_fonts();
use wordcraft_doc::para::{Float, Wrap};
let f = Float { wrap: Wrap::Square, dist: 9.0, dist_top: 0.0, dist_bottom: 4.0, ..Default::default() };
let (r, tb, ..) = wrap_area(Rect::new(10.0, 20.0, 100.0, 50.0), &f, None).unwrap();
assert_eq!((r.x, r.y, r.w, r.h, tb), (1.0, 20.0, 118.0, 54.0, false));
let hostile = Float { wrap: Wrap::TopAndBottom, dist: f32::NAN, dist_top: -5.0, dist_bottom: f32::INFINITY, ..Default::default() };
let (r, tb, ..) = wrap_area(Rect::new(0.0, 0.0, 10.0, 10.0), &hostile, None).unwrap();
assert!(r.w.is_finite() && r.h.is_finite() && tb, "{r:?}");
assert!(wrap_area(Rect::new(0.0, 0.0, 10.0, 10.0), &Float { wrap: Wrap::BehindText, ..Default::default() }, None).is_none());
}
#[test]
fn float_moved_to_a_new_page_sits_at_its_paragraph_top() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&format!("First page.\n{}", "Text beside the picture on page two. ".repeat(20)));
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(1, 0), rect_shape(144.0, 100.0, f), &Default::default()).unwrap();
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(1).map(std::sync::Arc::make_mut) {
p.props.page_break_before = Some(true);
p.props.space_before = Some(24.0);
}
let l = lay(&d);
let r = shapes(&l.pages[1].items)[0];
let top = first_line_top(&l.pages[1].items);
// The picture sits at the paragraph's start, above its space before, as in Word (`plan/word`
// R22); the text starts below the space before.
let body_top = d.last_section.margin_top;
assert!((r.y - body_top).abs() < 0.5 && top >= body_top, "picture at {} but its paragraph starts at {body_top}", r.y);
}
#[test]
fn page_relative_header_float_wraps_where_it_is_drawn() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
let body_top = |wrap| {
let mut d = Document::from_text("Body text.");
let logo = Float { wrap, h_rel: Anchor::Page, v_rel: Anchor::Page, x: 72.0, y: 0.0, ..Default::default() };
let mut hp = wordcraft_doc::Paragraph::with_text("Header", Default::default());
hp.insert_object(0, rect_shape(400.0, 20.0, logo), &Default::default()).unwrap();
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(hp)]);
d.last_section.headers.default = Some(id);
first_line_top(&lay(&d).pages[0].items)
};
// The logo sits at the top edge of the page, above the header text, so wrapping text around
// it must not make the header taller (and push the body down) compared with no wrapping.
let (wrapped, in_front) = (body_top(Wrap::TopAndBottom), body_top(Wrap::InFrontOfText));
assert!((wrapped - in_front).abs() < 0.5, "body starts at {wrapped} with wrapping, {in_front} without");
}
/// Issue #149: a tall text box floating behind the text in the header (placed relative to the
/// page, no wrapping) neither makes the header taller nor pushes the body down: the body starts
/// at the top margin and paginates exactly as without the box.
#[test]
fn floating_header_text_box_leaves_the_body_at_the_top_margin() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, ShapeKind, Wrap};
let body: Vec<String> = (1..=40).map(|i| format!("Body paragraph {i}: synthetic public test content.")).collect();
let make = |float: Option<Float>| {
let mut d = Document::from_text(&body.join("\n"));
// The header starts 18pt from the top, so its two lines end well above the 72pt top
// margin whatever font the default text gets (the line height differs between the
// installed fonts and the bundled fallback: a header at 36pt overflows the margin there).
d.last_section.header = 18.0;
// A label, then the paragraph the box is anchored to (empty in the control).
let tight = ParaProps { space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
let mut label = wordcraft_doc::Paragraph::with_text("Header label", Default::default());
label.props = tight.clone();
let mut anchor = wordcraft_doc::Paragraph { props: tight, ..Default::default() };
if let Some(float) = float {
let text = wordcraft_doc::Paragraph::with_text("WATERMARK", Default::default());
let story = d.add_part(wordcraft_doc::PartKind::TextBox, vec![wordcraft_doc::para_block(text)]);
let tb = InlineObject::Shape {
kind: ShapeKind::TextBox,
w: 405.0,
h: 491.4,
fill: None,
stroke: None,
stroke_width: 0.75,
float,
story: Some(story),
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
anchor.insert_object(0, tb, &Default::default()).unwrap();
}
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(label), wordcraft_doc::para_block(anchor)]);
d.last_section.headers.default = Some(id);
let l = lay(&d);
(l.pages.len(), first_line_top(&l.pages[0].items))
};
let (control_pages, control_top) = make(None);
let behind = Float { wrap: Wrap::BehindText, h_rel: Anchor::Page, v_rel: Anchor::Page, x: 0.0, y: 80.0, ..Default::default() };
let (pages, top) = make(Some(behind));
assert!(control_pages > 1, "the control needs more than one page: {control_pages}");
assert!((control_top - 72.0).abs() < 0.5, "control body starts at the top margin: {control_top}");
assert!((top - control_top).abs() < 0.5, "body starts at {top} with the floating box, {control_top} without");
assert_eq!(pages, control_pages);
// The same box inline does take room in the header, which is what the reader used to make of it.
let (inline_pages, inline_top) = make(Some(Float::default()));
assert!(inline_top > 400.0 && inline_pages > control_pages, "inline box: body at {inline_top}, {inline_pages} pages");
}
/// List labels drawn, in page order (each paragraph's first line).
fn labels(l: &DocLayout) -> Vec<String> {
l.pages
.iter()
.flat_map(|p| &p.items)
.filter_map(|i| if let Placed::Lines { para, l0: 0, .. } = i { para.label.as_ref().map(|lb| lb.text.clone()) } else { None })
.collect()
}
fn numbered(d: &mut Document, texts: &[&str], props: ParaProps) -> Vec<wordcraft_doc::Paragraph> {
let num = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
texts
.iter()
.map(|t| {
let mut p = wordcraft_doc::Paragraph::with_text(t, Default::default());
p.props = ParaProps { numbering: Some(wordcraft_doc::props::NumRef { num, level: 0 }), ..props.clone() };
p
})
.collect()
}
#[test]
fn list_items_are_counted_once_when_laid_out_again() {
crate::test_fonts();
// Contextual spacing drops the space before, so each item's top differs from the first guess.
let mut d = Document::new();
let props = ParaProps { space_before: Some(6.0), contextual_spacing: Some(true), ..Default::default() };
let mut items = numbered(&mut d, &["one", "two", "three"], props);
// A page break before moves the last item after its first layout.
items[2].props.page_break_before = Some(true);
d.body = items.into_iter().map(wordcraft_doc::para_block).collect();
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
assert_eq!(labels(&l), ["1.", "2.", "3."]);
}
#[test]
fn list_items_beside_a_float_in_a_cell_are_counted_once() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text("Body.");
let mut items = numbered(&mut d, &["first item", "second item", "third item"], ParaProps::default());
// The float makes the cell's paragraphs wrap, so they are laid out a second time.
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, ..Default::default() };
items[0].insert_object(0, rect_shape(40.0, 60.0, f), &Default::default()).unwrap();
let mut t = Table::new(1, 1, 468.0);
t.rows[0].cells[0].blocks = items.into_iter().map(wordcraft_doc::para_block).collect();
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
assert_eq!(labels(&lay(&d)), ["1.", "2.", "3."]);
}
#[test]
fn compatibility_mode_decides_where_a_table_s_edge_sits() {
crate::test_fonts();
use wordcraft_doc::props::{Border, BorderStyle, Borders};
let cell_text_x = |mode: u32| {
let mut d = Document::from_text("");
d.settings.compat_mode = mode;
let line = Some(Border { style: BorderStyle::Single, width: 0.5, color: None, space: 0.0 });
let mut t = Table::new(1, 1, 200.0);
t.props.borders = Some(Borders { top: line, left: line, bottom: line, right: line, between: line, inside_v: line });
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("cell", Default::default()))];
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t))];
let l = lay(&d);
l.pages[0].items.iter().find_map(|i| if let Placed::Lines { x, .. } = i { Some(*x) } else { None }).unwrap()
};
// Word 2013+: the border at the margin (moved in by half its width), the text a cell margin
// inside it. Earlier modes: the text at the margin, the border a cell margin outside it.
assert!((cell_text_x(15) - (72.0 + 0.25 + 5.4)).abs() < 0.01, "{}", cell_text_x(15));
assert!((cell_text_x(12) - 72.0).abs() < 0.01, "{}", cell_text_x(12));
}
#[test]
fn floating_tables_take_no_room_and_text_wraps_beside_them() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let mut d = Document::from_text("Body text beside the narrow table.");
let cell = |t: &mut Table, text: &str| {
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))]
};
let mut wide = Table::new(1, 1, 468.0);
cell(&mut wide, "Wide");
wide.props.float = Some(TableFloat { h_rel: Anchor::Margin, v_rel: Anchor::Paragraph, overlap: false, ..Default::default() });
let mut narrow = Table::new(1, 1, 200.0);
cell(&mut narrow, "Narrow");
narrow.props.float =
Some(TableFloat { h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist: [9.0, 0.0, 9.0, 0.0], overlap: false, ..Default::default() });
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(wide)).unwrap();
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(narrow)).unwrap();
let l = lay(&d);
let lines: Vec<(f32, f32, f32)> = l.pages[0]
.items
.iter()
.filter_map(|i| if let Placed::Lines { x, y, para, .. } = i { Some((*x, *y, para.lines[0].left)) } else { None })
.collect();
let [(wx, wy, _), (nx, ny, _), (bx, by, bleft)] = lines.as_slice() else { panic!("{lines:?}") };
// The wide table stands where the text is; the narrow one may not overlap it, so it goes
// right below, keeping its 9pt from the text's left edge.
assert!(*wy >= 72.0 && *wy < 80.0, "wide at {wy}");
assert!(*ny > *wy + 10.0, "narrow at {ny}, below the wide table at {wy}");
assert!((nx - wx - 9.0).abs() < 0.01, "narrow text at {nx}, wide text at {wx}");
// The paragraph doesn't wait below them: it runs beside the narrow table, level with it.
assert!((by - ny).abs() < 2.0, "body at {by}, narrow table text at {ny}");
assert!(bx + bleft > nx + 200.0, "body text at {}, right of the narrow table", bx + bleft);
}
/// Before Word 2013 layout a floating table moved below another keeps its own left edge, also
/// when its first cell has no left margin (docxide `displaced-anchor-*-compat12-overlap0-*`), in
/// the body and in a table cell.
#[test]
fn a_floating_table_moved_below_another_keeps_its_edge_before_word_2013_layout() {
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let narrow_x = |mode: u32, in_cell: bool| {
let mut d = Document::from_text("Body.");
d.settings.compat_mode = mode;
let table = |w: f32, text: &str, dist: [f32; 4]| {
let mut t = Table::new(1, 1, w);
t.props.cell_margins = Some([0.0; 4]);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))];
t.props.float = Some(TableFloat { h_rel: Anchor::Margin, v_rel: Anchor::Paragraph, dist, overlap: false, ..Default::default() });
t
};
let floats = [table(300.0, "Wide", [0.0; 4]), table(100.0, "Narrow", [9.0, 0.0, 9.0, 0.0])];
if in_cell {
let mut outer = Table::new(1, 1, 468.0);
outer.rows[0].cells[0].blocks = floats.into_iter().map(|t| std::sync::Arc::new(wordcraft_doc::Block::Table(t))).collect();
outer.rows[0].cells[0].blocks.push(wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Cell.", Default::default())));
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(outer)).unwrap();
} else {
for (i, t) in floats.into_iter().enumerate() {
d.insert_block(StoryRef::Body, &Path::top(i), wordcraft_doc::Block::Table(t)).unwrap();
}
}
let l = lay(&d);
let xs: Vec<(f32, f32)> =
l.pages[0].items.iter().filter_map(|i| if let Placed::Lines { x, y, .. } = i { Some((*x, *y)) } else { None }).collect();
let [(wx, wy), (nx, ny), ..] = xs.as_slice() else { panic!("{xs:?}") };
assert!(*ny > *wy + 10.0, "mode {mode}, in cell {in_cell}: narrow at {ny}, below the wide table at {wy}: {xs:?}");
nx - wx
};
for in_cell in [false, true] {
let (old, new) = (narrow_x(12, in_cell), narrow_x(15, in_cell));
assert!(old.abs() < 0.01, "mode 12, in cell {in_cell}: narrow table {old} right of the wide one");
assert!((new - 9.0).abs() < 0.01, "mode 15, in cell {in_cell}: narrow table {new} right of the wide one");
}
}
/// A margin-anchored floating table is placed from the anchor page's margin even when a body
/// paragraph keeps trailing empty lines: all 24 preceding paragraphs stay on page one and every
/// table row is drawn exactly once there.
#[test]
fn a_floating_table_ignores_a_paragraphs_empty_lines() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let mut doc = pagination_fixture_document(&[""; 9].join("\n"));
// Visible's line breaks belong inside its paragraph, not separate body paragraphs.
doc.body.push(wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Visible\n\n\n", Default::default())));
doc.body.extend((0..14).map(|_| wordcraft_doc::para_block(wordcraft_doc::Paragraph::new())));
for block in &mut doc.body {
if let Block::Para(para) = Arc::make_mut(block) {
para.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(14.0));
para.props.space_before = Some(0.0);
para.props.space_after = Some(8.0);
}
}
let before_table = lay(&doc);
assert_pagination_fixture_font(&before_table);
assert_eq!(doc.body.len(), 24, "all original body paragraphs remain");
assert_eq!(before_table.pages.len(), 1, "the table's preceding body/anchor must be on page zero");
let preceding: Vec<_> = before_table.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story: StoryRef::Body, path, para, y, .. } if path.0.len() == 1 => Some((path.0[0], *y + para.height)),
_ => None,
})
.collect();
assert_eq!(preceding.iter().map(|(block, _)| *block).collect::<Vec<_>>(), (0..24).collect::<Vec<_>>());
assert!(preceding.last().unwrap().1 < before_table.pages[0].body.bottom(), "the final preceding paragraph actually fits the anchor page");
assert!(
before_table.pages[0].items.iter().any(|it| matches!(it, Placed::Lines { path, para, .. } if path.0 == [9] && para.lines.len() == 4)),
"the visible paragraph retains all three trailing empty lines"
);
let mut table = Table::new(12, 1, 300.0);
for (i, row) in table.rows.iter_mut().enumerate() {
row.cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("Approval {i}"), Default::default()))];
}
table.props.float = Some(TableFloat { h_rel: Anchor::Margin, v_rel: Anchor::Margin, x: 100.0, y: 50.0, ..Default::default() });
let at = doc.body.len();
doc.insert_block(StoryRef::Body, &Path::top(at), wordcraft_doc::Block::Table(table)).unwrap();
let layout = lay(&doc);
assert_pagination_fixture_font(&layout);
let cells: Vec<_> = layout
.pages
.iter()
.flat_map(|page| &page.items)
.filter_map(|it| match it {
Placed::Cell { row, rect, .. } => Some((*row, *rect)),
_ => None,
})
.collect();
assert_eq!(cells.iter().map(|(row, _)| *row).collect::<Vec<_>>(), (0..12).collect::<Vec<_>>(), "every floating row remains once");
assert!((cells[0].1.y - (before_table.pages[0].body.y + 50.0)).abs() < 0.01, "the table keeps its margin-relative 50pt anchor");
let table_pages: Vec<usize> = layout
.pages
.iter()
.enumerate()
.flat_map(|(page, p)| {
p.items.iter().filter_map(move |item| match item {
Placed::Lines { story: StoryRef::Body, path, .. } if path.0.len() > 1 => Some(page),
_ => None,
})
})
.collect();
assert!(
!table_pages.is_empty() && table_pages.iter().all(|page| *page == 0),
"table rows on pages {table_pages:?}; table_block={at} margin_anchor_y=50{}",
pagination_fixture_diagnostics("a_floating_table_ignores_a_paragraphs_empty_lines", Some(&doc), &layout)
);
}
#[test]
fn a_floating_table_taller_than_a_page_runs_across_pages() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let mut d = Document::from_text("After the table.");
let mut t = Table::new(80, 1, 300.0);
for (i, r) in t.rows.iter_mut().enumerate() {
r.cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("Row {i}"), Default::default()))];
}
t.props.float = Some(TableFloat { h_rel: Anchor::Margin, v_rel: Anchor::Paragraph, x: -30.0, overlap: false, ..Default::default() });
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
assert!(l.pages.len() >= 2, "{} page(s)", l.pages.len());
// Every row is drawn on a page, none past a page's bottom margin, and all from the table's
// own left edge.
let mut rows = 0;
for p in &l.pages {
for it in &p.items {
if let Placed::Lines { x, y, story: StoryRef::Body, path, .. } = it
&& path.0.len() > 1
{
rows += 1;
assert!(*y < 792.0 - 72.0, "row drawn at {y}, below the bottom margin");
assert!(*x < 72.0, "row text at {x}, not from the table's edge 30pt left of the margin");
}
}
}
assert_eq!(rows, 80);
}
/// #534: a table placed on the page (`w:tblpPr w:vertAnchor="page"`) whose anchor comes after a
/// page full of text goes to the next page with it, like Word, instead of covering that text.
#[test]
fn a_page_anchored_floating_table_after_a_full_page_moves_to_the_next() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let text: Vec<String> = (0..24).map(|i| format!("Paragraph {i} before the table.")).collect();
let mut d = Document::from_text(&(text.join("\n") + "\nAfter the table."));
let mut t = Table::new(15, 1, 300.0);
for (i, r) in t.rows.iter_mut().enumerate() {
r.cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("Row {i}"), Default::default()))];
}
t.props.float = Some(TableFloat { h_rel: Anchor::Page, v_rel: Anchor::Page, x: 70.0, y: 71.0, ..Default::default() });
d.insert_block(StoryRef::Body, &Path::top(24), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let page_of = |want: &dyn Fn(&Path) -> bool| -> Vec<usize> {
l.pages
.iter()
.enumerate()
.flat_map(|(i, p)| p.items.iter().map(move |it| (i, it)))
.filter_map(|(i, it)| if let Placed::Lines { story: StoryRef::Body, path, .. } = it { want(path).then_some(i) } else { None })
.collect()
};
// The text before the table fills page 1; the table and the text after it are on page 2.
assert_eq!(page_of(&|p| p.0 == [23]), vec![0]);
let rows = page_of(&|p| p.0.first() == Some(&24) && p.0.len() > 1);
assert!(rows.len() == 15 && rows.iter().all(|pg| *pg == 1), "table rows on pages {rows:?}");
assert_eq!(page_of(&|p| p.0 == [25]), vec![1]);
}
/// #534: a paragraph that starts with a page break right where the page is full keeps the break
/// on that page: no blank page between the two tables around it.
#[test]
fn a_page_break_at_the_bottom_of_a_full_page_leaves_no_blank_page() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
let props = ParaProps { line_spacing: Some(LineSpacing::Exactly(24.0)), space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
let para = |text: &str| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props = props.clone();
wordcraft_doc::para_block(p)
};
let mut d = Document::from_text("");
// 27 lines of 24pt fill the 648pt of text on a Letter page.
d.body = (0..27).map(|i| para(&format!("Line {i}"))).collect();
d.body.push(para("\u{000C}Next page"));
let l = lay(&d);
assert_eq!(l.pages.len(), 2, "pages: {}", l.pages.len());
let last_on_2 = l.pages[1].items.iter().any(|it| matches!(it, Placed::Lines { path, .. } if path.0 == [27]));
assert!(last_on_2, "the text after the break is on page 2");
}
/// #534: indents in characters (`w:firstLineChars`) are measured in the paragraph mark's font
/// size and win over the indent in points.
#[test]
fn character_indents_use_the_paragraph_mark_size() {
crate::test_fonts();
let mut p = wordcraft_doc::Paragraph::with_text(&"字".repeat(80), Default::default());
p.props.indent_first = Some(5.0);
p.props.indent_first_chars = Some(2.0);
p.props.indent_left_chars = Some(1.0);
p.mark.size = Some(20.0);
let mut d = Document::from_text("");
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
let para = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para.clone()) } else { None }).unwrap();
assert!((para.lines[0].left - 60.0).abs() < 0.01, "first line at {}", para.lines[0].left);
assert!((para.lines[1].left - 20.0).abs() < 0.01, "second line at {}", para.lines[1].left);
}
#[test]
fn no_line_break_right_after_a_slash() {
crate::test_fonts();
// Word keeps "and/or" and web addresses whole on a line when they fit.
let text = "word and/or https://example.org/keepers/log/winter ".repeat(40);
let d = Document::from_text(&text);
let l = lay(&d);
let mut lines = 0;
for p in &l.pages {
for it in &p.items {
if let Placed::Lines { para, l0, l1, .. } = it {
for line in ¶.lines[*l0..*l1] {
lines += 1;
assert!(!text[..line.start].ends_with('/'), "line starts after a slash: {:?}", &text[line.start..line.stop]);
}
}
}
}
assert!(lines > 10, "{lines} lines");
}
/// The text of every laid-out line.
fn body_lines(l: &DocLayout, text: &str) -> Vec<String> {
l.pages
.iter()
.flat_map(|p| &p.items)
.filter_map(|it| {
if let Placed::Lines { para, l0, l1, .. } = it {
Some(para.lines[*l0..*l1].iter().map(|line| text[line.start..line.stop].to_string()))
} else {
None
}
})
.flatten()
.collect()
}
#[test]
fn no_line_break_inside_a_query_address() {
// Word keeps "/?type=" and "/_back" whole (measured: a request address went to the next
// line whole, a long one breaking only where it no longer fits).
for addr in ["https://example.org/portal/_back/?type=objects_export&action=get", "https://example.org/portal/_back_office/reports/_export_all"] {
for k in 0..60 {
let text = format!("{}{addr} end", "a ".repeat(k));
let lines = body_lines(&lay(&Document::from_text(&text)), &text);
for (a, b) in lines.iter().zip(&lines[1..]) {
assert!(!a.ends_with('?') && !a.ends_with('/'), "{k}: a line ends inside the address: {a:?} / {b:?}");
}
}
}
}
/// A path that starts after a space ("caption /_back") wraps whole: UAX #14 has no break between
/// the space and the slash, so the break before the slash is the only one there.
#[test]
fn a_path_after_a_space_wraps_whole() {
let text = "enregistrement /_back_office_reports";
let mut wrapped = 0;
// Down to the width where the path still fits on a line (it no longer does at 425 pt).
for m in 100..=420 {
let mut d = Document::from_text(text);
d.last_section.margin_right = m as f32;
let lines = body_lines(&lay(&d), text);
if lines.len() < 2 {
continue; // fits on one line
}
wrapped += 1;
assert_eq!(lines, ["enregistrement ", "/_back_office_reports"], "the path is split at margin {m}");
}
assert!(wrapped > 50, "{wrapped} widths wrapped");
}
/// A question mark in CJK text keeps the break after it: only a query's `?` before an ASCII
/// letter, digit or underscore loses it.
#[test]
fn a_question_mark_in_cjk_text_keeps_its_break() {
let text = "你好?世界".repeat(40);
let mut ended = false;
for m in 300..=440 {
let mut d = Document::from_text(&text);
d.last_section.margin_right = m as f32;
let lines = body_lines(&lay(&d), &text);
ended |= lines[..lines.len() - 1].iter().any(|l| l.ends_with('?'));
}
assert!(ended, "no line ever ends after the question mark");
}
/// #2963: a word after a slash ("caption /заполняется") wraps whole, as in Word. UAX #14 forbids a
/// break between the space and the slash, and the break after the slash is dropped (Word keeps
/// "and/or" whole), so the slash word had no break before it and split between two letters.
#[test]
fn a_word_after_a_slash_wraps_whole() {
crate::test_fonts();
let (head, slash, tail) = ("ЖСН енгізілмеген жағдайда толтырылады", " /", "заполняется в случае неприсвоения ИИН");
let text = format!("{head}{slash}{tail}");
let italic = wordcraft_doc::CharProps { italic: Some(true), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::new();
p.text = text.clone();
p.runs = vec![
wordcraft_doc::Run { len: head.len(), props: italic.clone() },
wordcraft_doc::Run { len: slash.len(), props: Default::default() },
wordcraft_doc::Run { len: tail.len(), props: italic },
];
let mut wrapped = 0;
// Down to the width where the longest word still fits on a line: from there on, a line may
// only end at a space.
for m in 100..=450 {
let mut d = Document::from_text("");
d.body = vec![wordcraft_doc::para_block(p.clone())];
d.last_section.margin_right = m as f32;
let l = lay(&d);
let lines: Vec<String> = l.pages[0]
.items
.iter()
.filter_map(|it| {
if let Placed::Lines { para, l0, l1, .. } = it {
Some(para.lines[*l0..*l1].iter().map(|line| text[line.start..line.stop].to_string()).collect::<Vec<_>>())
} else {
None
}
})
.flatten()
.collect();
if lines.len() < 2 {
continue; // fits on one line
}
wrapped += 1;
let (last, rest) = lines.split_last().expect("lines");
assert!(rest.iter().all(|l| l.ends_with(' ')), "a word is split at margin {m}: {lines:?}");
assert!(!last.is_empty());
}
assert!(wrapped > 100, "{wrapped} widths wrapped");
}
/// #2963 happened in a fixed-width table cell: the cell's own width is the line width there.
#[test]
fn a_word_after_a_slash_wraps_whole_in_a_fixed_cell() {
crate::test_fonts();
let (head, slash, tail) = ("ЖСН енгізілмеген жағдайда толтырылады", " /", "заполняется в случае неприсвоения ИИН");
let text = format!("{head}{slash}{tail}");
let italic = wordcraft_doc::CharProps { italic: Some(true), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::new();
p.text = text.clone();
p.runs = vec![
wordcraft_doc::Run { len: head.len(), props: italic.clone() },
wordcraft_doc::Run { len: slash.len(), props: Default::default() },
wordcraft_doc::Run { len: tail.len(), props: italic },
];
let mut wrapped = 0;
// From the width where the longest word fits in the cell.
for width in 90..=400 {
let mut table = Table::new(1, 1, width as f32);
table.props.style = None;
table.props.fixed = true;
table.props.cell_margins = Some([0.0; 4]);
table.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p.clone())];
let mut d = Document::new();
d.body = vec![std::sync::Arc::new(Block::Table(table))];
let l = lay(&d);
let lines: Vec<String> = l.pages[0]
.items
.iter()
.filter_map(|it| {
if let Placed::Lines { para, l0, l1, .. } = it {
Some(para.lines[*l0..*l1].iter().map(|line| text[line.start..line.stop].to_string()).collect::<Vec<_>>())
} else {
None
}
})
.flatten()
.collect();
if lines.len() < 2 {
continue; // fits on one line
}
wrapped += 1;
let (_, rest) = lines.split_last().expect("lines");
assert!(rest.iter().all(|l| l.ends_with(' ')), "a word is split at cell width {width}: {lines:?}");
}
assert!(wrapped > 100, "{wrapped} widths wrapped");
}
/// The break before a slash word (#2963) needs a breakable space: a no-break space before the
/// slash keeps it on the line.
#[test]
fn a_no_break_space_before_a_slash_still_holds() {
crate::test_fonts();
let starts = |nb: char| -> (usize, usize) {
// Varying word lengths, so the lines end at different places in the pattern.
let text: String = (0..80).map(|i| format!("caption{nb}/word {} ", "w".repeat(1 + i % 5))).collect();
let l = lay(&Document::from_text(&text));
let (mut lines, mut at_slash) = (0, 0);
for p in &l.pages {
for it in &p.items {
if let Placed::Lines { para, l0, l1, .. } = it {
for line in ¶.lines[*l0..*l1] {
lines += 1;
at_slash += usize::from(text[..line.start].ends_with(nb));
}
}
}
}
(lines, at_slash)
};
let (lines, at_slash) = starts(' ');
assert!(lines > 10 && at_slash > 0, "control: {at_slash} of {lines} lines start at a slash word");
for nb in ['\u{a0}', '\u{2007}', '\u{202f}'] {
let (lines, at_slash) = starts(nb);
assert!(lines > 10, "{lines} lines");
assert_eq!(at_slash, 0, "lines start after {nb:?}");
}
}
#[test]
#[cfg_attr(coverage, ignore = "coverage instrumentation skews the time ratio")]
fn unequal_formats_lay_out_in_linear_time() {
crate::test_fonts();
// Runs whose formats never compare equal (NaN spacing from a hostile file) each get a style;
// finding a run's style must not compare it against every earlier one.
let doc = |n: usize| {
let mut p = wordcraft_doc::Paragraph::with_text("", Default::default());
p.text = "ab ".repeat(n);
p.runs = (0..n)
.map(|i| wordcraft_doc::Run {
len: 3,
props: wordcraft_doc::CharProps { spacing: Some(f32::NAN), bold: Some(i % 2 == 0), ..Default::default() },
})
.collect();
let mut d = Document::from_text("");
d.body = vec![wordcraft_doc::para_block(p)];
d
};
let (t1, tk, ratio) = layout_time_ratio(doc, 5_000, &LayoutOptions::default());
eprintln!("t(n) {t1:.4} s, t(8n) {tk:.4} s, ratio {ratio:.1}");
assert!(ratio < 24.0, "8x the runs took {ratio:.1}x the time ({t1:.4} s → {tk:.4} s): not linear");
}
#[test]
fn formats_past_65536_in_a_paragraph_keep_their_own_style() {
crate::test_fonts();
// More distinct formats than a 16-bit index counts (the paragraph mark takes a style too): every
// run past that limit still draws with its own link, deletion and size, not an earlier run's.
let n = usize::from(u16::MAX) + 3;
let props = |i: usize| wordcraft_doc::CharProps {
link: Some(format!("#r{i}")),
del: (i % 2 == 1).then_some(0),
size: Some(if i.is_multiple_of(3) { 9.0 } else { 11.0 }),
..Default::default()
};
let mut p = wordcraft_doc::Paragraph::with_text("", Default::default());
p.text = "ab ".repeat(n);
p.runs = (0..n).map(|i| wordcraft_doc::Run { len: 3, props: props(i) }).collect();
let mut d = Document::from_text("");
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages.iter().flat_map(|pg| pg.items.iter()).find(|i| matches!(i, Placed::Lines { .. })) else {
panic!("no lines")
};
assert!(para.styles.len() > n, "{} styles for {n} formats", para.styles.len());
let mut last = 0;
for c in ¶.clusters {
let i = c.start / 3;
let rc = ¶.styles[c.style as usize].rc;
let want = props(i);
assert_eq!((&rc.link, rc.del, rc.size), (&want.link, want.del, want.size.unwrap()), "run {i}");
last = last.max(i);
}
assert_eq!(last, n - 1);
}
#[test]
fn hidden_float_in_a_table_cell_takes_no_room() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
// A square-wrapped shape anchored in hidden text inside a table cell, beside wrapping text.
let mut d = Document::from_text("Body text.");
let mut t = Table::new(1, 2, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text(&"Cell words wrap around it. ".repeat(8), Default::default());
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist: 9.0, ..Default::default() };
let hidden = wordcraft_doc::CharProps { hidden: Some(true), ..Default::default() };
cp.insert_object(0, rect_shape(60.0, 40.0, f), &hidden).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cp)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
// (shapes placed, the cell text's widest first-line indent)
let run = |show_hidden: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
let items = &l.pages[0].items;
let left = items
.iter()
.filter_map(|i| if let Placed::Lines { para, .. } = i { para.lines.first().map(|l| l.left) } else { None })
.fold(0.0f32, f32::max);
(shapes(items).len(), left)
};
let (n, left) = run(true);
assert!(n == 1 && left >= 60.0, "shown: placed and wrapped around ({n}, {left})");
assert_eq!(run(false), (0, 0.0), "hidden: not placed, no wrap area");
}
#[test]
fn objects_left_out_through_the_table_style_formatting() {
crate::test_fonts();
// The table style's character formatting sits under the runs' own, as the cell is laid out.
let mut p = wordcraft_doc::Paragraph::with_text("ab", Default::default());
p.insert_object(1, rect_shape(10.0, 10.0, Default::default()), &Default::default()).unwrap();
let d = Document::from_text("");
let hidden = wordcraft_doc::CharProps { hidden: Some(true), ..Default::default() };
assert!(!left_out_objects(&d, &p, None, false, HideDeleted::default())(0));
assert!(left_out_objects(&d, &p, Some(&hidden), false, HideDeleted::default())(0));
assert!(!left_out_objects(&d, &p, Some(&hidden), true, HideDeleted::default())(0), "hidden text shown");
}
#[test]
fn hidden_float_in_a_text_box_is_not_placed() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
// A shape anchored in hidden text inside a text box: no drawing, no hit area.
let mut d = Document::from_text("Body text.");
let id = text_box(&mut d, 0, "Box words.", 200.0, 120.0, Default::default());
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, ..Default::default() };
let hidden = wordcraft_doc::CharProps { hidden: Some(true), ..Default::default() };
let at = Pos { story: StoryRef::Part(id), path: Path::top(0), off: 0 };
d.insert_object(&at, rect_shape(30.0, 20.0, f), &hidden).unwrap();
let count = |show_hidden: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
let items = &l.pages[0].items;
let areas = items.iter().filter(|i| matches!(i, Placed::Object { story: StoryRef::Part(_), .. })).count();
(shapes(items).len(), areas)
};
let (shown, shown_areas) = count(true);
let (hidden_n, hidden_areas) = count(false);
assert_eq!((shown - hidden_n, shown_areas - hidden_areas), (1, 1), "shown {shown}/{shown_areas}, hidden {hidden_n}/{hidden_areas}");
}
#[test]
fn inline_graphic_reserves_its_height() {
crate::test_fonts();
let mut d = Document::from_text("Chart\nAfter");
let obj = InlineObject::Graphic { w: 216.0, h: 144.0, alt: String::new(), float: Default::default(), graphic: Arc::new(Default::default()) };
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let l = lay(&d);
let tops: Vec<f32> = l.pages[0].items.iter().filter_map(|i| if let Placed::Lines { y, .. } = i { Some(*y) } else { None }).collect();
assert_eq!(tops.len(), 2);
assert!(tops[1] - tops[0] >= 144.0, "the next paragraph starts below the chart: {tops:?}");
}
#[test]
fn graphic_items_draw_inside_the_object() {
crate::test_fonts();
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind, PathSeg, TextAlign};
use wordcraft_doc::props::Rgb;
let items = vec![
GraphicItem::Shape {
rect: [10.0, 5.0, 20.0, 20.0],
kind: wordcraft_doc::para::ShapeKind::Rectangle,
fill: Some(Rgb::BLACK),
stroke: None,
stroke_width: 0.0,
},
GraphicItem::Path {
segs: vec![PathSeg::Move(1.0, 2.0), PathSeg::Line(30.0, 40.0), PathSeg::Close],
fill: None,
stroke: Some(Rgb::BLACK),
stroke_width: 0.0,
},
GraphicItem::Text {
rect: [0.0, 100.0, 216.0, 20.0],
text: "Q1".into(),
size: 10.0,
color: Rgb::BLACK,
bold: false,
align: TextAlign::Center,
font: None,
angle: 0.0,
},
];
let mut d = Document::from_text("Chart");
let graphic = Graphic { kind: GraphicKind::Chart, items, ..Default::default() };
let obj = InlineObject::Graphic { w: 216.0, h: 144.0, alt: String::new(), float: Default::default(), graphic: Arc::new(graphic) };
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let l = lay(&d);
// The chart's draws sit inside its figure.
let draws = flat(display::page_display(&d, &l.pages[0], &Default::default()));
let shape = draws.iter().find_map(|x| if let display::Draw::Shape { rect, .. } = x { Some(*rect) } else { None }).expect("a shape");
let first = draws.iter().find_map(|x| if let display::Draw::Path { segs, .. } = x { segs.first().copied() } else { None }).expect("a path");
let PathSeg::Move(mx, my) = first else { panic!("{first:?}") };
// Path points are page coordinates, moved with the object like the shape's rectangle.
assert_eq!((mx - shape.x, my - shape.y), (1.0 - 10.0, 2.0 - 5.0));
assert!(draws.iter().any(|x| matches!(x, display::Draw::Glyphs { text, .. } if text == "Q1")));
}
#[test]
fn graphic_text_in_a_degenerate_rectangle_is_not_drawn() {
crate::test_fonts();
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind, TextAlign};
use wordcraft_doc::props::Rgb;
let text = |rect: [f32; 4], size: f32| GraphicItem::Text {
rect,
text: "Q1".into(),
size,
color: Rgb::BLACK,
bold: false,
align: TextAlign::Center,
font: None,
angle: 0.0,
};
let items = vec![text([f32::NAN, 0.0, 10.0, 10.0], 10.0), text([0.0, 0.0, f32::INFINITY, 10.0], 10.0), text([0.0, 0.0, 10.0, 10.0], f32::NAN)];
let graphic = Graphic { kind: GraphicKind::Diagram, items, ..Default::default() };
let obj = InlineObject::Graphic { w: 216.0, h: 144.0, alt: String::new(), float: Default::default(), graphic: Arc::new(graphic) };
let mut d = Document::from_text("Chart");
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let draws = flat(display::page_display(&d, &lay(&d).pages[0], &Default::default()));
assert!(!draws.iter().any(|x| matches!(x, display::Draw::Glyphs { text, .. } if text == "Q1")));
}
/// A chart's vertical axis title (text turned -90°) is laid out along its tall box and drawn
/// turned about the box's center.
#[test]
fn turned_graphic_text_is_drawn_turned_about_its_box() {
crate::test_fonts();
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind, TextAlign};
use wordcraft_doc::props::Rgb;
let items = vec![GraphicItem::Text {
rect: [0.0, 20.0, 20.0, 100.0],
text: "Sales".into(),
size: 10.0,
color: Rgb::BLACK,
bold: false,
align: TextAlign::Center,
font: None,
angle: -90.0,
}];
let graphic = Graphic { kind: GraphicKind::Chart, items, ..Default::default() };
let obj = InlineObject::Graphic { w: 216.0, h: 144.0, alt: String::new(), float: Default::default(), graphic: Arc::new(graphic) };
let mut d = Document::from_text("Chart");
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let draws = flat(display::page_display(&d, &lay(&d).pages[0], &Default::default()));
let turned = draws
.iter()
.find_map(|x| match x {
display::Draw::Rotated { cx, cy, spin, items } => Some((*cx, *cy, *spin, items)),
_ => None,
})
.expect("the title is turned");
let (cx, cy, spin, items) = turned;
assert_eq!(spin.deg, 270.0);
let Some(display::Draw::Glyphs { glyphs, text, .. }) = items.first() else { panic!("{items:?}") };
assert_eq!(text, "Sales");
// Laid out level across the box's 100 pt height, centered on the box's center.
let (first, last) = (glyphs[0].1, glyphs[glyphs.len() - 1].1);
assert!(first > cx - 50.0 && last < cx + 50.0 && first < cx && last > cx, "{first} {last} about {cx}");
assert!((glyphs[0].2 - cy).abs() < 10.0, "baseline {} near {cy}", glyphs[0].2);
}
#[test]
fn chart_text_the_font_lacks_is_drawn_in_a_fallback_face() {
crate::test_fonts();
// #4720: a Chinese legend in a chart drawn in the body font (which has no Chinese) showed boxes.
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind, TextAlign};
use wordcraft_doc::props::Rgb;
crate::test_fonts();
if wordcraft_fonts::FontDb::global().fallback_for('销', 0).is_none() {
eprintln!("skipped: no Chinese font installed");
return;
}
let label = "Sales 销售额 2024";
let items = vec![GraphicItem::Text {
rect: [0.0, 100.0, 216.0, 20.0],
text: label.into(),
size: 10.0,
color: Rgb::BLACK,
bold: false,
align: TextAlign::Center,
font: None,
angle: 0.0,
}];
let graphic = Graphic { kind: GraphicKind::Chart, items, ..Default::default() };
let obj = InlineObject::Graphic { w: 216.0, h: 144.0, alt: String::new(), float: Default::default(), graphic: Arc::new(graphic) };
let mut d = Document::from_text("Chart");
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let draws = flat(display::page_display(&d, &lay(&d).pages[0], &Default::default()));
let runs: Vec<_> = draws
.iter()
.filter_map(|x| if let display::Draw::Glyphs { face, text, glyphs, .. } = x { Some((*face, text.as_str(), glyphs)) } else { None })
.filter(|(_, text, _)| label.contains(*text) && text.trim() != "")
.collect();
// The label is drawn whole, in reading order, each character in a face that has it.
assert_eq!(runs.iter().map(|(_, t, _)| *t).collect::<String>(), label);
for (face, text, glyphs) in &runs {
for c in text.chars().filter(|c| !c.is_whitespace()) {
assert!(face.covers(c), "{c} in {}", face.family);
}
assert!(glyphs.iter().all(|g| g.0 != 0), "no missing glyphs in {text:?}");
}
// The Chinese takes one face, and the runs follow each other along the line.
assert_eq!(runs.iter().filter(|(_, t, _)| t.contains('销')).count(), 1);
assert!(runs.iter().any(|(_, t, _)| t.contains("销售额")), "{:?}", runs.iter().map(|r| r.1).collect::<Vec<_>>());
let xs: Vec<f32> = runs.iter().flat_map(|(_, _, g)| g.iter().map(|g| g.1)).collect();
assert!(xs.windows(2).all(|w| w[0] <= w[1]), "{xs:?}");
}
/// The draws with figures opened up.
fn flat(draws: Vec<display::Draw>) -> Vec<display::Draw> {
draws.into_iter().flat_map(|x| if let display::Draw::Figure { draws, .. } = x { draws } else { vec![x] }).collect()
}
#[test]
fn inline_chart_is_a_figure_with_its_alt_text() {
crate::test_fonts();
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind, PathSeg};
use wordcraft_doc::props::Rgb;
let items = vec![GraphicItem::Path {
segs: vec![PathSeg::Move(1.0, 1.0), PathSeg::Line(2.0, 2.0)],
fill: None,
stroke: Some(Rgb::BLACK),
stroke_width: 1.0,
}];
let graphic = Graphic { kind: GraphicKind::Chart, items, ..Default::default() };
let obj = InlineObject::Graphic { w: 216.0, h: 144.0, alt: "Sales by quarter".into(), float: Default::default(), graphic: Arc::new(graphic) };
let mut d = Document::from_text("Chart");
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let draws = display::page_display(&d, &lay(&d).pages[0], &Default::default());
let figure = draws.iter().find_map(|x| if let display::Draw::Figure { alt, draws, .. } = x { Some((alt.clone(), draws.len())) } else { None });
assert_eq!(figure, Some(("Sales by quarter".to_string(), 1)));
}
#[test]
fn graphic_paths_drop_segments_that_cannot_be_drawn() {
crate::test_fonts();
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind, PathSeg};
use wordcraft_doc::props::Rgb;
// The line before the first move, the move with a NaN, the infinite line and the line after the
// close are all dropped.
let segs = vec![
PathSeg::Line(5.0, 5.0),
PathSeg::Move(f32::NAN, 1.0),
PathSeg::Move(1.0, 2.0),
PathSeg::Line(3.0, 4.0),
PathSeg::Line(f32::INFINITY, 0.0),
PathSeg::Close,
PathSeg::Line(9.0, 9.0),
];
let items = vec![GraphicItem::Path { segs, fill: None, stroke: Some(Rgb::BLACK), stroke_width: 1.0 }];
let graphic = Graphic { kind: GraphicKind::Chart, items, ..Default::default() };
let obj = InlineObject::Graphic { w: 216.0, h: 144.0, alt: String::new(), float: Default::default(), graphic: Arc::new(graphic) };
let mut d = Document::from_text("Chart");
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let draws = flat(display::page_display(&d, &lay(&d).pages[0], &Default::default()));
let segs: Vec<PathSeg> =
draws.iter().find_map(|x| if let display::Draw::Path { segs, .. } = x { Some(segs.clone()) } else { None }).expect("a path");
assert!(matches!(segs.as_slice(), [PathSeg::Move(x, y), PathSeg::Line(..), PathSeg::Close] if x.is_finite() && y.is_finite()), "{segs:?}");
}
#[test]
fn graphic_items_scale_with_their_frame() {
crate::test_fonts();
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind};
use wordcraft_doc::props::Rgb;
// A chart drawn for 1000 x 500 pt in a 500 x 250 pt frame: its items and strokes scale by half.
let items = vec![GraphicItem::Shape {
rect: [0.0, 0.0, 1000.0, 500.0],
kind: wordcraft_doc::para::ShapeKind::Rectangle,
fill: None,
stroke: Some(Rgb::BLACK),
stroke_width: 4.0,
}];
let graphic = Graphic { kind: GraphicKind::Chart, items, w: 1000.0, h: 500.0, source: None, chart: None, smart_art: None };
let obj = InlineObject::Graphic { w: 500.0, h: 250.0, alt: String::new(), float: Default::default(), graphic: Arc::new(graphic) };
let mut d = Document::from_text("Chart");
d.insert_object(&Pos::body(0, 0), obj, &Default::default()).unwrap();
let draws = flat(display::page_display(&d, &lay(&d).pages[0], &Default::default()));
let (r, stroke) = draws
.iter()
.find_map(|x| if let display::Draw::Shape { rect, stroke_width, .. } = x { Some((*rect, *stroke_width)) } else { None })
.expect("a shape");
assert!((r.w - 500.0).abs() < 1e-3 && (r.h - 250.0).abs() < 1e-3, "{r:?}");
assert!((stroke - 2.0).abs() < 1e-5, "stroke {stroke}");
}
#[test]
fn inline_picture_wider_than_a_text_box_is_fitted_to_it() {
crate::test_fonts();
// Text boxes don't clip what runs past their sides, so a 400 x 100 pt picture in a 144 pt box
// is fitted to the box's 129.6 pt inside its margins instead of spilling over the page.
let mut d = Document::from_text("Before");
let mut p = wordcraft_doc::Paragraph::with_text("", Default::default());
p.insert_object(0, picture(400.0, 100.0, Default::default()), &Default::default()).unwrap();
let id = d.add_part(wordcraft_doc::PartKind::TextBox, vec![wordcraft_doc::para_block(p)]);
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::TextBox,
w: 144.0,
h: 72.0,
fill: None,
stroke: None,
stroke_width: 0.75,
float: Default::default(),
story: Some(id),
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let l = lay(&d);
let draws = flat(display::page_display(&d, &l.pages[0], &Default::default()));
let r = draws
.iter()
.find_map(|x| match x {
display::Draw::Shape { rect, kind: wordcraft_doc::para::ShapeKind::Rectangle, .. } => Some(*rect),
_ => None,
})
.expect("the picture");
assert!((r.w - 129.6).abs() < 0.1 && (r.h - 32.4).abs() < 0.1, "{r:?}");
}
#[test]
fn inline_picture_wider_than_the_text_keeps_its_size() {
crate::test_fonts();
// A 1000 x 100 pt picture in 468 pt of text: Word draws it at its size, past the margin, and the
// page edge clips it; the line is as tall as the picture (docxide-pdf's case179).
let mut d = Document::from_text("");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.insert_object(0, picture(1000.0, 100.0, Default::default()), &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let line = ¶.lines[0];
assert!((line.baseline - line.top - 100.0).abs() < 0.01, "the picture keeps its height: {line:?}");
let draws = flat(display::page_display(&d, &l.pages[0], &Default::default()));
let r = draws.iter().find_map(|x| if let display::Draw::Shape { rect, .. } = x { Some(*rect) } else { None }).expect("the picture");
assert!((r.w - 1000.0).abs() < 0.01 && (r.h - 100.0).abs() < 0.01, "{r:?}");
}
/// A floating object's anchor takes no room on a line: an inline picture a little wider than the
/// line, after an anchor, stays on the first line as the line's first item, instead of leaving
/// the anchor an empty line of its own above it (Word).
#[test]
fn a_float_anchor_does_not_push_a_wide_picture_to_a_second_line() {
crate::test_fonts();
let lines_of = |with_anchor: bool| {
let mut d = Document::from_text("");
let mut at = Pos::body(0, 0);
if with_anchor {
at = d.insert_object(&at, rect_shape(50.0, 30.0, page_float(300.0, 300.0)), &Default::default()).unwrap();
}
// 480 pt wide on a 468 pt line.
d.insert_object(&at, picture(480.0, 100.0, wordcraft_doc::para::Float::default()), &Default::default()).unwrap();
let l = lay(&d);
para_at(&l, &[0])[0].2
};
assert_eq!(lines_of(false), 1);
assert_eq!(lines_of(true), 1, "the anchor gets no line of its own");
}
#[test]
fn a_picture_too_wide_after_a_content_control_start_stays_on_the_first_line() {
crate::test_fonts();
// The picture opening a picture content control (a logo in a text box a little too
// narrow for it): the control's start marker before it takes no room, so the picture is
// still the line's first item and stays there instead of leaving an empty line above it.
let mut d = Document::from_text("");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.insert_object(0, picture(500.0, 100.0, Default::default()), &Default::default()).unwrap();
let start = InlineObject::ControlStart { control: Box::default() };
p.insert_object(0, start, &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
assert_eq!(para.lines.len(), 1, "{:?}", para.lines);
let line = ¶.lines[0];
assert!((line.baseline - line.top - 100.0).abs() < 0.01, "the picture is on the first line: {line:?}");
}
/// The paragraph at `path` on page 0: its first line's x, its y and its line count.
fn para_at(l: &DocLayout, path: &[u32]) -> Vec<(f32, f32, usize)> {
l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { x, y, para, path: p, .. } if p.0 == path => Some((*x + para.lines.first().map_or(0.0, |l| l.left), *y, para.lines.len())),
_ => None,
})
.collect()
}
#[test]
fn a_floating_table_in_a_cell_takes_no_room_and_the_cell_holds_it() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let text = |s: &str| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(s, Default::default()));
let mut inner = Table::new(3, 1, 200.0);
for (i, r) in inner.rows.iter_mut().enumerate() {
r.cells[0].blocks = vec![text(&format!("Inner {i}"))];
}
inner.props.float = Some(TableFloat { h_rel: Anchor::Margin, v_rel: Anchor::Paragraph, dist: [9.0, 0.0, 9.0, 0.0], ..Default::default() });
let mut outer = Table::new(1, 1, 468.0);
outer.rows[0].cells[0].blocks = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(inner)), text("Beside")];
let mut d = Document::from_text("Below");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(outer)).unwrap();
let l = lay(&d);
let (&[(ix, iy, _)], &[(_, last_y, _)], &[(bx, by, _)], &[(_, below_y, _)]) =
(¶_at(&l, &[0, 0, 0, 0, 0, 0, 0])[..], ¶_at(&l, &[0, 0, 0, 0, 2, 0, 0])[..], ¶_at(&l, &[0, 0, 0, 1])[..], ¶_at(&l, &[1])[..])
else {
panic!("lines missing")
};
// The paragraph after the floating table runs beside it, level with its top.
assert!((by - iy).abs() < 2.0, "beside at {by}, inner table at {iy}");
assert!(bx > ix + 200.0, "beside text at {bx}, inner table text at {ix}");
// The cell grows to hold the whole floating table.
assert!(below_y > last_y + 10.0, "text below the outer table at {below_y}, the inner table's last row at {last_y}");
}
/// A floating (anchored, non-inline) picture in a cell grows the row to hold it too, the same
/// way a floating table does: it must not hang past the row's own bottom edge and overlap
/// whatever follows the table (#3108).
#[test]
fn a_floating_picture_in_a_cell_grows_the_row_to_hold_it() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut t = Table::new(1, 1, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text("Caption", Default::default());
// Short text alone would need one line (well under 100pt); the floated picture is much
// taller than that, so only its own height should set the row's height.
let picture = Float { wrap: Wrap::Square, h_rel: Anchor::Margin, v_rel: Anchor::Margin, x: 0.0, y: 0.0, ..Default::default() };
cp.insert_object(0, rect_shape(200.0, 300.0, picture), &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cp)];
let mut d = Document::from_text("Below the table");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let [(_, row_y, _)] = para_at(&l, &[0, 0, 0, 0])[..] else { panic!("cell text line missing") };
let [(_, below_y, _)] = para_at(&l, &[1])[..] else { panic!("line after the table missing") };
assert!(below_y - row_y > 290.0, "text after the table at {below_y}, the row's text at {row_y}: the row didn't grow for the 300pt picture");
}
#[test]
fn a_rotated_floating_picture_grows_the_row_by_its_rotated_extent() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut t = Table::new(1, 1, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text("Caption", Default::default());
// Unrotated this shape's own `rect.bottom()` is only 40pt down. Rotated 90° about its centre
// (`Spin::bounds`: width and height swap), its drawn bottom moves to (w+h)/2 = 220pt down —
// using the unrotated rect here would undergrow the row to a fraction of that.
let picture = Float { wrap: Wrap::Square, h_rel: Anchor::Margin, v_rel: Anchor::Margin, x: 0.0, y: 0.0, rot: 90.0, ..Default::default() };
cp.insert_object(0, rect_shape(400.0, 40.0, picture), &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cp)];
let mut d = Document::from_text("Below the table");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let [(_, row_y, _)] = para_at(&l, &[0, 0, 0, 0])[..] else { panic!("cell text line missing") };
let [(_, below_y, _)] = para_at(&l, &[1])[..] else { panic!("line after the table missing") };
assert!(
below_y - row_y > 150.0,
"text after the table at {below_y}, the row's text at {row_y}: the row didn't grow for the picture's rotated extent (unrotated bottom is only 40pt, rotated should reach ~220pt)"
);
}
/// #3108 review: only floats that take part in the text flow grow the row. A behind-text (or
/// in-front-of-text) picture taller than the cell's text leaves the row at the text's height, as
/// in Word — a page-anchored logo or watermark behind a cell must not stretch its row.
#[test]
fn a_behind_or_in_front_of_text_picture_in_a_cell_leaves_the_row_alone() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let row_gap = |wrap: Wrap| {
let mut t = Table::new(1, 1, 468.0);
let mut cp = wordcraft_doc::Paragraph::with_text("Caption", Default::default());
let picture = Float { wrap, h_rel: Anchor::Margin, v_rel: Anchor::Margin, x: 0.0, y: 0.0, ..Default::default() };
cp.insert_object(0, rect_shape(200.0, 300.0, picture), &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cp)];
let mut d = Document::from_text("Below the table");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let [(_, row_y, _)] = para_at(&l, &[0, 0, 0, 0])[..] else { panic!("cell text line missing") };
let [(_, below_y, _)] = para_at(&l, &[1])[..] else { panic!("line after the table missing") };
below_y - row_y
};
for wrap in [Wrap::BehindText, Wrap::InFrontOfText] {
let gap = row_gap(wrap);
assert!(gap < 60.0, "{wrap:?}: text after the table is {gap}pt below the cell's text; the 300pt picture grew the row");
}
}
#[test]
fn autofit_sizes_columns_by_their_content() {
crate::test_fonts();
let text = |s: &str| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(s, Default::default()));
// No width anywhere: the columns come from their content.
let mut t = Table::new(1, 2, 468.0);
t.rows[0].cells[0].blocks = vec![text("Short")];
t.rows[0].cells[1].blocks = vec![text(&"A long cell that needs most of the width. ".repeat(4))];
t.rows[0].cells.iter_mut().for_each(|c| c.props.width = None);
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let (&[(sx, _, _)], &[(lx, _, _)]) = (¶_at(&l, &[0, 0, 0, 0])[..], ¶_at(&l, &[0, 0, 1, 0])[..]) else { panic!("lines missing") };
assert!(lx - sx < 80.0, "the short column is {}pt wide", lx - sx);
// A grid column narrower than its longest word grows; the others give up the difference.
let mut t = Table::new(1, 3, 468.0);
t.grid = vec![400.0, 20.0, 48.0];
t.rows[0].cells[1].blocks = vec![text("Unbreakable")];
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let [(_, _, n)] = para_at(&l, &[0, 0, 1, 0])[..] else { panic!("line missing") };
assert_eq!(n, 1, "the word is broken over {n} lines");
}
#[test]
fn autofit_handles_spanning_cells_long_words_and_empty_tables() {
crate::test_fonts();
let text = |s: &str| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(s, Default::default()));
let table_x = |t: Table, path: &[u32]| {
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
para_at(&lay(&d), path)
};
let automatic = |rows: usize, cols: usize| {
let mut t = Table::new(rows, cols, 468.0);
t.rows.iter_mut().flat_map(|r| r.cells.iter_mut()).for_each(|c| c.props.width = None);
t
};
// A title cell spanning both columns needs its width shared between them: it stays on one line.
let mut t = automatic(2, 2);
t.rows[0].cells.truncate(1);
t.rows[0].cells[0].props.span = 2;
t.rows[0].cells[0].blocks = vec![text("A title that spans both columns")];
t.rows[1].cells[0].blocks = vec![text("A")];
t.rows[1].cells[1].blocks = vec![text("B")];
let [(_, _, n)] = table_x(t, &[0, 0, 0, 0])[..] else { panic!("title missing") };
assert_eq!(n, 1, "the title wraps over {n} lines");
// An unbreakable string longer than the page doesn't widen the table past it.
let mut t = automatic(1, 2);
t.rows[0].cells[0].blocks = vec![text(&"x".repeat(300))];
t.rows[0].cells[1].blocks = vec![text("Second")];
let [(x, _, _)] = table_x(t, &[0, 0, 1, 0])[..] else { panic!("second cell missing") };
assert!(x < 72.0 + 468.0, "the second column starts at {x}, past the margin");
// A table of empty cells keeps its grid.
let [(x, _, _)] = table_x(automatic(1, 2), &[0, 0, 1, 0])[..] else { panic!("second cell missing") };
assert!(x > 72.0 + 200.0, "the second empty column starts at {x}");
// Cells asking for a share of the table's width keep their grid too.
let mut t = automatic(1, 2);
for (c, s) in t.rows[0].cells.iter_mut().zip(["A", "B"]) {
c.props.width_pct = Some(50.0);
c.blocks = vec![text(s)];
}
let [(x, _, _)] = table_x(t, &[0, 0, 1, 0])[..] else { panic!("second cell missing") };
assert!(x > 72.0 + 200.0, "the second 50% column starts at {x}");
}
#[test]
fn an_inherited_footer_sizes_its_percentage_table_by_its_own_section() {
crate::test_fonts();
use wordcraft_doc::section::SectionProps;
// Measured in Word: a 100%-wide footer table defined by a portrait section keeps that width on
// a landscape page that inherits the footer, centred there; a landscape section naming the
// same footer itself gets the landscape width.
let table_width = |landscape_names_it: bool| {
let mut d = Document::from_text("Portrait\nLandscape");
let mut t = Table::new(1, 2, 100.0);
t.props.width_pct = Some(100.0);
let footer = d.add_part(wordcraft_doc::PartKind::Footer, vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t))]);
let mut portrait = SectionProps::default();
portrait.footers.default = Some(footer);
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().section = Some(Box::new(portrait.clone()));
let mut landscape = portrait.clone();
(landscape.page_w, landscape.page_h) = (portrait.page_h, portrait.page_w);
if !landscape_names_it {
landscape.footers.default = None;
}
d.last_section = landscape;
let l = lay(&d);
let cells: Vec<Rect> = l.pages[1].footer.iter().filter_map(|i| if let Placed::Cell { rect, .. } = i { Some(*rect) } else { None }).collect();
let (x0, x1) = cells.iter().fold((f32::MAX, f32::MIN), |(a, b), r| (a.min(r.x), b.max(r.right())));
(x1 - x0, portrait.text_width(), d.last_section.text_width())
};
let (inherited, portrait_w, _) = table_width(false);
assert!((inherited - portrait_w).abs() < 1.0, "inherited: {inherited} wide, portrait text {portrait_w}");
let (own, _, landscape_w) = table_width(true);
assert!((own - landscape_w).abs() < 1.0, "own footer: {own} wide, landscape text {landscape_w}");
}
/// With exactly 50 pt left, an eight-paragraph row without a minimum splits on page one, while
/// the same row with an at-least height of 63.6 pt moves to page two whole; all eight paragraphs
/// remain.
#[test]
fn a_row_with_less_room_than_its_minimum_height_moves_on_whole() {
crate::test_fonts();
use wordcraft_doc::props::HeightRule;
// Exactly 50pt of measured room remains. The same eight paragraphs split without a minimum,
// but an at-least height of 63.6pt moves the row to the next page whole.
let first_row_line_page = |min: Option<f32>| {
let mut d = pagination_filler_leaving(50.0);
let mut t = Table::new(1, 1, 400.0);
t.rows[0].props.height = min;
t.rows[0].props.height_rule = HeightRule::AtLeast;
t.rows[0].cells[0].blocks =
(1..=8).map(|k| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("Row line {k}"), Default::default()))).collect();
let end = d.body.len();
d.insert_block(StoryRef::Body, &Path::top(end), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
assert_pagination_fixture_font(&l);
let row_lines: Vec<_> = l
.pages
.iter()
.enumerate()
.flat_map(|(page, p)| {
p.items.iter().filter_map(move |i| match i {
Placed::Lines { path, l0, l1, .. } if path.0.first() == Some(&(end as u32)) => Some((page, l1 - l0)),
_ => None,
})
})
.collect();
assert_eq!(row_lines.iter().map(|(_, count)| count).sum::<usize>(), 8, "all eight row paragraphs remain");
(row_lines.first().map(|(page, _)| *page), d, l)
};
let (page, d, l) = first_row_line_page(None);
assert_eq!(page, Some(0), "a row without a minimum height splits{}", pagination_fixture_diagnostics("at_least_row/no_minimum", Some(&d), &l));
let (page, d, l) = first_row_line_page(Some(63.6));
assert_eq!(
page,
Some(1),
"a row with a minimum height that doesn't fit moves on; available=50 height=63.6{}",
pagination_fixture_diagnostics("at_least_row/minimum", Some(&d), &l)
);
}
/// Build the filler paragraph and insert-room setting for [`at_least_rows`].
fn at_least_rows_filler(room: f32) -> (Document, usize) {
let mut d = pagination_fixture_document("Text above the table");
let at = if room >= 648.0 { 0 } else { 1 };
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.space_after = Some(if at == 0 { 0.0 } else { 648.0 - room - 14.0 });
let before_table = lay(&d);
assert_pagination_fixture_font(&before_table);
assert_eq!(before_table.pages.len(), 1);
if at == 1 {
let (para, y) = before_table.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { story: StoryRef::Body, path, para, y, .. } if path.0 == [0] => Some((para, *y)),
_ => None,
})
.unwrap();
let remaining = before_table.pages[0].body.bottom() - y - para.height - para.rp.space_after;
assert!((remaining - room).abs() < 0.02, "the measured filler leaves {remaining}pt, expected {room}pt");
}
(d, at)
}
/// Give every cell paragraph the fixture's exact one-line spacing.
fn set_at_least_row_spacing(t: &mut Table) {
for row in &mut t.rows {
for cell in &mut row.cells {
for block in &mut cell.blocks {
if let Block::Para(para) = Arc::make_mut(block) {
para.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(14.0));
para.props.space_before = Some(0.0);
para.props.space_after = Some(0.0);
}
}
}
}
}
/// The pages holding the real paragraph that remains before/after the table.
fn at_least_rows_trailing(l: &DocLayout, at: usize) -> Vec<usize> {
l.pages
.iter()
.enumerate()
.flat_map(|(page, p)| {
p.items.iter().filter_map(move |it| match it {
Placed::Lines { story: StoryRef::Body, path, .. } if path.0 == [if at == 0 { 1 } else { 0 }] => Some(page),
_ => None,
})
})
.collect()
}
/// Prove that the table begins at the page top and the retained paragraph follows it.
fn assert_at_least_table_at_page_top(l: &DocLayout, trailing: &[usize]) {
let first_cell = l.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Cell { row: 0, rect, .. } => Some(rect),
_ => None,
})
.unwrap();
assert!((first_cell.y - l.pages[0].body.y).abs() < 0.01, "the tested table really begins at the page top");
let last_table_page = l.pages.iter().rposition(|p| p.items.iter().any(|it| matches!(it, Placed::Cell { .. }))).unwrap();
assert!(trailing[0] >= last_table_page, "the retained paragraph follows the table");
}
/// The table rows that have a cell on each page.
fn at_least_rows_pages(l: &DocLayout) -> Vec<Vec<usize>> {
l.pages
.iter()
.map(|p| {
let mut rows: Vec<usize> =
p.items.iter().filter_map(|i| if let Placed::Cell { row, cell: 0, .. } = i { Some(*row) } else { None }).collect();
rows.dedup();
rows
})
.collect()
}
/// #1742: a paragraph that leaves `room` points of the letter page's 648 pt body, then the table
/// `build` shapes (one 468 pt column, `rows` rows of one short line each); with `room` 648 the
/// table comes first, at the top of the page. Returns the layout and, per page, the table rows
/// that have a cell there.
fn at_least_rows(room: f32, rows: usize, build: impl Fn(&mut Table)) -> (DocLayout, Vec<Vec<usize>>) {
let (mut d, at) = at_least_rows_filler(room);
let mut t = Table::new(rows, 1, 468.0);
build(&mut t);
set_at_least_row_spacing(&mut t);
d.insert_block(StoryRef::Body, &Path::top(at), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
assert_pagination_fixture_font(&l);
let trailing = at_least_rows_trailing(&l, at);
assert_eq!(trailing.len(), 1, "the real paragraph before/after the table is retained exactly once");
assert_eq!(d.para(StoryRef::Body, &Path::top(if at == 0 { 1 } else { 0 })).unwrap().text, "Text above the table");
if at == 0 {
assert_at_least_table_at_page_top(&l, &trailing);
}
let pages = at_least_rows_pages(&l);
(l, pages)
}
fn lines_in_cell(n: usize, what: &str) -> Vec<std::sync::Arc<wordcraft_doc::Block>> {
(1..=n).map(|k| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("{what} {k}"), Default::default()))).collect()
}
#[test]
fn an_at_least_row_with_no_room_starts_the_next_page_whole_either_way_breaking_is_set() {
crate::test_fonts();
use wordcraft_doc::props::HeightRule;
// Word for Mac 16.113, A4 with about 2.6 cm (74 pt) left: row 2, at least 8 cm (226.8 pt),
// starts page 2 whole and row 1 stays on page 1, whether the row may break across pages or not.
for cant_split in [false, true] {
let (_, pages) = at_least_rows(74.0, 2, |t| {
t.rows[1].props.height = Some(226.8);
t.rows[1].props.height_rule = HeightRule::AtLeast;
t.rows[1].props.cant_split = cant_split;
});
assert_eq!(pages, vec![vec![0], vec![1]], "cant_split {cant_split}");
}
}
#[test]
fn an_at_least_row_with_centred_lines_moves_whole_and_centres_them_in_its_height() {
crate::test_fonts();
use wordcraft_doc::props::{HeightRule, VAlign};
// Word: 10 short lines, centred vertically, in an "at least 8 cm" row with 2.6 cm left. The
// lines would split there, but the whole row goes to page 2 and they sit in the middle of it.
let (l, pages) = at_least_rows(74.0, 2, |t| {
t.rows[1].props.height = Some(226.8);
t.rows[1].props.height_rule = HeightRule::AtLeast;
t.rows[1].cells[0].props.valign = Some(VAlign::Center);
t.rows[1].cells[0].blocks = lines_in_cell(10, "Line");
});
assert_eq!(pages, vec![vec![0], vec![1]]);
let page = &l.pages[1];
let Some(cell) = page.items.iter().find_map(|i| if let Placed::Cell { rect, row: 1, .. } = i { Some(*rect) } else { None }) else {
panic!("no cell on page 2")
};
assert!(cell.h >= 226.8 - 0.01 && cell.h < 226.8 + 1.5, "the row keeps its minimum height: {}", cell.h);
let ys: Vec<f32> = page
.items
.iter()
.filter_map(|i| if let Placed::Lines { y, path, .. } = i { (path.0.first() == Some(&1)).then_some(*y) } else { None })
.collect();
assert_eq!(ys.len(), 10, "all ten lines on page 2: {ys:?}");
let (top, bottom) = (ys.iter().cloned().fold(f32::MAX, f32::min), ys.iter().cloned().fold(f32::MIN, f32::max));
let (above, below) = (top - cell.y, cell.y + cell.h - bottom);
assert!(above > 30.0 && below > 30.0, "the lines are centred in the row: {above} above, {below} below the line tops");
}
#[test]
fn an_at_least_row_taller_than_a_page_splits_from_the_top_of_the_next_page() {
crate::test_fonts();
use wordcraft_doc::props::HeightRule;
// A row at least 700 pt tall (the body is 648 pt) holding 80 lines: it can't fit on any page,
// so it splits, but it starts on a fresh page rather than in the 200 pt left under the text.
let (_, pages) = at_least_rows(200.0, 1, |t| {
t.rows[0].props.height = Some(700.0);
t.rows[0].props.height_rule = HeightRule::AtLeast;
t.rows[0].cells[0].blocks = lines_in_cell(80, "Line");
});
assert_eq!(pages.first(), Some(&vec![]), "nothing of the row under the text: {pages:?}");
assert!(pages.len() >= 3 && pages[1..].iter().all(|p| p == &vec![0]), "it splits from page 2 on: {pages:?}");
}
/// An at-least row taller than the page splits from the top of a fresh page instead of moving
/// on, keeps all 80 cell paragraphs, and pagination terminates.
#[test]
fn an_at_least_row_at_the_top_of_a_page_splits_instead_of_moving_on() {
use wordcraft_doc::props::HeightRule;
// At the top of a page (or under the header rows repeated there) moving on gains nothing: a
// row taller than the room splits, and pagination ends.
let (l, pages) = at_least_rows(648.0, 1, |t| {
t.rows[0].props.height = Some(700.0);
t.rows[0].props.height_rule = HeightRule::AtLeast;
t.rows[0].cells[0].blocks = lines_in_cell(80, "Line");
});
assert!(
pages.len() >= 2 && pages.iter().all(|p| p == &vec![0]),
"{pages:?}; helper retains body block1 \"Text above the table\" after table block0{}",
pagination_fixture_diagnostics("at_least_row/top_of_page", None, &l)
);
let data_lines = |layout: &DocLayout, row: u32| {
let mut paragraphs = std::collections::BTreeSet::new();
let count = layout
.pages
.iter()
.flat_map(|p| &p.items)
.filter_map(|it| match it {
Placed::Lines { story: StoryRef::Body, path, l0, l1, .. } if path.0.len() == 4 && path.0[..3] == [0, row, 0] => {
paragraphs.insert(path.0[3]);
Some(l1 - l0)
}
_ => None,
})
.sum::<usize>();
assert_eq!(paragraphs.into_iter().collect::<Vec<_>>(), (0..80).collect::<Vec<_>>(), "all eighty original cell paragraphs remain");
assert_eq!(count, 80, "every short cell paragraph is drawn exactly once");
};
data_lines(&l, 0);
// A 100 pt header row, then a row at least 600 pt with 80 lines: under the header only 548 pt
// are left on each page, so the row splits there instead of running past the bottom margin.
let (l, pages) = at_least_rows(648.0, 2, |t| {
t.rows[0].props.header = true;
t.rows[0].props.height = Some(100.0);
t.rows[0].props.height_rule = HeightRule::AtLeast;
t.rows[1].props.height = Some(600.0);
t.rows[1].props.height_rule = HeightRule::AtLeast;
t.rows[1].cells[0].blocks = lines_in_cell(80, "Line");
});
assert!(
pages.len() >= 3 && pages.iter().all(|p| p == &vec![0, 1]),
"{pages:?}; repeated100pt header plus minimum600pt row{}",
pagination_fixture_diagnostics("at_least_row/repeated_header", None, &l)
);
data_lines(&l, 1);
for p in &l.pages {
let bottom = p.items.iter().filter_map(|i| if let Placed::Cell { rect, .. } = i { Some(rect.y + rect.h) } else { None }).fold(0.0, f32::max);
assert!(
bottom <= 720.0 + 0.5,
"a row part runs past the bottom margin to {bottom}{}",
pagination_fixture_diagnostics("at_least_row/repeated_header_bottom", None, &l)
);
}
}
#[test]
fn repeated_header_moves_with_a_first_row_that_moves_on_whole() {
crate::test_fonts();
use wordcraft_doc::props::HeightRule;
// A 20 pt header, then a row at least 200 pt holding eight lines, with 100 pt left: the row
// moves on whole, so the header goes with it rather than staying alone at the foot of page 1.
let (_, pages) = at_least_rows(100.0, 2, |t| {
t.rows[0].props.header = true;
t.rows[0].props.height = Some(20.0);
t.rows[0].props.height_rule = HeightRule::AtLeast;
t.rows[1].props.height = Some(200.0);
t.rows[1].props.height_rule = HeightRule::AtLeast;
t.rows[1].cells[0].blocks = lines_in_cell(8, "Line");
});
assert_eq!(pages, vec![vec![], vec![0, 1]]);
}
/// #4272: a filler leaving `room` points, then a three-column table: a one-line heading row and
/// a row at least `min` points tall (no minimum when 0) whose first cell holds only an inline picture `pic_h` points
/// tall (one line, single spacing) and whose other cells hold `lines` short lines each. Returns
/// the layout and, per page, the rows with a first cell there.
fn picture_row(room: f32, min: f32, pic_h: f32, lines: usize) -> (DocLayout, Vec<Vec<usize>>) {
use wordcraft_doc::props::{HeightRule, LineSpacing};
let (mut d, at) = at_least_rows_filler(room);
let mut t = Table::new(2, 3, 468.0);
if min > 0.0 {
t.rows[1].props.height = Some(min);
t.rows[1].props.height_rule = HeightRule::AtLeast;
}
for cell in &mut t.rows[1].cells[1..3] {
cell.blocks = lines_in_cell(lines, "N/A");
}
set_at_least_row_spacing(&mut t);
let mut p = wordcraft_doc::Paragraph::with_text("", Default::default());
p.props.line_spacing = Some(LineSpacing::Multiple(1.0));
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p.insert_object(0, picture(114.0, pic_h, Default::default()), &Default::default()).unwrap();
t.rows[1].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
d.insert_block(StoryRef::Body, &Path::top(at), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let pages = at_least_rows_pages(&l);
(l, pages)
}
/// The height of row `row`'s first cell on each page it has a part on.
fn picture_row_parts(l: &DocLayout, row: usize) -> Vec<f32> {
l.pages
.iter()
.filter_map(|p| {
p.items.iter().find_map(|i| if let Placed::Cell { rect, row: r, cell: 0, .. } = i { (*r == row).then_some(rect.h) } else { None })
})
.collect()
}
#[test]
fn an_at_least_row_grown_by_its_picture_moves_on_whole_rather_than_leave_the_picture_behind() {
// The report in #4272: a row at least 193.45 pt (3869 twips) with a 203 pt inline picture in
// its first cell and "N/A" in the others, so the picture makes the row taller than its
// minimum. With room for the minimum but not for the picture, the row used to split: the
// "N/A" cells stayed beside an empty picture cell and the picture went on alone. The picture
// is one line, which Word never splits, so the row moves on whole. The same goes for a row
// with no minimum height.
for min in [193.45, 0.0] {
let (l, pages) = picture_row(214.0, min, 203.0, 1);
assert_eq!(pages, vec![vec![0], vec![1]], "min {min}{}", pagination_fixture_diagnostics("picture_row/grown", None, &l));
assert_eq!(l.pages.len(), 2, "min {min}");
let parts = picture_row_parts(&l, 1);
assert_eq!(parts.len(), 1, "min {min}: the picture row is in one piece: {parts:?}");
assert!(parts[0] >= 203.0, "min {min}: the row holds its picture: {parts:?}");
}
}
#[test]
fn a_picture_row_too_tall_for_any_page_splits_from_the_top_of_the_next_one() {
// A row of 60 lines beside a 700 pt picture (the body is 648 pt), under a heading row at the
// top of page 1: like an at-least row taller than a page (#1742), it starts page 2 rather
// than leave its picture cell empty under the heading, then splits from there, its text going
// on over the pages (at the top of a page moving on would gain nothing).
let (l, pages) = picture_row(648.0, 0.0, 700.0, 60);
let rows: Vec<&Vec<usize>> = pages.iter().filter(|p| !p.is_empty()).collect();
assert!(
rows.len() >= 3 && rows[0] == &vec![0] && rows[1..].iter().all(|p| p == &&vec![1]),
"{pages:?}{}",
pagination_fixture_diagnostics("picture_row/too_tall", None, &l)
);
}
#[test]
fn a_picture_row_that_fits_stays_and_text_rows_beside_a_short_picture_still_split() {
// The same row with room for all of it stays on page 1.
let (_, pages) = picture_row(260.0, 193.45, 203.0, 1);
assert_eq!(pages, vec![vec![0, 1]]);
// A row of 30 lines beside a 40 pt picture, at least 100 pt: with 225 pt left the picture
// and the first lines fit, so the row still splits as before.
let (l, pages) = picture_row(225.0, 100.0, 40.0, 30);
assert_eq!(pages, vec![vec![0, 1], vec![1]], "{}", pagination_fixture_diagnostics("picture_row/text_splits", None, &l));
}
#[test]
fn text_overflowing_an_exact_row_is_clipped_to_it() {
crate::test_fonts();
use wordcraft_doc::props::HeightRule;
// An exactly 12 pt row holding three lines: Word shows what fits and cuts the rest at the row's
// edge, rather than drawing it over the rows below.
let mut t = Table::new(2, 1, 200.0);
t.rows[0].props.height = Some(12.0);
t.rows[0].props.height_rule = HeightRule::Exact;
t.rows[0].cells[0].blocks =
["one", "two", "three"].iter().map(|s| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(s, Default::default()))).collect();
t.rows[1].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("below", Default::default()))];
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let draws = display::page_display(&d, &lay(&d).pages[0], &Default::default());
let clipped = |want: &str| {
draws.iter().any(|x| match x {
display::Draw::Clip { items, .. } => {
flat(items.clone()).iter().any(|i| matches!(i, display::Draw::Glyphs { text, .. } if text.contains(want)))
}
_ => false,
})
};
assert!(clipped("three"), "the overflowing row's text is drawn inside a clip");
assert!(!clipped("below"), "a row that fits isn't clipped");
}
#[test]
fn a_percentage_width_past_the_text_column_is_kept() {
crate::test_fonts();
// `w:tblW w:type="pct" w:w="6564"` (131.28%) with the left margin as a negative indent: a
// cover-page footer table that spans the page edge to edge.
let mut t = Table::new(1, 2, 234.0);
t.props.width_pct = Some(131.28);
t.props.indent = Some(-72.0);
for (c, s) in t.rows[0].cells.iter_mut().zip(["Left", "Right"]) {
c.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(s, Default::default()))];
}
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let [(x, _, _)] = para_at(&lay(&d), &[0, 0, 1, 0])[..] else { panic!("second cell missing") };
// Two equal columns of 614.4 pt from x = 0: the second starts past the middle of the page.
assert!(x > 307.0, "the second column starts at {x}");
}
#[test]
fn a_floating_table_in_the_footer_leaves_the_footer_where_it_is() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let footer_y = |float: bool| {
let mut d = Document::from_text("Body");
let mut t = Table::new(1, 1, 100.0);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Float", Default::default()))];
if float {
t.props.float = Some(TableFloat { h_rel: Anchor::Page, v_rel: Anchor::Page, y: 720.0, ..Default::default() });
}
let blocks = vec![
wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Footer", Default::default())),
std::sync::Arc::new(wordcraft_doc::Block::Table(t)),
];
let id = d.add_part(wordcraft_doc::PartKind::Footer, blocks);
d.last_section.footers.default = Some(id);
let l = lay(&d);
l.pages[0].footer.iter().find_map(|it| if let Placed::Lines { y, path, .. } = it { (path.0 == [0]).then_some(*y) } else { None }).unwrap()
};
// A floating table in the footer doesn't push the footer's text up.
assert!(footer_y(true) >= footer_y(false) - 0.01, "footer text at {} with the float, {} without", footer_y(true), footer_y(false));
}
#[test]
fn a_split_row_moves_shading_below_the_cut_with_it() {
crate::test_fonts();
use crate::table::{CellPart, RowLayout, split_row};
let line_row = |y: f32| {
let d = Document::from_text("Line");
let l = lay(&d);
let Some(Placed::Lines { story, path, para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })).cloned() else {
panic!("no line")
};
Placed::Lines { story, path, para, l0: 0, l1: 1, x: 0.0, y, turn: TextDirection::Horizontal }
};
let fill = |y: f32, h: f32| Placed::Fill { rect: wordcraft_geom::Rect::new(0.0, y, 100.0, h), color: wordcraft_doc::props::Rgb(200, 0, 0) };
// The row's own shading (from its top) and a nested cell's shading starting below the cut.
let row = RowLayout {
edge: 0.0,
height: 200.0,
items: vec![line_row(0.0), line_row(150.0), fill(0.0, 200.0), fill(150.0, 50.0)],
bottom: 0.0,
cells: vec![CellPart { top: 2.0, items: 0..4, end: None, align: None }],
};
let (a, b) = split_row(&row, 100.0).expect("splits");
let fills = |r: &RowLayout| {
r.items.iter().filter_map(|i| if let Placed::Fill { rect, .. } = i { Some((rect.y, rect.h)) } else { None }).collect::<Vec<_>>()
};
assert_eq!(fills(&a), vec![(0.0, 100.0)], "only the row's shading above the cut stays");
let moved = fills(&b);
assert_eq!(moved.first().map(|f| f.0), Some(0.0), "the row's shading starts the continuation: {moved:?}");
let nested = moved.get(1).copied().unwrap_or_default();
assert!(nested.0 > 0.0 && (nested.1 - 50.0).abs() < 0.01, "the nested shading keeps its place and size: {moved:?}");
}
#[test]
fn kinsoku_keeps_a_manual_line_break_before_a_closing_bracket() {
crate::test_fonts();
// #269: kinsoku forbids a line starting with 」, but a manual line break (Shift+Enter) right
// before one still ends the line there.
let text = "日本語\n」テスト";
let mut d = Document::from_text("");
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))];
let l = lay(&d);
let mut lines = Vec::new();
for p in &l.pages {
for it in &p.items {
if let Placed::Lines { para, l0, l1, .. } = it {
lines.extend(para.lines[*l0..*l1].iter().map(|line| (line.start, line.end)));
}
}
}
let bracket = text.find('」').unwrap();
assert_eq!(lines.len(), 2, "{lines:?}");
assert_eq!(lines[0].1, LineEnd::LineBreak, "{lines:?}");
assert_eq!(lines[1].0, bracket, "the second line starts at the bracket: {lines:?}");
}
/// 行頭禁則 (JIS X 4051 §4) end to end: a paragraph wrapping in a narrow column never starts a
/// line with a small kana or the prolonged sound mark, even where the break opportunity that
/// would put one there sits right after a kanji.
#[test]
fn a_line_never_starts_with_a_small_kana_or_the_prolonged_sound_mark() {
let text = "漢っ漢ゃ漢ー漢ッ漢ャ漢ゕ漢ヶ漢ㇺ漢ッ漢ャ漢ー漢";
let mut d = Document::from_text(text);
d.last_section.page_w = 72.0 + 72.0 + 72.0; // 72 pt of text: a few East Asian characters
let l = lay(&d);
let mut lines = Vec::new();
for p in &l.pages {
for it in &p.items {
if let Placed::Lines { para, l0, l1, .. } = it {
lines.extend(para.lines[*l0..*l1].iter().map(|line| (line.start, line.stop)));
}
}
}
assert!(lines.len() > 1, "the paragraph wraps: {lines:?}");
let non_starters = "ぁぃぅぇぉっゃゅょゎゕゖァィゥェォッャュョヮヵヶㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿァィゥェォャュョッーー";
for &(start, _) in &lines {
let first = text.get(start..).and_then(|t| t.chars().next()).unwrap_or_default();
assert!(!non_starters.contains(first), "a line must not start with {first}: {lines:?}");
}
}
/// #332: a rotated floating shape keeps text clear of its rotated bounds (it reaches further at
/// the side), its frame stays put (rotation is about the centre) and it is drawn turned; hit
/// testing follows the turned shape, not its frame.
#[test]
fn rotated_float_wraps_around_its_rotated_bounds() {
crate::test_fonts();
let text = "Words flow around the turned shape here. ".repeat(30);
let place = |rot: f32| {
let mut d = Document::from_text(&text);
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::Square,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
x: 0.0,
y: 40.0,
rot,
..Default::default()
};
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 144.0,
h: 40.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions::default());
let p = &l.pages[0];
let Some(Placed::Lines { para, .. }) = p.items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
// The widest indent of a line beside the shape.
let left = para.lines.iter().map(|l| l.left).fold(0.0f32, f32::max);
let hit = l.object(&Pos::body(0, 0), 0).unwrap();
let drawn = crate::display::page_display(&d, p, &Default::default()).iter().any(|d| matches!(d, crate::display::Draw::Rotated { .. }));
(left, hit, drawn, l)
};
let (flat, frame, flat_drawn, _) = place(0.0);
let (turned, hit, drawn, l) = place(30.0);
// 144 × 40 turned 30° is 144.7 wide: 0.36 pt further out on each side, the centre kept.
let bounds = hit.bounds();
assert!((bounds.w - (144.0 * 30f32.to_radians().cos() + 40.0 * 0.5)).abs() < 0.01, "{bounds:?}");
assert_eq!(hit.rect, frame.rect);
assert!(turned > flat && turned >= bounds.right() - hit.origin.x, "{flat} → {turned} ({bounds:?})");
assert!(drawn && !flat_drawn);
// Its frame's top-right corner turns away from where it was: no longer on the shape.
let r = hit.rect;
assert!(l.object_at(0, r.right() - 2.0, r.y + 2.0, 0.0).is_none());
assert!(l.object_at(0, r.x + r.w / 2.0, r.y + r.h / 2.0, 0.0).is_some());
}
/// #332: a group turns as a whole: each member's centre is carried round the group's centre and
/// the member drawn with the group's turn on top of its own; hit testing follows the turned
/// group. A shadow that doesn't rotate with its shape (`rotWithShape="0"`, Word's presets) keeps
/// its page direction inside the turn; one that does turns with the shape.
#[test]
fn rotated_group_turns_its_members_and_their_shadows() {
crate::test_fonts();
use wordcraft_doc::effects::{Shadow, ShapeEffects};
use wordcraft_doc::para::{Anchor, Float, GroupChild, ShapeKind, Wrap};
let member = |rot_with_shape: bool, rot: f32| InlineObject::Shape {
kind: ShapeKind::Rectangle,
w: 60.0,
h: 40.0,
fill: Some(Fill::solid(wordcraft_doc::props::Rgb(1, 2, 3))),
stroke: None,
stroke_width: 0.0,
float: Float { rot, ..Default::default() },
story: None,
freeform: None,
effects: ShapeEffects { shadow: Some(Shadow { angle: 0.0, rot_with_shape, ..Default::default() }), ..Default::default() },
extra: Default::default(),
};
let float =
Float { wrap: Wrap::InFrontOfText, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 100.0, y: 100.0, rot: 90.0, ..Default::default() };
let group = InlineObject::Group {
w: 120.0,
h: 40.0,
float,
ch_w: 120.0,
ch_h: 40.0,
children: vec![GroupChild { x: 0.0, y: 0.0, obj: member(false, 0.0) }, GroupChild { x: 60.0, y: 0.0, obj: member(true, 10.0) }],
canvas: None,
};
let mut d = Document::from_text("Text under the group.");
d.insert_object(&Pos::body(0, 0), group, &Default::default()).unwrap();
let l = lay(&d);
let p = &l.pages[0];
let hit = l.object(&Pos::body(0, 0), 0).unwrap();
let g = hit.rect;
let (cx, cy) = (g.x + g.w / 2.0, g.y + g.h / 2.0);
assert_eq!(hit.spin.deg, 90.0);
// Turned a quarter clockwise, the left member is now above the centre, the right one below.
let shapes: Vec<(Rect, Spin)> =
p.items.iter().filter_map(|i| if let Placed::Shape { rect, spin, .. } = i { Some((*rect, *spin)) } else { None }).collect();
assert_eq!(shapes.len(), 2, "{shapes:?}");
let centre = |r: Rect| (r.x + r.w / 2.0, r.y + r.h / 2.0);
let near = |a: (f32, f32), b: (f32, f32)| (a.0 - b.0).abs() < 0.01 && (a.1 - b.1).abs() < 0.01;
assert!(near(centre(shapes[0].0), (cx, cy - 30.0)), "{shapes:?} about ({cx}, {cy})");
assert!(near(centre(shapes[1].0), (cx, cy + 30.0)), "{shapes:?}");
assert_eq!((shapes[0].1.deg, shapes[1].1.deg), (90.0, 100.0));
// Drawn turned: the page-fixed shadow still falls to the right on the page (270° in the
// quarter-turned frame); the other turns with its shape (still 0° in its own frame).
let shadows: Vec<f32> = crate::display::page_display(&d, p, &Default::default())
.iter()
.filter_map(|d| match d {
crate::display::Draw::Rotated { items, .. } => items.iter().find_map(|i| match i {
crate::display::Draw::Shape { effects, .. } => effects.shadow.map(|s| s.angle),
_ => None,
}),
_ => None,
})
.collect();
assert_eq!(shadows.len(), 2, "{shadows:?}");
assert!((shadows[0] - 270.0).abs() < 0.01 && shadows[1].abs() < 0.01, "{shadows:?}");
// Grabbed on the turned group: its frame's left end is empty now, above the centre isn't.
assert!(l.object_at(0, g.x + 5.0, cy, 0.0).is_none());
assert!(l.object_at(0, cx, cy - 50.0, 0.0).is_some());
}
/// The pieces of footnote `id` as (page, first line, end line, top).
fn note_pieces(l: &DocLayout, id: u32) -> Vec<(usize, usize, usize, f32)> {
let mut v = Vec::new();
for (pi, p) in l.pages.iter().enumerate() {
for it in &p.items {
if let Placed::Lines { story: StoryRef::Part(s), l0, l1, y, .. } = it
&& *s == id
{
v.push((pi, *l0, *l1, *y));
}
}
}
v
}
/// Lengths of the horizontal rules on page `pi` below `y`.
fn rules_below(l: &DocLayout, pi: usize, y: f32) -> Vec<f32> {
l.pages[pi]
.items
.iter()
.filter_map(|it| if let Placed::Rule { x0, y0, x1, y1, .. } = it { (*y0 == *y1 && *y0 > y).then_some(x1 - x0) } else { None })
.collect()
}
#[test]
fn long_footnotes_continue_on_the_next_page() {
crate::test_fonts();
let mut d = Document::from_text(&"Body text line.\n".repeat(16));
let long = footnote(&mut d, &Pos::body(4, 4), &"A long footnote that runs on and on. ".repeat(100));
let own = footnote(&mut d, &Pos::body(14, 4), "The second page's own note.");
let l = lay(&d);
let refs = l.caret(&Pos::body(4, 4)).unwrap();
assert_eq!(refs.page, 0, "the reference stays where it was");
let pieces = note_pieces(&l, long);
assert!(pieces.len() >= 2, "{pieces:?}");
let (p0, p1) = (&pieces[0], &pieces[1]);
assert_eq!((p0.0, p1.0), (0, 1), "split over pages 1 and 2: {pieces:?}");
assert_eq!(p0.1, 0);
assert_eq!(p0.2, p1.1, "continues at the next line");
// Every line of the note is placed once.
let lines = pieces.iter().map(|p| p.2 - p.1).sum::<usize>();
let para = l.pages[0]
.items
.iter()
.find_map(|it| if let Placed::Lines { story: StoryRef::Part(s), para, .. } = it { (*s == long).then(|| para.lines.len()) } else { None })
.unwrap();
assert_eq!(lines, para);
// Page 1: the note fills the space under the text, which ends above it.
let body_bottom = |pi: usize| {
l.pages[pi]
.items
.iter()
.filter_map(
|it| if let Placed::Lines { story: StoryRef::Body, y, para, l0, l1, .. } = it { item_bottom(*y, para, *l0, *l1) } else { None },
)
.fold(0.0f32, f32::max)
};
assert!(body_bottom(0) <= p0.3, "{} {}", body_bottom(0), p0.3);
assert_eq!(rules_below(&l, 0, body_bottom(0)), vec![144.0], "a normal separator on page 1");
// Page 2: the continuation separator spans the text width, the rest of the long note comes
// first and the page's own note follows it.
assert!(body_bottom(1) <= p1.3, "{} {}", body_bottom(1), p1.3);
assert_eq!(rules_below(&l, 1, body_bottom(1)), vec![468.0], "continuation separator");
let own_ref = l.caret(&Pos::body(14, 4)).unwrap();
let own_note = l.caret(&d.start_of(StoryRef::Part(own))).unwrap();
assert_eq!((own_ref.page, own_note.page), (1, 1));
assert!(own_note.top > p1.3, "own note after the continued one: {own_note:?} {p1:?}");
}
#[test]
fn short_footnotes_stay_whole() {
crate::test_fonts();
let mut d = Document::from_text(&"Body text line.\n".repeat(60));
let id = footnote(&mut d, &Pos::body(10, 4), "A short note, two lines long. ".repeat(4).as_str());
let l = lay(&d);
let pieces = note_pieces(&l, id);
assert_eq!(pieces.len(), 1, "{pieces:?}");
assert_eq!(pieces[0].0, l.caret(&Pos::body(10, 4)).unwrap().page);
}
#[test]
fn footnote_longer_than_pages_ends() {
crate::test_fonts();
// A note several pages long after a one-line body: it continues on pages of its own.
let mut d = Document::from_text("Body");
let id = footnote(&mut d, &Pos::body(0, 4), &"Words in a very long note. ".repeat(1500));
let l = lay(&d);
let pieces = note_pieces(&l, id);
assert!(pieces.len() >= 3 && l.pages.len() == pieces.len(), "{} pages, {pieces:?}", l.pages.len());
assert!(pieces.windows(2).all(|w| w[0].2 == w[1].1 && w[1].0 == w[0].0 + 1), "{pieces:?}");
}
/// A comment by `author` saying `text` on body paragraph `para`, bytes `a..b`; its id.
fn comment_on(d: &mut Document, para: usize, a: usize, b: usize, author: &str, text: &str, parent: Option<u32>) -> u32 {
let part = d.add_part(wordcraft_doc::PartKind::Comment, vec![wordcraft_doc::para_block(Paragraph::with_text(text, CharProps::default()))]);
let id = d.comments.keys().next_back().map_or(0, |k| k + 1);
d.comments.insert(id, wordcraft_doc::Comment { author: author.into(), part, parent, ..Default::default() });
if parent.is_none() {
let p = CharProps::default();
d.insert_object(&Pos::body(para, b), InlineObject::CommentEnd { id }, &p).unwrap();
d.insert_object(&Pos::body(para, a), InlineObject::CommentStart { id }, &p).unwrap();
}
id
}
fn balloon_layout(d: &Document) -> DocLayout {
layout(d, &mut LayoutCache::new(), &LayoutOptions { comment_balloons: true, ..Default::default() })
}
/// The comment text lines placed on page `pi` (story, top-left).
fn comment_lines(l: &DocLayout, pi: usize) -> Vec<(StoryRef, f32, f32)> {
l.pages[pi]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story: s @ StoryRef::Part(_), x, y, .. } => Some((*s, *x, *y)),
_ => None,
})
.collect()
}
/// Print Markup (#589): each page grows by the markup area, and the comment, its author and its
/// reply are laid out there beside the line they comment on.
#[test]
fn comment_balloons_widen_pages_beside_their_anchors() {
crate::test_fonts();
let mut d = Document::from_text("Intro line.\nThe quarterly figures look strong.\nClosing line.");
let id = comment_on(&mut d, 1, 4, 13, "Ada Reviewer", "Check the totals", None);
comment_on(&mut d, 0, 0, 0, "Ben Editor", "Totals checked", Some(id));
let plain = lay(&d);
let l = balloon_layout(&d);
assert_eq!(l.pages.len(), plain.pages.len());
let (w, pw) = (l.pages[0].w, plain.pages[0].w);
assert_eq!(l.pages[0].markup, balloons::MARKUP_AREA);
assert!((w - pw - balloons::MARKUP_AREA).abs() < 0.01, "{w} vs {pw}");
assert_eq!(plain.pages[0].markup, 0.0);
// Author + text for the comment, then for the reply: four lines, all in the markup area.
let lines = comment_lines(&l, 0);
assert_eq!(lines.len(), 4, "{lines:?}");
assert!(lines.iter().all(|(_, x, _)| *x > pw && *x < w), "{lines:?}");
assert!(lines.windows(2).all(|p| p[0].2 < p[1].2), "stacked top to bottom: {lines:?}");
// The card sits by the commented line.
let anchor = l.caret(&Pos::body(1, 5)).unwrap();
assert!((lines[0].2 - anchor.top).abs() < 30.0, "{lines:?} vs {anchor:?}");
// The body is laid out exactly as without balloons.
assert_eq!(lines_of(&plain), lines_of(&l) - 4);
// The leader starts at the anchor.
assert!(l.pages[0].items.iter().any(|it| matches!(it, Placed::Rule { x0, x1, .. } if (*x0 - anchor.x).abs() < 0.5 && (*x1 - pw).abs() < 0.5)));
}
#[test]
fn no_balloons_without_anchored_comments() {
crate::test_fonts();
let d = Document::from_text("No comments here.");
let l = balloon_layout(&d);
assert_eq!(l.pages[0].markup, 0.0);
assert_eq!(l.pages[0].w, lay(&d).pages[0].w);
// A web view never gets a markup area.
let mut d = Document::from_text("Hello there.");
comment_on(&mut d, 0, 0, 5, "A", "x", None);
let opts = LayoutOptions { view: ViewMode::Web, web_width: 500.0, comment_balloons: true, ..Default::default() };
let l = layout(&d, &mut LayoutCache::new(), &opts);
assert_eq!(l.pages[0].markup, 0.0);
}
/// Hostile comments: parent cycles, a missing text part, and far more comments than fit beside
/// one page. Nothing panics or hangs, and the cards stay on the page.
#[test]
fn comment_balloons_survive_hostile_comments() {
crate::test_fonts();
let mut d = Document::from_text(&"Commented words here. ".repeat(20));
let mut ids = Vec::new();
for i in 0..120 {
ids.push(comment_on(&mut d, 0, 0, 9, &format!("Author {i}"), &"A long remark that wraps over lines. ".repeat(4), None));
}
// A reply cycle and a comment whose text part is gone.
let a = comment_on(&mut d, 0, 0, 0, "R", "one", Some(ids[0]));
let b = comment_on(&mut d, 0, 0, 0, "R", "two", Some(a));
d.comments.get_mut(&a).unwrap().parent = Some(b);
d.comments.get_mut(&ids[1]).unwrap().parent = Some(ids[1]);
d.comments.get_mut(&ids[2]).unwrap().part = 9_999_999;
let l = balloon_layout(&d);
let page = &l.pages[0];
for (_, _, y) in comment_lines(&l, 0) {
assert!(y.is_finite() && y >= 0.0 && y <= page.h, "{y}");
}
for it in &page.items {
if let Placed::Fill { rect, .. } = it {
assert!(rect.y >= 0.0 && rect.bottom() <= page.h + 0.5, "{rect:?}");
}
}
}
/// The first paragraph's lines on page one: (top, bottom, left, right), relative to its column.
fn line_spans(l: &DocLayout) -> Vec<(f32, f32, f32, f32)> {
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { return Vec::new() };
para.lines.iter().map(|ln| (ln.top, ln.top + ln.height, ln.left, ln.right)).collect()
}
/// A shape floating at the column's top-left with `wrap`, beside a long paragraph.
fn wrapped_shape_doc(kind: wordcraft_doc::para::ShapeKind, w: f32, h: f32, float: wordcraft_doc::para::Float) -> Document {
let mut d = Document::from_text(&"Words flow around the shape here. ".repeat(40));
let float =
wordcraft_doc::para::Float { h_rel: wordcraft_doc::para::Anchor::Column, v_rel: wordcraft_doc::para::Anchor::Paragraph, dist: 9.0, ..float };
let shape = InlineObject::Shape {
kind,
w,
h,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
effects: Default::default(),
freeform: None,
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), shape, &Default::default()).unwrap();
d
}
#[test]
fn tight_wrap_follows_an_ellipse() {
crate::test_fonts();
use wordcraft_doc::para::{Float, ShapeKind, Wrap};
let spans = |wrap| {
let mut d = wrapped_shape_doc(ShapeKind::Ellipse, 160.0, 160.0, Float { wrap, ..Default::default() });
Arc::make_mut(&mut d.styles).default_chr.font = Some(WRAP_TEST_FONT.into());
line_spans(&lay(&d))
};
let (square, tight, through) = (spans(Wrap::Square), spans(Wrap::Tight), spans(Wrap::Through));
// Square: every line beside the shape starts past its frame and distance from text.
assert!(square.iter().filter(|l| l.0 < 160.0).all(|l| l.2 >= 169.0 - 0.01), "{square:?}");
// Tight: no line runs into the ellipse (a 160pt circle at 80, 80) or its distance from text.
// Where a line from `top` to `bottom` meets the circle plus that distance: (left, right) edges.
let contour = |top: f32, bottom: f32| {
let y = if bottom < 80.0 {
80.0 - bottom
} else if top > 80.0 {
top - 80.0
} else {
0.0
};
let half = (80.0f32 * 80.0 - y.min(80.0).powi(2)).sqrt();
(80.0 - half - 9.0, 80.0 + half + 9.0)
};
for &(top, bottom, left, right) in tight.iter().filter(|l| l.0 < 160.0) {
let (a, b) = contour(top, bottom);
assert!(right <= a + 1.5 || left >= b - 1.5, "line {top}..{bottom} at {left}..{right} runs into {a}..{b}: {tight:?}");
}
// Lines near the ellipse's top and bottom start at the curve, well inside its frame; beside
// the middle they don't. Measured against each line's own contour edge, so the check holds
// with the explicit test font, independent of installed system fonts.
let line = |pred: &dyn Fn(f32) -> bool| *tight.iter().find(|l| pred(l.0) && l.2 > 60.0).unwrap();
for (what, l) in [("first line", line(&|top| top < 1.0)), ("near the bottom", line(&|top| top > 140.0 && top < 160.0))] {
let edge = contour(l.0, l.1).1;
assert!(l.2 <= edge + 3.0 && l.2 < 169.0 - 10.0, "{what} hugs the curve at {edge}: {l:?} in {tight:?}");
}
assert!(line(&|top| top > 65.0 && top < 80.0).2 >= 160.0, "beside the widest part: {tight:?}");
// A convex shape has no gaps for Through to use: it wraps as Tight.
assert_eq!(through, tight);
}
#[test]
fn contour_wrap_turns_with_the_object() {
crate::test_fonts();
use wordcraft_doc::para::{Float, ShapeKind, Wrap};
use wordcraft_doc::wrap::WrapPolygon;
// A wrap polygon covering the left half of a 200 × 100 frame.
let poly = WrapPolygon::new(true, [(0, 0), (10_800, 0), (10_800, 21_600), (0, 21_600)]).map(Arc::new);
// Where text goes on the first row: (left, right) of each line there.
let first_row = |wrap: Wrap, rot: f32, flip_h: bool| {
let f = Float { wrap, rot, flip_h, wrap_polygon: poly.clone(), ..Default::default() };
let l = line_spans(&lay(&wrapped_shape_doc(ShapeKind::Rectangle, 200.0, 100.0, f)));
l.iter().filter(|s| s.0 < 1.0).map(|s| (s.2.round(), s.3.round())).collect::<Vec<_>>()
};
// Unturned, text comes up to the polygon (half the frame) plus the distance from text.
assert_eq!(first_row(Wrap::Tight, 0.0, false)[0].0, 109.0);
// Turned half a turn or mirrored, the polygon covers the frame's right half: text goes to
// its left and past the frame.
for (rot, flip) in [(180.0, false), (0.0, true)] {
let row = first_row(Wrap::Tight, rot, flip);
assert_eq!((row[0].0, row[0].1, row[1].0), (0.0, 91.0, 209.0), "{rot} {flip}");
}
// Square wrapping ignores the polygon.
assert_eq!(first_row(Wrap::Square, 0.0, false)[0].0, 209.0);
}
/// Enclosed characters (#297, an `EQ \o\ac` field): the shape is drawn as a vector around the text,
/// whatever the font has; "shrink text" draws the text smaller inside a one-em shape, "enlarge
/// symbol" a bigger shape around text at its own size. Plain `\o` overstrikes its arguments.
#[test]
fn enclosed_characters_draw_a_shape_around_the_text() {
crate::test_fonts();
use wordcraft_doc::eq::{EncloseShape, EncloseStyle, Enclosure};
let draw = |shape: EncloseShape, style: EncloseStyle| {
let mut d = Document::from_text("a b");
let e = Enclosure { shape, style, text: "A".into() };
d.insert_object(
&Pos::body(0, 2),
InlineObject::Field { instr: e.instr(), result: "A".into(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &Default::default());
let shape = items
.iter()
.find_map(|i| if let display::Draw::Shape { rect, kind, stroke, .. } = i { Some((*rect, *kind, stroke.is_some())) } else { None });
// Each glyph's character, size and x.
let mut chars = Vec::new();
for i in &items {
if let display::Draw::Glyphs { text, size, glyphs, ranges, .. } = i {
for (g, r) in glyphs.iter().zip(ranges) {
chars.push((text.get(r.clone()).unwrap_or("").to_string(), *size, g.1));
}
}
}
let at = |c: &str| chars.iter().find(|x| x.0 == c).map(|x| (x.1, x.2)).unwrap_or_else(|| panic!("{c}: {items:?}"));
(shape.expect("a shape"), at("A"), at("b"))
};
let ((rect, kind, stroked), (size, gx), (base, bx)) = draw(EncloseShape::Circle, EncloseStyle::Shrink);
assert_eq!(kind, wordcraft_doc::para::ShapeKind::Ellipse);
assert!(stroked);
assert!(size < base * 0.8, "the text shrinks: {size} vs {base}");
assert!((rect.h - base * 1.05).abs() < 0.1 && (rect.w - rect.h).abs() < 0.1, "{rect:?}");
assert!(gx > rect.x && gx < rect.x + rect.w, "the text is inside: {gx} {rect:?}");
assert!(bx >= rect.x + rect.w, "the next text follows the shape: {bx} {rect:?}");
let ((rect, kind, _), (size, _), (base, _)) = draw(EncloseShape::Diamond, EncloseStyle::Enlarge);
assert_eq!(kind, wordcraft_doc::para::ShapeKind::Diamond);
assert!((size - base).abs() < 0.01 && rect.h > base * 1.5, "the shape grows: {rect:?}");
// A general overstrike: both arguments at the same place, no shape.
let mut d = Document::from_text("x");
d.insert_object(
&Pos::body(0, 1),
InlineObject::Field { instr: "eq \\o(=,/)".into(), result: String::new(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &Default::default());
assert!(!items.iter().any(|i| matches!(i, display::Draw::Shape { .. })));
assert!(items.iter().any(|i| matches!(i, display::Draw::Glyphs { text, .. } if text.contains("=/"))), "{items:?}");
}
#[test]
fn superscript_and_subscript_lines_are_as_tall_as_full_size_text() {
use wordcraft_doc::props::VertAlign;
// Word sizes the line at the full font size and leaves out the raise or drop (Word for Mac:
// an 11pt subscript beside 11pt text keeps the 12.675pt line; 24pt subscript alone makes the
// 27.6pt line of plain 24pt text). A `w:position` lowering still counts.
let height = |runs: &[(&str, f32, VertAlign, f32)]| {
let mut p = wordcraft_doc::Paragraph::new();
p.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Multiple(1.0));
for (text, size, vert_align, position) in runs {
let props = wordcraft_doc::CharProps {
font: Some("Source Sans 3".into()),
size: Some(*size),
vert_align: Some(*vert_align),
position: Some(*position),
..Default::default()
};
p.runs.push(wordcraft_doc::para::Run { len: text.len(), props: props.clone() });
p.text.push_str(text);
p.mark = props;
}
let mut d = Document::new();
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { para.lines.first().map(|x| x.height) } else { None }).unwrap()
};
let plain = height(&[("Hxg", 11.0, VertAlign::Baseline, 0.0)]);
for va in [VertAlign::Subscript, VertAlign::Superscript] {
assert_eq!(height(&[("Hxg ", 11.0, VertAlign::Baseline, 0.0), ("max", 11.0, va, 0.0)]), plain, "{va:?} beside text");
assert_eq!(height(&[("Hxg", 11.0, va, 0.0)]), plain, "{va:?} alone");
assert_eq!(height(&[("Hxg", 24.0, va, 0.0)]), height(&[("Hxg", 24.0, VertAlign::Baseline, 0.0)]), "24pt {va:?}");
}
let lowered = height(&[("Hxg ", 11.0, VertAlign::Baseline, 0.0), ("max", 11.0, VertAlign::Subscript, -6.0)]);
assert!((lowered - plain - 6.0).abs() < 0.01, "lowered {lowered} vs plain {plain}");
}
#[test]
fn superscript_digits_advance_at_the_half_point_size() {
use wordcraft_doc::props::VertAlign;
// Word sets an 11pt superscript at 7pt (0.65 × 11 = 7.15, rounded to the half point): its
// digits advance by 7pt digit widths (Word for Mac, measured from its PDF export).
let width = |size: f32, vert_align: VertAlign| {
let mut p = wordcraft_doc::Paragraph::new();
let props =
wordcraft_doc::CharProps { font: Some(WRAP_TEST_FONT.into()), size: Some(size), vert_align: Some(vert_align), ..Default::default() };
p.runs.push(wordcraft_doc::para::Run { len: 10, props: props.clone() });
p.text.push_str("1234567890");
p.mark = props;
let mut d = Document::new();
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
// From the first digit's start to the last's: nine digit advances.
let xs = l.pages[0]
.items
.iter()
.find_map(|it| if let Placed::Lines { para, .. } = it { para.lines.first().map(|x| x.xs.clone()) } else { None })
.unwrap();
xs.last().unwrap() - xs.first().unwrap()
};
let seven = width(7.0, VertAlign::Baseline);
assert!((width(11.0, VertAlign::Superscript) - seven).abs() < 0.01, "{} vs {seven}", width(11.0, VertAlign::Superscript));
assert!((width(11.0, VertAlign::Subscript) - seven).abs() < 0.01);
}
#[test]
fn ruby_text_sits_over_its_base_and_the_line_grows_to_fit() {
crate::test_fonts();
use wordcraft_doc::para::RubyAlign;
let plain = Document::from_text("Plain words here");
let mut d = Document::from_text("Plain here");
let ruby = InlineObject::Ruby {
base: "words".into(),
ruby: "a much longer reading".into(),
align: RubyAlign::Center,
size: 6.0,
raise: 12.0,
base_size: 12.0,
lang: String::new(),
props: Default::default(),
};
d.insert_object(&Pos::body(0, 6), ruby, &Default::default()).unwrap();
let height = |l: &DocLayout| {
l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { para.lines.first().map(|x| x.height) } else { None }).unwrap()
};
let (lp, lr) = (lay(&plain), lay(&d));
assert!(height(&lr) > height(&lp) + 3.0, "ruby line {} vs plain {}", height(&lr), height(&lp));
let items = display::page_display(&d, &lr.pages[0], &Default::default());
let glyphs_of = |want: &str| {
items.iter().find_map(|i| match i {
display::Draw::Glyphs { text, glyphs, size, .. } if text.contains(want) => Some((*size, glyphs.clone())),
_ => None,
})
};
let (_, line) = glyphs_of("Plain words").expect("base text drawn");
let (size, over) = glyphs_of("a much longer reading").expect("ruby text drawn");
let w = line[6]; // "Plain " then the base's first letter
// Smaller, 12 pt above the base text's baseline, and (being wider) centred over it: it starts
// at the base's slot, the base letters move in.
assert_eq!(size, 6.0);
assert!((w.2 - over[0].2 - 12.0).abs() < 0.01, "{w:?} {over:?}");
let slot = lr.caret(&Pos::body(0, 6)).unwrap().x;
assert!((over[0].1 - slot).abs() < 0.5 && w.1 > slot + 1.0, "{slot} {w:?} {over:?}");
// The plain text reads the base, and the caret steps over the ruby as one character.
assert_eq!(d.body[0].as_para().unwrap().plain_text(), "Plain words here");
let (a, b) = (lr.caret(&Pos::body(0, 6)).unwrap(), lr.caret(&Pos::body(0, 9)).unwrap());
assert!(b.x - a.x > 30.0, "{a:?} {b:?}");
}
/// #354: `wrapText`. Left: text only to the left of a centred object (Square or Tight); Right:
/// only to its right; Largest: only on its wider side.
#[test]
fn wrap_text_keeps_text_on_one_side() {
crate::test_fonts();
use wordcraft_doc::para::{Float, ShapeKind, Wrap, WrapText};
// A 100pt shape at `x` in the 468pt column; the lines beside it.
let beside = |kind, wrap, x: f32, side| {
let f = Float { wrap, wrap_text: side, x, ..Default::default() };
line_spans(&lay(&wrapped_shape_doc(kind, 100.0, 100.0, f))).into_iter().filter(|l| l.0 < 100.0).collect::<Vec<_>>()
};
for (kind, wrap) in [(ShapeKind::Rectangle, Wrap::Square), (ShapeKind::Ellipse, Wrap::Tight)] {
let both = beside(kind, wrap, 184.0, WrapText::BothSides);
assert!(both.iter().any(|l| l.2 < 1.0) && both.iter().any(|l| l.2 > 200.0), "{both:?}");
let left = beside(kind, wrap, 184.0, WrapText::Left);
// Nothing right of the object (Tight: lines come up to the outline, short of its middle).
let mid = if wrap == Wrap::Square { 175.0 } else { 234.0 };
assert!(!left.is_empty() && left.iter().all(|l| l.2 < 1.0 && l.3 <= mid + 0.01), "{wrap:?}: {left:?}");
let right = beside(kind, wrap, 184.0, WrapText::Right);
let mid = if wrap == Wrap::Square { 293.0 } else { 234.0 };
assert!(!right.is_empty() && right.iter().all(|l| l.2 >= mid - 0.01), "{wrap:?}: {right:?}");
}
// Nearer the left edge the right side is wider, nearer the right edge the left.
let near_left = beside(ShapeKind::Rectangle, Wrap::Square, 100.0, WrapText::Largest);
assert!(!near_left.is_empty() && near_left.iter().all(|l| l.2 >= 209.0 - 0.01), "{near_left:?}");
let near_right = beside(ShapeKind::Rectangle, Wrap::Square, 268.0, WrapText::Largest);
assert!(!near_right.is_empty() && near_right.iter().all(|l| l.2 < 1.0 && l.3 <= 259.0 + 0.01), "{near_right:?}");
}
#[test]
fn document_note_separators_and_continuation_notice() {
crate::test_fonts();
let mut d = Document::from_text(&"Body text line.\n".repeat(16));
let long = footnote(&mut d, &Pos::body(4, 4), &"A long footnote that runs on and on. ".repeat(100));
let sep = |cont: bool| {
let mut p = wordcraft_doc::Paragraph::new();
p.props.space_after = Some(0.0);
p.insert_object(0, InlineObject::note_separator(cont), &Default::default()).unwrap();
Some(vec![wordcraft_doc::para_block(p)])
};
let mut notice = wordcraft_doc::Paragraph::with_text("(continued)", Default::default());
notice.props.space_after = Some(0.0);
d.footnote_separators = wordcraft_doc::NoteSeparators {
separator: sep(false),
continuation_separator: sep(true),
continuation_notice: Some(vec![wordcraft_doc::para_block(notice)]),
};
let l = lay(&d);
let pieces = note_pieces(&l, long);
assert!(pieces.len() >= 2 && (pieces[0].0, pieces[1].0) == (0, 1), "{pieces:?}");
// The document's separators are paragraphs: their lines are drawn across the separator's
// place, short on page 1 and across the text on page 2.
let decor = |pi: usize| -> Vec<(f32, f32)> {
l.pages[pi]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story, y, para, l0, l1, .. } if *story == DECOR_STORY => Some((*y, item_bottom(*y, para, *l0, *l1).unwrap())),
_ => None,
})
.collect()
};
let (d0, d1) = (decor(0), decor(1));
assert_eq!((d0.len(), d1.len()), (2, 1), "separator and notice on page 1, continuation separator on page 2");
assert_eq!(rules_below(&l, 0, 0.0), vec![144.0]);
assert_eq!(rules_below(&l, 1, 0.0), vec![468.0]);
// The notice sits right under the part of the note on page 1, inside the page.
let note_bottom = l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story: StoryRef::Part(s), y, para, l0, l1, .. } if *s == long => item_bottom(*y, para, *l0, *l1),
_ => None,
})
.fold(0.0f32, f32::max);
let (ny, nb) = d0[1];
assert!((ny - note_bottom).abs() < 0.01, "notice at {ny}, note ends at {note_bottom}");
assert!(nb <= 720.01, "notice inside the page: {nb}");
// The separators and notice aren't text anyone clicks into.
assert_ne!(l.story_at(0, 80.0, ny + 2.0), Some(DECOR_STORY));
}
/// #344 with #332: a Drawing Canvas turns as a whole, like a group: its background and outline,
/// then its members clipped to its frame, all drawn inside its turn (the clip in the unturned
/// frame, so the clip turns too); floating or inline. Hit testing follows the turned canvas.
#[test]
fn rotated_canvas_draws_its_clipped_members_inside_the_turn() {
crate::test_fonts();
use crate::display::Draw;
use wordcraft_doc::para::{Anchor, CanvasStyle, Float, GroupChild, ShapeKind, Wrap};
let member = InlineObject::Shape {
kind: ShapeKind::Rectangle,
w: 60.0,
h: 40.0,
fill: Some(Fill::solid(wordcraft_doc::props::Rgb(1, 2, 3))),
stroke: None,
stroke_width: 0.0,
float: Float { rot: 10.0, ..Default::default() },
story: None,
effects: Default::default(),
freeform: None,
extra: Default::default(),
};
let canvas = |float: Float| InlineObject::Group {
w: 200.0,
h: 100.0,
float,
ch_w: 200.0,
ch_h: 100.0,
children: vec![GroupChild { x: 20.0, y: 30.0, obj: member.clone() }],
canvas: Some(CanvasStyle { fill: Some(Fill::solid(wordcraft_doc::props::Rgb(0xF0, 0xF4, 0xFF))), stroke: None, stroke_width: 0.0 }),
};
// Turned draws: (turn, background rect, clip rect, member rect and its own turn).
let turned = |draws: &[Draw]| -> (Vec<f32>, Vec<Rect>, Vec<(Rect, Vec<(Rect, f32)>)>) {
let (mut turns, mut bgs, mut clips) = (Vec::new(), Vec::new(), Vec::new());
for d in draws {
let Draw::Rotated { spin, items, .. } = d else { continue };
turns.push(spin.deg);
for i in items {
match i {
Draw::Shape { rect, fill: Some(display::Paint::Solid(c, _)), .. } if c.0 == 0xF0 => bgs.push(*rect),
Draw::Clip { rect, items } => {
let members = items
.iter()
.map(|m| match m {
Draw::Rotated { spin, items, .. } => match items.first() {
Some(Draw::Shape { rect, .. }) => (*rect, spin.deg),
o => panic!("{o:?}"),
},
o => panic!("{o:?}"),
})
.collect();
clips.push((*rect, members));
}
_ => {}
}
}
}
(turns, bgs, clips)
};
for floating in [true, false] {
let float = if floating {
Float { wrap: Wrap::InFrontOfText, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 100.0, y: 100.0, rot: 90.0, ..Default::default() }
} else {
Float { rot: 90.0, ..Default::default() }
};
let mut d = Document::from_text("Text by the canvas.");
d.insert_object(&Pos::body(0, 0), canvas(float), &Default::default()).unwrap();
let l = lay(&d);
let p = &l.pages[0];
let hit = l.object(&Pos::body(0, 0), 0).unwrap();
assert_eq!(hit.spin.deg, 90.0);
let f = hit.rect;
let (turns, bgs, clips) = turned(&crate::display::page_display(&d, p, &Default::default()));
assert!(turns.contains(&90.0), "floating {floating}: {turns:?}");
// Background and clip are the canvas's unturned frame; the member sits in it, unturned
// but for its own 10°.
assert_eq!(bgs.len(), 1, "floating {floating}");
assert!((bgs[0].x - f.x).abs() < 0.01 && (bgs[0].w - 200.0).abs() < 0.01, "{bgs:?} vs {f:?}");
assert_eq!(clips.len(), 1, "floating {floating}");
let (clip, members) = &clips[0];
assert!((clip.x - bgs[0].x).abs() < 0.01 && (clip.y - bgs[0].y).abs() < 0.01 && (clip.h - 100.0).abs() < 0.01, "{clip:?}");
assert_eq!(members.len(), 1, "{members:?}");
let (m, own) = members[0];
assert!((m.x - (clip.x + 20.0)).abs() < 0.01 && (m.y - (clip.y + 30.0)).abs() < 0.01, "{m:?} in {clip:?}");
assert_eq!(own, 10.0);
if floating {
// Turned a quarter, the canvas's frame's left end is empty; above its centre isn't.
let (cx, cy) = (f.x + f.w / 2.0, f.y + f.h / 2.0);
assert!(l.object_at(0, f.x + 5.0, cy, 0.0).is_none());
assert!(l.object_at(0, cx, cy - 80.0, 0.0).is_some());
}
}
}
#[test]
fn mirror_indents_swap_sides_on_even_pages() {
crate::test_fonts();
// #512: with mirrored indents the left indent is the inside one, on the right of an even page.
let mut d = Document::from_text("odd page\neven page");
let last = Pos::body(1, 0);
d.format_paragraphs(&Pos::body(0, 0), &last, &|p| {
p.indent_left = Some(72.0);
p.mirror_indents = Some(true);
})
.unwrap();
d.format_paragraphs(&last, &last, &|p| p.page_break_before = Some(true)).unwrap();
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
let odd = l.caret(&Pos::body(0, 0)).unwrap();
let even = l.caret(&last).unwrap();
assert_eq!(even.page, 1);
assert!((odd.x - 144.0).abs() < 0.5, "odd page: inside indent on the left, {odd:?}");
assert!((even.x - 72.0).abs() < 0.5, "even page: the left side has the outside indent (0), {even:?}");
}
/// Ten short paragraphs in a two-column section (`widths`: unequal columns), then one paragraph
/// in a one-column section starting `start`.
fn two_column_section(start: wordcraft_doc::section::SectionStart, widths: Vec<(f32, f32)>) -> Document {
use wordcraft_doc::section::SectionProps;
let text: Vec<String> = (0..10).map(|i| format!("Short paragraph {i}")).chain(["After the break".to_string()]).collect();
let mut d = Document::from_text(&text.join("\n"));
let mut s = SectionProps::default();
s.columns.count = 2;
s.columns.widths = widths;
d.para_mut(StoryRef::Body, &Path::top(9)).unwrap().section = Some(Box::new(s));
d.last_section.start = start;
d
}
/// The vertical rules on page `p`: (x, top, bottom).
fn vertical_rules(l: &DocLayout, p: usize) -> Vec<(f32, f32, f32)> {
l.pages[p]
.items
.iter()
.filter_map(|i| if let Placed::Rule { x0, x1, y0, y1, .. } = i { (x0 == x1).then_some((*x0, *y0, *y1)) } else { None })
.collect()
}
/// #5178: two columns with Line between for selected text (a continuous section between
/// one-column text) draw their line, from the top of the section's text to the bottom of its
/// columns, not over the text above or below; a section starting the page draws it down to the
/// bottom of its text, not of the page.
#[test]
fn the_line_between_columns_spans_the_section_s_text() {
use wordcraft_doc::section::{SectionProps, SectionStart};
let text: Vec<String> =
["Intro".to_string()].into_iter().chain((1..=8).map(|i| format!("Column text {i}"))).chain(["After".to_string()]).collect();
let mut d = Document::from_text(&text.join("\n"));
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().section = Some(Box::default());
let mut two = SectionProps { start: SectionStart::Continuous, ..Default::default() };
two.columns.count = 2;
two.columns.separator = true;
d.para_mut(StoryRef::Body, &Path::top(8)).unwrap().section = Some(Box::new(two.clone()));
d.last_section.start = SectionStart::Continuous;
let l = lay(&d);
let boxes = para_boxes(&l);
let rules = vertical_rules(&l, 0);
let [(x, top, bottom)] = rules[..] else { panic!("one line: {rules:?}") };
let mid = 72.0 + 468.0 / 2.0;
assert!((x - mid).abs() < 0.5, "midway between the columns: {x}");
assert!(top >= boxes[0].3 - 0.5 && (top - boxes[1].2).abs() < 0.5, "from the section's top: {top} {boxes:?}");
assert!(bottom <= boxes[9].2 + 0.5 && bottom > top + 30.0, "down to its columns' bottom, above After: {bottom} {boxes:?}");
// Space before and after the column paragraphs isn't text: the line runs from the first
// line's top to the bottom of the lowest line.
let mut spaced = d.clone();
for i in 1..=8 {
let p = spaced.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
(p.props.space_before, p.props.space_after) = (Some(24.0), Some(24.0));
}
let l = lay(&spaced);
let boxes = para_boxes(&l);
let rules = vertical_rules(&l, 0);
let [(_, top, bottom)] = rules[..] else { panic!("one line: {rules:?}") };
let lowest = boxes[1..=8].iter().map(|b| b.3).fold(0.0f32, f32::max);
// The second column's first paragraph starts at the column's top (no space before there).
let highest = boxes[1..=8].iter().map(|b| b.2).fold(f32::MAX, f32::min);
assert!(boxes[1].2 > highest + 10.0, "the first column's text starts below its space before: {boxes:?}");
assert!((top - highest).abs() < 0.5, "from the highest line, not a space before: {top} {boxes:?}");
assert!((bottom - lowest).abs() < 0.5, "to the lowest line, not its space after: {bottom} vs {lowest}");
// A section of one paragraph: its line starts at the paragraph's first line, below its space
// before, not at the section's top.
let mut one = Document::from_text("Intro\nOnly paragraph\nAfter");
one.para_mut(StoryRef::Body, &Path::top(0)).unwrap().section = Some(Box::default());
let p = one.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
p.props.space_before = Some(24.0);
p.section = Some(Box::new(two.clone()));
one.last_section.start = SectionStart::Continuous;
let l = lay(&one);
let boxes = para_boxes(&l);
let rules = vertical_rules(&l, 0);
let [(_, top, bottom)] = rules[..] else { panic!("one line: {rules:?}") };
assert!((top - boxes[1].2).abs() < 0.5 && (bottom - boxes[1].3).abs() < 0.5, "the paragraph's lines: {top}..{bottom} {boxes:?}");
// A section whose one line doesn't fit at the foot of the page (40 pt type) starts on the
// next: no line where it has no text, though the flow moved down there by its space before.
let mut late = Document::from_text("Filler\nBig\nAfter");
let filler = late.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
filler.props.space_after = Some(600.0);
filler.section = Some(Box::default());
late.format_range(&Pos::body(1, 0), &Pos::body(1, 3), &|c: &mut wordcraft_doc::CharProps| c.size = Some(40.0)).unwrap();
let p = late.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
p.props.space_before = Some(6.0);
p.section = Some(Box::new(two.clone()));
late.last_section.start = SectionStart::Continuous;
let l = lay(&late);
assert_eq!(para_boxes(&l)[1].0, 1, "the paragraph moves to page 2: {:?}", para_boxes(&l));
assert!(vertical_rules(&l, 0).is_empty(), "no line on page 1: {:?}", vertical_rules(&l, 0));
assert_eq!(vertical_rules(&l, 1).len(), 1, "its line on page 2");
// A floating table of the section before, placed lower on the page than the columns' text,
// isn't the columns' text: the line stays with the columns.
let mut floated = Document::from_text("Intro\nEnd of one\nCol one\nCol two\nAfter");
let mut t = Table::new(1, 1, 200.0);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Low table", Default::default()))];
t.props.float = Some(wordcraft_doc::props::TableFloat {
h_rel: wordcraft_doc::para::Anchor::Margin,
v_rel: wordcraft_doc::para::Anchor::Page,
y: 500.0,
..Default::default()
});
floated.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
floated.para_mut(StoryRef::Body, &Path::top(2)).unwrap().section = Some(Box::default());
floated.para_mut(StoryRef::Body, &Path::top(4)).unwrap().section = Some(Box::new(two.clone()));
floated.last_section.start = SectionStart::Continuous;
let l = lay(&floated);
let low = l.pages[0].items.iter().find_map(|i| if let Placed::Cell { rect, .. } = i { Some(rect.y) } else { None });
assert!(low.is_some_and(|y| y >= 490.0), "the table stands low on the page: {low:?}");
// The table's own side borders are vertical rules too: the line is the one midway.
let rules: Vec<_> = vertical_rules(&l, 0).into_iter().filter(|r| (r.0 - mid).abs() < 0.5).collect();
let [(_, _, bottom)] = rules[..] else { panic!("one line: {rules:?}") };
let boxes = para_boxes(&l);
assert!(bottom < 300.0 && bottom <= boxes[4].2 + 0.5, "the line ends with the columns, above After: {bottom} {boxes:?}");
// One section of two columns: the line runs down to the bottom of the text, not the page.
let mut d = Document::from_text("One\nTwo\nThree");
d.last_section.columns = two.columns.clone();
let l = lay(&d);
let rules = vertical_rules(&l, 0);
let [(_, top, bottom)] = rules[..] else { panic!("one line: {rules:?}") };
assert!((top - 72.0).abs() < 0.5 && bottom < 150.0, "{top}..{bottom}");
}
/// Each top-level paragraph's first piece: (page, x, top, bottom).
fn para_boxes(l: &DocLayout) -> Vec<(usize, f32, f32, f32)> {
let mut v: Vec<(usize, usize, f32, f32, f32)> = Vec::new();
for (pi, p) in l.pages.iter().enumerate() {
for it in &p.items {
if let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, x, y, .. } = it
&& let [b] = path.0[..]
&& !v.iter().any(|e| e.0 == b as usize)
{
v.push((b as usize, pi, *x, *y, item_bottom(*y, para, *l0, *l1).unwrap()));
}
}
}
v.sort_by_key(|e| e.0);
v.into_iter().map(|(_, pi, x, t, b)| (pi, x, t, b)).collect()
}
/// Bottoms of the two columns (paragraphs 0–9 by their x) and the top of paragraph 10.
fn column_bottoms(l: &DocLayout) -> (usize, f32, usize, f32, (usize, f32)) {
let b = para_boxes(l);
let x0 = b[0].1;
let (left, right): (Vec<_>, Vec<_>) = b[..10].iter().partition(|e| (e.1 - x0).abs() < 1.0);
let bottom = |v: &[&(usize, f32, f32, f32)]| v.iter().map(|e| e.3).fold(0.0f32, f32::max);
(left.len(), bottom(&left), right.len(), bottom(&right), (b[10].0, b[10].2))
}
#[test]
fn columns_before_a_continuous_break_are_balanced() {
crate::test_fonts();
use wordcraft_doc::section::SectionStart;
for widths in [vec![], vec![(150.0, 36.0), (282.0, 0.0)]] {
let l = lay(&two_column_section(SectionStart::Continuous, widths.clone()));
let (nl, bl, nr, br, (page, after)) = column_bottoms(&l);
// Filled left to right, level: five paragraphs each (the left one may hold one more).
assert!(nl == 5 || nl == 6, "{widths:?}: {nl} left, {nr} right");
assert!(bl >= br - 0.5 && bl - br < 20.0, "{widths:?}: columns end at {bl} and {br}");
// The next section starts right below, on the same page.
assert_eq!(page, 0);
assert!(after >= bl - 0.5 && after < bl + 30.0, "{widths:?}: next section at {after}, columns end at {bl}");
}
}
#[test]
fn columns_before_a_page_break_or_a_column_break_are_not_balanced() {
crate::test_fonts();
use wordcraft_doc::section::SectionStart;
// Next-page break: the ten paragraphs fill the first column; the next section is on page 2.
let l = lay(&two_column_section(SectionStart::NextPage, vec![]));
let (nl, _, nr, _, (page, _)) = column_bottoms(&l);
assert_eq!((nl, nr, page), (10, 0, 1));
// An explicit column break after paragraph 1 decides where the first column ends.
let mut d = two_column_section(SectionStart::Continuous, vec![]);
let p = d.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
let end = p.text.len();
p.insert_text(end, &wordcraft_doc::para::COLUMN_BREAK.to_string(), &Default::default()).unwrap();
let l = lay(&d);
let (nl, bl, nr, br, (page, after)) = column_bottoms(&l);
assert_eq!((nl, nr, page), (2, 8, 0));
// The next section starts below the taller column.
assert!(br > bl + 50.0 && after >= br - 0.5, "columns end at {bl} and {br}, next section at {after}");
}
#[test]
fn an_odf_section_says_whether_its_columns_are_balanced() {
use wordcraft_doc::section::SectionStart;
// The document's last section in two columns: Word's rule leaves it unbalanced (nothing
// follows); an ODF section asking for balance gets it there too.
let text: Vec<String> = (0..10).map(|i| format!("Short paragraph {i}")).collect();
let left_count = |balance: Option<bool>| {
let mut d = Document::from_text(&text.join("\n"));
d.last_section.columns.count = 2;
d.last_section.balance_columns = balance;
let b = para_boxes(&lay(&d));
let x0 = b[0].1;
b.iter().filter(|e| (e.1 - x0).abs() < 1.0).count()
};
assert_eq!(left_count(None), 10);
let n = left_count(Some(true));
assert!(n == 5 || n == 6, "{n} in the left column");
// A section saying no stays unbalanced even before a continuous break.
let mut d = two_column_section(SectionStart::Continuous, vec![]);
if let Some(s) = d.para_mut(StoryRef::Body, &Path::top(9)).unwrap().section.as_mut() {
s.balance_columns = Some(false);
}
let (nl, _, nr, _, _) = column_bottoms(&lay(&d));
assert_eq!((nl, nr), (10, 0));
}
/// The glyphs of each note reference mark in the body, by note id.
fn note_marks(l: &DocLayout) -> HashMap<u32, Vec<u32>> {
let mut marks = HashMap::new();
for it in l.pages.iter().flat_map(|p| p.items.iter()) {
if let Placed::Lines { story: StoryRef::Body, para, .. } = it {
for (ci, id) in ¶.notes {
let c = ¶.clusters[*ci];
marks.insert(*id, para.glyphs[c.g0 as usize..c.g1 as usize].iter().map(|g| g.gid).collect::<Vec<_>>());
}
}
}
marks
}
#[test]
fn footnotes_restart_on_each_page_and_section() {
crate::test_fonts();
use wordcraft_doc::section::{NoteProps, NoteRestart};
let mut d = Document::from_text(&"Body text line.\n".repeat(120));
let a = footnote(&mut d, &Pos::body(2, 4), "First note.");
let b = footnote(&mut d, &Pos::body(4, 4), "Second note.");
let c = footnote(&mut d, &Pos::body(110, 4), "A later page's note.");
let l = lay(&d);
let page = |l: &DocLayout, id: u32| l.caret(&d.start_of(StoryRef::Part(id))).unwrap().page;
assert!(page(&l, c) > page(&l, a), "the third note is on a later page");
let marks = note_marks(&l);
assert_ne!(marks[&c], marks[&a], "numbered on: 3 is not 1");
// Restart each page: the later page's note is 1 again; the first page counts 1, 2.
d.settings.footnote_pr = NoteProps { num_restart: Some(NoteRestart::EachPage), ..Default::default() };
let marks = note_marks(&lay(&d));
assert_eq!(marks[&c], marks[&a]);
assert_ne!(marks[&b], marks[&a]);
// Restart each section, starting at 5, in a second section that starts at paragraph 50.
d.settings.footnote_pr = NoteProps::default();
d.para_mut(StoryRef::Body, &Path::top(49)).unwrap().section = Some(Box::new(SectionProps::default()));
d.last_section.footnote_pr = NoteProps { num_restart: Some(NoteRestart::EachSect), num_start: Some(5), ..Default::default() };
let nums = note_numbers(&d, HideDeleted::default());
assert_eq!((nums[&a], nums[&b], nums[&c]), (1, 2, 5));
}
#[test]
fn endnotes_at_section_end_and_footnotes_below_text() {
crate::test_fonts();
use wordcraft_doc::section::{NotePos, NoteProps};
let mut d = Document::from_text("Alpha\nBeta\nGamma\nDelta");
let eid = d.add_part(
wordcraft_doc::PartKind::Endnote,
vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("An endnote.", Default::default()))],
);
d.insert_object(
&Pos::body(0, 5),
InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Endnote, id: eid, custom: String::new() },
&Default::default(),
)
.unwrap();
// Two sections, the second on a new page.
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().section = Some(Box::new(SectionProps::default()));
let end_page = |d: &Document| {
let l = lay(d);
(l.caret(&d.start_of(StoryRef::Part(eid))).unwrap().page, l.caret(&Pos::body(2, 0)).unwrap().page)
};
assert_eq!(end_page(&d), (1, 1), "end of document: after the second section's text");
d.settings.endnote_pr = NoteProps { pos: Some(NotePos::SectEnd), ..Default::default() };
assert_eq!(end_page(&d), (0, 1), "end of section: on the first section's page");
// A footnote below the text sits right under the last line, above where it'd be at the bottom.
let fid = footnote(&mut d, &Pos::body(0, 2), "A footnote.");
let top = |d: &Document| lay(d).caret(&d.start_of(StoryRef::Part(fid))).unwrap().top;
let bottom = top(&d);
d.settings.footnote_pr = NoteProps { pos: Some(NotePos::BeneathText), ..Default::default() };
let below = top(&d);
let text = lay(&d).caret(&Pos::body(1, 0)).unwrap();
assert!(below > text.top + text.height && below < bottom - 100.0, "{below} {bottom} {text:?}");
}
/// Each run is hyphenated and proofed in its own language (`w:lang`, resolved through the
/// styles): Polish patterns and dictionary for Polish runs, English ones for English runs.
#[test]
fn hyphenation_and_proofing_follow_each_runs_language() {
crate::test_fonts();
// A tiny synthetic Polish dictionary (real ones are installed on the system, not bundled).
wordcraft_proof::pl::install_dictionary("SET UTF-8\nSFX B Y 1\nSFX B y ego y\n", "2\nkonstytucyjny/B\npłynie\n").unwrap();
let text = "Konstytucyjnego żeka typography beautifull";
let mut d = Document::from_text(text);
d.settings.auto_hyphenation = true;
let eng = text.find("typography").unwrap();
d.format_range(&Pos::body(0, 0), &Pos::body(0, eng), &|c| c.lang = Some("pl-PL".into())).unwrap();
d.format_range(&Pos::body(0, eng), &Pos::body(0, text.len()), &|c| c.lang = Some("en-US".into())).unwrap();
let mut c = LayoutCache::new();
let l = layout(&d, &mut c, &LayoutOptions { proofing: true, ..LayoutOptions::default() });
let para = l.pages[0].items.iter().find_map(|i| if let Placed::Lines { para, .. } = i { Some(para.clone()) } else { None }).expect("a paragraph");
// Byte offsets after which a hyphen may go.
let ends: Vec<usize> = para.hyph_after.iter().filter_map(|&k| para.clusters.get(k as usize).map(|c| c.end)).collect();
for prefix in ["Kon", "Konsty", "Konstytu", "Konstytucyj", "Konstytucyjne"] {
assert!(ends.contains(&prefix.len()), "Polish kon-sty-tu-cyj-ne-go: no break after {prefix:?} in {ends:?}");
}
for prefix in ["ty", "typog", "typogra"] {
assert!(ends.contains(&(eng + prefix.len())), "English ty-pog-ra-phy: no break after {prefix:?} in {ends:?}");
}
// Spelling: the Polish misspelling and the English one; Polish words aren't English errors.
let flagged: Vec<&str> = para.issues.iter().filter(|i| !i.2).map(|i| &text[i.0..i.1]).collect();
assert_eq!(flagged, ["żeka", "beautifull"]);
// The layout and the Review commands report the same issues.
let p = d.para(StoryRef::Body, &Path::top(0)).unwrap();
let issues = para::paragraph_issues(p, ¶::proof_runs(&d, p, None), &Default::default(), true, false);
assert_eq!(issues.iter().map(|i| (i.start, i.end, i.kind == wordcraft_proof::IssueKind::Grammar)).collect::<Vec<_>>(), para.issues);
assert_eq!(issues[0].lang, wordcraft_proof::ProofLang::Pl);
assert_eq!(issues[1].lang, wordcraft_proof::ProofLang::En);
}
/// A list item may be a fragment: the drawn squiggles skip its first word's missing capital, a
/// plain paragraph's keep it (#1741). The list comes from the paragraph's own numbering or its
/// style's; a paragraph that switches the style's list off (`num: 0`) is plain again.
#[test]
fn list_item_first_word_gets_no_capital_squiggle() {
crate::test_fonts();
use wordcraft_doc::props::NumRef;
let opts = LayoutOptions { proofing: true, ..LayoutOptions::default() };
let grammar_squiggles = |d: &Document| -> usize {
let l = layout(d, &mut LayoutCache::new(), &opts);
l.pages[0].items.iter().map(|i| if let Placed::Lines { para, .. } = i { para.issues.iter().filter(|x| x.2).count() } else { 0 }).sum()
};
let mut d = Document::from_text("item one");
let id = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Bullet);
assert_eq!(grammar_squiggles(&d), 1, "plain paragraph");
// Direct numbering.
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.numbering = Some(NumRef { num: id, level: 0 })).unwrap();
assert_eq!(grammar_squiggles(&d), 0, "own numbering");
// Numbering from the paragraph style.
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.numbering = None;
p.style = Some("Bullets".into());
})
.unwrap();
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "Bullets".into(),
name: "Bullets".into(),
kind: wordcraft_doc::StyleKind::Paragraph,
para: ParaProps { numbering: Some(NumRef { num: id, level: 0 }), ..Default::default() },
..Default::default()
});
assert_eq!(grammar_squiggles(&d), 0, "style numbering");
// `num: 0` over the style's list.
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| p.numbering = Some(NumRef { num: 0, level: 0 })).unwrap();
assert_eq!(grammar_squiggles(&d), 1, "list switched off");
}
/// Text in a language WordCraft can't proof gets no spelling marks, and "Do not check spelling
/// or grammar" text none either; the document default language applies to text without its own.
#[test]
fn unproofed_languages_and_no_proof_runs_are_not_marked() {
crate::test_fonts();
// A tiny synthetic Polish dictionary (real ones are installed on the system, not bundled).
wordcraft_proof::pl::install_dictionary("SET UTF-8\nSFX B Y 1\nSFX B y ego y\n", "2\nkonstytucyjny/B\npłynie\n").unwrap();
let opts = LayoutOptions { proofing: true, ..LayoutOptions::default() };
let issues = |d: &Document| -> usize {
let l = layout(d, &mut LayoutCache::new(), &opts);
l.pages[0].items.iter().map(|i| if let Placed::Lines { para, .. } = i { para.issues.len() } else { 0 }).sum()
};
let text = "Nous écrivons beaucoup aujourd'hui.";
let mut d = Document::from_text(text);
assert!(issues(&d) > 0, "French words are English misspellings in an English document");
Arc::make_mut(&mut d.styles).default_chr.lang = Some("fr-FR".into());
assert_eq!(issues(&d), 0, "no French dictionary: no marks");
Arc::make_mut(&mut d.styles).default_chr.lang = Some("pl-PL".into());
let mut pl = Document::from_text("Płynie żeka.");
Arc::make_mut(&mut pl.styles).default_chr.lang = Some("pl-PL".into());
assert_eq!(issues(&pl), 1);
pl.format_range(&Pos::body(0, 0), &Pos::body(0, "Płynie żeka.".len()), &|c| c.no_proof = Some(true)).unwrap();
assert_eq!(issues(&pl), 0);
}
/// #451: page totals in the body show the document's page count (the stale cached result is
/// ignored), on every page, like the same fields in the footer.
#[test]
fn shared_section_page_totals() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
use wordcraft_doc::section::{SectionProps, SectionStart};
#[derive(Clone, Copy)]
enum FieldPlace {
BodyAndFooter,
FooterOnly,
}
for place in [FieldPlace::BodyAndFooter, FieldPlace::FooterOnly] {
let mut doc = Document::from_text("A\nB shared\nB second\nC");
let field = |instr: &str| InlineObject::Field {
instr: instr.into(),
result: "999".into(),
locked: false,
dirty: true,
code: false,
form: String::new(),
};
let mut footer = Paragraph::new();
for instr in ["PAGE", "SECTIONPAGES"] {
footer.insert_object(footer.len(), field(instr), &Default::default()).unwrap();
}
let id = doc.add_part(wordcraft_doc::PartKind::Footer, vec![wordcraft_doc::para_block(footer)]);
for index in 0..4 {
let p = doc.para_mut(StoryRef::Body, &Path::top(index)).unwrap();
p.props.line_spacing = Some(LineSpacing::Exactly(12.0));
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p.props.page_break_before = Some(index == 2);
if matches!(place, FieldPlace::BodyAndFooter) {
for instr in ["PAGE", "SECTIONPAGES"] {
p.insert_object(p.len(), field(instr), &Default::default()).unwrap();
}
}
}
for (index, start) in [(0, SectionStart::NextPage), (2, SectionStart::Continuous)] {
let mut section = SectionProps { start, ..Default::default() };
section.footers.default = Some(id);
doc.para_mut(StoryRef::Body, &Path::top(index)).unwrap().section = Some(Box::new(section));
}
doc.last_section.start = SectionStart::NextPage;
doc.last_section.footers.default = Some(id);
let laid = lay(&doc);
assert_eq!(laid.pages.len(), 3);
assert_eq!(laid.pages.iter().map(|p| p.section).collect::<Vec<_>>(), [0, 1, 2]);
let shown = |items: &[Placed]| {
items
.iter()
.flat_map(|item| match item {
Placed::Lines { para, .. } => para.shown.iter().map(|s| s.1.clone()).collect::<Vec<_>>(),
_ => Vec::new(),
})
.collect::<Vec<_>>()
};
for (page, expected) in laid.pages.iter().zip([["1", "1"], ["2", "2"], ["3", "1"]]) {
assert_eq!(shown(&page.footer), expected);
}
if matches!(place, FieldPlace::BodyAndFooter) {
for (page, expected) in laid.pages.iter().zip([vec!["1", "1", "1", "2"], vec!["2", "2"], vec!["3", "1"]]) {
assert_eq!(shown(&page.items), expected);
}
}
}
}
#[test]
fn body_page_totals_count_every_page() {
crate::test_fonts();
let mut d = Document::from_text("Body-1\nBody-2\nBody-3");
let field =
|instr: &str| InlineObject::Field { instr: instr.into(), result: "9".into(), locked: false, dirty: false, code: false, form: String::new() };
for i in 0..3 {
let p = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
p.props.page_break_before = Some(i > 0);
let n = p.len();
p.insert_object(n, field("NUMPAGES"), &Default::default()).unwrap();
let n = p.len();
p.insert_object(n, field("SECTIONPAGES"), &Default::default()).unwrap();
}
let mut fp = wordcraft_doc::Paragraph::new();
fp.insert_object(0, field("NUMPAGES"), &Default::default()).unwrap();
let id = d.add_part(wordcraft_doc::PartKind::Footer, vec![wordcraft_doc::para_block(fp)]);
d.last_section.footers.default = Some(id);
let l = lay(&d);
assert_eq!(l.pages.len(), 3);
let shown = |items: &[Placed]| -> Vec<String> {
items
.iter()
.flat_map(|it| if let Placed::Lines { para, .. } = it { para.shown.iter().map(|s| s.1.clone()).collect() } else { vec![] })
.collect()
};
for (i, p) in l.pages.iter().enumerate() {
assert_eq!(shown(&p.items), ["3", "3"], "body of page {}", i + 1);
assert_eq!(shown(&p.footer), ["3"], "footer of page {}", i + 1);
}
// One page: one pass, total 1.
let mut d1 = Document::from_text("Only");
let p = d1.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.insert_object(4, field("NUMPAGES"), &Default::default()).unwrap();
assert_eq!(shown(&lay(&d1).pages[0].items), ["1"]);
}
/// #450: a footnote referenced in a table cell is placed at the bottom of its page, like one in
/// a body paragraph.
#[test]
fn table_cell_footnotes_are_placed() {
crate::test_fonts();
let mut d = Document::from_text("After the table.");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(wordcraft_doc::Table::new(1, 1, 300.0))).unwrap();
let cell = Pos { story: StoryRef::Body, path: Path(vec![0, 0, 0, 0]), off: 0 };
d.para_mut(StoryRef::Body, &cell.path).unwrap().insert_text(0, "Table reference", &Default::default()).unwrap();
let id = footnote(&mut d, &Pos { off: "Table reference".len(), ..cell }, "Table note payload.");
let l = lay(&d);
assert_eq!(l.pages.len(), 1);
let c = l.caret(&d.start_of(StoryRef::Part(id))).expect("the cell's footnote is placed");
assert_eq!(c.page, 0);
let body = l.caret(&Pos::body(1, 0)).unwrap();
assert!(c.top > body.top + 100.0, "at the page bottom: {c:?} {body:?}");
}
#[test]
fn east_asian_text_takes_the_asian_font_and_latin_text_the_latin_font() {
crate::test_fonts();
// #505: one run with a Latin font and an Asian font (w:eastAsia) of its own sets each script in
// its font. Prefer an installed CJK font other than the one fallback would pick anyway.
let resolve = |f: &str| wordcraft_fonts::word::resolve(f, false, false);
let fallback = wordcraft_fonts::FontDb::global().fallback_for('你', 0).map(|f| f.family.clone());
let mut fonts: Vec<String> = wordcraft_fonts::FontDb::global()
.east_asian_families()
.into_iter()
.filter(|f| {
let r = resolve(f);
!r.substituted && r.face.covers('你') && r.face.covers('好')
})
.collect();
fonts.sort_by_key(|f| Some(f) == fallback.as_ref());
let Some(asian) = fonts.first().cloned() else {
eprintln!("skipped: no Chinese font installed");
return;
};
let latin = wordcraft_doc::styles::BODY_FONT;
let text = "Hello 你好 World";
let mut d = Document::from_text(text);
d.format_range(&Pos::body(0, 0), &Pos::body(0, text.len()), &|c| {
c.font = Some(latin.into());
c.font_ea = Some(asian.clone());
})
.unwrap();
let l = lay(&d);
let para =
l.pages.iter().flat_map(|p| p.items.iter()).find_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None }).unwrap();
let (latin_face, asian_face) = (resolve(latin).face.id(), resolve(&asian).face.id());
for c in ¶.clusters {
let Some(ch) = text.get(c.start..c.end).and_then(|s| s.chars().next()).filter(|ch| !ch.is_whitespace()) else { continue };
let face = para.styles[c.style as usize].face.id();
let want = if ch.is_ascii() { latin_face } else { asian_face };
assert_eq!(face, want, "{ch:?} in {}", if ch.is_ascii() { latin } else { &asian });
}
}
/// Text typed after a raised or lowered character sits where that character does: an input
/// method's composition there is drawn on the line's baseline shifted as the run is (positive up),
/// as the committed text is drawn, not on the line's own baseline.
#[test]
fn typing_style_takes_the_runs_baseline_shift() {
use wordcraft_doc::props::VertAlign;
let mut d = Document::from_text("x2");
d.format_range(&Pos::body(0, 1), &Pos::body(0, 2), &|c| c.vert_align = Some(VertAlign::Superscript)).unwrap();
let l = lay(&d);
let (plain, line) = l.typing_style(&Pos::body(0, 1), 0).expect("after the x");
let (raised, base) = l.typing_style(&Pos::body(0, 2), 0).expect("after the superscript 2");
assert_eq!(plain.shift, 0.0);
assert!(raised.shift > 0.0, "a superscript is raised: {}", raised.shift);
assert!((line - raised.shift - base).abs() < 0.01, "line {line}, shift {}, baseline {base}", raised.shift);
}
/// Text typed after a character the run's font lacks asks for the run's own font, not the fallback
/// face that drew that character: an input method's composition after a Chinese character in a
/// Latin font draws its letters as the committed letters are drawn.
#[test]
fn typing_style_asks_for_the_runs_font_after_a_fallback_character() {
let text = "A\u{4f60}";
let l = lay(&Document::from_text(text));
let para = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None }).unwrap();
let face_at = |off: usize| para.clusters.iter().find(|c| c.start == off).map(|c| para.styles[c.style as usize].face.id());
let (latin, han) = (face_at(0), face_at(1));
if latin == han {
eprintln!("skipped: the body font has the character, or no installed font does");
return;
}
let (run, _) = l.typing_style(&Pos::body(0, text.len()), 0).expect("after the Chinese character");
assert_eq!(Some(run.face.id()), han, "the character before the caret is drawn in a fallback face");
assert_eq!(Some(run.requested_face.id()), latin, "text typed there asks for the run's own font");
}
#[test]
fn a_missing_east_asian_font_is_drawn_in_its_font_table_alternate() {
crate::test_fonts();
// #2702 for the run's East Asian font (`w:eastAsia`): one that isn't installed is drawn in the
// alternate its font table names, when that one is installed and has the characters. Take an
// installed CJK font other than the one fallback would pick anyway, so the test tells them apart.
let resolve = |f: &str| wordcraft_fonts::word::resolve(f, false, false);
let fallback = wordcraft_fonts::FontDb::global().fallback_for('你', 0).map(|f| f.family.clone());
let Some(asian) = wordcraft_fonts::FontDb::global().east_asian_families().into_iter().find(|f| {
let r = resolve(f);
Some(f) != fallback.as_ref() && !r.substituted && r.face.covers('你') && r.face.covers('好')
}) else {
eprintln!("skipped: no second Chinese font installed");
return;
};
let missing = "No Such East Asian Font 2702";
let text = "Hello 你好";
let faces = |alternate: bool| {
let mut d = Document::from_text(text);
if alternate {
d.settings.font_alt_names = vec![(missing.into(), asian.clone())];
}
d.format_range(&Pos::body(0, 0), &Pos::body(0, text.len()), &|c| {
c.font = Some(wordcraft_doc::styles::BODY_FONT.into());
c.font_ea = Some(missing.into());
})
.unwrap();
let l = lay(&d);
let para =
l.pages.iter().flat_map(|p| p.items.iter()).find_map(|it| if let Placed::Lines { para, .. } = it { Some(para) } else { None }).unwrap();
let drawn = para
.clusters
.iter()
.filter(|c| text.get(c.start..c.end).and_then(|s| s.chars().next()).is_some_and(|ch| !ch.is_ascii()))
.map(|c| para.styles[c.style as usize].face.id())
.collect::<Vec<_>>();
(drawn, l.substituted_fonts())
};
let asian_face = resolve(&asian).face.id();
let (with, reported) = faces(true);
assert!(!with.is_empty() && with.iter().all(|f| *f == asian_face), "你好 in the alternate {asian}");
// Drawn in an installed alternate, the font asked for is still missing (#4770).
assert!(reported.iter().any(|(f, _)| f == missing), "{reported:?}");
assert!(faces(false).0.iter().all(|f| *f != asian_face), "without the alternate, fallback picks another font");
}
/// A page total in the footer ("Page X of Y") is filled in after pagination, so it doesn't make
/// the body lay out a second time; one in the body still does.
#[test]
fn footer_page_total_needs_one_body_pass() {
crate::test_fonts();
let field =
|| InlineObject::Field { instr: "NUMPAGES".into(), result: "9".into(), locked: false, dirty: false, code: false, form: String::new() };
let mut d = Document::from_text("Body-1\nBody-2\nBody-3");
for i in 1..3 {
d.para_mut(StoryRef::Body, &Path::top(i)).unwrap().props.page_break_before = Some(true);
}
let mut fp = wordcraft_doc::Paragraph::new();
fp.insert_object(0, field(), &Default::default()).unwrap();
let id = d.add_part(wordcraft_doc::PartKind::Footer, vec![wordcraft_doc::para_block(fp)]);
d.last_section.footers.default = Some(id);
let first = |d: &Document| {
let totals = Totals::first_guess(d.sections().len());
layout_pass(d, &mut LayoutCache::new(), &LayoutOptions::default(), (&HashMap::new(), None), &totals, true, (&EarlyFloats::new(), true))
};
assert!(matches!(first(&d), Pass::Done(l) if l.pages.len() == 3), "the footer's total asked for another pass");
// The same field in the body is only known once every page is laid out.
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
let n = p.len();
p.insert_object(n, field(), &Default::default()).unwrap();
assert!(matches!(first(&d), Pass::Again(t) if t.pages == 3));
}
/// Bulgarian text (`w:lang` `bg-BG`) is hyphenated by the Bulgarian syllable rules; the same
/// Cyrillic text in an English run is not hyphenated (the English data has nothing to say about it).
#[test]
fn bulgarian_text_is_hyphenated_by_its_own_rules() {
crate::test_fonts();
let text = "Сричкопренасянето в професионалните документи задължително следва правописните правила, разработени от специалистите. ".repeat(6);
let hyphenated = |d: &Document| -> Vec<(String, String)> {
let mut out = Vec::new();
for it in &lay(d).pages[0].items {
if let Placed::Lines { para, .. } = it {
for l in para.lines.iter().filter(|x| x.hyphen.is_some()) {
let end = l.stop;
let before = text.get(..end).unwrap_or_default();
let word_start = before.rfind(' ').map_or(0, |i| i + 1);
let after = text.get(end..).unwrap_or_default();
let word_end = after.find(|c: char| !c.is_alphabetic()).unwrap_or(after.len());
out.push((text[word_start..end].to_string(), after[..word_end].to_string()));
}
}
}
out
};
let mut d = Document::from_text(&text);
d.settings.auto_hyphenation = true;
assert!(hyphenated(&d).is_empty(), "Cyrillic in an English run: {:?}", hyphenated(&d));
d.format_range(&Pos::body(0, 0), &Pos::body(0, text.len()), &|c| c.lang = Some("bg-BG".into())).unwrap();
let splits = hyphenated(&d);
assert!(!splits.is_empty(), "no hyphenated lines");
let lim = wordcraft_proof::hyphen::Limits::default();
for (head, tail) in &splits {
let word = format!("{head}{tail}");
let at = head.chars().count();
assert!(wordcraft_proof::hyphen::hyphen_points_in(&word, &lim, wordcraft_proof::ProofLang::Bg).contains(&at), "{head}-{tail}");
}
}
/// Spaces and tabs never make a line taller in Word, whatever their size (measured in Word for
/// Windows: 9 pt text with 11–20 pt tabs, spaces and ideographic spaces kept the 9 pt line; a
/// line of only big spaces took the paragraph mark's height; a big letter or no-break space did
/// grow it). Tables of contents with big tab runs were a third taller than Word's.
#[test]
fn spaces_and_tabs_do_not_make_a_line_taller() {
crate::test_fonts();
use wordcraft_doc::props::CharProps;
let small = CharProps { size: Some(9.0), ..Default::default() };
let big = CharProps { size: Some(20.0), ..Default::default() };
let pitch = |middle: &str, middle_props: &CharProps| {
let mut d = Document::new();
d.body = (0..3)
.map(|i| {
let mut p = wordcraft_doc::Paragraph::with_text(&format!("L{i}A"), small.clone());
let n = p.len();
p.insert_text(n, middle, middle_props).unwrap();
let n = p.len();
p.insert_text(n, "B", &small).unwrap();
p.props = ParaProps { space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
p.mark = small.clone();
wordcraft_doc::para_block(p)
})
.collect();
let l = lay(&d);
l.caret(&Pos::body(1, 0)).unwrap().top - l.caret(&Pos::body(0, 0)).unwrap().top
};
let plain = pitch(" ", &small);
for (what, middle) in [("a tab", "\t"), ("a space", " "), ("two spaces", " "), ("an ideographic space", "\u{3000}")] {
assert!((pitch(middle, &big) - plain).abs() < 0.01, "{what} at 20 pt: {} vs {plain}", pitch(middle, &big));
}
assert!(pitch("x", &big) > plain + 5.0, "a 20 pt letter does make it taller");
assert!(pitch("\u{A0}", &big) > plain + 5.0, "so does a no-break space");
}
/// A list label taller than its text makes the first line taller above the baseline only: Word
/// keeps the text's descent below it (measured in Word for Windows, `plan/word` R18: a Symbol
/// bullet's taller ascent counts, a Courier New label's deeper descent doesn't). NIH's bulleted
/// items each came out a fifth of a point taller, enough to push a paragraph's last lines over
/// the page bottom.
#[test]
fn a_list_label_adds_ascent_but_not_descent() {
crate::test_fonts();
let first_line = |label_size: Option<f32>| {
let mut d = Document::new();
let num = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
for a in &mut Arc::make_mut(&mut d.numbering).abstracts {
for l in &mut a.levels {
l.chr.size = label_size;
}
}
let ten = wordcraft_doc::props::CharProps { size: Some(10.0), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::with_text("Item", ten.clone());
p.props.numbering = Some(wordcraft_doc::props::NumRef { num, level: 0 });
p.mark = ten;
p.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Multiple(1.0));
d.body = vec![wordcraft_doc::para_block(p)];
let l = lay(&d);
l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { para.lines.first().cloned() } else { None }).unwrap()
};
let plain = first_line(None);
let big = first_line(Some(30.0));
let below = |l: &crate::para::Line| l.top + l.height - l.baseline;
assert!(big.baseline - big.top > plain.baseline - plain.top + 5.0, "the big label raises the baseline");
assert!((below(&big) - below(&plain)).abs() < 0.01, "the text's descent: {} vs {}", below(&big), below(&plain));
}
/// A cell's hidden end-of-cell mark (`w:hideMark`), measured in Word for Windows (`plan/word`
/// R20, 9 cases): its empty last paragraph takes no room, spacing and all, so a row of such empty
/// cells is only its borders; one ordinary empty cell keeps the row a line tall, and a paragraph
/// with text is never hidden. NIH's Table A showed a blank row Word doesn't.
#[test]
fn a_hidden_cell_mark_takes_no_room() {
crate::test_fonts();
let row3_top = |hide: [bool; 2], second: Option<&str>| {
let mut d = Document::from_text("Above");
let mut t = Table::new(3, 2, 300.0);
for (r, text) in [(0, "R1"), (2, "R3")] {
for cell in &mut t.rows[r].cells {
cell.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))];
}
}
for (cell, hide) in t.rows[1].cells.iter_mut().zip(hide) {
cell.props.hide_mark = hide;
let mut blocks = Vec::new();
if let Some(text) = second {
blocks.push(wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default())));
}
let mut mark = wordcraft_doc::Paragraph::with_text("", Default::default());
mark.props.space_before = Some(10.0);
blocks.push(wordcraft_doc::para_block(mark));
cell.blocks = blocks;
}
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let at = |r: u32| l.caret(&Pos { story: StoryRef::Body, path: Path(vec![1, r, 0, 0]), off: 0 }).unwrap().top;
// Rows 1 and 2 together.
at(2) - at(0)
};
// Row 1 is one line of text; row 2's height is what's left.
let line = {
let both = row3_top([false, false], Some("Tx"));
let mut d = Document::from_text("Above");
let mut t = Table::new(2, 1, 300.0);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("R1", Default::default()))];
t.rows[1].cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("R3", Default::default()))];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let at = |r: u32| l.caret(&Pos { story: StoryRef::Body, path: Path(vec![1, r, 0, 0]), off: 0 }).unwrap().top;
assert!(both > at(1) - at(0));
at(1) - at(0)
};
let row2 = |hide: [bool; 2], second: Option<&str>| row3_top(hide, second) - line;
let hidden = row2([true, true], None);
assert!(hidden < 1.5, "a row of hidden marks is only its borders: {hidden} vs a line of {line}");
let mixed = row2([true, false], None);
let plain = row2([false, false], None);
assert!(plain > 5.0 && (mixed - plain).abs() < 0.01, "an ordinary empty cell keeps the row: {mixed} vs {plain}");
let text = row2([true, true], Some("Tx"));
assert!((text - line).abs() < 0.5, "text stays, the empty mark after it goes: {text} vs {line}");
}
/// A text frame in a header, footer or cell (NIH's footers put the page number in one, centred,
/// with the footer text wrapping around it) is placed apart: it takes no room in the flow, sits
/// where its alignment says, and the text beside it keeps clear of it. WordCraft laid it out as
/// an ordinary paragraph, a line of its own above the footer text.
#[test]
fn a_text_frame_in_a_cell_floats_beside_the_text() {
crate::test_fonts();
use wordcraft_doc::props::TextFrame;
let mut d = Document::from_text("Above");
let mut t = Table::new(1, 1, 300.0);
let mut framed = wordcraft_doc::Paragraph::with_text("7", Default::default());
framed.props.frame = Some(TextFrame {
x_align: Some("right".into()),
h_anchor: "text".into(),
v_anchor: "text".into(),
wrap: "around".into(),
..Default::default()
});
let text = wordcraft_doc::Paragraph::with_text("Cell text", Default::default());
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(framed), wordcraft_doc::para_block(text)];
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let at = |i: u32| l.caret(&Pos { story: StoryRef::Body, path: Path(vec![1, 0, 0, i]), off: 0 }).unwrap();
let (frame, text) = (at(0), at(1));
assert!((frame.top - text.top).abs() < 0.5, "the frame takes no room: {} vs {}", frame.top, text.top);
assert!(frame.x > text.x + 200.0, "right-aligned in the cell: {} vs {}", frame.x, text.x);
}
/// Word has no frames inside a text box: a paragraph there whose style carries a frame (a
/// letterhead's "Weld" and "Governor" styles, framed at the page's left) runs in the box's text
/// like any other. WordCraft placed each one apart at the frame's offset, so two of them in a row
/// were drawn over each other (#2357).
#[test]
fn a_frame_inside_a_text_box_flows_with_its_text() {
crate::test_fonts();
use wordcraft_doc::props::TextFrame;
let mut d = Document::from_text("Body");
let id = text_box(&mut d, 0, "", 150.0, 120.0, Default::default());
let frame = TextFrame { x: 27.3, y: 7.05, h_anchor: "page".into(), v_anchor: "text".into(), wrap: "notBeside".into(), ..Default::default() };
let para = |text: &str, framed: bool| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props.frame = framed.then(|| frame.clone());
wordcraft_doc::para_block(p)
};
d.parts.get_mut(&id).unwrap().blocks = vec![para("Name", true), para("Secretary", true), para("Commissioner", false)];
let l = lay(&d);
let top = |i: usize| l.caret(&Pos { story: StoryRef::Part(id), path: Path::top(i), off: 0 }).unwrap().top;
let (name, secretary, commissioner) = (top(0), top(1), top(2));
assert!(secretary > name + 5.0, "the second framed paragraph goes under the first: {secretary} vs {name}");
assert!(commissioner > secretary + 5.0, "the text after them follows: {commissioner} vs {secretary}");
}
/// Where a list paragraph's text starts when its style has indents of its own (measured in Word,
/// `plan/word` R16): the list level's indents go on top of the most derived style that gives the
/// list, so that style's own indent (and those of styles based on it) win, its base styles' don't
/// and the paragraph's own list wins over every style; a paragraph that switches the list off
/// (`num: 0`) drops the styles' indents. NIH's Heading 3 (its own 0.9" on Heading 2's list) sat at
/// the list's 0.6", and its "sample text" paragraphs with the list off at 0.9" instead of the margin.
#[test]
fn list_indents_and_style_indents_combine_like_word() {
crate::test_fonts();
use wordcraft_doc::props::NumRef;
use wordcraft_doc::styles::{Style, StyleKind};
let text_x = |style: &str, own: ParaProps| {
let mut d = Document::new();
let num = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
let style_of = |id: &str, based: Option<&str>, para: ParaProps| Style {
id: id.into(),
name: id.into(),
kind: StyleKind::Paragraph,
based_on: based.map(Into::into),
para,
..Default::default()
};
let list = ParaProps { numbering: Some(NumRef { num, level: 0 }), ..Default::default() };
let ind = ParaProps { indent_left: Some(64.8), ..Default::default() };
// List and indent in one style; list in the base, indent in the derived one; the reverse.
Arc::make_mut(&mut d.styles).upsert(style_of("Both", None, ParaProps { indent_left: Some(64.8), ..list.clone() }));
Arc::make_mut(&mut d.styles).upsert(style_of("ListBase", None, list.clone()));
Arc::make_mut(&mut d.styles).upsert(style_of("IndentOnList", Some("ListBase"), ind.clone()));
Arc::make_mut(&mut d.styles).upsert(style_of("IndentBase", None, ind));
Arc::make_mut(&mut d.styles).upsert(style_of("ListOnIndent", Some("IndentBase"), list.clone()));
let own =
ParaProps { style: Some(style.into()), numbering: own.numbering.map(|n| NumRef { num: if n.num == 0 { 0 } else { num }, ..n }), ..own };
let mut p = wordcraft_doc::Paragraph::with_text("Text", Default::default());
p.props = own;
d.body = vec![wordcraft_doc::para_block(p)];
lay(&d).caret(&Pos::body(0, 0)).unwrap().x
};
let listed = || ParaProps { numbering: Some(NumRef { num: 1, level: 0 }), ..Default::default() };
let off = || ParaProps { numbering: Some(NumRef { num: 0, level: 0 }), ..Default::default() };
let cases = [
("the style's own indent beats its list's", text_x("Both", ParaProps::default()), 72.0 + 64.8),
("a style based on the list's style wins too", text_x("IndentOnList", ParaProps::default()), 72.0 + 64.8),
("the list's style beats its base style", text_x("ListOnIndent", ParaProps::default()), 108.0),
("the paragraph's own list beats every style", text_x("Both", listed()), 108.0),
("list off: the style's indent goes too", text_x("Both", off()), 72.0),
("list off drops an indent from any style", text_x("IndentBase", off()), 72.0),
("list off keeps the paragraph's own indent", text_x("Both", ParaProps { indent_left: Some(10.0), ..off() }), 82.0),
];
for (what, got, want) in cases {
assert!((got - want).abs() < 0.5, "{what}: {got} vs {want}");
}
}
/// Keep with next at a page bottom, measured in Word for Windows (`plan/word` R19, 20 cases): a
/// paragraph that would fit on the page by itself moves over with the next one, but one that
/// doesn't fit anyway breaks as usual, its last lines going over with the next paragraph (with
/// Keep lines together it moves whole); a chain of kept paragraphs moves together. NIH's
/// five-line kept paragraph left a third of a page empty.
#[test]
fn keep_with_next_moves_a_paragraph_only_when_it_would_fit() {
crate::test_fonts();
// Page of each of the kept paragraph's 5 lines and of the first paragraph after it.
let pages = |fillers: usize, kept: ParaProps, next: ParaProps| {
let mut d = Document::new();
let plain = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(wordcraft_doc::props::LineSpacing::Multiple(1.0)),
..Default::default()
};
let para = |text: &str, p: &ParaProps| {
let mut x = wordcraft_doc::Paragraph::with_text(text, Default::default());
x.props = ParaProps { keep_next: p.keep_next, keep_lines: p.keep_lines, ..plain.clone() };
wordcraft_doc::para_block(x)
};
d.body = (0..fillers).map(|i| para(&format!("F{i}"), &plain)).collect();
d.body.push(para("Ka\nKb\nKc\nKd\nKe", &kept));
d.body.push(para("NX", &next));
d.body.push(para("NY", &plain));
let l = lay(&d);
let k = fillers;
[0, 3, 6, 9, 12]
.map(|off| l.caret(&Pos::body(k, off)).unwrap().page)
.into_iter()
.chain([l.caret(&Pos::body(k + 1, 0)).unwrap().page])
.collect::<Vec<_>>()
};
let none = ParaProps::default();
let kn = ParaProps { keep_next: Some(true), ..Default::default() };
let kl = ParaProps { keep_lines: Some(true), ..kn.clone() };
// Find where the kept paragraph just fits: its last line on page 1, the next one's on page 2.
let fit = (20..80).find(|n| pages(*n, none.clone(), none.clone()) == [0, 0, 0, 0, 0, 1]).expect("a filler count that fills the page");
assert_eq!(pages(fit, kn.clone(), none.clone()), [1, 1, 1, 1, 1, 1], "fits by itself: moves with the next");
let split = pages(fit + 1, none.clone(), none.clone());
assert!(split[0] == 0 && split[4] == 1, "one more line splits it: {split:?}");
assert_eq!(pages(fit + 1, kn.clone(), none.clone()), split, "doesn't fit anyway: breaks as usual");
assert_eq!(pages(fit + 1, kl.clone(), none.clone()), [1, 1, 1, 1, 1, 1], "with keep lines together it moves whole");
assert_eq!(pages(fit - 1, kn.clone(), kn.clone()), [1, 1, 1, 1, 1, 1], "a kept chain moves together");
}
/// A kept heading goes with the paragraph after it when that paragraph cannot start on its
/// page (#966): with widow/orphan control on, one line of it at the bottom of the page moves
/// over with the rest, so only two lines below the heading hold it there. Word and LibreOffice
/// both move the heading; WordCraft left it alone. With the control off the single line stays,
/// and the heading keeps it company.
#[test]
fn keep_with_next_carries_the_heading_when_widow_control_moves_the_next_paragraph() {
crate::test_fonts();
// Page of the heading, then of the next paragraph's lines at "Bb", "Bc" and "Be".
let pages = |fillers: usize, widow: bool| -> [usize; 4] {
let mut d = Document::new();
let plain = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(wordcraft_doc::props::LineSpacing::Multiple(1.0)),
widow_control: Some(widow),
..Default::default()
};
let para = |text: &str, p: &ParaProps| {
let mut x = wordcraft_doc::Paragraph::with_text(text, Default::default());
x.props = p.clone();
wordcraft_doc::para_block(x)
};
d.body = (0..fillers).map(|i| para(&format!("F{i}"), &plain)).collect();
let mut heading = wordcraft_doc::Paragraph::with_text("HEADING", Default::default());
heading.props = ParaProps { keep_next: Some(true), ..plain.clone() };
d.body.push(wordcraft_doc::para_block(heading));
d.body.push(para("Bb\nBc\nBd\nBe\nBf", &plain));
let l = lay(&d);
[
l.caret(&Pos::body(fillers, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 3)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 9)).unwrap().page,
]
};
// Find the page edge that leaves the heading room for exactly one line of the paragraph
// after it: with the control off it starts there and the rest goes over.
let fit = (20..100).find(|n| pages(*n, false) == [0, 0, 1, 1]).expect("a filler count that leaves room for one line after the heading");
assert_eq!(pages(fit, false), [0, 0, 1, 1], "without the control one line stays: {fit}");
// With widow/orphan control the paragraph moves over whole, and the heading goes with it.
assert_eq!(pages(fit, true), [1, 1, 1, 1], "the heading follows the paragraph: {fit}");
// One line more of room holds both of its first lines below the heading, under either
// setting.
assert_eq!(pages(fit - 1, true), [0, 0, 0, 1], "two lines below the heading hold it");
assert_eq!(pages(fit - 1, false), [0, 0, 0, 1]);
}
/// A three-line paragraph under widow/orphan control can start on a page only whole: two lines
/// and a widow, or an orphan and two, are both refused. So two lines of room below a kept
/// heading do not hold it there; Word moves the heading over with the paragraph.
#[test]
fn keep_with_next_carries_the_heading_when_a_three_line_paragraph_moves_whole() {
// Pages of the heading and of the paragraph's three lines.
let pages = |fillers: usize, widow: bool| -> [usize; 4] {
let mut d = Document::new();
let plain = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(wordcraft_doc::props::LineSpacing::Multiple(1.0)),
widow_control: Some(widow),
..Default::default()
};
let para = |text: &str, p: &ParaProps| {
let mut x = wordcraft_doc::Paragraph::with_text(text, Default::default());
x.props = p.clone();
wordcraft_doc::para_block(x)
};
d.body = (0..fillers).map(|i| para(&format!("F{i}"), &plain)).collect();
let kept = ParaProps { keep_next: Some(true), keep_lines: Some(true), ..plain.clone() };
d.body.push(para("HEADING", &kept));
d.body.push(para("Bb\nBc\nBd", &plain));
let l = lay(&d);
[
l.caret(&Pos::body(fillers, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 3)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 6)).unwrap().page,
]
};
// The page edge that leaves the heading room for two lines of the paragraph after it.
let fit = (20..100).find(|n| pages(*n, false) == [0, 0, 0, 1]).expect("a filler count that leaves room for two lines after the heading");
// With the control the paragraph moves over whole, and the heading goes with it.
assert_eq!(pages(fit, true), [1, 1, 1, 1], "the heading follows the paragraph: {fit}");
// One line more of room holds all three below the heading.
assert_eq!(pages(fit - 1, true), [0, 0, 0, 0]);
}
/// The chain case of #966: a kept heading before a kept paragraph before a long one all move
/// over when the last one cannot start on the page, and all stay when it can.
#[test]
fn keep_with_next_chain_carries_over_when_the_last_paragraph_cannot_start() {
crate::test_fonts();
let pages = |fillers: usize, widow: bool| -> Vec<usize> {
let mut d = Document::new();
let plain = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(wordcraft_doc::props::LineSpacing::Multiple(1.0)),
widow_control: Some(widow),
..Default::default()
};
let para = |text: &str, p: &ParaProps| {
let mut x = wordcraft_doc::Paragraph::with_text(text, Default::default());
x.props = p.clone();
wordcraft_doc::para_block(x)
};
d.body = (0..fillers).map(|i| para(&format!("F{i}"), &plain)).collect();
let kept = ParaProps { keep_next: Some(true), ..plain.clone() };
d.body.push(para("HEADING", &kept));
d.body.push(para("MID", &kept));
d.body.push(para("Bb\nBc\nBd\nBe\nBf", &plain));
let l = lay(&d);
// Pages of the heading, the kept middle, and the long paragraph's first two lines.
vec![
l.caret(&Pos::body(fillers, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 2, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 2, 3)).unwrap().page,
]
};
// The page edge that leaves the heading and the kept middle room for one line of the long
// paragraph after them.
let fit = (20..100).find(|n| pages(*n, false) == [0, 0, 0, 1]).expect("a filler count that leaves room for one line after the chain");
// With widow/orphan control the long paragraph cannot start there, so the whole chain
// moves over.
assert_eq!(pages(fit, true), [1, 1, 1, 1], "the chain follows the paragraph: {fit}");
assert_eq!(pages(fit, false), [0, 0, 0, 1], "without the control one line stays: {fit}");
}
/// Keep lines together on the paragraph after a kept heading: when the whole paragraph does
/// not fit below the heading, both move over. Word does not leave a kept heading holding part
/// of a paragraph that keep lines together will not split (#966).
#[test]
fn keep_with_next_carries_the_heading_when_keep_lines_moves_the_next_paragraph() {
crate::test_fonts();
let pages = |fillers: usize, kept_lines: bool| -> Vec<usize> {
let mut d = Document::new();
let plain = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(wordcraft_doc::props::LineSpacing::Multiple(1.0)),
widow_control: Some(false),
..Default::default()
};
let para = |text: &str, p: &ParaProps| {
let mut x = wordcraft_doc::Paragraph::with_text(text, Default::default());
x.props = p.clone();
wordcraft_doc::para_block(x)
};
d.body = (0..fillers).map(|i| para(&format!("F{i}"), &plain)).collect();
let mut heading = wordcraft_doc::Paragraph::with_text("HEADING", Default::default());
heading.props = ParaProps { keep_next: Some(true), ..plain.clone() };
d.body.push(wordcraft_doc::para_block(heading));
let body = ParaProps { keep_lines: Some(kept_lines), ..plain.clone() };
d.body.push(para("Bb\nBc\nBd", &body));
let l = lay(&d);
// Pages of the heading and of the paragraph's first two lines.
vec![
l.caret(&Pos::body(fillers, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 0)).unwrap().page,
l.caret(&Pos::body(fillers + 1, 3)).unwrap().page,
]
};
// The page edge that leaves the heading room for exactly one line of the three-line
// paragraph after it.
let fit = (20..100).find(|n| pages(*n, false) == [0, 0, 1]).expect("a filler count that leaves room for one line after the heading");
// With keep lines together the paragraph moves over whole, and the heading goes with it.
assert_eq!(pages(fit, true), [1, 1, 1], "the heading follows the paragraph: {fit}");
assert_eq!(pages(fit, false), [0, 0, 1], "without it the paragraph splits: {fit}");
}
#[test]
fn section_mark_hidden_styles() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
use wordcraft_doc::section::{SectionProps, SectionStart};
use wordcraft_doc::{CharProps, Style, StyleKind};
let position = |kind: Option<StyleKind>, show_hidden| {
let mut doc = Document::from_text("\nAfter marker");
Arc::make_mut(&mut doc.styles).upsert(Style {
id: "HiddenMark".into(),
name: "Hidden mark".into(),
kind: kind.unwrap_or(StyleKind::Character),
chr: CharProps { hidden: Some(true), ..Default::default() },
..Default::default()
});
for index in 0..2 {
let p = doc.para_mut(StoryRef::Body, &Path::top(index)).unwrap();
p.props.line_spacing = Some(LineSpacing::Exactly(12.0));
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
}
let p = doc.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.section = Some(Box::new(SectionProps::default()));
match kind {
None => p.mark.hidden = Some(true),
Some(StyleKind::Character) => p.mark.style = Some("HiddenMark".into()),
Some(StyleKind::Paragraph) => p.props.style = Some("HiddenMark".into()),
_ => panic!("expected a character or paragraph style"),
}
let p = doc.para(StoryRef::Body, &Path::top(0)).unwrap();
assert!(doc.styles.resolve_char(p.props.style.as_deref(), &p.mark).hidden);
doc.last_section.start = SectionStart::Continuous;
let laid = layout(&doc, &mut LayoutCache::new(), &LayoutOptions { show_hidden, ..Default::default() });
laid.caret(&Pos::body(1, 0)).unwrap().top
};
for show_hidden in [false, true] {
let direct = position(None, show_hidden);
let character = position(Some(StyleKind::Character), show_hidden);
let paragraph = position(Some(StyleKind::Paragraph), show_hidden);
assert!((character - direct).abs() < 0.01, "show_hidden={show_hidden}: direct={direct}, character={character}");
assert!((paragraph - direct).abs() < 0.01, "show_hidden={show_hidden}: direct={direct}, paragraph={paragraph}");
}
assert!((position(None, true) - position(None, false) - 12.0).abs() < 0.01);
}
#[test]
fn empty_page_section_keeps_line() {
crate::test_fonts();
use wordcraft_doc::section::{SectionProps, SectionStart};
let mut doc = Document::from_text("\nAfter empty section\n\nReference prefix\n\nAfter middle mark");
for index in 0..6 {
let para = doc.para_mut(StoryRef::Body, &Path::top(index)).unwrap();
para.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(12.0));
para.props.space_before = Some(0.0);
para.props.space_after = Some(0.0);
}
for (index, start) in [(0, SectionStart::NextPage), (2, SectionStart::Continuous), (4, SectionStart::NextPage)] {
doc.para_mut(StoryRef::Body, &Path::top(index)).unwrap().section = Some(Box::new(SectionProps { start, ..Default::default() }));
}
doc.last_section.start = SectionStart::Continuous;
let laid = lay(&doc);
let after_empty = laid.caret(&Pos::body(1, 0)).unwrap();
let prefix = laid.caret(&Pos::body(3, 0)).unwrap();
let after_middle = laid.caret(&Pos::body(5, 0)).unwrap();
assert_eq!([after_empty.page, prefix.page, after_middle.page], [0, 1, 1]);
assert!((after_empty.top - prefix.top - 12.0).abs() < 0.01, "empty page section: {after_empty:?}, reference: {prefix:?}");
assert!((after_middle.top - prefix.top - 12.0).abs() < 0.01, "middle mark: {after_middle:?}, reference: {prefix:?}");
}
/// An empty paragraph that only carries a section break before a continuous section takes no
/// room, measured in Word for Windows (`plan/word` R21, 10 cases): the text after it follows right
/// on, and columns balanced above it don't count it (two one-line paragraphs in two columns sit
/// side by side). A section break on a paragraph with text keeps its line, and so does any break
/// before a section on a new page. The SARP form's fields drifted a line lower at each of its
/// many continuous breaks.
/// A continuous section starting mid-page leaves its first paragraph's page break before in
/// force, measured in Word for Mac: "Cover", an empty mark closing a continuous section, then
/// "Heading" with page break before puts "Heading" on page 2.
#[test]
fn a_page_break_before_after_a_continuous_mark_starts_a_page() {
use wordcraft_doc::section::{SectionProps, SectionStart};
let mut d = Document::from_text("Cover\n\nHeading");
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().section =
Some(Box::new(SectionProps { start: SectionStart::Continuous, ..Default::default() }));
d.para_mut(StoryRef::Body, &Path::top(2)).unwrap().props.page_break_before = Some(true);
d.last_section.start = SectionStart::Continuous;
assert_eq!(lay(&d).caret(&Pos::body(2, 0)).unwrap().page, 1);
}
#[test]
fn an_empty_continuous_section_mark_takes_no_room() {
crate::test_fonts();
use wordcraft_doc::section::{SectionProps, SectionStart};
// "Pa", the section's last paragraph (`mark`), "Pb", "Pc" in the next section of `cols`
// columns, then "Pd" after a second break.
let tops = |mark: &str, cols: u32, start: SectionStart| {
let mut d = Document::from_text(&format!("Pa\n{mark}\nPb\nPc\n\nPd"));
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().section =
Some(Box::new(SectionProps { start: SectionStart::Continuous, ..Default::default() }));
let mut s = SectionProps { start, ..Default::default() };
s.columns.count = cols;
d.para_mut(StoryRef::Body, &Path::top(4)).unwrap().section = Some(Box::new(s));
d.last_section.start = SectionStart::Continuous;
let l = lay(&d);
[0, 2, 3, 5].map(|i| {
let c = l.caret(&Pos::body(i, 0)).unwrap();
(c.page, (c.top * 10.0).round() / 10.0, c.x)
})
};
let one = tops("", 1, SectionStart::Continuous);
let line = one[2].1 - one[1].1;
assert!((one[1].1 - one[0].1 - line).abs() < 0.15, "Pb right under Pa: {one:?}");
assert!((one[3].1 - one[2].1 - line).abs() < 0.15, "Pd right under Pc: {one:?}");
let text = tops("Mark", 1, SectionStart::Continuous);
assert!((text[1].1 - text[0].1 - 2.0 * line).abs() < 0.15, "a mark with text keeps its line: {text:?}");
let two = tops("", 2, SectionStart::Continuous);
assert_eq!(two[1].1, two[2].1, "balanced: Pb and Pc side by side: {two:?}");
assert!(two[2].2 > two[1].2 + 100.0, "Pc in the second column: {two:?}");
assert!((two[3].1 - two[1].1 - line).abs() < 0.15, "Pd a line below them: {two:?}");
let new_page = tops("", 1, SectionStart::NextPage);
assert_eq!(new_page[1].0, 1, "a next-page section starts a page: {new_page:?}");
}
/// A hidden mark closing a section before a continuous one, holding only an in-line picture:
/// the picture keeps its line, so the next section starts below it, not over it (#5288). A
/// floating picture there still leaves the mark quiet, and so does a hidden one or one in hidden
/// text.
#[test]
fn a_hidden_mark_with_an_inline_picture_keeps_its_room() {
use wordcraft_doc::para::{Float, ShapeKind};
use wordcraft_doc::section::{SectionProps, SectionStart};
// Where Pb starts, and the bottom of the closing mark's picture (none: no picture).
let tops = |float: Option<Float>, run: CharProps| {
let mut d = Document::from_text("Pa\n\nPb");
let closer = d.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
closer.mark.hidden = Some(true);
closer.section = Some(Box::new(SectionProps::default()));
d.last_section.start = SectionStart::Continuous;
if let Some(float) = float {
let shape = InlineObject::Shape {
kind: ShapeKind::Rectangle,
w: 144.0,
h: 72.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
effects: Default::default(),
freeform: None,
extra: Default::default(),
};
d.insert_object(&Pos::body(1, 0), shape, &run).unwrap();
}
let l = lay(&d);
let bottom = l.object(&Pos::body(1, 0), 0).map(|o| o.rect.bottom());
(l.caret(&Pos::body(2, 0)).unwrap(), bottom)
};
let wrapped = |wrap| Some(Float { wrap, ..Default::default() });
let (empty, _) = tops(None, CharProps::default());
let (pb, bottom) = tops(wrapped(Wrap::Inline), CharProps::default());
let bottom = bottom.unwrap();
assert_eq!(pb.page, 0, "the continuous section stays on the page: {pb:?}");
assert!(pb.top >= empty.top + 72.0 - 0.01, "Pb starts below the 72 pt picture: {pb:?} vs {empty:?}");
assert!(pb.top >= bottom - 0.01, "Pb starts below the picture's frame: {pb:?} vs {bottom}");
let (floating, drawn) = tops(wrapped(Wrap::InFrontOfText), CharProps::default());
assert!(drawn.is_some(), "the floating picture is drawn");
assert!((floating.top - empty.top).abs() < 0.01, "a floating picture leaves the mark quiet: {floating:?} vs {empty:?}");
let (hidden, _) = tops(Some(Float { hidden: true, ..Default::default() }), CharProps::default());
assert!((hidden.top - empty.top).abs() < 0.01, "a hidden picture leaves the mark quiet: {hidden:?} vs {empty:?}");
let (in_hidden_text, _) = tops(wrapped(Wrap::Inline), CharProps { hidden: Some(true), ..Default::default() });
assert!((in_hidden_text.top - empty.top).abs() < 0.01, "a picture in hidden text leaves the mark quiet: {in_hidden_text:?} vs {empty:?}");
}
/// A hidden closing mark holding only a legacy check box (a FORMCHECKBOX field, empty result):
/// the box is drawn with a line's room, so the next section starts below it (#5288).
#[test]
fn a_hidden_mark_with_a_check_box_keeps_its_room() {
use wordcraft_doc::section::{SectionProps, SectionStart};
let top = |boxed: bool| {
let mut d = Document::from_text("Pa\n\nPb");
let closer = d.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
closer.mark.hidden = Some(true);
closer.section = Some(Box::new(SectionProps::default()));
d.last_section.start = SectionStart::Continuous;
if boxed {
let form = r#"<w:ffData><w:name w:val="Box"/><w:checkBox><w:sizeAuto/></w:checkBox></w:ffData>"#.to_string();
let field = InlineObject::Field { instr: "FORMCHECKBOX".into(), result: String::new(), locked: false, dirty: false, code: false, form };
d.insert_object(&Pos::body(1, 0), field, &Default::default()).unwrap();
}
lay(&d).caret(&Pos::body(2, 0)).unwrap()
};
let (empty, boxed) = (top(false), top(true));
assert!(boxed.top >= empty.top + 8.0, "Pb starts a line below the check box: {boxed:?} vs {empty:?}");
}
/// Empty marks closing continuous sections one after another each keep their line while it
/// fits; only one right after text is quiet. Past the page's bottom they stay there, so the text
/// after the run starts the next page. Measured in Word (#3907): "Start", N such marks, "End":
/// 10 put "End" about 9 cm down page 1; 50, 100 and 200 all put it on page 2's first line.
#[test]
fn a_run_of_empty_continuous_section_marks_keeps_a_line_each() {
use wordcraft_doc::section::{SectionProps, SectionStart};
let tops_sized = |marks: usize, size: Option<f32>| {
let mut d = Document::from_text(&format!("Start\n{}End", "\n".repeat(marks)));
for i in 1..=marks {
let p = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
p.section = Some(Box::new(SectionProps { start: SectionStart::Continuous, ..Default::default() }));
p.mark.size = size;
}
d.last_section.start = SectionStart::Continuous;
let l = lay(&d);
let (start, end) = (l.caret(&Pos::body(0, 0)).unwrap(), l.caret(&Pos::body(marks + 1, 0)).unwrap());
(end.page, end.top - start.top)
};
let tops = |marks: usize| tops_sized(marks, None);
let (_, one) = tops(1);
let (_, three) = tops(3);
let line = three - one;
assert!(line > 0.0, "marks after the first take room: one {one}, three {three}");
let (_, five) = tops(5);
assert!((five - three - line).abs() < 0.15, "a line per extra mark: three {three}, five {five}");
let (fifty, two_hundred) = (tops(50), tops(200));
assert_eq!(fifty.0, 1, "50 marks fill page 1, End starts page 2: {fifty:?}, line {line}");
assert!((fifty.1 - two_hundred.1).abs() < 0.01 && two_hundred.0 == 1, "more marks stay on page 1: {fifty:?} {two_hundred:?}");
// Large marks too: the run ends at the bottom, so a smaller line after it still starts page 2.
let big = tops_sized(100, Some(24.0));
assert!(big.0 == 1 && (big.1 - fifty.1).abs() < 0.01, "24 pt marks: {big:?}, small: {fifty:?}");
}
/// A floating object positioned relative to its paragraph is measured from the paragraph's start
/// above its space before, measured in Word for Windows (`plan/word` R22, 10 cases: 0, 10 and 20
/// pt before, offsets 0 and −7.2 pt; the previous paragraph's space after still counts). The SARP
/// form's field boxes sat a space-before too low, over their labels.
#[test]
fn paragraph_relative_floats_start_above_the_space_before() {
crate::test_fonts();
let shape_top = |before: f32, prev_after: f32, y: f32| {
let float = wordcraft_doc::para::Float {
wrap: wordcraft_doc::para::Wrap::InFrontOfText,
h_rel: wordcraft_doc::para::Anchor::Column,
v_rel: wordcraft_doc::para::Anchor::Paragraph,
y,
..Default::default()
};
let shape = InlineObject::Shape {
kind: wordcraft_doc::para::ShapeKind::Rectangle,
w: 20.0,
h: 20.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
let plain = ParaProps { space_before: Some(0.0), space_after: Some(prev_after), ..Default::default() };
let mut first = wordcraft_doc::Paragraph::with_text("First", Default::default());
first.props = plain;
let mut p = wordcraft_doc::Paragraph::with_text("Text ", Default::default());
p.text.push(wordcraft_doc::para::OBJ);
p.objects = vec![shape];
p.runs = vec![wordcraft_doc::Run { len: p.text.len(), props: Default::default() }];
p.props = ParaProps { space_before: Some(before), space_after: Some(0.0), ..Default::default() };
let mut d = Document::from_text("");
d.body = vec![wordcraft_doc::para_block(first), wordcraft_doc::para_block(p)];
let l = lay(&d);
let first_bottom = l.pages[0]
.items
.iter()
.find_map(|i| match i {
Placed::Lines { path, para, l0, y, .. } if *path == Path::top(0) => para.lines.get(*l0).map(|ln| y + ln.height),
_ => None,
})
.unwrap();
let top = l.pages[0].items.iter().find_map(|i| if let Placed::Shape { rect, .. } = i { Some(rect.y) } else { None }).unwrap();
(top, first_bottom)
};
for before in [0.0, 10.0, 20.0] {
for y in [0.0, -7.2] {
let (top, first_bottom) = shape_top(before, 0.0, y);
assert!((top - (first_bottom + y)).abs() < 1.0, "{before} pt before, offset {y}: {top} vs {}", first_bottom + y);
}
}
let (top, first_bottom) = shape_top(0.0, 10.0, 0.0);
assert!((top - (first_bottom + 10.0)).abs() < 1.0, "below the previous paragraph's space after: {top} vs {first_bottom}");
}
/// Unequal columns (a narrow label column and a wide text column, as in NIH's SARP form): text
/// after a column break is broken for the column it lands in. WordCraft broke it for the narrow
/// column it started in, so a paragraph took a dozen lines a word or two wide.
#[test]
fn text_after_a_column_break_takes_the_new_column_s_width() {
crate::test_fonts();
let mut d = Document::new();
d.last_section.columns = wordcraft_doc::section::Columns { count: 2, space: 36.0, separator: false, widths: vec![(67.0, 52.0), (348.0, 0.0)] };
let brk = wordcraft_doc::para::COLUMN_BREAK;
let text = format!("Label{brk}Provide a description of the planned recruitment methods including use of contact lists and databases.");
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&text, Default::default()))];
let l = lay(&d);
let lines: Vec<(f32, usize)> =
l.pages[0].items.iter().filter_map(|it| if let Placed::Lines { x, l0, l1, .. } = it { Some((*x, l1 - l0)) } else { None }).collect();
let (wide_x, wide_lines) = lines.last().copied().unwrap();
assert!(wide_x > 72.0 + 67.0, "the text is in the second column: {lines:?}");
assert!(wide_lines <= 3, "broken for the 348 pt column, not the 67 pt one: {lines:?}");
}
/// Space before at the top of a page, measured in Word for Windows (32 cases): a paragraph that
/// ends with a page break keeps its mark with the break (nothing of it, not even its space after,
/// goes to the new page) and the next paragraph gets no space before there; a paragraph that starts with a page break starts on
/// the new page with its space before; a page break before keeps the space before in compatibility
/// modes up to 14 (less the previous paragraph's space after) and drops it in mode 15.
#[test]
fn space_before_at_the_top_of_a_page_like_word() {
crate::test_fonts();
let para = |text: &str, before: f32, pbb: bool| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props = ParaProps { space_before: Some(before), space_after: Some(0.0), page_break_before: Some(pbb), ..Default::default() };
wordcraft_doc::para_block(p)
};
let probe_top = |blocks: Vec<std::sync::Arc<wordcraft_doc::Block>>, mode: u32| {
let mut d = Document::new();
d.settings.compat_mode = mode;
let n = blocks.len();
d.body = blocks;
let l = lay(&d);
let c = l.caret(&Pos::body(n - 1, 0)).unwrap();
(c.page, c.top)
};
let plain_top = probe_top(vec![para("first", 0.0, false), para("PROBE", 0.0, true)], 15).1;
let brk = wordcraft_doc::para::PAGE_BREAK;
// A paragraph ending with a page break, then one with 24 pt before: no space, in both modes.
for mode in [12, 15] {
let (page, top) = probe_top(vec![para(&format!("first{brk}"), 0.0, false), para("PROBE", 24.0, false)], mode);
assert_eq!(page, 1, "mode {mode}");
assert!((top - plain_top).abs() < 0.05, "mode {mode}: the mark stays with the break and the space goes: {top} vs {plain_top}");
}
// Its space after stays behind too (modes 12 to 15), also when it holds only the break: the next
// paragraph, one with a page break before (no blank page) or a table starts at the top.
let after = |text: &str| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props = ParaProps { space_before: Some(0.0), space_after: Some(12.4), ..Default::default() };
wordcraft_doc::para_block(p)
};
let table_top = |blocks: Vec<std::sync::Arc<wordcraft_doc::Block>>| {
let mut d = Document::new();
d.body = blocks;
d.body.push(std::sync::Arc::new(wordcraft_doc::Block::Table(Table::new(1, 1, 468.0))));
let l = lay(&d);
let page = l.pages.len() - 1;
let y = l.pages[page].items.iter().find_map(|i| if let Placed::Cell { rect, .. } = i { Some(rect.y) } else { None });
(page, y)
};
let (_, alone) = table_top(vec![]);
for text in [brk.to_string(), format!("first{brk}")] {
for mode in [12, 14, 15] {
for (before, pbb) in [(0.0, false), (24.0, false), (0.0, true)] {
let (page, top) = probe_top(vec![after(&text), para("PROBE", before, pbb)], mode);
assert_eq!(page, 1, "mode {mode} {text:?} page break before {pbb}");
assert!((top - plain_top).abs() < 0.05, "mode {mode} {text:?} before {before}: {top} vs {plain_top}");
}
}
assert_eq!(table_top(vec![after(&text)]), (1, alone), "{text:?}: a table after the break");
}
// A paragraph starting with a page break: its space before on the new page.
let mut d = Document::new();
d.body = vec![para("first", 0.0, false), para(&format!("{brk}PROBE"), 24.0, false)];
let l = lay(&d);
let c = l.caret(&Pos::body(1, brk.len_utf8())).unwrap();
assert_eq!(c.page, 1);
assert!((c.top - plain_top - 24.0).abs() < 0.05, "{} vs {}", c.top, plain_top + 24.0);
// Page break before: kept up to mode 14, dropped in 15.
let (_, kept) = probe_top(vec![para("first", 0.0, false), para("PROBE", 24.0, true)], 14);
let (_, dropped) = probe_top(vec![para("first", 0.0, false), para("PROBE", 24.0, true)], 15);
assert!((kept - plain_top - 24.0).abs() < 0.05 && (dropped - plain_top).abs() < 0.05, "{kept} {dropped} {plain_top}");
// After a page break before (mode 14) the previous paragraph's space after comes off: 24 - 10.
let mut first = wordcraft_doc::Paragraph::with_text("first", Default::default());
first.props = ParaProps { space_before: Some(0.0), space_after: Some(10.0), ..Default::default() };
let (_, top) = probe_top(vec![wordcraft_doc::para_block(first.clone()), para("PROBE", 24.0, true)], 14);
assert!((top - plain_top - 14.0).abs() < 0.05, "{top} vs {}", plain_top + 14.0);
// More after than before: nothing left.
first.props.space_after = Some(30.0);
let (_, top) = probe_top(vec![wordcraft_doc::para_block(first), para("PROBE", 24.0, true)], 14);
assert!((top - plain_top).abs() < 0.05, "{top} vs {plain_top}");
// The caret can still reach the end of a paragraph whose mark stayed with its page break.
let mut d = Document::new();
d.body = vec![para(&format!("first{brk}"), 0.0, false), para("next", 0.0, false)];
let l = lay(&d);
assert!(l.caret(&Pos::body(0, "first".len() + brk.len_utf8())).is_some(), "caret after the break");
}
/// Word kerns a run only when Kerning for fonts (`w:kern`) is set and the font is at least that
/// size; WordCraft kerned everything, so its lines held more text than Word's (measured in Word for
/// Windows with Calibri at 14 pt: no `w:kern`, `w:kern="0"` and a threshold above the size are
/// all unkerned).
#[test]
fn kerning_follows_kerning_for_fonts_like_word() {
crate::test_fonts();
use wordcraft_doc::props::CharProps;
let width = |kern: Option<f32>| {
let mut d = Document::new();
let chr = CharProps { size: Some(14.0), kern, ..Default::default() };
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("AVAVAV To Wo Ty Yo AWAY", chr))];
let l = lay(&d);
let end = d.para_at(&Pos::body(0, 0)).map_or(0, |p| p.len());
l.caret(&Pos::body(0, end)).unwrap().x - l.caret(&Pos::body(0, 0)).unwrap().x
};
let plain = width(Some(0.0));
assert!(width(Some(1.0)) < plain - 1.0, "kerned from 1 pt: {} vs {plain}", width(Some(1.0)));
assert!((width(Some(14.0)) - width(Some(1.0))).abs() < 0.01, "a threshold equal to the size kerns");
assert!((width(Some(15.0)) - plain).abs() < 0.01, "a threshold above the size doesn't kern");
// A new document kerns from 1 pt, like Word's Normal template.
assert!((width(None) - width(Some(1.0))).abs() < 0.01, "new documents kern");
let mut d = Document::new();
Arc::make_mut(&mut d.styles).default_chr.kern = None;
assert!(d.styles.resolve_char(None, &Default::default()).kern == 0.0, "no Kerning for fonts: not kerned");
}
/// The ligatures a document asks for (`w14:ligatures`, Word's Font ▸ Advanced ▸ Ligatures) are
/// the ones shaped: `none` draws every letter, `standard` turns them back on over a style that
/// turned them off. Without a value WordCraft keeps its default, standard and contextual.
#[test]
fn ligatures_follow_w14_ligatures() {
crate::test_fonts();
use wordcraft_doc::props::{CharProps, Ligatures};
use wordcraft_doc::styles::{Style, StyleKind};
let text = "office affinity";
let face = wordcraft_fonts::word::resolve("Source Serif 4", false, false).face;
assert_eq!(wordcraft_fonts::shape(&face, "fi", &[], |c| c).len(), 1, "the test font draws fi as one glyph");
let glyphs = |style: Option<Ligatures>, run: Option<Ligatures>| {
let mut d = Document::new();
Arc::make_mut(&mut d.styles).upsert(Style {
id: "Plain".into(),
name: "Plain".into(),
kind: StyleKind::Character,
chr: CharProps { ligatures: style, ..Default::default() },
..Default::default()
});
let chr =
CharProps { style: Some("Plain".into()), font: Some("Source Serif 4".into()), size: Some(14.0), ligatures: run, ..Default::default() };
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, chr))];
let l = lay(&d);
l.pages
.iter()
.flat_map(|p| &p.items)
.map(|it| if let Placed::Lines { story: StoryRef::Body, para, .. } = it { para.glyphs.len() } else { 0 })
.sum::<usize>()
};
let letters = text.chars().count();
let none = Ligatures::from_ooxml("none");
let standard = Ligatures::from_ooxml("standard");
assert!(glyphs(None, None) < letters, "WordCraft's default draws ligatures");
assert_eq!(glyphs(None, none), letters, "none: one glyph per letter");
assert_eq!(glyphs(none, None), letters, "none from the character style");
assert!(glyphs(none, standard) < letters, "standard over a style with none draws them again");
assert_eq!(glyphs(None, Ligatures::from_ooxml("contextual")), letters, "fi is a standard ligature, not a contextual one");
}
/// Each flag of `w14:ligatures` sets its OpenType feature: standard `liga`, contextual `clig`,
/// historical `hlig`, discretional `dlig`.
#[test]
fn ligature_flags_map_to_opentype_features() {
crate::test_fonts();
use wordcraft_doc::props::Ligatures;
let f = |t: &[u8; 4], v: u32| wordcraft_fonts::feature_value(t, v);
let hd = Ligatures { historical: true, discretional: true, ..Default::default() };
assert_eq!(para::ligature_features(hd), [f(b"liga", 0), f(b"clig", 0), f(b"hlig", 1), f(b"dlig", 1)]);
let sc = Ligatures { standard: true, contextual: true, ..Default::default() };
assert_eq!(para::ligature_features(sc), [f(b"liga", 1), f(b"clig", 1), f(b"hlig", 0), f(b"dlig", 0)]);
}
/// Word's automatic (HTML-style) paragraph spacing, measured in Word for Windows: 14 pt at any
/// size; none before the first paragraph of the document or a cell, none after the last one of a
/// cell; next to another paragraph's space the larger of the two counts.
#[test]
fn automatic_paragraph_spacing_like_word() {
crate::test_fonts();
let auto = |before: bool, after: bool| ParaProps {
space_before: Some(5.0),
space_after: Some(5.0),
space_before_auto: before.then_some(true),
space_after_auto: after.then_some(true),
..Default::default()
};
let plain = ParaProps { space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
let tops = |props: [ParaProps; 3]| {
let mut d = Document::new();
d.body = ["FIRST", "SECOND", "THIRD"]
.iter()
.zip(props)
.map(|(t, p)| {
let mut para = wordcraft_doc::Paragraph::with_text(t, Default::default());
para.props = p;
wordcraft_doc::para_block(para)
})
.collect();
let l = lay(&d);
[0, 1, 2].map(|i| l.caret(&Pos::body(i, 0)).unwrap().top)
};
let base = tops([plain.clone(), plain.clone(), plain.clone()]);
let line = base[1] - base[0];
let near = |a: f32, b: f32| (a - b).abs() < 0.05;
// Space after: 14 pt.
let t = tops([plain.clone(), auto(false, true), plain.clone()]);
assert!(near(t[2] - t[1], line + 14.0), "{t:?}");
// Space before: 14 pt, but none for the document's first paragraph.
let t = tops([auto(true, false), auto(true, false), plain.clone()]);
assert!(near(t[0], base[0]), "no automatic space at the top of the document");
assert!(near(t[1] - t[0], line + 14.0), "{t:?}");
// Two automatic spaces meet: 14 pt, not 28; an automatic one beside 10 pt: 14.
let t = tops([plain.clone(), auto(true, true), auto(true, true)]);
assert!(near(t[2] - t[1], line + 14.0), "{t:?}");
let ten = ParaProps { space_before: Some(10.0), ..plain.clone() };
let t = tops([plain.clone(), auto(false, true), ten]);
assert!(near(t[2] - t[1], line + 14.0), "{t:?}");
// Explicitly off: the measured spacing again.
let off = ParaProps { space_after_auto: Some(false), ..auto(false, false) };
let t = tops([plain.clone(), off, plain.clone()]);
assert!(near(t[2] - t[1], line + 5.0), "{t:?}");
}
/// In a table cell automatic spacing drops at the cell's top and bottom (Word for Windows).
#[test]
fn automatic_paragraph_spacing_drops_at_cell_edges() {
crate::test_fonts();
let cell_tops = |auto: bool| {
let mut d = Document::from_text("Above");
let mut t = Table::new(1, 1, 300.0);
t.rows[0].cells[0].blocks = ["SECOND", "THIRD"]
.iter()
.map(|s| {
let mut p = wordcraft_doc::Paragraph::with_text(s, Default::default());
p.props = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
space_before_auto: auto.then_some(true),
space_after_auto: auto.then_some(true),
..Default::default()
};
wordcraft_doc::para_block(p)
})
.collect();
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
d.insert_block(StoryRef::Body, &Path::top(2), wordcraft_doc::Block::Para(wordcraft_doc::Paragraph::with_text("Below", Default::default())))
.unwrap();
let l = lay(&d);
let in_cell = |i: u32| l.caret(&Pos { story: StoryRef::Body, path: Path(vec![1, 0, 0, i]), off: 0 }).unwrap().top;
(in_cell(0), in_cell(1), l.caret(&Pos::body(2, 0)).unwrap().top)
};
let (a0, a1, a_below) = cell_tops(true);
let (p0, p1, p_below) = cell_tops(false);
assert!((a0 - p0).abs() < 0.05, "no automatic space at the top of the cell");
assert!((a1 - a0 - (p1 - p0) - 14.0).abs() < 0.05, "14 pt between the cell's paragraphs");
assert!((a_below - a1 - (p_below - p1)).abs() < 0.05, "none after the cell's last paragraph");
}
/// Automatic spacing inside a list, measured in Word for Windows (`plan/word` R17, 16 cases): none
/// between two list items, of one list or two, at any level, whichever item asks for it; the first
/// item keeps its automatic space before and the last its space after, a paragraph with its list
/// switched off in between keeps both, and measured spacing stays. NIH's bulleted IND reports
/// (each item automatic before and after) were 14 pt apart instead of touching.
#[test]
fn automatic_spacing_drops_between_list_items() {
crate::test_fonts();
use wordcraft_doc::props::NumRef;
let auto = ParaProps {
space_before: Some(5.0),
space_after: Some(5.0),
space_before_auto: Some(true),
space_after_auto: Some(true),
..Default::default()
};
let plain = ParaProps { space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
let tops = |items: [ParaProps; 3], in_cell: bool| {
let mut d = Document::new();
let num = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
let other = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
let fix = |p: ParaProps| ParaProps {
numbering: p.numbering.map(|n| NumRef {
num: match n.num {
0 => 0,
1 => num,
_ => other,
},
..n
}),
..p
};
let paras: Vec<_> = std::iter::once(plain.clone())
.chain(items.map(fix))
.chain(std::iter::once(plain.clone()))
.enumerate()
.map(|(i, p)| {
let mut para = wordcraft_doc::Paragraph::with_text(&format!("P{i}"), Default::default());
para.props = p;
wordcraft_doc::para_block(para)
})
.collect();
if in_cell {
let mut t = Table::new(1, 1, 300.0);
t.rows[0].cells[0].blocks = paras;
d.body = vec![wordcraft_doc::Block::Table(t).into()];
} else {
d.body = paras;
}
let at = |i: u32| if in_cell { Pos { story: StoryRef::Body, path: Path(vec![0, 0, 0, i]), off: 0 } } else { Pos::body(i as usize, 0) };
let l = lay(&d);
[0, 1, 2, 3, 4].map(|i| l.caret(&at(i)).unwrap().top)
};
let item = |num: u32, level: u8, p: &ParaProps| ParaProps { numbering: Some(NumRef { num, level }), ..p.clone() };
for in_cell in [false, true] {
let base = tops([plain.clone(), plain.clone(), plain.clone()], in_cell);
let line = base[1] - base[0];
let gaps = |t: [f32; 5]| [1, 2, 3, 4].map(|i| ((t[i] - t[i - 1] - line) * 10.0).round() / 10.0);
let one = item(1, 0, &auto);
let cases = [
("one list", [one.clone(), one.clone(), one.clone()], [14.0, 0.0, 0.0, 14.0]),
("two lists", [one.clone(), item(2, 0, &auto), item(2, 0, &auto)], [14.0, 0.0, 0.0, 14.0]),
("two levels", [one.clone(), item(1, 1, &auto), one.clone()], [14.0, 0.0, 0.0, 14.0]),
("a plain item between", [one.clone(), item(1, 0, &plain), one.clone()], [14.0, 0.0, 0.0, 14.0]),
("list off between", [one.clone(), item(0, 0, &auto), one.clone()], [14.0, 14.0, 14.0, 14.0]),
("no list", [auto.clone(), auto.clone(), auto.clone()], [14.0, 14.0, 14.0, 14.0]),
];
for (what, items, want) in cases {
assert_eq!(gaps(tops(items, in_cell)), want, "{what} (in a cell: {in_cell})");
}
let fourteen = ParaProps { space_before: Some(14.0), ..plain.clone() };
assert_eq!(
gaps(tops([item(1, 0, &fourteen), item(1, 0, &fourteen), item(1, 0, &fourteen)], in_cell)),
[14.0, 14.0, 14.0, 0.0],
"measured spacing stays"
);
}
}
/// Vietnamese is written in single syllables: automatic hyphenation leaves its words whole. (The
/// English patterns happen not to split these accented words today; the Vietnamese guard in
/// `hyphenation_points` keeps it so whatever the patterns become.)
#[test]
fn automatic_hyphenation_leaves_vietnamese_whole() {
crate::test_fonts();
let text =
"Những người khuyến khích chuyện trường thường nghiêng nghiêng nhưng thành phố Nguyễn Trường Thượng xuyên suốt chương trình. ".repeat(8);
let mut d = Document::from_text(&text);
d.settings.auto_hyphenation = true;
let hyphens: usize = lay(&d).pages[0]
.items
.iter()
.filter_map(|i| if let Placed::Lines { para, .. } = i { Some(para.lines.iter().filter(|x| x.hyphen.is_some()).count()) } else { None })
.sum();
assert_eq!(hyphens, 0);
}
/// #1252: highlight and character-shading fills are marked as text backgrounds (a dark page dims
/// them), and so is the text drawn on them; a paragraph's shading is an ordinary fill.
#[test]
fn highlight_fill_is_marked_as_a_text_background() {
crate::test_fonts();
use wordcraft_doc::props::Highlight;
let cp = wordcraft_doc::CharProps { highlight: Some(Highlight::Yellow), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::with_text("Marked", cp);
p.props.shading = Some(wordcraft_doc::Rgb(0xDD, 0xEE, 0xFF));
let plain = wordcraft_doc::Paragraph::with_text("Plain", Default::default());
let mut d = Document::from_text("x");
d.body = vec![wordcraft_doc::para_block(p), wordcraft_doc::para_block(plain)];
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let fills: Vec<(wordcraft_doc::Rgb, bool)> =
items.iter().filter_map(|i| if let display::Draw::Fill { color, text_bg, .. } = i { Some((*color, *text_bg)) } else { None }).collect();
assert!(fills.contains(&(wordcraft_doc::Rgb(255, 255, 0), true)), "highlight is a text background: {fills:?}");
assert!(fills.contains(&(wordcraft_doc::Rgb(0xDD, 0xEE, 0xFF), false)), "paragraph shading is not: {fills:?}");
let yellow = Some(wordcraft_doc::Rgb(255, 255, 0));
let glyphs: Vec<(String, Option<wordcraft_doc::Rgb>)> = items
.iter()
.filter_map(|i| if let display::Draw::Glyphs { text, text_bg, .. } = i { Some((text.clone(), *text_bg)) } else { None })
.collect();
assert!(glyphs.iter().any(|(t, bg)| t.contains("Marked") && *bg == yellow), "{glyphs:?}");
assert!(glyphs.iter().any(|(t, bg)| t.contains("Plain") && bg.is_none()), "{glyphs:?}");
}
/// #1252 review: an underline and strikethrough on a highlighted run carry the highlight, like
/// its glyphs; other lines (here a paragraph border) don't.
#[test]
fn underline_on_a_highlight_carries_the_text_background() {
crate::test_fonts();
use wordcraft_doc::props::{Highlight, Underline};
let cp =
wordcraft_doc::CharProps { highlight: Some(Highlight::Teal), underline: Some(Underline::Single), strike: Some(true), ..Default::default() };
let mut d = Document::from_text("x");
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Marked", cp))];
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let lines: Vec<Option<wordcraft_doc::Rgb>> =
items.iter().filter_map(|i| if let display::Draw::Line { text_bg, .. } = i { Some(*text_bg) } else { None }).collect();
assert_eq!(lines, vec![Some(wordcraft_doc::Rgb(0, 128, 128)); 2], "underline and strikethrough");
}
/// #1352 helpers: a body paragraph with a PAGE field after each piece of `pieces` (a piece may
/// hold a page break), after `before` paragraphs that each start a new page.
fn page_field_doc(before: usize, pieces: &[&str]) -> Document {
let mut d = Document::new();
let mut body = Vec::new();
for i in 0..before {
let mut q = wordcraft_doc::Paragraph::with_text(&format!("Filler {i}"), Default::default());
q.props.page_break_before = Some(i > 0);
body.push(wordcraft_doc::para_block(q));
}
let mut p = wordcraft_doc::Paragraph::new();
for piece in pieces {
let n = p.len();
p.insert_text(n, piece, &Default::default()).unwrap();
let n = p.len();
p.insert_object(
n,
InlineObject::Field { instr: "PAGE".into(), result: String::new(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
}
p.props.page_break_before = Some(before > 0);
body.push(wordcraft_doc::para_block(p));
d.body = body;
d
}
/// #1352: the field results drawn on each page (only the lines placed there), and the text
/// ranges of body paragraph `block` placed on each page, in order.
fn shown_and_ranges(l: &DocLayout, block: u32) -> (Vec<Vec<String>>, Vec<std::ops::Range<usize>>) {
let mut shown = Vec::new();
let mut ranges = Vec::new();
for page in &l.pages {
let mut on = Vec::new();
for it in &page.items {
let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, .. } = it else { continue };
if path.0 != [block] {
continue;
}
let (Some(f), Some(e)) = (para.lines.get(*l0), l1.checked_sub(1).and_then(|k| para.lines.get(k))) else { continue };
on.extend(para.shown.iter().filter(|s| s.0 >= f.c0 && s.0 < e.c1).map(|s| s.1.clone()));
ranges.push(f.start..e.stop);
}
shown.push(on);
}
(shown, ranges)
}
/// The placed pieces of a paragraph cover its text once, in order.
fn assert_contiguous(ranges: &[std::ops::Range<usize>], len: usize) {
let mut at = 0;
for r in ranges {
assert_eq!(r.start, at, "piece {r:?} doesn't follow on from {at}: {ranges:?}");
at = r.end;
}
assert_eq!(at, len, "the text up to {len} is placed: {ranges:?}");
}
/// #1352: a PAGE field after a page break inside its paragraph shows the page it is on.
#[test]
fn page_field_after_intra_paragraph_break_shows_its_page() {
crate::test_fonts();
let brk = wordcraft_doc::para::PAGE_BREAK;
let d = page_field_doc(0, &["A", &format!("{brk}B")]);
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
let (shown, _) = shown_and_ranges(&l, 0);
assert_eq!(shown, [vec!["1".to_string()], vec!["2".to_string()]]);
}
/// #1352: a paragraph running over onto the next page shows that page's number in its tail.
#[test]
fn page_field_in_a_split_paragraph_tail_shows_its_page() {
crate::test_fonts();
let long = "words that fill the page ".repeat(400);
let d = page_field_doc(0, &["Head", &long]);
let l = lay(&d);
assert!(l.pages.len() >= 2, "{} pages", l.pages.len());
let (shown, ranges) = shown_and_ranges(&l, 0);
assert_eq!(shown.first().unwrap(), &["1"]);
let last = l.pages.len().to_string();
assert_eq!(shown.last().unwrap(), &[last]);
assert_contiguous(&ranges, d.para(StoryRef::Body, &Path::top(0)).map(|p| p.len()).unwrap_or(0));
}
/// #1352: from page 9 to page 10 every field gets a digit wider; the lines on page 10 are broken
/// again for the wider results, and the paragraph's text is still placed exactly once.
#[test]
fn page_fields_from_page_nine_to_ten_rebreak_the_rest() {
crate::test_fonts();
let pieces: Vec<String> = (0..900).map(|i| format!(" word{i}")).collect();
let pieces: Vec<&str> = pieces.iter().map(String::as_str).collect();
let d = page_field_doc(8, &pieces);
let l = lay(&d);
assert!(l.pages.len() >= 10, "{} pages", l.pages.len());
let (shown, ranges) = shown_and_ranges(&l, 8);
let nine = shown.get(8).unwrap();
let ten = shown.get(9).unwrap();
assert!(!nine.is_empty() && nine.iter().all(|s| s == "9"), "page 9: {nine:?}");
assert!(!ten.is_empty() && ten.iter().all(|s| s == "10"), "page 10: {ten:?}");
assert_eq!(shown.iter().map(Vec::len).sum::<usize>(), 900, "every field drawn once");
assert_contiguous(&ranges, d.para(StoryRef::Body, &Path::top(8)).map(|p| p.len()).unwrap_or(0));
// No line overflows its column with the wider results: each ends with the space after a field
// (which may hang), so the field before it ends within the line's right edge.
for (pi, page) in l.pages.iter().enumerate() {
for it in &page.items {
let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, .. } = it else { continue };
if path.0 != [8] {
continue;
}
for line in para.lines.get(*l0..*l1).unwrap_or(&[]) {
let ink = line.xs.len().checked_sub(2).and_then(|k| line.xs.get(k)).copied().unwrap_or(0.0);
assert!(ink <= line.right + 0.5, "page {}: a line runs to {ink} past its right edge {}", pi + 1, line.right);
}
}
}
}
/// #1352: a footnote's PAGE field, referenced from the part of a paragraph on its second page,
/// shows the page the footnote is on (the paragraph's own page map doesn't leak into it).
#[test]
fn footnote_page_field_from_a_split_paragraph_shows_its_page() {
crate::test_fonts();
let long = "words that fill the page ".repeat(200);
let mut d = page_field_doc(0, &["Head", &long, "Tail"]);
let end = d.end_of(StoryRef::Body);
// A custom mark, so the note marks aren't mistaken for page numbers.
let id = d.add_part(
wordcraft_doc::PartKind::Footnote,
vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Note on page ", Default::default()))],
);
d.insert_object(&end, InlineObject::NoteRef { kind: wordcraft_doc::para::NoteKind::Footnote, id, custom: "*".into() }, &Default::default())
.unwrap();
let note = d.para_mut(StoryRef::Part(id), &Path::top(0)).unwrap();
let n = note.len();
note.insert_object(
n,
InlineObject::Field { instr: "PAGE".into(), result: String::new(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
let l = lay(&d);
assert_eq!(l.pages.len(), 2, "the paragraph runs onto a second page");
// The PAGE results drawn in `story`, by page (not the "*" note marks).
let fields_in = |story: StoryRef| -> Vec<(usize, String)> {
let mut out = Vec::new();
for (pi, page) in l.pages.iter().enumerate() {
for it in page.items.iter().chain(page.footer.iter()) {
let Placed::Lines { story: s, para, l0, l1, .. } = it else { continue };
let (Some(f), Some(e)) = (para.lines.get(*l0), l1.checked_sub(1).and_then(|k| para.lines.get(k))) else { continue };
if *s != story {
continue;
}
out.extend(para.shown.iter().filter(|x| x.0 >= f.c0 && x.0 < e.c1 && x.1 != "*").map(|x| (pi, x.1.clone())));
}
}
out
};
let body = fields_in(StoryRef::Body);
assert_eq!(body.first(), Some(&(0, "1".to_string())), "{body:?}");
assert!(body.iter().all(|(pi, t)| *t == (pi + 1).to_string()), "{body:?}");
assert_eq!(body.last().map(|x| x.0), Some(1), "{body:?}");
let in_note = fields_in(StoryRef::Part(id));
assert_eq!(in_note, [(1, "2".to_string())], "the note is on page 2 and says so");
}
/// The automatic equation numbers drawn in each body paragraph (from the layout of its last
/// piece, the one its last lines are drawn with), in order.
fn equation_numbers(l: &DocLayout) -> Vec<String> {
let mut last: Vec<(u32, Arc<ParaLayout>)> = Vec::new();
for it in l.pages.iter().flat_map(|p| p.items.iter()) {
if let Placed::Lines { story: StoryRef::Body, path, para, .. } = it
&& let [b] = path.0[..]
{
match last.iter_mut().find(|e| e.0 == b) {
Some(e) => e.1 = para.clone(),
None => last.push((b, para.clone())),
}
}
}
last.sort_by_key(|e| e.0);
let mut out = Vec::new();
for (_, pl) in last {
for (_, m) in &pl.maths {
let all: String =
m.items.iter().filter_map(|it| if let crate::math::MItem::Glyphs { text, .. } = it { Some(text.as_str()) } else { None }).collect();
if let Some(at) = all.rfind('(') {
out.push(all[at..].to_string());
}
}
}
out
}
/// The box around an equation spans the equation's width and its whole line, as Word frames
/// the equation the caret is in.
#[test]
fn an_equations_box_spans_its_width_and_its_line() {
let mut d = Document::from_text("Inline and text after it.");
let math = wordcraft_doc::math::Math { nodes: wordcraft_doc::math::parse_linear("x=(a+b)/c"), ..Default::default() };
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.insert_object(7, InlineObject::Equation { linear: "x=(a+b)/c".into(), display: false, math }, &Default::default()).unwrap();
let l = lay(&d);
let b = l.equation_box(&Pos::body(0, 7), 0).unwrap();
let before = l.caret(&Pos::body(0, 6)).unwrap();
// The equation's U+FFFC takes three bytes.
let after = l.caret(&Pos::body(0, 10)).unwrap();
// It starts where the equation starts and ends where the text after it starts.
assert!((b.x - before.x).abs() > 0.1 && (b.x + b.math.width - after.x).abs() < 0.5, "{b:?} {before:?} {after:?}");
// It holds the fraction, from the line's top to its bottom.
assert!(b.top <= b.base - b.math.ascent && b.bottom >= b.base + b.math.descent, "{b:?}");
assert!((b.top - after.top).abs() < 0.5 && b.bottom >= after.top + after.height, "{b:?} {after:?}");
assert!(l.equation_box(&Pos::body(0, 6), 0).is_none());
}
/// Laying a paragraph out again (placed again after a page break before, or the rest of it again
/// for a later page's PAGE fields) doesn't count its numbered equations twice: they read (1), (2), (3).
#[test]
fn relaid_paragraphs_keep_their_equation_numbers() {
crate::test_fonts();
let eq = |s: &str| InlineObject::Equation {
linear: s.into(),
display: true,
math: wordcraft_doc::math::Math { nodes: wordcraft_doc::math::parse_linear(s), ..Default::default() },
};
let mut d = Document::from_text("Before\n\nTail");
// Paragraph 1: a numbered equation on a new page (laid out again there).
let p1 = d.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
p1.insert_object(0, eq("a=b#"), &Default::default()).unwrap();
p1.props.page_break_before = Some(true);
// Paragraph 2: long, with a PAGE field, running onto the next page (the rest laid out again
// there), then a numbered equation.
let p2 = d.para_mut(StoryRef::Body, &Path::top(2)).unwrap();
let long = "words that fill the page ".repeat(400);
p2.insert_text(0, &long, &Default::default()).unwrap();
let n = p2.len();
p2.insert_object(
n,
InlineObject::Field { instr: "PAGE".into(), result: String::new(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
let n = p2.len();
p2.insert_object(n, eq("c=d#"), &Default::default()).unwrap();
// Paragraph 3: one more.
d.body.push(wordcraft_doc::para_block(wordcraft_doc::Paragraph::new()));
let p3 = d.para_mut(StoryRef::Body, &Path::top(3)).unwrap();
p3.insert_object(0, eq("e=f#"), &Default::default()).unwrap();
let l = lay(&d);
assert!(l.pages.len() >= 3, "{} pages", l.pages.len());
assert_eq!(equation_numbers(&l), ["(1)", "(2)", "(3)"]);
}
/// #1116: a document of a top paragraph with `before` points of space before, filler lines, a
/// paragraph of several lines (block `t`) with 6 pt after and, when `note`, a footnote on its last line.
fn space_after_doc(before: f32, note: bool) -> (Document, usize, Option<u32>) {
let text = format!("Top.\n{}{}\nAfter.", "Body text line.\n".repeat(14), "Words in a paragraph that wraps. ".repeat(14));
let mut d = Document::from_text(&text);
let t = 15;
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.props.space_before = Some(before);
}
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(t).map(std::sync::Arc::make_mut) {
p.props.space_after = Some(6.0);
p.props.widow_control = Some(true);
}
let len = d.para(StoryRef::Body, &Path(vec![t as u32])).map(|p| p.text.len()).unwrap();
let id = note.then(|| footnote(&mut d, &Pos::body(t, len), "The note."));
(d, t, id)
}
/// The pieces of body paragraph `t` as (page, l0, l1, bottom), and its line count.
fn para_pieces(l: &DocLayout, t: usize) -> (Vec<(usize, usize, usize, f32)>, usize) {
let mut v = Vec::new();
let mut n = 0;
for (pi, p) in l.pages.iter().enumerate() {
for it in &p.items {
if let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, y, .. } = it
&& path.0 == [t as u32]
{
n = para.lines.len();
v.push((pi, *l0, *l1, item_bottom(*y, para, *l0, *l1).unwrap()));
}
}
}
(v, n)
}
#[test]
fn space_after_stays_clear_of_the_footnote_separator() {
crate::test_fonts();
// #1116, measured in Word: on a page with footnotes a paragraph ending there keeps its space
// after above the separator, or its last lines (two, with widow control) go to the next page
// with the note.
let mut moved = 0;
for before in 0..=300 {
let (d, t, id) = space_after_doc(before as f32, true);
let l = lay(&d);
let (pieces, n) = para_pieces(&l, t);
assert!(n >= 4, "a paragraph of several lines: {n}");
let &(page, _, l1, bottom) = pieces.last().unwrap();
assert_eq!(l1, n);
let note = note_pieces(&l, id.unwrap());
assert_eq!(note.first().map(|p| p.0), Some(page), "before {before}: the note is on its reference's page");
// The separator's area (default separator: NOTE_SEP high, its rule half way down) sits
// right above the note.
let sep_top = note[0].3 - NOTE_SEP;
assert!(sep_top - bottom >= 6.0 - 0.01, "before {before}: last line ends at {bottom}, the separator starts at {sep_top}");
if pieces.len() > 1 {
assert_eq!(pieces.len(), 2, "{pieces:?}");
assert!(pieces[0].2 - pieces[0].1 >= 2 && pieces[1].2 - pieces[1].1 >= 2, "widow/orphan control: {pieces:?}");
moved += 1;
}
}
assert!(moved > 0, "the sweep crosses the page bottom");
}
#[test]
fn space_after_may_overflow_the_bottom_margin_without_notes() {
crate::test_fonts();
// Without footnotes nothing changes: the last line only has to fit, its space after may run
// past the bottom margin (Word). "Fit" means its text: the leading multiple spacing adds below
// the text (this paragraph's 1.15) may run past the margin too (observed in Word at 1.15, 1.5
// and double spacing; see `a_page_ends_when_a_multiple_spaced_lines_text_no_longer_fits`).
let mut tight = 0;
for before in 0..=300 {
let (d, t, _) = space_after_doc(before as f32, false);
let l = lay(&d);
let bottom_margin = d.last_section.page_h - d.last_section.margin_bottom;
let (pieces, _) = para_pieces(&l, t);
let &(page, _, l1, bottom) = pieces.last().unwrap();
let leading = l.pages[page]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { story: StoryRef::Body, path, para, .. } if path.0 == [t as u32] => {
para.lines.get(l1 - 1).map(|ln| ln.height - (ln.baseline - ln.top + ln.text_desc))
}
_ => None,
})
.unwrap()
.max(0.0);
let bottom = bottom - leading;
assert!(bottom <= bottom_margin + 0.01, "before {before}: the last line's text ends at {bottom}");
if bottom > bottom_margin - 6.0 {
tight += 1;
}
}
assert!(tight > 0, "some step leaves less than the space after below the last line");
}
/// #1116: the sweep of `space_after_stays_clear_of_the_footnote_separator` with paragraphs `t`
/// and `t + 1` changed by `tweak`: the last line of `t` stays `need` points clear of the separator.
fn space_after_clear_with(tweak: impl Fn(&mut Document, usize), need: f32) {
for before in 0..=300 {
let (mut d, t, id) = space_after_doc(before as f32, true);
tweak(&mut d, t);
let l = lay(&d);
let (pieces, _) = para_pieces(&l, t);
let &(page, _, _, bottom) = pieces.last().unwrap();
let note = note_pieces(&l, id.unwrap());
assert_eq!(note.first().map(|p| p.0), Some(page), "before {before}: the note is on its reference's page");
let sep_top = note[0].3 - NOTE_SEP;
assert!(sep_top - bottom >= need - 0.01, "before {before}: last line ends at {bottom}, the separator starts at {sep_top}");
}
}
fn para_props(d: &mut Document, i: usize) -> &mut ParaProps {
match d.body.get_mut(i).map(std::sync::Arc::make_mut) {
Some(wordcraft_doc::Block::Para(p)) => &mut p.props,
_ => panic!("no paragraph {i}"),
}
}
#[test]
fn space_after_stays_clear_when_only_the_next_paragraph_has_contextual_spacing() {
crate::test_fonts();
// Contextual spacing on the next paragraph alone drops its space before, not this one's space
// after (as the spacing between them): the space after still stays clear of the separator.
space_after_clear_with(|d, t| para_props(d, t + 1).contextual_spacing = Some(true), 6.0);
}
#[test]
fn space_after_stays_clear_before_a_numbered_paragraph_without_a_label() {
crate::test_fonts();
// Automatic spacing drops only between two list items with labels: before a paragraph whose
// list doesn't exist (no label) a list item's automatic space after stays clear.
use wordcraft_doc::props::NumRef;
space_after_clear_with(
|d, t| {
let num = Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
let p = para_props(d, t);
p.numbering = Some(NumRef { num, level: 0 });
p.space_after_auto = Some(true);
para_props(d, t + 1).numbering = Some(NumRef { num: 9999, level: 0 });
},
wordcraft_doc::resolve::AUTO_SPACING,
);
}
/// #1500: how shape fills paint a frame: linear gradients across it at their angle, path
/// gradients out from their focus to the farthest corner, transparency as opacity.
#[test]
fn shape_fills_paint_their_frame() {
use display::{Paint, paint_for};
use std::sync::Arc;
use wordcraft_doc::fill::{Gradient, GradientFlip, GradientKind, PathShape};
use wordcraft_doc::wordart::GradStop;
let frame = Rect::new(10.0, 20.0, 100.0, 50.0);
let stops = vec![GradStop { pos: 0.0, color: Rgb::BLACK, transparency: 0.0 }, GradStop { pos: 100.0, color: Rgb::WHITE, transparency: 40.0 }];
let grad = |kind| Fill::Gradient(Arc::new(Gradient { stops: stops.clone(), kind, tile: None, rot_with_shape: true, flip: GradientFlip::None }));
let ends = |p: Option<Paint>| match p {
Some(Paint::Linear { p0, p1, stops }) => {
assert_eq!(stops, [(0.0, Rgb::BLACK, 1.0), (1.0, Rgb::WHITE, 0.6)]);
[p0.0, p0.1, p1.0, p1.1].map(|v| (v * 100.0).round() / 100.0)
}
o => panic!("{o:?}"),
};
// 0°: left to right; 90°: top to bottom.
assert_eq!(ends(paint_for(&grad(GradientKind::Linear { angle: 0.0, scaled: false }), frame)), [10.0, 45.0, 110.0, 45.0]);
assert_eq!(ends(paint_for(&grad(GradientKind::Linear { angle: 90.0, scaled: false }), frame)), [60.0, 20.0, 60.0, 70.0]);
// Scaled 45°: corner to corner of the frame's diagonal direction across the stretched square.
let [x0, y0, x1, y1] = ends(paint_for(&grad(GradientKind::Linear { angle: 45.0, scaled: true }), frame));
assert!(x0 < 60.0 && y0 < 45.0 && x1 > 60.0 && y1 > 45.0 && (x1 - x0) < (y1 - y0) * 2.0 + 1.0, "{x0} {y0} {x1} {y1}");
// A circle from the centre reaches the corners.
match paint_for(&grad(GradientKind::Path { shape: PathShape::Circle, focus: [50.0; 4] }), frame) {
Some(Paint::Radial { c, r, .. }) => assert_eq!((c, (r * 100.0).round()), ((60.0, 45.0), (50f32.hypot(25.0) * 100.0).round())),
o => panic!("{o:?}"),
}
// From the top-left corner (a rectangular path, drawn circular).
match paint_for(&grad(GradientKind::Path { shape: PathShape::Rect, focus: [0.0, 0.0, 100.0, 100.0] }), frame) {
Some(Paint::Radial { c, .. }) => assert_eq!(c, (10.0, 20.0)),
o => panic!("{o:?}"),
}
assert_eq!(paint_for(&Fill::Solid { color: Rgb::WHITE, transparency: 70.0 }, frame), Some(Paint::Solid(Rgb::WHITE, 1.0 - 0.7)));
// The colour at a point (what the caret contrasts with): ends padded, the middle blended.
let down = paint_for(&grad(GradientKind::Linear { angle: 90.0, scaled: false }), frame).unwrap();
assert_eq!(down.at(60.0, 0.0), (Rgb::BLACK, 1.0));
assert_eq!(down.at(60.0, 999.0), (Rgb::WHITE, 0.6));
let (c, a) = down.at(60.0, 45.0);
assert!((c.0 as i32 - 128).abs() <= 1 && (a - 0.8).abs() < 1e-3, "{c:?} {a}");
}
#[test]
fn cell_widths_override_grid() {
crate::test_fonts();
for fixed in [false, true] {
let mut t = Table::new(2, 3, 450.0);
t.props.fixed = fixed;
t.grid = vec![40.0, 175.0, 235.0];
for row in &mut t.rows {
for (cell, width) in row.cells.iter_mut().zip([50.0, 60.0, 340.0]) {
cell.props.width = Some(width);
cell.blocks = vec![wordcraft_doc::para_block(Paragraph::with_text("A", Default::default()))];
}
}
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let [(x0, _, _)] = para_at(&l, &[0, 0, 0, 0])[..] else { panic!("cell missing") };
let [(x1, _, _)] = para_at(&l, &[0, 0, 1, 0])[..] else { panic!("cell missing") };
let [(x2, _, _)] = para_at(&l, &[0, 0, 2, 0])[..] else { panic!("cell missing") };
assert!((x1 - x0 - 50.0).abs() < 0.01);
assert!((x2 - x0 - 110.0).abs() < 0.01);
}
}
#[test]
fn percentage_cell_widths_that_disagree_or_span_columns() {
// Measured in Word (A4, 451.3 pt between the margins; 468 pt here), autofit tables 100% wide:
// rows asking 30/10/10/30 and 10/30/10/30, in either order, give 30/30/10/30 (each column its
// largest); a merged cell asking 50% over the first two columns, beside 10% and 40%, gives
// those two 50% between them; a merged 20% over columns asking 40% and 10% changes nothing;
// and a nested table's percentages are of its own width.
let cell_text = |s: &str| vec![wordcraft_doc::para_block(Paragraph::with_text(s, Default::default()))];
let table = |rows: &[&[(Option<f32>, u32)]]| {
let mut t = Table::new(rows.len(), 4, 460.3);
t.grid = vec![107.3, 37.2, 31.95, 283.85];
t.props.width_pct = Some(100.0);
for (row, spec) in t.rows.iter_mut().zip(rows) {
row.cells.truncate(spec.len());
for (cell, (pct, span)) in row.cells.iter_mut().zip(spec.iter()) {
cell.props.width = None;
cell.props.width_pct = *pct;
cell.props.span = *span;
cell.blocks = cell_text("A");
}
}
t
};
let starts_at = |t: Table, prefix: &[u32], row: u32| {
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let x: Vec<f32> = (0..4)
.map(|c| {
let path: Vec<u32> = prefix.iter().copied().chain([row, c, 0]).collect();
let [(x, _, _)] = para_at(&l, &path)[..] else { panic!("cell {c} missing") };
x
})
.collect();
x.iter().map(|v| v - x[0]).collect::<Vec<_>>()
};
let near = |got: Vec<f32>, want: [f32; 4], what: &str| {
assert!(got.iter().zip(want).all(|(g, w)| (g - w).abs() < 0.01), "{what}: columns start at {got:?}, not {want:?}");
};
let at = |shares: [f32; 3]| [0.0, shares[0] * 468.0, shares[1] * 468.0, shares[2] * 468.0];
let p = |v: f32| (Some(v), 1);
let auto = (None, 1);
let open = [auto, auto, auto, auto];
near(
starts_at(table(&[&[p(30.0), p(10.0), p(10.0), p(30.0)], &[p(10.0), p(30.0), p(10.0), p(30.0)], &open]), &[0], 2),
at([0.3, 0.6, 0.7]),
"rows disagree",
);
near(
starts_at(table(&[&[p(10.0), p(30.0), p(10.0), p(30.0)], &[p(30.0), p(10.0), p(10.0), p(30.0)], &open]), &[0], 2),
at([0.3, 0.6, 0.7]),
"the other order",
);
let merged = starts_at(table(&[&[(Some(50.0), 2), p(10.0), p(40.0)], &open]), &[0], 1);
near(vec![merged[0], merged[2], merged[3]].into_iter().chain([0.0]).collect(), [0.0, 0.5 * 468.0, 0.6 * 468.0, 0.0], "merged 50%");
near(
starts_at(table(&[&[p(40.0), p(10.0), p(10.0), p(40.0)], &[(Some(20.0), 2), auto, auto], &open]), &[0], 2),
at([0.4, 0.5, 0.6]),
"a smaller merged cell",
);
// The nested table fills the outer table's only cell, less the cell's margins.
let inner = table(&[&[p(40.0), p(10.0), p(10.0), p(40.0)], &open]);
let mut outer = Table::new(1, 1, 468.0);
outer.props.width_pct = Some(100.0);
outer.rows[0].cells[0].props.width_pct = Some(100.0);
outer.rows[0].cells[0].blocks = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(inner)), wordcraft_doc::para_block(Paragraph::new())];
let nested = starts_at(outer, &[0, 0, 0, 0], 1);
let w = nested[3] / 0.6;
near(nested, [0.0, 0.4 * w, 0.5 * w, 0.6 * w], "nested");
assert!(w > 400.0 && w <= 468.0, "the nested table is {w} wide");
}
#[test]
fn percentage_cell_widths_size_the_columns_whichever_rows_ask() {
// Measured in Word (A4, 451.3 pt between the margins; 468 pt here): a 40/10/10/40 header row
// over rows without cell widths lays out 40/10/10/40 of the table, from the grid
// 107.3/37.2/32/283.9 pt a document saved. The same with the row in the middle, in a fixed
// table, with the table 100% wide or without a width; 144 pt for 40% of a 360 pt table; and
// 20/5/5/20 scaled up to fill the table.
let starts = |t: Table| {
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let x: Vec<f32> = (0..4)
.map(|c| {
let [(x, _, _)] = para_at(&l, &[0, 2, c, 0])[..] else { panic!("cell {c} missing") };
x
})
.collect();
x.iter().map(|v| v - x[0]).collect::<Vec<_>>()
};
let table = |pct_row: usize, pcts: [f32; 4]| {
let mut t = Table::new(4, 4, 460.3);
t.grid = vec![107.3, 37.2, 31.95, 283.85];
for (r, row) in t.rows.iter_mut().enumerate() {
for (cell, p) in row.cells.iter_mut().zip(pcts) {
cell.props.width = None;
cell.props.width_pct = (r == pct_row).then_some(p);
cell.blocks = vec![wordcraft_doc::para_block(Paragraph::with_text("A", Default::default()))];
}
}
t
};
let near = |got: Vec<f32>, want: [f32; 4]| {
assert!(got.iter().zip(want).all(|(g, w)| (g - w).abs() < 0.01), "columns start at {got:?}, not {want:?}");
};
let of = |w: f32| [0.0, w * 0.4, w * 0.5, w * 0.6];
near(starts(table(0, [40.0, 10.0, 10.0, 40.0])), of(468.0));
near(starts(table(1, [40.0, 10.0, 10.0, 40.0])), of(468.0));
near(starts(table(0, [20.0, 5.0, 5.0, 20.0])), of(468.0));
// A fixed table without a width of its own keeps its grid's 460.3 pt; 100% wide, it takes
// the text width.
let mut fixed = table(0, [40.0, 10.0, 10.0, 40.0]);
fixed.props.fixed = true;
near(starts(fixed.clone()), of(460.3));
fixed.props.width_pct = Some(100.0);
near(starts(fixed), of(468.0));
let mut full = table(0, [40.0, 10.0, 10.0, 40.0]);
full.props.width_pct = Some(100.0);
near(starts(full), of(468.0));
let mut narrow = table(0, [20.0, 5.0, 5.0, 20.0]);
narrow.props.width = Some(360.0);
near(starts(narrow), of(360.0));
// A row that starts one column in gives its percentages to the columns it covers: 10/10/40
// there agree with the header row's 10/10/40 over the last three columns.
let mut shifted = table(0, [40.0, 10.0, 10.0, 40.0]);
shifted.rows[1].props.grid_before = 1;
shifted.rows[1].cells.remove(0);
for (cell, p) in shifted.rows[1].cells.iter_mut().zip([10.0, 10.0, 40.0]) {
cell.props.width_pct = Some(p);
}
near(starts(shifted), of(468.0));
// Past 100% Word gives every column but the last its share of the table and the last what
// is left: 44/11/11/44 starts the columns at 44%, 55% and 66%. At 60/20/20/60 nothing is left,
// so the last column takes its longest word and the other three give up the same width.
near(starts(table(0, [44.0, 11.0, 11.0, 44.0])), [0.0, 0.44, 0.55, 0.66].map(|f| f * 468.0));
let over = starts(table(0, [60.0, 20.0, 20.0, 60.0]));
let lost = [0.6 * 468.0 - over[1], 0.2 * 468.0 - (over[2] - over[1]), 0.2 * 468.0 - (over[3] - over[2])];
assert!(lost[0] > 1.0 && lost.iter().all(|l| (l - lost[0]).abs() < 0.01), "columns start at {over:?}");
// A fixed table gives the last column 2 pt and clips its text to the cell instead; the
// others share the rest of its 460.3 pt (Word: 275.5, 91.5, 91 and 2 pt).
let mut fixed_over = table(0, [60.0, 20.0, 20.0, 60.0]);
fixed_over.props.fixed = true;
for row in &mut fixed_over.rows {
row.cells[3].blocks = vec![wordcraft_doc::para_block(Paragraph::with_text("Lorem ipsum", Default::default()))];
}
near(starts(fixed_over.clone()), [0.0, 0.6, 0.8, 1.0].map(|f| f * (460.3 - 2.0)));
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(fixed_over)).unwrap();
let l = lay(&d);
let cells: Vec<(usize, f32, bool)> = l.pages[0]
.items
.iter()
.filter_map(|i| if let Placed::Cell { cell, rect, clip, row: 0, .. } = i { Some((*cell, rect.w, *clip)) } else { None })
.collect();
assert!(cells.iter().any(|&(c, w, clip)| c == 3 && (w - 2.0).abs() < 0.01 && clip), "the last cell is 2 pt and clipped: {cells:?}");
assert!(cells.iter().all(|&(c, _, clip)| c == 3 || !clip), "only the last cell is clipped: {cells:?}");
// When the columns before the last already pass 100% (80/40/40/20), Word gives them their
// shares left to right until the width runs out, and the table keeps its width: in a fixed
// table the third and fourth columns get 2 pt, the shares being of 460.3 - 4 pt; in an
// autofit table they get their longest words, the first two giving up the same width.
let widths = |t: Table| {
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let mut w: Vec<(usize, f32)> = l.pages[0]
.items
.iter()
.filter_map(|i| if let Placed::Cell { cell, rect, row: 0, .. } = i { Some((*cell, rect.w)) } else { None })
.collect();
w.sort_by_key(|c| c.0);
w.into_iter().map(|c| c.1).collect::<Vec<f32>>()
};
let mut fixed_far = table(0, [80.0, 40.0, 40.0, 20.0]);
fixed_far.props.fixed = true;
let got = widths(fixed_far);
let room = 460.3 - 4.0;
let want = [0.8 * room, 0.2 * room, 2.0, 2.0];
assert!(got.iter().zip(want).all(|(g, w)| (g - w).abs() < 0.01), "fixed 80/40/40/20: {got:?}, not {want:?}");
assert!((got.iter().sum::<f32>() - 460.3).abs() < 0.01, "fixed 80/40/40/20 is {} wide", got.iter().sum::<f32>());
// A fixed grid narrower than 2 pt a column keeps its width: the columns share it.
let mut fixed_narrow = table(0, [80.0, 40.0, 40.0, 20.0]);
fixed_narrow.props.fixed = true;
fixed_narrow.grid = vec![1.5; 4];
let got = widths(fixed_narrow);
assert!(got.iter().all(|w| (w - 1.5).abs() < 0.01), "a fixed 6 pt grid of 80/40/40/20: {got:?}");
let got = widths(table(0, [80.0, 40.0, 40.0, 20.0]));
assert!((got.iter().sum::<f32>() - 468.0).abs() < 0.01, "autofit 80/40/40/20 is {} wide: {got:?}", got.iter().sum::<f32>());
let lost = [0.8 * 468.0 - got[0], 0.2 * 468.0 - got[1]];
assert!(lost[0] > 1.0 && (lost[0] - lost[1]).abs() < 0.01 && got[2] > 1.0 && got[3] > 1.0, "autofit 80/40/40/20: {got:?}");
// A smaller percentage in another row of a column changes nothing: the column takes its
// largest. A merged cell's 20% goes to the two columns under it, which ask none.
let mut disagreeing = table(0, [40.0, 10.0, 10.0, 40.0]);
disagreeing.rows[1].cells[0].props.width_pct = Some(10.0);
near(starts(disagreeing), of(468.0));
let mut spanned = table(0, [40.0, 10.0, 10.0, 40.0]);
spanned.rows[0].cells.remove(2);
spanned.rows[0].cells[1].props.span = 2;
spanned.rows[0].cells[1].props.width_pct = Some(20.0);
let got = starts(spanned);
assert!((got[1] - 0.4 * 468.0).abs() < 0.01 && (got[3] - 0.6 * 468.0).abs() < 0.01, "merged 20%: columns start at {got:?}");
// A column no cell sizes and an absolute width alongside keep the grid.
let grid = [0.0, 107.3, 144.5, 176.45];
let mut unsized_column = table(0, [40.0, 10.0, 10.0, 40.0]);
unsized_column.rows[0].cells[3].props.width_pct = None;
let mut absolute = table(0, [40.0, 10.0, 10.0, 40.0]);
absolute.rows[1].cells[0].props.width = Some(100.0);
for t in [unsized_column, absolute] {
let got = starts(t);
let k = got[3] / grid[3];
near(got, grid.map(|g| g * k));
}
}
#[test]
fn ambiguous_widths_keep_grid() {
crate::test_fonts();
let mut t = Table::new(2, 3, 450.0);
t.grid = vec![40.0, 175.0, 235.0];
for row in &mut t.rows {
for (cell, width) in row.cells.iter_mut().zip([50.0, 60.0, 340.0]) {
cell.props.width = Some(width);
cell.blocks = vec![wordcraft_doc::para_block(Paragraph::with_text("A", Default::default()))];
}
}
let mut conflicting = t.clone();
conflicting.rows[1].cells[0].props.width = Some(60.0);
let mut percentage = t.clone();
percentage.rows[0].cells[0].props.width_pct = Some(10.0);
let mut invalid = t.clone();
invalid.rows[0].cells[0].props.width = Some(f32::NAN);
let mut different_total = t.clone();
different_total.rows.iter_mut().for_each(|r| r.cells[0].props.width = Some(60.0));
let mut spanned = t;
spanned.rows[0].cells.remove(1);
spanned.rows[0].cells[0].props.span = 2;
for table in [conflicting, percentage, invalid, different_total, spanned] {
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(table)).unwrap();
let l = lay(&d);
let [(x0, _, _)] = para_at(&l, &[0, 1, 0, 0])[..] else { panic!("cell missing") };
let [(x1, _, _)] = para_at(&l, &[0, 1, 1, 0])[..] else { panic!("cell missing") };
assert!((x1 - x0 - 40.0).abs() < 0.01);
}
}
/// #1374 helpers: a page-anchored, square-wrapped rectangle `w`×`h` at (`x`, `y`) on the page.
fn page_shape(x: f32, y: f32, w: f32, h: f32) -> InlineObject {
use wordcraft_doc::para::{Anchor, Float, ShapeKind, Wrap};
let float = Float { wrap: Wrap::Square, h_rel: Anchor::Page, v_rel: Anchor::Page, x, y, dist: 9.0, ..Default::default() };
InlineObject::Shape {
kind: ShapeKind::Rectangle,
w,
h,
fill: None,
stroke: None,
stroke_width: 1.0,
float,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
}
}
/// #1374: a two-column (`cols`) document: paragraph 0 holds `shape` (if any), paragraph 1 is
/// `words` numbered words, long enough to run on from where it starts.
fn column_wrap_doc(cols: u32, shape: Option<InlineObject>, words: usize) -> Document {
let text: String = (0..words).map(|i| format!("word{i} ")).collect();
let mut d = Document::from_text(&format!("Anchor\n{}", text.trim_end()));
d.last_section.columns.count = cols;
if let Some(s) = shape {
d.insert_object(&Pos::body(0, 0), s, &Default::default()).unwrap();
}
d
}
/// #1374: every line of body paragraph `block` drawn on page `page` whose x is `col_x` (one column):
/// its page box (left, top, right, bottom).
fn line_boxes(l: &DocLayout, page: usize, block: u32, col_x: f32) -> Vec<(f32, f32, f32, f32)> {
let mut v = Vec::new();
for it in &l.pages[page].items {
let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, x, y, .. } = it else { continue };
if path.0 != [block] || (x - col_x).abs() > 1.0 {
continue;
}
let first = ¶.lines[*l0];
for line in ¶.lines[*l0..*l1] {
let top = y + (line.top - first.top);
v.push((x + line.left, top, x + line.right, top + line.height));
}
}
v
}
/// #1374: no line in `lines` runs through `r` (grown by the shape's 9 pt wrap distance at the sides).
fn assert_clear_of(lines: &[(f32, f32, f32, f32)], r: Rect, what: &str) {
let mut beside = 0;
for &(l, t, rt, b) in lines {
if b <= r.y + 0.01 || t >= r.bottom() - 0.01 {
continue;
}
beside += 1;
assert!(l >= r.right() + 8.5 || rt <= r.x - 8.5, "{what}: line {l}..{rt} at {t}..{b} runs through the shape {r:?}");
}
assert!(beside > 0, "{what}: some lines are beside the shape: {lines:?}");
}
/// #1374: a paragraph that runs on from column 1 into column 2 wraps around a shape in column 2.
#[test]
fn paragraph_continued_into_next_column_wraps_around_a_shape_there() {
crate::test_fonts();
let r = Rect::new(340.0, 300.0, 100.0, 100.0);
let d = column_wrap_doc(2, Some(page_shape(r.x, r.y, r.w, r.h)), 450);
let l = lay(&d);
let (_, ranges) = shown_and_ranges(&l, 1);
assert_contiguous(&ranges, d.para(StoryRef::Body, &Path::top(1)).map(|p| p.len()).unwrap_or(0));
let col2 = l.pages[0].body.x + d.last_section.column_boxes()[1].0;
assert!(ranges.len() >= 2, "the paragraph runs into column 2: {ranges:?}");
assert_clear_of(&line_boxes(&l, 0, 1, col2), r, "column 2");
}
/// #1374: a shape far to the left of the next column (in the page margin, beyond a column's width
/// from it) doesn't make the paragraph going into that column be laid out again.
#[test]
fn paragraph_continued_into_next_column_ignores_shapes_well_clear_of_it() {
crate::test_fonts();
let d = column_wrap_doc(2, Some(page_shape(0.0, 300.0, 20.0, 100.0)), 450);
WRAP_RELAYS.with(|c| c.set(0));
let l = lay(&d);
assert_eq!(WRAP_RELAYS.with(|c| c.get()), 0, "no wrap relay");
let (_, ranges) = shown_and_ranges(&l, 1);
assert_contiguous(&ranges, d.para(StoryRef::Body, &Path::top(1)).map(|p| p.len()).unwrap_or(0));
}
/// #1374: lines continued onto a new page are broken for that page: a shape on the page before
/// (reaching below its body) doesn't push them aside there.
#[test]
fn paragraph_continued_onto_next_page_is_broken_for_that_page() {
crate::test_fonts();
// On page 1 from 640 down past the page bottom, at the left of the text.
let d = column_wrap_doc(1, Some(page_shape(72.0, 640.0, 150.0, 150.0)), 900);
let l = lay(&d);
assert!(l.pages.len() >= 2, "{} pages", l.pages.len());
let (_, ranges) = shown_and_ranges(&l, 1);
assert_contiguous(&ranges, d.para(StoryRef::Body, &Path::top(1)).map(|p| p.len()).unwrap_or(0));
// Page 1's lines beside the shape keep clear of it; page 2 has nothing to wrap around.
let page1 = line_boxes(&l, 0, 1, 72.0);
assert_clear_of(&page1, Rect::new(72.0, 640.0, 150.0, 150.0), "page 1");
let page2 = line_boxes(&l, 1, 1, 72.0);
assert!(!page2.is_empty());
for (left, top, ..) in page2 {
assert!(left < 72.5, "page 2: the line at {top} starts at {left}, beside a shape that isn't on this page");
}
}
/// #1374: with nothing to wrap around, the lines going into the next column are those broken in
/// the first: the paragraph isn't laid out again (no wrap relay), and both pieces share one layout.
#[test]
fn paragraph_continued_into_next_column_without_shapes_is_not_laid_out_again() {
crate::test_fonts();
let d = column_wrap_doc(2, None, 450);
WRAP_RELAYS.with(|c| c.set(0));
let l = lay(&d);
assert_eq!(WRAP_RELAYS.with(|c| c.get()), 0, "no wrap relay");
let pieces: Vec<&Arc<ParaLayout>> = l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Lines { story: StoryRef::Body, path, para, .. } if path.0 == [1] => Some(para),
_ => None,
})
.collect();
assert_eq!(pieces.len(), 2, "one piece per column");
assert!(Arc::ptr_eq(pieces[0], pieces[1]), "the second column reuses the first column's layout");
}
/// #1374: the paragraph's own floating object stays where it was placed (at its start, in column 1)
/// when its lines in column 2 are broken again around a shape there.
#[test]
fn paragraph_own_float_is_not_replaced_when_its_rest_wraps_in_the_next_column() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, ShapeKind, Wrap};
let r = Rect::new(340.0, 300.0, 100.0, 100.0);
let mut d = column_wrap_doc(2, Some(page_shape(r.x, r.y, r.w, r.h)), 450);
let own = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, dist: 9.0, ..Default::default() };
let own = InlineObject::Shape {
kind: ShapeKind::Rectangle,
w: 80.0,
h: 60.0,
fill: None,
stroke: None,
stroke_width: 1.0,
float: own,
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(1, 0), own, &Default::default()).unwrap();
let l = lay(&d);
let owns: Vec<(usize, Rect)> = l
.pages
.iter()
.enumerate()
.flat_map(|(pi, p)| p.items.iter().map(move |it| (pi, it)))
.filter_map(|(pi, it)| match it {
Placed::Shape { rect, .. } if (rect.w - 80.0).abs() < 0.5 => Some((pi, *rect)),
_ => None,
})
.collect();
let col2 = l.pages[0].body.x + d.last_section.column_boxes()[1].0;
let boxes = para_boxes(&l);
assert_eq!(owns.len(), 1, "the own float is drawn once: {owns:?}");
let (pi, own_rect) = owns[0];
assert_eq!(pi, 0);
assert!((own_rect.x - 72.0).abs() < 0.5, "in column 1: {own_rect:?}");
assert!((own_rect.y - boxes[1].2).abs() < 20.0, "at the paragraph's top {}: {own_rect:?}", boxes[1].2);
let (_, ranges) = shown_and_ranges(&l, 1);
assert_contiguous(&ranges, d.para(StoryRef::Body, &Path::top(1)).map(|p| p.len()).unwrap_or(0));
assert_clear_of(&line_boxes(&l, 0, 1, col2), r, "column 2");
}
/// "Straße" laid out with `f` applied to all of it: its first line's layout.
fn strasse_with(f: &dyn Fn(&mut wordcraft_doc::props::CharProps)) -> ParaLayout {
let mut d = Document::from_text("Straße");
d.format_range(&Pos::body(0, 0), &Pos::body(0, "Straße".len()), f).unwrap();
let l = lay(&d);
l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some((**para).clone()) } else { None }).expect("a laid-out line")
}
/// Text clusters of the first line: (start, end, glyph ids, left x, advance).
fn text_clusters(pl: &ParaLayout) -> Vec<(usize, usize, Vec<u32>, f32, f32)> {
let line = &pl.lines[0];
(line.c0..line.c1)
.filter(|&k| pl.clusters[k].kind == para::ClKind::Text)
.map(|k| {
let c = &pl.clusters[k];
let gids = pl.glyphs[c.g0 as usize..c.g1 as usize].iter().map(|g| g.gid).collect();
(c.start, c.end, gids, line.cl_left(k).unwrap(), c.adv)
})
.collect()
}
/// All Caps and Small Caps draw ß as SS, as Word does, and the ß stays one character for the
/// caret, selection and hit testing (#1581).
#[test]
fn caps_draw_sharp_s_as_two_capitals_in_one_cluster() {
crate::test_fonts();
let width = |pl: &ParaLayout| text_clusters(pl).iter().map(|c| c.4).sum::<f32>();
let plain_strase = {
let d = Document::from_text("STRASE");
let l = lay(&d);
let pl = l.pages[0].items.iter().find_map(|it| if let Placed::Lines { para, .. } = it { Some((**para).clone()) } else { None }).unwrap();
width(&pl)
};
let caps: &dyn Fn(&mut wordcraft_doc::props::CharProps) = &|c| c.caps = Some(true);
let small: &dyn Fn(&mut wordcraft_doc::props::CharProps) = &|c| c.small_caps = Some(true);
for (name, f) in [("All Caps", caps), ("Small Caps", small)] {
let pl = strasse_with(f);
let cl = text_clusters(&pl);
let glyphs: usize = cl.iter().map(|c| c.2.len()).sum();
assert_eq!(glyphs, 7, "{name}: S T R A S S E is seven glyphs: {cl:?}");
assert_eq!(cl.len(), 6, "{name}: six source characters, six clusters: {cl:?}");
let ss = cl.iter().find(|c| c.0 == 4).expect("a cluster for ß");
assert_eq!(ss.1, 6, "{name}: the ß cluster covers exactly the ß");
// Both glyphs drawn for ß are the S that starts the word.
let s_gid = cl.first().and_then(|c| c.2.first().copied());
assert_eq!(ss.2.len(), 2, "{name}: ß draws two glyphs");
assert!(ss.2.iter().all(|g| Some(*g) == s_gid), "{name}: both glyphs are S");
if name == "All Caps" {
assert!(width(&pl) > plain_strase + 1.0, "All Caps: STRASSE is wider than STRASE: {} vs {plain_strase}", width(&pl));
}
// Caret stops: one before each source character, and the end; none inside ß.
assert_eq!(pl.line_offsets(0), vec![0, 1, 2, 3, 4, 6, 7], "{name}");
// A click on the first S lands before the ß, on the second S after it.
assert_eq!(pl.off_at_x(0, ss.3 + ss.4 * 0.25), 4, "{name}: click on the first S");
assert_eq!(pl.off_at_x(0, ss.3 + ss.4 * 0.75), 6, "{name}: click on the second S");
if name == "Small Caps" {
// The ß is a lowercase letter: drawn at the small-caps size, like the "t", not
// at the size of the capital S that starts the word.
let style = |off: usize| pl.clusters.iter().find(|c| c.start == off).map(|c| c.style);
assert_eq!(style(4), style(1), "Small Caps: ß is scaled like t");
assert_ne!(style(4), style(0), "Small Caps: ß is not the size of the first S");
}
}
// Without caps, ß is one glyph of its own.
let pl = strasse_with(&|c| c.bold = Some(false));
let cl = text_clusters(&pl);
assert_eq!(cl.len(), 6);
assert_eq!(cl.iter().map(|c| c.2.len()).sum::<usize>(), 6, "{cl:?}");
}
/// A caps run in a symbol font draws each code as its symbol: ß never becomes two glyphs (#1581).
#[test]
fn caps_in_a_symbol_font_never_expand_characters() {
crate::test_fonts();
let pl = strasse_with(&|c| {
c.caps = Some(true);
c.font = Some("Wingdings".into());
});
let cl = text_clusters(&pl);
assert_eq!(cl.len(), 6, "{cl:?}");
let ss = cl.iter().find(|c| c.0 == 4).expect("a cluster for the ß code");
assert_eq!((ss.1, ss.2.len()), (6, 1), "the ß code is one symbol: {cl:?}");
}
/// #1320: a section's vertical alignment (`w:vAlign`, ECMA-376 §17.6.23). Justified shares the
/// room left on each page out equally between the page's blocks, so the first line stays at the
/// top margin and the last one sits on the bottom margin (Word for Mac 16.113.4): a partly filled
/// last page too, and a page ending in a manual page break, where the paragraph holding the break
/// is the page's last block. A page with one block keeps it at the top.
#[test]
fn section_vertical_alignment_top_center_justify_bottom() {
crate::test_fonts();
use wordcraft_doc::section::PageVAlign;
let para = |text: &str| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props = ParaProps { space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
wordcraft_doc::para_block(p)
};
let laid = |texts: &[&str], va: PageVAlign| {
let mut d = Document::new();
d.body = texts.iter().map(|t| para(t)).collect();
d.last_section.valign = va;
lay(&d)
};
let three = ["One", "Two", "Three"];
let top = laid(&three, PageVAlign::Top);
let body = top.pages[0].body;
let (body_top, body_bottom) = (body.y, body.y + body.h);
let t = para_boxes(&top);
let h: f32 = t[2].3 - t[0].2;
assert!((t[0].2 - body_top).abs() < 0.5, "top: at the top margin {t:?} {body:?}");
let c = para_boxes(&laid(&three, PageVAlign::Center));
let room = body_bottom - body_top - h;
assert!((c[0].2 - (body_top + room / 2.0)).abs() < 0.5, "center: {c:?}");
assert!((c[1].2 - c[0].3).abs() < 0.05 && (c[2].2 - c[1].3).abs() < 0.05, "center keeps the blocks together: {c:?}");
let b = para_boxes(&laid(&three, PageVAlign::Bottom));
assert!((b[2].3 - body_bottom).abs() < 0.5, "bottom: {b:?} {body:?}");
// Justified: first at the top, last on the bottom margin, equal gaps.
let j = para_boxes(&laid(&three, PageVAlign::Justify));
assert!((j[0].2 - body_top).abs() < 0.5, "justify: first line at the top margin {j:?}");
assert!((j[2].3 - body_bottom).abs() < 0.5, "justify: last line on the bottom margin {j:?} {body:?}");
let (g1, g2) = (j[1].2 - j[0].3, j[2].2 - j[1].3);
assert!(g1 > 100.0 && (g1 - g2).abs() < 0.05, "justify: equal gaps {g1} {g2}");
// One block on the page stays at the top.
let one = para_boxes(&laid(&["Only"], PageVAlign::Justify));
assert!((one[0].2 - body_top).abs() < 0.5, "a single block stays at the top: {one:?}");
// A manual page break: its paragraph is page 1's last block; "Four" alone on page 2 stays up.
let brk = wordcraft_doc::para::PAGE_BREAK.to_string();
let p = para_boxes(&laid(&["One", "Two", "Three", &brk, "Four"], PageVAlign::Justify));
assert_eq!(p.iter().map(|e| e.0).collect::<Vec<_>>(), vec![0, 0, 0, 0, 1], "{p:?}");
assert!((p[0].2 - body_top).abs() < 0.5, "{p:?}");
assert!((p[3].3 - body_bottom).abs() < 0.5, "the break's paragraph sits on the bottom margin: {p:?}");
let gaps: Vec<f32> = (1..4).map(|i| p[i].2 - p[i - 1].3).collect();
assert!(gaps.iter().all(|g| (g - gaps[0]).abs() < 0.05 && *g > 50.0), "{gaps:?}");
assert!((p[4].2 - body_top).abs() < 0.5, "Four keeps to the top of page 2: {p:?}");
}
/// #1320 review: a section's last page takes that section's vertical alignment, not the next
/// section's (Justified then Top: spread; Top then Justified: stays at the top).
#[test]
fn a_sections_last_page_keeps_its_own_vertical_alignment() {
crate::test_fonts();
use wordcraft_doc::section::{PageVAlign, SectionProps};
let para = |text: &str| {
let mut p = wordcraft_doc::Paragraph::with_text(text, Default::default());
p.props = ParaProps { space_before: Some(0.0), space_after: Some(0.0), ..Default::default() };
wordcraft_doc::para_block(p)
};
let laid = |first: PageVAlign, second: PageVAlign| {
let mut d = Document::new();
d.body = ["One", "Two", "Three", "Next section"].iter().map(|t| para(t)).collect();
d.para_mut(StoryRef::Body, &Path::top(2)).unwrap().section = Some(Box::new(SectionProps { valign: first, ..Default::default() }));
d.last_section.valign = second;
lay(&d)
};
let l = laid(PageVAlign::Justify, PageVAlign::Top);
let body = l.pages[0].body;
let b = para_boxes(&l);
assert_eq!(b.iter().map(|e| e.0).collect::<Vec<_>>(), vec![0, 0, 0, 1]);
assert!((b[0].2 - body.y).abs() < 0.5 && (b[2].3 - (body.y + body.h)).abs() < 0.5, "section 1 justified: {b:?} {body:?}");
assert!((b[3].2 - body.y).abs() < 0.5, "section 2 at the top: {b:?}");
let b = para_boxes(&laid(PageVAlign::Top, PageVAlign::Justify));
assert!((b[1].2 - b[0].3).abs() < 0.05 && (b[2].2 - b[1].3).abs() < 0.05, "section 1 stays at the top: {b:?}");
}
/// Word for Mac 16.113.4 (user-checked, #1320): a justified page keeps its last paragraph's space
/// after inside the text area, so "Three" with 72 pt after sits 72 pt above the bottom margin.
#[test]
fn justified_page_keeps_the_last_paragraphs_space_after() {
crate::test_fonts();
let mut d = Document::new();
d.body = ["One", "Two", "Three"]
.iter()
.enumerate()
.map(|(i, t)| {
let mut p = wordcraft_doc::Paragraph::with_text(t, Default::default());
p.props = ParaProps { space_before: Some(0.0), space_after: Some(if i == 2 { 72.0 } else { 0.0 }), ..Default::default() };
wordcraft_doc::para_block(p)
})
.collect();
d.last_section.valign = wordcraft_doc::section::PageVAlign::Justify;
let l = lay(&d);
let body = l.pages[0].body;
let b = para_boxes(&l);
assert!((b[0].2 - body.y).abs() < 0.5, "{b:?}");
assert!((body.y + body.h - b[2].3 - 72.0).abs() < 0.5, "72 pt left under Three: {b:?} {body:?}");
assert!((b[1].2 - b[0].3 - (b[2].2 - b[1].3)).abs() < 0.05, "equal gaps: {b:?}");
}
/// #1320: a justified page with several newspaper columns stays at the top (not spread).
#[test]
fn justified_multi_column_pages_stay_at_the_top() {
crate::test_fonts();
let laid = |va| {
let mut d = two_column_section(wordcraft_doc::section::SectionStart::NextPage, Vec::new());
d.para_mut(StoryRef::Body, &Path::top(9)).unwrap().section.as_mut().unwrap().valign = va;
para_boxes(&lay(&d))
};
use wordcraft_doc::section::PageVAlign;
assert_eq!(laid(PageVAlign::Justify), laid(PageVAlign::Top));
// The document's last section in two columns.
let last = |va| {
let mut d = Document::from_text("One\nTwo\nThree\nFour");
d.last_section.columns.count = 2;
d.last_section.valign = va;
para_boxes(&lay(&d))
};
assert_eq!(last(PageVAlign::Justify), last(PageVAlign::Top));
}
/// Gap #5 review: a paragraph deleted whole (text and mark) takes no room in the final text, and
/// neither does moved-away text marked Hidden; the paragraph after it sits where it would without
/// it, and a deletion that isn't left out keeps its line.
#[test]
fn a_paragraph_left_out_whole_takes_no_room() {
crate::test_fonts();
let mut d = Document::from_text("One\nGone\nThree");
d.format_range(&Pos::body(1, 0), &Pos::body(2, 0), &|c| c.del = Some(0)).unwrap();
let three_top =
|d: &Document, opts: &LayoutOptions, block: usize| layout(d, &mut LayoutCache::new(), opts).caret(&Pos::body(block, 0)).unwrap().top;
let without = three_top(&Document::from_text("One\nThree"), &LayoutOptions::default(), 1);
let fin = LayoutOptions { hide_deleted: true, ..Default::default() };
assert!((three_top(&d, &fin, 2) - without).abs() < 0.01, "no blank line in the final text");
assert!(three_top(&d, &LayoutOptions::default(), 2) > without + 1.0, "with markup it keeps its line");
// Only moved-away text hidden: an ordinary deletion keeps its line.
let moves = LayoutOptions { hide_marked: HideDeleted { plain: false, moved_from: true }, ..Default::default() };
assert!(three_top(&d, &moves, 2) > without + 1.0);
let plain = LayoutOptions { hide_marked: HideDeleted { plain: true, moved_from: false }, ..Default::default() };
assert!((three_top(&d, &plain, 2) - without).abs() < 0.01);
}
/// Gap #5 review: a paragraph left out whole draws no shading and no borders (they would be
/// lines across the page at its zero height).
#[test]
fn a_paragraph_left_out_whole_draws_no_borders_or_shading() {
crate::test_fonts();
let mut d = Document::from_text("One\nGone\nThree");
let line = Some(Border::single(1.0));
d.format_paragraphs(&Pos::body(1, 0), &Pos::body(1, 0), &|p| {
p.borders = Some(Borders { top: line, left: line, bottom: line, right: line, ..Borders::default() });
p.shading = Some(wordcraft_doc::Rgb(0xEE, 0xEE, 0xEE));
})
.unwrap();
d.format_range(&Pos::body(1, 0), &Pos::body(2, 0), &|c| c.del = Some(0)).unwrap();
let decorations = |hide_deleted: bool| {
let l = layout(&d, &mut LayoutCache::new(), &LayoutOptions { hide_deleted, ..Default::default() });
l.pages[0].items.iter().filter(|i| matches!(i, Placed::Fill { .. } | Placed::Rule { .. })).count()
};
assert_eq!(decorations(false), 5, "shading and four borders with markup");
assert_eq!(decorations(true), 0, "none in the final text");
}
#[test]
fn row_borders_stay_on_row() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(2, 2, 200.0);
t.props.style = None;
t.rows[0].props.exceptions =
Some(Box::new(wordcraft_doc::props::TableProps { borders: Some(Borders::all(Border::single(1.0))), ..Default::default() }));
t.rows[0].cells[0].props.borders = Some(Borders { top: Some(Border::single(2.0)), ..Default::default() });
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let rules = rules_on_page0(&lay(&d));
assert_eq!(rules.len(), 8);
assert_eq!(rules.iter().filter(|w| **w == 2.0).count(), 1);
assert_eq!(rules.iter().filter(|w| **w == 1.0).count(), 7);
}
/// #1740: a triple table border is drawn as a triple line, not a double one.
#[test]
fn triple_table_borders_draw_triple_lines() {
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(1, 1, 200.0);
t.props.style = None;
let triple = Border { style: BorderStyle::Triple, width: 0.5, color: None, space: 0.0 };
let double = Border { style: BorderStyle::Double, width: 0.5, color: None, space: 0.0 };
t.props.borders =
Some(Borders { top: Some(triple), bottom: Some(double), left: Some(triple), right: Some(Border::single(0.5)), ..Default::default() });
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let items = display::page_display(&d, &l.pages[0], &display::DisplayOptions::default());
let mut strokes: Vec<_> = items.iter().filter_map(|i| if let display::Draw::Line { stroke, .. } = i { Some(*stroke) } else { None }).collect();
strokes.sort_by_key(|s| format!("{s:?}"));
assert_eq!(strokes, vec![display::Stroke::Double, display::Stroke::Solid, display::Stroke::Triple, display::Stroke::Triple]);
}
#[test]
fn row_nil_overrides_style() {
crate::test_fonts();
let mut d = Document::from_text("before\nafter");
let mut t = Table::new(1, 1, 200.0);
t.rows[0].props.exceptions = Some(Box::new(wordcraft_doc::props::TableProps {
borders: Some(Borders::all(Border { style: BorderStyle::None, width: 0.0, color: None, space: 0.0 })),
..Default::default()
}));
t.rows[0].cells[0].props.borders = Some(Borders { right: Some(Border::single(2.0)), ..Default::default() });
d.insert_block(StoryRef::Body, &Path::top(1), wordcraft_doc::Block::Table(t)).unwrap();
assert_eq!(rules_on_page0(&lay(&d)), vec![2.0]);
}
/// Continued text keeps the cell's border inset, as on its first fragment.
#[test]
fn split_cell_reuses_top_inset() {
crate::test_fonts();
use wordcraft_doc::props::{HeightRule, LineSpacing};
for (width, margin) in [(0.0, 0.0), (0.5, 0.0), (2.0, 0.0), (0.0, 6.0), (0.5, 6.0), (2.0, 6.0)] {
for spacing in [LineSpacing::Exactly(10.0), LineSpacing::AtLeast(10.0)] {
let mut d = Document::new();
d.last_section.page_h = 360.0;
d.last_section.margin_top = 36.0;
d.last_section.margin_bottom = 36.0;
let mut t = Table::new(1, 1, 300.0);
t.rows[0].cells[0].props.margins = Some([margin, 5.4, 0.0, 5.4]);
let edge = Some(Border { width, style: if width > 0.0 { BorderStyle::Single } else { BorderStyle::None }, ..Default::default() });
t.props.borders = Some(Borders { top: edge, bottom: edge, left: edge, right: edge, between: edge, inside_v: edge });
t.rows[0].props.height = Some(100.0);
t.rows[0].props.height_rule = HeightRule::AtLeast;
let mut p = Paragraph::with_text(
&["Line"; 35].join("\n"),
wordcraft_doc::CharProps { font: Some("Arial".into()), size: Some(9.0), ..Default::default() },
);
p.props.line_spacing = Some(spacing);
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p.props.widow_control = Some(false);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
d.body = vec![std::sync::Arc::new(Block::Table(t))];
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
for pg in &l.pages {
let cell = pg
.items
.iter()
.find_map(|it| match it {
Placed::Cell { rect, .. } => Some(*rect),
_ => None,
})
.unwrap();
let top = pg
.items
.iter()
.find_map(|it| match it {
Placed::Lines { y, .. } => Some(*y),
_ => None,
})
.unwrap();
assert!((top - cell.y - width - margin).abs() < 0.01, "width={width}, margin={margin}, top={top}, cell={cell:?}");
}
}
}
}
/// Images and their floating hit areas move together without changing size or crop.
#[test]
fn split_cell_moves_image_frame() {
crate::test_fonts();
use crate::table::{CellPart, RowLayout, split_row};
use wordcraft_doc::para::Wrap;
for top in [0.0, 0.5, 6.5, 8.0] {
let rect = Rect::new(7.0, 150.0, 20.0, 20.0);
let image = Placed::Image {
rect,
media: "synthetic".into(),
crop: [0.1, 0.2, 0.3, 0.4],
fx: Default::default(),
story: StoryRef::Body,
path: Path::top(0),
off: 0,
spin: Default::default(),
};
let frame = Placed::Object {
rect,
spin: Default::default(),
story: StoryRef::Body,
path: Path::top(0),
off: 0,
text_box: None,
wrap: Wrap::Square,
origin: wordcraft_geom::Point::new(3.0, 145.0),
group_boxes: Vec::new(),
};
let mut kept = image.clone();
kept.translate(0.0, top - 150.0);
let row = RowLayout {
height: 200.0,
bottom: 4.0,
edge: 0.0,
items: vec![kept, image, frame],
cells: vec![CellPart { top, items: 0..3, end: Some(170.0), align: None }],
};
let (first, rest) = split_row(&row, 100.0).unwrap();
assert_eq!(first.items.len(), 1);
assert!(matches!(&first.items[0], Placed::Image { rect, .. } if *rect == Rect::new(7.0, top, 20.0, 20.0)));
assert_eq!(rest.items.len(), 2);
for item in &rest.items {
let moved = match item {
Placed::Image { rect, crop, media, .. } => {
assert_eq!(*crop, [0.1, 0.2, 0.3, 0.4]);
assert_eq!(media, "synthetic");
*rect
}
Placed::Object { rect, origin, wrap, .. } => {
assert_eq!(*wrap, Wrap::Square);
assert!((origin.y - (top - 5.0)).abs() < 0.01);
assert_eq!(origin.x, 3.0);
*rect
}
_ => panic!("unexpected continuation item"),
};
assert_eq!(moved, Rect::new(7.0, top, 20.0, 20.0));
}
assert!((rest.height - (50.0 + top)).abs() < 0.01);
}
}
fn row_keep_doc() -> Document {
use wordcraft_doc::props::{HeightRule, LineSpacing};
let plain = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(LineSpacing::Exactly(12.0)),
widow_control: Some(false),
..Default::default()
};
let para = |text: &str, props: ParaProps| {
let mut p = Paragraph::with_text(text, Default::default());
p.props = props;
wordcraft_doc::para_block(p)
};
let mut d = Document::new();
d.last_section.page_w = 400.0;
d.last_section.page_h = 360.0;
d.last_section.margin_top = 36.0;
d.last_section.margin_bottom = 36.0;
d.last_section.margin_left = 36.0;
d.last_section.margin_right = 36.0;
Arc::make_mut(&mut d.styles).upsert(wordcraft_doc::Style {
id: "KeptRow".into(),
name: "Kept row".into(),
para: ParaProps { keep_next: Some(true), keep_lines: Some(true), ..Default::default() },
..Default::default()
});
let mut t = Table::new(2, 1, 328.0);
t.props.style = None;
t.props.cell_margins = Some([0.0; 4]);
t.rows[0].props.height = Some(24.0);
t.rows[0].props.height_rule = HeightRule::Exact;
t.rows[0].cells[0].blocks = vec![para("Heading", ParaProps { style: Some("KeptRow".into()), ..plain.clone() })];
t.rows[1].props.height = Some(180.0);
t.rows[1].props.height_rule = HeightRule::AtLeast;
t.rows[1].cells[0].blocks = vec![para("", plain.clone()), para("Following row", plain.clone())];
d.body = vec![para("Filler", ParaProps { line_spacing: Some(LineSpacing::Exactly(190.0)), ..plain }), Arc::new(Block::Table(t))];
d
}
/// The tops of the lines of each cell of a two-cell row split across pages, by page: the
/// first cell aligned with `valign` and `left` lines long, the second 30 lines long, every line a
/// paragraph with `after` points after it.
fn split_valign_lines(valign: wordcraft_doc::props::VAlign, left: usize, after: f32) -> Vec<[Vec<f32>; 2]> {
use wordcraft_doc::props::LineSpacing;
let plain = ParaProps {
space_before: Some(0.0),
space_after: Some(after),
line_spacing: Some(LineSpacing::Exactly(12.0)),
widow_control: Some(false),
..Default::default()
};
let para = |text: &str, props: ParaProps| {
let mut p = Paragraph::with_text(text, Default::default());
p.props = props;
wordcraft_doc::para_block(p)
};
let mut d = Document::new();
d.last_section.page_w = 400.0;
d.last_section.page_h = 360.0;
d.last_section.margin_top = 36.0;
d.last_section.margin_bottom = 36.0;
d.last_section.margin_left = 36.0;
d.last_section.margin_right = 36.0;
let mut t = Table::new(1, 2, 328.0);
t.props.style = None;
t.props.cell_margins = Some([0.0; 4]);
t.rows[0].cells[0].props.valign = Some(valign);
t.rows[0].cells[0].blocks = (0..left).map(|i| para(&format!("Label {i}"), plain.clone())).collect();
t.rows[0].cells[1].blocks = (0..30).map(|i| para(&format!("Line {i}"), plain.clone())).collect();
d.body = vec![para("Filler", ParaProps { line_spacing: Some(LineSpacing::Exactly(100.0)), ..plain }), Arc::new(Block::Table(t))];
lay(&d)
.pages
.iter()
.map(|page| {
let mut cells = [Vec::new(), Vec::new()];
for item in &page.items {
if let Placed::Lines { path, y, .. } = item
&& path.0.len() == 4
&& path.0[0] == 1
{
cells[path.0[2] as usize].push(*y);
}
}
cells
})
.collect()
}
#[test]
fn a_middle_or_bottom_cell_of_a_split_row_lines_up_on_the_first_page() {
use wordcraft_doc::props::VAlign;
// Measured in Word: a centred or bottom cell whose text fits in the part of the row left on
// the page is aligned within that part (as tall as the other cells' text there), not left
// for the top of the next page.
for (valign, left) in [(VAlign::Center, 1), (VAlign::Center, 3), (VAlign::Bottom, 1)] {
let pages = split_valign_lines(valign, left, 0.0);
let [labels, lines] = &pages[0];
assert!(lines.len() > 5 && lines.len() < 30, "the row splits: {pages:?}");
assert_eq!(labels.len(), left, "{valign:?} {left}: all the labels stay on the first page: {pages:?}");
assert!(pages[1..].iter().all(|p| p[0].is_empty()), "{valign:?} {left}: nothing of the first cell moves on: {pages:?}");
let (top, bottom) = (lines[0], lines[lines.len() - 1] + 12.0);
let (first, last) = (labels[0], labels[left - 1] + 12.0);
let want = match valign {
VAlign::Bottom => bottom - 12.0 * left as f32,
_ => top + (bottom - top - 12.0 * left as f32) / 2.0,
};
assert!((first - want).abs() < 0.5, "{valign:?} {left}: first label at {first}, want {want}: {pages:?}");
assert!(last <= bottom + 0.01, "{valign:?} {left}: the labels end above the cut: {pages:?}");
}
// The other cells' text kept on the page ends with its last paragraph's space after: a bottom
// cell's last line lines up with theirs.
let pages = split_valign_lines(VAlign::Bottom, 1, 6.0);
let [labels, lines] = &pages[0];
assert_eq!(labels.last(), lines.last(), "{pages:?}");
// Text that doesn't all fit runs from the top of the cell, with the rest on the next page.
let pages = split_valign_lines(VAlign::Center, 25, 0.0);
let [labels, lines] = &pages[0];
assert_eq!(labels.first(), lines.first(), "a centred cell too long for the page starts at the top: {pages:?}");
assert_eq!(labels.len(), lines.len(), "{pages:?}");
assert_eq!(pages[1][0].len(), 25 - labels.len(), "{pages:?}");
}
/// The line tops on the first page of a row split across pages, by cell: a label aligned with
/// `valign`, 30 lines that split, and a 160 pt spacer above `note`.
fn split_row_beside_a_note(valign: wordcraft_doc::props::VAlign, note: &ParaProps) -> [Vec<f32>; 3] {
use wordcraft_doc::props::LineSpacing;
let plain = split_note_plain();
let para = |text: &str, props: ParaProps| {
let mut p = Paragraph::with_text(text, Default::default());
p.props = props;
wordcraft_doc::para_block(p)
};
let mut d = Document::new();
(d.last_section.page_w, d.last_section.page_h) = (400.0, 360.0);
d.last_section.margin_top = 36.0;
d.last_section.margin_bottom = 36.0;
let mut t = Table::new(1, 3, 328.0);
t.props.style = None;
t.props.cell_margins = Some([0.0; 4]);
t.rows[0].cells[0].props.valign = Some(valign);
t.rows[0].cells[0].blocks = vec![para("Label", plain.clone())];
t.rows[0].cells[1].blocks = (0..30).map(|i| para(&format!("Line {i}"), plain.clone())).collect();
let spacer = ParaProps { line_spacing: Some(LineSpacing::Exactly(160.0)), ..plain.clone() };
t.rows[0].cells[2].blocks = vec![para("Spacer", spacer), para("Note", note.clone())];
d.body = vec![para("Filler", ParaProps { line_spacing: Some(LineSpacing::Exactly(100.0)), ..plain }), Arc::new(Block::Table(t))];
let l = lay(&d);
let tops = |cell: u32| -> Vec<f32> {
l.pages[0]
.items
.iter()
.filter_map(|item| match item {
Placed::Lines { path, y, .. } if path.0.len() == 4 && path.0[0] == 1 && path.0[2] == cell => Some(*y),
_ => None,
})
.collect()
};
let cells = [tops(0), tops(1), tops(2)];
assert!(cells[1].len() > 5 && cells[1].len() < 30, "the row splits: {cells:?}");
assert_eq!(cells[2].len(), 2, "the note stays on the page: {cells:?}");
cells
}
/// Single 12 pt lines with no space around them.
fn split_note_plain() -> ParaProps {
ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(wordcraft_doc::props::LineSpacing::Exactly(12.0)),
widow_control: Some(false),
..Default::default()
}
}
#[test]
fn a_bottom_cell_of_a_split_row_ignores_a_dropped_space_after_beside_it() {
use wordcraft_doc::props::VAlign;
// The note's space after (contextual 300 pt, or automatic) drops at the cell's end and would
// otherwise reach below the split lines: a bottom label lines up with those, a middle one is
// centred between their top and bottom.
let plain = split_note_plain();
let contextual = ParaProps { space_after: Some(300.0), contextual_spacing: Some(true), ..plain.clone() };
let automatic = ParaProps { space_after_auto: Some(true), ..plain };
for note in [contextual, automatic] {
let [labels, lines, _] = split_row_beside_a_note(VAlign::Bottom, ¬e);
assert_eq!(labels.last(), lines.last(), "{note:?}: labels {labels:?}, lines {lines:?}");
let [labels, lines, _] = split_row_beside_a_note(VAlign::Center, ¬e);
let (Some(&first), Some(&last), Some(&label)) = (lines.first(), lines.last(), labels.first()) else { panic!("{labels:?} {lines:?}") };
let want = first + (last - first) / 2.0;
assert!((label - want).abs() < 0.01, "{note:?}: centred label at {label}, want {want}");
}
}
#[test]
fn a_bottom_cell_of_a_split_row_lines_up_with_a_kept_space_after_beside_it() {
use wordcraft_doc::props::VAlign;
// A note that keeps its 14 pt after (no contextual spacing) still ends there: the bottom
// label's line ends 14 pt below the note's.
let note = ParaProps { space_after: Some(14.0), ..split_note_plain() };
let [labels, lines, notes] = split_row_beside_a_note(VAlign::Bottom, ¬e);
let (Some(&label), Some(¬e_top), Some(&line)) = (labels.last(), notes.last(), lines.last()) else { panic!("{labels:?} {notes:?}") };
assert!(note_top + 14.0 > line, "the note's space after reaches below the split lines: {notes:?} {lines:?}");
assert!((label - (note_top + 14.0)).abs() < 0.01, "label at {label}, note at {note_top}");
}
fn row_keep_pages(d: &Document) -> Vec<usize> {
let l = lay(d);
(0..d.table(StoryRef::Body, &Path::top(1)).unwrap().rows.len())
.map(|row| {
l.pages
.iter()
.position(|page| {
page.items.iter().any(|item| matches!(item, Placed::Lines { path, .. } if path.0.len() == 4 && path.0[..3] == [1, row as u32, 0]))
})
.unwrap()
})
.collect()
}
#[test]
fn kept_row_moves_with_next() {
crate::test_fonts();
for rule in [wordcraft_doc::props::HeightRule::AtLeast, wordcraft_doc::props::HeightRule::Exact] {
let mut d = row_keep_doc();
d.table_mut(StoryRef::Body, &Path::top(1)).unwrap().rows[1].props.height_rule = rule;
d.para_mut(StoryRef::Body, &Path(vec![1, 0, 0, 0])).unwrap().props.keep_next = Some(false);
assert_eq!(row_keep_pages(&d), [0, 1], "unkept control, {rule:?}");
d.para_mut(StoryRef::Body, &Path(vec![1, 0, 0, 0])).unwrap().props.keep_next = None;
assert_eq!(row_keep_pages(&d), [1, 1], "inherited keep, {rule:?}");
}
}
#[test]
fn kept_row_allows_next_split() {
crate::test_fonts();
let mut d = row_keep_doc();
let t = d.table_mut(StoryRef::Body, &Path::top(1)).unwrap();
t.rows[1].props.height = None;
let p = d.para_mut(StoryRef::Body, &Path(vec![1, 1, 0, 0])).unwrap();
let props = p.props.clone();
*p = Paragraph::with_text(&"Next\n".repeat(30), Default::default());
p.props = props;
assert_eq!(row_keep_pages(&d), [0, 0]);
}
#[test]
fn kept_rows_move_as_chain() {
crate::test_fonts();
let mut d = row_keep_doc();
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(170.0));
let t = d.table_mut(StoryRef::Body, &Path::top(1)).unwrap();
let mut middle = t.rows[0].clone();
middle.props.height = Some(80.0);
middle.props.height_rule = wordcraft_doc::props::HeightRule::AtLeast;
let mut p = Paragraph::with_text("Middle", Default::default());
p.props = middle.cells[0].blocks[0].as_para().unwrap().props.clone();
middle.cells[0].blocks = vec![wordcraft_doc::para_block(p)];
t.rows.insert(1, middle);
assert_eq!(row_keep_pages(&d), [1, 1, 1]);
d.para_mut(StoryRef::Body, &Path(vec![1, 0, 0, 0])).unwrap().props.keep_next = Some(false);
assert_eq!(row_keep_pages(&d), [0, 1, 1]);
}
#[test]
fn oversized_kept_rows_finish() {
crate::test_fonts();
let mut d = row_keep_doc();
d.table_mut(StoryRef::Body, &Path::top(1)).unwrap().rows[1].props.height = Some(400.0);
let l = lay(&d);
assert!(l.pages.len() <= 4, "{} pages", l.pages.len());
assert_eq!(row_keep_pages(&d), [1, 2], "Word starts the oversized kept group on a fresh page");
}
#[test]
fn kept_row_can_split_itself() {
crate::test_fonts();
let mut d = row_keep_doc();
let t = d.table_mut(StoryRef::Body, &Path::top(1)).unwrap();
t.rows[0].props.height = None;
t.rows[0].props.height_rule = wordcraft_doc::props::HeightRule::Auto;
t.rows[1].props.height = Some(20.0);
let p = d.para_mut(StoryRef::Body, &Path(vec![1, 0, 0, 0])).unwrap();
let mut props = p.props.clone();
props.keep_lines = Some(false);
*p = Paragraph::with_text(&"Heading\n".repeat(10), Default::default());
p.props = props;
assert_eq!(row_keep_pages(&d), [0, 1]);
}
#[test]
fn first_cell_controls_keep() {
crate::test_fonts();
for (first, last, pages) in [(true, false, [1, 1]), (false, true, [0, 1]), (true, true, [1, 1]), (false, false, [0, 1])] {
let mut d = row_keep_doc();
let t = d.table_mut(StoryRef::Body, &Path::top(1)).unwrap();
t.grid = vec![164.0, 164.0];
for (ri, row) in t.rows.iter_mut().enumerate() {
row.cells.push(row.cells[0].clone());
for (ci, cell) in row.cells.iter_mut().enumerate() {
let mut p = Paragraph::with_text("Cell", Default::default());
p.props = cell.blocks[0].as_para().unwrap().props.clone();
p.props.keep_next = Some(ri == 0 && if ci == 0 { first } else { last });
cell.blocks = vec![wordcraft_doc::para_block(p)];
}
}
assert_eq!(row_keep_pages(&d), pages, "first={first}, last={last}");
}
}
#[test]
fn first_para_controls_row_keep() {
crate::test_fonts();
let mut d = row_keep_doc();
let mut p = Paragraph::with_text("Last paragraph", Default::default());
p.props = d.para(StoryRef::Body, &Path(vec![1, 0, 0, 0])).unwrap().props.clone();
p.props.keep_next = Some(false);
d.table_mut(StoryRef::Body, &Path::top(1)).unwrap().rows[0].cells[0].blocks.push(wordcraft_doc::para_block(p));
assert_eq!(row_keep_pages(&d), [1, 1], "Word honors the first paragraph even when the last opts out");
d.para_mut(StoryRef::Body, &Path(vec![1, 0, 0, 0])).unwrap().props.keep_next = Some(false);
d.para_mut(StoryRef::Body, &Path(vec![1, 0, 0, 1])).unwrap().props.keep_next = Some(true);
assert_eq!(row_keep_pages(&d), [0, 1], "a later paragraph cannot keep its row");
}
#[test]
fn nested_keep_leaves_outer_row() {
crate::test_fonts();
let mut d = row_keep_doc();
let t = d.table_mut(StoryRef::Body, &Path::top(1)).unwrap();
t.rows[0].props.height = Some(60.0);
let mut nested = Table::new(1, 1, 328.0);
nested.rows[0].cells[0].blocks = vec![t.rows[0].cells[0].blocks[0].clone()];
let mut p = Paragraph::with_text("Outer tail", Default::default());
p.props.keep_next = Some(false);
t.rows[0].cells[0].blocks = vec![Arc::new(Block::Table(nested)), wordcraft_doc::para_block(p)];
assert_eq!(row_keep_pages(&d), [0, 1]);
}
#[test]
fn kept_prefix_stays_together() {
crate::test_fonts();
let mut d = row_keep_doc();
let t = d.table_mut(StoryRef::Body, &Path::top(1)).unwrap();
t.rows[1].props.height = Some(400.0);
let mut middle = t.rows[0].clone();
middle.props.height = Some(80.0);
middle.props.height_rule = wordcraft_doc::props::HeightRule::AtLeast;
t.rows.insert(1, middle);
assert_eq!(row_keep_pages(&d), [1, 1, 2], "an oversized follower cannot separate an already placed kept prefix");
}
/// Word and Adobe: a behind-text frame participates in a cell's vertical alignment,
/// even when its anchor paragraph has no inline picture (synthetic two-cell probe).
#[test]
fn cell_frame_centres_empty() {
crate::test_fonts();
use wordcraft_doc::para::{Anchor, Float, Wrap};
use wordcraft_doc::props::{HeightRule, VAlign};
let mut d = Document::new();
let mut t = Table::new(1, 2, 468.0);
t.rows[0].props.height = Some(182.5);
t.rows[0].props.height_rule = HeightRule::Exact;
for (ci, cell) in t.rows[0].cells.iter_mut().enumerate() {
cell.props.valign = Some(VAlign::Center);
cell.props.margins = Some([0.0; 4]);
let mut p = wordcraft_doc::Paragraph::with_text("", Default::default());
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
let float = Float { wrap: Wrap::BehindText, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, y: -12.75, ..Default::default() };
p.insert_object(0, picture(231.0, 180.75, float), &Default::default()).unwrap();
if ci == 0 {
p.insert_object(p.text.len(), picture(207.0, 155.25, Default::default()), &Default::default()).unwrap();
}
cell.blocks = vec![wordcraft_doc::para_block(p)];
}
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let frames: Vec<_> = l.pages[0]
.items
.iter()
.filter_map(|item| if let Placed::Object { rect, wrap: Wrap::BehindText, .. } = item { Some(rect) } else { None })
.collect();
assert_eq!(frames.len(), 2);
assert!((frames[0].y - frames[1].y).abs() < 0.01, "frames must align: {frames:?}");
assert!((frames[0].y - 66.5).abs() < 0.5, "Word frame top: {frames:?}");
}
#[test]
fn section_start_summed_spacing() {
crate::test_fonts();
for summed in [false, true] {
let mut d = Document::from_text("Section end\nSection start");
d.settings.sum_paragraph_spacing = summed;
let first = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
first.props.space_after = Some(10.0);
first.section = Some(Box::default());
let next = d.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
next.props.space_before = Some(24.0);
let l = lay(&d);
let top = l.pages[1]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { path, y, .. } if *path == Path::top(1) => Some(*y),
_ => None,
})
.unwrap();
let gap = if summed { 24.0 } else { 14.0 };
assert!((top - d.last_section.margin_top - gap).abs() < 0.01, "summed={summed}: {top}");
}
}
#[test]
fn partial_margins_inherit() {
crate::test_fonts();
let height = |top, bottom| {
let mut table = Table::new(1, 1, 200.0);
table.props.style = None;
table.props.cell_margins = Some([top, 2.25, bottom, 2.75]);
let cell = &mut table.rows[0].cells[0];
cell.props.margins = None;
cell.props.partial_margins = Some([None, Some(0.0), None, None]);
let mut para = Paragraph::with_text("Point", Default::default());
para.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(11.0));
para.props.space_before = Some(0.0);
para.props.space_after = Some(0.0);
cell.blocks = vec![wordcraft_doc::para_block(para)];
let mut doc = Document::new();
doc.body = vec![std::sync::Arc::new(Block::Table(table))];
let layout = lay(&doc);
layout.pages[0]
.items
.iter()
.find_map(|item| match item {
Placed::Cell { rect, .. } => Some(rect.h),
_ => None,
})
.unwrap()
};
assert!((height(2.75, 2.75) - 16.5).abs() < 0.01);
assert!((height(6.0, 8.0) - 25.0).abs() < 0.01);
}
/// Exact line pitch keeps the text baseline even when an equation has a deep denominator.
#[test]
fn exact_math_keeps_run_baseline() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
for display in [false, true] {
for spacing in [LineSpacing::Exactly(12.0), LineSpacing::AtLeast(12.0), LineSpacing::Multiple(1.0)] {
let mut baseline = Vec::new();
let mut following = Vec::new();
for equation in [None, Some("a/(b/c)")] {
let chr = wordcraft_doc::CharProps { font: Some(wordcraft_doc::styles::BODY_FONT.into()), size: Some(12.0), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::new();
p.props.line_spacing = Some(spacing);
match equation {
None => {
p.insert_text(0, "x", &chr).unwrap();
}
Some(text) => p
.insert_object(
0,
InlineObject::Equation {
linear: text.into(),
display,
math: wordcraft_doc::math::Math { nodes: wordcraft_doc::math::parse_linear(text), ..Default::default() },
},
&chr,
)
.unwrap(),
}
let mut d = Document::from_text("After");
d.body.insert(0, wordcraft_doc::para_block(p));
let l = lay(&d);
let (y, para) = l.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { path, y, para, .. } if *path == Path::top(0) => Some((*y, para)),
_ => None,
})
.unwrap();
baseline.push(y + para.lines[0].baseline);
following.push(para_at(&l, &[1])[0].1);
}
match spacing {
LineSpacing::Exactly(_) => {
assert!((baseline[0] - baseline[1]).abs() < 0.01, "display={display}: {baseline:?}");
assert!((following[0] - following[1]).abs() < 0.01, "fixed pitch: {following:?}");
}
_ => assert!(following[1] > following[0], "minimum pitch grows for math: {following:?}"),
}
}
}
}
#[test]
fn float_font_keeps_line_height() {
crate::test_fonts();
use wordcraft_doc::CharProps;
use wordcraft_doc::para::{Float, Wrap};
let pitch = |wrap, size| {
let small = CharProps { size: Some(9.0), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::with_text("Anchor", small.clone());
p.mark = small;
p.props.space_after = Some(0.0);
p.insert_object(0, picture(1.0, 1.0, Float { wrap, ..Default::default() }), &CharProps { size: Some(size), ..Default::default() }).unwrap();
let mut d = Document::from_text("After");
d.body.insert(0, wordcraft_doc::para_block(p));
let l = lay(&d);
l.caret(&Pos::body(1, 0)).unwrap().top - l.caret(&Pos::body(0, 0)).unwrap().top
};
for wrap in [Wrap::BehindText, Wrap::InFrontOfText] {
assert!((pitch(wrap, 40.0) - pitch(wrap, 9.0)).abs() < 0.01, "{wrap:?}");
}
assert!(pitch(Wrap::Inline, 40.0) > pitch(Wrap::Inline, 9.0));
}
/// Native ink inside a group is drawn as drawing-level ink is: its fallback picture, in its place.
#[test]
fn ink_member_of_a_group_draws_its_fallback_picture() {
crate::test_fonts();
use crate::display::Draw;
use std::sync::Arc;
use wordcraft_doc::graphic::{Graphic, GraphicItem, GraphicKind};
use wordcraft_doc::para::{Float, GroupChild};
let items = vec![GraphicItem::Image { rect: [0.0, 0.0, 60.0, 30.0], media: "preview".into() }];
let ink = InlineObject::Graphic {
w: 60.0,
h: 30.0,
alt: String::new(),
float: Float::default(),
graphic: Arc::new(Graphic { kind: GraphicKind::Ink, items, w: 60.0, h: 30.0, ..Default::default() }),
};
let group = InlineObject::Group {
w: 200.0,
h: 100.0,
float: Float::default(),
ch_w: 200.0,
ch_h: 100.0,
children: vec![GroupChild { x: 20.0, y: 30.0, obj: ink }],
canvas: None,
};
let mut d = Document::from_text("Text by the group.");
d.insert_object(&Pos::body(0, 0), group, &Default::default()).unwrap();
let l = lay(&d);
let frame = l.object(&Pos::body(0, 0), 0).unwrap().rect;
fn images(draws: &[Draw], out: &mut Vec<Rect>) {
for d in draws {
match d {
Draw::Image { rect, media, .. } if media == "preview" => out.push(*rect),
Draw::Rotated { items, .. } | Draw::Clip { items, .. } => images(items, out),
Draw::Figure { draws, .. } => images(draws, out),
_ => {}
}
}
}
let mut found = Vec::new();
images(&crate::display::page_display(&d, &l.pages[0], &Default::default()), &mut found);
let [r] = found.as_slice() else { panic!("ink preview not drawn: {found:?}") };
assert!((r.x - (frame.x + 20.0)).abs() < 0.01 && (r.y - (frame.y + 30.0)).abs() < 0.01, "{r:?} in {frame:?}");
assert!((r.w - 60.0).abs() < 0.01 && (r.h - 30.0).abs() < 0.01, "{r:?}");
}
/// The word being typed gets no spelling squiggle until the caret leaves it (#1552): only in the
/// paragraph with that revision, only spelling, and a change to it lays that one paragraph out
/// again without clearing the cache.
#[test]
fn the_word_being_typed_has_no_spelling_squiggle() {
crate::test_fonts();
let d = Document::from_text("helo wrld\nfine text here");
let rev = d.para(StoryRef::Body, &Path::top(0)).unwrap().rev;
let marks = |l: &DocLayout, grammar: bool| -> Vec<String> {
l.pages[0]
.items
.iter()
.filter_map(|i| match i {
Placed::Lines { para, path, .. } if *path == Path::top(0) => {
Some(para.issues.iter().filter(|i| i.2 == grammar).map(|i| "helo wrld"[i.0..i.1].to_string()).collect::<Vec<_>>())
}
_ => None,
})
.flatten()
.collect()
};
let mut c = LayoutCache::new();
let opts = LayoutOptions { proofing: true, ..LayoutOptions::default() };
let both = layout(&d, &mut c, &opts);
assert_eq!(marks(&both, false), ["helo", "wrld"]);
let misses = c.misses;
// "wrld" is being typed: only "helo" is marked; grammar is as before.
let typing = layout(&d, &mut c, &LayoutOptions { typing_word: Some(TypingWord { rev, start: 5, end: 9 }), ..opts.clone() });
assert_eq!(marks(&typing, false), ["helo"]);
assert_eq!(marks(&typing, true), marks(&both, true));
assert_eq!(c.misses, misses + 1, "only the paragraph with the word is laid out again");
// A range overlapping the word counts too (the checker's word may be longer than the caret's).
let typing = layout(&d, &mut c, &LayoutOptions { typing_word: Some(TypingWord { rev, start: 7, end: 9 }), ..opts.clone() });
assert_eq!(marks(&typing, false), ["helo"]);
// A different paragraph revision leaves everything marked.
let other = layout(&d, &mut c, &LayoutOptions { typing_word: Some(TypingWord { rev: rev.wrapping_add(1), start: 5, end: 9 }), ..opts.clone() });
assert_eq!(marks(&other, false), ["helo", "wrld"]);
// The caret left the word: the layout without the exemption comes back from the cache.
let misses = c.misses;
let left = layout(&d, &mut c, &opts);
assert_eq!(marks(&left, false), ["helo", "wrld"]);
assert_eq!(c.misses, misses);
}
fn cell_break_doc(text: &str) -> Document {
use wordcraft_doc::props::{HeightRule, LineSpacing, VAlign};
let mut d = Document::new();
d.last_section.page_w = 344.0;
d.last_section.margin_left = 72.0;
d.last_section.margin_right = 72.0;
let mut p = Paragraph::with_text(text, CharProps { size: Some(11.0), ..Default::default() });
p.props.line_spacing = Some(LineSpacing::Exactly(12.0));
p.props.space_before = Some(3.0);
p.props.space_after = Some(3.0);
let prefix = text.bytes().take_while(|&c| c == wordcraft_doc::para::PAGE_BREAK as u8 || c == b'\n').count();
p.format(0, prefix, &|props| props.size = Some(3.0)).unwrap();
let mut t = Table::new(1, 1, 200.0);
t.props.cell_margins = Some([0.0; 4]);
t.rows[0].props.height = Some(20.0);
t.rows[0].props.height_rule = HeightRule::AtLeast;
t.rows[0].cells[0].props.valign = Some(VAlign::Center);
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
d.body = vec![Arc::new(Block::Table(t))];
d
}
#[test]
fn cell_breaks_take_no_height() {
crate::test_fonts();
let height = |d: &Document| {
lay(d).pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Cell { rect, .. } => Some(rect.h),
_ => None,
})
.unwrap()
};
let plain = height(&cell_break_doc("Heading"));
for text in ["\u{000c}Heading", "\u{000c}\u{000c}\u{000c}Heading", "Head\u{000c}ing", "Heading\u{000c}\u{000c}\u{000c}", "é\u{000c}界"] {
let d = cell_break_doc(text);
assert_eq!(height(&d), plain, "cell page breaks take no height: {text:?}");
let l = lay(&d);
let para = l.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { para, .. } => Some(para),
_ => None,
})
.unwrap();
assert_eq!(para.lines.len(), 1);
assert!(!para.clusters.iter().any(|c| c.kind == para::ClKind::PageBreak));
for c in ¶.clusters {
assert!(text.is_char_boundary(c.start) && text.is_char_boundary(c.end));
if text.get(c.start..c.end) == Some("\u{000c}") {
assert_eq!(c.kind, para::ClKind::Marker);
}
}
let starts: Vec<_> = para.clusters.iter().filter(|c| c.kind == para::ClKind::Text).map(|c| c.start).collect();
let expected: Vec<_> = text.char_indices().filter_map(|(i, c)| (c != '\u{000c}').then_some(i)).collect();
assert_eq!(starts, expected, "visible clusters retain source offsets");
}
assert!(height(&cell_break_doc("\n\n\nHeading")) > plain, "ordinary line breaks retain their lines");
}
#[test]
fn cell_break_cache_is_scoped() {
crate::test_fonts();
let mut d = cell_break_doc("\u{000c}Heading");
let Block::Table(t) = &*d.body[0] else { panic!("table") };
let p = t.rows[0].cells[0].blocks[0].clone();
d.body.push(p);
assert_eq!(lay(&d).pages.len(), 2, "a reused paragraph's body page break still starts a page");
}
#[test]
fn cell_breaks_with_bookmarks() {
crate::test_fonts();
for offset in [0, 1, 3] {
let mut d = cell_break_doc("\u{000c}\u{000c}\u{000c}Heading");
let Block::Table(t) = Arc::make_mut(&mut d.body[0]) else { panic!("table") };
let Block::Para(p) = Arc::make_mut(&mut t.rows[0].cells[0].blocks[0]) else { panic!("paragraph") };
p.insert_object(offset, InlineObject::BookmarkStart { name: "control".into() }, &Default::default()).unwrap();
let original = p.clone();
let l = lay(&d);
let para = l.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { para, .. } => Some(para),
_ => None,
})
.unwrap();
assert!(!para.clusters.iter().any(|c| c.kind == para::ClKind::PageBreak));
assert_eq!(para.lines.len(), 1);
assert_eq!(para.clusters.iter().find(|c| c.kind == para::ClKind::Text).unwrap().start, 6);
let Block::Table(t) = &*d.body[0] else { panic!("table") };
let Block::Para(p) = &*t.rows[0].cells[0].blocks[0] else { panic!("paragraph") };
assert_eq!(p, &original, "layout preserves bookmark objects and source bytes");
}
}
#[test]
fn cell_break_only_is_marker() {
crate::test_fonts();
let d = cell_break_doc("\u{000c}");
let l = lay(&d);
let para = l.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { para, .. } => Some(para),
_ => None,
})
.unwrap();
assert!(para.clusters.iter().all(|c| c.kind == para::ClKind::Marker));
}
#[test]
fn subpoint_grid_keeps_widths() {
crate::test_fonts();
for gap in [0.05, 0.5, 1.0, 3.0] {
let mut d = Document::new();
let mut table = Table::new(1, 3, 300.0);
table.props.fixed = true;
table.props.width = Some(300.0);
table.grid = vec![100.0, 200.0 - gap, gap];
let row = &mut table.rows[0];
row.props.grid_after = 1;
row.props.w_after = Some(gap);
row.cells.truncate(1);
row.cells[0].props.span = 2;
row.cells[0].props.width = Some(300.0 - gap);
d.body = vec![Arc::new(Block::Table(table))];
let l = lay(&d);
let width = l.pages[0]
.items
.iter()
.find_map(|item| match item {
Placed::Cell { rect, .. } => Some(rect.w),
_ => None,
})
.unwrap();
assert!((width - (300.0 - gap)).abs() < 0.001, "gap {gap}: cell width {width}");
}
}
#[test]
fn invalid_grid_keeps_fallback() {
crate::test_fonts();
for width in [0.0, -1.0, f32::NAN, f32::INFINITY] {
let mut d = Document::new();
let mut table = Table::new(1, 2, 300.0);
table.props.fixed = true;
table.props.width = Some(300.0);
table.grid = vec![width; 2];
for cell in &mut table.rows[0].cells {
cell.props.width = None;
}
d.body = vec![Arc::new(Block::Table(table))];
let l = lay(&d);
let widths: Vec<_> = l.pages[0]
.items
.iter()
.filter_map(|item| match item {
Placed::Cell { rect, .. } => Some(rect.w),
_ => None,
})
.collect();
assert_eq!(widths, [150.0, 150.0], "grid {width}");
}
}
#[test]
fn tiny_grid_scales_to_width() {
crate::test_fonts();
for unit in [0.05, 0.25, 0.5, f32::MIN_POSITIVE, f32::from_bits(1)] {
for ratio in [1.0, 3.0] {
let mut d = Document::new();
let mut table = Table::new(1, 2, 300.0);
table.props.fixed = true;
table.props.width = Some(300.0);
table.grid = vec![unit, unit * ratio];
for cell in &mut table.rows[0].cells {
cell.props.width = None;
}
d.body = vec![Arc::new(Block::Table(table))];
let l = lay(&d);
let widths: Vec<_> = l.pages[0]
.items
.iter()
.filter_map(|item| match item {
Placed::Cell { rect, .. } => Some(rect.w),
_ => None,
})
.collect();
let first = 300.0 / (1.0 + ratio);
assert_eq!(widths.len(), 2);
for (width, want) in widths.iter().zip([first, 300.0 - first]) {
assert!(width.is_finite() && (width - want).abs() < 0.001, "unit {unit}, ratio {ratio}: {widths:?}");
}
}
}
}
fn absolute_footer(text: &str, height: f32) -> Document {
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::TableFloat;
let para = |text| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()));
let mut table = Table::new(1, 1, 468.0);
table.props.float = Some(TableFloat { y: 650.0, h_rel: Anchor::Page, v_rel: Anchor::Page, ..Default::default() });
table.rows[0].props.height = Some(height);
table.rows[0].props.height_rule = wordcraft_doc::props::HeightRule::AtLeast;
table.rows[0].cells[0].blocks = vec![para(text)];
let mut doc = Document::from_text("Body");
let id = doc.add_part(wordcraft_doc::PartKind::Footer, vec![para("Footer label"), Arc::new(Block::Table(table)), para("")]);
doc.last_section.footers.default = Some(id);
doc
}
#[test]
fn footer_absolute_height() {
crate::test_fonts();
let mut base = absolute_footer("", 20.0);
let id = base.last_section.footers.default.unwrap();
base.parts.get_mut(&id).unwrap().blocks.remove(1);
let footer_y = |doc: &Document| {
lay(doc).pages[0]
.footer
.iter()
.find_map(|item| match item {
Placed::Lines { path, y, .. } if *path == Path::top(0) => Some(*y),
_ => None,
})
.unwrap()
};
let expected = footer_y(&base);
// Native original controls keep this anchor with both empty and text-bearing floats.
for text in ["", "Decoration"] {
for height in [20.0, 60.0, 100.0] {
let doc = absolute_footer(text, height);
let actual = footer_y(&doc);
assert!((actual - expected).abs() < 0.01, "{text:?}, height {height}: {actual}, expected {expected}");
let layout = lay(&doc);
let top = layout.pages[0]
.footer
.iter()
.find_map(|item| match item {
Placed::Cell { table, rect, .. } if *table == Path::top(1) => Some(rect.y),
_ => None,
})
.unwrap();
assert!((top - 650.0).abs() < 0.01, "absolute position must survive: {top}");
}
}
}
#[test]
fn footer_float_wraps_body() {
crate::test_fonts();
use wordcraft_doc::props::LineSpacing;
const FLOAT_TOP: f32 = 100.0;
const FLOAT_RIGHT: f32 = 468.0;
for text in ["", "Decoration"] {
for height in [20.0, 60.0, 100.0] {
let mut doc = absolute_footer(text, height);
let id = doc.last_section.footers.default.unwrap();
let Block::Table(table) = Arc::make_mut(&mut doc.parts.get_mut(&id).unwrap().blocks[1]) else { panic!("table") };
table.props.float.as_mut().unwrap().y = FLOAT_TOP;
table.props.float.as_mut().unwrap().x = 0.0;
doc.body = (0..17)
.map(|i| {
let mut p =
wordcraft_doc::Paragraph::with_text(&format!("Body row {i:02}: original footer wrapping control."), Default::default());
p.props = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(LineSpacing::Exactly(24.0)),
..Default::default()
};
wordcraft_doc::para_block(p)
})
.collect();
let layout = lay(&doc);
assert_eq!(layout.pages.len(), 1, "a page float must not cap every body's bottom");
for i in 0..17 {
let lines = line_boxes(&layout, 0, i, doc.last_section.margin_left);
assert!(!lines.is_empty(), "body row {i} vanished");
for &(left, top, right, bottom) in &lines {
if bottom > FLOAT_TOP + 0.01 && top < FLOAT_TOP + height - 0.01 {
assert!(left >= FLOAT_RIGHT - 0.01 || right <= 0.01, "body crosses footer table: {lines:?}");
}
}
}
let after = layout.caret(&Pos::body(16, 0)).unwrap();
assert!((after.x - doc.last_section.margin_left).abs() < 0.01, "body must return below the float");
assert!(after.top > FLOAT_TOP + height);
}
}
}
#[test]
fn footer_table_wrap_bounds() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::{HeightRule, LineSpacing, TableFloat};
const FLOAT_TOP: f32 = 100.0;
const ROW_HEIGHT: f32 = 40.0;
const TABLE_WIDTH: f32 = 468.0;
let mut doc = Document::from_text(&format!("Anchor\n{}", "Original body words ".repeat(60)));
for block in &mut doc.body {
let Block::Para(p) = Arc::make_mut(block) else { panic!("paragraph") };
p.props = ParaProps { space_before: Some(0.0), space_after: Some(0.0), line_spacing: Some(LineSpacing::Exactly(24.0)), ..Default::default() };
}
let mut table = Table::new(2, 2, TABLE_WIDTH);
table.props.cell_margins = Some([0.0; 4]);
table.props.float = Some(TableFloat { y: FLOAT_TOP, h_rel: Anchor::Page, v_rel: Anchor::Page, ..Default::default() });
for row in &mut table.rows {
row.props.height = Some(ROW_HEIGHT);
row.props.height_rule = HeightRule::AtLeast;
}
table.rows[1].cells.truncate(1);
table.rows[1].props.grid_after = 1;
let id = doc.add_part(wordcraft_doc::PartKind::Footer, vec![Arc::new(Block::Table(table))]);
doc.last_section.footers.default = Some(id);
let layout = lay(&doc);
let lines = line_boxes(&layout, 0, 1, doc.last_section.margin_left);
let beside: Vec<_> = lines.iter().filter(|(_, top, _, bottom)| *bottom > FLOAT_TOP + ROW_HEIGHT && *top < FLOAT_TOP + ROW_HEIGHT * 2.0).collect();
assert!(!beside.is_empty());
assert!(beside.iter().all(|(left, _, _, _)| *left >= TABLE_WIDTH - 0.01), "omitted cells must not open a hole in table wrapping: {beside:?}");
}
#[test]
fn header_table_collision() {
crate::test_fonts();
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::{HeightRule, TableFloat};
for (overlap, expected) in [(false, 140.0), (true, 100.0)] {
let mut doc = Document::new();
doc.settings.compat_mode = 15;
let table = |y, height| {
let mut t = Table::new(1, 2, 300.0);
t.props.cell_margins = Some([0.0; 4]);
t.props.float = Some(TableFloat { h_rel: Anchor::Page, v_rel: Anchor::Page, x: 72.0, y, overlap, ..Default::default() });
t.rows[0].props.height = Some(height);
t.rows[0].props.height_rule = HeightRule::Exact;
t
};
let id = doc.add_part(wordcraft_doc::PartKind::Header, vec![Arc::new(Block::Table(table(60.0, 80.0)))]);
doc.last_section.headers.default = Some(id);
doc.body = vec![Arc::new(Block::Table(table(100.0, 48.0)))];
let laid = lay(&doc);
assert_eq!(laid.pages.len(), 1);
for page in &laid.pages {
let top = |items: &[Placed]| {
items
.iter()
.filter_map(|it| match it {
Placed::Cell { rect, .. } => Some(rect.y),
_ => None,
})
.fold(f32::MAX, f32::min)
};
assert!((top(&page.header) - 60.0).abs() < 0.01);
assert!((top(&page.items) - expected).abs() < 0.01, "overlap={overlap}: body top {} expected {expected}", top(&page.items));
}
}
}
const SHARED_BAND: f32 = 2.0;
#[derive(Clone, Copy)]
enum KeepAfter {
Next,
Separate,
}
fn band_row_table(top: Option<Border>) -> Table {
use wordcraft_doc::props::{HeightRule, LineSpacing};
let line = Border { style: BorderStyle::Single, width: SHARED_BAND, color: None, space: 0.0 };
let mut table = Table::new(4, 1, 200.0);
table.props.style = None;
table.props.borders = Some(Borders::default());
table.props.cell_margins = Some([0.0; 4]);
for (i, row) in table.rows.iter_mut().enumerate() {
row.props.height = Some(20.0);
row.props.height_rule = HeightRule::AtLeast;
row.props.cant_split = true;
row.cells[0].props.borders = Some(Borders { top: if i == 0 { Some(line) } else { top }, bottom: Some(line), ..Default::default() });
let mut para = Paragraph::with_text("Original cell", Default::default());
para.props =
ParaProps { space_before: Some(0.0), space_after: Some(0.0), line_spacing: Some(LineSpacing::Exactly(10.0)), ..Default::default() };
row.cells[0].blocks = vec![wordcraft_doc::para_block(para)];
}
table
}
#[test]
fn shared_band_row_minimum() {
crate::test_fonts();
let hidden = Border { style: BorderStyle::None, width: 0.0, color: None, space: 0.0 };
let shown = Border { style: BorderStyle::Single, width: SHARED_BAND, color: None, space: 0.0 };
// The previous row already paints the shared edge. Its band still clears the next cell.
for top in [None, Some(hidden), Some(shown)] {
let mut doc = Document::new();
doc.body = vec![std::sync::Arc::new(Block::Table(band_row_table(top)))];
let laid = lay(&doc);
let heights: Vec<_> = laid.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Cell { rect, table, .. } if *table == Path::top(0) => Some(rect.h),
_ => None,
})
.collect();
assert_eq!(heights, [22.0, 22.0, 22.0, 24.0], "top {top:?}");
}
}
#[test]
fn shared_band_carries_heading() {
crate::test_fonts();
use wordcraft_doc::props::{HeightRule, LineSpacing};
for (page_height, heading_page) in [(150.0, 1), (156.0, 0)] {
let mut doc = Document::new();
doc.last_section.page_h = page_height;
doc.last_section.margin_top = 20.0;
doc.last_section.margin_bottom = 20.0;
let para = |text: &str, height, keep: KeepAfter| {
let mut p = Paragraph::with_text(text, Default::default());
p.props = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(LineSpacing::Exactly(height)),
keep_next: Some(matches!(keep, KeepAfter::Next)),
..Default::default()
};
wordcraft_doc::para_block(p)
};
let mut next = Table::new(1, 1, 200.0);
next.props.style = None;
next.props.borders = Some(Borders::default());
next.props.cell_margins = Some([0.0; 4]);
next.rows[0].props.height = Some(60.0);
next.rows[0].props.height_rule = HeightRule::Exact;
doc.body = vec![
std::sync::Arc::new(Block::Table(band_row_table(None))),
para("", 5.0, KeepAfter::Separate),
para("Heading", 10.0, KeepAfter::Next),
para("", 8.0, KeepAfter::Separate),
std::sync::Arc::new(Block::Table(next)),
];
let laid = lay(&doc);
assert_eq!(laid.pages.len(), 2);
assert_eq!(laid.caret(&Pos::body(2, 0)).unwrap().page, heading_page);
assert!(laid.pages[1].items.iter().any(|it| matches!(it, Placed::Cell { table, .. } if *table == Path::top(4))));
}
}
#[test]
fn shared_band_exact_rows() {
crate::test_fonts();
let mut table = band_row_table(None);
for row in &mut table.rows {
row.props.height_rule = wordcraft_doc::props::HeightRule::Exact;
}
let mut doc = Document::new();
doc.body = vec![std::sync::Arc::new(Block::Table(table))];
let laid = lay(&doc);
let heights: Vec<_> = laid.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Cell { rect, .. } => Some(rect.h),
_ => None,
})
.collect();
assert_eq!(heights, [20.0; 4]);
}
#[test]
fn shared_band_borderless() {
crate::test_fonts();
let mut table = band_row_table(None);
for row in &mut table.rows {
row.cells[0].props.borders = Some(Borders::default());
}
let mut doc = Document::new();
doc.body = vec![std::sync::Arc::new(Block::Table(table))];
let laid = lay(&doc);
let heights: Vec<_> = laid.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Cell { rect, .. } => Some(rect.h),
_ => None,
})
.collect();
assert_eq!(heights, [20.0; 4]);
assert!(!laid.pages[0].items.iter().any(|it| matches!(it, Placed::Rule { .. })));
}
#[test]
fn shared_band_merge_boundary() {
crate::test_fonts();
use wordcraft_doc::props::VMerge;
let mut table = band_row_table(None);
table.rows[0].cells[0].props.vmerge = VMerge::Restart;
table.rows[1].cells[0].props.vmerge = VMerge::Continue;
let mut doc = Document::new();
doc.body = vec![std::sync::Arc::new(Block::Table(table))];
let laid = lay(&doc);
let cells: Vec<_> = laid.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Cell { rect, row, covered, .. } => Some((*row, rect.h, *covered)),
_ => None,
})
.collect();
assert_eq!(cells, [(0, 42.0, false), (1, 20.0, true), (2, 22.0, false), (3, 24.0, false)]);
}
#[test]
fn shared_band_grid_spans() {
crate::test_fonts();
let mut table = band_row_table(None);
table.rows.truncate(2);
table.grid = vec![100.0; 3];
table.props.width = Some(300.0);
table.props.fixed = true;
let cell = table.rows[0].cells[0].clone();
table.rows[0].cells = vec![cell.clone(), cell.clone(), cell];
for cell in &mut table.rows[0].cells {
cell.props.width = Some(100.0);
}
table.rows[0].cells[1].props.borders.as_mut().unwrap().bottom = Some(Border::single(6.0));
table.merge_right(0, 1, 1);
let mut cell = table.rows[1].cells[0].clone();
cell.props.width = Some(100.0);
cell.props.borders.as_mut().unwrap().bottom = Some(Border::single(1.0));
table.rows[1].cells = vec![cell.clone(), cell.clone(), cell];
table.merge_right(1, 0, 1);
let mut doc = Document::new();
doc.body = vec![std::sync::Arc::new(Block::Table(table))];
let laid = lay(&doc);
let height = laid.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Cell { rect, row: 1, .. } => Some(rect.h),
_ => None,
})
.unwrap();
assert_eq!(height, 27.0);
}
#[test]
fn caret_height_ignores_line_spacing() {
crate::test_fonts();
// #2920: extra line spacing is leading below the text; the caret stays the height of the font.
use wordcraft_doc::props::LineSpacing;
let caret_height = |spacing: Option<LineSpacing>| {
let mut d = Document::new();
let chr = wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(12.0), ..Default::default() };
let mut p = wordcraft_doc::Paragraph::with_text("Alpha probe", chr);
p.props = ParaProps { line_spacing: spacing, ..Default::default() };
d.body = vec![wordcraft_doc::para_block(p)];
lay(&d).caret(&Pos::body(0, 3)).unwrap().height
};
let single = caret_height(Some(LineSpacing::Multiple(1.0)));
for spacing in [LineSpacing::Multiple(2.0), LineSpacing::AtLeast(40.0), LineSpacing::Exactly(40.0)] {
let wide = caret_height(Some(spacing));
assert!((single - wide).abs() < 0.01, "{spacing:?}: single {single}, wide {wide}");
}
}
#[test]
fn bottom_border_reserves_gap() {
use wordcraft_doc::props::{BorderStyle, Borders};
for part in [None, Some(wordcraft_doc::PartKind::Header), Some(wordcraft_doc::PartKind::Footer)] {
let mut positions = Vec::new();
for style in [BorderStyle::None, BorderStyle::Single] {
let mut d = Document::from_text("First\nNext");
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props.borders =
Some(Borders { bottom: Some(Border { style, width: 0.5, space: 2.0, color: None }), ..Default::default() });
if let Some(kind) = part {
let id = d.add_part(kind, d.body.clone());
d.body = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("Body", Default::default()))];
match kind {
wordcraft_doc::PartKind::Header => d.last_section.headers.default = Some(id),
_ => d.last_section.footers.default = Some(id),
}
}
let l = lay(&d);
let items = match part {
Some(wordcraft_doc::PartKind::Header) => &l.pages[0].header,
Some(_) => &l.pages[0].footer,
None => &l.pages[0].items,
};
let top = |block| {
items
.iter()
.find_map(|it| match it {
Placed::Lines { path, y, .. } if *path == Path::top(block) => Some(*y),
_ => None,
})
.unwrap()
};
positions.push(top(1) - top(0));
}
assert!((positions[1] - positions[0] - 2.5).abs() < 0.01, "{part:?}: {positions:?}");
}
}
#[test]
fn bottom_border_keeps_chain() {
use wordcraft_doc::props::LineSpacing;
const LINE_HEIGHT: f32 = 12.0;
for bordered in [1, 2] {
for style in [BorderStyle::None, BorderStyle::Single] {
let mut d = Document::from_text("Filler\nHeading\nRuled\nBody");
// Four 12pt lines fit; the border band makes the kept chain exceed the remainder.
d.last_section.page_h = d.last_section.margin_top + d.last_section.margin_bottom + 4.0 * LINE_HEIGHT + 1.0;
for block in 0..4 {
let p = d.para_mut(StoryRef::Body, &Path::top(block)).unwrap();
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p.props.line_spacing = Some(LineSpacing::Exactly(LINE_HEIGHT));
p.props.keep_next = Some(block == 1 || block == 2);
if block == bordered {
p.props.borders = Some(Borders { bottom: Some(Border { style, width: 0.5, space: 2.0, color: None }), ..Default::default() });
}
}
let laid = lay(&d);
let heading_page = laid
.pages
.iter()
.position(|page| page.items.iter().any(|item| matches!(item, Placed::Lines { path, .. } if *path == Path::top(1))))
.unwrap();
assert_eq!(heading_page, usize::from(style == BorderStyle::Single), "bordered={bordered}, {style:?}");
}
}
}
#[test]
fn border_break_keeps_preflight() {
use wordcraft_doc::para::PAGE_BREAK;
use wordcraft_doc::props::LineSpacing;
const BODY_HEIGHT: f32 = 160.0;
const MARGIN: f32 = 20.0;
const LINE_HEIGHT: f32 = 10.0;
const BORDER_GAP: f32 = 20.0;
let make_para = |text: &str| {
let chr = wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(10.0), ..Default::default() };
let mut p = Paragraph::with_text(text, chr);
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p.props.line_spacing = Some(LineSpacing::Exactly(LINE_HEIGHT));
p.props.keep_lines = Some(true);
p.props.keep_next = Some(false);
p.props.borders =
Some(Borders { bottom: Some(Border { style: BorderStyle::Single, width: 1.0, space: BORDER_GAP, color: None }), ..Default::default() });
p
};
let fitting = format!("One{PAGE_BREAK}");
let tall = format!("One\nTwo{PAGE_BREAK}");
let mut measured = Document::new();
measured.body = vec![wordcraft_doc::para_block(make_para(&fitting))];
let l = lay(&measured);
let room = l.pages[0]
.items
.iter()
.find_map(|it| match it {
Placed::Lines { para, .. } => Some(para.height),
_ => None,
})
.unwrap();
assert!(room > 0.0 && room + BORDER_GAP + 1.0 < BODY_HEIGHT);
for (text, expected) in [(fitting.as_str(), 0), (tall.as_str(), 1), ("One", 1)] {
let mut d = Document::new();
d.last_section.margin_top = MARGIN;
d.last_section.margin_bottom = MARGIN;
d.last_section.page_h = BODY_HEIGHT + 2.0 * MARGIN;
let mut filler = Paragraph::with_text("Filler", Default::default());
filler.props.space_before = Some(0.0);
filler.props.space_after = Some(0.0);
filler.props.line_spacing = Some(LineSpacing::Exactly(BODY_HEIGHT - room));
let mut after = Paragraph::with_text("After", Default::default());
after.props.space_before = Some(0.0);
after.props.space_after = Some(0.0);
after.props.line_spacing = Some(LineSpacing::Exactly(LINE_HEIGHT));
d.body = vec![wordcraft_doc::para_block(filler), wordcraft_doc::para_block(make_para(text)), wordcraft_doc::para_block(after)];
let l = lay(&d);
assert_eq!(l.caret(&Pos::body(1, 0)).unwrap().page, expected, "{text:?}: omit only the terminal break border extent");
let pieces: Vec<_> = l
.pages
.iter()
.enumerate()
.filter_map(|(page, p)| p.items.iter().any(|it| matches!(it, Placed::Lines { path, .. } if *path == Path::top(1))).then_some(page))
.collect();
assert_eq!(pieces, vec![expected], "{text:?}: keep the paragraph whole");
}
}
enum SpanWidth {
Preferred,
Automatic,
TextOnly,
}
fn banner_layout(width: SpanWidth) -> DocLayout {
let widths = [150.0, 100.0, 25.0, 25.0];
let mut d = Document::new();
let mut t = Table::new(2, widths.len(), 300.0);
t.grid = widths.to_vec();
t.props.width = match width {
SpanWidth::Preferred => Some(300.0),
SpanWidth::Automatic | SpanWidth::TextOnly => None,
};
t.props.cell_margins = Some([0.0; 4]);
t.rows[0].cells.truncate(1);
t.rows[0].cells[0].props.span = 4;
t.rows[0].cells[0].props.width = t.props.width;
let mut banner = wordcraft_doc::Paragraph::new();
if !matches!(width, SpanWidth::TextOnly) {
banner.insert_object(0, picture(300.0, 30.0, Default::default()), &Default::default()).unwrap();
}
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(banner)];
for (i, cell) in t.rows[1].cells.iter_mut().enumerate() {
cell.props.width = match width {
SpanWidth::Preferred => Some(widths[i]),
SpanWidth::Automatic | SpanWidth::TextOnly => None,
};
cell.blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("A", Default::default()))];
}
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
lay(&d)
}
#[test]
fn spanning_banner_uses_weights() {
let text = banner_layout(SpanWidth::TextOnly);
let minimum = text.pages[0]
.items
.iter()
.find_map(|item| match item {
Placed::Cell { rect, row: 1, .. } => Some(rect.w),
_ => None,
})
.unwrap();
let widths = [150.0 - minimum, 100.0 - minimum / 3.0, 25.0 + 2.0 * minimum / 3.0, 25.0 + 2.0 * minimum / 3.0];
let l = banner_layout(SpanWidth::Preferred);
let actual: Vec<_> =
l.pages[0].items.iter().filter_map(|it| if let Placed::Cell { rect, row: 1, .. } = it { Some(rect.w) } else { None }).collect();
assert_eq!(actual.len(), widths.len());
for (got, want) in actual.iter().zip(widths) {
assert!((got - want).abs() < 0.01, "spanning banner changed columns: {actual:?}");
}
}
#[test]
fn automatic_banner_shares_width() {
let l = banner_layout(SpanWidth::Automatic);
let widths: Vec<_> =
l.pages[0].items.iter().filter_map(|it| if let Placed::Cell { rect, row: 1, .. } = it { Some(rect.w) } else { None }).collect();
assert_eq!(widths.len(), 4);
assert!(widths.iter().all(|w| (w - 75.0).abs() < 0.01), "automatic widths: {widths:?}");
}
#[test]
fn nested_spans_use_grid_weights() {
const NESTED_WIDTH: f32 = 40.0;
const IMAGE_WIDTH: f32 = 50.0;
const OUTER_WIDTH: f32 = 51.0;
let widths: Vec<_> = [0.0, 4.0]
.into_iter()
.map(|first| {
let mut nested = Table::new(2, 3, NESTED_WIDTH);
nested.props.style = None;
nested.props.width = Some(NESTED_WIDTH);
nested.props.cell_margins = Some([0.0; 4]);
nested.grid = vec![first, 100.0, 100.0];
for (index, row) in nested.rows.iter_mut().enumerate() {
row.cells.truncate(1);
row.props.grid_before = index as u32;
row.cells[0].props.span = 2;
row.cells[0].props.width = None;
let mut p = Paragraph::new();
p.insert_object(0, picture(IMAGE_WIDTH, 10.0, Default::default()), &Default::default()).unwrap();
row.cells[0].blocks = vec![wordcraft_doc::para_block(p)];
}
let mut outer = Table::new(1, 1, OUTER_WIDTH);
outer.props.style = None;
outer.props.width = Some(OUTER_WIDTH);
outer.props.cell_margins = Some([0.0; 4]);
outer.rows[0].cells[0].blocks = vec![Arc::new(Block::Table(nested))];
let mut d = Document::new();
d.body = vec![Arc::new(Block::Table(outer))];
lay(&d).pages[0]
.items
.iter()
.find_map(|item| match item {
Placed::Cell { rect, table, .. } if table.0 == [0] => Some(rect.w),
_ => None,
})
.unwrap()
})
.collect();
assert!(widths[1] > OUTER_WIDTH + 0.5, "overlapping spans must expand the outer table: {widths:?}");
assert!((widths[0] - widths[1]).abs() < 0.01, "equivalent nested grids changed outer fitting: {widths:?}");
}
/// #2048: a picture anchored in a later paragraph but placed higher up the page (fixed on the
/// page, or moved up from its paragraph) keeps the text of the paragraphs above its anchor clear
/// too, as in Word, not just its own paragraph's.
#[test]
fn a_float_placed_above_its_anchor_wraps_the_paragraphs_before_it() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let text = "Earlier text flows beside the picture placed above its anchor. ".repeat(3);
for (v_rel, y) in [(Anchor::Page, 72.0), (Anchor::Paragraph, -200.0)] {
let mut d = Document::from_text(&format!("{text}\n{text}\n{text}\n\nThe anchor paragraph."));
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel, x: 0.0, y, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(4, 0), rect_shape(150.0, 260.0, f), &Default::default()).unwrap();
let l = lay(&d);
let r = shapes(&l.pages[0].items)[0];
assert!(r.y < 150.0, "{v_rel:?}: the picture is above its anchor: {r:?}");
let mut checked = 0;
for it in &l.pages[0].items {
let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, x, y: top, .. } = it else { continue };
for ln in ¶.lines[*l0..*l1] {
let (lt, lb) = (top + ln.top, top + ln.top + ln.height);
if lb > r.y + 0.5 && lt < r.bottom() - 0.5 && ln.c1 > ln.c0 {
checked += 1;
assert!(x + ln.left >= r.right() - 0.5, "{v_rel:?}: paragraph {path:?}, line at {lt}, runs under the picture {r:?}");
}
}
}
assert!(checked >= 6, "{v_rel:?}: {checked} lines beside the picture");
}
}
/// The first line of body text running under a shape on any page of `l`, and how many shapes.
fn text_under_shapes(l: &DocLayout) -> (Option<String>, usize) {
let mut seen = 0;
for (pi, page) in l.pages.iter().enumerate() {
for r in shapes(&page.items) {
seen += 1;
for it in &page.items {
let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, x, y: top, .. } = it else { continue };
for ln in ¶.lines[*l0..*l1] {
let (lt, lb) = (top + ln.top, top + ln.top + ln.height);
if lb > r.y + 0.5 && lt < r.bottom() - 0.5 && ln.c1 > ln.c0 && x + ln.left < r.right() - 0.5 {
return (Some(format!("page {pi}: paragraph {path:?}, line at {lt}, runs under the picture {r:?}")), seen);
}
}
}
}
}
(None, seen)
}
/// A square-wrapped 150 x 260 picture fixed on the page at `y`, anchored in the last paragraph
/// (at `anchor`) after paragraphs of `text`.
fn picture_above_anchor(text: &str, anchor: usize, y: f32) -> Document {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text(&format!("{}The anchor paragraph.", format!("{text}\n").repeat(anchor)));
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Page, x: 0.0, y, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(anchor, 0), rect_shape(150.0, 260.0, f), &Default::default()).unwrap();
d
}
/// Wrapping the text above around this picture pushes its anchor paragraph onto the next page.
fn early_float_across_pages() -> Document {
picture_above_anchor(&"Earlier text must stay clear of the anchored picture while pagination moves its paragraph. ".repeat(4), 7, 72.0)
}
/// #2048 (review): when wrapping the text above around a float pushes its anchor paragraph onto
/// the next page, the layout still settles with no text under the float on any page, rather
/// than handing back a pass laid out for a placement the float no longer has.
#[test]
fn early_float_wrap_stays_valid_across_page_boundaries() {
let (under, n) = text_under_shapes(&lay(&early_float_across_pages()));
assert_eq!(under, None);
assert_eq!(n, 1, "the picture is placed once");
}
/// #2048 (review): the same picture anchored after 4 to 18 such paragraphs, so its anchor lands
/// on the first page, at the page break or past it: no text runs under it on any page.
#[test]
fn early_float_wrap_stays_valid_wherever_the_page_breaks() {
let text = "Earlier text must stay clear of the anchored picture while pagination moves its paragraph. ".repeat(4);
for count in 4..=18 {
let (under, n) = text_under_shapes(&lay(&picture_above_anchor(&text, count, 72.0)));
assert_eq!(under, None, "{count} paragraphs before the anchor");
assert_eq!(n, 1, "{count} paragraphs before the anchor: the picture is placed once");
}
}
/// #2048 (review): a pass with no passes left for floats above their anchors (here none known
/// from the page's start) still keeps them clear of the text laid out before them: the float
/// moves down to its paragraph rather than over that text.
#[test]
fn last_rewrap_pass_keeps_early_floats_clear_of_text() {
let one_page = picture_above_anchor(&"Earlier text flows beside the picture placed above its anchor. ".repeat(3), 4, 72.0);
for d in [one_page, early_float_across_pages()] {
let totals = Totals::first_guess(d.sections().len());
let pass = layout_pass(
&d,
&mut LayoutCache::new(),
&LayoutOptions::default(),
(&HashMap::new(), None),
&totals,
false,
(&EarlyFloats::new(), false),
);
let Pass::Done(l) = pass else { panic!("a last pass is done") };
let (under, n) = text_under_shapes(&l);
assert_eq!(under, None);
assert_eq!(n, 1);
}
}
/// Two unequal columns (260 and 172 pt): `before` paragraphs of earlier text, a paragraph
/// ending in a column break first when `skip_first_column`, then an anchor paragraph holding a
/// 100 x 200 picture (wrapped `wrap`) fixed on the page at the column's top, and a column break
/// into the other column (#2048 review).
fn early_float_with_column_break(skip_first_column: bool, wrap: wordcraft_doc::para::Wrap) -> Document {
use wordcraft_doc::para::{Anchor, Float};
let brk = wordcraft_doc::para::COLUMN_BREAK;
let earlier = "Earlier text in this column flows beside the picture above its anchor. ".repeat(2);
let after = "Text after the column break is broken for the width of its own column. ".repeat(4);
let mut paras = Vec::new();
if skip_first_column {
paras.push(format!("The first column.{brk}"));
}
paras.extend(std::iter::repeat_n(earlier, 3));
paras.push(format!("The anchor paragraph.{brk}{after}"));
let anchor = paras.len() - 1;
let mut d = Document::from_text(¶s.join("\n"));
d.last_section.columns = wordcraft_doc::section::Columns { count: 2, space: 36.0, separator: false, widths: vec![(260.0, 36.0), (172.0, 0.0)] };
let f = Float { wrap, h_rel: Anchor::Column, v_rel: Anchor::Page, x: 0.0, y: 72.0, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(anchor, 0), rect_shape(100.0, 200.0, f), &Default::default()).unwrap();
d
}
/// Where each body line on page `page` of `l` right of `min_x` goes: its left, top and length.
fn line_spots(l: &DocLayout, page: usize, min_x: f32) -> Vec<(i32, i32, usize)> {
let mut v = Vec::new();
for it in &l.pages[page].items {
let Placed::Lines { story: StoryRef::Body, para, l0, l1, x, y, .. } = it else { continue };
for ln in ¶.lines[*l0..*l1] {
if x + ln.left >= min_x {
v.push(((x + ln.left).round() as i32, (y + ln.top).round() as i32, ln.c1 - ln.c0));
}
}
}
v
}
/// #2048 (review): an anchor paragraph whose picture sits above it and that breaks into a column
/// of another width (on its page, or from the last column onto the next page) keeps the earlier
/// text on the picture's page clear of it, and wraps nothing around it where it isn't drawn.
#[test]
fn early_float_survives_a_column_break_into_another_width() {
use wordcraft_doc::para::Wrap;
// (anchor in the second column, so the break goes onto the next page; where the text after the
// break goes: page and the left of its column)
for (skip, page, min_x) in [(false, 0, 72.0 + 260.0 + 36.0), (true, 1, 72.0)] {
let l = lay(&early_float_with_column_break(skip, Wrap::Square));
let drawn: Vec<Rect> = l.pages.iter().flat_map(|pg| shapes(&pg.items)).collect();
let [r] = drawn[..] else { panic!("second column first: {skip}: the picture is placed once: {drawn:?}") };
assert_eq!(shapes(&l.pages[0].items), vec![r], "second column first: {skip}: on the first page");
// The lines in the picture's column (they start right of the other one) beside it start
// right of it.
let mut beside = 0;
for it in &l.pages[0].items {
let Placed::Lines { story: StoryRef::Body, path, para, l0, l1, x, y, .. } = it else { continue };
for ln in ¶.lines[*l0..*l1] {
let (lt, lb) = (y + ln.top, y + ln.top + ln.height);
if lb > r.y + 0.5 && lt < r.bottom() - 0.5 && ln.c1 > ln.c0 && x + ln.left > r.x - 1.0 {
beside += 1;
assert!(x + ln.left >= r.right() - 0.5, "second column first: {skip}: {path:?}, line at {lt}, runs under the picture {r:?}");
}
}
}
assert!(beside >= 6, "second column first: {skip}: {beside} lines beside the picture");
let plain = lay(&early_float_with_column_break(skip, Wrap::InFrontOfText));
let (got, want) = (line_spots(&l, page, min_x), line_spots(&plain, page, min_x));
assert!(!want.is_empty(), "second column first: {skip}: text after the break");
assert_eq!(got, want, "second column first: {skip}: the text after the break wraps around nothing");
}
}
/// A table with its own width keeps it when it is over 1.5 times the text width (#1721); one
/// without is still squeezed to the margins.
#[test]
fn table_with_its_own_width_is_not_squeezed_to_the_margins() {
let text = |s: &str| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(s, Default::default()));
let second_column_x = |own: Option<f32>| {
let mut t = Table::new(1, 3, 936.0);
t.props.width = own;
t.rows[0].cells[1].blocks = vec![text("Address")];
let mut d = Document::from_text("After");
d.insert_block(StoryRef::Body, &Path::top(0), wordcraft_doc::Block::Table(t)).unwrap();
let l = lay(&d);
let [(x, _, _)] = para_at(&l, &[0, 0, 1, 0])[..] else { panic!("second cell missing") };
x
};
// 936pt (twice the 468pt of text) of its own: the columns stay 312pt wide, past the margin.
let x = second_column_x(Some(936.0));
assert!(x > 72.0 + 300.0, "the second column starts at {x}, squeezed");
// The same columns with an automatic table width are squeezed to 156pt each.
let x = second_column_x(None);
assert!(x < 72.0 + 200.0, "the second column starts at {x}, not squeezed");
}
/// Cut marks: page-anchored rules thinner than a point keep their height (Word draws a 0.25 pt
/// rectangle 0.25 pt high), and a flat `line` stays flat instead of running down a point.
#[test]
fn anchored_objects_thinner_than_a_point_keep_their_size() {
use wordcraft_doc::para::{Anchor, Float, ShapeKind, Wrap};
let float = |y: f32| Float { wrap: Wrap::InFrontOfText, h_rel: Anchor::Page, v_rel: Anchor::Page, x: 72.0, y, ..Default::default() };
let mut d = Document::from_text("Rules");
for (i, h) in [0.25f32, 0.5, 1.0, 2.0].into_iter().enumerate() {
d.insert_object(&Pos::body(0, 0), rect_shape(200.0, h, float(100.0 + 20.0 * i as f32)), &Default::default()).unwrap();
}
let line = |w: f32, h: f32, y: f32| InlineObject::Shape {
kind: ShapeKind::Line,
w,
h,
fill: None,
stroke: Some(Rgb::BLACK),
stroke_width: 0.25,
float: float(y),
story: None,
freeform: None,
effects: Default::default(),
extra: Default::default(),
};
d.insert_object(&Pos::body(0, 0), line(200.0, 0.0, 220.0), &Default::default()).unwrap();
d.insert_object(&Pos::body(0, 0), line(0.0, 100.0, 300.0), &Default::default()).unwrap();
let draws = flat(display::page_display(&d, &lay(&d).pages[0], &Default::default()));
let mut rects: Vec<(ShapeKind, Rect)> =
draws.iter().filter_map(|x| if let display::Draw::Shape { rect, kind, .. } = x { Some((*kind, *rect)) } else { None }).collect();
rects.sort_by(|a, b| a.1.y.total_cmp(&b.1.y));
let got: Vec<(f32, f32, f32, f32)> = rects.iter().map(|(_, r)| (r.x, r.y, r.w, r.h)).collect();
let want = [
(72.0, 100.0, 200.0, 0.25),
(72.0, 120.0, 200.0, 0.5),
(72.0, 140.0, 200.0, 1.0),
(72.0, 160.0, 200.0, 2.0),
(72.0, 220.0, 200.0, 0.0),
(72.0, 300.0, 0.0, 100.0),
];
assert_eq!(got.len(), want.len(), "{rects:?}");
for (g, w) in got.iter().zip(want) {
assert!((g.0 - w.0).abs() < 1e-3 && (g.1 - w.1).abs() < 1e-3 && (g.2 - w.2).abs() < 1e-3 && (g.3 - w.3).abs() < 1e-3, "{g:?} != {w:?}");
}
}
#[test]
fn keep_next_counts_list_indent() {
use wordcraft_doc::props::{LineSpacing, NumRef};
let mut doc = Document::new();
doc.last_section.page_w = 240.0;
doc.last_section.page_h = 200.0;
doc.last_section.margin_top = 20.0;
doc.last_section.margin_bottom = 20.0;
doc.last_section.margin_left = 20.0;
doc.last_section.margin_right = 20.0;
let id = Arc::make_mut(&mut doc.numbering).add_list(wordcraft_doc::ListKind::Numbered);
let level = &mut Arc::make_mut(&mut doc.numbering).abstracts[0].levels[0];
level.indent = 100.0;
level.hanging = 0.0;
let props = ParaProps {
space_before: Some(0.0),
space_after: Some(0.0),
line_spacing: Some(LineSpacing::Exactly(12.0)),
widow_control: Some(true),
..Default::default()
};
let para = |text: &str, props: ParaProps| {
let mut p =
Paragraph::with_text(text, wordcraft_doc::CharProps { font: Some("Source Sans 3".into()), size: Some(12.0), ..Default::default() });
p.props = props;
wordcraft_doc::para_block(p)
};
doc.body = vec![
para("Filler", ParaProps { line_spacing: Some(LineSpacing::Exactly(136.0)), ..props.clone() }),
para("Heading", ParaProps { keep_next: Some(true), keep_lines: Some(true), ..props.clone() }),
para("Alpha beta gamma delta", ParaProps { numbering: Some(NumRef { num: id, level: 0 }), ..props }),
];
let layout = lay(&doc);
assert_eq!(layout.caret(&Pos::body(2, 0)).unwrap().page, 1, "the indented list cannot start below the heading");
assert_eq!(layout.caret(&Pos::body(1, 0)).unwrap().page, 1, "the kept heading must follow it");
let labels: Vec<_> = layout
.pages
.iter()
.flat_map(|p| &p.items)
.filter_map(|item| match item {
Placed::Lines { para, .. } => para.label.as_ref().map(|label| label.text.as_str()),
_ => None,
})
.collect();
assert_eq!(labels, ["1."], "lookahead must not consume a list counter");
}
/// #2712: Word breaks a line right after a hyphen followed by a digit ("2016-" / "2022"), where
/// UAX #14 keeps the hyphen and the number together. Sweeping the text width, the first width
/// that wraps `Deed 2016-2022` must break after the hyphen -- not move the range whole (the
/// break lands at the space) and not split it inside a number.
#[test]
fn a_hyphen_before_digits_is_a_break_opportunity_like_word() {
for m in 100..=540 {
let margin_right = m as f32;
let text = "Deed 2016-2022";
let mut d = Document::from_text(text);
d.last_section.margin_right = margin_right;
let l = lay(&d);
let line_texts = |l: &DocLayout| -> Vec<String> {
l.pages[0]
.items
.iter()
.filter_map(|it| {
if let Placed::Lines { para, l0, l1, .. } = it {
Some(para.lines[*l0..*l1].iter().map(|line| text[line.start..line.stop].to_string()).collect::<Vec<_>>())
} else {
None
}
})
.flatten()
.collect()
};
let lines = line_texts(&l);
if lines.len() < 2 {
continue; // still fits on one line at this width
}
assert_eq!(lines[0], "Deed 2016-", "the first wrap breaks after the hyphen: {lines:?}");
assert_eq!(lines[1], "2022", "the range continues after it: {lines:?}");
return;
}
panic!("no width in the sweep wrapped the paragraph");
}
/// #2712 scopes the new break to U+002D: a non-breaking hyphen (U+2011) and a minus sign
/// (U+2212) gain no break, so the first wrap moves the range whole, breaking at the space.
#[test]
fn a_non_breaking_hyphen_and_a_minus_sign_stay_unbreakable() {
for (token, hyphen) in [("2016\u{2011}2022", '\u{2011}'), ("2016\u{2212}2022", '\u{2212}')] {
let text = format!("Deed {token}");
for m in 100..=540 {
let mut d = Document::from_text(&text);
d.last_section.margin_right = m as f32;
let l = lay(&d);
let lines: Vec<String> = l.pages[0]
.items
.iter()
.filter_map(|it| {
if let Placed::Lines { para, l0, l1, .. } = it {
Some(para.lines[*l0..*l1].iter().map(|line| text[line.start..line.stop].to_string()).collect::<Vec<_>>())
} else {
None
}
})
.flatten()
.collect();
if lines.len() < 2 {
continue; // still fits on one line at this width
}
// The first wrap breaks at the space: the protected hyphen is not a break. (Narrower
// widths fall into the break-anywhere fallback that splits too-long words between
// characters, which the sweep leaves out, as the issue does.)
assert_eq!(lines[0], "Deed ", "the only break is at the space, not after {hyphen}: {lines:?}");
assert_eq!(lines[1], token, "the range stays whole: {lines:?}");
break;
}
}
}
/// #3408: Word breaks a compound right after a hyphen that a slash follows ("Dataprotection-" /
/// "/Secrecyviolation"), where UAX #14 forbids a break before the slash. The first width that
/// wraps must break after the hyphen, not move the compound whole, and the slash stays with its
/// word. Table auto-fit reads the same break, so such a column no longer widens to the compound.
/// Word keeps "fitness-/1589" whole: a slash before a digit gains no break.
#[test]
fn a_hyphen_before_a_slash_is_a_break_opportunity_like_word() {
let digits = "Deed fitness-/1589";
let mut wrapped = false;
for m in 100..=540 {
let mut d = Document::from_text(digits);
d.last_section.margin_right = m as f32;
let l = lay(&d);
let lines: Vec<&str> = l.pages[0]
.items
.iter()
.filter_map(|it| if let Placed::Lines { para, l0, l1, .. } = it { Some(¶.lines[*l0..*l1]) } else { None })
.flatten()
.map(|line| &digits[line.start..line.stop])
.collect();
if lines.len() >= 2 {
assert_eq!(lines, ["Deed ", "fitness-/1589"], "the first wrap breaks at the space, not after the hyphen");
wrapped = true;
break;
}
}
assert!(wrapped, "no width in the sweep wrapped the digit case");
let text = "Deed Dataprotection-/Secrecyviolation";
for m in 100..=540 {
let mut d = Document::from_text(text);
d.last_section.margin_right = m as f32;
let l = lay(&d);
let lines: Vec<String> = l.pages[0]
.items
.iter()
.filter_map(|it| {
if let Placed::Lines { para, l0, l1, .. } = it {
Some(para.lines[*l0..*l1].iter().map(|line| text[line.start..line.stop].to_string()).collect::<Vec<_>>())
} else {
None
}
})
.flatten()
.collect();
if lines.len() < 2 {
continue; // still fits on one line at this width
}
assert_eq!(lines[0], "Deed Dataprotection-", "the first wrap breaks after the hyphen: {lines:?}");
assert_eq!(lines[1], "/Secrecyviolation", "the slash starts the next line with its word: {lines:?}");
return;
}
panic!("no width in the sweep wrapped the paragraph");
}
/// docxide-pdf `dot-open-token*`: UAX #14 allows a break between a full stop and an opening
/// parenthesis, Word doesn't. The first width that wraps `Deed 2023.(Example` breaks at the space.
#[test]
fn a_full_stop_before_a_parenthesis_is_no_break() {
let text = "Deed 2023.(Example";
for m in 100..=540 {
let mut d = Document::from_text(text);
d.last_section.margin_right = m as f32;
let l = lay(&d);
let lines: Vec<String> = l.pages[0]
.items
.iter()
.filter_map(|it| {
if let Placed::Lines { para, l0, l1, .. } = it {
Some(para.lines[*l0..*l1].iter().map(|line| text[line.start..line.stop].to_string()).collect::<Vec<_>>())
} else {
None
}
})
.flatten()
.collect();
if lines.len() < 2 {
continue; // still fits on one line at this width
}
assert_eq!(lines, ["Deed ", "2023.(Example"], "the first wrap breaks at the space");
return;
}
panic!("no width in the sweep wrapped the paragraph");
}
#[test]
fn layout_cache_invalidates_on_changed_filename() {
let mut doc = Document::new();
let mut p = Paragraph::new();
p.insert_object(
0,
InlineObject::Field { instr: "FILENAME".into(), result: String::new(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
doc.body = vec![wordcraft_doc::para_block(p)];
let shown = |l: &DocLayout| -> String {
l.pages[0]
.items
.iter()
.find_map(|it| if let Placed::Lines { para, .. } = it { para.shown.first().map(|s| s.1.clone()) } else { None })
.unwrap_or_default()
};
let mut cache = LayoutCache::new();
let opts_a = LayoutOptions { filename: Some(Arc::from("a.docx")), filepath: Some(Arc::from("/docs/a.docx")), ..Default::default() };
let l_a = layout(&doc, &mut cache, &opts_a);
let text_a = shown(&l_a);
assert_eq!(text_a, "a.docx", "first layout shows a.docx");
let opts_b = LayoutOptions { filename: Some(Arc::from("b.docx")), filepath: Some(Arc::from("/docs/b.docx")), ..Default::default() };
let l_b = layout(&doc, &mut cache, &opts_b);
let text_b = shown(&l_b);
assert_eq!(text_b, "b.docx", "second layout with same cache shows b.docx");
}
#[test]
fn layout_cache_invalidates_on_changed_filepath() {
let mut doc = Document::new();
let mut p = Paragraph::new();
p.insert_object(
0,
InlineObject::Field { instr: r"FILENAME \p".into(), result: String::new(), locked: false, dirty: false, code: false, form: String::new() },
&Default::default(),
)
.unwrap();
doc.body = vec![wordcraft_doc::para_block(p)];
let shown = |l: &DocLayout| -> String {
l.pages[0]
.items
.iter()
.find_map(|it| if let Placed::Lines { para, .. } = it { para.shown.first().map(|s| s.1.clone()) } else { None })
.unwrap_or_default()
};
let mut cache = LayoutCache::new();
let opts_a = LayoutOptions { filename: Some(Arc::from("a.docx")), filepath: Some(Arc::from("/path/one/a.docx")), ..Default::default() };
let l_a = layout(&doc, &mut cache, &opts_a);
let text_a = shown(&l_a);
assert_eq!(text_a, "/path/one/a.docx", "first layout shows /path/one/a.docx");
let opts_b = LayoutOptions { filename: Some(Arc::from("a.docx")), filepath: Some(Arc::from("/path/two/a.docx")), ..Default::default() };
let l_b = layout(&doc, &mut cache, &opts_b);
let text_b = shown(&l_b);
assert_eq!(text_b, "/path/two/a.docx", "second layout with same cache shows /path/two/a.docx");
}
/// Keep with next takes the same 0.01 pt of slack as the other fit checks: a kept paragraph and
/// the next one's first line that fill the page to within it stay on the page.
#[test]
fn keep_with_next_fits_to_the_hundredth_of_a_point() {
use wordcraft_doc::props::LineSpacing;
let exact =
|h: f32| ParaProps { space_before: Some(0.0), space_after: Some(0.0), line_spacing: Some(LineSpacing::Exactly(h)), ..Default::default() };
let mut d = Document::from_text("Filler\nKept\nNext");
let body = d.last_section.page_h - d.last_section.margin_top - d.last_section.margin_bottom;
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().props = exact(body - 24.0 + 0.005);
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().props = ParaProps { keep_next: Some(true), ..exact(12.0) };
d.para_mut(StoryRef::Body, &Path::top(2)).unwrap().props = exact(12.0);
let l = lay(&d);
assert_eq!(l.caret(&Pos::body(1, 0)).unwrap().page, 0, "the kept paragraph stays on the first page");
assert_eq!(l.caret(&Pos::body(2, 0)).unwrap().page, 0, "and so does the next one's first line");
}
/// A table of `rows` one-line rows with `border`-wide borders after `fill` filler lines.
fn ruled_table(fill: usize, rows: usize, border: f32) -> Document {
let mut d = Document::from_text("filler\n".repeat(fill).trim_end());
let mut t = Table::new(rows, 1, 468.0);
t.props.style = None;
t.props.borders = Some(Borders::all(Border::single(border)));
for row in &mut t.rows {
row.cells[0].blocks = vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text("row", Default::default()))];
}
d.insert_block(StoryRef::Body, &Path::top(fill), wordcraft_doc::Block::Table(t)).unwrap();
d
}
/// A row that another row follows needs the border below it on the page too, as in Word: the
/// last row on a page ends at least that border's width above the bottom margin (a row ending
/// 0.05 pt short of the margin with a 0.5 pt border under it moves on). Swept over the filler
/// lines above the table, so the row nearest the margin lands at every offset from it.
#[test]
fn a_row_leaves_room_for_the_border_below_it() {
for border in [0.5f32, 3.0] {
for fill in 20..40 {
let d = ruled_table(fill, 80, border);
let l = lay(&d);
let bottom = d.last_section.page_h - d.last_section.margin_bottom;
let end = l.pages[0]
.items
.iter()
.filter_map(|it| if let Placed::Cell { rect, .. } = it { Some(rect.bottom()) } else { None })
.fold(0.0f32, f32::max);
assert!(end + border <= bottom + 0.02, "border {border}, {fill} filler lines: the last row ends at {end}, the margin at {bottom}");
}
}
}
/// A horizontal rule (VML `o:hr`) takes its whole line and is drawn across its share of it,
/// placed by its alignment (Word, measured: 50 % centred, left, right). In a table cell it
/// follows its column instead of widening the table.
#[test]
fn horizontal_rules_take_their_line() {
use wordcraft_doc::connector::HorizontalRule;
use wordcraft_doc::props::Align;
let rule = |pct: f32, align: Align| {
let mut o = rect_shape(0.0, 1.5, Default::default());
if let InlineObject::Shape { extra, .. } = &mut o {
extra.hr = Some(HorizontalRule { pct, align, standard: true });
}
o
};
let drawn = |d: &Document| -> Vec<wordcraft_geom::Rect> {
let l = lay(d);
display::page_display(d, &l.pages[0], &display::DisplayOptions::default())
.iter()
.filter_map(
|i| if let display::Draw::Shape { rect, kind: wordcraft_doc::para::ShapeKind::Rectangle, .. } = i { Some(*rect) } else { None },
)
.collect()
};
let mut d = Document::from_text("a\nb");
d.insert_object(&Pos::body(1, 0), rule(50.0, Align::Center), &Default::default()).unwrap();
d.insert_object(&Pos::body(0, 0), rule(100.0, Align::Left), &Default::default()).unwrap();
let s = drawn(&d);
let (full, half) = (s[0], s[1]);
assert!(full.w > 400.0, "the whole line: {full:?}");
assert!((half.w - full.w / 2.0).abs() < 0.01 && (half.x - (full.x + full.w / 4.0)).abs() < 0.01, "{half:?} in {full:?}");
let mut cell = Table::new(1, 1, 200.0);
let mut p = Paragraph::default();
p.insert_object(0, rule(100.0, Align::Left), &Default::default()).unwrap();
cell.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
d.body = vec![Arc::new(Block::Table(cell))];
let s = drawn(&d);
assert!(s.first().is_some_and(|r| r.w > 150.0 && r.w < 200.0), "the cell's width, not the page's: {s:?}");
// Word's numbers (A4, 1 inch margins, a 100 pt float): beside a float a rule keeps its width
// and is placed in what the line has left, a first-line indent moving the end of that room
// along, so a whole-line rule runs past the margin as in Word.
let beside = |pct: f32, align: Align, side: Option<f32>, first: f32| {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let mut d = Document::from_text("a");
if first != 0.0 {
let mut p = d.body[0].as_para().unwrap().clone();
p.props.indent_first = Some(first);
d.body[0] = Arc::new(Block::Para(p));
}
d.insert_object(&Pos::body(0, 0), rule(pct, align), &Default::default()).unwrap();
if let Some(x) = side {
let f = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x, dist: 9.0, ..Default::default() };
d.insert_object(&Pos::body(0, 0), rect_shape(100.0, 100.0, f), &Default::default()).unwrap();
}
let l = lay(&d);
display::page_display(&d, &l.pages[0], &display::DisplayOptions::default())
.iter()
.find_map(|i| match i {
display::Draw::Shape { rect, kind: wordcraft_doc::para::ShapeKind::Rectangle, .. } if rect.h < 10.0 => {
Some((rect.x, rect.x + rect.w))
}
_ => None,
})
.unwrap()
};
let (x0, x1) = beside(100.0, Align::Left, None, 0.0);
let (tw, half) = (x1 - x0, (x1 - x0) / 2.0);
let near =
|got: (f32, f32), want: (f32, f32)| assert!((got.0 - want.0).abs() < 0.5 && (got.1 - want.1).abs() < 0.5, "{got:?}, Word's rule {want:?}");
// A float on the left: the room is from past it to the margin.
let lo = x0 + 109.0;
near(beside(50.0, Align::Left, Some(0.0), 0.0), (lo, lo + half));
near(beside(50.0, Align::Center, Some(0.0), 0.0), ((lo + x1 - half) / 2.0, (lo + x1 + half) / 2.0));
near(beside(50.0, Align::Right, Some(0.0), 0.0), (x1 - half, x1));
near(beside(100.0, Align::Left, Some(0.0), 0.0), (lo, lo + tw));
// A float on the right: from the margin to before it.
let hi = x1 - 109.0;
near(beside(50.0, Align::Center, Some(tw - 100.0), 0.0), ((x0 + hi - half) / 2.0, (x0 + hi + half) / 2.0));
near(beside(50.0, Align::Right, Some(tw - 100.0), 0.0), (hi - half, hi));
near(beside(100.0, Align::Left, Some(tw - 100.0), 0.0), (x0, x1));
// A first-line indent moves the room along.
near(beside(100.0, Align::Left, None, 36.0), (x0 + 36.0, x1 + 36.0));
near(beside(50.0, Align::Center, None, 36.0), (x0 + 36.0 + half / 2.0, x1 + 36.0 - half / 2.0));
near(beside(50.0, Align::Right, None, 36.0), (x1 + 36.0 - half, x1 + 36.0));
// Measuring a table column: a rule of its own width asks for it, a share of the line for none.
let measured = |pct: f32| {
let mut o = rect_shape(150.0, 1.5, Default::default());
if let InlineObject::Shape { extra, .. } = &mut o {
extra.hr = Some(HorizontalRule { pct, align: Align::Left, standard: false });
}
let mut t = Table::new(1, 1, 200.0);
let mut p = Paragraph::default();
p.insert_object(0, o, &Default::default()).unwrap();
t.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(p)];
crate::autofit_widths(&crate::measure_table_columns(&d, &t), 451.0)[0]
};
assert!(measured(0.0) >= 150.0, "{}", measured(0.0));
assert!(measured(100.0) < 150.0, "{}", measured(100.0));
}
/// A line's height with pictures raised or lowered and with legacy check boxes, in Word's numbers
/// (Arial at 10 and 20 pt, single, 1.15 and 1.5 spacing).
#[test]
fn lowered_pictures_and_check_boxes_take_words_line_heights() {
use wordcraft_doc::props::LineSpacing;
// A paragraph at `m` spacing from a lead, a picture and how far its run is raised: the line's
// height, its picture's top under the line's, and the font's height.
let line_of = |lead: &str, m: f32, h: f32, raise: f32| {
let mut d = Document::from_text(lead);
let props = wordcraft_doc::CharProps { position: Some(raise), ..Default::default() };
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.props.line_spacing = Some(LineSpacing::Multiple(m));
let at = p.len();
p.insert_object(at, picture(40.0, h, Default::default()), &props).unwrap();
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let c = para.clusters.iter().find(|c| matches!(c.kind, para::ClKind::Object(_))).unwrap();
let (line, st) = (¶.lines[0], ¶.styles[c.style as usize]);
(line.height, line.baseline - c.obj_h.max(0.0) - line.top, st.ascent + st.descent)
};
for m in [1.0, 1.15, 1.5] {
let share = |font: f32| (m - 1.0) * font;
// Alone, lowered or not: the picture's height and the spacing's share, its top the line's.
for lowered in [0.0, 10.0, 30.0] {
let (h, top, font) = line_of("", m, 30.0, -lowered);
assert!((h - 30.0 - share(font)).abs() < 0.01 && top.abs() < 0.01, "lowered {lowered} at {m}: {h}, {top}");
}
// Raised: as far as it reaches.
let (h, top, font) = line_of("", m, 30.0, 10.0);
assert!((h - 40.0 - share(font)).abs() < 0.01 && top.abs() < 0.01, "raised at {m}: {h}, {top}");
// Shorter than the font: the font's height, and it ends at the font's bottom.
for (raise, reach) in [(0.0, 6.0), (-3.0, 6.0), (3.0, 9.0)] {
let (h, top, font) = line_of("", m, 6.0, raise);
assert!((h - font * m).abs() < 0.01 && (top - (font - reach)).abs() < 0.01, "{raise} at {m}: {h}, {top}");
}
// Lowered further than its height: as far down as it's lowered, the font's height at least,
// its top on the baseline (Word: a 6 pt picture lowered 10 pt takes the font's 11.5 pt,
// lowered 30 pt 30 pt; beside text, the text's ascent and the 30 pt).
let (h, top, font) = line_of("", m, 6.0, -10.0);
assert!((h - font * m).abs() < 0.01 && (top - (font - 10.0)).abs() < 0.01, "6 lowered 10 at {m}: {h}, {top}");
let (h, top, font) = line_of("", m, 6.0, -30.0);
assert!((h - 30.0 - share(font)).abs() < 0.01 && top.abs() < 0.01, "6 lowered 30 at {m}: {h}, {top}");
let (h, top, font) = line_of("x", m, 6.0, -30.0);
let asc = h - 30.0 - share(font);
assert!(asc > 0.0 && asc < font && (top - asc).abs() < 0.01, "6 lowered 30 beside text at {m}: {h}, {top}");
// Beside text, lowered: the text's ascent is no matter, the picture reaching further.
let (h, top, font) = line_of("x", m, 30.0, -10.0);
assert!((h - 30.0 - share(font)).abs() < 0.01 && top.abs() < 0.01, "beside text at {m}: {h}, {top}");
}
// Exact spacing keeps the line's box and its baseline: a picture lowered past its height sits
// where one lowered by its height does.
let exact = |raise: f32| {
let mut d = Document::from_text("x");
let props = wordcraft_doc::CharProps { position: Some(raise), ..Default::default() };
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.props.line_spacing = Some(LineSpacing::Exactly(20.0));
let at = p.len();
p.insert_object(at, picture(40.0, 6.0, Default::default()), &props).unwrap();
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
(para.lines[0].height, para.lines[0].baseline - para.lines[0].top)
};
let (h, base) = exact(-6.0);
assert!((h - 20.0).abs() < 0.01, "{h}");
assert_eq!(exact(-30.0), (h, base));
// A check box sizes its line as text of its size, alone or beside text.
let box_line = |lead: &str, m: f32, size: u32| {
let mut d = Document::from_text(lead);
let form = format!(r#"<w:ffData><w:name w:val="Box"/><w:checkBox><w:size w:val="{size}"/></w:checkBox></w:ffData>"#);
let field = InlineObject::Field { instr: "FORMCHECKBOX".into(), result: String::new(), locked: false, dirty: false, code: false, form };
let props = wordcraft_doc::CharProps { size: Some(10.0), ..Default::default() };
let p = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
p.props.line_spacing = Some(LineSpacing::Multiple(m));
let at = p.len();
p.insert_object(at, field, &props).unwrap();
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
let c = para.clusters.iter().find(|c| matches!(c.kind, para::ClKind::Object(_))).unwrap();
let st = ¶.styles[c.style as usize];
(para.lines[0].height, st.ascent + st.descent)
};
for m in [1.0, 1.5] {
let (h, font) = box_line("", m, 40);
assert!((h - font * 2.0 * m).abs() < 0.01, "a 20 pt box in 10 pt text at {m}: {h}, font {font}");
}
}
/// A line of only a picture (and spaces) ends at the picture's bottom; with text beside the
/// picture the text's descent goes below it too (Word, measured with Aptos, Arial and Times New
/// Roman at 10 and 20 pt: a 30 pt picture alone or after spaces takes 30 pt at single spacing,
/// after a word 30 pt plus the descent).
#[test]
fn a_line_of_only_pictures_takes_no_descent() {
use wordcraft_doc::props::LineSpacing;
let line_of = |lead: &str| {
let mut d = Document::from_text(lead);
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.props.line_spacing = Some(LineSpacing::Multiple(1.0));
let at = p.len();
p.insert_object(at, picture(60.0, 30.0, Default::default()), &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
(para.lines[0].height, para.lines[0].baseline - para.lines[0].top, para.styles[0].descent)
};
for lead in ["", " "] {
let (h, base, _) = line_of(lead);
assert!((h - 30.0).abs() < 0.01 && (base - 30.0).abs() < 0.01, "{lead:?}: line {h}, baseline {base}");
}
let (h, base, desc) = line_of("Text ");
assert!((h - (30.0 + desc)).abs() < 0.01 && (base - 30.0).abs() < 0.01, "with text: line {h}, baseline {base}");
// A line break ending the picture's line is no text.
let mut d = Document::from_text("");
if let Some(wordcraft_doc::Block::Para(p)) = d.body.get_mut(0).map(std::sync::Arc::make_mut) {
p.props.line_spacing = Some(LineSpacing::Multiple(1.0));
p.insert_object(0, picture(60.0, 30.0, Default::default()), &Default::default()).unwrap();
let at = p.len();
p.insert_text(at, &format!("{}Next", wordcraft_doc::para::LINE_BREAK), &Default::default()).unwrap();
}
let l = lay(&d);
let Some(Placed::Lines { para, .. }) = l.pages[0].items.iter().find(|i| matches!(i, Placed::Lines { .. })) else { panic!() };
assert!(para.lines.len() == 2 && (para.lines[0].height - 30.0).abs() < 0.01, "picture, then a line break: {}", para.lines[0].height);
}
/// A kept-together paragraph starting a continuous section low on a page, with room there for
/// one of its lines, moves whole to the next page, where it fits (#3907 review).
#[test]
fn kept_lines_at_a_low_continuous_section_move_to_the_next_page() {
use wordcraft_doc::props::LineSpacing;
use wordcraft_doc::section::{SectionProps, SectionStart};
let fill = 53; // 53 lines of 12 pt leave one line of a 648 pt body
let text = format!("{}{}", "x\n".repeat(fill), "word ".repeat(40));
let mut d = Document::from_text(&text);
for i in 0..=fill {
let p = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
p.props.line_spacing = Some(LineSpacing::Exactly(12.0));
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
}
d.para_mut(StoryRef::Body, &Path::top(fill - 1)).unwrap().section =
Some(Box::new(SectionProps { start: SectionStart::Continuous, ..Default::default() }));
d.last_section.start = SectionStart::Continuous;
let kept = d.para_mut(StoryRef::Body, &Path::top(fill)).unwrap();
kept.props.keep_lines = Some(true);
kept.props.widow_control = Some(false);
let l = lay(&d);
let last_x = l.caret(&Pos::body(fill - 1, 0)).unwrap();
let first = l.caret(&Pos::body(fill, 0)).unwrap();
assert_eq!(last_x.page, 0, "the filler fits on page 1: {last_x:?}");
assert_eq!(first.page, 1, "kept paragraph moves whole: {first:?}");
}
/// A kept-together paragraph in a continuous section is measured against the page it would move
/// to, not the one it starts on: below a tall different first-page header it doesn't fit page 1's
/// body but does page 2's, so it moves there whole (#3907 CodeRabbit).
#[test]
fn kept_lines_below_a_tall_first_page_header_move_whole_to_page_two() {
use wordcraft_doc::props::LineSpacing;
use wordcraft_doc::section::SectionStart;
let exact = |p: &mut wordcraft_doc::Paragraph, h: f32| {
p.props.line_spacing = Some(LineSpacing::Exactly(h));
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p.props.widow_control = Some(false);
};
let kept_text = "word ".repeat(300);
// How tall the kept paragraph is (its line count depends on the fonts; 12 pt lines).
let mut probe = Document::from_text(&kept_text);
exact(probe.para_mut(StoryRef::Body, &Path::top(0)).unwrap(), 12.0);
let pl = lay(&probe);
let end = pl.caret(&Pos::body(0, kept_text.len())).unwrap();
assert_eq!(end.page, 0, "{end:?}");
let h = end.top + 12.0 - pl.caret(&Pos::body(0, 0)).unwrap().top;
let mut d = Document::from_text(&format!("x\n{kept_text}"));
let s = d.last_section.clone();
let (bottom, full) = (s.page_h - s.margin_bottom, s.page_h - s.margin_bottom - s.margin_top);
assert!(h > 120.0 && h + 12.0 < full, "kept paragraph {h} fits a plain page of {full}");
// The first section's first-page header leaves page 1, below the 12 pt filler, room for all
// but 36 pt of the kept paragraph.
let header_h = bottom - 12.0 - (h - 36.0) - s.header;
let mut head = wordcraft_doc::Paragraph::with_text("Title", Default::default());
exact(&mut head, header_h);
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(head)]);
let mut first_sect = s.clone();
first_sect.title_page = true;
first_sect.headers.first = Some(id);
let filler = d.para_mut(StoryRef::Body, &Path::top(0)).unwrap();
exact(filler, 12.0);
filler.section = Some(Box::new(first_sect));
d.last_section.start = SectionStart::Continuous;
let kept = d.para_mut(StoryRef::Body, &Path::top(1)).unwrap();
exact(kept, 12.0);
kept.props.keep_lines = Some(true);
let l = lay(&d);
let filler = l.caret(&Pos::body(0, 0)).unwrap();
assert_eq!(filler.page, 0, "{filler:?}");
assert!(filler.top > s.margin_top + 100.0, "the tall header pushes page 1's body down: {filler:?}");
let (first, last) = (l.caret(&Pos::body(1, 0)).unwrap(), l.caret(&Pos::body(1, kept_text.len())).unwrap());
assert_eq!((first.page, last.page), (1, 1), "kept paragraph whole on page 2: {first:?} .. {last:?}");
}
/// Sections starting continuously one after another still go onto new pages: a paragraph that
/// doesn't fit below the text above it moves on rather than running off the page (#3907). A
/// hundred one-line sections lay out like a hundred plain paragraphs.
#[test]
fn continuous_sections_running_off_a_page_go_onto_the_next() {
use wordcraft_doc::section::{SectionProps, SectionStart};
let marks = 100;
let text = format!("Start\n{}End", "x\n".repeat(marks));
let mut d = Document::from_text(&text);
for i in 1..=marks {
d.para_mut(StoryRef::Body, &Path::top(i)).unwrap().section =
Some(Box::new(SectionProps { start: SectionStart::Continuous, ..Default::default() }));
}
d.last_section.start = SectionStart::Continuous;
let end = lay(&d).caret(&Pos::body(marks + 1, 0)).unwrap();
let plain = lay(&Document::from_text(&text)).caret(&Pos::body(marks + 1, 0)).unwrap();
assert!(end.page > 0, "End past the first page: {end:?}");
assert_eq!((end.page, (end.top * 10.0).round()), (plain.page, (plain.top * 10.0).round()), "sections {end:?}, plain {plain:?}");
}
/// Bulleted empty marks past a full page's bottom draw nothing there, not even their bullets;
/// those that fit keep theirs (#3907 review: a stray bullet below the column).
#[test]
fn stacked_marks_past_the_bottom_draw_no_label() {
use wordcraft_doc::ListKind;
use wordcraft_doc::section::{SectionProps, SectionStart};
let marks = 100;
let mut d = Document::from_text(&format!("Start\n{}End", "\n".repeat(marks)));
let id = Arc::make_mut(&mut d.numbering).add_list(ListKind::Bullet);
for i in 1..=marks {
let p = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
p.section = Some(Box::new(SectionProps { start: SectionStart::Continuous, ..Default::default() }));
p.props.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 });
}
d.last_section.start = SectionStart::Continuous;
let l = lay(&d);
let page = &l.pages[0];
let bottom = page.body.y + page.body.h;
let (mut inside, mut below) = (0, 0);
for it in &page.items {
let Placed::Lines { para, y, .. } = it else { continue };
if para.label.is_none() {
continue;
}
if *y < bottom - 0.01 { inside += 1 } else { below += 1 }
}
assert!(inside > 10, "marks that fit keep their bullets: {inside}");
// Nor their line numbers (CodeRabbit).
for i in 1..=marks {
if let Some(s) = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap().section.as_mut() {
s.line_numbers = Some(Default::default());
}
}
d.last_section.line_numbers = Some(Default::default());
let numbered = lay(&d);
let page = &numbered.pages[0];
let low = page.items.iter().filter(|it| matches!(it, Placed::Lines { story, y, .. } if *story == DECOR_STORY && *y >= bottom - 0.01)).count();
assert_eq!(low, 0, "no line number at or below the body's bottom ({bottom})");
assert!(page.items.iter().any(|it| matches!(it, Placed::Lines { story, .. } if *story == DECOR_STORY)), "the marks that fit are numbered");
assert_eq!(below, 0, "no bullet at or below the body's bottom ({bottom})");
assert_eq!(l.caret(&Pos::body(marks + 1, 0)).unwrap().page, 1, "End still starts page 2");
}
/// An empty mark after a text paragraph that itself closes a continuous section takes no room,
/// as after any text: only marks after an empty mark stack (#3907 review).
#[test]
fn an_empty_mark_after_a_text_section_mark_stays_quiet() {
use wordcraft_doc::section::{SectionProps, SectionStart};
let gap = |text_closes: bool| {
let mut d = Document::from_text("Start\n\nEnd");
let cont = || Some(Box::new(SectionProps { start: SectionStart::Continuous, ..Default::default() }));
if text_closes {
d.para_mut(StoryRef::Body, &Path::top(0)).unwrap().section = cont();
}
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().section = cont();
d.last_section.start = SectionStart::Continuous;
let l = lay(&d);
l.caret(&Pos::body(2, 0)).unwrap().top - l.caret(&Pos::body(0, 0)).unwrap().top
};
assert!((gap(true) - gap(false)).abs() < 0.01, "text closing a section: {}, plain text: {}", gap(true), gap(false));
}
/// dpkruse's Genuine Steps Certificate (#3907 review): a bulleted text paragraph closes a
/// two-column continuous section, then an empty bulleted paragraph closes another. Word draws no
/// bullet for the empty one wherever the text above ends, down to the foot of the page.
#[test]
fn an_empty_bulleted_mark_after_a_bulleted_section_closer_draws_no_bullet() {
use wordcraft_doc::ListKind;
use wordcraft_doc::section::{SectionProps, SectionStart};
for filler in (40..140).step_by(3) {
let mut d = Document::from_text(&format!("{}file this form\n\nFailure to comply", "Instructions\n".repeat(filler)));
let id = Arc::make_mut(&mut d.numbering).add_list(ListKind::Bullet);
let mut two = SectionProps { start: SectionStart::Continuous, ..Default::default() };
two.columns.count = 2;
for i in [filler, filler + 1] {
let p = d.para_mut(StoryRef::Body, &Path::top(i)).unwrap();
p.section = Some(Box::new(two.clone()));
p.props.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 });
}
d.last_section.start = SectionStart::Continuous;
let l = lay(&d);
let bullets = l
.pages
.iter()
.flat_map(|page| &page.items)
.filter(|it| matches!(it, Placed::Lines { path, para, .. } if *path == Path::top(filler + 1) && para.label.is_some()))
.count();
assert_eq!(bullets, 0, "{filler} lines above: the empty mark draws no bullet");
let text = l
.pages
.iter()
.flat_map(|page| &page.items)
.any(|it| matches!(it, Placed::Lines { path, para, .. } if *path == Path::top(filler) && para.label.is_some()));
assert!(text, "{filler} lines above: the text closer keeps its bullet");
}
}
/// A page break before the first row's paragraph moves the whole table to a new page (Word's
/// behaviour; an ODT table starting a page opens so), unless the table is at a page's top.
#[test]
fn a_page_break_in_a_tables_first_row_moves_the_table() {
let mut d = Document::from_text("Before the table.");
let mut table = Table::new(1, 1, 468.0);
let mut first = wordcraft_doc::Paragraph::with_text("First cell", Default::default());
first.props.page_break_before = Some(true);
table.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(first)];
d.body.push(std::sync::Arc::new(wordcraft_doc::Block::Table(table.clone())));
let l = lay(&d);
assert_eq!(l.pages.len(), 2, "the table starts page two");
// At the top of the document it starts no extra page.
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(table))];
assert_eq!(lay(&d).pages.len(), 1);
}
#[test]
fn a_cells_background_picture_is_drawn_clipped_to_the_cell() {
// An ODF cell's background picture: once at its own size at the cell's top left, under the
// text and cut off at the cell's edges; tiled, as many copies as cover the cell.
use wordcraft_doc::props::{CellPicture, PictureRepeat};
let mut d = Document::new();
let mut t = wordcraft_doc::Table::new(1, 1, 200.0);
let media = d.add_media(vec![0u8; 8], "png");
let pic = |repeat| Some(Box::new(CellPicture { media: media.clone(), size: [30.0, 6.0], repeat, align: [0.0, 0.0] }));
t.rows[0].cells[0].props.picture = pic(PictureRepeat::None);
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t.clone())), wordcraft_doc::para_block(wordcraft_doc::Paragraph::new())];
let clips = |l: &DocLayout| -> Vec<(Rect, Vec<Rect>)> {
l.pages[0]
.items
.iter()
.filter_map(|it| match it {
Placed::Clip { rect, items, .. } => {
Some((*rect, items.iter().filter_map(|i| if let Placed::Image { rect, .. } = i { Some(*rect) } else { None }).collect()))
}
_ => None,
})
.collect()
};
let c = clips(&lay(&d));
assert_eq!(c.len(), 1);
let (cell, images) = &c[0];
assert_eq!(images.len(), 1);
assert!(
(images[0].x - cell.x).abs() < 0.01 && (images[0].y - cell.y).abs() < 0.01 && (images[0].w - 30.0).abs() < 0.01,
"{images:?} in {cell:?}"
);
t.rows[0].cells[0].props.picture = pic(PictureRepeat::Tile);
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t)), wordcraft_doc::para_block(wordcraft_doc::Paragraph::new())];
let c = clips(&lay(&d));
let (cell, images) = &c[0];
let want = (cell.w / 30.0).ceil() as usize * (cell.h / 6.0).ceil() as usize;
assert_eq!(images.len(), want, "{cell:?}");
// More tiles than are drawn (a small pattern in a big cell): stretched over the whole cell,
// not tiled over its top rows only.
let mut t = wordcraft_doc::Table::new(1, 1, 400.0);
t.rows[0].cells[0].props.picture =
Some(Box::new(CellPicture { media: media.clone(), size: [2.0, 1.0], repeat: PictureRepeat::Tile, align: [0.0, 0.0] }));
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t)), wordcraft_doc::para_block(wordcraft_doc::Paragraph::new())];
let c = clips(&lay(&d));
let (cell, images) = &c[0];
assert!((cell.w / 2.0).ceil() * (cell.h / 1.0).ceil() > 400.0, "{cell:?}");
assert_eq!(images.len(), 1, "{cell:?}");
let i = images[0];
assert!(
(i.x - cell.x).abs() < 0.01 && (i.y - cell.y).abs() < 0.01 && (i.w - cell.w).abs() < 0.01 && (i.h - cell.h).abs() < 0.01,
"{i:?} in {cell:?}"
);
}
#[test]
fn default_tab_stops_count_from_the_indent_in_odt_documents_that_say_so() {
// LibreOffice with `TabsRelativeToIndent` (its default), measured: default stops every
// interval from the paragraph's left indent; the hanging indent still a stop. Word, and ODT
// documents measuring from the margin: from the margin.
let x_of_b = |from_indent: bool, left: f32, first: f32| {
let mut d = Document::from_text("a\tb");
d.settings.default_tab = 36.0;
d.settings.odf = Some(wordcraft_doc::OdfLayout { tabs_from_indent: from_indent });
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(0, 0), &|p| {
p.indent_left = Some(left);
p.indent_first = Some(first);
})
.unwrap();
let l = lay(&d);
l.caret(&Pos::body(0, 2)).unwrap().x - 72.0
};
assert!((x_of_b(true, 17.0, 0.0) - 53.0).abs() < 0.5, "{}", x_of_b(true, 17.0, 0.0));
assert!((x_of_b(false, 17.0, 0.0) - 36.0).abs() < 0.5, "{}", x_of_b(false, 17.0, 0.0));
// Hanging: the indent is the first stop either way.
assert!((x_of_b(true, 85.0, -85.0) - 85.0).abs() < 0.5, "{}", x_of_b(true, 85.0, -85.0));
}
#[test]
fn a_list_item_that_shows_nothing_reports_no_missing_font() {
// Its number is shaped in its mark's font before the paragraph turns out to show nothing
// (#3982): that font isn't shown in another, so it isn't missing from what's drawn.
let mut d = Document::from_text("Alpha\n\nBeta");
let id = std::sync::Arc::make_mut(&mut d.numbering).add_list(wordcraft_doc::ListKind::Numbered);
d.format_paragraphs(&Pos::body(0, 0), &Pos::body(2, 4), &|p| {
p.numbering = Some(wordcraft_doc::props::NumRef { num: id, level: 0 });
})
.unwrap();
let mark = &mut d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().mark;
mark.font = Some("Wordcraft Gone Number Face".into());
let missing = |d: &Document| layout(d, &mut LayoutCache::new(), &LayoutOptions::default()).substituted_fonts();
let shown = missing(&d);
assert!(shown.iter().any(|(f, _)| f == "Wordcraft Gone Number Face"), "a shown number counts: {shown:?}");
d.para_mut(StoryRef::Body, &Path::top(1)).unwrap().mark.hidden = Some(true);
let gone = missing(&d);
assert!(!gone.iter().any(|(f, _)| f == "Wordcraft Gone Number Face"), "{gone:?}");
}
fn boundary_header_para() -> Paragraph {
let mut p = Paragraph::with_text("One\nTwo\nThree\nFour\nFive", Default::default());
p.props.line_spacing = Some(wordcraft_doc::props::LineSpacing::Exactly(10.0));
p.props.space_before = Some(0.0);
p.props.space_after = Some(0.0);
p
}
#[test]
fn header_boundary_pinned() {
use wordcraft_doc::para::{Anchor, Float, FloatAlign, Wrap};
for anchor in [Anchor::Margin, Anchor::Page, Anchor::TopMargin] {
for align in [None, Some(FloatAlign::Center)] {
let mut doc = Document::from_text("Body");
doc.last_section.margin_top = 60.0;
doc.last_section.header = 36.0;
let mut cell = Paragraph::with_text("Cell", Default::default());
let float = Float {
wrap: Wrap::BehindText,
h_rel: Anchor::Page,
v_rel: anchor,
v_align: align,
outside_cell: true,
x: 300.0,
y: -20.0,
..Default::default()
};
cell.insert_object(0, rect_shape(40.0, 10.0, float), &Default::default()).unwrap();
let mut table = Table::new(1, 1, 40.0);
table.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(cell)];
let header = doc.add_part(
wordcraft_doc::PartKind::Header,
vec![wordcraft_doc::para_block(boundary_header_para()), Arc::new(Block::Table(table.clone()))],
);
let footer = doc.add_part(wordcraft_doc::PartKind::Footer, vec![Arc::new(Block::Table(table))]);
doc.last_section.headers.default = Some(header);
doc.last_section.footers.default = Some(footer);
let laid = lay(&doc);
let page = &laid.pages[0];
assert!(page.body.y > doc.last_section.margin_top);
for (items, margin) in [(&page.header, page.body.y), (&page.footer, doc.last_section.margin_top)] {
let (start, extent) = match anchor {
Anchor::Margin => (margin, doc.last_section.page_h - margin - doc.last_section.margin_bottom),
Anchor::TopMargin => (0.0, doc.last_section.margin_top),
_ => (0.0, doc.last_section.page_h),
};
let expected = match align {
Some(FloatAlign::Center) => start + (extent - 10.0) / 2.0,
_ => start - 20.0,
};
let rects = shapes(items);
assert_eq!(rects.len(), 1);
assert!((rects[0].y - expected).abs() < 0.01, "{anchor:?} {align:?}: {:?}, expected {expected}, body {:?}", rects[0], page.body);
let hit = items
.iter()
.find_map(|item| match item {
Placed::Object { rect, .. } => Some(rect),
_ => None,
})
.unwrap();
assert!((hit.y - expected).abs() < 0.01);
}
}
}
}
#[test]
fn header_boundary_obstacle() {
use wordcraft_doc::para::Anchor;
use wordcraft_doc::props::{HeightRule, TableFloat};
const FLOAT_HEIGHT: f32 = 10.0;
for overlap in [false, true] {
let mut doc = Document::from_text("Body");
doc.last_section.margin_top = 60.0;
doc.last_section.header = 36.0;
let mut header_table = Table::new(1, 1, 40.0);
header_table.rows[0].props.height = Some(FLOAT_HEIGHT);
header_table.rows[0].props.height_rule = HeightRule::Exact;
header_table.props.float = Some(TableFloat { h_rel: Anchor::Page, v_rel: Anchor::Margin, x: 300.0, y: -20.0, ..Default::default() });
let id = doc
.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(boundary_header_para()), Arc::new(Block::Table(header_table))]);
doc.last_section.headers.default = Some(id);
let target = lay(&doc).pages[0].body.y - 20.0;
let mut body_table = Table::new(1, 1, 40.0);
body_table.rows[0].props.height = Some(FLOAT_HEIGHT);
body_table.rows[0].props.height_rule = HeightRule::Exact;
body_table.props.float = Some(TableFloat { h_rel: Anchor::Page, v_rel: Anchor::Page, x: 300.0, y: target, overlap, ..Default::default() });
doc.body.insert(0, Arc::new(Block::Table(body_table)));
let laid = lay(&doc);
let page = &laid.pages[0];
let cell = |items: &[Placed]| {
items
.iter()
.find_map(|item| match item {
Placed::Cell { rect, .. } => Some(*rect),
_ => None,
})
.unwrap()
};
let (header, body) = (cell(&page.header), cell(&page.items));
assert!(page.body.y > doc.last_section.margin_top);
assert!((header.y - target).abs() < 0.01);
if overlap {
assert!((body.y - target).abs() < 0.01, "overlap retains requested position: {body:?}");
} else {
assert!(body.y >= header.bottom() - 0.01, "body {body:?} overlaps rendered header {header:?}");
}
}
}
#[test]
fn header_margin_tracks_body_top() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
use wordcraft_doc::props::LineSpacing;
for margin in [60.0, 120.0] {
for anchor in [Anchor::Margin, Anchor::Page, Anchor::Paragraph] {
let mut d = Document::from_text("Body");
d.last_section.margin_top = margin;
d.last_section.header = 36.0;
let mut hp = Paragraph::with_text("One\nTwo\nThree\nFour\nFive", Default::default());
hp.props.line_spacing = Some(LineSpacing::Exactly(10.0));
hp.props.space_before = Some(0.0);
hp.props.space_after = Some(0.0);
let float = Float { wrap: Wrap::BehindText, h_rel: Anchor::Page, v_rel: anchor, x: 300.0, y: -20.0, ..Default::default() };
hp.insert_object(0, rect_shape(40.0, 10.0, float), &Default::default()).unwrap();
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(hp)]);
d.last_section.headers.default = Some(id);
let l = lay(&d);
let page = &l.pages[0];
let expected = match anchor {
Anchor::Margin => page.body.y - 20.0,
Anchor::Page => -20.0,
_ => 16.0,
};
assert!(
(shapes(&page.header)[0].y - expected).abs() < 0.01,
"margin {margin}, anchor {anchor:?}: {:?}, body {:?}",
shapes(&page.header),
page.body
);
}
}
}
#[test]
fn header_anchor_extents_stay() {
use wordcraft_doc::para::{Anchor, Float, FloatAlign, Wrap};
use wordcraft_doc::props::LineSpacing;
for margin in [60.0, 120.0] {
for anchor in
[Anchor::Margin, Anchor::TopMargin, Anchor::InsideMargin, Anchor::Page, Anchor::Paragraph, Anchor::BottomMargin, Anchor::OutsideMargin]
{
for align in [None, Some(FloatAlign::Start), Some(FloatAlign::Center), Some(FloatAlign::End)] {
let mut d = Document::from_text("Body");
d.last_section.margin_top = margin;
d.last_section.header = 36.0;
let mut hp = Paragraph::with_text("One\nTwo\nThree\nFour\nFive", Default::default());
hp.props.line_spacing = Some(LineSpacing::Exactly(10.0));
hp.props.space_before = Some(0.0);
hp.props.space_after = Some(0.0);
let float =
Float { wrap: Wrap::BehindText, h_rel: Anchor::Page, v_rel: anchor, v_align: align, x: 300.0, y: -20.0, ..Default::default() };
hp.insert_object(0, rect_shape(40.0, 10.0, float), &Default::default()).unwrap();
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(hp)]);
d.last_section.headers.default = Some(id);
let l = lay(&d);
let page = &l.pages[0];
if margin == 60.0 {
assert!(page.body.y > margin, "the header must displace the body");
} else {
assert!((page.body.y - margin).abs() < 0.01, "the header must fit within the declared margin");
}
let s = &d.last_section;
let (start, extent) = match anchor {
Anchor::Margin => (page.body.y, s.page_h - page.body.y - s.margin_bottom),
Anchor::TopMargin | Anchor::InsideMargin => (0.0, margin),
Anchor::Page => (0.0, s.page_h),
Anchor::BottomMargin | Anchor::OutsideMargin => (s.page_h - s.margin_bottom, s.margin_bottom),
_ => (s.header, 0.0),
};
let expected = match align {
None => start - 20.0,
Some(FloatAlign::Center) => start + (extent - 10.0) / 2.0,
Some(FloatAlign::End) => start + extent - 10.0,
_ => start,
};
let drawn = shapes(&page.header);
assert_eq!(drawn.len(), 1, "the countercontrol must place its drawing");
assert!(
(drawn[0].y - expected).abs() < 0.01,
"margin {margin}, anchor {anchor:?}, align {align:?}: {:?}, expected {expected}, body {:?}",
drawn,
page.body
);
}
}
}
}
#[test]
fn header_margin_table_area() {
use wordcraft_doc::para::{Anchor, FloatAlign};
use wordcraft_doc::props::{HeightRule, LineSpacing, TableFloat};
for margin in [60.0, 120.0] {
for align in [None, Some(FloatAlign::Center), Some(FloatAlign::End)] {
let mut d = Document::from_text("Body");
d.last_section.margin_top = margin;
d.last_section.header = 36.0;
let mut hp = Paragraph::with_text("One\nTwo\nThree\nFour\nFive", Default::default());
hp.props.line_spacing = Some(LineSpacing::Exactly(10.0));
hp.props.space_before = Some(0.0);
hp.props.space_after = Some(0.0);
let mut t = Table::new(1, 1, 40.0);
t.rows[0].props.height = Some(10.0);
t.rows[0].props.height_rule = HeightRule::Exact;
t.props.float = Some(TableFloat { h_rel: Anchor::Page, v_rel: Anchor::Margin, v_align: align, x: 300.0, y: -20.0, ..Default::default() });
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(hp), Arc::new(Block::Table(t))]);
d.last_section.headers.default = Some(id);
let l = lay(&d);
let page = &l.pages[0];
if margin == 60.0 {
assert!(page.body.y > margin, "the header must displace the body");
}
let cells: Vec<_> = page
.header
.iter()
.filter_map(|it| match it {
Placed::Cell { rect, .. } => Some(rect),
_ => None,
})
.collect();
assert_eq!(cells.len(), 1);
let extent = (d.last_section.page_h - page.body.y - d.last_section.margin_bottom).max(18.0);
let expected = match align {
Some(FloatAlign::Center) => page.body.y + (extent - 10.0) / 2.0,
Some(FloatAlign::End) => page.body.y + extent - 10.0,
_ => page.body.y - 20.0,
};
assert!((cells[0].y - expected).abs() < 0.01, "margin {margin}, align {align:?}: {:?}, expected {expected}", cells[0]);
}
}
}
mod shape_alpha;
/// A row with a background picture split over two pages: each part draws its own piece of the
/// picture inside its own part of the cell, and the text moving on starts at the continuation's
/// top (the picture is the cell's background, not content moving on with the text).
#[test]
fn a_split_cells_background_picture_is_drawn_on_both_parts() {
use wordcraft_doc::props::{CellPicture, PictureRepeat};
let mut d = Document::new();
let mut t = wordcraft_doc::Table::new(1, 1, 200.0);
let media = d.add_media(vec![0u8; 8], "png");
t.rows[0].cells[0].props.picture = Some(Box::new(CellPicture { media, size: [30.0, 6.0], repeat: PictureRepeat::Tile, align: [0.0, 0.0] }));
t.rows[0].cells[0].blocks =
(0..90).map(|i| wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(&format!("Line {i}"), Default::default()))).collect();
d.body = vec![std::sync::Arc::new(wordcraft_doc::Block::Table(t)), wordcraft_doc::para_block(wordcraft_doc::Paragraph::new())];
let l = lay(&d);
assert!(l.pages.len() >= 2, "the row splits");
for (n, page) in l.pages.iter().take(2).enumerate() {
let clips: Vec<Rect> = page.items.iter().filter_map(|it| if let Placed::Clip { rect, .. } = it { Some(*rect) } else { None }).collect();
assert_eq!(clips.len(), 1, "page {n}: {clips:?}");
let clip = clips[0];
let cells: Vec<Rect> = page.items.iter().filter_map(|it| if let Placed::Cell { rect, .. } = it { Some(*rect) } else { None }).collect();
assert!(cells.iter().any(|c| (c.y - clip.y).abs() < 0.01 && (c.h - clip.h).abs() < 0.01), "page {n}: {clip:?} is its cell part {cells:?}");
assert!(clip.y >= 0.0 && clip.bottom() <= page.h + 0.01, "page {n}: {clip:?}");
// The text starts near the top of its part of the cell.
let first = page.items.iter().find_map(|it| if let Placed::Lines { y, .. } = it { Some(*y) } else { None }).unwrap_or(f32::MAX);
assert!(first - clip.y < 20.0, "page {n}: text at {first}, cell at {clip:?}");
}
}
/// A table moved to a new page by a page break before its first paragraph shows the number of
/// the page it lands on in that cell's PAGE field, not the page it was laid out for.
#[test]
fn a_table_moved_by_a_page_break_shows_its_new_page_number() {
let mut d = Document::from_text("Before the table.");
let mut table = Table::new(1, 1, 468.0);
let mut first = wordcraft_doc::Paragraph::with_text("Page ", Default::default());
first.props.page_break_before = Some(true);
let page = InlineObject::Field { instr: "PAGE".into(), result: "9".into(), locked: false, dirty: true, code: false, form: String::new() };
first.insert_object(first.len(), page, &Default::default()).unwrap();
table.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(first)];
d.body.push(std::sync::Arc::new(wordcraft_doc::Block::Table(table)));
let l = lay(&d);
assert_eq!(l.pages.len(), 2);
let shown: Vec<String> = l.pages[1]
.items
.iter()
.flat_map(|it| match it {
Placed::Lines { para, .. } => para.shown.iter().map(|s| s.1.clone()).collect::<Vec<_>>(),
_ => Vec::new(),
})
.collect();
assert_eq!(shown, ["2"]);
}
/// Cell confinement must not change page-vertical placement through the rotated text axis.
#[test]
fn turned_cell_float_keeps_its_along_text_offset() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let place = |direction, outside_cell| {
let mut doc = Document::from_text("Synthetic body");
let mut table = Table::new(1, 2, 468.0);
table.rows[0].props.height = Some(100.0);
table.rows[0].props.height_rule = wordcraft_doc::props::HeightRule::Exact;
table.rows[0].cells[0].props.text_direction = direction;
let mut para = Paragraph::with_text("Synthetic cell", Default::default());
let float = Float { wrap: Wrap::Tight, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 150.0, outside_cell, ..Default::default() };
para.insert_object(0, rect_shape(20.0, 10.0, float), &Default::default()).unwrap();
table.rows[0].cells[0].blocks = vec![wordcraft_doc::para_block(para)];
doc.insert_block(StoryRef::Body, &Path::top(1), Block::Table(table)).unwrap();
let objects = shapes(&lay(&doc).pages[0].items);
assert_eq!(objects.len(), 1);
objects[0]
};
for direction in [TextDirection::Down, TextDirection::Up] {
let confined = place(direction, false);
let reference = place(direction, true);
assert!((confined.y - reference.y).abs() < 0.01, "{direction:?}: {confined:?} vs {reference:?}");
}
}
/// A header paragraph beside a Square float on its last lines only: those lines are shorter than
/// the first. A click on the first line past the short last line's end is still on the header's
/// text, so a Behind Text picture under it is not grabbed there (#5601 review).
#[test]
fn header_text_covers_the_whole_width_of_a_wrapped_first_line() {
use wordcraft_doc::para::{Anchor, Float, Wrap};
let text = "Header words that wrap across the whole line and carry on over several lines of the header \
paragraph so there are three lines here and the last one is cut short by the float beside it";
let mut d = Document::new();
let id =
d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(wordcraft_doc::Paragraph::with_text(text, Default::default()))]);
d.last_section.headers.default = Some(id);
let at = |off| Pos::new(wordcraft_doc::StoryRef::Part(id), wordcraft_doc::Path(vec![0]), off);
// The Square float narrows the lines below the first two, on the right.
let square = Float { wrap: Wrap::Square, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 300.0, y: 30.0, ..Default::default() };
d.insert_object(&at(0), rect_shape(160.0, 80.0, square), &Default::default()).unwrap();
// The Behind Text picture lies under the first line, past where the last line ends.
let behind = Float { wrap: Wrap::BehindText, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 340.0, y: 0.0, ..Default::default() };
d.insert_object(&at(0), rect_shape(120.0, 20.0, behind), &Default::default()).unwrap();
let l = lay(&d);
let page = &l.pages[0];
let lines: Vec<_> = page
.header
.iter()
.filter_map(|it| match it {
Placed::Lines { para, l0, l1, x, y, .. } => {
Some((*x, *y, (*l0..*l1).filter_map(|i| para.lines.get(i)).map(|l| (l.top, l.height, l.right)).collect::<Vec<_>>()))
}
_ => None,
})
.collect();
let (x, y, ls) = lines.first().expect("header lines").clone();
let (first, last) = (ls.first().expect("first"), ls.last().expect("last"));
assert!(last.2 + 40.0 < first.2 - 20.0, "the last line is shorter than the first: {ls:?}");
let (px, py) = (x + first.2 - 15.0, y + first.0 + first.1 / 2.0);
assert!(l.object_at_in(0, px, py, 0.0, wordcraft_doc::StoryRef::Part(id)).is_none(), "on the first line's text, not the picture: {lines:?}");
}
/// `Line::left`/`right` are the edges available to a line, not where its ink sits: a centred or
/// right-aligned header line covers the Behind Text picture across its whole band, so a click in
/// the empty space beside its text is still on the header text. Beyond the band (an indent, or
/// beside a float) and 40pt of slack the picture is hit (#5601 review).
#[test]
fn header_text_covers_the_whole_band_of_centred_and_right_lines() {
use wordcraft_doc::Align;
use wordcraft_doc::para::{Anchor, Float, Wrap};
for align in [Align::Center, Align::Right] {
let mut d = Document::new();
let mut p = wordcraft_doc::Paragraph::with_text("Header", Default::default());
p.props.align = Some(align);
p.props.indent_left = Some(150.0);
let id = d.add_part(wordcraft_doc::PartKind::Header, vec![wordcraft_doc::para_block(p)]);
d.last_section.headers.default = Some(id);
let story = wordcraft_doc::StoryRef::Part(id);
let at = Pos::new(story, wordcraft_doc::Path(vec![0]), 0);
// A Behind Text picture across the whole text width, level with the header line.
let behind = Float { wrap: Wrap::BehindText, h_rel: Anchor::Column, v_rel: Anchor::Paragraph, x: 0.0, y: 0.0, ..Default::default() };
d.insert_object(&at, rect_shape(460.0, 20.0, behind), &Default::default()).unwrap();
let l = lay(&d);
let (x, y, left, right, height, ink0) = l.pages[0]
.header
.iter()
.find_map(|it| match it {
Placed::Lines { para, l0, x, y, .. } => {
para.lines.get(*l0).and_then(|ln| Some((*x, *y, ln.left, ln.right, ln.height, *ln.xs.first()?)))
}
_ => None,
})
.expect("header line");
// `left`/`right` are the band edges available to the line, not the ink extent.
assert!((left - 150.0).abs() < 0.5, "{align:?}: the band's left edge is the indent: {left}");
assert!(ink0 > left + 100.0, "{align:?}: the ink starts well inside the band: ink {ink0}, band left {left}");
let ym = y + height / 2.0;
let hit = |px: f32| l.object_at_in(0, px, ym, 0.0, story).is_some();
// Inside the band, wherever the centred or right-aligned ink sits: header text.
assert!(!hit(x + left + 5.0), "{align:?}: the band's left end is text");
assert!(!hit(x + (left + right) / 2.0), "{align:?}: the band's middle is text");
// Between the indent and the ink is still the text band, not the picture.
assert!(!hit(x + left + 160.0), "{align:?}: between the indent and the ink is text");
// Within 40pt of the band's left end is still text; further left the picture is hit.
assert!(!hit(x + left - 30.0), "{align:?}: within 40pt left of the band is text");
assert!(hit(x + left - 60.0), "{align:?}: beyond 40pt left of the band the picture is hit");
}
}
No file is open. Choose one in the tree, or press Ctrl+O (⌘O on a Mac) to find one by name.
Syntax highlighting could not load. The unmodified read-only text remains available above.