flpdf 0.1.5

A pure-Rust PDF toolkit modeled on qpdf — read, rewrite, linearize, and inspect PDFs.
Documentation
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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
//! qpdf `QPDFPageLabelDocumentHelper`-equivalent page-label access.
//!
//! [`PageLabelDocumentHelper`] reads, renders (ISO 32000-1 §12.4.2), and edits
//! the catalog `/PageLabels` number tree. [`LabelRange`] models one label range
//! (`/S` style, `/P` prefix, `/St` start). The number-tree walking/building is
//! delegated to [`crate::name_number_tree`].

use crate::name_number_tree::DEFAULT_MAX_TREE_DEPTH;
use crate::{Dictionary, Object, ObjectRef, Pdf, Result};
use std::io::{Read, Seek};

/// Page-label numbering style (ISO 32000-1 §12.4.2 `/S`).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LabelStyle {
    /// `/D` — decimal arabic.
    Decimal,
    /// `/R` — uppercase roman.
    RomanUpper,
    /// `/r` — lowercase roman.
    RomanLower,
    /// `/A` — uppercase letters (A, B, …, Z, AA, …).
    AlphaUpper,
    /// `/a` — lowercase letters.
    AlphaLower,
    /// No `/S` — labels have no numeric portion (prefix only).
    None,
}

impl LabelStyle {
    /// Map a `/S` name's bytes to a style; unrecognised/absent → [`LabelStyle::None`].
    pub fn from_name(name: &[u8]) -> Self {
        match name {
            b"D" => LabelStyle::Decimal,
            b"R" => LabelStyle::RomanUpper,
            b"r" => LabelStyle::RomanLower,
            b"A" => LabelStyle::AlphaUpper,
            b"a" => LabelStyle::AlphaLower,
            _ => LabelStyle::None,
        }
    }

    /// The `/S` name string, or `None` for [`LabelStyle::None`].
    pub fn to_name(self) -> Option<&'static str> {
        match self {
            LabelStyle::Decimal => Some("D"),
            LabelStyle::RomanUpper => Some("R"),
            LabelStyle::RomanLower => Some("r"),
            LabelStyle::AlphaUpper => Some("A"),
            LabelStyle::AlphaLower => Some("a"),
            LabelStyle::None => None,
        }
    }
}

/// One `/PageLabels` range: numbering style, prefix, and starting value.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LabelRange {
    /// Numbering style (`/S`).
    pub style: LabelStyle,
    /// Label prefix (`/P`), decoded; empty when absent.
    pub prefix: String,
    /// First value in the range (`/St`); defaults to 1.
    pub start: i64,
}

impl LabelRange {
    /// Parse a label dictionary (`/S`, `/P`, `/St`). Unrecognised/absent `/S`
    /// → [`LabelStyle::None`]; absent `/St` → 1; `/P` decoded via
    /// `crate::json_inspect::decode_pdf_text_string` with lossy fallback.
    ///
    /// This does **not** resolve indirect `/S`/`/P`/`/St` values (it has no
    /// `Pdf` handle): an indirect inner value falls through to its default.
    /// Callers reading a live document should go through
    /// [`PageLabelDocumentHelper::ranges`] (which uses the resolving
    /// `LabelRange::from_dict_resolved`); this plain form is for the
    /// non-resolving JSON-inspection path.
    pub fn from_dict(dict: &Dictionary) -> Self {
        let style = match dict.get("S") {
            Some(Object::Name(bytes)) => LabelStyle::from_name(bytes),
            _ => LabelStyle::None,
        };
        let prefix = match dict.get("P") {
            Some(Object::String(bytes)) => crate::json_inspect::decode_pdf_text_string(bytes)
                .unwrap_or_else(|| String::from_utf8_lossy(bytes).into_owned()),
            _ => String::new(),
        };
        let start = match dict.get("St") {
            Some(Object::Integer(n)) => *n,
            _ => 1,
        };
        LabelRange {
            style,
            prefix,
            start,
        }
    }

    /// Like [`LabelRange::from_dict`] but resolves indirect `/S`, `/P`, `/St`
    /// values via `pdf` before interpreting them (ISO 32000-1 allows any value
    /// to be an indirect reference). Used by the document reader; the plain
    /// [`LabelRange::from_dict`] is retained for callers without a `Pdf` handle.
    pub(crate) fn from_dict_resolved<R: Read + Seek>(
        pdf: &mut Pdf<R>,
        dict: &Dictionary,
    ) -> Result<Self> {
        let style = match resolve_entry(pdf, dict.get("S"))? {
            Some(Object::Name(bytes)) => LabelStyle::from_name(&bytes),
            _ => LabelStyle::None,
        };
        let prefix = match resolve_entry(pdf, dict.get("P"))? {
            Some(Object::String(bytes)) => crate::json_inspect::decode_pdf_text_string(&bytes)
                .unwrap_or_else(|| String::from_utf8_lossy(&bytes).into_owned()),
            _ => String::new(),
        };
        let start = match resolve_entry(pdf, dict.get("St"))? {
            Some(Object::Integer(n)) => n,
            _ => 1,
        };
        Ok(LabelRange {
            style,
            prefix,
            start,
        })
    }

