Skip to main content

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    /// A page boundary — docling's implicit page break between pages. The PPTX
305    /// backend emits one between consecutive slides. DocLang renders it as
306    /// `<page_break/>`; Markdown and JSON omit it (matching docling's default
307    /// exports, which carry page breaks only in the document model).
308    PageBreak,
309    /// An invisible page marker — the first node of every page the PDF paths
310    /// assemble: the 1-based page number and the page size in PDF points. It
311    /// carries exactly what the JSON export needs to populate docling's
312    /// `pages` map and to denormalize the 0–511 `<location>` grid back into
313    /// BOTTOMLEFT point bboxes for per-item `prov` (#171). Every other
314    /// serializer skips it, so Markdown / DocLang / DocTags output is
315    /// byte-for-byte unchanged.
316    PageInfo {
317        /// 1-based page number (0 = "not yet numbered": the assembler emits
318        /// the marker, the document-level collector stamps the real number).
319        page_no: usize,
320        /// Page width in PDF points.
321        width: f32,
322        /// Page height in PDF points.
323        height: f32,
324    },
325    /// A node docling keeps in the document model (and DocLang) but leaves out
326    /// of the Markdown and JSON exports — e.g. an ODF *presentation*'s pictures
327    /// and charts, which appear in the `.dclx` body but not in its `.md`/`.json`.
328    /// DocLang renders the wrapped node in place; Markdown and JSON skip it.
329    DoclangOnly(Box<Node>),
330    /// A verbatim plain-text dump — docling's plain-text backend emits the whole
331    /// file as a single text item (used for legacy USPTO APS `.txt` grants, which
332    /// docling routes to plain text rather than its APS parser). The stored string
333    /// is the file body, one record per line. Markdown/JSON render it as one text
334    /// block; the DocLang serializer reproduces minidom's per-line layout, CDATA-
335    /// escaping only the lines that need it (see `emit_text_dump`).
336    TextDump(String),
337}
338
339/// Vertical text position of an [`InlineRun`] — docling's `Script`.
340#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
341pub enum Script {
342    #[default]
343    Baseline,
344    Sub,
345    Super,
346}
347
348/// One styled segment of a [`Node::InlineGroup`] — the docling.rs analogue of a
349/// `TextItem` inside an `InlineGroup`, carrying the ancestor formatting docling
350/// tracks. `text` is already whitespace-normalized/trimmed (one segment per
351/// source text node). A hyperlink is intentionally not stored: DocLang drops the
352/// target inside inline scope, keeping only the anchor text.
353#[derive(Debug, Clone, PartialEq, Eq, Default)]
354pub struct InlineRun {
355    pub text: String,
356    pub bold: bool,
357    pub italic: bool,
358    pub underline: bool,
359    pub strike: bool,
360    pub script: Script,
361    pub code: bool,
362    /// An inline equation (`text` holds LaTeX): DocLang renders `<formula>…`,
363    /// Markdown/JSON keep the `$…$` already baked into the group's `md_text`.
364    pub formula: bool,
365}
366
367/// A DocLang content layer other than the default `body` (see [`Node::Furniture`]).
368#[derive(Debug, Clone, Copy, PartialEq, Eq)]
369pub enum ContentLayer {
370    /// Page headers/footers, HTML `<title>`, site navigation/chrome.
371    Furniture,
372    /// Editorial notes (docx reviewer comments).
373    Notes,
374    /// Invisible content (hidden spreadsheet sheets).
375    Invisible,
376}
377
378impl ContentLayer {
379    /// The `<layer value="…"/>` token value.
380    pub fn value(self) -> &'static str {
381        match self {
382            ContentLayer::Furniture => "furniture",
383            ContentLayer::Notes => "notes",
384            ContentLayer::Invisible => "invisible",
385        }
386    }
387}
388
389/// DocLang-only content for a [`Node::ListItem`] whose DocLang form differs from
390/// its flat Markdown `text` (see [`Node::ListItem::dclx`]). `ordered` picks the
391/// enclosing `<list>` kind, `marker` the `<ldiv><marker>`; content is `runs`
392/// (structured equations/formatting) when non-empty, else `text` re-parsed for
393/// inline markers.
394#[derive(Debug, Clone, PartialEq, Eq, Default)]
395pub struct ListItemDclx {
396    pub ordered: bool,
397    pub marker: Option<String>,
398    pub text: String,
399    pub runs: Vec<InlineRun>,
400}
401
402impl InlineRun {
403    /// A run with no active formatting (renders as bare inline text).
404    pub fn is_plain(&self) -> bool {
405        !self.bold
406            && !self.italic
407            && !self.underline
408            && !self.strike
409            && !self.code
410            && !self.formula
411            && self.script == Script::Baseline
412    }
413}
414
415/// Build the [`Node`] for a paragraph of inline content from its structured
416/// `runs` and Markdown text, applying docling's `InlineGroup` boundary:
417///
418/// * a single plain run (or none) → a plain [`Node::Paragraph`] (which the
419///   serializers render as `<text>…</text>`, and a lone hyperlink via `<href>`);
420/// * a single uniformly-formatted run, or two or more runs → a
421///   [`Node::InlineGroup`]. `unwrapped` (the group's docling parent is a
422///   heading, so no enclosing `<text>`) only applies to multi-run groups.
423///
424/// Markdown/JSON render the group's `md_text`, so their output is identical to
425/// emitting a `Paragraph` — the structured runs are DocLang-only.
426pub fn inline_paragraph_node(md_text: String, runs: Vec<InlineRun>, unwrapped: bool) -> Node {
427    let single_plain = runs.len() <= 1 && runs.first().is_none_or(|r| r.is_plain());
428    if single_plain {
429        Node::Paragraph { text: md_text }
430    } else {
431        Node::InlineGroup {
432            unwrapped: unwrapped && runs.len() >= 2,
433            runs,
434            md_text,
435        }
436    }
437}
438
439/// One entry of a [`Node::FieldRegion`]: a marker/key/value triple, any of which
440/// may be absent. Mirrors docling's `field_item` with its `marker` / `field_key`
441/// / `field_value` child texts.
442#[derive(Debug, Clone, PartialEq, Default)]
443pub struct FieldItem {
444    pub marker: Option<String>,
445    pub key: Option<String>,
446    pub value: Option<String>,
447    /// docling's `kind` on the `field_value` item — `read_only` or
448    /// `fillable` (the value is or holds a form control); JSON-only.
449    pub value_kind: Option<String>,
450}
451
452/// One node of a [`Node::KeyValueGraph`] — docling-core's `GraphCell`.
453#[derive(Debug, Clone, PartialEq)]
454pub struct GraphCell {
455    /// docling's `GraphCellLabel` value: `key` or `value` (it also knows
456    /// `unspecified` and `checkbox`).
457    pub label: String,
458    /// The cell's number within its graph, what the links refer to.
459    pub cell_id: usize,
460    pub text: String,
461    /// The text before any cleanup — for an XBRL fact key, the concept's
462    /// qualified name where `text` is its local name.
463    pub orig: String,
464}
465
466/// One edge of a [`Node::KeyValueGraph`] — docling-core's `GraphLink`.
467#[derive(Debug, Clone, PartialEq)]
468pub struct GraphLink {
469    /// docling's `GraphLinkLabel` value: `to_value`, `to_child`, `to_parent`
470    /// or `to_key`.
471    pub label: String,
472    pub source_cell_id: usize,
473    pub target_cell_id: usize,
474}
475
476/// One DocumentPictureClassifier prediction — docling-core's
477/// `PictureClassificationClass` (`class_name` + `confidence`).
478#[derive(Debug, Clone, PartialEq)]
479pub struct PictureClass {
480    /// e.g. `bar_chart`, `logo`, `signature` (the classifier's 26-label set).
481    pub class_name: String,
482    pub confidence: f32,
483}
484
485/// An extracted picture's raw encoded bytes plus its mimetype and pixel size —
486/// the docling.rs analogue of docling-core's `ImageRef`.
487#[derive(Debug, Clone, PartialEq)]
488pub struct PictureImage {
489    /// e.g. `image/png`, `image/jpeg`.
490    pub mimetype: String,
491    pub width: u32,
492    pub height: u32,
493    /// The image file bytes, exactly as embedded (PNG/JPEG/…).
494    pub data: Vec<u8>,
495}
496
497impl PictureImage {
498    /// A `data:` URI for the image (`data:<mimetype>;base64,<…>`).
499    pub fn data_uri(&self) -> String {
500        format!(
501            "data:{};base64,{}",
502            self.mimetype,
503            crate::base64::encode(&self.data)
504        )
505    }
506}
507
508/// One table cell as a first-class object (#240) — the Rust counterpart of
509/// docling's `TableCell`: its text, page geometry, grid rectangle and header
510/// roles. Produced by the PDF TableFormer paths from the predicted OTSL
511/// structure; `bbox` is `[l, t, r, b]` in page points with a top-left origin.
512#[derive(Debug, Clone, PartialEq)]
513pub struct TableCell {
514    pub text: String,
515    /// `[l, t, r, b]`, page points, top-left origin; `None` without geometry.
516    pub bbox: Option<[f32; 4]>,
517    /// Anchor grid position (0-based row/column offsets).
518    pub start_row: usize,
519    pub start_col: usize,
520    /// Span extents (≥ 1); the covered grid positions repeat the cell's text
521    /// in [`Table::rows`].
522    pub row_span: usize,
523    pub col_span: usize,
524    /// OTSL `ched` — a column-header cell.
525    pub column_header: bool,
526    /// OTSL `rhed` — a row-header cell.
527    pub row_header: bool,
528    /// OTSL `srow` — a section-row cell.
529    pub row_section: bool,
530}
531
532/// Where a picture's or table's caption text item hangs in the docling-JSON
533/// tree (#390). docling's backends do not agree, and the JSON structure is
534/// the only surface that shows it (Markdown, DocLang and LaTeX place a
535/// caption by its item, whatever its parent): the PDF pipeline parents a
536/// layout caption to the picture or table it belongs to, while every
537/// declarative backend creates the caption with `doc.add_text(label=CAPTION)`
538/// and no parent — the document body — even when the item itself sits in a
539/// group or under a section header (JATS, LaTeX, HTML, Markdown, EPUB,
540/// AsciiDoc all do). The office backends hang a chart's title caption off the
541/// chart's container (the sheet group, the slide, docx's current parent,
542/// docling#4190) — that is [`Node::Chart`]'s own path, not this choice. A
543/// backend that adds a new captioned item picks the variant matching
544/// upstream's `add_text` call for that format; the default is upstream's
545/// default.
546#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
547pub enum CaptionParent {
548    /// `#/body`, listed after the enclosing top-level item — docling's
549    /// `add_text` default, which every declarative backend leaves alone.
550    #[default]
551    Body,
552    /// The item's own container (its `parent`), listed ahead of the item:
553    /// the caption is created first, as docling's office backends do.
554    Container,
555    /// The item's own container, listed *after* the item: docling's HTML
556    /// backend adds a `<figure>`-wrapped table, then its `<figcaption>` under
557    /// `self.parents[self.level]` (docling#4050).
558    ContainerAfter,
559    /// The item itself — the caption is the picture's or table's first
560    /// child, as docling's PDF pipeline attaches a layout caption.
561    Item,
562}
563
564/// A simple row-major table. By default `rows[0]` is the header row; a
565/// [`TableStructure`] overlay overrides that and adds column spans.
566#[derive(Debug, Clone, PartialEq, Default)]
567pub struct Table {
568    pub rows: Vec<Vec<String>>,
569    /// Optional layout provenance: the four DocLang `<location>` values
570    /// (`x0,y0,x1,y1`, each already normalized to the 0–511 resolution) emitted
571    /// before the table's cells. Set only by backends with real geometry (e.g.
572    /// the spreadsheet backend, whose cell grid yields a bounding box); left
573    /// `None` by declarative backends, which have no coordinates.
574    pub location: Option<[u16; 4]>,
575    /// Optional OTSL structure overlay for backends that parse real table
576    /// geometry (USPTO CALS): explicit header-row count and horizontal-span
577    /// continuations. `None` → the default (row 0 is the header, no spans).
578    /// `rows` still carries the full text grid (span text replicated) for
579    /// Markdown/JSON; DocLang uses this overlay to emit `<ched/>`/`<lcel/>`.
580    pub structure: Option<TableStructure>,
581    /// Optional per-cell block content, parallel to `rows`. A *rich* cell (an
582    /// ODF cell holding a list, several paragraphs, or a nested table) carries
583    /// its DocLang blocks here; the DocLang serializer emits them after the
584    /// cell token instead of the flat `rows` text. Markdown/JSON ignore this
585    /// and render `rows`, so their output is unchanged. `None` (or an empty
586    /// `Vec` for a given cell) → the flat text is used everywhere.
587    pub cell_blocks: Option<Vec<Vec<Vec<Node>>>>,
588    /// Optional caption (docling's `TableItem.captions`): the JATS
589    /// `<table-wrap>` label+caption, an HTML `<caption>`, etc. Markdown renders
590    /// it as a text line *before* the grid; JSON emits a caption text item the
591    /// table references; DocLang emits a `<caption>` as the table's first child.
592    /// `None` → the table has no caption.
593    pub caption: Option<String>,
594    /// Where the caption item hangs in the JSON tree (#390); see
595    /// [`CaptionParent`]. Only the JSON export reads it.
596    pub caption_parent: CaptionParent,
597    /// Optional per-cell bounding boxes, same shape as [`Self::rows`]: `[l, t,
598    /// r, b]` in page points with a **top-left** origin (the PDF pipeline's
599    /// native space). Set by the ML pipeline's TableFormer paths — a spanned
600    /// cell repeats its anchor's box across the covered grid positions — and
601    /// First-class cells (#240): the authoritative per-cell records —
602    /// text, page geometry, spans and header roles — when the backend
603    /// produces them (the PDF TableFormer paths do; declarative backends
604    /// leave `None`). [`Self::rows`] stays the dense text grid every
605    /// serializer renders (a spanning cell's text is replicated across its
606    /// covered positions there); JSON serializes these cells verbatim when
607    /// present, and the DocLang structure overlay is derived from them.
608    pub cells: Option<Vec<TableCell>>,
609}
610
611impl Table {
612    /// A cell's text at a grid position, `None` outside the grid.
613    pub fn cell_text(&self, row: usize, col: usize) -> Option<&str> {
614        self.rows.get(row)?.get(col).map(String::as_str)
615    }
616
617    /// Replace the text at a grid position; `false` (and no change) outside
618    /// the grid. When a first-class cell covers the position, the whole
619    /// cell is updated: its record text and every grid position its span
620    /// covers, so the repair shows once in Markdown, not once per covered
621    /// column.
622    pub fn set_cell_text(&mut self, row: usize, col: usize, text: impl Into<String>) -> bool {
623        if self.rows.get(row).and_then(|r| r.get(col)).is_none() {
624            return false;
625        }
626        let text = text.into();
627        let covering = self.cells.as_mut().and_then(|cells| {
628            cells.iter_mut().find(|c| {
629                (c.start_row..c.start_row + c.row_span).contains(&row)
630                    && (c.start_col..c.start_col + c.col_span).contains(&col)
631            })
632        });
633        if let Some(cell) = covering {
634            cell.text = text.clone();
635            let (r0, r1) = (cell.start_row, cell.start_row + cell.row_span);
636            let (c0, c1) = (cell.start_col, cell.start_col + cell.col_span);
637            for r in self.rows.iter_mut().take(r1).skip(r0) {
638                for slot in r.iter_mut().take(c1).skip(c0) {
639                    *slot = text.clone();
640                }
641            }
642        } else {
643            self.rows[row][col] = text;
644        }
645        true
646    }
647
648    /// Derive first-class cells (#240) from the dense grid plus the
649    /// [`TableStructure`] overlay — how declarative tables (DOCX/XLSX merged
650    /// regions, HTML `th`/spans, ODF covered cells, USPTO CALS) get real
651    /// `TableCell` records without page geometry. Anchors are the positions
652    /// not marked as span continuations; extents scan the continuation grids
653    /// right/down (matching the DocLang `lcel`/`ucel` reading). Header roles
654    /// come from the per-cell `col_header`/`row_header` grids when present,
655    /// else the `header_row` band, else docling's declarative default (row 0
656    /// is the header). Without any overlay every position is a 1×1 cell.
657    pub fn derive_cells(&self) -> Vec<TableCell> {
658        let s = self.structure.as_ref();
659        let flag = |grid: Option<&Vec<Vec<bool>>>, r: usize, c: usize| {
660            grid.and_then(|g| g.get(r))
661                .and_then(|row| row.get(c))
662                .copied()
663                .unwrap_or(false)
664        };
665        let col_cont = |r: usize, c: usize| flag(s.map(|s| &s.col_continuation), r, c);
666        let row_cont = |r: usize, c: usize| flag(s.map(|s| &s.row_continuation), r, c);
667        let is_col_header = |r: usize, c: usize| match s {
668            Some(st) if !st.col_header.is_empty() => flag(Some(&st.col_header), r, c),
669            Some(st) if !st.header_row.is_empty() => st.header_row.get(r).copied().unwrap_or(false),
670            _ => r == 0,
671        };
672        let mut cells = Vec::new();
673        for (r, row) in self.rows.iter().enumerate() {
674            for (c, text) in row.iter().enumerate() {
675                if col_cont(r, c) || row_cont(r, c) {
676                    continue; // covered by a span anchor
677                }
678                let mut col_span = 1;
679                while c + col_span < row.len() && col_cont(r, c + col_span) {
680                    col_span += 1;
681                }
682                let mut row_span = 1;
683                while r + row_span < self.rows.len() && row_cont(r + row_span, c) {
684                    row_span += 1;
685                }
686                cells.push(TableCell {
687                    text: text.clone(),
688                    bbox: None,
689                    start_row: r,
690                    start_col: c,
691                    row_span,
692                    col_span,
693                    column_header: is_col_header(r, c),
694                    row_header: flag(s.map(|s| &s.row_header), r, c),
695                    row_section: false,
696                });
697            }
698        }
699        cells
700    }
701
702    /// The number of leading grid rows that form the column header —
703    /// docling-core's `_count_header_rows` (docling-core#723, 2.96) shared by
704    /// the Markdown serializer and the chunker's dataframe view: a row counts
705    /// only when a `column_header` cell *starts* on it (a header spanning
706    /// several rows is replicated into each row it covers, and counting those
707    /// would pull the data rows beneath it into the header block). Two
708    /// special cases: `1` when no cell carries the flag at all, so tables from
709    /// backends that never set it keep row 0 as the header; `0` when flags
710    /// exist but none starts on row 0 — then nothing is promotable and every
711    /// row stays in the body. Uses the first-class [`Self::cells`] when
712    /// present (the PDF pipeline's TableFormer flags), else the cells derived
713    /// from the structure overlay.
714    ///
715    /// A pivot table's row headers no longer disturb this: docling#4216 flags
716    /// a spanning `<th>` row as `row_header`, not `column_header`, so the
717    /// first data row is no longer folded into the header block and the
718    /// deviation this port carried for docling-core#765 is gone.
719    pub fn header_row_count(&self) -> usize {
720        if self.rows.is_empty() {
721            return 0;
722        }
723        let derived;
724        let cells: &[TableCell] = match &self.cells {
725            Some(c) if !c.is_empty() => c,
726            _ => {
727                derived = self.derive_cells();
728                &derived
729            }
730        };
731        if !cells.iter().any(|c| c.column_header) {
732            return 1;
733        }
734        (0..self.rows.len())
735            .take_while(|&r| cells.iter().any(|c| c.column_header && c.start_row == r))
736            .count()
737    }
738
739    /// The first-class cell covering a grid position, if any.
740    pub fn cell_at(&self, row: usize, col: usize) -> Option<&TableCell> {
741        self.cells.as_ref()?.iter().find(|c| {
742            (c.start_row..c.start_row + c.row_span).contains(&row)
743                && (c.start_col..c.start_col + c.col_span).contains(&col)
744        })
745    }
746
747    /// A cell's bounding box (`[l, t, r, b]`, page points, top-left origin);
748    /// `None` when no cell with geometry covers the position.
749    pub fn cell_bbox(&self, row: usize, col: usize) -> Option<[f32; 4]> {
750        self.cell_at(row, col)?.bbox
751    }
752
753    /// Set (or replace) the bounding box of the cell covering a grid
754    /// position; `false` outside the text grid. A table without first-class
755    /// cells materializes them first (one 1×1 cell per grid position, texts
756    /// from the grid), so declarative tables can be annotated too.
757    pub fn set_cell_bbox(&mut self, row: usize, col: usize, bbox: [f32; 4]) -> bool {
758        if self.rows.get(row).and_then(|r| r.get(col)).is_none() {
759            return false;
760        }
761        let rows = &self.rows;
762        let cells = self.cells.get_or_insert_with(|| {
763            rows.iter()
764                .enumerate()
765                .flat_map(|(r, cols)| {
766                    cols.iter().enumerate().map(move |(c, text)| TableCell {
767                        text: text.clone(),
768                        bbox: None,
769                        start_row: r,
770                        start_col: c,
771                        row_span: 1,
772                        col_span: 1,
773                        column_header: false,
774                        row_header: false,
775                        row_section: false,
776                    })
777                })
778                .collect()
779        });
780        match cells.iter_mut().find(|c| {
781            (c.start_row..c.start_row + c.row_span).contains(&row)
782                && (c.start_col..c.start_col + c.col_span).contains(&col)
783        }) {
784            Some(cell) => {
785                cell.bbox = Some(bbox);
786                true
787            }
788            None => {
789                cells.push(TableCell {
790                    text: self.rows[row][col].clone(),
791                    bbox: Some(bbox),
792                    start_row: row,
793                    start_col: col,
794                    row_span: 1,
795                    col_span: 1,
796                    column_header: false,
797                    row_header: false,
798                    row_section: false,
799                });
800                true
801            }
802        }
803    }
804
805    /// The anchor position of the cell whose box overlaps `bbox` best
806    /// (largest intersection-over-union), ties resolved in cell order.
807    /// `None` when nothing overlaps or the table carries no geometry. This
808    /// is the lookup half of the repair workflow: find the cell an external
809    /// OCR box refers to, then [`Self::set_cell_text`] it.
810    pub fn find_cell_by_bbox(&self, bbox: [f32; 4]) -> Option<(usize, usize)> {
811        let area = |b: &[f32; 4]| ((b[2] - b[0]) * (b[3] - b[1])).max(0.0);
812        let mut best: Option<(f32, (usize, usize))> = None;
813        for cell in self.cells.as_deref()?.iter() {
814            let Some(cb) = cell.bbox else { continue };
815            let iw = (bbox[2].min(cb[2]) - bbox[0].max(cb[0])).max(0.0);
816            let ih = (bbox[3].min(cb[3]) - bbox[1].max(cb[1])).max(0.0);
817            let inter = iw * ih;
818            if inter <= 0.0 {
819                continue;
820            }
821            let iou = inter / (area(&bbox) + area(&cb) - inter).max(f32::EPSILON);
822            if best.is_none_or(|(b, _)| iou > b) {
823                best = Some((iou, (cell.start_row, cell.start_col)));
824            }
825        }
826        best.map(|(_, pos)| pos)
827    }
828
829    /// Locate the cell overlapping `bbox` best and replace its text — the
830    /// one-call form of the OCR-repair loop. Returns the updated anchor.
831    pub fn update_cell_by_bbox(
832        &mut self,
833        bbox: [f32; 4],
834        text: impl Into<String>,
835    ) -> Option<(usize, usize)> {
836        let (row, col) = self.find_cell_by_bbox(bbox)?;
837        self.set_cell_text(row, col, text);
838        Some((row, col))
839    }
840}
841
842/// OTSL structure overlay for a [`Table`], parallel to [`Table::rows`].
843#[derive(Debug, Clone, PartialEq, Default)]
844pub struct TableStructure {
845    /// Per-row: `true` if the row's non-empty cells are column headers
846    /// (emitted as `<ched/>` rather than `<fcel/>`).
847    pub header_row: Vec<bool>,
848    /// Same shape as [`Table::rows`]; `true` where a cell continues a
849    /// horizontal span from its left neighbour (emitted as `<lcel/>`).
850    pub col_continuation: Vec<Vec<bool>>,
851    /// Same shape as [`Table::rows`]; `true` where a cell continues a
852    /// vertical span from the cell above (emitted as `<ucel/>`). Empty or all
853    /// `false` when the backend has no vertical spans (e.g. USPTO CALS).
854    pub row_continuation: Vec<Vec<bool>>,
855    /// Same shape as [`Table::rows`]; `true` where a non-empty cell is a row
856    /// header (emitted as `<rhed/>`) — a chart's category column. Empty when
857    /// the table has no row headers.
858    pub row_header: Vec<Vec<bool>>,
859    /// Same shape as [`Table::rows`]; `true` where a cell is a *column header*
860    /// cell (an HTML `<th>`). When non-empty this per-cell grid supersedes the
861    /// per-row [`Self::header_row`] for `<ched/>` emission, matching docling's
862    /// cell-level `column_header` flag; the chunker derives its header-row
863    /// count from it.
864    pub col_header: Vec<Vec<bool>>,
865}
866
867impl DoclingDocument {
868    /// Create an empty document with the given name.
869    pub fn new(name: impl Into<String>) -> Self {
870        Self {
871            name: name.into(),
872            nodes: Vec::new(),
873            strict_markdown: false,
874            compact_tables: false,
875            page_break_placeholder: None,
876            links: Vec::new(),
877            confidence: None,
878            tree: None,
879        }
880    }
881
882    /// Append a node.
883    /// The document's top-level tables in reading order — the read half of
884    /// the post-extraction table API (#238). [`Node::Located`] wrappers (the
885    /// PDF pipeline attaches layout provenance that way) are looked through;
886    /// tables nested inside rich table cells (`Table::cell_blocks`) are not
887    /// traversed.
888    pub fn tables(&self) -> impl Iterator<Item = &Table> {
889        fn unwrap_table(n: &Node) -> Option<&Table> {
890            match n {
891                Node::Table(t) => Some(t),
892                Node::Located { inner, .. } | Node::Prov { inner, .. } => unwrap_table(inner),
893                _ => None,
894            }
895        }
896        self.nodes.iter().filter_map(unwrap_table)
897    }
898
899    /// Mutable access to the document's top-level tables, for repair
900    /// workflows (#238): locate a cell via [`Table::find_cell_by_bbox`], fix
901    /// its text with [`Table::set_cell_text`], then re-export — every
902    /// serializer reads the same grid.
903    pub fn tables_mut(&mut self) -> impl Iterator<Item = &mut Table> {
904        fn unwrap_table(n: &mut Node) -> Option<&mut Table> {
905            match n {
906                Node::Table(t) => Some(t),
907                Node::Located { inner, .. } | Node::Prov { inner, .. } => unwrap_table(inner),
908                _ => None,
909            }
910        }
911        self.nodes.iter_mut().filter_map(unwrap_table)
912    }
913
914    pub fn push(&mut self, node: Node) {
915        self.nodes.push(node);
916    }
917
918    /// Convenience: append a heading.
919    pub fn add_heading(&mut self, level: u8, text: impl Into<String>) {
920        self.push(Node::Heading {
921            level,
922            text: text.into(),
923        });
924    }
925
926    /// Convenience: append a paragraph.
927    pub fn add_paragraph(&mut self, text: impl Into<String>) {
928        self.push(Node::Paragraph { text: text.into() });
929    }
930
931    /// Serialize the document to Markdown.
932    ///
933    /// The Rust equivalent of docling-core's
934    /// `DoclingDocument.export_to_markdown()`. Uses [`Self::strict_markdown`] to
935    /// pick between docling-legacy output (default) and the cleaner, more
936    /// conformant variant.
937    pub fn export_to_markdown(&self) -> String {
938        to_markdown(self, self.strict_markdown)
939    }
940
941    /// Serialize to Markdown, explicitly choosing the mode regardless of
942    /// [`Self::strict_markdown`]. `strict = true` produces cleaner, more
943    /// conformant Markdown (code-fence languages preserved, no inline-run
944    /// spacing artifacts); `strict = false` reproduces docling's legacy output.
945    pub fn export_to_markdown_with(&self, strict: bool) -> String {
946        to_markdown(self, strict)
947    }
948
949    /// Markdown for this document as the *content of a rich table cell*
950    /// (docling-core's `in_table_cell` serialization, docling-core#540):
951    /// headings render as plain text since Markdown tables can't hold them.
952    /// Backends build a sub-document per rich cell and flatten this into the
953    /// cell text; no trailing newline.
954    pub fn export_to_table_cell_markdown(&self) -> String {
955        crate::markdown::to_markdown_table_cell(self, self.strict_markdown)
956    }
957
958    /// Serialize to docling-core's native JSON wire format (`DoclingDocument`
959    /// schema), pretty-printed — the Rust equivalent of
960    /// `DoclingDocument.export_to_dict()` / `save_as_json()`. The output loads
961    /// back into Python docling-core and round-trips to the same Markdown.
962    pub fn export_to_json(&self) -> String {
963        serde_json::to_string_pretty(&self.export_to_json_value())
964            .expect("DoclingDocument JSON is always serializable")
965    }
966
967    /// The same JSON wire format as [`Self::export_to_json`], as a
968    /// `serde_json::Value` — for callers that append response-level extras
969    /// (docling-serve adds the confidence report, #183) before serializing.
970    pub fn export_to_json_value(&self) -> serde_json::Value {
971        crate::json::to_json(self)
972    }
973
974    /// Serialize to a complete LaTeX document — the Rust counterpart of
975    /// docling-core's `LaTeXDocSerializer` with default parameters (docling
976    /// 2.124's `--to latex`, #317). No trailing newline, like the upstream
977    /// CLI's `<stem>.tex`.
978    pub fn export_to_latex(&self) -> String {
979        crate::latex::to_latex(self)
980    }
981
982    /// Serialize to DocLang XML (`<doclang version="0.7">…`), the markup that
983    /// lives inside a `.dclx` archive — the Rust counterpart of docling-core's
984    /// `export_to_doclang()` with default parameters. No trailing newline; the
985    /// archive writer appends exactly one.
986    pub fn export_to_doclang(&self) -> String {
987        crate::doclang::export_to_doclang(&self.nodes)
988    }
989
990    /// Serialize to Markdown with an explicit picture [`ImageMode`] (mirrors
991    /// docling's `image_mode`). Returns the Markdown and, for
992    /// [`ImageMode::Referenced`], the `(relative-path, bytes)` of each image the
993    /// caller should write next to the Markdown file. `artifacts_dir` is the
994    /// directory name used in referenced links.
995    pub fn export_to_markdown_with_images(
996        &self,
997        image_mode: ImageMode,
998        artifacts_dir: &str,
999    ) -> (String, Vec<(String, Vec<u8>)>) {
1000        to_markdown_images(self, self.strict_markdown, image_mode, artifacts_dir)
1001    }
1002}
1003
1004#[cfg(test)]
1005mod table_api_tests {
1006    use super::*;
1007
1008    fn cell(
1009        text: &str,
1010        bbox: [f32; 4],
1011        (start_row, start_col): (usize, usize),
1012        (row_span, col_span): (usize, usize),
1013    ) -> TableCell {
1014        TableCell {
1015            text: text.into(),
1016            bbox: Some(bbox),
1017            start_row,
1018            start_col,
1019            row_span,
1020            col_span,
1021            column_header: false,
1022            row_header: false,
1023            row_section: false,
1024        }
1025    }
1026
1027    fn table() -> Table {
1028        Table {
1029            rows: vec![
1030                vec!["Year".into(), "Ducks".into()],
1031                vec!["2019".into(), "120".into()],
1032            ],
1033            cells: Some(vec![
1034                cell("Year", [0.0, 0.0, 50.0, 10.0], (0, 0), (1, 1)),
1035                cell("Ducks", [50.0, 0.0, 100.0, 10.0], (0, 1), (1, 1)),
1036                cell("2019", [0.0, 10.0, 50.0, 20.0], (1, 0), (1, 1)),
1037                cell("120", [50.0, 10.0, 100.0, 20.0], (1, 1), (1, 1)),
1038            ]),
1039            ..Default::default()
1040        }
1041    }
1042
1043    /// Declarative tables derive first-class cells from the structure
1044    /// overlay: continuation grids become span extents, `col_header` (or the
1045    /// row-0 fallback) becomes the header role — the XLSX/DOCX/HTML merge
1046    /// path into real `TableCell`s (#240).
1047    #[test]
1048    fn derive_cells_reads_spans_and_headers_from_structure() {
1049        let t = Table {
1050            rows: vec![
1051                vec!["Wide".into(), "Wide".into(), "C".into()],
1052                vec!["a".into(), "b".into(), "c".into()],
1053            ],
1054            structure: Some(TableStructure {
1055                header_row: vec![true, false],
1056                col_continuation: vec![vec![false, true, false], vec![false; 3]],
1057                row_continuation: vec![vec![false; 3], vec![false; 3]],
1058                row_header: Vec::new(),
1059                col_header: Vec::new(),
1060            }),
1061            ..Default::default()
1062        };
1063        let cells = t.derive_cells();
1064        assert_eq!(cells.len(), 5, "two anchors in row 0, three in row 1");
1065        let wide = &cells[0];
1066        assert_eq!((wide.col_span, wide.row_span), (2, 1));
1067        assert!(wide.column_header, "header_row band");
1068        assert!(cells.iter().skip(2).all(|c| !c.column_header));
1069
1070        // Without any overlay: every position 1x1, row 0 the header
1071        // (docling's declarative default — the old JSON synthesis).
1072        let plain = Table {
1073            rows: vec![vec!["h".into()], vec!["x".into()]],
1074            ..Default::default()
1075        };
1076        let cells = plain.derive_cells();
1077        assert_eq!(cells.len(), 2);
1078        assert!(cells[0].column_header && !cells[1].column_header);
1079    }
1080
1081    /// A spanning cell updates once: the record text and every covered grid
1082    /// position — a repair shows once in Markdown, not once per column.
1083    #[test]
1084    fn span_repair_updates_the_whole_cell() {
1085        let mut t = Table {
1086            rows: vec![
1087                vec!["Wide".into(), "Wide".into(), "C".into()],
1088                vec!["a".into(), "b".into(), "c".into()],
1089            ],
1090            cells: Some(vec![
1091                cell("Wide", [0.0, 0.0, 100.0, 10.0], (0, 0), (1, 2)),
1092                cell("C", [100.0, 0.0, 150.0, 10.0], (0, 2), (1, 1)),
1093            ]),
1094            ..Default::default()
1095        };
1096        // Update through the covered (non-anchor) position.
1097        assert!(t.set_cell_text(0, 1, "Fixed"));
1098        assert_eq!(
1099            t.rows[0],
1100            vec!["Fixed".to_string(), "Fixed".into(), "C".into()]
1101        );
1102        assert_eq!(t.cell_at(0, 1).unwrap().text, "Fixed");
1103        assert_eq!(t.cell_at(0, 1).unwrap().col_span, 2);
1104    }
1105
1106    /// The OCR-repair loop (#238): locate a cell by an external box (best
1107    /// IoU), replace its text, and see the fix in the export — the grid is
1108    /// the single source of truth for every serializer.
1109    #[test]
1110    fn bbox_lookup_and_repair_flow_into_exports() {
1111        let mut doc = DoclingDocument::new("t");
1112        doc.push(Node::Table(table()));
1113        assert_eq!(doc.tables().count(), 1);
1114
1115        let t = doc.tables_mut().next().unwrap();
1116        // A slightly-off OCR box still lands on the (1,1) cell.
1117        assert_eq!(t.find_cell_by_bbox([52.0, 11.0, 98.0, 19.0]), Some((1, 1)));
1118        assert_eq!(
1119            t.update_cell_by_bbox([52.0, 11.0, 98.0, 19.0], "125"),
1120            Some((1, 1))
1121        );
1122        assert_eq!(t.cell_text(1, 1), Some("125"));
1123        assert!(doc.export_to_markdown().contains("125"));
1124
1125        // No overlap → no match, nothing changed.
1126        let t = doc.tables_mut().next().unwrap();
1127        assert_eq!(t.find_cell_by_bbox([500.0, 500.0, 600.0, 600.0]), None);
1128    }
1129
1130    #[test]
1131    fn cell_accessors_bound_check_and_geometry_materializes() {
1132        let mut t = table();
1133        assert_eq!(t.cell_text(0, 0), Some("Year"));
1134        assert_eq!(t.cell_text(5, 0), None);
1135        assert!(!t.set_cell_text(0, 9, "x"), "outside the grid");
1136        assert_eq!(t.cell_bbox(1, 0), Some([0.0, 10.0, 50.0, 20.0]));
1137
1138        // A geometry-less table materializes its box grid on first set.
1139        let mut plain = Table {
1140            rows: vec![vec!["a".into(), "b".into()]],
1141            ..Default::default()
1142        };
1143        assert_eq!(plain.cell_bbox(0, 1), None);
1144        assert!(!plain.set_cell_bbox(0, 5, [0.0; 4]), "outside the grid");
1145        assert!(plain.set_cell_bbox(0, 1, [1.0, 2.0, 3.0, 4.0]));
1146        assert_eq!(plain.cell_bbox(0, 1), Some([1.0, 2.0, 3.0, 4.0]));
1147        assert_eq!(plain.find_cell_by_bbox([1.5, 2.5, 2.5, 3.5]), Some((0, 1)));
1148    }
1149}