kreuzberg 4.0.0.rc2 → 4.0.0

data/vendor/kreuzberg/src/pdf/table.rs

@@ -1,393 +1,417 @@
-//! PDF table extraction using pdfium character positions.
-//!
-//! This module converts pdfium character data to HocrWord format,
-//! allowing us to reuse the existing table reconstruction logic.
-
-use super::error::{PdfError, Result};
-use html_to_markdown_rs::hocr::HocrWord;
-use pdfium_render::prelude::*;
-
-/// Spacing threshold for word boundary detection (in PDF units).
-///
-/// Characters separated by more than this distance are considered separate words.
-const WORD_SPACING_THRESHOLD: f32 = 3.0;
-
-/// Minimum word length for table detection (filter out noise).
-const MIN_WORD_LENGTH: usize = 1;
-
-/// Extract words with positions from PDF page for table detection.
-///
-/// Groups adjacent characters into words based on spacing heuristics,
-/// then converts to HocrWord format for table reconstruction.
-///
-/// # Arguments
-///
-/// * `page` - PDF page to extract words from
-/// * `min_confidence` - Minimum confidence threshold (0.0-100.0). PDF text has high confidence (95.0).
-///
-/// # Returns
-///
-/// Vector of HocrWord objects with text and bounding box information.
-///
-/// # Example
-///
-/// ```rust,no_run
-/// use kreuzberg::pdf::table::extract_words_from_page;
-/// use pdfium_render::prelude::*;
-///
-/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-/// let pdfium = Pdfium::default();
-/// let document = pdfium.load_pdf_from_file("example.pdf", None)?;
-/// let page = document.pages().get(0)?;
-/// let words = extract_words_from_page(&page, 90.0)?;
-/// # Ok(())
-/// # }
-/// ```
-pub fn extract_words_from_page(page: &PdfPage, min_confidence: f64) -> Result<Vec<HocrWord>> {
-    let page_width = page.width().value as i32;
-    let page_height = page.height().value as i32;
-
-    let page_text = page
-        .text()
-        .map_err(|e| PdfError::TextExtractionFailed(format!("Failed to get page text: {}", e)))?;
-
-    let chars = page_text.chars();
-
-    let words = group_chars_into_words(chars, page_width, page_height, min_confidence)?;
-
-    Ok(words)
-}
-
-/// Character with position information extracted from PDF.
-#[derive(Debug, Clone)]
-struct CharInfo {
-    text: char,
-    x: f32,
-    y: f32,
-    width: f32,
-    height: f32,
-}
-
-/// Group PDF characters into words based on spacing heuristics.
-///
-/// Characters are grouped into the same word if they are:
-/// 1. On the same horizontal line (similar y-coordinate)
-/// 2. Close together horizontally (spacing < WORD_SPACING_THRESHOLD)
-///
-/// # Arguments
-///
-/// * `chars` - Iterator of PDF page characters
-/// * `page_width` - Page width in PDF units
-/// * `page_height` - Page height in PDF units
-/// * `min_confidence` - Minimum confidence threshold (PDF text uses 95.0)
-fn group_chars_into_words(
-    chars: PdfPageTextChars,
-    _page_width: i32,
-    page_height: i32,
-    min_confidence: f64,
-) -> Result<Vec<HocrWord>> {
-    let mut words: Vec<HocrWord> = Vec::new();
-    let mut current_word_chars: Vec<CharInfo> = Vec::new();
-
-    for pdf_char in chars.iter() {
-        let bounds = pdf_char
-            .loose_bounds()
-            .map_err(|e| PdfError::TextExtractionFailed(format!("Failed to get char bounds: {}", e)))?;
-
-        let Some(ch) = pdf_char.unicode_char() else {
-            continue;
-        };
-
-        let char_info = CharInfo {
-            text: ch,
-            x: bounds.left().value,
-            y: bounds.bottom().value,
-            width: bounds.width().value,
-            height: bounds.height().value,
-        };
-
-        if char_info.text.is_whitespace() {
-            if !current_word_chars.is_empty() {
-                if let Some(word) = finalize_word(&current_word_chars, page_height, min_confidence) {
-                    words.push(word);
-                }
-                current_word_chars.clear();
-            }
-            continue;
-        }
-
-        if should_start_new_word(&current_word_chars, &char_info) && !current_word_chars.is_empty() {
-            if let Some(word) = finalize_word(&current_word_chars, page_height, min_confidence) {
-                words.push(word);
-            }
-            current_word_chars.clear();
-        }
-
-        current_word_chars.push(char_info);
-    }
-
-    if !current_word_chars.is_empty()
-        && let Some(word) = finalize_word(&current_word_chars, page_height, min_confidence)
-    {
-        words.push(word);
-    }
-
-    Ok(words)
-}
-
-/// Determine if a new character should start a new word.
-///
-/// Returns true if the character is far from the previous character
-/// (indicating a word boundary) or on a different line.
-fn should_start_new_word(current_word_chars: &[CharInfo], new_char: &CharInfo) -> bool {
-    if current_word_chars.is_empty() {
-        return false;
-    }
-
-    let last_char = &current_word_chars[current_word_chars.len() - 1];
-
-    let vertical_distance = (new_char.y - last_char.y).abs();
-    if vertical_distance > last_char.height * 0.5 {
-        return true;
-    }
-
-    let horizontal_gap = new_char.x - (last_char.x + last_char.width);
-    horizontal_gap > WORD_SPACING_THRESHOLD
-}
-
-/// Convert a group of characters into a HocrWord.
-///
-/// Calculates bounding box and confidence for the word.
-/// Returns None if the word doesn't meet minimum criteria.
-fn finalize_word(chars: &[CharInfo], page_height: i32, min_confidence: f64) -> Option<HocrWord> {
-    if chars.is_empty() {
-        return None;
-    }
-
-    let text: String = chars.iter().map(|c| c.text).collect();
-
-    if text.len() < MIN_WORD_LENGTH {
-        return None;
-    }
-
-    let left = chars
-        .iter()
-        .map(|c| c.x)
-        .min_by(|a, b| a.partial_cmp(b).unwrap())
-        .unwrap_or(0.0);
-    let right = chars
-        .iter()
-        .map(|c| c.x + c.width)
-        .max_by(|a, b| a.partial_cmp(b).unwrap())
-        .unwrap_or(0.0);
-    let bottom = chars
-        .iter()
-        .map(|c| c.y)
-        .min_by(|a, b| a.partial_cmp(b).unwrap())
-        .unwrap_or(0.0);
-    let top = chars
-        .iter()
-        .map(|c| c.y + c.height)
-        .max_by(|a, b| a.partial_cmp(b).unwrap())
-        .unwrap_or(0.0);
-
-    let width = (right - left).round() as i32;
-    let height = (top - bottom).round() as i32;
-
-    let top_in_image_coords = (page_height as f32 - top).round() as i32;
-
-    let confidence = 95.0;
-
-    if confidence < min_confidence {
-        return None;
-    }
-
-    Some(HocrWord {
-        text,
-        left: left.round().max(0.0) as u32,
-        top: top_in_image_coords.max(0) as u32,
-        width: width.max(0) as u32,
-        height: height.max(0) as u32,
-        confidence,
-    })
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn test_char_info_creation() {
-        let char_info = CharInfo {
-            text: 'A',
-            x: 100.0,
-            y: 50.0,
-            width: 10.0,
-            height: 12.0,
-        };
-
-        assert_eq!(char_info.text, 'A');
-        assert_eq!(char_info.x, 100.0);
-        assert_eq!(char_info.width, 10.0);
-    }
-
-    #[test]
-    fn test_should_start_new_word_empty() {
-        let chars: Vec<CharInfo> = vec![];
-        let new_char = CharInfo {
-            text: 'A',
-            x: 100.0,
-            y: 50.0,
-            width: 10.0,
-            height: 12.0,
-        };
-
-        assert!(!should_start_new_word(&chars, &new_char));
-    }
-
-    #[test]
-    fn test_should_start_new_word_spacing() {
-        let chars = vec![CharInfo {
-            text: 'A',
-            x: 100.0,
-            y: 50.0,
-            width: 10.0,
-            height: 12.0,
-        }];
-
-        let close_char = CharInfo {
-            text: 'B',
-            x: 111.0,
-            y: 50.0,
-            width: 10.0,
-            height: 12.0,
-        };
-        assert!(!should_start_new_word(&chars, &close_char));
-
-        let far_char = CharInfo {
-            text: 'C',
-            x: 120.0,
-            y: 50.0,
-            width: 10.0,
-            height: 12.0,
-        };
-        assert!(should_start_new_word(&chars, &far_char));
-    }
-
-    #[test]
-    fn test_should_start_new_word_different_line() {
-        let chars = vec![CharInfo {
-            text: 'A',
-            x: 100.0,
-            y: 50.0,
-            width: 10.0,
-            height: 12.0,
-        }];
-
-        let new_line_char = CharInfo {
-            text: 'B',
-            x: 100.0,
-            y: 70.0,
-            width: 10.0,
-            height: 12.0,
-        };
-        assert!(should_start_new_word(&chars, &new_line_char));
-    }
-
-    #[test]
-    fn test_finalize_word_basic() {
-        let chars = vec![
-            CharInfo {
-                text: 'H',
-                x: 100.0,
-                y: 50.0,
-                width: 10.0,
-                height: 12.0,
-            },
-            CharInfo {
-                text: 'i',
-                x: 110.0,
-                y: 50.0,
-                width: 8.0,
-                height: 12.0,
-            },
-        ];
-
-        let page_height = 800;
-        let word = finalize_word(&chars, page_height, 0.0).unwrap();
-
-        assert_eq!(word.text, "Hi");
-        assert_eq!(word.left, 100);
-        assert_eq!(word.width, 18);
-        assert_eq!(word.height, 12);
-        assert_eq!(word.confidence, 95.0);
-    }
-
-    #[test]
-    fn test_finalize_word_empty() {
-        let chars: Vec<CharInfo> = vec![];
-        let word = finalize_word(&chars, 800, 0.0);
-        assert!(word.is_none());
-    }
-
-    #[test]
-    fn test_finalize_word_confidence_filter() {
-        let chars = vec![CharInfo {
-            text: 'A',
-            x: 100.0,
-            y: 50.0,
-            width: 10.0,
-            height: 12.0,
-        }];
-
-        let word = finalize_word(&chars, 800, 90.0);
-        assert!(word.is_some());
-
-        let word = finalize_word(&chars, 800, 96.0);
-        assert!(word.is_none());
-    }
-
-    #[test]
-    fn test_coordinate_conversion() {
-        let chars = vec![CharInfo {
-            text: 'A',
-            x: 100.0,
-            y: 700.0,
-            width: 10.0,
-            height: 12.0,
-        }];
-
-        let page_height = 800;
-        let word = finalize_word(&chars, page_height, 0.0).unwrap();
-
-        assert_eq!(word.top, 88);
-    }
-
-    #[test]
-    fn test_word_bounding_box() {
-        let chars = vec![
-            CharInfo {
-                text: 'A',
-                x: 100.0,
-                y: 50.0,
-                width: 10.0,
-                height: 12.0,
-            },
-            CharInfo {
-                text: 'B',
-                x: 110.0,
-                y: 51.0,
-                width: 10.0,
-                height: 13.0,
-            },
-        ];
-
-        let word = finalize_word(&chars, 800, 0.0).unwrap();
-
-        assert_eq!(word.left, 100);
-
-        assert_eq!(word.width, 20);
-
-        assert_eq!(word.height, 14);
-    }
-}
+//! PDF table extraction using pdfium character positions.
+//!
+//! This module converts pdfium character data to HocrWord format,
+//! allowing us to reuse the existing table reconstruction logic.
+//!
+//! Note: Table extraction requires the "ocr" feature and is not available in WASM builds.
+
+use super::error::{PdfError, Result};
+#[cfg(feature = "ocr")]
+use crate::ocr::table::HocrWord;
+use pdfium_render::prelude::*;
+
+/// Spacing threshold for word boundary detection (in PDF units).
+///
+/// Characters separated by more than this distance are considered separate words.
+#[cfg(feature = "ocr")]
+const WORD_SPACING_THRESHOLD: f32 = 3.0;
+
+/// Minimum word length for table detection (filter out noise).
+#[cfg(feature = "ocr")]
+const MIN_WORD_LENGTH: usize = 1;
+
+/// Extract words with positions from PDF page for table detection.
+///
+/// Groups adjacent characters into words based on spacing heuristics,
+/// then converts to HocrWord format for table reconstruction.
+///
+/// # Arguments
+///
+/// * `page` - PDF page to extract words from
+/// * `min_confidence` - Minimum confidence threshold (0.0-100.0). PDF text has high confidence (95.0).
+///
+/// # Returns
+///
+/// Vector of HocrWord objects with text and bounding box information.
+///
+/// # Note
+/// This function requires the "ocr" feature to be enabled. Without it, returns an error.
+///
+/// # Example
+///
+/// ```rust,no_run
+/// # #[cfg(feature = "ocr")]
+/// # {
+/// use kreuzberg::pdf::table::extract_words_from_page;
+/// use pdfium_render::prelude::*;
+///
+/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+/// let pdfium = Pdfium::default();
+/// let document = pdfium.load_pdf_from_file("example.pdf", None)?;
+/// let page = document.pages().get(0)?;
+/// let words = extract_words_from_page(&page, 90.0)?;
+/// # Ok(())
+/// # }
+/// # }
+/// ```
+#[cfg(feature = "ocr")]
+pub fn extract_words_from_page(page: &PdfPage, min_confidence: f64) -> Result<Vec<HocrWord>> {
+    let page_width = page.width().value as i32;
+    let page_height = page.height().value as i32;
+
+    let page_text = page
+        .text()
+        .map_err(|e| PdfError::TextExtractionFailed(format!("Failed to get page text: {}", e)))?;
+
+    let chars = page_text.chars();
+
+    let words = group_chars_into_words(chars, page_width, page_height, min_confidence)?;
+
+    Ok(words)
+}
+
+/// Fallback implementation when OCR feature is disabled.
+///
+/// # Errors
+/// Always returns an error indicating that the OCR feature is required.
+#[cfg(not(feature = "ocr"))]
+pub fn extract_words_from_page(_page: &PdfPage, _min_confidence: f64) -> Result<Vec<()>> {
+    Err(PdfError::TextExtractionFailed(
+        "PDF table extraction requires the 'ocr' feature to be enabled".to_string(),
+    ))
+}
+
+/// Character with position information extracted from PDF.
+#[cfg(feature = "ocr")]
+#[derive(Debug, Clone)]
+struct CharInfo {
+    text: char,
+    x: f32,
+    y: f32,
+    width: f32,
+    height: f32,
+}
+
+/// Group PDF characters into words based on spacing heuristics.
+///
+/// Characters are grouped into the same word if they are:
+/// 1. On the same horizontal line (similar y-coordinate)
+/// 2. Close together horizontally (spacing < WORD_SPACING_THRESHOLD)
+///
+/// # Arguments
+///
+/// * `chars` - Iterator of PDF page characters
+/// * `page_width` - Page width in PDF units
+/// * `page_height` - Page height in PDF units
+/// * `min_confidence` - Minimum confidence threshold (PDF text uses 95.0)
+#[cfg(feature = "ocr")]
+fn group_chars_into_words(
+    chars: PdfPageTextChars,
+    _page_width: i32,
+    page_height: i32,
+    min_confidence: f64,
+) -> Result<Vec<HocrWord>> {
+    let mut words: Vec<HocrWord> = Vec::new();
+    let mut current_word_chars: Vec<CharInfo> = Vec::new();
+
+    for pdf_char in chars.iter() {
+        let bounds = pdf_char
+            .loose_bounds()
+            .map_err(|e| PdfError::TextExtractionFailed(format!("Failed to get char bounds: {}", e)))?;
+
+        let Some(ch) = pdf_char.unicode_char() else {
+            continue;
+        };
+
+        let char_info = CharInfo {
+            text: ch,
+            x: bounds.left().value,
+            y: bounds.bottom().value,
+            width: bounds.width().value,
+            height: bounds.height().value,
+        };
+
+        if char_info.text.is_whitespace() {
+            if !current_word_chars.is_empty() {
+                if let Some(word) = finalize_word(&current_word_chars, page_height, min_confidence) {
+                    words.push(word);
+                }
+                current_word_chars.clear();
+            }
+            continue;
+        }
+
+        if should_start_new_word(&current_word_chars, &char_info) && !current_word_chars.is_empty() {
+            if let Some(word) = finalize_word(&current_word_chars, page_height, min_confidence) {
+                words.push(word);
+            }
+            current_word_chars.clear();
+        }
+
+        current_word_chars.push(char_info);
+    }
+
+    if !current_word_chars.is_empty()
+        && let Some(word) = finalize_word(&current_word_chars, page_height, min_confidence)
+    {
+        words.push(word);
+    }
+
+    Ok(words)
+}
+
+/// Determine if a new character should start a new word.
+///
+/// Returns true if the character is far from the previous character
+/// (indicating a word boundary) or on a different line.
+#[cfg(feature = "ocr")]
+fn should_start_new_word(current_word_chars: &[CharInfo], new_char: &CharInfo) -> bool {
+    if current_word_chars.is_empty() {
+        return false;
+    }
+
+    let last_char = &current_word_chars[current_word_chars.len() - 1];
+
+    let vertical_distance = (new_char.y - last_char.y).abs();
+    if vertical_distance > last_char.height * 0.5 {
+        return true;
+    }
+
+    let horizontal_gap = new_char.x - (last_char.x + last_char.width);
+    horizontal_gap > WORD_SPACING_THRESHOLD
+}
+
+/// Convert a group of characters into a HocrWord.
+///
+/// Calculates bounding box and confidence for the word.
+/// Returns None if the word doesn't meet minimum criteria.
+#[cfg(feature = "ocr")]
+fn finalize_word(chars: &[CharInfo], page_height: i32, min_confidence: f64) -> Option<HocrWord> {
+    if chars.is_empty() {
+        return None;
+    }
+
+    let text: String = chars.iter().map(|c| c.text).collect();
+
+    if text.len() < MIN_WORD_LENGTH {
+        return None;
+    }
+
+    let (left, right, bottom, top) = chars.iter().fold(
+        (f32::INFINITY, f32::NEG_INFINITY, f32::INFINITY, f32::NEG_INFINITY),
+        |(left, right, bottom, top), c| {
+            (
+                left.min(c.x),
+                right.max(c.x + c.width),
+                bottom.min(c.y),
+                top.max(c.y + c.height),
+            )
+        },
+    );
+
+    let (left, right, bottom, top) = if left.is_infinite() {
+        (0.0, 0.0, 0.0, 0.0)
+    } else {
+        (left, right, bottom, top)
+    };
+
+    let width = (right - left).round() as i32;
+    let height = (top - bottom).round() as i32;
+
+    let top_in_image_coords = (page_height as f32 - top).round() as i32;
+
+    let confidence = 95.0;
+
+    if confidence < min_confidence {
+        return None;
+    }
+
+    Some(HocrWord {
+        text,
+        left: left.round().max(0.0) as u32,
+        top: top_in_image_coords.max(0) as u32,
+        width: width.max(0) as u32,
+        height: height.max(0) as u32,
+        confidence,
+    })
+}
+
+#[cfg(all(test, feature = "ocr"))]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_char_info_creation() {
+        let char_info = CharInfo {
+            text: 'A',
+            x: 100.0,
+            y: 50.0,
+            width: 10.0,
+            height: 12.0,
+        };
+
+        assert_eq!(char_info.text, 'A');
+        assert_eq!(char_info.x, 100.0);
+        assert_eq!(char_info.width, 10.0);
+    }
+
+    #[test]
+    fn test_should_start_new_word_empty() {
+        let chars: Vec<CharInfo> = vec![];
+        let new_char = CharInfo {
+            text: 'A',
+            x: 100.0,
+            y: 50.0,
+            width: 10.0,
+            height: 12.0,
+        };
+
+        assert!(!should_start_new_word(&chars, &new_char));
+    }
+
+    #[test]
+    fn test_should_start_new_word_spacing() {
+        let chars = vec![CharInfo {
+            text: 'A',
+            x: 100.0,
+            y: 50.0,
+            width: 10.0,
+            height: 12.0,
+        }];
+
+        let close_char = CharInfo {
+            text: 'B',
+            x: 111.0,
+            y: 50.0,
+            width: 10.0,
+            height: 12.0,
+        };
+        assert!(!should_start_new_word(&chars, &close_char));
+
+        let far_char = CharInfo {
+            text: 'C',
+            x: 120.0,
+            y: 50.0,
+            width: 10.0,
+            height: 12.0,
+        };
+        assert!(should_start_new_word(&chars, &far_char));
+    }
+
+    #[test]
+    fn test_should_start_new_word_different_line() {
+        let chars = vec![CharInfo {
+            text: 'A',
+            x: 100.0,
+            y: 50.0,
+            width: 10.0,
+            height: 12.0,
+        }];
+
+        let new_line_char = CharInfo {
+            text: 'B',
+            x: 100.0,
+            y: 70.0,
+            width: 10.0,
+            height: 12.0,
+        };
+        assert!(should_start_new_word(&chars, &new_line_char));
+    }
+
+    #[test]
+    fn test_finalize_word_basic() {
+        let chars = vec![
+            CharInfo {
+                text: 'H',
+                x: 100.0,
+                y: 50.0,
+                width: 10.0,
+                height: 12.0,
+            },
+            CharInfo {
+                text: 'i',
+                x: 110.0,
+                y: 50.0,
+                width: 8.0,
+                height: 12.0,
+            },
+        ];
+
+        let page_height = 800;
+        let word = finalize_word(&chars, page_height, 0.0).unwrap();
+
+        assert_eq!(word.text, "Hi");
+        assert_eq!(word.left, 100);
+        assert_eq!(word.width, 18);
+        assert_eq!(word.height, 12);
+        assert_eq!(word.confidence, 95.0);
+    }
+
+    #[test]
+    fn test_finalize_word_empty() {
+        let chars: Vec<CharInfo> = vec![];
+        let word = finalize_word(&chars, 800, 0.0);
+        assert!(word.is_none());
+    }
+
+    #[test]
+    fn test_finalize_word_confidence_filter() {
+        let chars = vec![CharInfo {
+            text: 'A',
+            x: 100.0,
+            y: 50.0,
+            width: 10.0,
+            height: 12.0,
+        }];
+
+        let word = finalize_word(&chars, 800, 90.0);
+        assert!(word.is_some());
+
+        let word = finalize_word(&chars, 800, 96.0);
+        assert!(word.is_none());
+    }
+
+    #[test]
+    fn test_coordinate_conversion() {
+        let chars = vec![CharInfo {
+            text: 'A',
+            x: 100.0,
+            y: 700.0,
+            width: 10.0,
+            height: 12.0,
+        }];
+
+        let page_height = 800;
+        let word = finalize_word(&chars, page_height, 0.0).unwrap();
+
+        assert_eq!(word.top, 88);
+    }
+
+    #[test]
+    fn test_word_bounding_box() {
+        let chars = vec![
+            CharInfo {
+                text: 'A',
+                x: 100.0,
+                y: 50.0,
+                width: 10.0,
+                height: 12.0,
+            },
+            CharInfo {
+                text: 'B',
+                x: 110.0,
+                y: 51.0,
+                width: 10.0,
+                height: 13.0,
+            },
+        ];
+
+        let word = finalize_word(&chars, 800, 0.0).unwrap();
+
+        assert_eq!(word.left, 100);
+
+        assert_eq!(word.width, 20);
+
+        assert_eq!(word.height, 14);
+    }
+}