    /// Build a label dictionary mirroring qpdf `pageLabelDict`: `/S` name when
    /// the style is not [`LabelStyle::None`]; `/P` only when non-empty; `/St`
    /// only when `!= 1`.
    pub fn to_dict(&self) -> Dictionary {
        let mut d = Dictionary::new();
        if let Some(name) = self.style.to_name() {
            d.insert("S", Object::Name(name.into()));
        }
        if !self.prefix.is_empty() {
            d.insert("P", Object::String(self.prefix.clone().into_bytes()));
        }
        if self.start != 1 {
            d.insert("St", Object::Integer(self.start));
        }
        d
    }

    /// Render the display label for `value` (§12.4.2): `prefix` followed by the
    /// style-formatted number. [`LabelStyle::None`] and non-positive numeric
    /// values contribute no numeric portion.
    pub fn format(&self, value: i64) -> String {
        let mut s = self.prefix.clone();
        match self.style {
            LabelStyle::Decimal => s.push_str(&value.to_string()),
            LabelStyle::RomanUpper => s.push_str(&to_roman(value, true)),
            LabelStyle::RomanLower => s.push_str(&to_roman(value, false)),
            LabelStyle::AlphaUpper => s.push_str(&to_alpha(value, true)),
            LabelStyle::AlphaLower => s.push_str(&to_alpha(value, false)),
            LabelStyle::None => {}
        }
        s
    }
}

/// Resolve a dictionary entry that may be an indirect reference, returning the
/// owned target object (or the value verbatim if direct, `None` if absent).
fn resolve_entry<R: Read + Seek>(
    pdf: &mut Pdf<R>,
    value: Option<&Object>,
) -> Result<Option<Object>> {
    match value {
        Some(Object::Reference(r)) => Ok(Some(pdf.resolve_borrowed(*r)?.clone())),
        Some(o) => Ok(Some(o.clone())),
        None => Ok(None),
    }
}

/// Upper bound on the numeric value [`to_roman`]/[`to_alpha`] will render.
///
/// Values above this produce an empty numeric portion — a defensive cap against
/// CPU/memory exhaustion from a hostile `/St`: without it the roman subtraction
/// loop and the alphabetic repeat both scale with `value`, so an `i64::MAX`
/// `/St` would spin/allocate unboundedly. 100 000 is far beyond any real page
/// label yet keeps the rendered string short.
const MAX_RENDERABLE_LABEL_VALUE: i64 = 100_000;

/// Format `value` as a roman numeral (`upper` → uppercase). Empty for
/// `value <= 0` or `value > MAX_RENDERABLE_LABEL_VALUE`.
fn to_roman(value: i64, upper: bool) -> String {
    if value <= 0 || value > MAX_RENDERABLE_LABEL_VALUE {
        return String::new();
    }
    const TABLE: &[(i64, &str, &str)] = &[
        (1000, "M", "m"),
        (900, "CM", "cm"),
        (500, "D", "d"),
        (400, "CD", "cd"),
        (100, "C", "c"),
        (90, "XC", "xc"),
        (50, "L", "l"),
        (40, "XL", "xl"),
        (10, "X", "x"),
        (9, "IX", "ix"),
        (5, "V", "v"),
        (4, "IV", "iv"),
        (1, "I", "i"),
    ];
    let mut v = value;
    let mut out = String::new();
    for &(n, up, lo) in TABLE {
        while v >= n {
            out.push_str(if upper { up } else { lo });
            v -= n;
        }
    }
    out
}

/// Format `value` as repeating letters (§12.4.2): 1→A … 26→Z, 27→AA, 53→AAA.
/// Empty for `value <= 0` or `value > MAX_RENDERABLE_LABEL_VALUE`.
fn to_alpha(value: i64, upper: bool) -> String {
    if value <= 0 || value > MAX_RENDERABLE_LABEL_VALUE {
        return String::new();
    }
    let v = value - 1;
    let letter = (v % 26) as u8;
    let count = (v / 26) + 1;
    let ch = if upper { b'A' + letter } else { b'a' + letter } as char;
    (0..count).map(|_| ch).collect()
}

/// High-level helper for a document's `/PageLabels` number tree.
///
/// Construct with [`PageLabelDocumentHelper::new`] or [`Pdf::page_labels`]. The
/// helper caches nothing; methods re-read the live document.
pub struct PageLabelDocumentHelper<'a, R: Read + Seek> {
    pdf: &'a mut Pdf<R>,
}

