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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
//! High-level page-document helper, mirroring qpdf's `QPDFPageDocumentHelper`.
//!
//! [`PageDocumentHelper`] wraps a `&mut Pdf<R>` and exposes an ergonomic API for
//! traversing and mutating a document's page list without requiring callers to
//! interact with raw [`ObjectRef`]s or the underlying page-tree internals.
//!
//! # Design
//!
//! The helper is a thin borrowing wrapper — it holds **no copied state**. Every
//! method re-derives the page list from the live document via the existing
//! infrastructure:
//!
//! - [`pages`] / [`iter`] / [`get`] delegate to [`crate::pages::page_refs`].
//! - [`rotate`] builds a [`RotateOp`] and calls
//! [`crate::page_rotate::apply_rotate_to_pages`].
//! - [`insert`] / [`remove`] splice the ordered page list and call
//! [`crate::page_tree_rebuild::rebuild_page_tree`].
//!
//! # Examples
//!
//! ## Traverse pages
//!
//! ```no_run
//! use std::fs::File;
//! use std::io::BufReader;
//! use flpdf::{Pdf, PageDocumentHelper};
//!
//! let mut pdf = Pdf::open(BufReader::new(File::open("input.pdf")?))?;
//! let mut helper = PageDocumentHelper::new(&mut pdf);
//! let all_pages = helper.pages()?;
//! println!("{} pages", all_pages.len());
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! ## Rotate a range of pages
//!
//! ```no_run
//! use std::fs::File;
//! use std::io::BufReader;
//! use flpdf::{Pdf, PageDocumentHelper, PageRange, RotateMode, write_pdf};
//!
//! let mut pdf = Pdf::open(BufReader::new(File::open("input.pdf")?))?;
//! let mut helper = PageDocumentHelper::new(&mut pdf);
//!
//! // Rotate pages 1 and 3 by +90° (additive).
//! let range = PageRange::parse("1,3")?;
//! helper.rotate(&range, 90, RotateMode::Add)?;
//! drop(helper);
//!
//! let mut out = File::create("output.pdf")?;
//! write_pdf(&mut pdf, &mut out)?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! ## Remove a page
//!
//! ```no_run
//! use std::fs::File;
//! use std::io::BufReader;
//! use flpdf::{Pdf, PageDocumentHelper, write_pdf};
//!
//! let mut pdf = Pdf::open(BufReader::new(File::open("input.pdf")?))?;
//! let mut helper = PageDocumentHelper::new(&mut pdf);
//!
//! // Remove the second page (0-based index 1).
//! helper.remove(1)?;
//! drop(helper);
//!
//! let mut out = File::create("output.pdf")?;
//! write_pdf(&mut pdf, &mut out)?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! ## Insert a page
//!
//! ```no_run
//! use std::fs::File;
//! use std::io::BufReader;
//! use flpdf::{Pdf, PageDocumentHelper, ObjectRef, write_pdf};
//!
//! // Assume `page_ref` is a valid /Page ObjectRef already in the document.
//! let mut pdf = Pdf::open(BufReader::new(File::open("input.pdf")?))?;
//! let page_ref: ObjectRef = {
//! let mut h = PageDocumentHelper::new(&mut pdf);
//! *h.pages()?.first().expect("at least one page")
//! };
//!
//! let mut helper = PageDocumentHelper::new(&mut pdf);
//! // Insert the page as a duplicate at index 0 (prepend).
//! helper.insert(0, page_ref)?;
//! drop(helper);
//!
//! let mut out = File::create("output.pdf")?;
//! write_pdf(&mut pdf, &mut out)?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
use crate;
use crate;
use cratepage_refs;
use crate::;
use ;
/// High-level page-document helper.
///
/// Construct with [`PageDocumentHelper::new`], then use the provided methods to
/// traverse or mutate the document's page list. All operations are delegated to
/// the underlying `Pdf<R>` infrastructure; no page-tree state is cached inside
/// this struct.