pdftract/crates/pdftract-core
jedarden 24f5af8fc5 feat(pdftract-47zt): implement thread-local Tesseract instance management
Implement Phase 5.4 Tesseract integration with thread-local caching.
Each rayon worker thread holds one TessBaseAPI in a thread_local! RefCell,
with lazy initialization on first use and reinitialization only when OCR
configuration changes (language or tessdata path).

- Add TessOpts with PartialEq for cache comparison
- Add TessState wrapping TessBaseAPI + last opts
- Implement thread_local! TESS with RefCell<Option<TessState>>
- Implement borrow_or_init() helper with caching strategy
- Add tessdata path resolution: opts.tessdata_path > TESSDATA_PREFIX > default
- Add INIT_COUNT atomic for testing initialization behavior
- Implement all acceptance criteria tests (cache reuse, diff-opts, multithreaded)

Dependencies:
- Add tesseract 0.15 crate (optional, ocr feature)

Tests:
- test_microbenchmark_cache_reuse: 100 calls → 1 init + 99 reuses ✓
- test_diff_opts_reinit: alternating languages → 2 inits ✓
- test_multithreaded_inits: 4 workers → at most 8 inits ✓
- test_resolve_tessdata_path_*: path resolution priority ✓

Note: Full compilation requires libleptonica-dev and libtesseract-dev
system packages. Rust code is syntactically correct; WARN for memory
leak test (requires valgrind/sanitizer on system with OCR deps).

Co-Authored-By: Claude Code <noreply@anthropic.com>
2026-05-23 23:04:59 -04:00
..
benches feat(pdftract-3nwz): add borderless table detection benchmark 2026-05-23 22:30:06 -04:00
build feat(pdftract-43ry): implement predefined CMap registry 2026-05-23 23:00:59 -04:00
examples feat(pdftract-mcp): add MCP server implementation changes 2026-05-23 03:09:56 -04:00
proptest-regressions/parser/lexer feat(pdftract-29z7b): implement unified diagnostic system + CLI commands 2026-05-22 22:38:31 -04:00
src feat(pdftract-47zt): implement thread-local Tesseract instance management 2026-05-23 23:04:59 -04:00
tests feat(pdftract-2w3r): implement StructTree coverage check and XY-cut fallback 2026-05-23 20:53:25 -04:00
__test__.pdf feat(pdftract-15pz8): implement multi-process safe cache operations 2026-05-23 05:31:11 -04:00
build.rs feat(pdftract-43ry): implement predefined CMap registry 2026-05-23 23:00:59 -04:00
Cargo.toml feat(pdftract-47zt): implement thread-local Tesseract instance management 2026-05-23 23:04:59 -04:00
pdftract-core.cdx.json feat(pdftract-67tm8): implement MCP stdio transport with integration tests 2026-05-23 00:16:42 -04:00
README.md docs(pdftract-49f8): establish Cargo.lock policy and documentation 2026-05-20 18:13:14 -04:00

pdftract-core

The core Rust library for PDF text extraction. This crate provides the parsing, layout analysis, font encoding recovery, and text extraction primitives used by the CLI (pdftract-cli) and Python bindings (pdftract-py).

Cargo.lock Policy

This workspace checks in Cargo.lock at the repository root. This is unconventional for library crates—the Cargo Book historically suggested that only binary crates should check in lockfiles, allowing library consumers to resolve their own dependency versions.

pdftract departs from this convention for release reproducibility:

  1. SLSA Level 3 provenance requires that every milestone tag produces byte-identical artifacts across builds. Without a checked-in lockfile, two runs of cargo build on the same commit can resolve different transitive dependency versions, producing different binary hashes.

  2. Multi-output artifacts—this workspace produces Rust crates (pdftract-core, pdftract-cli), Python wheels (pdftract-py), and Docker images. All must be built from the same dependency tree.

  3. Supply-chain security—the lockfile pins checksums for all transitive dependencies, enabling cargo audit to detect yanked or compromised crates.

  4. Downstream consumers can still ignore the lockfile if needed. Cargo allows cargo build --frozen with a local lockfile override, or consumers can vendor the crate with their own dependency resolution.

The tradeoff—occasional merge conflicts when PRs update overlapping dependencies—is worth the guarantee of reproducible releases. See CONTRIBUTING.md for the lockfile-update workflow.

Modules

  • parser: PDF spec parsing (xref, trailer, object streams, indirect references)
  • font: Font encoding recovery, glyph name lookup, fingerprinting
  • layout: Page layout analysis, region segmentation, reading order
  • extract: Text extraction with provenance (bounding boxes, confidence scores)
  • ocr: Tesseract integration for raster pages

Usage

use pdftract_core::{extract_text, ExtractOptions};

let options = ExtractOptions::default();
let result = extract_text("document.pdf", &options)?;
println!("{}", result.text);