impl<'a, R: Read + Seek> PageLabelDocumentHelper<'a, R> {
    /// Create a new helper borrowing `pdf` mutably.
    pub fn new(pdf: &'a mut Pdf<R>) -> Self {
        Self { pdf }
    }

    /// Resolve the catalog's `/PageLabels` value (Reference or inline dict), or
    /// `None` when absent.
    fn pagelabels_root(&mut self) -> Result<Option<Object>> {
        let Some(catalog_ref) = self.pdf.root_ref() else {
            return Ok(None);
        };
        let Some(catalog) = self.pdf.resolve_borrowed(catalog_ref)?.as_dict() else {
            return Ok(None);
        };
        Ok(catalog.get("PageLabels").cloned())
    }

    /// Whether the document carries a `/PageLabels` tree with at least the root.
    pub fn has_page_labels(&mut self) -> Result<bool> {
        Ok(self.pagelabels_root()?.is_some())
    }

    /// All label ranges as `(first_page_index, LabelRange)`, ascending by index.
    /// Empty when `/PageLabels` is absent.
    pub fn ranges(&mut self) -> Result<Vec<(i64, LabelRange)>> {
        let Some(root) = self.pagelabels_root()? else {
            return Ok(vec![]);
        };
        crate::name_number_tree::read_number_tree(
            self.pdf,
            root,
            |pdf, v| {
                let dict = match v {
                    Object::Dictionary(d) => Some(d),
                    Object::Reference(r) => pdf.resolve_borrowed(r)?.as_dict().cloned(),
                    _ => None,
                };
                match dict {
                    Some(d) => Ok(Some(LabelRange::from_dict_resolved(pdf, &d)?)),
                    None => Ok(None),
                }
            },
            DEFAULT_MAX_TREE_DEPTH,
        )
    }

    /// The effective label for a 0-based page index (qpdf `getLabelForPage`):
    /// the range whose first index is the largest `<= page_idx`, with `start`
    /// offset to that page. `None` when no range applies (no `/PageLabels`, or
    /// the page precedes the first range).
    pub fn label_for_page(&mut self, page_idx: i64) -> Result<Option<LabelRange>> {
        let ranges = self.ranges()?;
        // ranges is ascending; take the last with first_index <= page_idx.
        let mut chosen: Option<&(i64, LabelRange)> = None;
        for entry in &ranges {
            if entry.0 <= page_idx {
                chosen = Some(entry);
            } else {
                break;
            }
        }
        Ok(chosen.map(|(first, r)| {
            // Saturating arithmetic: `first <= page_idx` so the offset is
            // non-negative, but a hostile `/St` near i64::MAX could otherwise
            // overflow the start (panic in debug, wrap in release).
            let offset = page_idx.saturating_sub(*first);
            LabelRange {
                style: r.style,
                prefix: r.prefix.clone(),
                start: r.start.saturating_add(offset),
            }
        }))
    }

    /// The rendered display string for a 0-based page index. Falls back to
    /// 1-based decimal (`(page_idx + 1)`) when no range applies — matching the
    /// "default 1-based numeric labels" requirement.
    pub fn label_string_for_page(&mut self, page_idx: i64) -> Result<String> {
        match self.label_for_page(page_idx)? {
            Some(effective) => Ok(effective.format(effective.start)),
            None => Ok((page_idx + 1).to_string()),
        }
    }

    /// qpdf `getLabelsForPageRange` port: collect the label entries needed to
    /// reproduce the labels of pages `start_idx..=end_idx` if they were
    /// renumbered to begin at `new_start_idx`. Returns `(new_index, LabelRange)`
    /// pairs (the first entry plus every explicit entry in the source range),
    /// renumbered by `new_start_idx - start_idx`. Read-only; intended for
    /// page-extraction wiring (.14.4).
    ///
    /// Unlike qpdf's accumulating signature, this is a single self-contained
    /// call: the leading entry is always emitted (the result vector starts
    /// empty, so there is no prior entry to be redundant against). A later
    /// accumulating consumer can dedupe across calls.
    ///
    /// Re-reads the `/PageLabels` tree once per explicit page in the span (the
    /// helper caches nothing by design); acceptable for typical small label trees.
    pub fn labels_for_page_range(
        &mut self,
        start_idx: i64,
        end_idx: i64,
        new_start_idx: i64,
    ) -> Result<Vec<(i64, LabelRange)>> {
        let ranges = self.ranges()?;
        // Set of explicit source indices, for hasIndex().
        let explicit: std::collections::BTreeSet<i64> = ranges.iter().map(|(i, _)| *i).collect();

        // First page label (or fabricated default decimal start = 1 + new_start).
        let first_label = match self.label_for_page(start_idx)? {
            Some(r) => r,
            None => LabelRange {
                style: LabelStyle::Decimal,
                prefix: String::new(),
                start: new_start_idx.saturating_add(1),
            },
        };

        let mut out = vec![(new_start_idx, first_label)];
        let idx_offset = new_start_idx.saturating_sub(start_idx);
        // Iterate only the explicit indices within the span (the rest sequence
        // implicitly from the prior entry), so the cost is O(log N + M) in the
        // number of ranges rather than O(end_idx - start_idx) over the page span.
        for &i in explicit.range((start_idx + 1)..=end_idx) {
            if let Some(lab) = self.label_for_page(i)? {
                out.push((i.saturating_add(idx_offset), lab));
            }
        }
        Ok(out)
    }

