docling_pdf/assemble.rs
1//! Layout-driven assembly: map detected [`Region`]s + text cells to a
2//! [`DoclingDocument`], mirroring docling's page-assembly + reading-order.
3//!
4//! Overlapping detections are resolved greedily by score, each text cell is
5//! assigned to its best-containing region, regions are ordered in reading order
6//! (two-column aware), and each becomes a typed node by its layout label.
7
8use docling_core::{Node, PictureClass, PictureImage, Table};
9#[cfg(feature = "ml")]
10use image::RgbImage;
11
12use crate::layout::Region;
13use crate::pdfium_backend::{PdfPage, TextCell};
14
15fn area(l: f32, t: f32, r: f32, b: f32) -> f32 {
16 ((r - l).max(0.0)) * ((b - t).max(0.0))
17}
18
19/// Intersection area of two boxes.
20fn inter(a: &Region, l: f32, t: f32, r: f32, b: f32) -> f32 {
21 let il = a.l.max(l);
22 let it = a.t.max(t);
23 let ir = a.r.min(r);
24 let ib = a.b.min(b);
25 area(il, it, ir, ib)
26}
27
28/// Wrapper (structured-region) labels, ported from docling
29/// `LayoutPostprocessor.WRAPPER_TYPES`: a region that *contains* other regions
30/// and renders as a structured block (a table / table-of-contents index), not as
31/// its own flat text.
32fn is_wrapper(label: &str) -> bool {
33 matches!(
34 label,
35 "table" | "document_index" | "form" | "key_value_region"
36 )
37}
38
39/// Labels docling's table-structure (TableFormer) model runs on and that render
40/// as a Markdown table: a plain `table` and a `document_index` (a table of
41/// contents), which docling assembles as a `TableItem` too.
42pub fn is_table_like(label: &str) -> bool {
43 matches!(label, "table" | "document_index")
44}
45
46/// Greedily keep regions by descending score, dropping a region that is mostly
47/// covered by an already-kept one (RT-DETR emits overlapping duplicates).
48fn greedy(mut regions: Vec<Region>) -> Vec<Region> {
49 regions.sort_by(|a, b| b.score.total_cmp(&a.score));
50 let mut kept: Vec<Region> = Vec::new();
51 for r in regions {
52 let ra = area(r.l, r.t, r.r, r.b).max(1.0);
53 let covered = kept.iter().any(|k| {
54 let i = inter(&r, k.l, k.t, k.r, k.b);
55 let ka = area(k.l, k.t, k.r, k.b).max(1.0);
56 // drop if most of r is inside k, or they strongly mutually overlap
57 i / ra > 0.7 || i / (ra + ka - i) > 0.5
58 });
59 if !covered {
60 kept.push(r);
61 }
62 }
63 kept
64}
65
66/// Resolve overlapping RT-DETR detections, ported from the bucket structure of
67/// docling's `LayoutPostprocessor`: regular, picture and wrapper clusters live in
68/// **separate** spatial indexes and are de-overlapped independently, so a
69/// high-score picture never suppresses a lower-score table or table-of-contents
70/// index (the redp5110 TOC that was otherwise replaced by a picture box). A
71/// cross-type pass first drops a picture that nearly coincides with a table
72/// (`_handle_cross_type_overlaps`), keeping the structured table.
73/// docling's `_remove_overlapping_clusters("picture")`: same-label picture
74/// detections whose boxes heavily overlap (IoU > 0.8, or either box > 80 %
75/// contained in the other) form one group, and a single survivor is kept per
76/// group. Survivor selection ports `_should_prefer_cluster` /
77/// `_select_best_cluster_from_group` with the picture params
78/// (`area_threshold` 2.0, `conf_threshold` 0.3): a candidate is rejected only
79/// when a rival is both comparable in size (candidate ≤ 2× its area) and
80/// clearly more confident (> 0.3); among the survivors the *larger* box wins
81/// unless it is > 0.3 less confident. Net effect on the corpus: a figure the
82/// detector proposes both whole and as its sub-panels (2206's four-thumbnail
83/// Figure 1) collapses to the whole-figure box, exactly like docling.
84pub(crate) fn dedup_pictures(regions: &mut Vec<Region>) {
85 let idx: Vec<usize> = (0..regions.len())
86 .filter(|&i| regions[i].label == "picture")
87 .collect();
88 if idx.len() < 2 {
89 return;
90 }
91 // Union-find over the picture subset.
92 let mut parent: Vec<usize> = (0..idx.len()).collect();
93 fn find(parent: &mut [usize], i: usize) -> usize {
94 let mut root = i;
95 while parent[root] != root {
96 root = parent[root];
97 }
98 let mut cur = i;
99 while parent[cur] != root {
100 let next = parent[cur];
101 parent[cur] = root;
102 cur = next;
103 }
104 root
105 }
106 let boxed = |r: &Region| (r.l, r.t, r.r, r.b);
107 for a in 0..idx.len() {
108 for b in (a + 1)..idx.len() {
109 let (ra, rb) = (®ions[idx[a]], ®ions[idx[b]]);
110 let (al, at, ar, ab_) = boxed(ra);
111 let (bl, bt, br, bb) = boxed(rb);
112 let ix = (ar.min(br) - al.max(bl)).max(0.0);
113 let iy = (ab_.min(bb) - at.max(bt)).max(0.0);
114 let inter = ix * iy;
115 let aa = area(al, at, ar, ab_).max(f32::EPSILON);
116 let ba = area(bl, bt, br, bb).max(f32::EPSILON);
117 let iou = inter / (aa + ba - inter).max(f32::EPSILON);
118 if iou > 0.8 || inter / aa > 0.8 || inter / ba > 0.8 {
119 let (pa, pb) = (find(&mut parent, a), find(&mut parent, b));
120 if pa != pb {
121 parent[pa] = pb;
122 }
123 }
124 }
125 }
126 // Per group, run docling's pairwise preference + larger-wins selection.
127 let mut groups: std::collections::HashMap<usize, Vec<usize>> = std::collections::HashMap::new();
128 for i in 0..idx.len() {
129 let root = find(&mut parent, i);
130 groups.entry(root).or_default().push(i);
131 }
132 let mut drop = vec![false; regions.len()];
133 for group in groups.values() {
134 if group.len() < 2 {
135 continue;
136 }
137 const AREA_THRESHOLD: f32 = 2.0;
138 const CONF_THRESHOLD: f32 = 0.3;
139 let area_of = |i: usize| {
140 let r = ®ions[idx[i]];
141 area(r.l, r.t, r.r, r.b).max(f32::EPSILON)
142 };
143 let mut best: Option<usize> = None;
144 for &cand in group {
145 let passes = group.iter().all(|&other| {
146 if other == cand {
147 return true;
148 }
149 let area_ratio = area_of(cand) / area_of(other);
150 let conf_diff = regions[idx[other]].score - regions[idx[cand]].score;
151 !(area_ratio <= AREA_THRESHOLD && conf_diff > CONF_THRESHOLD)
152 });
153 if passes {
154 best = Some(match best {
155 None => cand,
156 Some(cur) => {
157 if area_of(cand) > area_of(cur)
158 && regions[idx[cur]].score - regions[idx[cand]].score <= CONF_THRESHOLD
159 {
160 cand
161 } else {
162 cur
163 }
164 }
165 });
166 }
167 }
168 // Every candidate rejected can't happen with docling's rule (rejection
169 // needs a strictly better rival); guard with highest score anyway.
170 let keep = best.unwrap_or_else(|| {
171 *group
172 .iter()
173 .max_by(|&&a, &&b| regions[idx[a]].score.total_cmp(®ions[idx[b]].score))
174 .expect("non-empty group")
175 });
176 for &i in group {
177 if i != keep {
178 drop[idx[i]] = true;
179 }
180 }
181 }
182 let mut keep_iter = drop.into_iter();
183 regions.retain(|_| !keep_iter.next().expect("aligned"));
184}
185
186pub fn resolve(regions: Vec<Region>) -> Vec<Region> {
187 // Cross-type: a region proposed as BOTH a picture and a table survives twice
188 // (the two buckets de-overlap independently). Keep the structured table and
189 // drop the coincident picture — IoU (not containment), so a genuine small
190 // figure fully inside a large table region is not removed.
191 let tables: Vec<(f32, f32, f32, f32)> = regions
192 .iter()
193 .filter(|r| r.label == "table")
194 .map(|r| (r.l, r.t, r.r, r.b))
195 .collect();
196 let mut regions = regions;
197 regions.retain(|r| {
198 if r.label != "picture" {
199 return true;
200 }
201 let ra = area(r.l, r.t, r.r, r.b).max(1.0);
202 !tables.iter().any(|&(l, t, rr, b)| {
203 let i = inter(r, l, t, rr, b);
204 let u = ra + area(l, t, rr, b) - i;
205 u > 0.0 && i / u > 0.8
206 })
207 });
208 // De-overlap each bucket on its own.
209 let pictures = greedy(
210 regions
211 .iter()
212 .filter(|r| r.label == "picture")
213 .cloned()
214 .collect(),
215 );
216 let wrappers = greedy(
217 regions
218 .iter()
219 .filter(|r| is_wrapper(r.label))
220 .cloned()
221 .collect(),
222 );
223 let mut kept = greedy(
224 regions
225 .iter()
226 .filter(|r| r.label != "picture" && !is_wrapper(r.label))
227 .cloned()
228 .collect(),
229 );
230 dedup_nested_code(&mut kept);
231 kept.extend(pictures);
232 kept.extend(wrappers);
233 kept
234}
235
236/// Drop a regular region that is >80% contained in a surviving special region we
237/// render **as a single unit** — a table/table-of-contents index — ported from
238/// docling's "Remove regular clusters that are included in wrappers" step: the
239/// special absorbs it as a child (a table cell), so it must not also be emitted
240/// as its own paragraph/list-item. This stops the survey list-items from
241/// appearing both inside the detected table and again as bullets
242/// (`table_mislabeled_as_picture`).
243///
244/// `picture` regions stay in the swallow set even after #165: docling keeps a
245/// picture's contained clusters as the `PictureItem`'s *children* in the
246/// document JSON (`ReadingOrderModel._add_child_elements`), but its
247/// `MarkdownPictureSerializer` prints only the caption and the image — the
248/// children never reach the Markdown (verified against the corpus groundtruth:
249/// `amt_handbook`'s in-figure callout labels are absent). Dropping the
250/// fully-contained regulars here reproduces exactly that. What #165 *does*
251/// change is upstream, in [`add_orphan_regions`]: pictures no longer claim
252/// cells, so a line only partially under a figure box (straddling its border,
253/// ≤80 % contained) now forms an orphan region that survives this drop — those
254/// words were silently erased before, and docling emits them.
255///
256/// `form` / `key_value_region` wrappers are deliberately **excluded**: this
257/// pipeline does not render them as a structured block (they are skipped), so
258/// their textual content comes precisely from the contained regular regions —
259/// dropping those would erase the page (e.g. `right_to_left_03`'s form-heavy
260/// pages). Runs *after* [`drop_false_pictures`] so a phantom picture can't
261/// swallow real text on its way out.
262pub fn drop_contained_regulars(regions: &mut Vec<Region>) {
263 let specials: Vec<(f32, f32, f32, f32)> = regions
264 .iter()
265 .filter(|r| r.label == "picture" || is_table_like(r.label))
266 .map(|r| (r.l, r.t, r.r, r.b))
267 .collect();
268 if specials.is_empty() {
269 return;
270 }
271 regions.retain(|r| {
272 if r.label == "picture" || is_wrapper(r.label) {
273 return true;
274 }
275 let ra = area(r.l, r.t, r.r, r.b).max(1.0);
276 !specials
277 .iter()
278 .any(|&(l, t, rr, b)| inter(r, l, t, rr, b) / ra > 0.8)
279 });
280}
281
282/// True for a bare, single-token source-code language label (`XML`, `C#`, `JSON`,
283/// `bash`, …) — the little header the docs render above a code block. Matched
284/// case-insensitively; anything with whitespace or longer than a token is out.
285fn is_code_language(t: &str) -> bool {
286 let t = t.trim();
287 if t.is_empty() || t.chars().any(char::is_whitespace) || t.chars().count() > 12 {
288 return false;
289 }
290 const LANGS: &[&str] = &[
291 "xml",
292 "html",
293 "xhtml",
294 "json",
295 "jsonc",
296 "yaml",
297 "yml",
298 "toml",
299 "ini",
300 "c#",
301 "csharp",
302 "f#",
303 "fsharp",
304 "vb",
305 "c",
306 "c++",
307 "cpp",
308 "java",
309 "kotlin",
310 "scala",
311 "go",
312 "golang",
313 "rust",
314 "swift",
315 "javascript",
316 "js",
317 "typescript",
318 "ts",
319 "jsx",
320 "tsx",
321 "python",
322 "py",
323 "ruby",
324 "rb",
325 "php",
326 "perl",
327 "lua",
328 "r",
329 "dart",
330 "bash",
331 "sh",
332 "shell",
333 "powershell",
334 "zsh",
335 "batch",
336 "cmd",
337 "sql",
338 "tsql",
339 "plsql",
340 "graphql",
341 "dockerfile",
342 "makefile",
343 "css",
344 "scss",
345 "sass",
346 "less",
347 "markdown",
348 "md",
349 "tex",
350 "latex",
351 "diff",
352 "proto",
353 "razor",
354 "cshtml",
355 "xaml",
356 "aspx",
357 "http",
358 ];
359 let lower = t.to_ascii_lowercase();
360 LANGS.contains(&lower.as_str())
361}
362
363/// Mark the region indices that are a code block's **language label** — a bare
364/// `XML`/`C#`/… token sitting directly above a `code` region — so they are consumed
365/// rather than emitted as their own stray paragraph/heading. The label may also be
366/// captured inside a wider code box (rendered as the fence's first line); dropping
367/// the standalone copy just removes the duplicate.
368fn code_language_labels(regions: &[Region], cells: &[TextCell]) -> Vec<bool> {
369 let mut drop = vec![false; regions.len()];
370 for (i, r) in regions.iter().enumerate() {
371 if matches!(r.label, "code" | "picture" | "table") {
372 continue;
373 }
374 if !is_code_language(®ion_text(r, cells)) {
375 continue;
376 }
377 // The label sits just above the code (a blank line's gap) or is swallowed
378 // into the top of a wider code box; either way it is that block's label.
379 // The window is generous because the label's own font is small, so a
380 // one-line gap is several times its height.
381 let line_h = (r.b - r.t).abs().max(1.0);
382 let window = (line_h * 4.0).max(28.0);
383 let labels_code = regions.iter().enumerate().any(|(j, c)| {
384 if j == i || c.label != "code" {
385 return false;
386 }
387 let gap = c.t - r.b; // >0 when the code is below the label
388 let h_overlap = (r.r.min(c.r) - r.l.max(c.l)).max(0.0);
389 gap > -line_h * 3.0 && gap < window && h_overlap > 0.0
390 });
391 if labels_code {
392 drop[i] = true;
393 }
394 }
395 drop
396}
397
398/// Collapse `code` regions where one is nested inside another, keeping the larger.
399///
400/// RT-DETR sometimes emits a tight code box *and* a wider near-duplicate that also
401/// captures the block's language label (`XML`, `C#`, …). When the tight box scores
402/// higher it is kept first, and the wider container — not "mostly inside" the tight
403/// box — survives [`resolve`]'s greedy pass, so the block is emitted twice. Keeping
404/// the **larger** box (rather than dropping it) collapses the pair without leaking
405/// the container's extra cells back out as orphan text, since the larger box still
406/// covers every cell. Restricted to `code` so genuinely distinct nested regions of
407/// other kinds are untouched.
408fn dedup_nested_code(kept: &mut Vec<Region>) {
409 let mut drop = vec![false; kept.len()];
410 for i in 0..kept.len() {
411 if kept[i].label != "code" {
412 continue;
413 }
414 let ai = area(kept[i].l, kept[i].t, kept[i].r, kept[i].b).max(1.0);
415 for j in 0..kept.len() {
416 if i == j || drop[j] || kept[j].label != "code" {
417 continue;
418 }
419 let aj = area(kept[j].l, kept[j].t, kept[j].r, kept[j].b).max(1.0);
420 // Drop i when it is mostly inside a strictly larger code box j.
421 let overlap = inter(&kept[i], kept[j].l, kept[j].t, kept[j].r, kept[j].b);
422 if aj > ai && overlap / ai > 0.7 {
423 drop[i] = true;
424 break;
425 }
426 }
427 }
428 let mut keep = drop.iter();
429 kept.retain(|_| !*keep.next().unwrap());
430}
431
432/// Fraction of the page's non-empty text cells that some detected region
433/// claims (>0.2 intersection-over-self, docling's assignment rule). 1.0 for a
434/// page without text cells.
435///
436/// The int8-layout guard keys off this: a dense digital page whose detections
437/// cover almost none of its text is the signature of quantized confidences
438/// flipping under the 0.5 label thresholds on this CPU's kernels — not of a
439/// genuinely empty layout — and is worth re-running on the fp32 graph.
440pub fn layout_cell_coverage(regions: &[Region], cells: &[TextCell]) -> f32 {
441 let mut total = 0usize;
442 let mut covered = 0usize;
443 for c in cells {
444 if c.text.trim().is_empty() {
445 continue;
446 }
447 total += 1;
448 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
449 if regions
450 .iter()
451 .any(|r| inter(r, c.l, c.t, c.r, c.b) / ca > 0.2)
452 {
453 covered += 1;
454 }
455 }
456 if total == 0 {
457 1.0
458 } else {
459 covered as f32 / total as f32
460 }
461}
462
463/// Append `text` regions for cells the layout left uncovered ("orphan cells"),
464/// the way docling's `LayoutPostprocessor` does (`create_orphan_clusters`): any
465/// non-empty cell that no kept region covers (>50% of the cell's area) becomes a
466/// text region of its own, so text the detector missed (a stray `.`, a small
467/// label) is still emitted instead of silently dropped. Adjacent orphan cells on a
468/// line are merged so a missed paragraph doesn't shatter into one block per line.
469pub fn add_orphan_regions(regions: &mut Vec<Region>, cells: &[TextCell]) {
470 // docling assigns each cell to its single best-overlapping cluster at
471 // intersection-over-self > 0.2 and serializes exactly the assigned cells —
472 // and since [`region_texts_exclusive`] now emits under that very rule, the
473 // claim test here matches it: any cell over 0.2 will actually render in
474 // its best region, everything else becomes an orphan. Completeness by
475 // construction, with no (0.2, 0.5] hole (the old > 0.5 serializer needed
476 // the claim test raised to > 0.5 to keep right_to_left_03's `20300` from
477 // vanishing; the exclusive port closes that structurally).
478 //
479 // Only *regular* clusters claim cells: docling's `_find_unassigned_cells`
480 // walks `regular_clusters` alone, so a cell under a `picture` or a wrapper
481 // (`table`/`document_index`/`form`/`key_value_region`) that no regular
482 // cluster covers still becomes an orphan text cluster (#165). The orphans
483 // that end up *fully* inside the special are re-dropped by
484 // [`drop_contained_regulars`] (docling's Markdown drops them the same way
485 // — a picture's children never reach its `MarkdownPictureSerializer`
486 // output, a table's text renders through the reconstructed grid). The
487 // observable fix is the border-straddlers: a line only partially under a
488 // figure box used to lose its cells to the picture's 0.2 claim and vanish
489 // — now it forms an orphan region and is emitted, as docling does.
490 let assigned = |c: &TextCell| {
491 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
492 regions
493 .iter()
494 .filter(|r| r.label != "picture" && !is_wrapper(r.label))
495 .any(|r| inter(r, c.l, c.t, c.r, c.b) / ca > 0.2)
496 };
497 // Collect orphan cells (non-empty, unassigned), in page order.
498 let mut orphans: Vec<&TextCell> = cells
499 .iter()
500 .filter(|c| !c.text.trim().is_empty() && !assigned(c))
501 .collect();
502 if orphans.is_empty() {
503 return;
504 }
505 orphans.sort_by(|a, b| a.t.total_cmp(&b.t).then(a.l.total_cmp(&b.l)));
506 // Merge cells that sit on the same line and nearly touch into one region, so a
507 // dropped multi-word line stays one block (docling's refinement merges these).
508 let mut merged: Vec<Region> = Vec::new();
509 for c in orphans {
510 let h = (c.b - c.t).abs().max(1.0);
511 if let Some(last) = merged.last_mut() {
512 let same_line = (last.t - c.t).abs() < h * 0.5;
513 let touching = c.l <= last.r + h && c.l >= last.l - h;
514 if same_line && touching {
515 last.l = last.l.min(c.l);
516 last.r = last.r.max(c.r);
517 last.t = last.t.min(c.t);
518 last.b = last.b.max(c.b);
519 continue;
520 }
521 }
522 merged.push(Region {
523 label: "text",
524 score: 0.0,
525 l: c.l,
526 t: c.t,
527 r: c.r,
528 b: c.b,
529 });
530 }
531 regions.extend(merged);
532}
533
534/// Demote a `picture` region that is really a **text panel** — a paragraph block
535/// the layout model boxed as a figure because it is typeset on a colored
536/// background (terms-and-conditions callouts, quote boxes) — into ordinary
537/// `text` regions, one per paragraph, so its words are read instead of shipped
538/// as pixels. docling loses this text the same way (cells assigned to a picture
539/// cluster are never serialized); this is a deliberate improvement, not parity.
540///
541/// The gate is conservative so a genuine figure keeps its crop: the region must
542/// contain at least three text lines whose median width spans most of the panel
543/// (axis labels and chat bubbles are narrow and varied) and whose cells cover a
544/// substantial fraction of its area (a photo or chart with sparse labels does
545/// not). Paragraph boundaries are re-derived from the line pitch: a vertical gap
546/// clearly larger than the panel's own leading starts a new `text` region, so
547/// the panel doesn't collapse into one giant paragraph.
548///
549/// Works on any cell source — the digital text layer or OCR lines recognized
550/// from the picture crop — so the native and browser paths, with or without
551/// force-OCR, demote identically.
552pub fn recover_text_panels(regions: &mut Vec<Region>, cells: &[TextCell]) {
553 // A *captioned* picture is a genuine figure whatever it contains — the
554 // corpus is full of document screenshots ("Figure 3: …" above a page
555 // image) that are exactly as dense and wide as a text panel. Only an
556 // uncaptioned picture is a demotion candidate.
557 let captioned: Vec<bool> = regions
558 .iter()
559 .map(|r| {
560 r.label == "picture"
561 && regions.iter().any(|c| {
562 c.label == "caption" && c.r.min(r.r) - c.l.max(r.l) > 0.0 && {
563 let gap = if c.t >= r.b {
564 c.t - r.b
565 } else if r.t >= c.b {
566 r.t - c.b
567 } else {
568 f32::MAX // vertically overlapping: not a caption
569 };
570 gap <= 25.0
571 }
572 })
573 })
574 .collect();
575 let mut out: Vec<Region> = Vec::with_capacity(regions.len());
576 // Synthesized paragraphs and the demoted panels' boxes are kept separate
577 // from `out` until the end: the dedup filter below must not confuse a
578 // paragraph we just built with a pre-existing region inside the panel.
579 let mut demoted_paras: Vec<Region> = Vec::new();
580 let mut demoted_boxes: Vec<(f32, f32, f32, f32)> = Vec::new();
581 for (i, r) in regions.drain(..).enumerate() {
582 if r.label != "picture" || captioned[i] {
583 out.push(r);
584 continue;
585 }
586 let inside: Vec<&TextCell> = cells
587 .iter()
588 .filter(|c| {
589 !c.text.trim().is_empty() && {
590 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
591 inter(&r, c.l, c.t, c.r, c.b) / ca > 0.5
592 }
593 })
594 .collect();
595 // Group the contained cells into lines by vertical overlap (the same
596 // rule region_text orders by), tracking each line's union box.
597 let mut lines: Vec<(f32, f32, f32, f32)> = Vec::new(); // (t, b, l, r)
598 for c in &inside {
599 let (ct, cb) = (c.t.min(c.b), c.t.max(c.b));
600 match lines.iter_mut().find(|(lt, lb, _, _)| {
601 let ov = cb.min(*lb) - ct.max(*lt);
602 ov > 0.5 * (cb - ct).min(*lb - *lt).max(1.0)
603 }) {
604 Some((lt, lb, ll, lr)) => {
605 *lt = lt.min(ct);
606 *lb = lb.max(cb);
607 *ll = ll.min(c.l);
608 *lr = lr.max(c.r);
609 }
610 None => lines.push((ct, cb, c.l, c.r)),
611 }
612 }
613 if lines.len() < 3 {
614 out.push(r);
615 continue;
616 }
617 let panel_w = (r.r - r.l).max(1.0);
618 let coverage = inside.iter().map(|c| area(c.l, c.t, c.r, c.b)).sum::<f32>()
619 / area(r.l, r.t, r.r, r.b).max(1.0);
620 let mut widths: Vec<f32> = lines.iter().map(|(_, _, l, rr)| rr - l).collect();
621 widths.sort_by(f32::total_cmp);
622 // A figure's text is ragged: a title line, small axis/tick labels, and
623 // OCR boxes over the plot area come out at wildly different heights,
624 // whereas a real text panel is set in one face with constant leading.
625 // Require near-uniform line heights (median absolute deviation ≤ 35%
626 // of the median) so an uncaptioned chart keeps its crop even when its
627 // labels are dense enough to pass the coverage gate (#173) — garbled
628 // OCR of its bars is not content.
629 let mut heights: Vec<f32> = lines.iter().map(|(t, b, _, _)| b - t).collect();
630 heights.sort_by(f32::total_cmp);
631 let h_med = heights[heights.len() / 2].max(1.0);
632 let mut devs: Vec<f32> = heights.iter().map(|h| (h - h_med).abs()).collect();
633 devs.sort_by(f32::total_cmp);
634 let uniform = devs[devs.len() / 2] <= 0.35 * h_med;
635 let text_panel = coverage >= 0.2 && widths[widths.len() / 2] >= 0.45 * panel_w && uniform;
636 if !text_panel {
637 out.push(r);
638 continue;
639 }
640 lines.sort_by(|a, b| a.0.total_cmp(&b.0));
641 let mut heights: Vec<f32> = lines.iter().map(|(t, b, _, _)| b - t).collect();
642 heights.sort_by(f32::total_cmp);
643 let h = heights[heights.len() / 2].max(1.0);
644 let mut gaps: Vec<f32> = lines
645 .windows(2)
646 .map(|w| (w[1].0 - w[0].1).max(0.0))
647 .collect();
648 gaps.sort_by(f32::total_cmp);
649 let leading = if gaps.is_empty() {
650 0.0
651 } else {
652 gaps[gaps.len() / 2]
653 };
654 let brk = (1.8 * leading).max(0.75 * h);
655 let mut para: Option<(f32, f32, f32, f32)> = None; // (l, t, r, b) union
656 for (t, b, l, rr) in &lines {
657 match &mut para {
658 Some((pl, _, pr, pb)) if *t - *pb <= brk => {
659 *pl = pl.min(*l);
660 *pr = pr.max(*rr);
661 *pb = pb.max(*b);
662 }
663 _ => {
664 if let Some((pl, pt, pr, pb)) = para.take() {
665 demoted_paras.push(Region {
666 label: "text",
667 score: r.score,
668 l: pl,
669 t: pt,
670 r: pr,
671 b: pb,
672 });
673 }
674 para = Some((*l, *t, *rr, *b));
675 }
676 }
677 }
678 if let Some((pl, pt, pr, pb)) = para {
679 demoted_paras.push(Region {
680 label: "text",
681 score: r.score,
682 l: pl,
683 t: pt,
684 r: pr,
685 b: pb,
686 });
687 }
688 demoted_boxes.push((r.l, r.t, r.r, r.b));
689 }
690 // The paragraphs are rebuilt from *all* of the panel's cells, so any
691 // surviving text region inside a demoted panel (an orphan cluster or a
692 // layout-detected fragment — pictures no longer swallow them, #165) would
693 // say the same words twice. Consume those; wrappers and pictures stay.
694 if !demoted_boxes.is_empty() {
695 out.retain(|r| {
696 r.label == "picture" || is_wrapper(r.label) || {
697 let ra = area(r.l, r.t, r.r, r.b).max(1.0);
698 !demoted_boxes
699 .iter()
700 .any(|&(l, t, rr, b)| inter(r, l, t, rr, b) / ra > 0.5)
701 }
702 });
703 }
704 out.extend(demoted_paras);
705 *regions = out;
706}
707
708/// Drop a `picture` detection that is a small, empty, low-confidence margin box on
709/// a **text page** — a false positive the RT-DETR layout sometimes emits (e.g.
710/// `right_to_left_02`'s phantom right-column picture, score 0.40); docling does not
711/// emit it. The gate is deliberately narrow so a genuine figure is never dropped:
712/// (1) only on pages with a digital text layer — image/scanned/figure pages have
713/// no `cells` yet at this point (OCR runs later), so their pictures, which *are*
714/// the content, are kept; (2) only a box covering < 25 % of the page (a margin
715/// artifact, not a dominant figure); (3) only when it contains no text and scores
716/// below 0.5 (real empty figures in the corpus all score ≥ 0.86).
717pub fn drop_false_pictures(
718 regions: &mut Vec<Region>,
719 cells: &[TextCell],
720 page_w: f32,
721 page_h: f32,
722) {
723 if cells.iter().all(|c| c.text.trim().is_empty()) {
724 return; // no digital text layer (image/scanned page) — keep all pictures
725 }
726 // A text-document page carries several text-bearing non-picture regions (so a
727 // spurious margin picture is clearly extra). A slide / figure page has at most
728 // one — there the picture is the content, so never drop it.
729 let content_regions = regions
730 .iter()
731 .filter(|r| r.label != "picture" && !region_text(r, cells).trim().is_empty())
732 .count();
733 if content_regions < 2 {
734 return;
735 }
736 let page_area = (page_w * page_h).max(1.0);
737 regions.retain(|r| {
738 if r.label != "picture" || r.score >= 0.5 {
739 return true;
740 }
741 if area(r.l, r.t, r.r, r.b) / page_area >= 0.25 {
742 return true; // a dominant figure, not a margin artifact
743 }
744 // Keep it if any text cell falls mostly inside (a real captioned/labelled
745 // figure); drop only the genuinely empty low-confidence boxes.
746 cells.iter().any(|c| {
747 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
748 !c.text.trim().is_empty() && inter(r, c.l, c.t, c.r, c.b) / ca > 0.5
749 })
750 });
751}
752
753/// A small digit-only region in the top/bottom margin: a page number. docling
754/// emits `right_to_left_02`'s bottom `11` as the page's *first* text item (its
755/// reading-order model floats the page number to the front), whereas our
756/// position-based ordering would place a bottom region last.
757fn is_page_number(region: &Region, cells: &[TextCell], page_h: f32) -> bool {
758 let t = region_text(region, cells);
759 let t = t.trim();
760 !t.is_empty()
761 && t.chars().all(|c| c.is_ascii_digit())
762 && (region.b - region.t).abs() < 30.0
763 && (region.t < page_h * 0.12 || region.b > page_h * 0.88)
764}
765
766/// Furniture / not-yet-emitted labels.
767fn is_skipped(label: &str) -> bool {
768 matches!(
769 label,
770 "page_header" | "page_footer" | "form" | "key_value_region"
771 )
772}
773
774/// Reading-order sort of a page's regions, via the ported rule-based
775/// [`reading_order`](crate::reading_order) predictor (docling's
776/// `ReadingOrderPredictor`): an up/down geometry graph, horizontal dilation and a
777/// depth-first traversal, with `page_header`/`page_footer` ordered as their own
778/// groups (first/last) as docling does.
779fn order_regions<T: Clone>(
780 items: &mut Vec<T>,
781 page_w: f32,
782 page_h: f32,
783 reg: impl Fn(&T) -> &Region,
784) {
785 let boxes: Vec<(f32, f32, f32, f32)> = items
786 .iter()
787 .map(|it| {
788 let r = reg(it);
789 (r.l, r.t, r.r, r.b)
790 })
791 .collect();
792 let is_header: Vec<bool> = items
793 .iter()
794 .map(|it| reg(it).label == "page_header")
795 .collect();
796 let is_footer: Vec<bool> = items
797 .iter()
798 .map(|it| reg(it).label == "page_footer")
799 .collect();
800 let order = crate::reading_order::order_page(&boxes, &is_header, &is_footer, page_w, page_h);
801 *items = order.iter().map(|&i| items[i].clone()).collect();
802}
803
804/// Clean a region's assembled text: undo soft-hyphen line wraps, map curly
805/// quotes and the ellipsis to ASCII (matching docling), and collapse runs of
806/// whitespace. pdfium emits the line-wrap hyphen as U+0002 in this corpus
807/// (U+00AD elsewhere), so `word\u{2} continuation` is one hyphenated word —
808/// drop the hyphen + the joining space and merge (`com\u{2} pact` → `compact`,
809/// `end-to\u{2} end` → `end-toend`), exactly as docling does.
810///
811/// Token spacing is otherwise left as the geometric join produced it. We do not
812/// tighten punctuation spacing: docling preserves the PDF's own spaces (it keeps
813/// `{ ahn }`, `Name 1 .`, `[ 9 ]`), and a geometric gap heuristic diverges from
814/// it more than a plain single-space join does.
815/// An ordered-list enumeration marker at the start of a list item: leading ASCII
816/// digits followed by `.`, e.g. `1. Undo/Redo` → `(1, "Undo/Redo")`. Returns
817/// `None` when the text doesn't start with `digits.`.
818fn parse_ordered_marker(s: &str) -> Option<(u64, String)> {
819 let digits: String = s.chars().take_while(|c| c.is_ascii_digit()).collect();
820 if digits.is_empty() {
821 return None;
822 }
823 let rest = s[digits.len()..].strip_prefix('.')?;
824 let number = digits.parse().ok()?;
825 Some((number, rest.trim_start().to_string()))
826}
827
828/// Escape markdown special characters the way docling-core's markdown serializer
829/// does (`markdown.py` post_process): `_` → `\_`, then HTML-escape `&`, `<`, `>`
830/// (quote=False, so quotes are left). Applied to prose (headings, list items,
831/// paragraphs); code blocks, the formula placeholder, and table cells are left raw.
832fn md_escape(text: &str) -> String {
833 text.replace('_', "\\_")
834 .replace('&', "&")
835 .replace('<', "<")
836 .replace('>', ">")
837}
838
839fn clean_text(text: &str) -> String {
840 // Typographic-quote normalization follows docling-parse's sanitizer table
841 // (`pdf_sanitators/constants.h`): every curly quote — single *and double* —
842 // becomes the ASCII apostrophe `'`, and `‚` a comma. A `"` in docling's
843 // output only ever comes from a literal `quotedbl` glyph, never from `“ ”`
844 // (2206's `'text in the wild"` pairs a curly open with a literal-quote
845 // close). This replaces an earlier Hangul-only special case that patched
846 // one symptom of mapping `“ ”` to `"`.
847 let replaced = text
848 .replace("\u{2} ", "")
849 .replace("\u{ad} ", "")
850 .replace(['\u{2}', '\u{ad}'], "") // any stray wrap hyphens not at a join
851 .replace(
852 [
853 '\u{2018}', '\u{2019}', '\u{201b}', '\u{201c}', '\u{201d}', '\u{201e}', '\u{201f}',
854 ],
855 "'",
856 ) // ‘ ’ ‛ “ ” „ ‟ → '
857 .replace('\u{201a}', ",") // ‚ → ,
858 .replace(
859 [
860 '\u{2010}', '\u{2011}', '\u{2012}', '\u{2013}', '\u{2014}', '\u{2015}', '\u{2212}',
861 ],
862 "-",
863 ) // hyphen/dash family → -
864 .replace('\u{2044}', "/") // ⁄ fraction slash → /
865 .replace('\u{2022}', "\u{b7}") // • → · (docling never emits •; inline CCS-concept separators)
866 .replace('\u{2026}', "..."); // … → ...
867 let out = if crate::pdfium_backend::use_dp_lines() {
868 // The docling-parse sanitizer already placed the correct spacing (e.g.
869 // justified double spaces); preserve internal runs of spaces, only
870 // normalizing line breaks/tabs and trimming the ends.
871 replaced.replace(['\n', '\r', '\t'], " ").trim().to_string()
872 } else {
873 // Legacy: collapse all whitespace runs to single spaces.
874 replaced.split_whitespace().collect::<Vec<_>>().join(" ")
875 };
876 fix_arabic_lam_alef(&out)
877}
878
879/// pdfium decomposes the Arabic lam-alef ligature (لا / لإ / لأ / لآ) into its
880/// glyph constituents in *visual* order — `alef-variant, lam` — but docling keeps
881/// logical order, `lam, alef-variant`. Swap a mid-word `alef-variant + lam` back
882/// to `lam + alef-variant`. "Mid-word" (the previous char is an Arabic letter)
883/// distinguishes the ligature from the definite article `ال` (word-initial
884/// `alef + lam`), which must stay. No-op for non-Arabic text.
885fn fix_arabic_lam_alef(s: &str) -> String {
886 let is_arabic_letter = |c: char| ('\u{0620}'..='\u{064A}').contains(&c);
887 let chars: Vec<char> = s.chars().collect();
888 if !chars.iter().any(|&c| is_arabic_letter(c)) {
889 return s.to_string(); // no-op for non-Arabic text
890 }
891 // Pass 1: swap mid-word `alef-variant + lam` → `lam + alef-variant`. Only the
892 // hamza/madda alef variants (إ أ آ) are safe: the definite article is always
893 // plain `ا + ل`, so plain `alef + lam` is ambiguous (a legitimate `فعالة` vs a
894 // reversed `لا` ligature look identical) — leaving plain alef alone avoids
895 // corrupting legitimate words.
896 let mut a: Vec<char> = Vec::with_capacity(chars.len());
897 let mut i = 0;
898 while i < chars.len() {
899 let c = chars[i];
900 if matches!(c, '\u{0622}' | '\u{0623}' | '\u{0625}')
901 && chars.get(i + 1) == Some(&'\u{0644}')
902 && i > 0
903 && is_arabic_letter(chars[i - 1])
904 // A preceding lam means this alef-variant is *already* the logical
905 // `lam + alef` ligature; the following lam is the next syllable's
906 // letter, not a reversed ligature — swapping it corrupts `لآل` → `للآ`
907 // (e.g. التعلم الآلي → الآلي, not اللآي).
908 && chars[i - 1] != '\u{0644}'
909 {
910 a.push('\u{0644}');
911 a.push(c);
912 i += 2;
913 continue;
914 }
915 a.push(c);
916 i += 1;
917 }
918 // Pass 2: insert a space at Arabic↔Latin boundaries (bidi script switch) that
919 // pdfium runs together — docling separates the embedded Latin run (`وPython`
920 // → `و Python`).
921 let mut out: Vec<char> = Vec::with_capacity(a.len());
922 for (j, &c) in a.iter().enumerate() {
923 if j > 0 {
924 let p = a[j - 1];
925 if (is_arabic_letter(p) && c.is_ascii_alphabetic())
926 || (p.is_ascii_alphabetic() && is_arabic_letter(c))
927 {
928 out.push(' ');
929 }
930 }
931 out.push(c);
932 }
933 out.into_iter().collect()
934}
935
936/// docling's `PageAssembleModel._match_hyperlink`: the URI whose link
937/// annotations cover at least half of the region's box, or `None`. Coverage is
938/// intersection-over-region-area, **accumulated per URI** — a URL that wraps
939/// across lines carries several annotation rects that sum toward the same
940/// target. Ties resolve to the first-seen URI (Python's `max` over dict
941/// insertion order); the winner still needs `>= 0.5`
942/// (`_HYPERLINK_COVERAGE_THRESHOLD`).
943pub(crate) fn region_hyperlink(
944 region: &Region,
945 links: &[crate::pdfium_backend::LinkAnnot],
946) -> Option<String> {
947 if links.is_empty() {
948 return None;
949 }
950 let area = (region.r - region.l).max(0.0) * (region.b - region.t).max(0.0);
951 if area <= 0.0 {
952 return None;
953 }
954 let mut coverage: Vec<(&str, f32)> = Vec::new();
955 for link in links {
956 let ix = (region.r.min(link.r) - region.l.max(link.l)).max(0.0);
957 let iy = (region.b.min(link.b) - region.t.max(link.t)).max(0.0);
958 let c = ix * iy / area;
959 match coverage.iter_mut().find(|(uri, _)| *uri == link.uri) {
960 Some((_, acc)) => *acc += c,
961 None => coverage.push((&link.uri, c)),
962 }
963 }
964 let mut best: Option<(&str, f32)> = None;
965 for (uri, c) in coverage {
966 // Strictly greater keeps the first-seen URI on ties, like Python's max.
967 if best.is_none_or(|(_, bc)| c > bc) {
968 best = Some((uri, c));
969 }
970 }
971 let (uri, c) = best?;
972 (c >= 0.5).then(|| normalize_uri(uri))
973}
974
975/// The pydantic-`AnyUrl` normalization docling's hyperlink value passes
976/// through on its way to the serializer: a URL with an authority but no path
977/// gains a trailing `/` (`https://arxiv.org` → `https://arxiv.org/`). Other
978/// AnyUrl canonicalizations (scheme/host lowercasing, percent-encoding) don't
979/// occur in PDF link annotations in practice, so they are not reproduced.
980fn normalize_uri(uri: &str) -> String {
981 if let Some((_, rest)) = uri.split_once("://") {
982 if !rest.is_empty() && !rest.contains(['/', '?', '#']) {
983 return format!("{uri}/");
984 }
985 }
986 uri.to_string()
987}
988
989/// Resolve each page hyperlink to the visible text it covers, as `(anchor, uri)`
990/// in reading order. The anchor is the cells whose centre falls in the link rect,
991/// joined left-to-right and cleaned the same way prose is (so it matches the
992/// serialized text), deduped against the immediately-preceding link so pdfium's
993/// occasional duplicate annotation doesn't double-list. Empty anchors are dropped.
994pub(crate) fn resolve_link_anchors(page: &PdfPage) -> Vec<(String, String)> {
995 let mut out: Vec<(String, String)> = Vec::new();
996 // Use per-word cells, not the line-merged `cells`: a link rect covers a few
997 // words on a line, and a whole merged line cell would over-capture (its centre
998 // lands in one link's rect, grabbing the entire line as that link's anchor).
999 let words = if page.word_cells.is_empty() {
1000 &page.cells
1001 } else {
1002 &page.word_cells
1003 };
1004 for link in &page.links {
1005 // A cell participates when its centre row is inside the rect and it
1006 // overlaps the rect horizontally. A cell can be *wider* than the rect:
1007 // PDFs often draw a whole header line as one text run ("LinkedIn |
1008 // GitHub | Credly"), which docling-parse's word grouping keeps as one
1009 // cell even though each label carries its own link annotation —
1010 // centre-in-rect alone would hand the entire line to every link.
1011 // [`cell_text_in_rect`] clips such a cell to the tokens under the rect.
1012 let mut inside: Vec<(&TextCell, String)> = words
1013 .iter()
1014 .filter(|c| {
1015 let cy = (c.t + c.b) / 2.0;
1016 cy >= link.t && cy <= link.b && c.r.min(link.r) > c.l.max(link.l)
1017 })
1018 .filter_map(|c| {
1019 let text = cell_text_in_rect(c, link.l, link.r);
1020 (!text.is_empty()).then_some((c, text))
1021 })
1022 .collect();
1023 // Reading order: top band then left-to-right (link anchors are LTR).
1024 let band = inside
1025 .iter()
1026 .map(|(c, _)| (c.b - c.t).abs())
1027 .fold(0.0f32, f32::max)
1028 .max(1.0);
1029 inside.sort_by_key(|(c, _)| ((c.t / band).round() as i64, (c.l * 10.0) as i64));
1030 let anchor = clean_text(
1031 &inside
1032 .iter()
1033 .map(|(_, t)| t.trim())
1034 .filter(|t| !t.is_empty())
1035 .collect::<Vec<_>>()
1036 .join(" "),
1037 );
1038 if anchor.is_empty() {
1039 continue;
1040 }
1041 if out
1042 .last()
1043 .is_some_and(|(a, u)| a == &anchor && u == &link.uri)
1044 {
1045 continue;
1046 }
1047 out.push((anchor, link.uri.clone()));
1048 }
1049 out
1050}
1051
1052/// The part of a cell's text that lies under a link rect's x-range. A cell
1053/// fully inside the rect (by centre) returns its whole text. A wider cell is
1054/// split into whitespace tokens whose x-spans are estimated proportionally to
1055/// their character positions (kerning makes this approximate, so selection
1056/// snaps to whole tokens, never characters); tokens whose estimated centre
1057/// falls inside the rect are kept. Returns "" when nothing falls inside.
1058fn cell_text_in_rect(c: &TextCell, l: f32, r: f32) -> String {
1059 let cx = (c.l + c.r) / 2.0;
1060 if cx >= l && cx <= r && c.l >= l - (c.r - c.l) * 0.25 && c.r <= r + (c.r - c.l) * 0.25 {
1061 return c.text.trim().to_string();
1062 }
1063 let chars: Vec<char> = c.text.chars().collect();
1064 let n = chars.len();
1065 if n == 0 || c.r <= c.l {
1066 return String::new();
1067 }
1068 let per = (c.r - c.l) / n as f32;
1069 let mut out: Vec<String> = Vec::new();
1070 let mut token = String::new();
1071 let mut start = 0usize;
1072 // A trailing sentinel space flushes the last token.
1073 for (i, &ch) in chars.iter().enumerate().chain(std::iter::once((n, &' '))) {
1074 if ch.is_whitespace() {
1075 if !token.is_empty() {
1076 let mid = c.l + (start as f32 + (i - start) as f32 / 2.0) * per;
1077 if mid >= l && mid <= r {
1078 out.push(std::mem::take(&mut token));
1079 } else {
1080 token.clear();
1081 }
1082 }
1083 } else {
1084 if token.is_empty() {
1085 start = i;
1086 }
1087 token.push(ch);
1088 }
1089 }
1090 out.join(" ")
1091}
1092
1093/// Cells assigned to a region (best container), in reading order, joined.
1094fn region_text(region: &Region, cells: &[TextCell]) -> String {
1095 let inside: Vec<&TextCell> = cells
1096 .iter()
1097 .filter(|c| {
1098 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
1099 inter(region, c.l, c.t, c.r, c.b) / ca > 0.5
1100 })
1101 .collect();
1102 cells_text(inside)
1103}
1104
1105/// docling's exclusive cell assignment (`_assign_cells_to_clusters`): every
1106/// non-empty cell goes to the single best-overlapping *regular* region at
1107/// intersection-over-self > 0.2, and each region serializes exactly its
1108/// assigned cells. A cell under two overlapping boxes is emitted once (by the
1109/// better-covering one), and a cell only partially under its region — e.g.
1110/// normal_4pages' big section numeral, ~30 % inside the heading box — still
1111/// joins it (`## 들어가며 1`) instead of leaking as an orphan. Pictures and
1112/// wrappers never claim (docling walks regular clusters only); ties go to the
1113/// first region, like docling's strict `>` best-overlap scan.
1114pub fn region_texts_exclusive(regions: &[Region], cells: &[TextCell]) -> Vec<String> {
1115 let claimer: Vec<bool> = regions
1116 .iter()
1117 .map(|r| r.label != "picture" && !is_wrapper(r.label))
1118 .collect();
1119 let mut owned: Vec<Vec<&TextCell>> = vec![Vec::new(); regions.len()];
1120 for c in cells {
1121 if c.text.trim().is_empty() {
1122 continue;
1123 }
1124 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
1125 let mut best: Option<(usize, f32)> = None;
1126 for (i, r) in regions.iter().enumerate() {
1127 if !claimer[i] {
1128 continue;
1129 }
1130 let ov = inter(r, c.l, c.t, c.r, c.b) / ca;
1131 if ov > 0.2 && best.is_none_or(|(_, b)| ov > b) {
1132 best = Some((i, ov));
1133 }
1134 }
1135 if let Some((i, _)) = best {
1136 owned[i].push(c);
1137 }
1138 }
1139 // Non-claimers (tables/wrappers/pictures) keep the inclusive > 0.5 text:
1140 // docling fills a special cluster's cells from its contained children, and
1141 // downstream table assembly gates on that text being non-empty.
1142 regions
1143 .iter()
1144 .zip(owned)
1145 .map(|(r, cs)| {
1146 if r.label != "picture" && !is_wrapper(r.label) {
1147 cells_text(cs)
1148 } else {
1149 region_text(r, cells)
1150 }
1151 })
1152 .collect()
1153}
1154
1155/// Join a prefiltered cell list into the region's text (docling's
1156/// `sanitize_text` on the docling-parse path, gap-aware band join on legacy).
1157fn cells_text(mut inside: Vec<&TextCell>) -> String {
1158 // Quantize the top coordinate into ~line bands so cells on the same line
1159 // sort in reading order; this is a strict total order (a raw fuzzy comparator
1160 // is not transitive and makes Rust's sort panic). For a right-to-left
1161 // (Arabic-majority) region, cells on a line read right→left, so sort the band
1162 // by descending left edge.
1163 let band = inside
1164 .iter()
1165 .map(|c| (c.b - c.t).abs())
1166 .fold(0.0f32, f32::max)
1167 .max(1.0);
1168 let arabic = inside
1169 .iter()
1170 .flat_map(|c| c.text.chars())
1171 .filter(|&c| ('\u{0600}'..='\u{06FF}').contains(&c))
1172 .count();
1173 let latin = inside
1174 .iter()
1175 .flat_map(|c| c.text.chars())
1176 .filter(|c| c.is_ascii_alphabetic())
1177 .count();
1178 let rtl = arabic > latin;
1179 let dp = crate::pdfium_backend::use_dp_lines();
1180 if dp {
1181 // docling orders a cluster's cells by their docling-parse cell index
1182 // alone (`LayoutPostprocessor._sort_cells`: `sorted(cells, key=c.index)`)
1183 // — the sanitizer's output order, which our `cells` slice already is.
1184 // No geometric re-sort: normal_4pages' big section numerals paint
1185 // *after* their heading text, and docling's `## 들어가며 1` (numeral
1186 // last) only falls out of pure index order — a band sort dragged the
1187 // numeral to the front. The overlap-grouped line restore this replaced
1188 // measured strictly worse on the corpus (it fixed nothing the index
1189 // order broke, and broke the numerals).
1190 } else {
1191 inside.sort_by_key(|c| {
1192 let x = (c.l * 10.0) as i64;
1193 ((c.t / band).round() as i64, if rtl { -x } else { x })
1194 });
1195 }
1196 let joined = if dp {
1197 // docling's `PageAssembleModel.sanitize_text`, ported verbatim over the
1198 // parse-index-ordered lines: append a separating space to a line —
1199 // unless it ends with `-`. A dash-ending line whose last word and the
1200 // next line's first word are both alphanumeric is a wrapped word: the
1201 // dash is dropped and the lines fuse (`platforms-` + `reflects` →
1202 // `platformsreflects`, `pp. 545-` + `561` → `545561`). Any other
1203 // dash-ending line — e.g. the *bare* `-` cell a superscript ORCID or an
1204 // inline `–` bullet splits off (its word list is empty, so the fuse
1205 // test fails) — keeps its dash and still takes no trailing space:
1206 // `[0000` `-` `0002` joins as docling's `[0000 -0002`, and the OTSL
1207 // list's `-` + `"C" cell -` + `a new table cell` collapses to
1208 // `-"C" cell a new table cell`. Our cells still carry the raw dash
1209 // family (docling-parse normalizes to `-` before this; clean_text does
1210 // it after), so the endswith test matches them all.
1211 let texts: Vec<&str> = inside
1212 .iter()
1213 .map(|c| c.text.trim())
1214 // Skip whitespace-only cells (a justified line's trailing space
1215 // glyph): an empty line would double the separator.
1216 .filter(|t| !t.is_empty())
1217 .collect();
1218 let last_word_alnum = |s: &str| {
1219 s.split(|c: char| !(c.is_alphanumeric() || c == '_'))
1220 .rfind(|w| !w.is_empty())
1221 .is_some_and(|w| w.chars().all(char::is_alphanumeric))
1222 };
1223 let first_word_alnum = |s: &str| {
1224 s.split(|c: char| !(c.is_alphanumeric() || c == '_'))
1225 .find(|w| !w.is_empty())
1226 .is_some_and(|w| w.chars().all(char::is_alphanumeric))
1227 };
1228 let mut out = String::new();
1229 for (i, t) in texts.iter().enumerate() {
1230 if i > 0 {
1231 let prev = texts[i - 1];
1232 let dashish = matches!(
1233 prev.chars().last(),
1234 Some(
1235 '-' | '\u{2010}'
1236 | '\u{2011}'
1237 | '\u{2012}'
1238 | '\u{2013}'
1239 | '\u{2014}'
1240 | '\u{2015}'
1241 | '\u{2212}'
1242 )
1243 );
1244 if dashish {
1245 if last_word_alnum(prev) && first_word_alnum(t) {
1246 out.pop(); // wrapped word: fuse without the dash
1247 }
1248 // dash-ending line never takes a separating space
1249 } else {
1250 out.push(' ');
1251 }
1252 }
1253 out.push_str(t);
1254 }
1255 out
1256 } else {
1257 // Legacy reconstruction: join same-band cells with a space only across a
1258 // real gap, because it can split a word into abutting segments
1259 // (`الت`|`ي` → `التي`).
1260 let mut out = String::new();
1261 let mut prev: Option<&&TextCell> = None;
1262 for c in &inside {
1263 let t = c.text.trim();
1264 if t.is_empty() {
1265 continue;
1266 }
1267 if let Some(p) = prev {
1268 let same_band = ((p.t / band).round() as i64) == ((c.t / band).round() as i64);
1269 let h = (c.b - c.t).abs().max((p.b - p.t).abs()).max(1.0);
1270 let gap = if rtl { p.l - c.r } else { c.l - p.r };
1271 if !same_band || gap > h * 0.25 {
1272 out.push(' ');
1273 }
1274 }
1275 out.push_str(t);
1276 prev = Some(c);
1277 }
1278 out
1279 };
1280 clean_text(&joined)
1281}
1282
1283/// Tighten the spaces pdfium leaves around tight punctuation in a code line
1284/// (`console .log` → `console.log`, `add (3 , 5)` → `add(3, 5)`), matching
1285/// docling-parse's source spacing.
1286fn tighten_code_punct(s: &str) -> String {
1287 s.replace(" .", ".")
1288 .replace(" ,", ",")
1289 .replace(" ;", ";")
1290 .replace(" )", ")")
1291 .replace(" (", "(")
1292}
1293
1294/// Assemble a **code** region's text with its line structure preserved.
1295///
1296/// Unlike [`region_text`] — which joins every cell with a single space, the right
1297/// thing for prose reflow — a code block's line breaks and indentation are
1298/// significant. The `code_cells` are already one physical source line each
1299/// (grouped space-glyph-only, so monospace runs keep their spacing), so this:
1300///
1301/// 1. groups the cells into vertical line bands and orders them top→bottom,
1302/// left→right;
1303/// 2. joins the lines with `\n` (rather than spaces), keeping the carriage
1304/// returns; and
1305/// 3. reconstructs each line's leading indentation from its left offset, in units
1306/// of the block's estimated monospace character width, so nesting survives.
1307///
1308/// Typography is normalized per line via [`clean_text`] (smart quotes, dashes,
1309/// ellipsis), which never merges lines. Returns an empty string if the region has
1310/// no code cells (the caller falls back to the prose text).
1311fn code_region_text(region: &Region, cells: &[TextCell]) -> String {
1312 let mut inside: Vec<&TextCell> = cells
1313 .iter()
1314 .filter(|c| {
1315 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
1316 inter(region, c.l, c.t, c.r, c.b) / ca > 0.5
1317 })
1318 .filter(|c| !c.text.trim().is_empty())
1319 .collect();
1320 if inside.is_empty() {
1321 return String::new();
1322 }
1323
1324 // Quantize the top edge into ~line bands (like `region_text`), then order the
1325 // cells by band (top→bottom) and, within a band, by left edge.
1326 let band = inside
1327 .iter()
1328 .map(|c| (c.b - c.t).abs())
1329 .fold(0.0f32, f32::max)
1330 .max(1.0);
1331 let line_of = |c: &TextCell| (c.t / band).round() as i64;
1332 inside.sort_by_key(|c| (line_of(c), (c.l * 10.0) as i64));
1333
1334 // Estimate one monospace character's width (total ink width / total glyphs) to
1335 // convert a line's left offset into a count of leading spaces. Measured over
1336 // all lines so a single short line can't skew it.
1337 let (mut total_w, mut total_chars) = (0.0f32, 0usize);
1338 for c in &inside {
1339 let n = c.text.trim().chars().count();
1340 if n > 0 {
1341 total_w += (c.r - c.l).max(0.0);
1342 total_chars += n;
1343 }
1344 }
1345 let char_w = if total_chars > 0 {
1346 (total_w / total_chars as f32).max(1.0)
1347 } else {
1348 1.0
1349 };
1350 // The block's own left margin is the zero-indent baseline.
1351 let base_l = inside.iter().map(|c| c.l).fold(f32::INFINITY, f32::min);
1352
1353 let mut lines: Vec<String> = Vec::new();
1354 let mut cur: Option<i64> = None;
1355 for c in &inside {
1356 // Tighten pdfium's spaced punctuation per line (on the trimmed content, so
1357 // the reconstructed leading indentation is never nibbled).
1358 let text = tighten_code_punct(&clean_text(c.text.trim()));
1359 if Some(line_of(c)) == cur {
1360 // A second cell sharing this band (rare — e.g. split columns): keep it
1361 // on the same source line, separated by a space.
1362 if let Some(last) = lines.last_mut() {
1363 last.push(' ');
1364 last.push_str(&text);
1365 }
1366 continue;
1367 }
1368 let indent = ((c.l - base_l) / char_w).round().max(0.0) as usize;
1369 lines.push(format!("{}{}", " ".repeat(indent), text));
1370 cur = Some(line_of(c));
1371 }
1372 lines.join("\n")
1373}
1374
1375/// Reconstruct a table's grid geometrically from the text cells inside its
1376/// region: cluster cells into rows (by vertical centre) and columns (by clustered
1377/// left edges), then place each cell. A model-free stand-in for TableFormer that
1378/// recovers grid-aligned tables from the precise PDF text layer (it does not
1379/// resolve row/column spans).
1380pub fn reconstruct_table(region: &Region, cells: &[TextCell]) -> Vec<Vec<String>> {
1381 let mut inside: Vec<&TextCell> = cells
1382 .iter()
1383 .filter(|c| {
1384 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
1385 inter(region, c.l, c.t, c.r, c.b) / ca > 0.5
1386 })
1387 .collect();
1388 if inside.is_empty() {
1389 return Vec::new();
1390 }
1391 inside.sort_by(|a, b| a.t.total_cmp(&b.t));
1392
1393 // Rows: consecutive cells whose vertical centre is within ~0.7 line height.
1394 let mut rows: Vec<(f32, Vec<&TextCell>)> = Vec::new();
1395 for c in &inside {
1396 let cyc = (c.t + c.b) / 2.0;
1397 let lh = (c.b - c.t).abs().max(1.0);
1398 if let Some((ryc, row)) = rows.last_mut() {
1399 if (cyc - *ryc).abs() < lh * 0.7 {
1400 row.push(c);
1401 continue;
1402 }
1403 }
1404 rows.push((cyc, vec![c]));
1405 }
1406
1407 // Columns: cluster left edges (merge those within a tolerance).
1408 let tol = {
1409 let mut hs: Vec<f32> = inside.iter().map(|c| (c.b - c.t).abs()).collect();
1410 hs.sort_by(f32::total_cmp);
1411 hs[hs.len() / 2].max(4.0) * 1.5
1412 };
1413 let mut lefts: Vec<f32> = inside.iter().map(|c| c.l).collect();
1414 lefts.sort_by(f32::total_cmp);
1415 let mut col_starts: Vec<f32> = Vec::new();
1416 for l in lefts {
1417 if col_starts.last().is_none_or(|&last| l - last > tol) {
1418 col_starts.push(l);
1419 }
1420 }
1421 let ncols = col_starts.len().max(1);
1422 let col_of = |l: f32| -> usize {
1423 col_starts
1424 .iter()
1425 .rposition(|&s| l + tol * 0.5 >= s)
1426 .unwrap_or(0)
1427 .min(ncols - 1)
1428 };
1429
1430 let mut grid = Vec::with_capacity(rows.len());
1431 for (_, mut row) in rows {
1432 row.sort_by(|a, b| a.l.total_cmp(&b.l));
1433 let mut cols = vec![String::new(); ncols];
1434 for c in row {
1435 let ci = col_of(c.l);
1436 // Strip the wrap-hyphen control char so it never lands in a cell.
1437 let t = c.text.trim().replace(['\u{2}', '\u{ad}'], "");
1438 if cols[ci].is_empty() {
1439 cols[ci] = t;
1440 } else {
1441 cols[ci].push(' ');
1442 cols[ci].push_str(&t);
1443 }
1444 }
1445 grid.push(cols);
1446 }
1447 grid
1448}
1449
1450/// Does the geometric reconstruction of a table look trustworthy enough to use
1451/// as-is, instead of paying for TableFormer?
1452///
1453/// [`reconstruct_table`] derives columns by clustering cell **left edges**. On a
1454/// clean grid that is exact, but when a column's entries are not left-aligned
1455/// (or the OCR boxes wobble) the clustering splits one real column into several,
1456/// and the result is a wide, mostly-empty grid — the "spurious empty columns"
1457/// failure TableFormer exists to fix.
1458///
1459/// Two symptoms separate the two cases, and both are properties of the grid
1460/// alone (no model needed):
1461/// * **density** — a real table is mostly full; a split-up one is mostly holes;
1462/// * **thin columns** — a column carrying at most one entry across several rows
1463/// is almost always a split artefact rather than a real column.
1464///
1465/// Deliberately conservative: it answers `true` only for grids that are plainly
1466/// well-formed, so the expensive path stays the default whenever there is doubt.
1467/// A caller that skips TableFormer on `true` trades no quality for the time.
1468pub fn geometric_table_is_reliable(rows: &[Vec<String>]) -> bool {
1469 let ncols = rows.iter().map(Vec::len).max().unwrap_or(0);
1470 // Fewer than two columns is not a grid this heuristic can vouch for: it is
1471 // exactly the shape a collapsed table takes, and TableFormer may recover
1472 // real structure from it.
1473 if rows.len() < 2 || ncols < 2 {
1474 return false;
1475 }
1476 let filled = |c: &String| !c.trim().is_empty();
1477 let total = rows.len() * ncols;
1478 let full = rows.iter().flatten().filter(|c| filled(c)).count();
1479 if (full as f32) < MIN_TABLE_FILL * total as f32 {
1480 return false;
1481 }
1482 // A column used by at most one row, when there are rows enough to tell.
1483 if rows.len() >= 3 {
1484 for ci in 0..ncols {
1485 let used = rows
1486 .iter()
1487 .filter(|r| r.get(ci).is_some_and(filled))
1488 .count();
1489 if used <= 1 {
1490 return false;
1491 }
1492 }
1493 }
1494 true
1495}
1496
1497/// Share of a geometric grid's cells that must carry text for it to be trusted
1498/// without TableFormer. Chosen well above the density a left-edge split
1499/// produces (those land nearer a third) and below what a genuine table with a
1500/// few blank cells reaches.
1501const MIN_TABLE_FILL: f32 = 0.6;
1502
1503/// The union bbox of the text cells assigned to a region (same >50%-overlap
1504/// rule as [`region_text`]), or `None` when no cell lands in it. docling's
1505/// LayoutPostprocessor shrinks a regular cluster's bbox to its cells, and the
1506/// enrichment crops are taken from that cell-tight box — cropping the raw
1507/// detector box instead hands the VLM surrounding chrome (e.g. the `Listing N:`
1508/// caption under a code block) that changes its output.
1509pub fn region_cell_bbox(region: &Region, cells: &[TextCell]) -> Option<[f32; 4]> {
1510 let mut bbox: Option<[f32; 4]> = None;
1511 for c in cells {
1512 let ca = area(c.l, c.t, c.r, c.b).max(1.0);
1513 if inter(region, c.l, c.t, c.r, c.b) / ca <= 0.5 {
1514 continue;
1515 }
1516 bbox = Some(match bbox {
1517 None => [c.l, c.t, c.r, c.b],
1518 Some([l, t, r, b]) => [l.min(c.l), t.min(c.t), r.max(c.r), b.max(c.b)],
1519 });
1520 }
1521 bbox
1522}
1523
1524/// One region's enrichment-model result, produced by the pipeline's opt-in
1525/// passes (issue #76) and applied during assembly.
1526#[derive(Debug, Clone)]
1527pub enum Enrichment {
1528 /// DocumentPictureClassifier predictions, descending confidence.
1529 PictureClasses(Vec<PictureClass>),
1530 /// CodeFormulaV2 output for a `code` region: the rewritten source text and
1531 /// the `<_language_>` prefix (when the model emitted one).
1532 Code {
1533 language: Option<String>,
1534 text: String,
1535 },
1536 /// CodeFormulaV2 output for a `formula` region: the decoded LaTeX.
1537 Formula { latex: String },
1538}
1539
1540/// Crop a region (page points, already expanded by the caller if needed) from
1541/// the rendered page image and resize it to `target_scale` pixels per point —
1542/// the enrichment-model equivalent of docling's
1543/// `page.get_image(scale=…, cropbox=…)`, sourced from the existing
1544/// [`crate::pdfium_backend::RENDER_SCALE`] render instead of a fresh pdfium
1545/// pass (the page bitmap is already the exact docling render at scale 2).
1546#[cfg(feature = "ml")]
1547pub fn crop_region_scaled(page: &PdfPage, bbox: [f32; 4], target_scale: f32) -> Option<RgbImage> {
1548 let s = page.scale;
1549 let [l, t, r, b] = bbox;
1550 let (iw, ih) = (page.image.width(), page.image.height());
1551 let x = (l * s).max(0.0) as u32;
1552 let y = (t * s).max(0.0) as u32;
1553 if x >= iw || y >= ih {
1554 return None;
1555 }
1556 let w = (((r - l.max(0.0)) * s) as u32).min(iw - x);
1557 let h = (((b - t.max(0.0)) * s) as u32).min(ih - y);
1558 if w == 0 || h == 0 {
1559 return None;
1560 }
1561 let crop = image::imageops::crop_imm(&page.image, x, y, w, h).to_image();
1562 // docling renders the crop at `target_scale` directly; from the scale-2
1563 // page render that is a resize to the same pixel geometry
1564 // (`round(width_points * scale)`, PIL's BICUBIC ≙ CatmullRom).
1565 let tw = ((w as f32 / s) * target_scale).round().max(1.0) as u32;
1566 let th = ((h as f32 / s) * target_scale).round().max(1.0) as u32;
1567 if (tw, th) == (w, h) {
1568 return Some(crop);
1569 }
1570 Some(image::imageops::resize(
1571 &crop,
1572 tw,
1573 th,
1574 image::imageops::FilterType::CatmullRom,
1575 ))
1576}
1577
1578/// Crop a layout region from the rendered page image and encode it as PNG (the
1579/// figure bytes docling stores on a `PictureItem`). Region coordinates are page
1580/// points; the image is rendered at `page.scale`.
1581#[cfg(feature = "ocr-prep")]
1582fn crop_region(page: &PdfPage, region: &Region) -> Option<PictureImage> {
1583 let s = page.scale;
1584 let (iw, ih) = (page.image.width(), page.image.height());
1585 let x = (region.l * s).max(0.0) as u32;
1586 let y = (region.t * s).max(0.0) as u32;
1587 if x >= iw || y >= ih {
1588 return None;
1589 }
1590 let w = (((region.r - region.l) * s) as u32).min(iw - x);
1591 let h = (((region.b - region.t) * s) as u32).min(ih - y);
1592 if w == 0 || h == 0 {
1593 return None;
1594 }
1595 let sub = image::imageops::crop_imm(&page.image, x, y, w, h).to_image();
1596 let mut buf = std::io::Cursor::new(Vec::new());
1597 sub.write_to(&mut buf, image::ImageFormat::Png).ok()?;
1598 Some(PictureImage {
1599 mimetype: "image/png".into(),
1600 width: w,
1601 height: h,
1602 data: buf.into_inner(),
1603 })
1604}
1605
1606/// For each `picture` region, find the `caption` region closest below it (and
1607/// horizontally overlapping); docling pairs them and emits the caption first.
1608/// Each caption is claimed by at most one picture.
1609fn pair_captions(regions: &[Region]) -> Vec<Option<usize>> {
1610 let mut pairs = vec![None; regions.len()];
1611 let mut taken = vec![false; regions.len()];
1612 for (pi, p) in regions.iter().enumerate() {
1613 if p.label != "picture" {
1614 continue;
1615 }
1616 let mut best: Option<(usize, f32)> = None;
1617 for (ci, c) in regions.iter().enumerate() {
1618 if c.label != "caption" || taken[ci] {
1619 continue;
1620 }
1621 let line_h = (c.b - c.t).abs().max(1.0);
1622 let gap = c.t - p.b; // caption sits below the picture
1623 let h_overlap = (p.r.min(c.r) - p.l.max(c.l)).max(0.0);
1624 if gap > -line_h && gap < line_h * 3.0 && h_overlap > 0.0 {
1625 let dist = gap.abs();
1626 if best.is_none_or(|(_, bd)| dist < bd) {
1627 best = Some((ci, dist));
1628 }
1629 }
1630 }
1631 if let Some((ci, _)) = best {
1632 pairs[pi] = Some(ci);
1633 taken[ci] = true;
1634 }
1635 }
1636 pairs
1637}
1638
1639/// Pair each `code` region with the `caption` region just **above** it (a
1640/// `Listing N:` label). docling renders the code block first, then its caption,
1641/// so the caption is consumed from its own (earlier) reading-order slot and
1642/// re-emitted after the code.
1643fn pair_code_captions(regions: &[Region]) -> Vec<Option<usize>> {
1644 let mut pairs = vec![None; regions.len()];
1645 let mut taken = vec![false; regions.len()];
1646 for (pi, p) in regions.iter().enumerate() {
1647 if p.label != "code" {
1648 continue;
1649 }
1650 let mut best: Option<(usize, f32)> = None;
1651 for (ci, c) in regions.iter().enumerate() {
1652 if c.label != "caption" || taken[ci] {
1653 continue;
1654 }
1655 let line_h = (c.b - c.t).abs().max(1.0);
1656 let gap = p.t - c.b; // caption sits above the code
1657 let h_overlap = (p.r.min(c.r) - p.l.max(c.l)).max(0.0);
1658 if gap > -line_h && gap < line_h * 3.0 && h_overlap > 0.0 {
1659 let dist = gap.abs();
1660 if best.is_none_or(|(_, bd)| dist < bd) {
1661 best = Some((ci, dist));
1662 }
1663 }
1664 }
1665 if let Some((ci, _)) = best {
1666 pairs[pi] = Some(ci);
1667 taken[ci] = true;
1668 }
1669 }
1670 pairs
1671}
1672
1673/// Assemble one page from its (already overlap-resolved) layout regions and
1674/// text cells.
1675/// Normalize a layout region (page points, top-left origin) to DocLang's 0–511
1676/// location grid: `clamp(round(512 · coord / page_dim), 0, 511)`, per axis,
1677/// order `[x0, y0, x1, y1]`. Mirrors docling_core's
1678/// `_doclang_utils._create_location_tokens_for_bbox` (resolution 512) so the
1679/// emitted `<location>` tokens line up with the Python groundtruth. Our heron
1680/// cluster boxes match docling's to within ~1 grid unit; the residual (mainly
1681/// the aspect-ratio-stretch vs letterbox preprocessing difference) is absorbed
1682/// by the conformance harness's geometry tolerance.
1683fn norm_loc(region: &Region, page_w: f32, page_h: f32) -> [u16; 4] {
1684 let q = |v: f32, dim: f32| -> u16 {
1685 if dim <= 0.0 {
1686 return 0;
1687 }
1688 let g = (512.0 * (v as f64) / (dim as f64)).round() as i64;
1689 g.clamp(0, 511) as u16
1690 };
1691 [
1692 q(region.l, page_w),
1693 q(region.t, page_h),
1694 q(region.r, page_w),
1695 q(region.b, page_h),
1696 ]
1697}
1698
1699/// Wrap a node in its layout provenance so the DocLang serializer emits the four
1700/// `<location>` tokens as the element's head (Markdown/JSON render `inner`
1701/// unchanged).
1702fn located(loc: [u16; 4], inner: Node) -> Node {
1703 Node::Located {
1704 location: loc,
1705 inner: Box::new(inner),
1706 }
1707}
1708
1709/// Stamp the real 1-based page number onto a page's leading marker (see
1710/// [`assemble_page`], which emits it with `page_no: 0` because only the
1711/// document-level collector knows the true index — `--pages` windows shift it).
1712pub fn stamp_page_no(nodes: &mut [Node], page_no: usize) {
1713 if let Some(Node::PageInfo { page_no: p, .. }) = nodes.first_mut() {
1714 *p = page_no;
1715 }
1716}
1717
1718/// A dense table grid plus per-cell geometry, aligned position-for-position:
1719/// `boxes[r][c]` is cell `(r, c)`'s `[l, t, r, b]` in page points (top-left
1720/// origin); a spanned cell repeats its anchor's box over the covered
1721/// positions. Produced by the TableFormer paths (`tf_core`), consumed here
1722/// into [`docling_core::Table::cell_boxes`] (#238). Lives in this always-
1723/// compiled module so the pure-text (wasm `pdf-text`) build sees the type.
1724#[derive(Clone, Debug)]
1725pub struct TableGrid {
1726 pub rows: Vec<Vec<String>>,
1727 pub boxes: Vec<Vec<Option<[f32; 4]>>>,
1728}
1729
1730pub fn assemble_page(
1731 page: &PdfPage,
1732 regions: Vec<Region>,
1733 table_rows: &[Option<TableGrid>],
1734 enrichments: &[Option<Enrichment>],
1735) -> (Vec<Node>, Vec<(String, String)>) {
1736 let mut nodes: Vec<Node> = Vec::new();
1737 // Every page opens with an invisible page marker carrying its size in
1738 // points — what the JSON export needs to build docling's `pages` map and
1739 // denormalize the 0–511 `<location>` grid into point bboxes (#171). The
1740 // page *number* is stamped by the document-level collector (which knows
1741 // the real 1-based index, `--pages` windows included); every serializer
1742 // except JSON skips the marker, so Markdown/DocLang stay byte-identical.
1743 nodes.push(Node::PageInfo {
1744 page_no: 0,
1745 width: page.width,
1746 height: page.height,
1747 });
1748 // Recover this page's hyperlinks (anchor-precise pairs for strict
1749 // Markdown; whole-item docling-parity links are baked below and their
1750 // pairs dropped from this list so strict output doesn't double-wrap).
1751 let mut links = resolve_link_anchors(page);
1752 // Pair each region with its precomputed TableFormer grid and enrichment
1753 // (indexed by original order) and order by reading order together, so they
1754 // stay aligned.
1755 type RegionItem = (Region, Option<TableGrid>, Option<Enrichment>);
1756 let mut items: Vec<RegionItem> = regions
1757 .into_iter()
1758 .enumerate()
1759 .map(|(i, r)| {
1760 (
1761 r,
1762 table_rows.get(i).cloned().flatten(),
1763 enrichments.get(i).cloned().flatten(),
1764 )
1765 })
1766 .collect();
1767 order_regions(&mut items, page.width, page.height, |it| &it.0);
1768 // Float a margin page number to the front of reading order (docling parity:
1769 // right_to_left_02's bottom `11` is its first item). Stable, so everything
1770 // else keeps its order; no-op on pages without such a region.
1771 let page_h = page.height;
1772 items.sort_by_key(|(r, _, _)| !is_page_number(r, &page.cells, page_h));
1773 let table_rows: Vec<Option<TableGrid>> = items.iter().map(|(_, t, _)| t.clone()).collect();
1774 let enrichments: Vec<Option<Enrichment>> = items.iter().map(|(_, _, e)| e.clone()).collect();
1775 let regions: Vec<Region> = items.into_iter().map(|(r, _, _)| r).collect();
1776 // docling emits a figure's caption *before* the image marker. Pair each
1777 // picture with the caption region nearest below it and consume that caption,
1778 // so it isn't also emitted in its own (lower) reading-order position.
1779 let caption_for = pair_captions(®ions);
1780 let code_caption_for = pair_code_captions(®ions);
1781 let mut consumed = vec![false; regions.len()];
1782 for ci in caption_for.iter().flatten() {
1783 consumed[*ci] = true;
1784 }
1785 for ci in code_caption_for.iter().flatten() {
1786 consumed[*ci] = true;
1787 }
1788 // A code block's language label (`XML`, `C#`, …) is chrome, not content — the
1789 // detector emits it as its own region above the code; consume it.
1790 for (i, is_label) in code_language_labels(®ions, &page.cells)
1791 .into_iter()
1792 .enumerate()
1793 {
1794 if is_label {
1795 consumed[i] = true;
1796 }
1797 }
1798
1799 // docling `ReadingOrderPredictor.predict_merges`: join a text fragment with a
1800 // following text fragment strictly to its right (an author column that wraps
1801 // into the next, a paragraph continuing in the next column) into one block —
1802 // the intra-page half of docling's reading-order merges (cross-page/vertical
1803 // continuations stay with [`merge_continuations`]). Already-consumed regions
1804 // (paired captions, code labels) are excluded.
1805 // Exclusive docling cell assignment: computed once for the ordered region
1806 // list and reused for every serialization below, so a cell can never render
1807 // in two regions.
1808 let region_texts: Vec<String> = region_texts_exclusive(®ions, &page.cells);
1809 let is_text: Vec<bool> = regions
1810 .iter()
1811 .enumerate()
1812 .map(|(i, r)| r.label == "text" && !consumed[i])
1813 .collect();
1814 let is_skip: Vec<bool> = regions
1815 .iter()
1816 .enumerate()
1817 .map(|(i, r)| {
1818 consumed[i]
1819 || matches!(
1820 r.label,
1821 "page_header" | "page_footer" | "table" | "picture" | "caption" | "footnote"
1822 )
1823 })
1824 .collect();
1825 let boxes: Vec<(f32, f32, f32, f32)> = regions.iter().map(|r| (r.l, r.t, r.r, r.b)).collect();
1826 if docling_core::env::flag("DOCLING_RS_DEBUG_MERGES") {
1827 for (i, r) in regions.iter().enumerate() {
1828 eprintln!(
1829 "MRG {i:2} {} text={} skip={} [{:.0},{:.0},{:.0},{:.0}] {:?}",
1830 r.label,
1831 is_text[i],
1832 is_skip[i],
1833 r.l,
1834 r.t,
1835 r.r,
1836 r.b,
1837 region_texts[i].chars().take(40).collect::<String>()
1838 );
1839 }
1840 }
1841 let mut merge_suffix: Vec<String> = vec![String::new(); regions.len()];
1842 for (head, children) in
1843 crate::reading_order::predict_merges(&boxes, ®ion_texts, &is_text, &is_skip)
1844 .into_iter()
1845 .enumerate()
1846 {
1847 for c in children {
1848 let t = region_texts[c].trim();
1849 if !t.is_empty() {
1850 merge_suffix[head].push(' ');
1851 merge_suffix[head].push_str(t);
1852 }
1853 consumed[c] = true;
1854 }
1855 }
1856
1857 for (i, region) in regions.iter().enumerate() {
1858 if consumed[i] {
1859 continue;
1860 }
1861 // Page headers/footers: docling emits them as furniture blocks
1862 // (`<page_header>`/`<page_footer>` with a layer + location + text) at
1863 // their reading-order position, not as body — emit them, don't skip.
1864 if matches!(region.label, "page_header" | "page_footer") {
1865 let text = region_texts[i].clone();
1866 if !text.is_empty() {
1867 nodes.push(Node::PageFurniture {
1868 footer: region.label == "page_footer",
1869 location: norm_loc(region, page.width, page_h),
1870 text: md_escape(&text),
1871 });
1872 }
1873 continue;
1874 }
1875 if is_skipped(region.label) {
1876 continue;
1877 }
1878 // Layout provenance for this region, normalized to docling's 0–511 grid.
1879 let loc = norm_loc(region, page.width, page_h);
1880 if region.label == "picture" {
1881 // The figure pixels are cropped from the page render for image export.
1882 let caption = caption_for[i]
1883 .map(|ci| region_texts[ci].clone())
1884 .filter(|t| !t.is_empty());
1885 let classification = match &enrichments[i] {
1886 Some(Enrichment::PictureClasses(classes)) => Some(classes.clone()),
1887 _ => None,
1888 };
1889 // Without the page render (text-layer-only build) a picture keeps
1890 // its caption/classification but carries no cropped pixels.
1891 #[cfg(feature = "ocr-prep")]
1892 let image = crate::timing::timed("crop_region", || crop_region(page, region));
1893 #[cfg(not(feature = "ocr-prep"))]
1894 let image: Option<PictureImage> = None;
1895 nodes.push(located(
1896 loc,
1897 Node::Picture {
1898 caption,
1899 image,
1900 classification,
1901 },
1902 ));
1903 continue;
1904 }
1905 let mut text = region_texts[i].clone();
1906 text.push_str(&merge_suffix[i]);
1907 if text.is_empty() {
1908 continue;
1909 }
1910 match region.label {
1911 // docling assembles checkboxes as TEXT_ELEM items (the region's
1912 // cells are the option label, e.g. right_to_left_03's بلی/خير)
1913 // and its Markdown serializer renders them as task-list lines
1914 // (`- [x] …`) — mirrored by [`Node::CheckboxItem`].
1915 "checkbox_selected" | "checkbox_unselected" => nodes.push(Node::CheckboxItem {
1916 checked: region.label == "checkbox_selected",
1917 text: md_escape(&text),
1918 }),
1919 // docling renders both the document title and section headers as
1920 // `##` (it never emits a top-level `#` for PDFs), so match that.
1921 "title" | "section_header" => nodes.push(located(
1922 loc,
1923 Node::Heading {
1924 level: 2,
1925 text: md_escape(&text),
1926 },
1927 )),
1928 // docling drops the rendered bullet glyph; the Markdown serializer
1929 // adds its own `- ` marker. An item whose text opens with an `N.`
1930 // enumeration marker is an ordered item (rendered `N. text`).
1931 // A leading dash stays: it is an ordinary text glyph that
1932 // docling-parse keeps, and docling's items carry it into the
1933 // Markdown (2305's OTSL list renders `- -"C" cell …`) — only the
1934 // symbol-font bullets docling-parse filters out are stripped.
1935 "list_item" => {
1936 let stripped = text
1937 .trim_start_matches(['•', '◦', '▪', '·', '*'])
1938 .trim_start()
1939 .to_string();
1940 if let Some((number, rest)) = parse_ordered_marker(&stripped) {
1941 nodes.push(Node::ListItem {
1942 ordered: true,
1943 number,
1944 first_in_list: false,
1945 text: md_escape(&rest),
1946 level: 0,
1947 marker: None,
1948 location: Some(loc),
1949 dclx: None,
1950 href: None,
1951 layer: None,
1952 });
1953 } else {
1954 nodes.push(Node::ListItem {
1955 ordered: false,
1956 number: 0,
1957 first_in_list: false,
1958 text: md_escape(&stripped),
1959 level: 0,
1960 // docling keeps the bullet as the DocLang list marker
1961 // (`<ldiv><marker>·</marker></ldiv>`); Markdown ignores it.
1962 marker: Some("·".into()),
1963 location: Some(loc),
1964 dclx: None,
1965 href: None,
1966 layer: None,
1967 });
1968 }
1969 }
1970 // TableFormer structure (cells + spans, text matched from word cells)
1971 // when available; otherwise geometric grid reconstruction; finally a
1972 // single cell.
1973 "table" | "document_index" => {
1974 // TableFormer grids carry per-cell page-point boxes into the
1975 // public post-extraction API (#238); the geometric fallback
1976 // has no per-cell geometry.
1977 let (rows, cell_boxes) = match table_rows[i].clone() {
1978 Some(grid) => (grid.rows, Some(grid.boxes)),
1979 None => {
1980 let rows = reconstruct_table(region, &page.cells);
1981 let rows = if rows.iter().any(|r| r.len() > 1) {
1982 rows
1983 } else {
1984 vec![vec![text.clone()]]
1985 };
1986 (rows, None)
1987 }
1988 };
1989 nodes.push(located(
1990 loc,
1991 Node::Table(Table {
1992 rows,
1993 location: None,
1994 structure: None,
1995 cell_blocks: None,
1996 cell_boxes,
1997 caption: None,
1998 }),
1999 ));
2000 }
2001 // With formula enrichment the CodeFormula model decodes the region
2002 // to LaTeX; otherwise docling emits a placeholder comment rather
2003 // than the (garbled) raw glyph text.
2004 "formula" => match &enrichments[i] {
2005 Some(Enrichment::Formula { latex }) => nodes.push(Node::Formula {
2006 latex: latex.clone(),
2007 orig: text.clone(),
2008 location: Some(loc),
2009 }),
2010 _ => nodes.push(Node::Paragraph {
2011 text: "<!-- formula-not-decoded -->".into(),
2012 }),
2013 },
2014 // Code blocks: use the space-glyph-only grouping (monospace keeps its
2015 // source spacing) and emit a fenced block, preserving the line breaks
2016 // and indentation of the source (unlike prose, which reflows). pdfium
2017 // still inserts spaces around tight punctuation (`console .log`,
2018 // `add (3 , 5)`); tighten them to match docling-parse's source spacing.
2019 "code" => {
2020 // `code_region_text` preserves line breaks/indentation and tightens
2021 // each line itself; the fallback prose `text` is tightened here.
2022 let code = code_region_text(region, &page.code_cells);
2023 let code = if code.is_empty() {
2024 tighten_code_punct(&text)
2025 } else {
2026 code
2027 };
2028 // With code enrichment the CodeFormula model rewrites the block
2029 // (and names its language); `orig` keeps the raw extraction in
2030 // docling's shape — its parser has no line-preserving code
2031 // path, so its `orig` is the same code with the lines joined
2032 // by single spaces (indentation collapsed).
2033 // docling's parser has no line-preserving code path — its code
2034 // items carry the lines joined by single spaces. That flat
2035 // form is what every byte-conformance surface serializes
2036 // (legacy Markdown, JSON, DocLang); the line-preserving
2037 // extraction rides in `pretty` for strict Markdown only.
2038 let flat = code
2039 .lines()
2040 .map(str::trim)
2041 .filter(|l| !l.is_empty())
2042 .collect::<Vec<_>>()
2043 .join(" ");
2044 let node = match &enrichments[i] {
2045 Some(Enrichment::Code {
2046 language,
2047 text: enriched,
2048 }) => Node::Code {
2049 language: language.clone(),
2050 text: enriched.clone(),
2051 orig: Some(flat),
2052 pretty: None,
2053 },
2054 _ => Node::Code {
2055 language: None,
2056 text: flat,
2057 orig: None,
2058 pretty: Some(code),
2059 },
2060 };
2061 nodes.push(located(loc, node));
2062 // docling emits the `Listing N:` caption after the code block.
2063 if let Some(ci) = code_caption_for[i] {
2064 let cap = region_texts[ci].clone();
2065 if !cap.is_empty() {
2066 nodes.push(Node::Paragraph { text: cap });
2067 }
2068 }
2069 }
2070 // text, caption, footnote → paragraph
2071 _ => {
2072 // docling parity (`PageAssembleModel._match_hyperlink`): when
2073 // link annotations cover ≥ half of the region's box, the
2074 // hyperlink attaches to the item and the legacy Markdown
2075 // serializer wraps its full text — 2206.01062's footnote URLs
2076 // render as `[1 https://…](https://…)`. Sparse in-paragraph
2077 // citation links stay below the 0.5 coverage threshold and
2078 // remain plain text, exactly like docling.
2079 //
2080 // Scope: **footnote regions only.** Upstream's page_assemble
2081 // matches every TEXT_ELEM label, but published docling
2082 // observably carries the hyperlink into the document only for
2083 // footnote items — in both committed groundtruth generations
2084 // (docling-JSON and Markdown, independent runs) the fully
2085 // covered plain-text DOI line of 2206.01062 page 1 has
2086 // `hyperlink: None` while the equally covered footnotes carry
2087 // theirs. The corpus is the conformance reference, so match
2088 // the observed behavior; widen the label set if a future
2089 // groundtruth refresh starts linking plain text too.
2090 let escaped = md_escape(&text);
2091 let hyperlink = (region.label == "footnote")
2092 .then(|| region_hyperlink(region, &page.links))
2093 .flatten();
2094 let text = match hyperlink {
2095 Some(uri) => {
2096 // The strict-mode anchor pairs this item covers are
2097 // superseded by the baked whole-item link.
2098 links.retain(|(anchor, href)| {
2099 !(href == &uri && region_texts[i].contains(anchor.as_str()))
2100 });
2101 format!("[{escaped}]({uri})")
2102 }
2103 None => escaped,
2104 };
2105 nodes.push(located(loc, Node::Paragraph { text }))
2106 }
2107 }
2108 }
2109 // A `/Rotate`-normalized scanned page (see `pdfium_backend`) was assembled
2110 // in upright space; rotate the finished geometry back so locations and the
2111 // page size are display-space, like docling and every viewer report them.
2112 if page.rotation != 0 {
2113 rotate_nodes_to_display(&mut nodes, page.rotation);
2114 }
2115 (nodes, links)
2116}
2117
2118/// Rotate one 0–511 location bbox 90° clockwise on the grid (top-left origin):
2119/// `(x, y) → (511 - y, x)`.
2120fn rot_loc_cw(l: [u16; 4]) -> [u16; 4] {
2121 [511 - l[3], l[0], 511 - l[1], l[2]]
2122}
2123
2124/// Map upright-space geometry back to display space for a page whose `/Rotate`
2125/// was normalized away before inference: every `<location>` rotates `rot`°
2126/// clockwise on the 0–511 grid (the grid is per-axis normalized, so no page
2127/// dims are needed), and the `PageInfo` size returns to the display box. Node
2128/// text and order are untouched — reading order was decided upright, which is
2129/// the whole point.
2130fn rotate_nodes_to_display(nodes: &mut [Node], rot: u16) {
2131 let quarter_turns = (rot / 90) as usize;
2132 let rot_loc = |l: &mut [u16; 4]| {
2133 for _ in 0..quarter_turns {
2134 *l = rot_loc_cw(*l);
2135 }
2136 };
2137 fn walk(node: &mut Node, rot_loc: &impl Fn(&mut [u16; 4]), swap_dims: bool) {
2138 match node {
2139 Node::PageInfo { width, height, .. } => {
2140 if swap_dims {
2141 std::mem::swap(width, height);
2142 }
2143 }
2144 Node::Located { location, inner } => {
2145 rot_loc(location);
2146 walk(inner, rot_loc, swap_dims);
2147 }
2148 Node::Furniture { inner, .. } => walk(inner, rot_loc, swap_dims),
2149 Node::Group { children, .. } => {
2150 for c in children {
2151 walk(c, rot_loc, swap_dims);
2152 }
2153 }
2154 Node::ListItem { location, .. }
2155 | Node::Formula { location, .. }
2156 | Node::Chart { location, .. } => {
2157 if let Some(l) = location {
2158 rot_loc(l);
2159 }
2160 }
2161 Node::PageFurniture { location, .. } => rot_loc(location),
2162 Node::Table(t) => {
2163 if let Some(l) = &mut t.location {
2164 rot_loc(l);
2165 }
2166 }
2167 _ => {}
2168 }
2169 }
2170 let swap_dims = quarter_turns % 2 == 1;
2171 for node in nodes {
2172 walk(node, &rot_loc, swap_dims);
2173 }
2174}
2175
2176/// Merge paragraph fragments split across a column or page break. docling joins a
2177/// paragraph whose previous fragment ends mid-sentence (a letter, not sentence
2178/// punctuation) with a lowercase continuation: `…definition of` + `lists in…` →
2179/// `…definition of lists in…`. The fragments are consecutive paragraphs, or
2180/// separated only by figure(s) the text wraps around: a column whose body flows
2181/// past a figure resumes below it (`…The wing type that is` ⟶[figure]⟶ `the most
2182/// common…`), and docling emits the whole paragraph before the figure. A heading,
2183/// table, or list between them ends the paragraph (no merge).
2184/// A paragraph that is really a figure/table caption (`Fig. 1. …`, `Table 2 …`).
2185/// Used to skip an unpaired caption when stitching a paragraph that wraps around
2186/// a figure.
2187fn looks_like_caption(text: &str) -> bool {
2188 let head: String = text.trim_start().chars().take(14).collect();
2189 (head.starts_with("Fig") || head.starts_with("Table"))
2190 && head.contains(|c: char| c.is_ascii_digit())
2191}
2192
2193/// A paragraph fragment is "open" — i.e. it might continue into the next
2194/// paragraph — when it ends mid-word (a letter) or with a wrap hyphen/dash.
2195/// docling joins `vocab-` + `ulary` → `vocab- ulary`.
2196fn paragraph_is_open(text: &str) -> bool {
2197 // docling's merge head test (`.+([a-z,\-\u00AD])\s*`): at least two chars,
2198 // ending in an ASCII lowercase letter, a comma, a hyphen, or a soft
2199 // hyphen. The comma matters: 2206's "…In phase four," resumes across the
2200 // page break. Uppercase/non-Latin endings do not merge, exactly as
2201 // upstream (the dash family is already `-` here — clean_text normalized).
2202 let t = text.trim_end();
2203 t.chars().count() >= 2
2204 && t.chars()
2205 .next_back()
2206 .is_some_and(|c| matches!(c, 'a'..='z' | ',' | '-' | '\u{ad}'))
2207}
2208
2209/// The paragraph text inside a node, looking through a [`Node::Located`]
2210/// provenance wrapper (PDF body paragraphs are wrapped since they carry a
2211/// `<location>`). Returns `None` for non-paragraph nodes.
2212fn as_paragraph(n: &Node) -> Option<&str> {
2213 match n {
2214 Node::Paragraph { text } => Some(text),
2215 Node::Located { inner, .. } => match inner.as_ref() {
2216 Node::Paragraph { text } => Some(text),
2217 _ => None,
2218 },
2219 _ => None,
2220 }
2221}
2222
2223/// Whether a node is a picture, looking through a [`Node::Located`] wrapper.
2224fn is_picture_node(n: &Node) -> bool {
2225 match n {
2226 Node::Picture { .. } => true,
2227 Node::Located { inner, .. } => matches!(inner.as_ref(), Node::Picture { .. }),
2228 _ => false,
2229 }
2230}
2231
2232/// A node a forward paragraph merge looks straight past: a figure or *table*
2233/// the text wraps around, or a page header/footer that falls between the two
2234/// fragments of a paragraph continuing across a page break (docling's merge
2235/// skip-labels: page_header, page_footer, table, picture, caption, footnote —
2236/// 2206's "…In phase four," resumes after a full caption+table+figure block).
2237fn is_merge_trailer(n: &Node) -> bool {
2238 is_picture_node(n)
2239 || matches!(
2240 n,
2241 Node::PageFurniture { .. } | Node::PageInfo { .. } | Node::Table(_)
2242 )
2243 || matches!(n, Node::Located { inner, .. } if matches!(inner.as_ref(), Node::Table(_)))
2244 || as_paragraph(n).is_some_and(looks_like_caption)
2245}
2246
2247/// Rebuild node `i` as a paragraph with `text`, preserving its `<location>`
2248/// wrapper (and thus provenance) if it had one.
2249fn reparagraph(node: &Node, text: String) -> Node {
2250 match node {
2251 Node::Located { location, .. } => located(*location, Node::Paragraph { text }),
2252 _ => Node::Paragraph { text },
2253 }
2254}
2255
2256pub(crate) fn merge_continuations(nodes: &mut Vec<Node>) {
2257 let mut i = 0;
2258 while i + 1 < nodes.len() {
2259 let Some(a) = as_paragraph(&nodes[i]) else {
2260 i += 1;
2261 continue;
2262 };
2263 // A figure/table caption is a self-contained unit; body text resuming
2264 // after a figure is the continuation case, not the caption itself. Never
2265 // stitch *from* a caption — otherwise a caption that ends in a lone glyph
2266 // (`Fig. 5. … PubTabNet. μ`) would swallow a following stray figure label
2267 // (a standalone `μ`) into `… μ μ`.
2268 if looks_like_caption(a) {
2269 i += 1;
2270 continue;
2271 }
2272 if !paragraph_is_open(a) {
2273 i += 1;
2274 continue;
2275 }
2276 // The continuation is the next paragraph, looking past any figures the
2277 // text wraps around — and a figure/table caption that was emitted as its
2278 // own paragraph (an above-the-figure caption that didn't pair), since the
2279 // body text resumes after the whole figure+caption block.
2280 let mut j = i + 1;
2281 while nodes.get(j).is_some_and(is_merge_trailer) {
2282 j += 1;
2283 }
2284 // docling's continuation regex allows either case, but its merge runs
2285 // over the pre-assembly element stream; at node level an uppercase
2286 // start is overwhelmingly a new sentence/heading fragment (allowing it
2287 // swallowed 2305's formula blocks and redp's chapter openers), so the
2288 // continuation stays lowercase-start here.
2289 let cont = nodes.get(j).and_then(as_paragraph).is_some_and(|b| {
2290 b.trim_start()
2291 .chars()
2292 .next()
2293 .is_some_and(char::is_lowercase)
2294 });
2295 if cont {
2296 let a = as_paragraph(&nodes[i]).unwrap().trim_end().to_string();
2297 let b = as_paragraph(&nodes[j]).unwrap().trim_start().to_string();
2298 // Keep node i's provenance wrapper; docling's merged paragraph keeps
2299 // the first fragment's geometry as its primary location.
2300 nodes[i] = reparagraph(&nodes[i], format!("{a} {b}"));
2301 nodes.remove(j);
2302 // Re-check i: the merged paragraph may continue further.
2303 } else {
2304 i += 1;
2305 }
2306 }
2307}
2308
2309/// How many leading nodes of `nodes` are safe to flush now — i.e. cannot be
2310/// rewritten by a future [`merge_continuations`] once more pages are appended.
2311///
2312/// A forward merge can only start from an "open" paragraph (ends mid-word) and
2313/// only reaches across trailing pictures and figure/table captions. So we scan
2314/// from the end past those skippable trailers: if the first non-skippable node is
2315/// an open paragraph, it (and the trailers after it) must be held; anything else —
2316/// a closed paragraph, a heading, a table, a list — blocks any forward merge, so
2317/// the whole buffer is safe to flush.
2318fn hold_start(nodes: &[Node]) -> usize {
2319 for k in (0..nodes.len()).rev() {
2320 // Skippable trailers (figures, page furniture, captions): a forward merge
2321 // looks straight past them.
2322 if is_merge_trailer(&nodes[k]) {
2323 continue;
2324 }
2325 match as_paragraph(&nodes[k]) {
2326 // An open body paragraph might still pull a continuation off the next
2327 // page — hold from here to the end.
2328 Some(text) if paragraph_is_open(text) => return k,
2329 // A closed paragraph, heading, table, list, etc. ends the paragraph:
2330 // nothing after it can merge backwards across it. Flush everything.
2331 _ => return nodes.len(),
2332 }
2333 }
2334 // Only skippable trailers (or empty) and no open paragraph to anchor a merge.
2335 nodes.len()
2336}
2337
2338/// Streaming counterpart of [`merge_continuations`]: feed per-page node batches in
2339/// document order and get back the prefix that is final (its cross-page merges are
2340/// resolved and no future page can change it), holding back only the small tail
2341/// that might still merge into the next page. Concatenating every flushed batch
2342/// (then [`finish`](Self::finish)) yields exactly the same nodes as running
2343/// [`merge_continuations`] once over the whole document.
2344pub(crate) struct StreamAssembler {
2345 pending: Vec<Node>,
2346}
2347
2348impl StreamAssembler {
2349 pub(crate) fn new() -> Self {
2350 Self {
2351 pending: Vec::new(),
2352 }
2353 }
2354
2355 /// Append one page's nodes, resolve merges within the buffer, and return the
2356 /// now-final prefix to emit (possibly empty).
2357 pub(crate) fn push(&mut self, mut nodes: Vec<Node>) -> Vec<Node> {
2358 self.pending.append(&mut nodes);
2359 merge_continuations(&mut self.pending);
2360 let cut = hold_start(&self.pending);
2361 let tail = self.pending.split_off(cut);
2362 std::mem::replace(&mut self.pending, tail)
2363 }
2364
2365 /// Flush whatever is left after the last page (the held tail is final once no
2366 /// more pages can follow).
2367 pub(crate) fn finish(self) -> Vec<Node> {
2368 self.pending
2369 }
2370}
2371
2372#[cfg(test)]
2373mod tests {
2374 use super::clean_text;
2375 use super::{code_region_text, merge_continuations, resolve_link_anchors, StreamAssembler};
2376 use crate::layout::Region;
2377 use crate::pdfium_backend::{LinkAnnot, PdfPage, TextCell};
2378 use docling_core::Node;
2379
2380 /// The int8-layout guard's coverage metric: cells under detections count,
2381 /// cells outside don't, whitespace cells are ignored, and a cell-less page
2382 /// reads as fully covered (nothing to rescue).
2383 #[test]
2384 fn layout_cell_coverage_counts_claimed_text_cells() {
2385 let cell = |text: &str, l: f32, t: f32| TextCell {
2386 text: text.into(),
2387 l,
2388 t,
2389 r: l + 40.0,
2390 b: t + 10.0,
2391 };
2392 let region = Region {
2393 label: "text",
2394 score: 0.9,
2395 l: 0.0,
2396 t: 0.0,
2397 r: 100.0,
2398 b: 50.0,
2399 };
2400 let cells = vec![
2401 cell("inside", 10.0, 10.0),
2402 cell("also inside", 10.0, 30.0),
2403 cell("outside", 10.0, 200.0),
2404 cell(" ", 10.0, 210.0), // whitespace: not counted at all
2405 ];
2406 let cov = super::layout_cell_coverage(std::slice::from_ref(®ion), &cells);
2407 assert!((cov - 2.0 / 3.0).abs() < 1e-6, "got {cov}");
2408 assert_eq!(super::layout_cell_coverage(&[], &[]), 1.0);
2409 assert_eq!(super::layout_cell_coverage(&[], &cells), 0.0);
2410 }
2411
2412 /// #165: a picture no longer claims cells at 0.2 intersection-over-self.
2413 /// A line straddling the figure border (≤80 % contained) becomes an orphan
2414 /// region and survives the contained-regulars drop — before the fix its
2415 /// cells were silently erased. A line fully inside the picture is still
2416 /// re-dropped, matching docling's Markdown (a picture's children never
2417 /// reach its serializer's output).
2418 #[test]
2419 fn border_straddling_lines_survive_picture_interior_is_still_dropped() {
2420 let pic = Region {
2421 label: "picture",
2422 score: 0.9,
2423 l: 0.0,
2424 t: 0.0,
2425 r: 100.0,
2426 b: 100.0,
2427 };
2428 // ~35 % of this cell overlaps the picture (l=90..120 of 0..100): above
2429 // the old 0.2 claim (was swallowed), below full containment (survives).
2430 let straddler = TextCell {
2431 text: "axis label".into(),
2432 l: 90.0,
2433 t: 40.0,
2434 r: 120.0,
2435 b: 48.0,
2436 };
2437 let interior = TextCell {
2438 text: "in-figure callout".into(),
2439 l: 10.0,
2440 t: 10.0,
2441 r: 60.0,
2442 b: 18.0,
2443 };
2444 let mut regions = vec![pic];
2445 super::add_orphan_regions(&mut regions, &[straddler, interior]);
2446 assert_eq!(
2447 regions.iter().filter(|r| r.label == "text").count(),
2448 2,
2449 "both unclaimed lines become orphans"
2450 );
2451 super::drop_contained_regulars(&mut regions);
2452 let texts: Vec<(f32, f32)> = regions
2453 .iter()
2454 .filter(|r| r.label == "text")
2455 .map(|r| (r.l, r.r))
2456 .collect();
2457 assert_eq!(
2458 texts,
2459 [(90.0, 120.0)],
2460 "the straddler is emitted, the fully-contained callout is not"
2461 );
2462 }
2463
2464 /// A colored terms-and-conditions panel detected as `picture` demotes into
2465 /// per-paragraph `text` regions (the blank line between C.7 and C.8 splits
2466 /// them); a chart whose only text is a few narrow axis labels keeps its
2467 /// crop untouched.
2468 #[test]
2469 fn text_panels_demote_to_paragraphs_but_charts_keep_their_crop() {
2470 let cell = |text: &str, l: f32, t: f32, r: f32, b: f32| TextCell {
2471 text: text.to_string(),
2472 l,
2473 t,
2474 r,
2475 b,
2476 };
2477 let panel = Region {
2478 label: "picture",
2479 score: 0.9,
2480 l: 0.0,
2481 t: 0.0,
2482 r: 100.0,
2483 b: 100.0,
2484 };
2485 // Three tight lines, a blank-line gap, two more: two paragraphs.
2486 let cells = vec![
2487 cell(
2488 "C.7. Wenn Sie diesen Vertrag widerrufen,",
2489 5.0,
2490 10.0,
2491 95.0,
2492 18.0,
2493 ),
2494 cell(
2495 "haben wir Ihnen alle Zahlungen, die wir",
2496 5.0,
2497 20.0,
2498 95.0,
2499 28.0,
2500 ),
2501 cell(
2502 "von Ihnen erhalten haben, zurückzuzahlen.",
2503 5.0,
2504 30.0,
2505 90.0,
2506 38.0,
2507 ),
2508 cell(
2509 "C.8. Wir können die Rückzahlung verweigern,",
2510 5.0,
2511 52.0,
2512 95.0,
2513 60.0,
2514 ),
2515 cell(
2516 "bis wir die Waren wieder zurückerhalten haben.",
2517 5.0,
2518 62.0,
2519 92.0,
2520 70.0,
2521 ),
2522 ];
2523 let mut regions = vec![panel.clone()];
2524 super::recover_text_panels(&mut regions, &cells);
2525 assert_eq!(
2526 regions.iter().map(|r| r.label).collect::<Vec<_>>(),
2527 ["text", "text"],
2528 "dense panel must demote into one text region per paragraph"
2529 );
2530 assert!(regions[0].b < regions[1].t, "paragraphs split at the gap");
2531 // Sparse narrow labels (a chart): picture survives.
2532 let labels = vec![
2533 cell("0", 5.0, 90.0, 8.0, 95.0),
2534 cell("50", 5.0, 50.0, 10.0, 55.0),
2535 cell("100", 5.0, 10.0, 12.0, 15.0),
2536 cell("t, s", 45.0, 96.0, 55.0, 100.0),
2537 ];
2538 let mut regions = vec![panel];
2539 super::recover_text_panels(&mut regions, &labels);
2540 assert_eq!(
2541 regions.iter().map(|r| r.label).collect::<Vec<_>>(),
2542 ["picture"]
2543 );
2544 }
2545
2546 /// An uncaptioned chart on a scanned page whose title, axis labels, and
2547 /// OCR boxes over the plot area are dense and wide enough to pass the
2548 /// coverage/width gates still keeps its crop: its line heights are ragged
2549 /// (title face vs tick labels vs bar-area OCR), failing the uniform-leading
2550 /// gate — a real text panel is set with constant leading (#173).
2551 #[test]
2552 fn dense_titled_chart_keeps_its_crop() {
2553 let cell = |text: &str, l: f32, t: f32, r: f32, b: f32| TextCell {
2554 text: text.to_string(),
2555 l,
2556 t,
2557 r,
2558 b,
2559 };
2560 let chart = Region {
2561 label: "picture",
2562 score: 0.9,
2563 l: 0.0,
2564 t: 0.0,
2565 r: 100.0,
2566 b: 100.0,
2567 };
2568 // Five wide lines at wildly different heights: a 12-pt title, 20-pt OCR
2569 // boxes over the bars, 4–5-pt tick/axis labels. Coverage and median
2570 // width both clear the panel thresholds.
2571 let cells = vec![
2572 cell("Underground Water Storage", 10.0, 5.0, 90.0, 17.0),
2573 cell("aquifer recharge zone", 15.0, 30.0, 75.0, 50.0),
2574 cell("confined | unconfined | perched", 12.0, 55.0, 80.0, 59.0),
2575 cell("saturated thickness", 8.0, 70.0, 60.0, 90.0),
2576 cell("distance from well, km", 20.0, 92.0, 85.0, 97.0),
2577 ];
2578 let mut regions = vec![chart];
2579 super::recover_text_panels(&mut regions, &cells);
2580 assert_eq!(
2581 regions.iter().map(|r| r.label).collect::<Vec<_>>(),
2582 ["picture"],
2583 "ragged line heights mark a figure, not a text panel"
2584 );
2585 }
2586
2587 /// docling serializes a cluster's cells in docling-parse index order
2588 /// (`_sort_cells`) and joins them with `PageAssembleModel.sanitize_text`:
2589 /// a space after every line except one ending in `-`, which either fuses a
2590 /// wrapped word (alnum on both sides — dash dropped) or glues verbatim (a
2591 /// bare `-` cell: `[0000` `-` `0002` → `[0000 -0002`, the 2305 ORCID line;
2592 /// `-` + `"C" cell -` + `a new table cell` → `-"C" cell a new table cell`,
2593 /// its OTSL list). Verified against the corpus: pure index order beats any
2594 /// geometric re-sort (normal_4pages' heading numerals paint after their
2595 /// text and belong last: `## 들어가며 1`).
2596 #[test]
2597 fn cells_join_in_index_order_with_sanitize_text_rules() {
2598 let cell = |text: &str, l: f32, t: f32, r: f32, b: f32| TextCell {
2599 text: text.to_string(),
2600 l,
2601 t,
2602 r,
2603 b,
2604 };
2605 let region = Region {
2606 label: "text",
2607 score: 1.0,
2608 l: 0.0,
2609 t: 95.0,
2610 r: 200.0,
2611 b: 130.0,
2612 };
2613 // ORCID superscript: bare dash cells keep the dash, take no space after.
2614 let orcid = vec![
2615 cell("[0000", 10.0, 100.0, 30.0, 110.0),
2616 cell("−", 30.0, 100.0, 34.0, 110.0),
2617 cell("0002", 34.0, 100.0, 50.0, 110.0),
2618 cell("−", 50.0, 100.0, 54.0, 110.0),
2619 cell("6960]", 54.0, 100.0, 70.0, 110.0),
2620 ];
2621 assert_eq!(super::region_text(®ion, &orcid), "[0000 -0002 -6960]");
2622 // Wrapped word: dash dropped, lines fused (both boundary words alnum).
2623 let wrapped = vec![
2624 cell("platforms-", 10.0, 100.0, 60.0, 110.0),
2625 cell("reflects the design", 10.0, 112.0, 90.0, 122.0),
2626 ];
2627 assert_eq!(
2628 super::region_text(®ion, &wrapped),
2629 "platformsreflects the design"
2630 );
2631 // Dash-ending line before a quote-opening one: not alnum-adjacent, so
2632 // the dash stays and the lines glue (2305's OTSL list bullets).
2633 let otsl = vec![
2634 cell("–", 10.0, 100.0, 14.0, 110.0),
2635 cell("\"C\" cell -", 16.0, 100.0, 60.0, 110.0),
2636 cell("a new table cell", 10.0, 112.0, 80.0, 122.0),
2637 ];
2638 assert_eq!(
2639 super::region_text(®ion, &otsl),
2640 "-\"C\" cell a new table cell"
2641 );
2642 // Index order is authoritative — no geometric re-sort.
2643 let numeral = vec![
2644 cell("들어가며", 30.0, 100.0, 80.0, 110.0),
2645 cell("1", 10.0, 98.0, 25.0, 112.0), // big numeral painted last
2646 ];
2647 assert_eq!(super::region_text(®ion, &numeral), "들어가며 1");
2648 }
2649
2650 /// The geometric-reliability gate, on the two shapes it has to tell apart.
2651 #[test]
2652 fn geometric_reliability_rejects_split_column_grids() {
2653 let g = |rows: &[&[&str]]| -> Vec<Vec<String>> {
2654 rows.iter()
2655 .map(|r| r.iter().map(|c| c.to_string()).collect())
2656 .collect()
2657 };
2658 // A genuine grid: dense, every column carrying entries. Nothing for
2659 // TableFormer to improve, so geometry is used as-is.
2660 assert!(super::geometric_table_is_reliable(&g(&[
2661 &["Datum", "Leistung", "Anzahl", "Kosten"],
2662 &["04.07", "Internet", "1", "40.30"],
2663 &["04.07", "Telefon", "2", "8.06"],
2664 ])));
2665 // The left-edge split artefact (the shape a scanned invoice produced):
2666 // one real label column plus values scattered across three sparse ones.
2667 assert!(!super::geometric_table_is_reliable(&g(&[
2668 &["www.magenta.at/faq", "", "", ""],
2669 &["Serviceteam", "", "", ""],
2670 &["Telefon", "0676/2000", "", ""],
2671 &["Kundennummer", "", "", "1.21699482"],
2672 &["Rechnungsnummer", "", "922769430725", ""],
2673 &["Rechnungsdatum", "", "", "04.07.2025"],
2674 ])));
2675 // A column only one row ever uses is a split artefact even when the
2676 // grid is otherwise dense.
2677 assert!(!super::geometric_table_is_reliable(&g(&[
2678 &["a", "b", ""],
2679 &["c", "d", ""],
2680 &["e", "f", "g"],
2681 ])));
2682 // Degenerate shapes are never vouched for — TableFormer may recover
2683 // structure a collapsed reconstruction lost.
2684 assert!(!super::geometric_table_is_reliable(&g(&[&[
2685 "only one column"
2686 ]])));
2687 assert!(!super::geometric_table_is_reliable(&[]));
2688 }
2689
2690 /// A `picture` region is cropped out of the rendered page, whatever built
2691 /// that page. The browser pipeline (#157) has no pdfium but does hand over
2692 /// the rasterized bitmap through `from_cells_with_image`, so it must get
2693 /// the same figure bytes the native path does — that is what makes
2694 /// `images = "embedded"` inline real pixels instead of a placeholder.
2695 #[cfg(feature = "ocr-prep")]
2696 #[test]
2697 fn picture_regions_are_cropped_from_a_host_supplied_page_image() {
2698 let mut img = image::RgbImage::new(200, 200);
2699 // Paint the figure area so the crop is distinguishable from the page.
2700 for y in 100..160 {
2701 for x in 20..120 {
2702 img.put_pixel(x, y, image::Rgb([255, 0, 0]));
2703 }
2704 }
2705 // scale 2.0: the region is in page points, the bitmap in pixels.
2706 let page = PdfPage::from_cells_with_image(100.0, 100.0, 2.0, Vec::new(), img);
2707 let region = Region {
2708 label: "picture",
2709 score: 0.9,
2710 l: 10.0,
2711 t: 50.0,
2712 r: 60.0,
2713 b: 80.0,
2714 };
2715 let (nodes, _) = super::assemble_page(&page, vec![region], &[None], &[None]);
2716 // Layout-derived nodes carry provenance, so the picture arrives wrapped.
2717 let image = nodes
2718 .iter()
2719 .find_map(|n| match n {
2720 Node::Located { inner, .. } => match &**inner {
2721 Node::Picture { image, .. } => image.as_ref(),
2722 _ => None,
2723 },
2724 Node::Picture { image, .. } => image.as_ref(),
2725 _ => None,
2726 })
2727 .expect("a picture node with cropped pixels");
2728 assert_eq!(image.mimetype, "image/png");
2729 assert_eq!((image.width, image.height), (100, 60), "region × scale");
2730 assert!(!image.data.is_empty(), "PNG bytes were encoded");
2731 }
2732
2733 #[test]
2734 fn link_anchors_split_a_shared_word_cell_between_adjacent_links() {
2735 // A common header layout: one text run holds several pipe-separated
2736 // labels, each carrying its own link annotation. Every link must get
2737 // its own label as the anchor (and the "|" separators must belong to
2738 // none), not the whole run.
2739 let annot = |l: f32, r: f32, uri: &str| LinkAnnot {
2740 l,
2741 t: 100.0,
2742 r,
2743 b: 114.0,
2744 uri: uri.into(),
2745 };
2746 let page = PdfPage {
2747 width: 600.0,
2748 height: 800.0,
2749 scale: 2.0,
2750 cells: Vec::new(),
2751 code_cells: Vec::new(),
2752 // "LinkedIn | GitHub | Credly" = 26 chars over x 100..360.
2753 word_cells: vec![cell(
2754 "LinkedIn | GitHub | Credly",
2755 100.0,
2756 100.0,
2757 360.0,
2758 114.0,
2759 )],
2760 image: image::RgbImage::new(1, 1),
2761 image_layout: None,
2762 links: vec![
2763 annot(100.0, 180.0, "https://l"),
2764 annot(200.0, 260.0, "https://g"),
2765 annot(290.0, 360.0, "https://c"),
2766 ],
2767 rotation: 0,
2768 };
2769 assert_eq!(
2770 resolve_link_anchors(&page),
2771 vec![
2772 ("LinkedIn".to_string(), "https://l".to_string()),
2773 ("GitHub".to_string(), "https://g".to_string()),
2774 ("Credly".to_string(), "https://c".to_string()),
2775 ]
2776 );
2777 }
2778
2779 /// A one-line code cell at `[l, r] × [t, b]` (top-left coords).
2780 fn cell(text: &str, l: f32, t: f32, r: f32, b: f32) -> TextCell {
2781 TextCell {
2782 text: text.into(),
2783 l,
2784 t,
2785 r,
2786 b,
2787 }
2788 }
2789
2790 fn region(label: &'static str, score: f32, l: f32, t: f32, r: f32, b: f32) -> Region {
2791 Region {
2792 label,
2793 score,
2794 l,
2795 t,
2796 r,
2797 b,
2798 }
2799 }
2800
2801 #[test]
2802 fn resolve_collapses_nested_code_keeping_the_larger_box() {
2803 // A tight high-score `code` box and a taller lower-score near-duplicate that
2804 // contains it must collapse to one — the *larger* box, so every cell stays
2805 // covered and nothing leaks out as orphan text.
2806 let tight = region("code", 0.95, 78.0, 292.0, 300.0, 330.0);
2807 let wide = region("code", 0.66, 63.0, 260.0, 320.0, 346.0);
2808 let kept = super::resolve(vec![tight, wide]);
2809 assert_eq!(kept.len(), 1, "nested code boxes must collapse to one");
2810 assert!(
2811 kept[0].l == 63.0 && kept[0].b == 346.0,
2812 "the larger containing box is kept"
2813 );
2814 }
2815
2816 #[test]
2817 fn resolve_keeps_distinct_and_differently_typed_regions() {
2818 // A text box fully inside a lower-score *table* must NOT be collapsed (the
2819 // code dedup is code-only), and two separate code blocks stay separate.
2820 let text = region("text", 0.95, 90.0, 210.0, 200.0, 230.0);
2821 let table = region("table", 0.60, 80.0, 200.0, 400.0, 500.0);
2822 assert_eq!(super::resolve(vec![text, table]).len(), 2);
2823
2824 let code_a = region("code", 0.9, 78.0, 100.0, 300.0, 140.0);
2825 let code_b = region("code", 0.9, 78.0, 300.0, 300.0, 360.0); // far below, no overlap
2826 assert_eq!(super::resolve(vec![code_a, code_b]).len(), 2);
2827 }
2828
2829 #[test]
2830 fn code_language_label_above_code_is_detected() {
2831 // A bare "XML" token directly above a code box is a language label; a real
2832 // heading above the same code is not; a language word with no code below is
2833 // left alone.
2834 let label = region("section_header", 0.9, 76.0, 540.0, 96.0, 549.0);
2835 let code = region("code", 0.7, 77.0, 552.0, 290.0, 640.0);
2836 let heading = region("section_header", 0.9, 76.0, 500.0, 260.0, 512.0);
2837 let cells = vec![
2838 cell("XML", 78.0, 541.0, 94.0, 548.0), // inside `label`
2839 cell("Overview", 78.0, 501.0, 250.0, 511.0), // inside `heading`
2840 ];
2841 let drop = super::code_language_labels(&[label, code, heading], &cells);
2842 assert_eq!(drop, vec![true, false, false], "only the label is consumed");
2843
2844 // Same label with no code region present → not consumed.
2845 let label2 = region("section_header", 0.9, 76.0, 540.0, 96.0, 549.0);
2846 let only = vec![cell("XML", 78.0, 541.0, 94.0, 548.0)];
2847 assert_eq!(super::code_language_labels(&[label2], &only), vec![false]);
2848
2849 // A label swallowed into the top of a wider code box (negative gap) is still
2850 // recognized.
2851 let inside_lbl = region("text", 0.9, 76.0, 540.0, 96.0, 549.0);
2852 let wide_code = region("code", 0.7, 63.0, 531.0, 320.0, 654.0);
2853 let cells2 = vec![cell("XML", 78.0, 541.0, 94.0, 548.0)];
2854 assert_eq!(
2855 super::code_language_labels(&[inside_lbl, wide_code], &cells2),
2856 vec![true, false]
2857 );
2858
2859 assert!(super::is_code_language("XML") && super::is_code_language("c#"));
2860 assert!(!super::is_code_language("Configure") && !super::is_code_language("XML schema"));
2861 }
2862
2863 #[test]
2864 fn code_region_text_keeps_lines_and_indentation() {
2865 // Three source lines; each glyph is 6 units wide (width / chars = 6), so the
2866 // `int X;` line indented to x=22 is (22-10)/6 = 2 spaces in.
2867 let region = Region {
2868 label: "code",
2869 score: 1.0,
2870 l: 0.0,
2871 t: -5.0,
2872 r: 100.0,
2873 b: 40.0,
2874 };
2875 let cells = vec![
2876 cell("struct P {", 10.0, 0.0, 70.0, 10.0),
2877 cell("int X;", 22.0, 12.0, 58.0, 22.0),
2878 cell("}", 10.0, 24.0, 16.0, 34.0),
2879 ];
2880 assert_eq!(code_region_text(®ion, &cells), "struct P {\n int X;\n}");
2881 }
2882
2883 #[test]
2884 fn code_region_text_tightens_punctuation_without_eating_indentation() {
2885 // A fluent `.Foo()` line at x=22 (2 chars in). Per-line tightening must not
2886 // consume the leading indent space by matching " ." across it.
2887 let region = Region {
2888 label: "code",
2889 score: 1.0,
2890 l: 0.0,
2891 t: -5.0,
2892 r: 100.0,
2893 b: 40.0,
2894 };
2895 let cells = vec![
2896 cell("builder", 10.0, 0.0, 52.0, 10.0),
2897 // pdfium spaced the call: ".Foo (x)" tightens to ".Foo(x)", still 2-indented.
2898 cell(".Foo (x)", 22.0, 12.0, 70.0, 22.0),
2899 ];
2900 assert_eq!(code_region_text(®ion, &cells), "builder\n .Foo(x)");
2901 }
2902
2903 #[test]
2904 fn code_region_text_orders_out_of_order_cells_and_ignores_blank_lines() {
2905 let region = Region {
2906 label: "code",
2907 score: 1.0,
2908 l: 0.0,
2909 t: -5.0,
2910 r: 100.0,
2911 b: 60.0,
2912 };
2913 // Fed bottom-up and with a whitespace-only cell; output is top-down, no blank.
2914 let cells = vec![
2915 cell("b();", 10.0, 24.0, 34.0, 34.0),
2916 cell(" ", 10.0, 12.0, 20.0, 22.0),
2917 cell("a();", 10.0, 0.0, 34.0, 10.0),
2918 ];
2919 assert_eq!(code_region_text(®ion, &cells), "a();\nb();");
2920 // No code cells → empty, so the caller falls back to the prose text.
2921 assert_eq!(code_region_text(®ion, &[]), "");
2922 }
2923
2924 fn para(text: &str) -> Node {
2925 Node::Paragraph { text: text.into() }
2926 }
2927
2928 /// Run a node sequence through [`StreamAssembler`] with the given page splits
2929 /// and assert the flushed result equals one-shot [`merge_continuations`].
2930 fn assert_stream_eq(nodes: &[Node], splits: &[usize]) {
2931 let mut want = nodes.to_vec();
2932 merge_continuations(&mut want);
2933
2934 let mut asm = StreamAssembler::new();
2935 let mut got = Vec::new();
2936 let mut start = 0;
2937 for &end in splits {
2938 got.extend(asm.push(nodes[start..end].to_vec()));
2939 start = end;
2940 }
2941 got.extend(asm.push(nodes[start..].to_vec()));
2942 got.extend(asm.finish());
2943 assert_eq!(got, want, "stream assembly diverged (splits={splits:?})");
2944 }
2945
2946 #[test]
2947 fn stream_assembler_matches_merge_continuations() {
2948 // Open fragment + lowercase continuation split across a page boundary.
2949 let cross = [para("the definition of"), para("lists in scope")];
2950 assert_stream_eq(&cross, &[1]);
2951 assert_stream_eq(&cross, &[]);
2952
2953 // Continuation that wraps around a figure (+ its caption) on the boundary.
2954 let wrap = [
2955 para("the wing type that is"),
2956 Node::Picture {
2957 caption: None,
2958 image: None,
2959 classification: None,
2960 },
2961 para("Fig. 1. a diagram"),
2962 para("the most common kind"),
2963 ];
2964 for splits in [&[][..], &[1][..], &[2][..], &[3][..], &[1, 3][..]] {
2965 assert_stream_eq(&wrap, splits);
2966 }
2967
2968 // A heading between fragments blocks the merge (must still flush correctly).
2969 let blocked = [
2970 para("ends mid word and"),
2971 Node::Heading {
2972 level: 2,
2973 text: "New Section".into(),
2974 },
2975 para("more body here"),
2976 ];
2977 for splits in [&[][..], &[1][..], &[2][..]] {
2978 assert_stream_eq(&blocked, splits);
2979 }
2980
2981 // A chain across three pages: each page is one open lowercase fragment.
2982 let chain = [
2983 para("alpha beta"),
2984 para("gamma delta"),
2985 para("epsilon zeta"),
2986 ];
2987 assert_stream_eq(&chain, &[1, 2]);
2988 }
2989
2990 #[test]
2991 fn clean_text_dehyphenates_and_normalizes_typography() {
2992 // U+0002 line-wrap hyphen + the join space → merged word (like docling).
2993 assert_eq!(clean_text("com\u{2} pact"), "compact");
2994 assert_eq!(clean_text("end-to\u{2} end deep"), "end-toend deep");
2995 // A stray wrap hyphen (no following join) is dropped.
2996 assert_eq!(clean_text("word\u{2}"), "word");
2997 // Typographic punctuation → ASCII: every curly quote becomes `'`
2998 // (docling-parse's sanitizer table), a literal `"` stays.
2999 assert_eq!(
3000 clean_text("Graph\u{2019}s \u{201c}x\u{201d} \"y\""),
3001 "Graph's 'x' \"y\""
3002 );
3003 assert_eq!(clean_text("a\u{2026}"), "a...");
3004 // The dp default (the docling-parse sanitizer) preserves internal spacing
3005 // it placed deliberately; line breaks/tabs normalize to a space, ends trim.
3006 assert_eq!(clean_text("a b\nc"), "a b c");
3007 }
3008
3009 #[test]
3010 fn lam_alef_only_swaps_a_genuinely_reversed_ligature() {
3011 // A mid-word `alef-variant + lam` is pdfium's reversed lam-alef ligature and
3012 // is swapped back to logical `lam + alef-variant` (`ب أ ل` → `ب ل أ`).
3013 assert_eq!(
3014 clean_text("\u{0628}\u{0623}\u{0644}"),
3015 "\u{0628}\u{0644}\u{0623}"
3016 );
3017 // But when the alef-variant is *already* preceded by a lam it is the logical
3018 // ligature `لآ`; the following lam is the next syllable's letter and must not
3019 // move. `التعلم الآلي` must stay `الآلي`, not become `اللآي`.
3020 assert_eq!(
3021 clean_text("\u{0627}\u{0644}\u{0622}\u{0644}\u{064a}"),
3022 "\u{0627}\u{0644}\u{0622}\u{0644}\u{064a}"
3023 );
3024 }
3025}