docling_core/document.rs
1//! The unified document representation.
2
3use crate::markdown::{to_markdown, to_markdown_images};
4use crate::ImageMode;
5
6/// The unified, format-agnostic document produced by every backend.
7///
8/// This is the heart of docling: backends parse their source format into a
9/// `DoclingDocument`, and serializers turn it back into Markdown, HTML, JSON,
10/// etc. Phase 0 uses a flat sequence of [`Node`]s; the production schema will
11/// match docling-core's body-tree-with-references layout.
12#[derive(Debug, Clone, PartialEq)]
13pub struct DoclingDocument {
14 /// Logical document name (usually the input file stem).
15 pub name: String,
16 /// Top-level content, in reading order.
17 pub nodes: Vec<Node>,
18 /// Default Markdown export mode for [`Self::export_to_markdown`]. `false`
19 /// (the default) reproduces docling's legacy output byte-for-byte; `true`
20 /// emits cleaner, more conformant Markdown. Set by `DocumentConverter`.
21 pub strict_markdown: bool,
22 /// Emit tables in the compact `| a | b |` / `| - | - |` form rather than
23 /// docling-core's width-padded GitHub serializer. The PDF backend sets this
24 /// (its committed groundtruth corpus predates the padded serializer); DOCX/HTML
25 /// leave it `false` to match current published docling.
26 pub compact_tables: bool,
27 /// Text the Markdown export inserts between two pages — docling-core's
28 /// `MarkdownParams.page_break_placeholder` (e.g. `"<!-- page break -->"`).
29 /// `None` (the default) omits page breaks from Markdown, as docling does.
30 /// Set by `DocumentConverter::page_break_placeholder`. See
31 /// [`crate::markdown`] for where a break lands (only between two rendered
32 /// blocks that sit on different pages, never leading or trailing).
33 pub page_break_placeholder: Option<String>,
34 /// Hyperlinks recovered from the source, as `(anchor_text, href)` pairs in
35 /// document order. docling's standard pipeline drops PDF link annotations, so
36 /// these are rendered as Markdown `[anchor](href)` **only in strict mode**
37 /// (legacy/docling output is left byte-for-byte unchanged). The PDF backend
38 /// populates this from pdfium link annotations; other backends leave it empty.
39 pub links: Vec<(String, String)>,
40 /// Conversion-confidence report (#183), populated by the PDF/image ML
41 /// pipeline; `None` for declarative conversions. Deliberately **not**
42 /// part of any document export (docling keeps it on the conversion
43 /// result, outside the document schema) — docling-serve surfaces it in
44 /// the HTTP response instead.
45 pub confidence: Option<crate::confidence::ConfidenceReport>,
46 /// docling's item tree, when the backend built one (the HTML backend
47 /// does): the JSON export serializes it instead of deriving a tree from
48 /// `nodes`, so the JSON carries upstream's exact parent/child structure,
49 /// item numbering, inline groups, formatting and content layers. Every
50 /// other serializer reads `nodes`. See [`crate::tree`].
51 pub tree: Option<crate::tree::ItemTree>,
52}
53
54/// A single piece of document content.
55#[derive(Debug, Clone, PartialEq)]
56pub enum Node {
57 /// A heading. `level` is 1-6.
58 Heading { level: u8, text: String },
59 /// A run of body text.
60 Paragraph { text: String },
61 /// A form checkbox (docling's `checkbox_selected`/`checkbox_unselected`): its
62 /// clean label `text` with the checked state. DocLang emits a `<checkbox>`
63 /// element head; Markdown/JSON render the task-list form (`- [x] `/`- [ ] `).
64 CheckboxItem { checked: bool, text: String },
65 /// A single list item at the given nesting `level` (0 = top). For ordered
66 /// items, `number` is the display number (honoring the list's `start`); it
67 /// is unused for unordered items. `first_in_list` marks the first item of a
68 /// list so the serializer can blank-line-separate adjacent sibling lists.
69 ///
70 /// `marker` is the DocLang enumeration marker (`"1."`, `"1.1."`, …) when the
71 /// backend provides one — HTML and DOCX set it for enumerated items, so
72 /// DocLang emits `<ldiv><marker>…</marker></ldiv>`; Markdown and the other
73 /// declarative backends leave it `None`, giving a bare `<ldiv/>` (matching
74 /// docling, whose Markdown backend passes no marker).
75 ListItem {
76 ordered: bool,
77 number: u64,
78 first_in_list: bool,
79 text: String,
80 level: u8,
81 marker: Option<String>,
82 /// Optional layout provenance (`x0,y0,x1,y1`, normalized to 0–511): the
83 /// four DocLang `<location>` values emitted inside the `<list>` right
84 /// after the item's `<ldiv>`. Set only by backends with real geometry
85 /// (e.g. PPTX shapes); `None` for the declarative backends. Kept on the
86 /// item itself (rather than a [`Node::Located`] wrapper) so consecutive
87 /// items still group into one `<list>`.
88 location: Option<[u16; 4]>,
89 /// DocLang-only override for items whose DocLang form diverges from their
90 /// flat Markdown `text`. Markdown/JSON always render the fields above; the
91 /// DocLang serializer, when this is `Some`, takes the list kind, marker,
92 /// and content from here instead. Used for docx multilevel numbering
93 /// (Markdown shows `- 1.1. x`, DocLang an ordered `<marker>1.1.</marker>`
94 /// with clean text) and inline equations/formatting in list items.
95 dclx: Option<ListItemDclx>,
96 /// The item's hyperlink target, when its content is a link — docling's
97 /// HTML backend emits it as an `<href uri=…/>` in the item head, and the
98 /// anchor's Markdown link markup is stripped from the rendered content.
99 /// `None` for a plain item; ignored by Markdown/JSON.
100 href: Option<String>,
101 /// Non-body content layer (docling's HTML site chrome before the first
102 /// heading → `furniture`). DocLang emits a `<layer value=…/>` in the item
103 /// head; Markdown/JSON drop a non-body item entirely.
104 layer: Option<ContentLayer>,
105 },
106 /// A fenced code block.
107 Code {
108 language: Option<String>,
109 text: String,
110 /// The original (pre-enrichment) text when the CodeFormula model
111 /// rewrote `text`: docling keeps the raw extraction in the JSON `orig`
112 /// field while `text` carries the model output. `None` → `orig == text`.
113 orig: Option<String>,
114 /// A line-preserving rendering, when the backend can reconstruct one
115 /// but docling's own output for the format cannot. The PDF pipeline
116 /// sets it (docling-parse joins code lines with single spaces, so
117 /// `text` carries that flat docling-parity form): **strict** Markdown
118 /// prefers `pretty`, every byte-conformance surface (legacy Markdown,
119 /// JSON, DocLang, chunks) serializes `text`.
120 pretty: Option<String>,
121 },
122 /// A table. The first row is treated as the header.
123 Table(Table),
124 /// A picture/figure, with an optional caption and (when a backend extracts
125 /// it) the embedded image itself.
126 Picture {
127 caption: Option<String>,
128 /// Hyperlink annotation on the caption (docling's caption text item
129 /// `hyperlink`): the HTML backend sets it when an `<a href>` wraps the
130 /// image whose `alt` became the caption. DocLang emits the block-form
131 /// `<caption>` with an `<href uri=…/>` head; JSON puts `hyperlink` on
132 /// the caption item; Markdown and LaTeX print the plain caption text,
133 /// as docling does.
134 caption_href: Option<String>,
135 image: Option<PictureImage>,
136 /// DocumentPictureClassifier predictions (all classes, descending
137 /// confidence), when the picture-classification enrichment ran.
138 /// Serialized as docling's `classification` annotation + `meta` field
139 /// on the JSON picture item; Markdown/DocLang output is unaffected.
140 classification: Option<Vec<PictureClass>>,
141 /// Where the caption item hangs in the JSON tree (#390); see
142 /// [`CaptionParent`]. Markdown, DocLang and LaTeX ignore it.
143 caption_parent: CaptionParent,
144 },
145 /// A display-math formula item decoded by the CodeFormula enrichment:
146 /// `latex` is the model's LaTeX (no `$$` wrapping), `orig` the raw glyph
147 /// text extracted from the PDF. Markdown renders `$$latex$$`; JSON emits a
148 /// `formula` text item (docling's un-enriched pipeline instead emits a
149 /// placeholder paragraph — see the PDF assembler).
150 Formula {
151 latex: String,
152 orig: String,
153 location: Option<[u16; 4]>,
154 },
155 /// A standalone caption item (docling's `DocItemLabel.CAPTION` text that
156 /// no picture or table claims): the HTML backend emits a `<figure>`'s
157 /// `<figcaption>` this way when the figure produced no picture and its
158 /// first item is not a table (docling#4050). `href` is the caption's
159 /// hyperlink annotation (the first link inside the figcaption); Markdown
160 /// renders it as `[text](href)`, JSON puts `hyperlink` on the caption
161 /// item, DocLang emits the block-form `<caption>` with an `<href>` head.
162 Caption { text: String, href: Option<String> },
163 /// A chart (docling's `PictureItem` classified as a chart, carrying a
164 /// `PictureTabularChartData` annotation). Markdown and JSON render it exactly
165 /// like a [`Node::Picture`] placeholder (an `<!-- image -->` / `picture`
166 /// item); the DocLang serializer emits `<picture class="chart">` with a
167 /// `<label value="{kind}"/>` and the data `table` as a `<tabular>`.
168 Chart {
169 /// docling's classification label, e.g. `bar_chart`, `line_chart`.
170 kind: String,
171 /// The chart's data grid (row 0 is the header band).
172 table: Table,
173 /// The chart title (docling's caption item on the picture).
174 caption: Option<String>,
175 /// DocLang `<location>` provenance for the picture element.
176 location: Option<[u16; 4]>,
177 },
178 /// A logical grouping of child nodes (e.g. a list, a section, a spreadsheet
179 /// sheet). `name` is docling's group name when it differs from the label —
180 /// an xlsx sheet group is `label: "sheet"`, `name: Some("Sheet1")`. `layer`
181 /// puts the group *and* everything it contains on a non-body content layer
182 /// (a hidden sheet is `invisible`), which is how the serializers that only
183 /// render body content know to skip it; DocLang stamps each child with the
184 /// layer token, exactly as a [`Node::Furniture`] wrapper on each would.
185 /// DocLang has no group element, so a group is transparent there.
186 Group {
187 label: String,
188 name: Option<String>,
189 layer: Option<ContentLayer>,
190 children: Vec<Node>,
191 },
192 /// A form key-value region (docling's `field_region`): a set of form fields,
193 /// each pairing an optional marker, key, and value. Backends detect these
194 /// from form structure (e.g. HTML's `keyN` / `keyN_valueM` / `keyN_marker`
195 /// `id`-convention); the serializers render each item's parts as separate
196 /// labelled texts (`marker` / `field_key` / `field_value`).
197 FieldRegion { items: Vec<FieldItem> },
198 /// docling's `KeyValueItem`: a graph of key and value cells and the links
199 /// between them (docling-core's `GraphData`). The XBRL backend builds one
200 /// from an instance's numeric facts and the presentation and calculation
201 /// hierarchies of its taxonomy. Only the JSON export carries the graph:
202 /// docling's Markdown serializer has no rendering for the item and writes
203 /// its `<!-- missing-key-value-item -->` placeholder, which the Markdown
204 /// export reproduces; the other serializers omit it.
205 KeyValueGraph {
206 cells: Vec<GraphCell>,
207 links: Vec<GraphLink>,
208 },
209 /// Rich inline content — docling's `InlineGroup`: a run of styled text
210 /// segments that a backend captured with formatting (`<bold>`, `<italic>`,
211 /// `<underline>`, `<strikethrough>`, sub/superscript, inline `<code>`) the
212 /// flat Markdown text cannot represent. Markdown/JSON render this exactly
213 /// like `Paragraph { text: md_text }` (so their output is unchanged); the
214 /// DocLang serializer uses the structured `runs`. `unwrapped` is set when the
215 /// group's docling parent is a heading/text (no enclosing `<text>` wrapper).
216 InlineGroup {
217 unwrapped: bool,
218 runs: Vec<InlineRun>,
219 md_text: String,
220 },
221 /// A node in a non-body content layer — `furniture` (page headers/footers,
222 /// the HTML `<title>`, site navigation/chrome) or `notes` (docx comments).
223 /// Markdown and JSON omit these layers by default; DocLang renders the wrapped
224 /// node with a `<layer value="{layer}"/>` head.
225 Furniture {
226 layer: ContentLayer,
227 inner: Box<Node>,
228 },
229 /// One reviewer comment: docling's notes-layer `comment_section` group
230 /// holding a single text item. `name` is docling's own — `comment-{id}` for
231 /// a docx `w:comment`, `comment-{sheet}-{cell}` for a spreadsheet cell note.
232 /// JSON emits the group plus its notes-layer text; DocLang emits the flat
233 /// `<text><layer value="notes"/>…</text>` upstream writes (its DocLang
234 /// carries no group for comments); Markdown and LaTeX omit the notes layer.
235 ///
236 /// `refs_note_text` picks what a [`Node::Commented`] annotation points at,
237 /// mirroring an upstream asymmetry: docling-core's `add_comment` appends the
238 /// **note text**'s ref to each target (which is what the xlsx backend gets),
239 /// while the docx backend overwrites that with the **group**'s ref so a
240 /// comment's replies group together.
241 ///
242 /// `grouped` is whether docling wraps the note in a `comment_section`
243 /// group at all: the docx and spreadsheet backends do, while backends that
244 /// call docling-core's `add_comment` directly (Pages, #383) get a bare
245 /// notes-layer text item under the body — JSON then emits no group and
246 /// `name` is unused.
247 CommentSection {
248 name: String,
249 text: String,
250 refs_note_text: bool,
251 grouped: bool,
252 },
253 /// A body item annotated by reviewer comments: `comments` are indices into
254 /// the document's [`Node::CommentSection`] nodes, in document order. JSON
255 /// emits docling's `comments: [{"$ref": …}]` on the item, each ref pointing
256 /// where the section says (see [`Node::CommentSection::refs_note_text`]);
257 /// every other serializer renders `inner` unchanged.
258 Commented {
259 comments: Vec<usize>,
260 inner: Box<Node>,
261 },
262 /// A node carrying layout provenance — the four DocLang `<location>` values
263 /// (`x0,y0,x1,y1`, normalized to 0–511) docling attaches to elements from
264 /// backends with real geometry (e.g. the slide shapes in PPTX). Markdown and
265 /// JSON render the wrapped node unchanged; DocLang emits the `<location>`
266 /// tokens as the element's first children.
267 Located {
268 location: [u16; 4],
269 inner: Box<Node>,
270 },
271 /// Exact page provenance for a backend whose geometry already *is* the
272 /// page's coordinate system — an XLSX item's cell-index box on its sheet,
273 /// which docling writes verbatim (`bbox` in a top-left origin, the
274 /// `charspan` the backend chose) and sizes the page from. The 0–511 grid
275 /// of a [`Node::Located`] cannot round-trip such integers exactly, so the
276 /// JSON export reads this wrapper; every other serializer renders `inner`
277 /// unchanged (DocLang keeps taking its `<location>` tokens from the grid).
278 Prov {
279 page_no: usize,
280 /// `[l, t, r, b]`, page units, top-left origin.
281 bbox: [f32; 4],
282 /// docling's `charspan` for the item (`[0, 0]` for an XLSX table).
283 charspan: [usize; 2],
284 /// The item's creation rank among its siblings, when that differs
285 /// from the node order: docling numbers `#/tables/N` / `#/texts/N` /
286 /// `#/pictures/N` in the order it *creates* items (a sheet's tables,
287 /// then its images, then its charts) and only afterwards sorts the
288 /// container's children by position. The JSON export adds siblings in
289 /// this order and lays their refs out in node order; `None` when the
290 /// two orders coincide.
291 seq: Option<usize>,
292 inner: Box<Node>,
293 },
294 /// A PDF page header or footer (docling's `page_header`/`page_footer`
295 /// furniture): DocLang emits `<page_header>`/`<page_footer>` with a
296 /// `<layer value="furniture"/>` head, the four `<location>` tokens, then the
297 /// text. The JSON writes it as a body-parented `page_header`/`page_footer`
298 /// text item on the furniture layer; Markdown omits it.
299 PageFurniture {
300 footer: bool,
301 location: [u16; 4],
302 text: String,
303 },
304 /// The text a PDF picture contains, kept the way docling keeps it: every
305 /// regular layout cluster > 80 % inside a picture cluster is that
306 /// `PictureItem`'s child (`LayoutPostprocessor._set_cluster_children`,
307 /// `ReadingOrderModel._add_child_elements`). Emitted right after its
308 /// picture node. The JSON export writes these nodes as items parented to
309 /// that picture, after its caption; docling's Markdown and LaTeX picture
310 /// serializers print only the caption and the image, so every other
311 /// serializer skips it.
312 PictureChildren(Vec<Node>),
313 /// A page boundary — docling's implicit page break between pages. The PPTX
314 /// backend emits one between consecutive slides. DocLang renders it as
315 /// `<page_break/>`; Markdown and JSON omit it (matching docling's default
316 /// exports, which carry page breaks only in the document model).
317 PageBreak,
318 /// An invisible page marker — the first node of every page the PDF paths
319 /// assemble: the 1-based page number and the page size in PDF points. It
320 /// carries exactly what the JSON export needs to populate docling's
321 /// `pages` map and to denormalize the 0–511 `<location>` grid back into
322 /// BOTTOMLEFT point bboxes for per-item `prov` (#171). Every other
323 /// serializer skips it, so Markdown / DocLang / DocTags output is
324 /// byte-for-byte unchanged.
325 PageInfo {
326 /// 1-based page number (0 = "not yet numbered": the assembler emits
327 /// the marker, the document-level collector stamps the real number).
328 page_no: usize,
329 /// Page width in PDF points.
330 width: f32,
331 /// Page height in PDF points.
332 height: f32,
333 },
334 /// A node docling keeps in the document model (and DocLang) but leaves out
335 /// of the Markdown and JSON exports — e.g. an ODF *presentation*'s pictures
336 /// and charts, which appear in the `.dclx` body but not in its `.md`/`.json`.
337 /// DocLang renders the wrapped node in place; Markdown and JSON skip it.
338 DoclangOnly(Box<Node>),
339 /// A verbatim plain-text dump — docling's plain-text backend emits the whole
340 /// file as a single text item (used for legacy USPTO APS `.txt` grants, which
341 /// docling routes to plain text rather than its APS parser). The stored string
342 /// is the file body, one record per line. Markdown/JSON render it as one text
343 /// block; the DocLang serializer reproduces minidom's per-line layout, CDATA-
344 /// escaping only the lines that need it (see `emit_text_dump`).
345 TextDump(String),
346}
347
348/// Vertical text position of an [`InlineRun`] — docling's `Script`.
349#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
350pub enum Script {
351 #[default]
352 Baseline,
353 Sub,
354 Super,
355}
356
357/// One styled segment of a [`Node::InlineGroup`] — the docling.rs analogue of a
358/// `TextItem` inside an `InlineGroup`, carrying the ancestor formatting docling
359/// tracks. `text` is already whitespace-normalized/trimmed (one segment per
360/// source text node). A hyperlink is intentionally not stored: DocLang drops the
361/// target inside inline scope, keeping only the anchor text.
362#[derive(Debug, Clone, PartialEq, Eq, Default)]
363pub struct InlineRun {
364 pub text: String,
365 pub bold: bool,
366 pub italic: bool,
367 pub underline: bool,
368 pub strike: bool,
369 pub script: Script,
370 pub code: bool,
371 /// An inline equation (`text` holds LaTeX): DocLang renders `<formula>…`,
372 /// Markdown/JSON keep the `$…$` already baked into the group's `md_text`.
373 pub formula: bool,
374}
375
376/// A DocLang content layer other than the default `body` (see [`Node::Furniture`]).
377#[derive(Debug, Clone, Copy, PartialEq, Eq)]
378pub enum ContentLayer {
379 /// Page headers/footers, HTML `<title>`, site navigation/chrome.
380 Furniture,
381 /// Editorial notes (docx reviewer comments).
382 Notes,
383 /// Invisible content (hidden spreadsheet sheets).
384 Invisible,
385}
386
387impl ContentLayer {
388 /// The `<layer value="…"/>` token value.
389 pub fn value(self) -> &'static str {
390 match self {
391 ContentLayer::Furniture => "furniture",
392 ContentLayer::Notes => "notes",
393 ContentLayer::Invisible => "invisible",
394 }
395 }
396}
397
398/// DocLang-only content for a [`Node::ListItem`] whose DocLang form differs from
399/// its flat Markdown `text` (see [`Node::ListItem::dclx`]). `ordered` picks the
400/// enclosing `<list>` kind, `marker` the `<ldiv><marker>`; content is `runs`
401/// (structured equations/formatting) when non-empty, else `text` re-parsed for
402/// inline markers.
403#[derive(Debug, Clone, PartialEq, Eq, Default)]
404pub struct ListItemDclx {
405 pub ordered: bool,
406 pub marker: Option<String>,
407 pub text: String,
408 pub runs: Vec<InlineRun>,
409}
410
411impl InlineRun {
412 /// A run with no active formatting (renders as bare inline text).
413 pub fn is_plain(&self) -> bool {
414 !self.bold
415 && !self.italic
416 && !self.underline
417 && !self.strike
418 && !self.code
419 && !self.formula
420 && self.script == Script::Baseline
421 }
422}
423
424/// Build the [`Node`] for a paragraph of inline content from its structured
425/// `runs` and Markdown text, applying docling's `InlineGroup` boundary:
426///
427/// * a single plain run (or none) → a plain [`Node::Paragraph`] (which the
428/// serializers render as `<text>…</text>`, and a lone hyperlink via `<href>`);
429/// * a single uniformly-formatted run, or two or more runs → a
430/// [`Node::InlineGroup`]. `unwrapped` (the group's docling parent is a
431/// heading, so no enclosing `<text>`) only applies to multi-run groups.
432///
433/// Markdown/JSON render the group's `md_text`, so their output is identical to
434/// emitting a `Paragraph` — the structured runs are DocLang-only.
435pub fn inline_paragraph_node(md_text: String, runs: Vec<InlineRun>, unwrapped: bool) -> Node {
436 let single_plain = runs.len() <= 1 && runs.first().is_none_or(|r| r.is_plain());
437 if single_plain {
438 Node::Paragraph { text: md_text }
439 } else {
440 Node::InlineGroup {
441 unwrapped: unwrapped && runs.len() >= 2,
442 runs,
443 md_text,
444 }
445 }
446}
447
448/// One entry of a [`Node::FieldRegion`]: a marker/key/value triple, any of which
449/// may be absent. Mirrors docling's `field_item` with its `marker` / `field_key`
450/// / `field_value` child texts.
451#[derive(Debug, Clone, PartialEq, Default)]
452pub struct FieldItem {
453 pub marker: Option<String>,
454 pub key: Option<String>,
455 pub value: Option<String>,
456 /// docling's `kind` on the `field_value` item — `read_only` or
457 /// `fillable` (the value is or holds a form control); JSON-only.
458 pub value_kind: Option<String>,
459}
460
461/// One node of a [`Node::KeyValueGraph`] — docling-core's `GraphCell`.
462#[derive(Debug, Clone, PartialEq)]
463pub struct GraphCell {
464 /// docling's `GraphCellLabel` value: `key` or `value` (it also knows
465 /// `unspecified` and `checkbox`).
466 pub label: String,
467 /// The cell's number within its graph, what the links refer to.
468 pub cell_id: usize,
469 pub text: String,
470 /// The text before any cleanup — for an XBRL fact key, the concept's
471 /// qualified name where `text` is its local name.
472 pub orig: String,
473}
474
475/// One edge of a [`Node::KeyValueGraph`] — docling-core's `GraphLink`.
476#[derive(Debug, Clone, PartialEq)]
477pub struct GraphLink {
478 /// docling's `GraphLinkLabel` value: `to_value`, `to_child`, `to_parent`
479 /// or `to_key`.
480 pub label: String,
481 pub source_cell_id: usize,
482 pub target_cell_id: usize,
483}
484
485/// One DocumentPictureClassifier prediction — docling-core's
486/// `PictureClassificationClass` (`class_name` + `confidence`).
487#[derive(Debug, Clone, PartialEq)]
488pub struct PictureClass {
489 /// e.g. `bar_chart`, `logo`, `signature` (the classifier's 26-label set).
490 pub class_name: String,
491 pub confidence: f32,
492}
493
494/// An extracted picture's raw encoded bytes plus its mimetype and pixel size —
495/// the docling.rs analogue of docling-core's `ImageRef`.
496#[derive(Debug, Clone, PartialEq)]
497pub struct PictureImage {
498 /// e.g. `image/png`, `image/jpeg`.
499 pub mimetype: String,
500 pub width: u32,
501 pub height: u32,
502 /// The image file bytes, exactly as embedded (PNG/JPEG/…).
503 pub data: Vec<u8>,
504}
505
506impl PictureImage {
507 /// A `data:` URI for the image (`data:<mimetype>;base64,<…>`).
508 pub fn data_uri(&self) -> String {
509 format!(
510 "data:{};base64,{}",
511 self.mimetype,
512 crate::base64::encode(&self.data)
513 )
514 }
515}
516
517/// One table cell as a first-class object (#240) — the Rust counterpart of
518/// docling's `TableCell`: its text, page geometry, grid rectangle and header
519/// roles. Produced by the PDF TableFormer paths from the predicted OTSL
520/// structure; `bbox` is `[l, t, r, b]` in page points with a top-left origin.
521#[derive(Debug, Clone, PartialEq)]
522pub struct TableCell {
523 pub text: String,
524 /// `[l, t, r, b]`, page points, top-left origin; `None` without geometry.
525 pub bbox: Option<[f32; 4]>,
526 /// Anchor grid position (0-based row/column offsets).
527 pub start_row: usize,
528 pub start_col: usize,
529 /// Span extents (≥ 1); the covered grid positions repeat the cell's text
530 /// in [`Table::rows`].
531 pub row_span: usize,
532 pub col_span: usize,
533 /// OTSL `ched` — a column-header cell.
534 pub column_header: bool,
535 /// OTSL `rhed` — a row-header cell.
536 pub row_header: bool,
537 /// OTSL `srow` — a section-row cell.
538 pub row_section: bool,
539}
540
541/// Where a picture's or table's caption text item hangs in the docling-JSON
542/// tree (#390). docling's backends do not agree, and the JSON structure is
543/// the only surface that shows it (Markdown, DocLang and LaTeX place a
544/// caption by its item, whatever its parent): the PDF pipeline parents a
545/// layout caption to the picture or table it belongs to, while every
546/// declarative backend creates the caption with `doc.add_text(label=CAPTION)`
547/// and no parent — the document body — even when the item itself sits in a
548/// group or under a section header (JATS, LaTeX, HTML, Markdown, EPUB,
549/// AsciiDoc all do). The office backends hang a chart's title caption off the
550/// chart's container (the sheet group, the slide, docx's current parent,
551/// docling#4190) — that is [`Node::Chart`]'s own path, not this choice. A
552/// backend that adds a new captioned item picks the variant matching
553/// upstream's `add_text` call for that format; the default is upstream's
554/// default.
555#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
556pub enum CaptionParent {
557 /// `#/body`, listed after the enclosing top-level item — docling's
558 /// `add_text` default, which every declarative backend leaves alone.
559 #[default]
560 Body,
561 /// The item's own container (its `parent`), listed ahead of the item:
562 /// the caption is created first, as docling's office backends do.
563 Container,
564 /// The item's own container, listed *after* the item: docling's HTML
565 /// backend adds a `<figure>`-wrapped table, then its `<figcaption>` under
566 /// `self.parents[self.level]` (docling#4050).
567 ContainerAfter,
568 /// The item itself — the caption is the picture's or table's first
569 /// child, as docling's PDF pipeline attaches a layout caption.
570 Item,
571}
572
573/// A simple row-major table. By default `rows[0]` is the header row; a
574/// [`TableStructure`] overlay overrides that and adds column spans.
575#[derive(Debug, Clone, PartialEq, Default)]
576pub struct Table {
577 pub rows: Vec<Vec<String>>,
578 /// Optional layout provenance: the four DocLang `<location>` values
579 /// (`x0,y0,x1,y1`, each already normalized to the 0–511 resolution) emitted
580 /// before the table's cells. Set only by backends with real geometry (e.g.
581 /// the spreadsheet backend, whose cell grid yields a bounding box); left
582 /// `None` by declarative backends, which have no coordinates.
583 pub location: Option<[u16; 4]>,
584 /// Optional OTSL structure overlay for backends that parse real table
585 /// geometry (USPTO CALS): explicit header-row count and horizontal-span
586 /// continuations. `None` → the default (row 0 is the header, no spans).
587 /// `rows` still carries the full text grid (span text replicated) for
588 /// Markdown/JSON; DocLang uses this overlay to emit `<ched/>`/`<lcel/>`.
589 pub structure: Option<TableStructure>,
590 /// Optional per-cell block content, parallel to `rows`. A *rich* cell (an
591 /// ODF cell holding a list, several paragraphs, or a nested table) carries
592 /// its DocLang blocks here; the DocLang serializer emits them after the
593 /// cell token instead of the flat `rows` text. Markdown/JSON ignore this
594 /// and render `rows`, so their output is unchanged. `None` (or an empty
595 /// `Vec` for a given cell) → the flat text is used everywhere.
596 pub cell_blocks: Option<Vec<Vec<Vec<Node>>>>,
597 /// Optional caption (docling's `TableItem.captions`): the JATS
598 /// `<table-wrap>` label+caption, an HTML `<caption>`, etc. Markdown renders
599 /// it as a text line *before* the grid; JSON emits a caption text item the
600 /// table references; DocLang emits a `<caption>` as the table's first child.
601 /// `None` → the table has no caption.
602 pub caption: Option<String>,
603 /// Where the caption item hangs in the JSON tree (#390); see
604 /// [`CaptionParent`]. Only the JSON export reads it.
605 pub caption_parent: CaptionParent,
606 /// Optional per-cell bounding boxes, same shape as [`Self::rows`]: `[l, t,
607 /// r, b]` in page points with a **top-left** origin (the PDF pipeline's
608 /// native space). Set by the ML pipeline's TableFormer paths — a spanned
609 /// cell repeats its anchor's box across the covered grid positions — and
610 /// First-class cells (#240): the authoritative per-cell records —
611 /// text, page geometry, spans and header roles — when the backend
612 /// produces them (the PDF TableFormer paths do; declarative backends
613 /// leave `None`). [`Self::rows`] stays the dense text grid every
614 /// serializer renders (a spanning cell's text is replicated across its
615 /// covered positions there); JSON serializes these cells verbatim when
616 /// present, and the DocLang structure overlay is derived from them.
617 pub cells: Option<Vec<TableCell>>,
618}
619
620impl Table {
621 /// A cell's text at a grid position, `None` outside the grid.
622 pub fn cell_text(&self, row: usize, col: usize) -> Option<&str> {
623 self.rows.get(row)?.get(col).map(String::as_str)
624 }
625
626 /// Replace the text at a grid position; `false` (and no change) outside
627 /// the grid. When a first-class cell covers the position, the whole
628 /// cell is updated: its record text and every grid position its span
629 /// covers, so the repair shows once in Markdown, not once per covered
630 /// column.
631 pub fn set_cell_text(&mut self, row: usize, col: usize, text: impl Into<String>) -> bool {
632 if self.rows.get(row).and_then(|r| r.get(col)).is_none() {
633 return false;
634 }
635 let text = text.into();
636 let covering = self.cells.as_mut().and_then(|cells| {
637 cells.iter_mut().find(|c| {
638 (c.start_row..c.start_row + c.row_span).contains(&row)
639 && (c.start_col..c.start_col + c.col_span).contains(&col)
640 })
641 });
642 if let Some(cell) = covering {
643 cell.text = text.clone();
644 let (r0, r1) = (cell.start_row, cell.start_row + cell.row_span);
645 let (c0, c1) = (cell.start_col, cell.start_col + cell.col_span);
646 for r in self.rows.iter_mut().take(r1).skip(r0) {
647 for slot in r.iter_mut().take(c1).skip(c0) {
648 *slot = text.clone();
649 }
650 }
651 } else {
652 self.rows[row][col] = text;
653 }
654 true
655 }
656
657 /// Derive first-class cells (#240) from the dense grid plus the
658 /// [`TableStructure`] overlay — how declarative tables (DOCX/XLSX merged
659 /// regions, HTML `th`/spans, ODF covered cells, USPTO CALS) get real
660 /// `TableCell` records without page geometry. Anchors are the positions
661 /// not marked as span continuations; extents scan the continuation grids
662 /// right/down (matching the DocLang `lcel`/`ucel` reading). Header roles
663 /// come from the per-cell `col_header`/`row_header` grids when present,
664 /// else the `header_row` band, else docling's declarative default (row 0
665 /// is the header). Without any overlay every position is a 1×1 cell.
666 pub fn derive_cells(&self) -> Vec<TableCell> {
667 let s = self.structure.as_ref();
668 let flag = |grid: Option<&Vec<Vec<bool>>>, r: usize, c: usize| {
669 grid.and_then(|g| g.get(r))
670 .and_then(|row| row.get(c))
671 .copied()
672 .unwrap_or(false)
673 };
674 let col_cont = |r: usize, c: usize| flag(s.map(|s| &s.col_continuation), r, c);
675 let row_cont = |r: usize, c: usize| flag(s.map(|s| &s.row_continuation), r, c);
676 let is_col_header = |r: usize, c: usize| match s {
677 Some(st) if !st.col_header.is_empty() => flag(Some(&st.col_header), r, c),
678 Some(st) if !st.header_row.is_empty() => st.header_row.get(r).copied().unwrap_or(false),
679 _ => r == 0,
680 };
681 let mut cells = Vec::new();
682 for (r, row) in self.rows.iter().enumerate() {
683 for (c, text) in row.iter().enumerate() {
684 if col_cont(r, c) || row_cont(r, c) {
685 continue; // covered by a span anchor
686 }
687 let mut col_span = 1;
688 while c + col_span < row.len() && col_cont(r, c + col_span) {
689 col_span += 1;
690 }
691 let mut row_span = 1;
692 while r + row_span < self.rows.len() && row_cont(r + row_span, c) {
693 row_span += 1;
694 }
695 cells.push(TableCell {
696 text: text.clone(),
697 bbox: None,
698 start_row: r,
699 start_col: c,
700 row_span,
701 col_span,
702 column_header: is_col_header(r, c),
703 row_header: flag(s.map(|s| &s.row_header), r, c),
704 row_section: false,
705 });
706 }
707 }
708 cells
709 }
710
711 /// The number of leading grid rows that form the column header —
712 /// docling-core's `_count_header_rows` (docling-core#723, 2.96) shared by
713 /// the Markdown serializer and the chunker's dataframe view: a row counts
714 /// only when a `column_header` cell *starts* on it (a header spanning
715 /// several rows is replicated into each row it covers, and counting those
716 /// would pull the data rows beneath it into the header block). Two
717 /// special cases: `1` when no cell carries the flag at all, so tables from
718 /// backends that never set it keep row 0 as the header; `0` when flags
719 /// exist but none starts on row 0 — then nothing is promotable and every
720 /// row stays in the body. Uses the first-class [`Self::cells`] when
721 /// present (the PDF pipeline's TableFormer flags), else the cells derived
722 /// from the structure overlay.
723 ///
724 /// A pivot table's row headers no longer disturb this: docling#4216 flags
725 /// a spanning `<th>` row as `row_header`, not `column_header`, so the
726 /// first data row is no longer folded into the header block and the
727 /// deviation this port carried for docling-core#765 is gone.
728 pub fn header_row_count(&self) -> usize {
729 if self.rows.is_empty() {
730 return 0;
731 }
732 let derived;
733 let cells: &[TableCell] = match &self.cells {
734 Some(c) if !c.is_empty() => c,
735 _ => {
736 derived = self.derive_cells();
737 &derived
738 }
739 };
740 if !cells.iter().any(|c| c.column_header) {
741 return 1;
742 }
743 (0..self.rows.len())
744 .take_while(|&r| cells.iter().any(|c| c.column_header && c.start_row == r))
745 .count()
746 }
747
748 /// The first-class cell covering a grid position, if any.
749 pub fn cell_at(&self, row: usize, col: usize) -> Option<&TableCell> {
750 self.cells.as_ref()?.iter().find(|c| {
751 (c.start_row..c.start_row + c.row_span).contains(&row)
752 && (c.start_col..c.start_col + c.col_span).contains(&col)
753 })
754 }
755
756 /// A cell's bounding box (`[l, t, r, b]`, page points, top-left origin);
757 /// `None` when no cell with geometry covers the position.
758 pub fn cell_bbox(&self, row: usize, col: usize) -> Option<[f32; 4]> {
759 self.cell_at(row, col)?.bbox
760 }
761
762 /// Set (or replace) the bounding box of the cell covering a grid
763 /// position; `false` outside the text grid. A table without first-class
764 /// cells materializes them first (one 1×1 cell per grid position, texts
765 /// from the grid), so declarative tables can be annotated too.
766 pub fn set_cell_bbox(&mut self, row: usize, col: usize, bbox: [f32; 4]) -> bool {
767 if self.rows.get(row).and_then(|r| r.get(col)).is_none() {
768 return false;
769 }
770 let rows = &self.rows;
771 let cells = self.cells.get_or_insert_with(|| {
772 rows.iter()
773 .enumerate()
774 .flat_map(|(r, cols)| {
775 cols.iter().enumerate().map(move |(c, text)| TableCell {
776 text: text.clone(),
777 bbox: None,
778 start_row: r,
779 start_col: c,
780 row_span: 1,
781 col_span: 1,
782 column_header: false,
783 row_header: false,
784 row_section: false,
785 })
786 })
787 .collect()
788 });
789 match cells.iter_mut().find(|c| {
790 (c.start_row..c.start_row + c.row_span).contains(&row)
791 && (c.start_col..c.start_col + c.col_span).contains(&col)
792 }) {
793 Some(cell) => {
794 cell.bbox = Some(bbox);
795 true
796 }
797 None => {
798 cells.push(TableCell {
799 text: self.rows[row][col].clone(),
800 bbox: Some(bbox),
801 start_row: row,
802 start_col: col,
803 row_span: 1,
804 col_span: 1,
805 column_header: false,
806 row_header: false,
807 row_section: false,
808 });
809 true
810 }
811 }
812 }
813
814 /// The anchor position of the cell whose box overlaps `bbox` best
815 /// (largest intersection-over-union), ties resolved in cell order.
816 /// `None` when nothing overlaps or the table carries no geometry. This
817 /// is the lookup half of the repair workflow: find the cell an external
818 /// OCR box refers to, then [`Self::set_cell_text`] it.
819 pub fn find_cell_by_bbox(&self, bbox: [f32; 4]) -> Option<(usize, usize)> {
820 let area = |b: &[f32; 4]| ((b[2] - b[0]) * (b[3] - b[1])).max(0.0);
821 let mut best: Option<(f32, (usize, usize))> = None;
822 for cell in self.cells.as_deref()?.iter() {
823 let Some(cb) = cell.bbox else { continue };
824 let iw = (bbox[2].min(cb[2]) - bbox[0].max(cb[0])).max(0.0);
825 let ih = (bbox[3].min(cb[3]) - bbox[1].max(cb[1])).max(0.0);
826 let inter = iw * ih;
827 if inter <= 0.0 {
828 continue;
829 }
830 let iou = inter / (area(&bbox) + area(&cb) - inter).max(f32::EPSILON);
831 if best.is_none_or(|(b, _)| iou > b) {
832 best = Some((iou, (cell.start_row, cell.start_col)));
833 }
834 }
835 best.map(|(_, pos)| pos)
836 }
837
838 /// Locate the cell overlapping `bbox` best and replace its text — the
839 /// one-call form of the OCR-repair loop. Returns the updated anchor.
840 pub fn update_cell_by_bbox(
841 &mut self,
842 bbox: [f32; 4],
843 text: impl Into<String>,
844 ) -> Option<(usize, usize)> {
845 let (row, col) = self.find_cell_by_bbox(bbox)?;
846 self.set_cell_text(row, col, text);
847 Some((row, col))
848 }
849}
850
851/// OTSL structure overlay for a [`Table`], parallel to [`Table::rows`].
852#[derive(Debug, Clone, PartialEq, Default)]
853pub struct TableStructure {
854 /// Per-row: `true` if the row's non-empty cells are column headers
855 /// (emitted as `<ched/>` rather than `<fcel/>`).
856 pub header_row: Vec<bool>,
857 /// Same shape as [`Table::rows`]; `true` where a cell continues a
858 /// horizontal span from its left neighbour (emitted as `<lcel/>`).
859 pub col_continuation: Vec<Vec<bool>>,
860 /// Same shape as [`Table::rows`]; `true` where a cell continues a
861 /// vertical span from the cell above (emitted as `<ucel/>`). Empty or all
862 /// `false` when the backend has no vertical spans (e.g. USPTO CALS).
863 pub row_continuation: Vec<Vec<bool>>,
864 /// Same shape as [`Table::rows`]; `true` where a non-empty cell is a row
865 /// header (emitted as `<rhed/>`) — a chart's category column. Empty when
866 /// the table has no row headers.
867 pub row_header: Vec<Vec<bool>>,
868 /// Same shape as [`Table::rows`]; `true` where a cell is a *column header*
869 /// cell (an HTML `<th>`). When non-empty this per-cell grid supersedes the
870 /// per-row [`Self::header_row`] for `<ched/>` emission, matching docling's
871 /// cell-level `column_header` flag; the chunker derives its header-row
872 /// count from it.
873 pub col_header: Vec<Vec<bool>>,
874}
875
876impl DoclingDocument {
877 /// Create an empty document with the given name.
878 pub fn new(name: impl Into<String>) -> Self {
879 Self {
880 name: name.into(),
881 nodes: Vec::new(),
882 strict_markdown: false,
883 compact_tables: false,
884 page_break_placeholder: None,
885 links: Vec::new(),
886 confidence: None,
887 tree: None,
888 }
889 }
890
891 /// Append a node.
892 /// The document's top-level tables in reading order — the read half of
893 /// the post-extraction table API (#238). [`Node::Located`] wrappers (the
894 /// PDF pipeline attaches layout provenance that way) are looked through;
895 /// tables nested inside rich table cells (`Table::cell_blocks`) are not
896 /// traversed.
897 pub fn tables(&self) -> impl Iterator<Item = &Table> {
898 fn unwrap_table(n: &Node) -> Option<&Table> {
899 match n {
900 Node::Table(t) => Some(t),
901 Node::Located { inner, .. } | Node::Prov { inner, .. } => unwrap_table(inner),
902 _ => None,
903 }
904 }
905 self.nodes.iter().filter_map(unwrap_table)
906 }
907
908 /// Mutable access to the document's top-level tables, for repair
909 /// workflows (#238): locate a cell via [`Table::find_cell_by_bbox`], fix
910 /// its text with [`Table::set_cell_text`], then re-export — every
911 /// serializer reads the same grid.
912 pub fn tables_mut(&mut self) -> impl Iterator<Item = &mut Table> {
913 fn unwrap_table(n: &mut Node) -> Option<&mut Table> {
914 match n {
915 Node::Table(t) => Some(t),
916 Node::Located { inner, .. } | Node::Prov { inner, .. } => unwrap_table(inner),
917 _ => None,
918 }
919 }
920 self.nodes.iter_mut().filter_map(unwrap_table)
921 }
922
923 pub fn push(&mut self, node: Node) {
924 self.nodes.push(node);
925 }
926
927 /// Convenience: append a heading.
928 pub fn add_heading(&mut self, level: u8, text: impl Into<String>) {
929 self.push(Node::Heading {
930 level,
931 text: text.into(),
932 });
933 }
934
935 /// Convenience: append a paragraph.
936 pub fn add_paragraph(&mut self, text: impl Into<String>) {
937 self.push(Node::Paragraph { text: text.into() });
938 }
939
940 /// Serialize the document to Markdown.
941 ///
942 /// The Rust equivalent of docling-core's
943 /// `DoclingDocument.export_to_markdown()`. Uses [`Self::strict_markdown`] to
944 /// pick between docling-legacy output (default) and the cleaner, more
945 /// conformant variant.
946 pub fn export_to_markdown(&self) -> String {
947 to_markdown(self, self.strict_markdown)
948 }
949
950 /// Serialize to Markdown, explicitly choosing the mode regardless of
951 /// [`Self::strict_markdown`]. `strict = true` produces cleaner, more
952 /// conformant Markdown (code-fence languages preserved, no inline-run
953 /// spacing artifacts); `strict = false` reproduces docling's legacy output.
954 pub fn export_to_markdown_with(&self, strict: bool) -> String {
955 to_markdown(self, strict)
956 }
957
958 /// Markdown for this document as the *content of a rich table cell*
959 /// (docling-core's `in_table_cell` serialization, docling-core#540):
960 /// headings render as plain text since Markdown tables can't hold them.
961 /// Backends build a sub-document per rich cell and flatten this into the
962 /// cell text; no trailing newline.
963 pub fn export_to_table_cell_markdown(&self) -> String {
964 crate::markdown::to_markdown_table_cell(self, self.strict_markdown)
965 }
966
967 /// Serialize to docling-core's native JSON wire format (`DoclingDocument`
968 /// schema), pretty-printed — the Rust equivalent of
969 /// `DoclingDocument.export_to_dict()` / `save_as_json()`. The output loads
970 /// back into Python docling-core and round-trips to the same Markdown.
971 pub fn export_to_json(&self) -> String {
972 serde_json::to_string_pretty(&self.export_to_json_value())
973 .expect("DoclingDocument JSON is always serializable")
974 }
975
976 /// The same JSON wire format as [`Self::export_to_json`], as a
977 /// `serde_json::Value` — for callers that append response-level extras
978 /// (docling-serve adds the confidence report, #183) before serializing.
979 pub fn export_to_json_value(&self) -> serde_json::Value {
980 crate::json::to_json(self)
981 }
982
983 /// Serialize to a complete LaTeX document — the Rust counterpart of
984 /// docling-core's `LaTeXDocSerializer` with default parameters (docling
985 /// 2.124's `--to latex`, #317). No trailing newline, like the upstream
986 /// CLI's `<stem>.tex`.
987 pub fn export_to_latex(&self) -> String {
988 crate::latex::to_latex(self)
989 }
990
991 /// Serialize to DocLang XML (`<doclang version="0.7">…`), the markup that
992 /// lives inside a `.dclx` archive — the Rust counterpart of docling-core's
993 /// `export_to_doclang()` with default parameters. No trailing newline; the
994 /// archive writer appends exactly one.
995 pub fn export_to_doclang(&self) -> String {
996 crate::doclang::export_to_doclang(&self.nodes)
997 }
998
999 /// Serialize to Markdown with an explicit picture [`ImageMode`] (mirrors
1000 /// docling's `image_mode`). Returns the Markdown and, for
1001 /// [`ImageMode::Referenced`], the `(relative-path, bytes)` of each image the
1002 /// caller should write next to the Markdown file. `artifacts_dir` is the
1003 /// directory name used in referenced links.
1004 pub fn export_to_markdown_with_images(
1005 &self,
1006 image_mode: ImageMode,
1007 artifacts_dir: &str,
1008 ) -> (String, Vec<(String, Vec<u8>)>) {
1009 to_markdown_images(self, self.strict_markdown, image_mode, artifacts_dir)
1010 }
1011}
1012
1013#[cfg(test)]
1014mod table_api_tests {
1015 use super::*;
1016
1017 fn cell(
1018 text: &str,
1019 bbox: [f32; 4],
1020 (start_row, start_col): (usize, usize),
1021 (row_span, col_span): (usize, usize),
1022 ) -> TableCell {
1023 TableCell {
1024 text: text.into(),
1025 bbox: Some(bbox),
1026 start_row,
1027 start_col,
1028 row_span,
1029 col_span,
1030 column_header: false,
1031 row_header: false,
1032 row_section: false,
1033 }
1034 }
1035
1036 fn table() -> Table {
1037 Table {
1038 rows: vec![
1039 vec!["Year".into(), "Ducks".into()],
1040 vec!["2019".into(), "120".into()],
1041 ],
1042 cells: Some(vec![
1043 cell("Year", [0.0, 0.0, 50.0, 10.0], (0, 0), (1, 1)),
1044 cell("Ducks", [50.0, 0.0, 100.0, 10.0], (0, 1), (1, 1)),
1045 cell("2019", [0.0, 10.0, 50.0, 20.0], (1, 0), (1, 1)),
1046 cell("120", [50.0, 10.0, 100.0, 20.0], (1, 1), (1, 1)),
1047 ]),
1048 ..Default::default()
1049 }
1050 }
1051
1052 /// Declarative tables derive first-class cells from the structure
1053 /// overlay: continuation grids become span extents, `col_header` (or the
1054 /// row-0 fallback) becomes the header role — the XLSX/DOCX/HTML merge
1055 /// path into real `TableCell`s (#240).
1056 #[test]
1057 fn derive_cells_reads_spans_and_headers_from_structure() {
1058 let t = Table {
1059 rows: vec![
1060 vec!["Wide".into(), "Wide".into(), "C".into()],
1061 vec!["a".into(), "b".into(), "c".into()],
1062 ],
1063 structure: Some(TableStructure {
1064 header_row: vec![true, false],
1065 col_continuation: vec![vec![false, true, false], vec![false; 3]],
1066 row_continuation: vec![vec![false; 3], vec![false; 3]],
1067 row_header: Vec::new(),
1068 col_header: Vec::new(),
1069 }),
1070 ..Default::default()
1071 };
1072 let cells = t.derive_cells();
1073 assert_eq!(cells.len(), 5, "two anchors in row 0, three in row 1");
1074 let wide = &cells[0];
1075 assert_eq!((wide.col_span, wide.row_span), (2, 1));
1076 assert!(wide.column_header, "header_row band");
1077 assert!(cells.iter().skip(2).all(|c| !c.column_header));
1078
1079 // Without any overlay: every position 1x1, row 0 the header
1080 // (docling's declarative default — the old JSON synthesis).
1081 let plain = Table {
1082 rows: vec![vec!["h".into()], vec!["x".into()]],
1083 ..Default::default()
1084 };
1085 let cells = plain.derive_cells();
1086 assert_eq!(cells.len(), 2);
1087 assert!(cells[0].column_header && !cells[1].column_header);
1088 }
1089
1090 /// A spanning cell updates once: the record text and every covered grid
1091 /// position — a repair shows once in Markdown, not once per column.
1092 #[test]
1093 fn span_repair_updates_the_whole_cell() {
1094 let mut t = Table {
1095 rows: vec![
1096 vec!["Wide".into(), "Wide".into(), "C".into()],
1097 vec!["a".into(), "b".into(), "c".into()],
1098 ],
1099 cells: Some(vec![
1100 cell("Wide", [0.0, 0.0, 100.0, 10.0], (0, 0), (1, 2)),
1101 cell("C", [100.0, 0.0, 150.0, 10.0], (0, 2), (1, 1)),
1102 ]),
1103 ..Default::default()
1104 };
1105 // Update through the covered (non-anchor) position.
1106 assert!(t.set_cell_text(0, 1, "Fixed"));
1107 assert_eq!(
1108 t.rows[0],
1109 vec!["Fixed".to_string(), "Fixed".into(), "C".into()]
1110 );
1111 assert_eq!(t.cell_at(0, 1).unwrap().text, "Fixed");
1112 assert_eq!(t.cell_at(0, 1).unwrap().col_span, 2);
1113 }
1114
1115 /// The OCR-repair loop (#238): locate a cell by an external box (best
1116 /// IoU), replace its text, and see the fix in the export — the grid is
1117 /// the single source of truth for every serializer.
1118 #[test]
1119 fn bbox_lookup_and_repair_flow_into_exports() {
1120 let mut doc = DoclingDocument::new("t");
1121 doc.push(Node::Table(table()));
1122 assert_eq!(doc.tables().count(), 1);
1123
1124 let t = doc.tables_mut().next().unwrap();
1125 // A slightly-off OCR box still lands on the (1,1) cell.
1126 assert_eq!(t.find_cell_by_bbox([52.0, 11.0, 98.0, 19.0]), Some((1, 1)));
1127 assert_eq!(
1128 t.update_cell_by_bbox([52.0, 11.0, 98.0, 19.0], "125"),
1129 Some((1, 1))
1130 );
1131 assert_eq!(t.cell_text(1, 1), Some("125"));
1132 assert!(doc.export_to_markdown().contains("125"));
1133
1134 // No overlap → no match, nothing changed.
1135 let t = doc.tables_mut().next().unwrap();
1136 assert_eq!(t.find_cell_by_bbox([500.0, 500.0, 600.0, 600.0]), None);
1137 }
1138
1139 #[test]
1140 fn cell_accessors_bound_check_and_geometry_materializes() {
1141 let mut t = table();
1142 assert_eq!(t.cell_text(0, 0), Some("Year"));
1143 assert_eq!(t.cell_text(5, 0), None);
1144 assert!(!t.set_cell_text(0, 9, "x"), "outside the grid");
1145 assert_eq!(t.cell_bbox(1, 0), Some([0.0, 10.0, 50.0, 20.0]));
1146
1147 // A geometry-less table materializes its box grid on first set.
1148 let mut plain = Table {
1149 rows: vec![vec!["a".into(), "b".into()]],
1150 ..Default::default()
1151 };
1152 assert_eq!(plain.cell_bbox(0, 1), None);
1153 assert!(!plain.set_cell_bbox(0, 5, [0.0; 4]), "outside the grid");
1154 assert!(plain.set_cell_bbox(0, 1, [1.0, 2.0, 3.0, 4.0]));
1155 assert_eq!(plain.cell_bbox(0, 1), Some([1.0, 2.0, 3.0, 4.0]));
1156 assert_eq!(plain.find_cell_by_bbox([1.5, 2.5, 2.5, 3.5]), Some((0, 1)));
1157 }
1158}