    /// Collect the raw `(index, value Object)` entries of the `/PageLabels` tree
    /// verbatim (values un-decoded), for rebuild.
    fn raw_entries(&mut self) -> Result<Vec<(i64, Object)>> {
        let Some(root) = self.pagelabels_root()? else {
            return Ok(vec![]);
        };
        crate::name_number_tree::read_number_tree(
            self.pdf,
            root,
            |_, v| Ok(Some(v)),
            DEFAULT_MAX_TREE_DEPTH,
        )
    }

    /// Insert or replace the label range whose first page index is
    /// `first_page_idx`. Rebuilds the `/Nums` tree and points the catalog
    /// `/PageLabels` at the new (indirect) root.
    pub fn set_range(&mut self, first_page_idx: i64, range: LabelRange) -> Result<()> {
        let mut entries = self.raw_entries()?;
        let value = Object::Dictionary(range.to_dict());
        match entries.iter_mut().find(|(k, _)| *k == first_page_idx) {
            Some(e) => e.1 = value,
            None => {
                entries.push((first_page_idx, value));
                entries.sort_by_key(|(k, _)| *k);
            }
        }
        self.rebuild(entries)
    }

    /// Remove the label range whose first page index is `first_page_idx`.
    /// Returns `false` if no such range exists. When the last range is removed,
    /// `/PageLabels` is dropped from the catalog.
    pub fn remove_range(&mut self, first_page_idx: i64) -> Result<bool> {
        let mut entries = self.raw_entries()?;
        let before = entries.len();
        entries.retain(|(k, _)| *k != first_page_idx);
        if entries.len() == before {
            return Ok(false);
        }
        self.rebuild(entries)?;
        Ok(true)
    }

    /// Rebuild `/PageLabels` from sorted entries and patch the catalog. Empty
    /// entries → remove `/PageLabels`.
    fn rebuild(&mut self, entries: Vec<(i64, Object)>) -> Result<()> {
        let Some(catalog_ref) = self.pdf.root_ref() else {
            return Ok(());
        };
        let Some(mut catalog) = self.pdf.resolve_borrowed(catalog_ref)?.as_dict().cloned() else {
            return Ok(());
        };

        if entries.is_empty() {
            catalog.remove("PageLabels");
            self.pdf
                .set_object(catalog_ref, Object::Dictionary(catalog));
            return Ok(());
        }

        let mut next_num: u32 = self
            .pdf
            .object_refs()
            .iter()
            .map(|r| r.number)
            .max()
            .unwrap_or(0);
        let mut alloc = move || -> ObjectRef {
            next_num += 1;
            ObjectRef::new(next_num, 0)
        };

        let (root_ref, nodes) = crate::name_number_tree::build_number_tree(&entries, &mut alloc);
        for (r, node) in nodes {
            self.pdf.set_object(r, node);
        }
        catalog.insert("PageLabels", Object::Reference(root_ref));
        self.pdf
            .set_object(catalog_ref, Object::Dictionary(catalog));
        Ok(())
    }
}

