docling_pdf/pdfium_backend.rs
1//! pdfium-based text extraction and page rendering.
2//!
3//! Text is reconstructed the way docling's `docling-parse` does it, so the
4//! output spacing matches the groundtruth: the page's **character** stream is
5//! grouped into **words** (split at a horizontal gap wider than a fraction of
6//! the font height — font-relative, so letter-tracking in display titles does
7//! not split a word) and words into **lines** (by baseline). pdfium-render's
8//! safe API only exposes whole style runs / `GetBoundedText`, so the character
9//! loop is driven through the raw `PdfiumLibraryBindings` FFI on a second handle
10//! to the same bytes (no fork; stays publishable).
11
12#[cfg(feature = "ocr-prep")]
13use image::RgbImage;
14#[cfg(feature = "ml")]
15use pdfium_render::prelude::*;
16
17/// A run of text with its bounding box, in PDF points with a **top-left** origin
18/// (pdfium's native origin is bottom-left; we flip it to match docling's
19/// `BoundingBox(..., origin=TOPLEFT)`).
20#[derive(Debug, Clone)]
21pub struct TextCell {
22 pub text: String,
23 pub l: f32,
24 pub t: f32,
25 pub r: f32,
26 pub b: f32,
27}
28
29/// Pixels-per-point used to render page images. Layout is scale-invariant (it
30/// scales normalized boxes by the page point size), but OCR benefits from the
31/// extra resolution.
32pub const RENDER_SCALE: f32 = 2.0;
33
34/// One page's geometry, extracted text cells, and a rendered RGB image. The
35/// image is rendered at [`RENDER_SCALE`] pixels per PDF point; `image px =
36/// page point × scale`.
37#[derive(Clone)]
38pub struct PdfPage {
39 pub width: f32,
40 pub height: f32,
41 pub scale: f32,
42 pub cells: Vec<TextCell>,
43 /// Same text grouped for code regions: split only at pdfium space glyphs, so
44 /// monospace runs keep their source spacing instead of the prose heuristic's.
45 pub code_cells: Vec<TextCell>,
46 /// Per-word cells (one per word, not joined into lines) for TableFormer cell
47 /// matching.
48 pub word_cells: Vec<TextCell>,
49 /// The rendered page bitmap. Present whenever pixels are available at all
50 /// (`ocr-prep` ⊂ `ml`): the native pipeline renders it with pdfium, the
51 /// browser pipeline receives it from the host canvas. Picture regions are
52 /// cropped out of it.
53 #[cfg(feature = "ocr-prep")]
54 pub image: RgbImage,
55 /// The **scale-1.0** page image the layout model runs on (docling parity:
56 /// its layout stage calls `page.get_image(scale=1.0)` — pdfium at 1.5×,
57 /// PIL-BICUBIC down to point size — a *different* image from the 2×
58 /// OCR/crop bitmap above, and a different resampling regime than
59 /// stretching that bitmap). `None` on paths without a pdfium renderer
60 /// (browser, METS/TIFF), which fall back to stretching [`Self::image`].
61 #[cfg(feature = "ocr-prep")]
62 pub image_layout: Option<RgbImage>,
63 /// Hyperlink annotations on the page (rect in top-left page coords + target
64 /// URI), restricted to web/mail/tel schemes. Used only by strict Markdown.
65 pub links: Vec<LinkAnnot>,
66 /// The page's `/Rotate` value (0/90/180/270) when it was normalized away
67 /// before inference: a scanned page with `/Rotate` displays its raster
68 /// rotated, which turns OCR into garbage — so extraction un-rotates the
69 /// bitmaps (and swaps `width`/`height`) and records the display rotation
70 /// here. Assembly rotates the finished geometry *back* by this many
71 /// degrees clockwise, so emitted locations and the page size stay in
72 /// display space (matching docling and every PDF viewer). Always 0 for
73 /// text-layer pages (their cells live in display space already) and on
74 /// paths without a pdfium renderer.
75 pub rotation: u16,
76}
77
78impl PdfPage {
79 /// A page built from recognized cells alone — the browser pipeline's
80 /// shape (#157), where the bitmap lives on the JS side. Exists so callers
81 /// compile identically with and without the `ml` feature: under a
82 /// feature-unified workspace build the struct carries the `image` field,
83 /// which a plain literal in a non-`ml` consumer can't spell.
84 #[cfg(feature = "ocr-prep")]
85 pub fn from_cells(width: f32, height: f32, scale: f32, cells: Vec<TextCell>) -> Self {
86 Self {
87 width,
88 height,
89 scale,
90 cells,
91 code_cells: Vec::new(),
92 word_cells: Vec::new(),
93 #[cfg(feature = "ocr-prep")]
94 image: RgbImage::new(0, 0),
95 #[cfg(feature = "ocr-prep")]
96 image_layout: None,
97 links: Vec::new(),
98 rotation: 0,
99 }
100 }
101
102 /// Same as [`from_cells`](Self::from_cells) but carrying the rendered page
103 /// bitmap, so picture regions can be cropped out of it (#157: the browser
104 /// pipeline gets the same figure bytes the native one does).
105 #[cfg(feature = "ocr-prep")]
106 pub fn from_cells_with_image(
107 width: f32,
108 height: f32,
109 scale: f32,
110 cells: Vec<TextCell>,
111 image: RgbImage,
112 ) -> Self {
113 Self {
114 image,
115 ..Self::from_cells(width, height, scale, cells)
116 }
117 }
118
119 /// Un-rotate the page's bitmaps by `deg` (clockwise 90° steps) and record
120 /// the compensating display rotation, composing with any rotation already
121 /// recorded: the raster becomes upright for inference while assembly
122 /// still maps the finished geometry back into display space. Handles both
123 /// `/Rotate` normalization (extraction) and content-detected orientation
124 /// (#225) — the two compose additively (axis-aligned 90° rotations
125 /// commute through the dimension swaps). Link rectangles follow the
126 /// raster; `width`/`height` swap on odd quarter-turns.
127 #[cfg(feature = "ocr-prep")]
128 pub(crate) fn unrotate(&mut self, deg: u16) {
129 if deg == 0 {
130 return;
131 }
132 use image::imageops::{rotate180, rotate270, rotate90};
133 // Display = upright rotated `deg`° clockwise, so upright = display
134 // rotated the complementary amount clockwise.
135 let un = |img: &RgbImage| match deg {
136 90 => rotate270(img),
137 180 => rotate180(img),
138 _ => rotate90(img),
139 };
140 if self.image.width() > 1 {
141 self.image = un(&self.image);
142 }
143 self.image_layout = self.image_layout.as_ref().map(&un);
144 let (width, height) = (self.width, self.height);
145 // Link rects follow the raster from display into upright space (the
146 // inverse of the geometry rotation assembly applies at the end).
147 for l in &mut self.links {
148 let (nl, nt, nr, nb) = match deg {
149 90 => (l.t, width - l.r, l.b, width - l.l),
150 180 => (width - l.r, height - l.b, width - l.l, height - l.t),
151 _ => (height - l.b, l.l, height - l.t, l.r),
152 };
153 (l.l, l.t, l.r, l.b) = (nl, nt, nr, nb);
154 }
155 if deg != 180 {
156 (self.width, self.height) = (height, width);
157 }
158 self.rotation = (self.rotation + deg) % 360;
159 }
160}
161
162/// A PDF link annotation: its rectangle (top-left page coordinates, matching
163/// [`TextCell`]) and target URI.
164#[derive(Debug, Clone)]
165pub struct LinkAnnot {
166 pub l: f32,
167 pub t: f32,
168 pub r: f32,
169 pub b: f32,
170 pub uri: String,
171}
172
173#[cfg(feature = "ml")]
174/// A parsed PDF: per-page text cells and page images.
175pub struct PdfDocument {
176 pub pages: Vec<PdfPage>,
177}
178
179/// Whether to use the docling-parse line sanitizer ([`crate::dp_lines`]) for prose
180/// reconstruction — the default. Set `DOCLING_LEGACY_LINES` to fall back to the
181/// older gap-heuristic `lines_from_glyphs`.
182pub(crate) fn use_dp_lines() -> bool {
183 !docling_core::env::flag("DOCLING_LEGACY_LINES")
184}
185
186/// Whether to source **word** cells from the pure-Rust parser (roadmap item 6),
187/// the default. The parser's `word_cells` reproduce docling-parse's word grouping
188/// byte-for-byte — the per-word tokens TableFormer matches table-grid cells
189/// against — which moves table extraction closer to docling on the heavy
190/// multi-column fixtures. Set `DOCLING_PDFIUM_WORDS` to keep pdfium's word cells,
191/// or `DOCLING_PDFIUM_TEXT` to fall back to pdfium for all text.
192pub(crate) fn use_parser_words() -> bool {
193 !docling_core::env::flag("DOCLING_PDFIUM_WORDS")
194 && !docling_core::env::flag("DOCLING_PDFIUM_TEXT")
195}
196
197/// Whether to source **code** cells from the parser too (the default) — the last
198/// text layer to leave pdfium, fully retiring its text path. The parser's
199/// gap-based code grouping ([`code_cells_from_glyphs`]) reconstructs monospace
200/// spacing from positioning gaps (`function add(a, b) { … }`), so it no longer
201/// drops the inter-token spaces the old space-glyph-only grouping lost
202/// (`functionadd`). Reverts to pdfium with `DOCLING_PDFIUM_WORDS` (alongside word
203/// cells) or `DOCLING_PDFIUM_TEXT` (all text).
204pub(crate) fn use_parser_code() -> bool {
205 use_parser_words()
206}
207
208#[cfg(feature = "ml")]
209/// Try binding pdfium from a directory (or a literal library file path):
210/// `<dir>/<platform library name>` first, else `<dir>` itself as the file.
211fn try_bind_dir(path: &str) -> Option<Box<dyn pdfium_render::prelude::PdfiumLibraryBindings>> {
212 let name = Pdfium::pdfium_platform_library_name_at_path(path);
213 if let Ok(b) = Pdfium::bind_to_library(&name) {
214 return Some(b);
215 }
216 Pdfium::bind_to_library(path).ok()
217}
218
219#[cfg(feature = "ml")]
220/// Bind to the pdfium dynamic library. Honors `PDFIUM_DYNAMIC_LIB_PATH` (a
221/// directory or file) first; else falls back to `.pdfium/lib` relative to the
222/// current directory (the layout `scripts/install/download_dependencies.sh` and
223/// `scripts/install/pdf_setup.sh` both produce); else the system library.
224fn bind() -> Result<Pdfium, PdfiumError> {
225 if let Some(path) = docling_core::env::nonempty("PDFIUM_DYNAMIC_LIB_PATH") {
226 if let Some(b) = try_bind_dir(&path) {
227 return Ok(Pdfium::new(b));
228 }
229 }
230 // No env var (or it didn't resolve): fall back to `.pdfium/lib` relative to
231 // the current directory — mirroring `layout.rs`/`ocr.rs`'s `.models/…`
232 // defaults — the layout `scripts/install/download_dependencies.sh` (and
233 // `scripts/install/pdf_setup.sh`) produce, so a checkout with the dependencies
234 // downloaded next to it needs no env var at all.
235 if let Some(b) = try_bind_dir(&crate::resolve_asset(".pdfium/lib")) {
236 return Ok(Pdfium::new(b));
237 }
238 Pdfium::bind_to_system_library().map(Pdfium::new)
239}
240
241#[cfg(feature = "ml")]
242impl PdfDocument {
243 /// Parse a PDF from bytes, optionally decrypting with `password`.
244 ///
245 /// Note: this materialises **every** page's rendered bitmap in memory at
246 /// once. For large documents prefer [`for_each_page`], which streams.
247 pub fn open(bytes: &[u8], password: Option<&str>) -> Result<Self, PdfiumError> {
248 let pdfium = bind()?;
249 let ffi = FfiText::load(pdfium.bindings(), bytes, password);
250 let doc = pdfium.load_pdf_from_byte_slice(bytes, password)?;
251 let mut rust = rust_parser_cells(bytes);
252 let mut pages = Vec::new();
253 for (i, page) in doc.pages().iter().enumerate() {
254 let rc = rust.as_mut().and_then(|v| v.get_mut(i).map(std::mem::take));
255 pages.push(extract_page(&page, &ffi, i as i32, rc, true)?);
256 }
257 Ok(PdfDocument { pages })
258 }
259}
260
261#[cfg(feature = "ml")]
262/// Per-page prose line cells from the pure-Rust text parser. This is the
263/// **default** text layer (it matches docling-parse's char geometry and is a
264/// strict improvement on byte-conformance — e.g. it recovers the Arabic
265/// sentence-period attachment in `right_to_left_01`). Set `DOCLING_PDFIUM_TEXT`
266/// to fall back to pdfium's text layer. The parser returns an empty page when a
267/// PDF (or a page) has no parseable text layer; the caller keeps pdfium's cells
268/// in that case, so scanned/edge-case pages are unaffected.
269fn rust_parser_cells(bytes: &[u8]) -> Option<Vec<crate::textparse::PageParserCells>> {
270 if docling_core::env::flag("DOCLING_PDFIUM_TEXT") {
271 return None;
272 }
273 Some(crate::timing::timed("textparse", || {
274 crate::textparse::pdf_all_cells(bytes)
275 }))
276}
277
278#[cfg(feature = "ml")]
279/// Number of pages in a PDF, without rendering any of them — used to decide
280/// whether a document is worth spinning up the parallel worker pool.
281pub fn page_count(bytes: &[u8], password: Option<&str>) -> Result<usize, PdfiumError> {
282 let pdfium = bind()?;
283 let doc = pdfium.load_pdf_from_byte_slice(bytes, password)?;
284 Ok(doc.pages().len() as usize)
285}
286
287#[cfg(feature = "ml")]
288/// Render + extract pages one at a time, handing each (owned) [`PdfPage`] to `f`.
289/// Only one page bitmap is resident at a time — a rendered page is ~5 MB, so a
290/// large PDF would otherwise hold gigabytes of bitmaps at once. `f` receives the
291/// zero-based page index and the total page count.
292///
293/// `render_image` controls whether the page bitmap is rasterized at all: layout,
294/// OCR, TableFormer, and picture cropping all need it, but a caller that skips
295/// every one of those (the `no_ocr` fast path) doesn't, and rasterizing +
296/// downsampling a page is by far the most expensive step per page — skipping it
297/// is most of `no_ocr`'s speedup. `PdfPage::image` is a 1×1 placeholder when
298/// `false`; do not read it.
299///
300/// `range` restricts the walk to a **0-based inclusive** page window (issue
301/// #80's `--pages`); out-of-window pages are skipped *before* text extraction
302/// and rasterization, so a 3-page window over a 500-page PDF costs three
303/// pages, not five hundred. `f` still receives the absolute page index, so
304/// downstream page numbering refers to the source document.
305///
306/// `E` is the caller's error type; pdfium errors convert into it via `From`.
307pub fn for_each_page<E, F>(
308 bytes: &[u8],
309 password: Option<&str>,
310 render_image: bool,
311 range: Option<(usize, usize)>,
312 mut f: F,
313) -> Result<(), E>
314where
315 E: From<PdfiumError>,
316 F: FnMut(usize, usize, PdfPage) -> Result<(), E>,
317{
318 let pdfium = bind()?;
319 let ffi = FfiText::load(pdfium.bindings(), bytes, password);
320 let doc = pdfium.load_pdf_from_byte_slice(bytes, password)?;
321 let mut rust = rust_parser_cells(bytes);
322 let pages = doc.pages();
323 let total = pages.len() as usize;
324 let (first, last) = range.unwrap_or((0, total.saturating_sub(1)));
325 for (i, page) in pages.iter().enumerate() {
326 if i < first || i > last {
327 continue;
328 }
329 let rc = rust.as_mut().and_then(|v| v.get_mut(i).map(std::mem::take));
330 let extracted = extract_page(&page, &ffi, i as i32, rc, render_image)?;
331 f(i, total, extracted)?;
332 }
333 Ok(())
334}
335
336/// One rasterized page from [`render_pages`] (#243): the absolute 1-based page
337/// number in the source document, the pixel dimensions, and the PNG bytes.
338#[cfg(feature = "ml")]
339#[derive(Debug, Clone)]
340pub struct RenderedPage {
341 pub page_no: usize,
342 pub width: u32,
343 pub height: u32,
344 pub png: Vec<u8>,
345}
346
347#[cfg(feature = "ml")]
348/// Rasterize a PDF's pages to PNG (#243) — the lean path behind serve's
349/// `to=images`: pdfium render only, no text extraction, no models, and only
350/// one page bitmap resident at a time (each is PNG-encoded and dropped before
351/// the next renders). `scale` is pixels per PDF point — 2.0 matches the
352/// pipeline's [`RENDER_SCALE`] (144 dpi). Unlike the pipeline's render there
353/// is no 1.5× supersample + downsample pass: that dance exists only because
354/// TableFormer is pixel-pinned to docling's bitmaps, and nothing downstream
355/// of this output is — a single render is nearly twice as fast.
356///
357/// `range` is a **1-based** inclusive page window (issue #80's `pages`
358/// semantics: the end clamps to the document, a start past the end errors).
359///
360/// pdfium is not thread-safe — callers must serialize this against any other
361/// pdfium use (docling-serve holds its pipeline mutex around this call for
362/// exactly that reason).
363pub fn render_pages(
364 bytes: &[u8],
365 password: Option<&str>,
366 range: Option<(usize, usize)>,
367 scale: f32,
368) -> Result<Vec<RenderedPage>, crate::PdfError> {
369 let pdfium = bind()?;
370 let doc = pdfium.load_pdf_from_byte_slice(bytes, password)?;
371 let pages = doc.pages();
372 let total = pages.len() as usize;
373 let (first, last) = match range {
374 None => (0, total.saturating_sub(1)),
375 Some((first, last)) => {
376 if first == 0 || last < first {
377 return Err(crate::PdfError::Pdfium(format!(
378 "invalid page range {first}-{last} (pages are 1-based, first <= last)"
379 )));
380 }
381 if first > total {
382 return Err(crate::PdfError::Pdfium(format!(
383 "page range {first}-{last} is outside the document ({total} page(s))"
384 )));
385 }
386 (first - 1, last.min(total) - 1)
387 }
388 };
389 let mut out = Vec::with_capacity(last.saturating_sub(first) + 1);
390 for (i, page) in pages.iter().enumerate() {
391 if i < first || i > last {
392 continue;
393 }
394 // pdfium applies /Rotate itself, so the bitmap is the page as a viewer
395 // shows it — no orientation handling needed (the pipeline's scanned-page
396 // un-rotation is an OCR-conformance concern, not a display one).
397 let tw = (page.width().value * scale).round().max(1.0) as i32;
398 let th = (page.height().value * scale).round().max(1.0) as i32;
399 let cfg = PdfRenderConfig::new()
400 .set_target_width(tw)
401 .set_target_height(th);
402 let bitmap = crate::timing::timed("pdfium.rasterize", || {
403 page.render_with_config(&cfg)
404 .map(|b| b.as_image().into_rgb8())
405 })?;
406 let mut png = Vec::new();
407 bitmap
408 .write_to(&mut std::io::Cursor::new(&mut png), image::ImageFormat::Png)
409 .map_err(|e| crate::PdfError::Pdfium(format!("PNG-encoding page {}: {e}", i + 1)))?;
410 out.push(RenderedPage {
411 page_no: i + 1,
412 width: bitmap.width(),
413 height: bitmap.height(),
414 png,
415 });
416 }
417 Ok(out)
418}
419
420#[cfg(feature = "ml")]
421fn extract_page(
422 page: &pdfium_render::prelude::PdfPage<'_>,
423 ffi: &FfiText<'_>,
424 index: i32,
425 rust_cells: Option<crate::textparse::PageParserCells>,
426 render_image: bool,
427) -> Result<PdfPage, PdfiumError> {
428 let width = page.width().value;
429 let height = page.height().value;
430
431 // Default: use the pure-Rust text parser instead of pdfium's text layer
432 // (override with `DOCLING_PDFIUM_TEXT`). Prose line cells always come from the
433 // parser; word and code cells do too unless `DOCLING_PDFIUM_WORDS` keeps them
434 // on pdfium (the parser's word grouping reproduces docling-parse's, which
435 // TableFormer matches against — roadmap item 6). A page the parser couldn't
436 // read (no text layer) keeps pdfium's cells.
437 let rc = rust_cells.unwrap_or_default();
438 let need_pdfium_prose = rc.prose.is_empty();
439 let need_pdfium_words = !use_parser_words() || rc.words.is_empty();
440 let need_pdfium_code = !use_parser_code() || rc.code.is_empty();
441
442 // The parser covers prose/words/code from one shared glyph pass, so on the
443 // common (parser-succeeded) page all three are already satisfied and this
444 // pdfium FFI call — otherwise fully discarded below — is skipped outright.
445 let (mut cells, mut code_cells, mut word_cells) =
446 if need_pdfium_prose || need_pdfium_words || need_pdfium_code {
447 let (mut cells, code_cells, word_cells) =
448 crate::timing::timed("ffi.page_cells", || ffi.page_cells(index, height));
449 if cells.is_empty() {
450 cells = segment_cells(&page.text()?, height);
451 }
452 (cells, code_cells, word_cells)
453 } else {
454 (Vec::new(), Vec::new(), Vec::new())
455 };
456 if !rc.prose.is_empty() {
457 cells = rc.prose;
458 }
459 if use_parser_words() && !rc.words.is_empty() {
460 word_cells = rc.words;
461 }
462 if use_parser_code() && !rc.code.is_empty() {
463 code_cells = rc.code;
464 }
465
466 let image = if render_image {
467 // docling renders at 1.5× the target scale and downsamples "to make it
468 // sharper" (pypdfium2 → PIL BICUBIC). Replicate exactly: the TableFormer
469 // model is pixel-sensitive, so the page bitmap must match byte-for-byte.
470 // `CatmullRom` is the same a=-0.5 cubic kernel as PIL's BICUBIC.
471 const SUPERSAMPLE: f32 = 1.5;
472 let tw = (width * RENDER_SCALE * SUPERSAMPLE).round().max(1.0) as i32;
473 let th = (height * RENDER_SCALE * SUPERSAMPLE).round().max(1.0) as i32;
474 let cfg = PdfRenderConfig::new()
475 .set_target_width(tw)
476 .set_target_height(th);
477 let big = crate::timing::timed("pdfium.render", || {
478 page.render_with_config(&cfg)
479 .map(|b| b.as_image().into_rgb8())
480 })?;
481 let dw = (width * RENDER_SCALE).round().max(1.0) as u32;
482 let dh = (height * RENDER_SCALE).round().max(1.0) as u32;
483 crate::timing::timed("image.resize", || fast_downscale(&big, dw, dh))
484 } else {
485 RgbImage::new(1, 1)
486 };
487 // The layout model's input image, built exactly like docling's
488 // `get_page_image(scale=1.0)`: a pdfium render at 1.5× (pypdfium2 sizes
489 // with `ceil`), PIL-BICUBIC down to the point-size image (PIL `resize`'s
490 // default kernel; Python `round` = ties-to-even). Distinct from the 2×
491 // bitmap above — resampling 1224→640 and 612→640 are different regimes,
492 // and the heron model's borderline scores follow the pixels.
493 let image_layout = if render_image {
494 let tw = f64::from(width * 1.5).ceil().max(1.0) as i32;
495 let th = f64::from(height * 1.5).ceil().max(1.0) as i32;
496 let cfg = PdfRenderConfig::new()
497 .set_target_width(tw)
498 .set_target_height(th);
499 let big = crate::timing::timed("pdfium.render_layout", || {
500 page.render_with_config(&cfg)
501 .map(|b| b.as_image().into_rgb8())
502 })?;
503 let dw = f64::from(width).round_ties_even().max(1.0) as u32;
504 let dh = f64::from(height).round_ties_even().max(1.0) as u32;
505 Some(crate::timing::timed("image.resize_layout", || {
506 crate::resample::pil_resize(&big, dw, dh, crate::resample::PilFilter::Bicubic)
507 }))
508 } else {
509 None
510 };
511
512 let links = extract_links(page, height);
513
514 // `/Rotate` normalization for scanned pages: pdfium renders the page as a
515 // viewer displays it — `/Rotate` applied — so a rotated scan hands layout
516 // and OCR a sideways/upside-down raster and the recognition output is
517 // garbage. A page with a text layer needs none of this (its cells carry
518 // the geometry; the models never see its pixels decide text), so the
519 // normalization is gated to pages with no cells at all — exactly the set
520 // the OCR path fires on. The bitmaps are un-rotated to upright (lossless
521 // 90° steps), `width`/`height` swap to the upright box, and the display
522 // rotation is recorded so assembly can rotate the finished geometry back
523 // into display space (docling reports rotated pages in display coords).
524 let rotation = match page.rotation() {
525 Ok(PdfPageRenderRotation::Degrees90) => 90u16,
526 Ok(PdfPageRenderRotation::Degrees180) => 180,
527 Ok(PdfPageRenderRotation::Degrees270) => 270,
528 _ => 0,
529 };
530 let scanned = cells.is_empty() && word_cells.is_empty() && code_cells.is_empty();
531 let mut page = PdfPage {
532 width,
533 height,
534 scale: RENDER_SCALE,
535 image_layout,
536 cells,
537 code_cells,
538 word_cells,
539 image,
540 links,
541 rotation: 0,
542 };
543 if rotation != 0 && scanned && render_image {
544 page.unrotate(rotation);
545 }
546 Ok(page)
547}
548
549#[cfg(feature = "ml")]
550/// The supersample→target downscale via `fast_image_resize` (SIMD convolution;
551/// the same a=-0.5 Catmull-Rom kernel as `image::imageops::resize(...,
552/// CatmullRom)` and PIL BICUBIC — see the render comment above). Set
553/// `DOCLING_RS_SLOW_RESIZE=1` to fall back to the `image`-crate scalar resize
554/// (byte-parity with the pre-SIMD pipeline, several times slower).
555fn fast_downscale(big: &RgbImage, dw: u32, dh: u32) -> RgbImage {
556 use fast_image_resize as fir;
557 static SLOW: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
558 let slow = *SLOW.get_or_init(|| docling_core::env::flag("DOCLING_RS_SLOW_RESIZE"));
559 if !slow {
560 if let Some(out) = (|| {
561 let src = fir::images::ImageRef::new(
562 big.width(),
563 big.height(),
564 big.as_raw(),
565 fir::PixelType::U8x3,
566 )
567 .ok()?;
568 let mut dst = fir::images::Image::new(dw, dh, fir::PixelType::U8x3);
569 fir::Resizer::new()
570 .resize(
571 &src,
572 &mut dst,
573 &fir::ResizeOptions::new()
574 .resize_alg(fir::ResizeAlg::Convolution(fir::FilterType::CatmullRom)),
575 )
576 .ok()?;
577 RgbImage::from_raw(dw, dh, dst.into_vec())
578 })() {
579 return out;
580 }
581 // Unreachable in practice; fall through to the scalar path on any error.
582 }
583 image::imageops::resize(big, dw, dh, image::imageops::FilterType::CatmullRom)
584}
585
586#[cfg(feature = "ml")]
587/// Collect web/mail/tel hyperlink annotations on a page, mapping each link's
588/// rectangle into top-left page coordinates (like [`TextCell`]). `file://` and
589/// in-document destinations are skipped — only externally meaningful targets are
590/// rendered. pdfium occasionally lists a link twice; rects are kept as-is and the
591/// caller dedupes by resolved anchor text.
592fn extract_links(page: &pdfium_render::prelude::PdfPage<'_>, page_h: f32) -> Vec<LinkAnnot> {
593 let mut out = Vec::new();
594 for link in page.links().iter() {
595 let Some(uri) = link
596 .action()
597 .and_then(|a| a.as_uri_action().and_then(|u| u.uri().ok()))
598 else {
599 continue;
600 };
601 let scheme_ok = ["http://", "https://", "mailto:", "tel:"]
602 .iter()
603 .any(|s| uri.starts_with(s));
604 if !scheme_ok {
605 continue;
606 }
607 if let Ok(rect) = link.rect() {
608 out.push(LinkAnnot {
609 l: rect.left().value,
610 t: page_h - rect.top().value,
611 r: rect.right().value,
612 b: page_h - rect.bottom().value,
613 uri,
614 });
615 }
616 }
617 out
618}
619
620#[cfg(feature = "ml")]
621/// Fallback line cells from pdfium-render's style segments (one cell per
622/// segment). Used only when the raw-FFI text page can't be loaded.
623fn segment_cells(text: &PdfPageText, page_h: f32) -> Vec<TextCell> {
624 text.segments()
625 .iter()
626 .filter_map(|seg| {
627 let s = seg.text();
628 if s.trim().is_empty() {
629 return None;
630 }
631 let r = seg.bounds();
632 Some(TextCell {
633 text: s,
634 l: r.left().value,
635 t: page_h - r.top().value,
636 r: r.right().value,
637 b: page_h - r.bottom().value,
638 })
639 })
640 .collect()
641}
642
643#[cfg(feature = "ml")]
644/// A second, raw-FFI handle on the same PDF used to drive the character loop
645/// (`FPDFText_GetUnicode`/`GetCharBox`) that pdfium-render's safe API doesn't
646/// expose. Closes the document on drop.
647struct FfiText<'a> {
648 bindings: &'a dyn PdfiumLibraryBindings,
649 doc: FPDF_DOCUMENT,
650}
651
652/// One glyph: codepoint + native (y-up) box edges. `l/b/r/t` is pdfium's *tight*
653/// ink box (used by the legacy `lines_from_glyphs`); `ll/lb/lr/lt` is the *loose*
654/// box (font ascent/descent + advance — uniform per font/size), which the
655/// docling-parse-style sanitizer needs so adjacent glyphs share a top edge.
656pub(crate) struct Glyph {
657 pub(crate) ch: char,
658 pub(crate) l: f32,
659 pub(crate) b: f32,
660 pub(crate) r: f32,
661 pub(crate) t: f32,
662 pub(crate) ll: f32,
663 pub(crate) lb: f32,
664 pub(crate) lr: f32,
665 pub(crate) lt: f32,
666 /// Hash of the PDF font name + flags (0 when not fetched). The sanitizer uses
667 /// it for docling-parse's `enforce_same_font` (keeps a bold label and regular
668 /// value as separate line cells, e.g. `LABEL : value`).
669 pub(crate) font: u64,
670}
671
672#[cfg(feature = "ml")]
673impl<'a> FfiText<'a> {
674 fn load(bindings: &'a dyn PdfiumLibraryBindings, bytes: &[u8], password: Option<&str>) -> Self {
675 let doc = bindings.FPDF_LoadMemDocument(bytes, password);
676 FfiText { bindings, doc }
677 }
678
679 /// Reconstruct line cells for page `index` (zero-based) via the
680 /// chars→words→lines grouping. Returns `(prose_cells, code_cells)` — the same
681 /// glyphs grouped two ways (gap-heuristic for prose, space-glyph-only for
682 /// code). Both empty on any failure (caller falls back).
683 fn page_cells(&self, index: i32, page_h: f32) -> (Vec<TextCell>, Vec<TextCell>, Vec<TextCell>) {
684 let empty = || (Vec::new(), Vec::new(), Vec::new());
685 if self.doc.is_null() {
686 return empty();
687 }
688 let b = self.bindings;
689 let page = b.FPDF_LoadPage(self.doc, index);
690 if page.is_null() {
691 return empty();
692 }
693 let tp = b.FPDFText_LoadPage(page);
694 let out = if tp.is_null() {
695 empty()
696 } else {
697 let dp = use_dp_lines();
698 let g = glyphs(b, tp, dp);
699 b.FPDFText_ClosePage(tp);
700 // Prose line cells: the docling-parse-style sanitizer (behind a flag
701 // while it's validated) or the legacy gap-heuristic reconstruction.
702 let prose = if dp {
703 crate::dp_lines::line_cells(&g, page_h, false)
704 } else {
705 lines_from_glyphs(&g, page_h, Grouping::Prose)
706 };
707 (
708 prose,
709 lines_from_glyphs(&g, page_h, Grouping::CodeSpaceOnly),
710 words_from_glyphs(&g, page_h),
711 )
712 };
713 b.FPDF_ClosePage(page);
714 out
715 }
716}
717
718#[cfg(feature = "ml")]
719impl Drop for FfiText<'_> {
720 fn drop(&mut self) {
721 if !self.doc.is_null() {
722 self.bindings.FPDF_CloseDocument(self.doc);
723 }
724 }
725}
726
727#[cfg(feature = "ml")]
728/// Read every glyph (codepoint + native box) from the text page, in document
729/// order. A space glyph is kept as a word-boundary marker (NaN box, char `' '`);
730/// pdfium emits these on most lines and they pin word splits exactly. Hard line
731/// breaks are dropped (line structure comes from geometry); the gap heuristic in
732/// [`lines_from_glyphs`] is the fallback for the lines pdfium leaves space-less.
733/// Debug helper: the raw pdfium glyph stream (codepoint + native bottom-left
734/// box) for a page, in pdfium's character order. For comparing against
735/// docling-parse's char cells.
736pub fn debug_glyphs(bytes: &[u8], index: i32) -> Vec<(char, f32, f32)> {
737 let Ok(pdfium) = bind() else {
738 return Vec::new();
739 };
740 let ffi = FfiText::load(pdfium.bindings(), bytes, None);
741 if ffi.doc.is_null() {
742 return Vec::new();
743 }
744 let b = ffi.bindings;
745 let page = b.FPDF_LoadPage(ffi.doc, index);
746 if page.is_null() {
747 return Vec::new();
748 }
749 let tp = b.FPDFText_LoadPage(page);
750 let mut out = Vec::new();
751 if !tp.is_null() {
752 for g in glyphs(b, tp, true) {
753 out.push((g.ch, g.ll, g.lr));
754 }
755 b.FPDFText_ClosePage(tp);
756 }
757 b.FPDF_ClosePage(page);
758 out
759}
760
761#[cfg(feature = "ml")]
762/// One text object on a page, for the hidden-layer diagnostic.
763#[derive(Debug, Clone)]
764pub struct DebugTextObject {
765 /// True when the object is drawn invisibly (text render mode 3) — the marker of
766 /// a hidden duplicate text layer.
767 pub invisible: bool,
768 /// Bounding box in native PDF points (bottom-left origin).
769 pub l: f32,
770 pub b: f32,
771 pub r: f32,
772 pub t: f32,
773 /// The object's text (best-effort; empty if it could not be read).
774 pub text: String,
775}
776
777#[cfg(feature = "ml")]
778/// Diagnostic: every text object on page `index`, each tagged visible/invisible
779/// (via the object-level [`FPDFTextObj_GetTextRenderMode`], which — unlike the
780/// per-character render-mode API — is available on the default pdfium binding).
781/// A hidden duplicate text layer shows up as invisible objects repeating the
782/// visible text. Used by the `dump_render_modes` example.
783///
784/// [`FPDFTextObj_GetTextRenderMode`]: pdfium_render::prelude::PdfiumLibraryBindings::FPDFTextObj_GetTextRenderMode
785pub fn debug_text_objects(bytes: &[u8], index: i32) -> Vec<DebugTextObject> {
786 let Ok(pdfium) = bind() else {
787 return Vec::new();
788 };
789 let ffi = FfiText::load(pdfium.bindings(), bytes, None);
790 if ffi.doc.is_null() {
791 return Vec::new();
792 }
793 let b = ffi.bindings;
794 let page = b.FPDF_LoadPage(ffi.doc, index);
795 if page.is_null() {
796 return Vec::new();
797 }
798 let tp = b.FPDFText_LoadPage(page);
799 let mut out = Vec::new();
800 let n = b.FPDFPage_CountObjects(page);
801 for i in 0..n {
802 let obj = b.FPDFPage_GetObject(page, i);
803 if obj.is_null() || b.FPDFPageObj_GetType(obj) != FPDF_PAGEOBJ_TEXT as i32 {
804 continue;
805 }
806 let (mut l, mut bot, mut r, mut top) = (0f32, 0f32, 0f32, 0f32);
807 if b.FPDFPageObj_GetBounds(obj, &mut l, &mut bot, &mut r, &mut top) == 0 {
808 continue;
809 }
810 let invisible = b.FPDFTextObj_GetTextRenderMode(obj) == INVISIBLE_RENDER_MODE;
811 let text = if tp.is_null() {
812 String::new()
813 } else {
814 // FPDFTextObj_GetText returns the count of UTF-16 code units, including
815 // the trailing NUL; call once for the size, once to fill.
816 let need = b.FPDFTextObj_GetText(obj, tp, std::ptr::null_mut(), 0);
817 if need <= 1 {
818 String::new()
819 } else {
820 let mut buf = vec![0u16; need as usize];
821 b.FPDFTextObj_GetText(obj, tp, buf.as_mut_ptr(), need);
822 if let Some(&0) = buf.last() {
823 buf.pop();
824 }
825 String::from_utf16_lossy(&buf)
826 }
827 };
828 out.push(DebugTextObject {
829 invisible,
830 l,
831 b: bot,
832 r,
833 t: top,
834 text,
835 });
836 }
837 if !tp.is_null() {
838 b.FPDFText_ClosePage(tp);
839 }
840 b.FPDF_ClosePage(page);
841 out
842}
843
844#[cfg(feature = "ml")]
845/// Hash a glyph's PDF font name + flags, for `enforce_same_font`. 0 if unavailable.
846fn font_hash(b: &dyn PdfiumLibraryBindings, tp: FPDF_TEXTPAGE, i: i32) -> u64 {
847 use std::hash::{Hash, Hasher};
848 let mut flags: std::os::raw::c_int = 0;
849 let len = b.FPDFText_GetFontInfo(tp, i, std::ptr::null_mut(), 0, &mut flags);
850 if len == 0 {
851 return 0;
852 }
853 let mut buf = vec![0u8; len as usize];
854 b.FPDFText_GetFontInfo(
855 tp,
856 i,
857 buf.as_mut_ptr() as *mut std::os::raw::c_void,
858 len,
859 &mut flags,
860 );
861 let mut h = std::collections::hash_map::DefaultHasher::new();
862 buf.hash(&mut h);
863 flags.hash(&mut h);
864 h.finish()
865}
866
867#[cfg(feature = "ml")]
868/// pdfium text render mode 3: the glyph is drawn with neither fill nor stroke —
869/// an invisible glyph. Web-to-PDF exporters put a hidden plain-text copy of
870/// syntax-highlighted code (and other "copy"/accessibility layers) in this mode,
871/// which the char-level text API then extracts as a duplicate of the visible text.
872const INVISIBLE_RENDER_MODE: i32 = 3;
873
874#[cfg(feature = "ml")]
875fn glyphs(b: &dyn PdfiumLibraryBindings, tp: FPDF_TEXTPAGE, fetch_font: bool) -> Vec<Glyph> {
876 let n = b.FPDFText_CountChars(tp);
877 let mut out = Vec::with_capacity(n.max(0) as usize);
878 for i in 0..n {
879 let ch = match char::from_u32(b.FPDFText_GetUnicode(tp, i)) {
880 Some(c) => c,
881 None => continue,
882 };
883 if ch == '\r' || ch == '\n' {
884 continue;
885 }
886 // Spaces are font-neutral (0): pdfium's generated spaces carry a default
887 // font that would otherwise block every word↔space merge under
888 // enforce_same_font; docling-parse's spaces inherit the run's font.
889 let font = if fetch_font && !ch.is_whitespace() {
890 font_hash(b, tp, i)
891 } else {
892 0
893 };
894 let (mut l, mut r, mut bot, mut top) = (0f64, 0f64, 0f64, 0f64);
895 let has_box = b.FPDFText_GetCharBox(tp, i, &mut l, &mut r, &mut bot, &mut top) != 0;
896 // Loose box: font ascent/descent + glyph advance, uniform per font/size.
897 let mut lr = FS_RECTF {
898 left: 0.0,
899 top: 0.0,
900 right: 0.0,
901 bottom: 0.0,
902 };
903 let (ll, lb, lrt, ltop) = if b.FPDFText_GetLooseCharBox(tp, i, &mut lr) != 0 {
904 (lr.left, lr.bottom, lr.right, lr.top)
905 } else if has_box {
906 (l as f32, bot as f32, r as f32, top as f32)
907 } else {
908 (f32::NAN, 0.0, 0.0, 0.0)
909 };
910 if ch.is_whitespace() {
911 // Keep the space *with its box* (the docling-parse-style line sanitizer
912 // needs literal space glyphs); NaN `l` if pdfium reports no box (the
913 // legacy `lines_from_glyphs` ignores the box and only flags a space).
914 out.push(Glyph {
915 ch: ' ',
916 l: if has_box { l as f32 } else { f32::NAN },
917 b: if has_box { bot as f32 } else { 0.0 },
918 r: if has_box { r as f32 } else { 0.0 },
919 t: if has_box { top as f32 } else { 0.0 },
920 ll,
921 lb,
922 lr: lrt,
923 lt: ltop,
924 font,
925 });
926 continue;
927 }
928 if !has_box {
929 continue;
930 }
931 out.push(Glyph {
932 ch,
933 l: l as f32,
934 b: bot as f32,
935 r: r as f32,
936 t: top as f32,
937 ll,
938 lb,
939 lr: lrt,
940 lt: ltop,
941 font,
942 });
943 }
944 // pdfium splits the Arabic lam-alef ligature into two chars at the *same* x
945 // (it's one glyph) in visual order — `alef-variant, lam`. docling-parse and
946 // logical order are `lam, alef-variant`. Detect the ligature by the shared x
947 // and swap. The shared-x test reliably distinguishes a true ligature from a
948 // genuine `alef + lam` sequence (the article `ال`, or `فعالة`), whose two
949 // glyphs sit at different x and must NOT be reordered.
950 for i in 0..out.len().saturating_sub(1) {
951 let same_x = out[i].l.is_finite()
952 && out[i + 1].l.is_finite()
953 && (out[i].l - out[i + 1].l).abs() < 1.0;
954 if same_x
955 && matches!(out[i].ch, '\u{0622}' | '\u{0623}' | '\u{0625}' | '\u{0627}')
956 && out[i + 1].ch == '\u{0644}'
957 {
958 out.swap(i, i + 1);
959 }
960 }
961 // Reconstruct degenerate (zero-width) loose space boxes by spanning the gap to
962 // the next glyph on the same line, so the sanitizer keeps them as word
963 // separators rather than dropping them (which would merge `Information systems`
964 // → `Informationsystems`). pdfium gives generated spaces a zero-width box at a
965 // wrong baseline; a wrap (different baseline) or a touching gap is left alone.
966 for i in 0..out.len() {
967 if out[i].ch != ' ' || (out[i].lr - out[i].ll).abs() >= 0.5 {
968 continue;
969 }
970 let prev = out[..i]
971 .iter()
972 .rev()
973 .find(|g| g.ch != ' ' && g.ll.is_finite())
974 .map(|g| (g.lr, g.lb, g.lt));
975 let next = out[i + 1..]
976 .iter()
977 .find(|g| g.ch != ' ' && g.ll.is_finite())
978 .map(|g| (g.ll, g.lb));
979 if let (Some((plr, plb, plt)), Some((nll, nlb))) = (prev, next) {
980 let line_h = (plt - plb).abs().max(1.0);
981 if (plb - nlb).abs() < line_h * 0.5 && nll > plr + 0.5 {
982 out[i].ll = plr;
983 out[i].lr = nll;
984 out[i].lb = plb;
985 out[i].lt = plt;
986 }
987 }
988 }
989 out
990}
991
992/// How [`lines_from_glyphs`] splits a line into words.
993#[derive(Clone, Copy, PartialEq)]
994enum Grouping {
995 /// Gap heuristic + punctuation glue (`engines,`, `[37`, `98.5`) — prose.
996 Prose,
997 /// Split only at literal space glyphs, never glue — pdfium code cells.
998 /// pdfium's monospace listings carry a real space glyph at every source space,
999 /// and its overhanging loose boxes would make the gap heuristic over-split
1000 /// (`f un c t i o n`), so honouring just the spaces reproduces the spacing.
1001 CodeSpaceOnly,
1002 /// Split on the inter-glyph **gap** (or a space glyph), but never glue — for
1003 /// the parser's code cells: the parser emits no space glyphs (a source space
1004 /// is a positioning gap), and its clean advance boxes make the gap reliable.
1005 /// Unlike [`Grouping::Prose`] there is no punctuation glue, so a real gap
1006 /// always splits (`et al. 2000`, not `et al.2000`) while genuinely touching
1007 /// tokens stay joined (`add(a,` / `b)`).
1008 CodeGap,
1009}
1010
1011/// Group glyphs (document order) into words then lines, the way docling-parse
1012/// does: a new **word** starts where the horizontal gap to the previous glyph
1013/// exceeds ~0.2 × the font height (a real space is ~0.3 × height; letter
1014/// tracking is smaller, so titles don't shatter); a new **line** starts where
1015/// the baseline drops by ~half the font height (a superscript rises without
1016/// dropping, so it stays on its line). Coordinates are flipped to top-left.
1017/// See [`Grouping`] for how each mode decides word boundaries.
1018fn lines_from_glyphs(gs: &[Glyph], page_h: f32, mode: Grouping) -> Vec<TextCell> {
1019 let mut cells: Vec<TextCell> = Vec::new();
1020 let mut words: Vec<String> = Vec::new(); // words on the current line
1021 let mut word = String::new();
1022 // current line bounding box, native
1023 let (mut ll, mut lb, mut lr, mut lt) = (
1024 f32::INFINITY,
1025 f32::INFINITY,
1026 f32::NEG_INFINITY,
1027 f32::NEG_INFINITY,
1028 );
1029 // Tallest glyph seen on the current line: the word-gap threshold is relative
1030 // to it, so a small-font run on the line (a superscript citation) isn't split
1031 // at its tight digit gaps, while a big display title isn't split at its wider
1032 // letter tracking. A real inter-word space is ~0.3× the font height.
1033 let mut line_h: f32 = 0.0;
1034 let mut prev: Option<&Glyph> = None;
1035 // A space glyph between non-space glyphs pins a word split the gap heuristic
1036 // can miss (tight justified spacing); it carries no geometry.
1037 let mut pending_space = false;
1038
1039 for g in gs {
1040 if g.ch == ' ' {
1041 pending_space = true;
1042 continue;
1043 }
1044 let h = (g.t - g.b).abs().max(1.0);
1045 let (mut new_word, mut new_line) = (false, false);
1046 if let Some(p) = prev {
1047 // A new line drops the baseline *and* resets x leftward; requiring the
1048 // x-reset avoids a descending comma/semicolon faking a line break. A
1049 // *large* drop (≥1.5× the line height — a skipped line, e.g. a centered
1050 // page-number footer below a short last word) is always a new line,
1051 // even without the x-reset.
1052 // LTR wraps reset x leftward (`g.l < p.r`); RTL (Arabic) wraps reset
1053 // rightward (the new line begins at the far right). A large drop
1054 // (≥1.5× line height) is a new line regardless of x.
1055 let x_reset = if is_arabic(g.ch) || is_arabic(p.ch) {
1056 g.l > p.r
1057 } else {
1058 g.l < p.r
1059 };
1060 new_line = (p.b - g.b > h * 0.5 && x_reset) || (p.b - g.b > line_h.max(h) * 1.5);
1061 // Don't split before closing punctuation, after opening punctuation, or
1062 // after a period that runs into a digit/lowercase letter — docling
1063 // keeps `engines,` / `[37` / `i.e.` / `98.5` together even across a
1064 // space or gap.
1065 let glued = is_close_punct(g.ch)
1066 || is_open_punct(p.ch)
1067 || (p.ch.is_ascii_digit() && g.ch.is_ascii_digit())
1068 || (p.ch == '.'
1069 && !pending_space
1070 && (g.ch.is_ascii_digit() || g.ch.is_ascii_lowercase()));
1071 let word_gap = line_h.max(h) * 0.25;
1072 new_word = if mode == Grouping::CodeSpaceOnly {
1073 new_line || pending_space
1074 } else if mode == Grouping::CodeGap {
1075 // Gap-based, no glue: a real gap always splits, touching tokens join.
1076 new_line || pending_space || g.l - p.r > word_gap
1077 } else if is_arabic(g.ch) || is_arabic(p.ch) {
1078 // RTL runs right-to-left, so the inter-word gap is `p.l - g.r`. A
1079 // real word space has a gap; pdfium also emits spurious zero-gap
1080 // space glyphs inside words (`التي`), so require the gap rather
1081 // than trusting a bare space glyph.
1082 new_line || (p.l - g.r > word_gap && !glued)
1083 } else {
1084 new_line || ((pending_space || g.l - p.r > word_gap) && !glued)
1085 };
1086 }
1087 pending_space = false;
1088 if new_line {
1089 push_word(&mut word, &mut words);
1090 push_line(&mut words, (ll, lb, lr, lt), page_h, &mut cells);
1091 (ll, lb, lr, lt) = (
1092 f32::INFINITY,
1093 f32::INFINITY,
1094 f32::NEG_INFINITY,
1095 f32::NEG_INFINITY,
1096 );
1097 line_h = 0.0;
1098 } else if new_word {
1099 push_word(&mut word, &mut words);
1100 }
1101 word.push(g.ch);
1102 ll = ll.min(g.l);
1103 lb = lb.min(g.b);
1104 lr = lr.max(g.r);
1105 lt = lt.max(g.t);
1106 line_h = line_h.max(h);
1107 prev = Some(g);
1108 }
1109 push_word(&mut word, &mut words);
1110 push_line(&mut words, (ll, lb, lr, lt), page_h, &mut cells);
1111 cells
1112}
1113
1114/// Code line cells from the **parser**'s glyph stream. Unlike pdfium — whose
1115/// monospace listings carry explicit space glyphs (so [`Grouping::CodeSpaceOnly`]
1116/// keeps their spacing) — the parser emits no space glyphs: a source space is a
1117/// positioning gap. So code cells use [`Grouping::CodeGap`], which splits on the
1118/// inter-glyph gap (a space wherever it exceeds ~0.25× the line height) but never
1119/// glues punctuation, so `et al. 2000` keeps its space while `add(a,` / `b)` stay
1120/// joined. The parser's clean advance boxes make the gap heuristic reliable here,
1121/// where pdfium's overhanging loose boxes would over-split (`f un c t i o n`).
1122pub(crate) fn code_cells_from_glyphs(gs: &[Glyph], page_h: f32) -> Vec<TextCell> {
1123 lines_from_glyphs(gs, page_h, Grouping::CodeGap)
1124}
1125
1126/// Per-word cells (each word's text + top-left bbox), using the same word/line
1127/// splitting as [`lines_from_glyphs`] but emitting one cell per word instead of
1128/// joining into lines — the legacy gap-heuristic word grouping, kept for the
1129/// pdfium word path (`DOCLING_PDFIUM_WORDS`). The default parser path uses
1130/// [`crate::dp_lines::word_cells`] instead.
1131pub(crate) fn words_from_glyphs(gs: &[Glyph], page_h: f32) -> Vec<TextCell> {
1132 let mut cells = Vec::new();
1133 let mut word = String::new();
1134 let inf = (
1135 f32::INFINITY,
1136 f32::INFINITY,
1137 f32::NEG_INFINITY,
1138 f32::NEG_INFINITY,
1139 );
1140 let (mut wl, mut wb, mut wr, mut wt) = inf;
1141 let mut line_h: f32 = 0.0;
1142 let mut prev: Option<&Glyph> = None;
1143 let mut pending_space = false;
1144 for g in gs {
1145 if g.ch == ' ' {
1146 pending_space = true;
1147 continue;
1148 }
1149 let h = (g.t - g.b).abs().max(1.0);
1150 let mut new_line = false;
1151 let mut new_word = false;
1152 if let Some(p) = prev {
1153 // LTR wraps reset x leftward (`g.l < p.r`); RTL (Arabic) wraps reset
1154 // rightward (the new line begins at the far right). A large drop
1155 // (≥1.5× line height) is a new line regardless of x.
1156 let x_reset = if is_arabic(g.ch) || is_arabic(p.ch) {
1157 g.l > p.r
1158 } else {
1159 g.l < p.r
1160 };
1161 new_line = (p.b - g.b > h * 0.5 && x_reset) || (p.b - g.b > line_h.max(h) * 1.5);
1162 // No digit-digit glue here (unlike the prose grouping): table cells in
1163 // adjacent columns are numeric and a column gap must still split them
1164 // (`0.965` `0.934`, not `0.9650.934`). Intra-number digits have no gap
1165 // so they stay together regardless.
1166 let glued = is_close_punct(g.ch)
1167 || is_open_punct(p.ch)
1168 || (p.ch == '.'
1169 && !pending_space
1170 && (g.ch.is_ascii_digit() || g.ch.is_ascii_lowercase()));
1171 let word_gap = line_h.max(h) * 0.25;
1172 new_word = new_line || ((pending_space || g.l - p.r > word_gap) && !glued);
1173 }
1174 pending_space = false;
1175 if new_word && !word.is_empty() {
1176 cells.push(TextCell {
1177 text: std::mem::take(&mut word),
1178 l: wl,
1179 t: page_h - wt,
1180 r: wr,
1181 b: page_h - wb,
1182 });
1183 (wl, wb, wr, wt) = inf;
1184 }
1185 if new_line {
1186 line_h = 0.0;
1187 }
1188 word.push(g.ch);
1189 wl = wl.min(g.l);
1190 wb = wb.min(g.b);
1191 wr = wr.max(g.r);
1192 wt = wt.max(g.t);
1193 line_h = line_h.max(h);
1194 prev = Some(g);
1195 }
1196 if !word.is_empty() {
1197 cells.push(TextCell {
1198 text: word,
1199 l: wl,
1200 t: page_h - wt,
1201 r: wr,
1202 b: page_h - wb,
1203 });
1204 }
1205 cells
1206}
1207
1208fn is_arabic(c: char) -> bool {
1209 ('\u{0600}'..='\u{06FF}').contains(&c)
1210}
1211
1212fn is_close_punct(c: char) -> bool {
1213 matches!(
1214 c,
1215 ',' | '.' | ';' | '!' | '?' | ')' | ']' | '}' | '%' | '\'' | '\u{2019}' | '\u{2018}'
1216 )
1217}
1218
1219fn is_open_punct(c: char) -> bool {
1220 // `@` glues to what follows (`mAP @0.5`, `bpf@zurich`, `@decorator`).
1221 matches!(c, '(' | '[' | '{' | '@')
1222}
1223
1224fn push_word(word: &mut String, words: &mut Vec<String>) {
1225 if !word.is_empty() {
1226 words.push(std::mem::take(word));
1227 }
1228}
1229
1230fn push_line(
1231 words: &mut Vec<String>,
1232 bbox: (f32, f32, f32, f32),
1233 page_h: f32,
1234 cells: &mut Vec<TextCell>,
1235) {
1236 if words.is_empty() {
1237 return;
1238 }
1239 let text = std::mem::take(words).join(" ");
1240 let (l, b, r, t) = bbox;
1241 cells.push(TextCell {
1242 text,
1243 l,
1244 t: page_h - t,
1245 r,
1246 b: page_h - b,
1247 });
1248}