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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
//! Parser for qpdf's `--rotate` flag specification.
//!
//! # Syntax
//!
//! ```text
//! rotate-spec ::= ['+' | '-'] angle [':' page-range]
//! angle ::= '0' | '90' | '180' | '270'
//! page-range ::= (qpdf page-range syntax, see [`PageRange`])
//! ```
//!
//! ## Sign semantics
//!
//! NOTE: This implementation intentionally diverges from one interpretation of
//! qpdf where "no sign = Assign". This implementation uses the following
//! sign semantics:
//!
//! - `+angle` or `angle` (no sign) → additive rotation (`RotateMode::Add`, positive degrees)
//! - `-angle` → additive rotation (`RotateMode::Add`, **negative** degrees)
//!
//! `RotateMode::Assign` is not used here; it is reserved for a future issue.
//! The additive sign-encoded form is the natural representation because
//! `compose_rotate` accepts signed `degrees` and `normalize_rotate` handles
//! negatives correctly (e.g. `Add(-90)` on existing=0 gives 270).
//!
//! ## Page-range
//!
//! If no `:` is present the spec applies to all pages (equivalent to an empty
//! page-range string in [`PageRange`]). A `:` must be followed by a non-empty
//! page-range string; a trailing `:` with nothing after it is an error.
//!
//! ## Multiple `--rotate` flags
//!
//! The parser returns a single [`RotateSpec`]. Callers that accept multiple
//! `--rotate` flags should collect them into a `Vec<RotateSpec>`; the specs are
//! applied in order (responsibility of the CLI layer).
use crate::page_range::PageRange;
use crate::page_rotate::{RotateMode, RotateOp};
use crate::{Error, Result};
// ---------------------------------------------------------------------------
// Public types
// ---------------------------------------------------------------------------
/// A parsed `--rotate` specification: a rotation operation plus an optional
/// page-range selector.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RotateSpec {
/// The rotation operation (mode + degrees). `mode` is always
/// [`RotateMode::Add`] in this parser; `degrees` may be negative to
/// represent counter-clockwise rotation.
pub op: RotateOp,
/// The page range to which the rotation applies. A [`PageRange`] parsed
/// from an empty string means "all pages".
pub range: PageRange,
}
impl RotateSpec {
/// Parse a single `--rotate` argument string.
///
/// # Accepted forms
///
/// | Input | `op.degrees` | `op.mode` | `range` |
/// |-------------|-------------|-----------------|-------------|
/// | `90` | `90` | `Add` | all pages |
/// | `+90` | `90` | `Add` | all pages |
/// | `-90` | `-90` | `Add` | all pages |
/// | `+90:1-3` | `90` | `Add` | pages 1-3 |
/// | `-90:5` | `-90` | `Add` | page 5 |
/// | `180:r1` | `180` | `Add` | last page |
///
/// # Errors
///
/// - Empty input.
/// - Invalid or absent angle digits.
/// - Angle not in `{0, 90, 180, 270}`.
/// - `:` present but nothing follows it.
/// - Malformed page-range syntax (forwarded from [`PageRange::parse`]).
pub fn parse(input: &str) -> Result<Self> {
if input.is_empty() {
return Err(Error::parse(
0,
"rotate spec is empty; expected [+|-]angle[:page-range]",
));
}
let mut pos = 0usize;
let bytes = input.as_bytes();
// ----------------------------------------------------------------
// 1. Optional sign.
// ----------------------------------------------------------------
let negative = match bytes.get(pos) {
Some(b'+') => {
pos += 1;
false
}
Some(b'-') => {
pos += 1;
true
}
_ => false,
};
// After a sign there must be digits.
if pos >= bytes.len() {
return Err(Error::parse(
pos,
"expected angle digits after sign; valid angles are 0, 90, 180, 270",
));
}
// ----------------------------------------------------------------
// 2. Parse angle digits (up to the ':' or end of string).
// ----------------------------------------------------------------
let angle_start = pos;
while pos < bytes.len() && bytes[pos].is_ascii_digit() {
pos += 1;
}
if pos == angle_start {
return Err(Error::parse(
angle_start,
format!(
"expected angle at position {angle_start}; valid angles are 0, 90, 180, 270"
),
));
}
let angle_str = &input[angle_start..pos];
let angle_value: u32 = angle_str.parse().map_err(|_| {
Error::parse(
angle_start,
format!("angle '{angle_str}' is too large; valid angles are 0, 90, 180, 270"),
)
})?;
// Validate angle is one of the qpdf-allowed values.
if !matches!(angle_value, 0 | 90 | 180 | 270) {
return Err(Error::parse(
angle_start,
format!("angle {angle_value} is not allowed; qpdf accepts only 0, 90, 180, or 270"),
));
}
let degrees: i32 = if negative {
// NOTE: negative sign encodes counter-clockwise (or CW depending on
// convention) additive rotation. We store it as negative i32 degrees.
-(angle_value as i32)
} else {
angle_value as i32
};
// ----------------------------------------------------------------
// 3. Optional ':' + page-range.
// ----------------------------------------------------------------
let range = if pos < bytes.len() {
// There must be a ':' here; anything else is invalid.
if bytes[pos] != b':' {
let unexpected = input[pos..].chars().next().unwrap_or('?');
return Err(Error::parse(
pos,
format!(
"unexpected character '{unexpected}' at position {pos}; expected ':' or end of input"
),
));
}
pos += 1; // consume ':'
// The page-range after ':' must not be empty.
if pos >= bytes.len() {
return Err(Error::parse(
pos,
"expected a page-range after ':'; got end of input",
));
}
let range_str = &input[pos..];
PageRange::parse(range_str).map_err(|e| {
// Re-wrap with offset adjusted to the page-range substring.
match e {
Error::Parse { offset, message } => Error::parse(pos + offset, message),
other => other,
}
})?
} else {
// No ':' → all pages.
PageRange::parse("").expect("empty string always yields all-pages sentinel")
};
Ok(RotateSpec {
op: RotateOp {
mode: RotateMode::Add,
degrees,
},
range,
})
}
}
// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------
#[cfg(test)]
mod tests {
use super::*;
use crate::page_range::{Endpoint, PageRangeEntry};
use crate::page_rotate::compose_rotate;
// -----------------------------------------------------------------------
// Helpers
// -----------------------------------------------------------------------
fn parse_ok(input: &str) -> RotateSpec {
RotateSpec::parse(input).unwrap_or_else(|e| panic!("expected Ok for {input:?}, got: {e}"))
}
fn parse_err(input: &str) -> String {
RotateSpec::parse(input)
.err()
.unwrap_or_else(|| panic!("expected Err for {input:?}"))
.to_string()
}
// -----------------------------------------------------------------------
// qpdf documented examples
// -----------------------------------------------------------------------
#[test]
fn plus_90_colon_1_3() {
// "+90:1-3" → Add(+90), pages 1-3
let spec = parse_ok("+90:1-3");
assert_eq!(spec.op.mode, RotateMode::Add);
assert_eq!(spec.op.degrees, 90);
let pages = spec.range.resolve(10).unwrap();
assert_eq!(pages, vec![1, 2, 3]);
}
#[test]
fn minus_90_colon_5() {
// "-90:5" → Add(-90), page 5
let spec = parse_ok("-90:5");
assert_eq!(spec.op.mode, RotateMode::Add);
assert_eq!(spec.op.degrees, -90);
let pages = spec.range.resolve(10).unwrap();
assert_eq!(pages, vec![5]);
}
#[test]
fn bare_180_colon_r1() {
// "180:r1" → Add(+180), last page
let spec = parse_ok("180:r1");
assert_eq!(spec.op.mode, RotateMode::Add);
assert_eq!(spec.op.degrees, 180);
let entries = spec.range.entries.as_ref().unwrap();
assert_eq!(entries.len(), 1);
assert_eq!(entries[0].start, Endpoint::FromEnd(1));
}
#[test]
fn bare_90_no_range_means_all_pages() {
// "90" (no colon) → Add(+90), all pages
let spec = parse_ok("90");
assert_eq!(spec.op.mode, RotateMode::Add);
assert_eq!(spec.op.degrees, 90);
assert!(spec.range.entries.is_none(), "expected all-pages sentinel");
let pages = spec.range.resolve(3).unwrap();
assert_eq!(pages, vec![1, 2, 3]);
}
#[test]
fn zero_rotation_valid() {
// "0:1" is a no-op rotation on page 1 — syntactically valid
let spec = parse_ok("0:1");
assert_eq!(spec.op.degrees, 0);
let pages = spec.range.resolve(5).unwrap();
assert_eq!(pages, vec![1]);
}
#[test]
fn minus_180_colon_z() {
// "-180:z" → Add(-180), last page
let spec = parse_ok("-180:z");
assert_eq!(spec.op.degrees, -180);
let entries = spec.range.entries.as_ref().unwrap();
assert_eq!(entries[0].start, Endpoint::Z);
}
#[test]
fn plus_270_no_range() {
// "+270" → Add(+270), all pages
let spec = parse_ok("+270");
assert_eq!(spec.op.degrees, 270);
assert!(spec.range.entries.is_none());
}
// -----------------------------------------------------------------------
// Sign / no-sign variants of the same angle
// -----------------------------------------------------------------------
#[test]
fn positive_sign_explicit() {
let spec = parse_ok("+90");
assert_eq!(spec.op.degrees, 90);
assert_eq!(spec.op.mode, RotateMode::Add);
}
#[test]
fn negative_sign() {
let spec = parse_ok("-90");
assert_eq!(spec.op.degrees, -90);
assert_eq!(spec.op.mode, RotateMode::Add);
}
#[test]
fn no_sign_treated_as_add() {
// NOTE: no-sign is Add (not Assign) per flpdf-9hc.8.5 specification.
let spec = parse_ok("270");
assert_eq!(spec.op.mode, RotateMode::Add);
assert_eq!(spec.op.degrees, 270);
}
// -----------------------------------------------------------------------
// Compose sanity: negative degrees produce correct final values
// -----------------------------------------------------------------------
#[test]
fn compose_negative_90_from_zero_gives_270() {
// existing=0, op=Add(-90) → 270
let spec = parse_ok("-90");
assert_eq!(compose_rotate(0, &spec.op), 270);
}
#[test]
fn compose_plus_90_from_270_wraps_to_zero() {
let spec = parse_ok("+90");
assert_eq!(compose_rotate(270, &spec.op), 0);
}
// -----------------------------------------------------------------------
// Invalid angle values
// -----------------------------------------------------------------------
#[test]
fn angle_45_is_invalid() {
let msg = parse_err("45:1");
assert!(
msg.contains("45") && (msg.contains("not allowed") || msg.contains("0, 90, 180, 270")),
"got: {msg}"
);
}
#[test]
fn angle_91_is_invalid() {
let msg = parse_err("91:1");
assert!(
msg.contains("91") && (msg.contains("not allowed") || msg.contains("0, 90, 180, 270")),
"got: {msg}"
);
}
#[test]
fn angle_360_is_invalid() {
let msg = parse_err("360:1");
assert!(
msg.contains("360") && (msg.contains("not allowed") || msg.contains("0, 90, 180, 270")),
"got: {msg}"
);
}
#[test]
fn negative_45_is_invalid() {
let msg = parse_err("-45:1");
assert!(
msg.contains("45") && (msg.contains("not allowed") || msg.contains("0, 90, 180, 270")),
"got: {msg}"
);
}
// -----------------------------------------------------------------------
// Structural errors
// -----------------------------------------------------------------------
#[test]
fn empty_input_is_invalid() {
let msg = parse_err("");
assert!(!msg.is_empty(), "got: {msg}");
}
#[test]
fn bare_sign_only_is_invalid() {
let msg = parse_err("+");
assert!(
msg.contains("expected angle") || msg.contains("digits"),
"got: {msg}"
);
}
#[test]
fn bare_minus_only_is_invalid() {
let msg = parse_err("-");
assert!(
msg.contains("expected angle") || msg.contains("digits"),
"got: {msg}"
);
}
#[test]
fn non_numeric_is_invalid() {
let msg = parse_err("abc");
assert!(
msg.contains("expected angle") || msg.contains("angle at position"),
"got: {msg}"
);
}
#[test]
fn trailing_colon_no_range_is_invalid() {
// "90:" — colon present but nothing follows
let msg = parse_err("90:");
assert!(
msg.contains("expected a page-range after ':'") || msg.contains("end of input"),
"got: {msg}"
);
}
#[test]
fn colon_without_angle_is_invalid() {
// ":1-3" — no angle before colon
let msg = parse_err(":1-3");
assert!(!msg.is_empty(), "got: {msg}");
}
#[test]
fn double_sign_is_invalid() {
// "+-90:1" — two signs
let msg = parse_err("+-90:1");
// After consuming '+', the next char is '-' which is not a digit;
// angle parsing fails.
assert!(!msg.is_empty(), "got: {msg}");
}
#[test]
fn unexpected_char_after_angle_is_invalid() {
// "90x" — 'x' is unexpected
let msg = parse_err("90x");
assert!(
msg.contains("unexpected character") || msg.contains("'x'"),
"got: {msg}"
);
}
// -----------------------------------------------------------------------
// Multiple-spec order preservation (Vec accumulation pattern)
// -----------------------------------------------------------------------
#[test]
fn multiple_specs_parsed_in_order() {
// Callers collect Vec<RotateSpec> in CLI order.
let specs: Vec<RotateSpec> = ["+90:1-3", "-90:5", "180:r1"]
.iter()
.map(|s| RotateSpec::parse(s).unwrap())
.collect();
assert_eq!(specs.len(), 3);
assert_eq!(specs[0].op.degrees, 90);
assert_eq!(specs[1].op.degrees, -90);
assert_eq!(specs[2].op.degrees, 180);
}
// -----------------------------------------------------------------------
// Page-range reuse: verify PageRange entries are forwarded correctly
// -----------------------------------------------------------------------
#[test]
fn range_1_3_has_correct_entries() {
let spec = parse_ok("+90:1-3");
let entries: &[PageRangeEntry] = spec.range.entries.as_ref().unwrap();
assert_eq!(entries.len(), 1);
assert_eq!(entries[0].start, Endpoint::Num(1));
assert_eq!(entries[0].end, Some(Endpoint::Num(3)));
}
#[test]
fn range_r1_has_from_end_entry() {
let spec = parse_ok("180:r1");
let entries = spec.range.entries.as_ref().unwrap();
assert_eq!(entries[0].start, Endpoint::FromEnd(1));
assert!(entries[0].end.is_none());
}
#[test]
fn malformed_page_range_produces_error() {
// "90:0" — page 0 is invalid in PageRange
let msg = parse_err("90:0");
assert!(
msg.contains("0 is invalid") || msg.contains("page number 0"),
"got: {msg}"
);
}
}