/// Extension constructor mirroring [`Pdf::acroform`].
impl<R: Read + Seek> Pdf<R> {
    /// Return a high-level page-label helper for this document.
    pub fn page_labels(&mut self) -> PageLabelDocumentHelper<'_, R> {
        PageLabelDocumentHelper::new(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;

    fn pdf_with_pagelabels(nums: Vec<Object>) -> Pdf<Cursor<Vec<u8>>> {
        // Minimal one-page PDF; then attach an inline /PageLabels leaf via set_object.
        let mut bytes = Vec::new();
        bytes.extend_from_slice(b"%PDF-1.7\n");
        let off1 = bytes.len() as u64;
        bytes.extend_from_slice(b"1 0 obj\n<< /Type /Catalog /Pages 2 0 R >>\nendobj\n");
        let off2 = bytes.len() as u64;
        bytes.extend_from_slice(b"2 0 obj\n<< /Type /Pages /Kids [3 0 R] /Count 1 >>\nendobj\n");
        let off3 = bytes.len() as u64;
        bytes.extend_from_slice(
            b"3 0 obj\n<< /Type /Page /Parent 2 0 R /MediaBox [0 0 612 792] >>\nendobj\n",
        );
        let xref = bytes.len() as u64;
        bytes.extend_from_slice(
            format!(
                "xref\n0 4\n0000000000 65535 f \n{off1:010} 00000 n \n{off2:010} 00000 n \n{off3:010} 00000 n \ntrailer\n<< /Size 4 /Root 1 0 R >>\nstartxref\n{xref}\n%%EOF\n"
            )
            .as_bytes(),
        );
        let mut pdf = Pdf::open(Cursor::new(bytes)).expect("open");
        // /PageLabels root leaf at obj 10, catalog points to it.
        let pl_ref = ObjectRef::new(10, 0);
        let mut leaf = Dictionary::new();
        leaf.insert("Nums", Object::Array(nums));
        pdf.set_object(pl_ref, Object::Dictionary(leaf));
        let catalog_ref = pdf.root_ref().unwrap();
        let mut catalog = pdf
            .resolve_borrowed(catalog_ref)
            .unwrap()
            .as_dict()
            .unwrap()
            .clone();
        catalog.insert("PageLabels", Object::Reference(pl_ref));
        pdf.set_object(catalog_ref, Object::Dictionary(catalog));
        pdf
    }

    fn label_dict(style: &str, st: Option<i64>, prefix: Option<&str>) -> Object {
        let mut d = Dictionary::new();
        d.insert("S", Object::Name(style.into()));
        if let Some(s) = st {
            d.insert("St", Object::Integer(s));
        }
        if let Some(p) = prefix {
            d.insert("P", Object::String(p.as_bytes().to_vec()));
        }
        Object::Dictionary(d)
    }

    #[test]
    fn label_string_multi_range_matches_spec() {
        // /Nums [0 <</S /r>> 3 <</S /D /St 1>> 6 <</S /D /P "A-" /St 1>>]
        let mut pdf = pdf_with_pagelabels(vec![
            Object::Integer(0),
            label_dict("r", None, None),
            Object::Integer(3),
            label_dict("D", Some(1), None),
            Object::Integer(6),
            label_dict("D", Some(1), Some("A-")),
        ]);
        let mut h = pdf.page_labels();
        assert!(h.has_page_labels().unwrap());
        assert_eq!(h.label_string_for_page(0).unwrap(), "i");
        assert_eq!(h.label_string_for_page(1).unwrap(), "ii");
        assert_eq!(h.label_string_for_page(2).unwrap(), "iii");
        assert_eq!(h.label_string_for_page(3).unwrap(), "1");
        assert_eq!(h.label_string_for_page(5).unwrap(), "3");
        assert_eq!(h.label_string_for_page(6).unwrap(), "A-1");
        assert_eq!(h.label_string_for_page(8).unwrap(), "A-3");
    }

    #[test]
    fn label_for_page_offsets_start() {
        let mut pdf =
            pdf_with_pagelabels(vec![Object::Integer(0), label_dict("D", Some(10), None)]);
        let mut h = pdf.page_labels();
        let lab = h.label_for_page(2).unwrap().expect("range applies");
        assert_eq!(lab.start, 12, "/St 10 + offset 2");
        assert_eq!(lab.style, LabelStyle::Decimal);
    }

    #[test]
    fn no_pagelabels_defaults_to_decimal() {
        let mut pdf = pdf_with_pagelabels(vec![]); // empty /Nums -> ranges empty
        let mut h = pdf.page_labels();
        assert_eq!(h.label_string_for_page(0).unwrap(), "1");
        assert_eq!(h.label_string_for_page(4).unwrap(), "5");
        assert!(h.label_for_page(0).unwrap().is_none());
    }

    #[test]
    fn page_before_first_range_defaults_to_decimal() {
        let mut pdf = pdf_with_pagelabels(vec![Object::Integer(3), label_dict("R", Some(1), None)]);
        let mut h = pdf.page_labels();
        assert_eq!(
            h.label_string_for_page(0).unwrap(),
            "1",
            "page before first range"
        );
        assert_eq!(h.label_string_for_page(3).unwrap(), "I");
    }

    #[test]
    fn labels_for_page_range_renumbers_and_copies_explicit() {
        // ranges at 0 (roman) and 5 (decimal). Extract pages 3..=6 to new_start 0.
        let mut pdf = pdf_with_pagelabels(vec![
            Object::Integer(0),
            label_dict("r", Some(1), None),
            Object::Integer(5),
            label_dict("D", Some(1), None),
        ]);
        let mut h = pdf.page_labels();
        let out = h.labels_for_page_range(3, 6, 0).unwrap();
        // First page (idx 3) is in the roman range with offset 3 -> start 4.
        assert_eq!(out[0].0, 0);
        assert_eq!(out[0].1.style, LabelStyle::RomanLower);
        assert_eq!(out[0].1.start, 4);
        // Page 5 has an explicit entry -> copied, renumbered to new index 2.
        assert!(out
            .iter()
            .any(|(idx, r)| *idx == 2 && r.style == LabelStyle::Decimal));
    }

    #[test]
    fn set_range_inserts_and_round_trips() {
        let mut pdf = pdf_with_pagelabels(vec![]); // start with empty /PageLabels root
        {
            let mut h = pdf.page_labels();
            h.set_range(
                0,
                LabelRange {
                    style: LabelStyle::RomanLower,
                    prefix: String::new(),
                    start: 1,
                },
            )
            .unwrap();
            h.set_range(
                3,
                LabelRange {
                    style: LabelStyle::Decimal,
                    prefix: "A-".into(),
                    start: 1,
                },
            )
            .unwrap();
        }
        let mut h = pdf.page_labels();
        let ranges = h.ranges().unwrap();
        assert_eq!(ranges.len(), 2);
        assert_eq!(ranges[0].0, 0);
        assert_eq!(ranges[0].1.style, LabelStyle::RomanLower);
        assert_eq!(ranges[1].0, 3);
        assert_eq!(ranges[1].1.prefix, "A-");
        assert_eq!(h.label_string_for_page(4).unwrap(), "A-2");
    }

    #[test]
    fn set_range_replaces_existing_index() {
        let mut pdf = pdf_with_pagelabels(vec![Object::Integer(0), label_dict("D", Some(1), None)]);
        {
            let mut h = pdf.page_labels();
            h.set_range(
                0,
                LabelRange {
                    style: LabelStyle::RomanUpper,
                    prefix: String::new(),
                    start: 1,
                },
            )
            .unwrap();
        }
        let mut h = pdf.page_labels();
        let ranges = h.ranges().unwrap();
        assert_eq!(ranges.len(), 1);
        assert_eq!(ranges[0].1.style, LabelStyle::RomanUpper);
    }

    #[test]
    fn remove_range_drops_entry_and_pagelabels_when_empty() {
        let mut pdf = pdf_with_pagelabels(vec![Object::Integer(0), label_dict("D", Some(1), None)]);
        {
            let mut h = pdf.page_labels();
            assert!(h.remove_range(0).unwrap());
            assert!(!h.remove_range(99).unwrap(), "absent index => false");
        }
        let mut h = pdf.page_labels();
        assert!(
            !h.has_page_labels().unwrap(),
            "/PageLabels dropped when empty"
        );
        assert_eq!(
            h.label_string_for_page(0).unwrap(),
            "1",
            "defaults after removal"
        );
    }

    #[test]
    fn roman_matches_spec() {
        assert_eq!(to_roman(1, true), "I");
        assert_eq!(to_roman(4, true), "IV");
        assert_eq!(to_roman(9, false), "ix");
        assert_eq!(to_roman(40, true), "XL");
        assert_eq!(to_roman(90, false), "xc");
        assert_eq!(to_roman(400, true), "CD");
        assert_eq!(to_roman(900, true), "CM");
        assert_eq!(to_roman(3888, true), "MMMDCCCLXXXVIII");
        assert_eq!(to_roman(0, true), "");
        assert_eq!(to_roman(-3, false), "");
    }

    #[test]
    fn formatters_cap_huge_values() {
        // DoS guard: at the cap the formatters still render; above it (incl.
        // i64::MAX) they return empty instead of spinning/allocating unboundedly.
        assert!(!to_roman(MAX_RENDERABLE_LABEL_VALUE, true).is_empty());
        assert_eq!(to_roman(MAX_RENDERABLE_LABEL_VALUE + 1, true), "");
        assert_eq!(to_roman(i64::MAX, true), "");
        assert!(!to_alpha(MAX_RENDERABLE_LABEL_VALUE, true).is_empty());
        assert_eq!(to_alpha(MAX_RENDERABLE_LABEL_VALUE + 1, true), "");
        assert_eq!(to_alpha(i64::MAX, true), "");
    }

    #[test]
    fn alpha_repeating_letters() {
        assert_eq!(to_alpha(1, true), "A");
        assert_eq!(to_alpha(26, true), "Z");
        assert_eq!(to_alpha(27, true), "AA");
        assert_eq!(to_alpha(52, false), "zz");
        assert_eq!(to_alpha(53, true), "AAA");
        assert_eq!(to_alpha(0, true), "");
    }

    #[test]
    fn label_range_format_prefix_and_styles() {
        let d = LabelRange {
            style: LabelStyle::Decimal,
            prefix: "A-".into(),
            start: 1,
        };
        assert_eq!(d.format(5), "A-5");
        let r = LabelRange {
            style: LabelStyle::RomanLower,
            prefix: String::new(),
            start: 1,
        };
        assert_eq!(r.format(3), "iii");
        let none = LabelRange {
            style: LabelStyle::None,
            prefix: "Cover".into(),
            start: 1,
        };
        assert_eq!(
            none.format(9),
            "Cover",
            "None style => prefix only, no number"
        );
    }

    #[test]
    fn label_range_dict_round_trip() {
        let r = LabelRange {
            style: LabelStyle::RomanUpper,
            prefix: "App-".into(),
            start: 5,
        };
        let dict = r.to_dict();
        assert_eq!(dict.get("S"), Some(&Object::Name("R".into())));
        assert_eq!(dict.get("St"), Some(&Object::Integer(5)));
        assert_eq!(LabelRange::from_dict(&dict), r);
        // Defaults omitted: St=1 and empty prefix and None style produce empty dict.
        let bare = LabelRange {
            style: LabelStyle::None,
            prefix: String::new(),
            start: 1,
        };
        assert!(
            bare.to_dict().iter().next().is_none(),
            "all-default range => empty dict"
        );
    }

    #[test]
    fn ranges_resolves_indirect_inner_st() {
        let mut pdf = pdf_with_pagelabels(vec![]); // empty root; we set a custom tree below
                                                   // Put an indirect /St value: label dict {/S /D /St 11 0 R}, 11 0 obj = Integer(7).
        let st_ref = ObjectRef::new(11, 0);
        pdf.set_object(st_ref, Object::Integer(7));
        let mut label = Dictionary::new();
        label.insert("S", Object::Name("D".into()));
        label.insert("St", Object::Reference(st_ref));
        let pl_ref = ObjectRef::new(10, 0);
        let mut leaf = Dictionary::new();
        leaf.insert(
            "Nums",
            Object::Array(vec![Object::Integer(0), Object::Dictionary(label)]),
        );
        pdf.set_object(pl_ref, Object::Dictionary(leaf));
        // catalog already points /PageLabels -> 10 0 R from pdf_with_pagelabels.
        let mut h = pdf.page_labels();
        let ranges = h.ranges().unwrap();
        assert_eq!(ranges.len(), 1);
        assert_eq!(ranges[0].1.start, 7, "indirect /St must be resolved");
    }

    #[test]
    fn set_range_round_trips_multi_leaf_tree() {
        let mut pdf = pdf_with_pagelabels(vec![]);
        {
            let mut h = pdf.page_labels();
            for i in 0..40i64 {
                h.set_range(
                    i * 2,
                    LabelRange {
                        style: LabelStyle::Decimal,
                        prefix: String::new(),
                        start: 1,
                    },
                )
                .unwrap();
            }
        }
        let mut h = pdf.page_labels();
        let ranges = h.ranges().unwrap();
        assert_eq!(
            ranges.len(),
            40,
            "all 40 ranges survive the multi-leaf tree"
        );
        // Spot-check ordering + a mid entry.
        assert_eq!(ranges[0].0, 0);
        assert_eq!(ranges[39].0, 78);
        assert!(ranges.windows(2).all(|w| w[0].0 < w[1].0), "ascending");
    }

    #[test]
    fn label_style_name_round_trip_all_variants() {
        for (bytes, style, name) in [
            (b"D".as_ref(), LabelStyle::Decimal, Some("D")),
            (b"R".as_ref(), LabelStyle::RomanUpper, Some("R")),
            (b"r".as_ref(), LabelStyle::RomanLower, Some("r")),
            (b"A".as_ref(), LabelStyle::AlphaUpper, Some("A")),
            (b"a".as_ref(), LabelStyle::AlphaLower, Some("a")),
        ] {
            assert_eq!(LabelStyle::from_name(bytes), style);
            assert_eq!(style.to_name(), name);
        }
        // Unrecognised /S name -> None (from_name `_` arm); None has no name.
        assert_eq!(LabelStyle::from_name(b"Z"), LabelStyle::None);
        assert_eq!(LabelStyle::None.to_name(), None);
    }

    #[test]
    fn format_alpha_styles() {
        let up = LabelRange {
            style: LabelStyle::AlphaUpper,
            prefix: String::new(),
            start: 1,
        };
        assert_eq!(up.format(27), "AA");
        let lo = LabelRange {
            style: LabelStyle::AlphaLower,
            prefix: "x".into(),
            start: 1,
        };
        assert_eq!(lo.format(2), "xb");
    }

    #[test]
    fn from_dict_non_name_style_is_none() {
        let mut d = Dictionary::new();
        d.insert("S", Object::Integer(0)); // /S not a Name -> LabelStyle::None
        assert_eq!(LabelRange::from_dict(&d).style, LabelStyle::None);
    }

    #[test]
    fn ranges_handles_indirect_and_non_dict_values() {
        // entry 0: indirect ref to a label dict; entry 5: a non-dict value (skipped).
        let mut pdf = pdf_with_pagelabels(vec![]);
        let lab_ref = ObjectRef::new(20, 0);
        let mut lab = Dictionary::new();
        lab.insert("S", Object::Name("D".into()));
        pdf.set_object(lab_ref, Object::Dictionary(lab));
        let pl_ref = ObjectRef::new(10, 0);
        let mut leaf = Dictionary::new();
        leaf.insert(
            "Nums",
            Object::Array(vec![
                Object::Integer(0),
                Object::Reference(lab_ref), // indirect entry value -> resolve
                Object::Integer(5),
                Object::Integer(99), // non-dict entry value -> skipped
            ]),
        );
        pdf.set_object(pl_ref, Object::Dictionary(leaf));
        let mut h = pdf.page_labels();
        let ranges = h.ranges().unwrap();
        assert_eq!(ranges.len(), 1, "non-dict value skipped");
        assert_eq!(ranges[0].0, 0);
        assert_eq!(ranges[0].1.style, LabelStyle::Decimal);
    }

    #[test]
    fn ranges_non_name_style_resolves_to_none() {
        // A label dict whose /S is not a Name resolves to LabelStyle::None via
        // the resolving reader path (from_dict_resolved).
        let mut pdf = pdf_with_pagelabels(vec![]);
        let pl_ref = ObjectRef::new(10, 0);
        let mut lab = Dictionary::new();
        lab.insert("S", Object::Integer(0)); // non-Name /S
        let mut leaf = Dictionary::new();
        leaf.insert(
            "Nums",
            Object::Array(vec![Object::Integer(0), Object::Dictionary(lab)]),
        );
        pdf.set_object(pl_ref, Object::Dictionary(leaf));
        let mut h = pdf.page_labels();
        let ranges = h.ranges().unwrap();
        assert_eq!(ranges.len(), 1);
        assert_eq!(ranges[0].1.style, LabelStyle::None);
    }

    #[test]
    fn labels_for_page_range_fabricates_default_when_first_unlabeled() {
        // Only an explicit range at index 5; extract starting before it (idx 0).
        let mut pdf = pdf_with_pagelabels(vec![Object::Integer(5), label_dict("D", Some(1), None)]);
        let mut h = pdf.page_labels();
        let out = h.labels_for_page_range(0, 6, 0).unwrap();
        // First entry fabricated: Decimal, start = new_start(0) + 1 = 1.
        assert_eq!(out[0].0, 0);
        assert_eq!(out[0].1.style, LabelStyle::Decimal);
        assert_eq!(out[0].1.start, 1);
        // The explicit range at 5 is copied (renumbered to 5).
        assert!(out.iter().any(|(idx, _)| *idx == 5));
    }

    #[test]
    fn helper_tolerates_non_dict_catalog() {
        let mut pdf = pdf_with_pagelabels(vec![]);
        let catalog_ref = pdf.root_ref().unwrap();
        pdf.set_object(catalog_ref, Object::Integer(0)); // catalog no longer a dict
        let mut h = pdf.page_labels();
        assert!(
            !h.has_page_labels().unwrap(),
            "non-dict catalog => no labels"
        );
        assert_eq!(h.ranges().unwrap(), vec![]);
        // rebuild path bails out gracefully when the catalog is not a dict.
        h.set_range(
            0,
            LabelRange {
                style: LabelStyle::Decimal,
                prefix: String::new(),
                start: 1,
            },
        )
        .unwrap();
    }

    #[test]
    fn helper_tolerates_missing_root() {
        // A trailer without /Root makes root_ref() return None; the helper must
        // degrade gracefully (no labels, rebuild is a no-op).
        let mut bytes = Vec::new();
        bytes.extend_from_slice(b"%PDF-1.7\n");
        let off1 = bytes.len() as u64;
        bytes.extend_from_slice(b"1 0 obj\n<< /Type /Catalog >>\nendobj\n");
        let xref = bytes.len() as u64;
        bytes.extend_from_slice(
            format!(
                "xref\n0 2\n0000000000 65535 f \n{off1:010} 00000 n \ntrailer\n<< /Size 2 >>\nstartxref\n{xref}\n%%EOF\n"
            )
            .as_bytes(),
        );
        let mut pdf = Pdf::open(Cursor::new(bytes)).expect("rootless trailer still opens");
        assert!(pdf.root_ref().is_none(), "rootless trailer => no root_ref");
        let mut h = pdf.page_labels();
        assert!(!h.has_page_labels().unwrap());
        assert_eq!(h.ranges().unwrap(), vec![]);
        h.set_range(
            0,
            LabelRange {
                style: LabelStyle::Decimal,
                prefix: String::new(),
                start: 1,
            },
        )
        .unwrap();
    }
}