1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
//! Defines the [PdfPageTextChars] struct, a collection of all the distinct characters
//! in a bounded rectangular region of a single [PdfPage].
use crate::bindgen::{FPDF_DOCUMENT, FPDF_TEXTPAGE};
use crate::bindings::PdfiumLibraryBindings;
use crate::error::PdfiumError;
use crate::page::PdfPage;
use crate::page_index_cache::PdfPageIndexCache;
use crate::page_text::PdfPageText;
use crate::page_text_char::PdfPageTextChar;
use crate::pages::PdfPageIndex;
use crate::points::PdfPoints;
use std::ops::Range;
use std::os::raw::c_int;
pub type PdfPageTextCharIndex = usize;
pub struct PdfPageTextChars<'a> {
source_page: Option<PdfPage<'a>>,
text_page_handle: FPDF_TEXTPAGE,
start: i32,
len: i32,
bindings: &'a dyn PdfiumLibraryBindings,
}
impl<'a> PdfPageTextChars<'a> {
#[inline]
pub(crate) fn new(
text_page_handle: FPDF_TEXTPAGE,
start: i32,
len: i32,
bindings: &'a dyn PdfiumLibraryBindings,
) -> Self {
PdfPageTextChars {
source_page: None,
text_page_handle,
start,
len,
bindings,
}
}
/// Creates a new [PdfPageTextChars] instance for the given character range
/// by loading the text page for the given page index in the given document handle.
/// The newly created [PdfPageTextChars] instance will take ownership of both the page
/// and its text page, disposing of both when the [PdfPageTextChars] instance leaves scope.
pub(crate) fn new_for_page_index(
document_handle: FPDF_DOCUMENT,
page_index: c_int,
start: i32,
len: i32,
bindings: &'a dyn PdfiumLibraryBindings,
) -> Self {
let page_handle = bindings.FPDF_LoadPage(document_handle, page_index);
// Add the page to the page cache, so we can delete it later when this PdfPageTextChars
// instance moves out of scope.
PdfPageIndexCache::set_index_for_page(
document_handle,
page_handle,
page_index as PdfPageIndex,
);
let page = PdfPage::from_pdfium(document_handle, page_handle, None, None, bindings);
let text_page_handle = bindings.FPDFText_LoadPage(page.page_handle());
PdfPageTextChars {
source_page: Some(page),
text_page_handle,
start,
len,
bindings,
}
}
/// Returns the index in the containing [PdfPage] of the first character in this
/// [PdfPageTextChars] collection.
#[inline]
pub fn first_char_index(&self) -> PdfPageTextCharIndex {
self.start as PdfPageTextCharIndex
}
/// Returns the number of individual characters in this [PdfPageTextChars] collection.
#[inline]
pub fn len(&self) -> PdfPageTextCharIndex {
self.len as PdfPageTextCharIndex
}
/// Returns the index in the containing [PdfPage] of the last character in this
/// [PdfPageTextChars] collection.
#[inline]
pub fn last_char_index(&self) -> PdfPageTextCharIndex {
(self.start + self.len - 1) as PdfPageTextCharIndex
}
/// Returns the valid index range of this [PdfPageTextChars] collection.
#[inline]
pub fn as_range(&self) -> Range<PdfPageTextCharIndex> {
self.first_char_index()..self.last_char_index()
}
/// Returns `true` if this [PdfPageTextChars] collection is empty.
#[inline]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
/// Returns a single [PdfPageTextChar] from this [PdfPageTextChars] collection.
#[inline]
pub fn get(&self, index: PdfPageTextCharIndex) -> Result<PdfPageTextChar, PdfiumError> {
let index = index as i32;
if index < self.start || index >= self.start + self.len {
Err(PdfiumError::CharIndexOutOfBounds)
} else {
Ok(PdfPageTextChar::from_pdfium(
self.text_page_handle,
index,
self.bindings,
))
}
}
/// Returns the character at the given x and y positions on the containing [PdfPage], if any.
#[inline]
pub fn get_char_at_point(&self, x: PdfPoints, y: PdfPoints) -> Option<PdfPageTextChar> {
self.get_char_near_point(x, PdfPoints::ZERO, y, PdfPoints::ZERO)
}
/// Returns the character near to the given x and y positions on the containing [PdfPage],
/// if any. The returned character will be no further from the given positions than the given
/// tolerance values.
#[inline]
pub fn get_char_near_point(
&self,
x: PdfPoints,
tolerance_x: PdfPoints,
y: PdfPoints,
tolerance_y: PdfPoints,
) -> Option<PdfPageTextChar> {
PdfPageText::get_char_index_near_point(
self.text_page_handle,
x,
tolerance_x,
y,
tolerance_y,
self.bindings,
)
.ok_or(PdfiumError::CharIndexOutOfBounds)
.and_then(|index| self.get(index))
.ok()
}
/// Returns an iterator over all the characters in this [PdfPageTextChars] collection.
#[inline]
pub fn iter(&self) -> PdfPageTextCharsIterator {
PdfPageTextCharsIterator::new(self)
}
}
impl<'a> Drop for PdfPageTextChars<'a> {
/// Closes this [PdfPageTextChars] object, releasing held memory.
#[inline]
fn drop(&mut self) {
if let Some(page) = self.source_page.take() {
// This PdfPageTextChars instance had ownership over the page and text page
// to which it was bound. Release those resources now.
self.bindings.FPDFText_ClosePage(self.text_page_handle);
assert!(page.delete().is_ok());
}
}
}
/// An iterator over all the [PdfPageTextChar] objects in a [PdfPageTextChars] collection.
pub struct PdfPageTextCharsIterator<'a> {
chars: &'a PdfPageTextChars<'a>,
next_index: PdfPageTextCharIndex,
}
impl<'a> PdfPageTextCharsIterator<'a> {
#[inline]
pub(crate) fn new(chars: &'a PdfPageTextChars<'a>) -> Self {
PdfPageTextCharsIterator {
chars,
next_index: chars.first_char_index(),
}
}
}
impl<'a> Iterator for PdfPageTextCharsIterator<'a> {
type Item = PdfPageTextChar<'a>;
fn next(&mut self) -> Option<Self::Item> {
let next = self.chars.get(self.next_index);
self.next_index += 1;
next.ok()
}
}