pivot-pdf 0.6.0

A low-overhead PDF generation library for reports, invoices, and documents
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
use std::collections::{HashMap, HashSet};
use std::io;
use std::path::Path;

// ── Error type ────────────────────────────────────────────────────────────────

/// Errors that can occur when reading a PDF file.
#[derive(Debug, PartialEq)]
pub enum PdfReadError {
    /// The bytes do not start with a valid `%PDF-` header.
    NotAPdf,
    /// The `startxref` keyword or its offset could not be found.
    StartxrefNotFound,
    /// The cross-reference table is missing or could not be parsed.
    MalformedXref,
    /// The trailer dictionary is missing or malformed.
    MalformedTrailer,
    /// The PDF uses a cross-reference stream (PDF 1.5+), which is not yet supported.
    XrefStreamNotSupported,
    /// An object reference could not be resolved (offset out of range or malformed).
    UnresolvableObject(u32),
    /// The page tree structure is invalid (missing /Count or /Pages).
    MalformedPageTree,
    /// An I/O error occurred while opening a file.
    Io(String),
}

impl std::fmt::Display for PdfReadError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            PdfReadError::NotAPdf => write!(f, "not a PDF file"),
            PdfReadError::StartxrefNotFound => write!(f, "startxref not found"),
            PdfReadError::MalformedXref => write!(f, "malformed or missing xref table"),
            PdfReadError::MalformedTrailer => write!(f, "malformed or missing trailer"),
            PdfReadError::XrefStreamNotSupported => {
                write!(
                    f,
                    "cross-reference streams (PDF 1.5+) are not yet supported"
                )
            }
            PdfReadError::UnresolvableObject(n) => write!(f, "cannot resolve object {}", n),
            PdfReadError::MalformedPageTree => write!(f, "malformed page tree"),
            PdfReadError::Io(msg) => write!(f, "I/O error: {}", msg),
        }
    }
}

impl std::error::Error for PdfReadError {}

impl From<io::Error> for PdfReadError {
    fn from(e: io::Error) -> Self {
        PdfReadError::Io(e.to_string())
    }
}

// ── Public API ─────────────────────────────────────────────────────────────────

/// Reads an existing PDF file.
///
/// `PdfReader` parses the PDF's cross-reference table and trailer to locate
/// and resolve objects. The raw bytes and xref offset map are retained so that
/// future enhancements (editing, field extraction, merging) can resolve
/// arbitrary objects without re-reading the file.
///
/// # Limitations
/// PDF 1.5+ cross-reference streams are not supported. Files that use them
/// return `PdfReadError::XrefStreamNotSupported`.
pub struct PdfReader {
    /// Raw file bytes retained for object resolution (merging, field extraction, etc.).
    data: Vec<u8>,
    /// Maps each object number to its byte offset in `data`.
    xref: HashMap<u32, usize>,
    version: String,
    page_count: usize,
    /// Object number of the document catalog (`/Type /Catalog`).
    catalog_num: u32,
}

impl PdfReader {
    /// Open a PDF from a file path.
    pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, PdfReadError> {
        let data = std::fs::read(path.as_ref())?;
        Self::from_bytes(data)
    }

    /// Parse a PDF from raw bytes.
    pub fn from_bytes(data: Vec<u8>) -> Result<Self, PdfReadError> {
        let version = parse_version(&data)?;
        let xref_offset = find_startxref(&data)?;
        let (xref, root_ref) = parse_xref_and_trailer(&data, xref_offset)?;
        let page_count = resolve_page_count(&data, &xref, root_ref)?;

        Ok(PdfReader {
            data,
            xref,
            version,
            page_count,
            catalog_num: root_ref,
        })
    }

    /// Number of pages in the document.
    pub fn page_count(&self) -> usize {
        self.page_count
    }

    /// PDF version string (e.g. `"1.7"`).
    pub fn pdf_version(&self) -> &str {
        &self.version
    }

    // ── Internal infrastructure for Issue 28 (PDF Merge) ───────────────────────
    // Dead-code warnings are expected until Issue 28 calls these methods.
    #[allow(dead_code)]
    /// Return page object numbers in document order by walking the page tree.
    ///
    /// Walks the Catalog → Pages tree recursively, collecting the object number
    /// of each leaf `/Page` node in the order they appear in the document.
    pub(crate) fn page_object_numbers(&self) -> Result<Vec<u32>, PdfReadError> {
        let catalog_dict = resolve_dict(&self.data, &self.xref, self.catalog_num)?;
        let pages_ref = catalog_dict
            .get("Pages")
            .ok_or(PdfReadError::MalformedPageTree)?;
        let pages_num: u32 = pages_ref
            .parse()
            .map_err(|_| PdfReadError::MalformedPageTree)?;

        let mut result = Vec::new();
        walk_page_tree(&self.data, &self.xref, pages_num, &mut result)?;
        Ok(result)
    }

    /// Build the transitive closure of all objects reachable from `roots`.
    ///
    /// BFS from the seed object numbers, scanning each object's raw bytes for
    /// indirect references (`N G R`) and adding any newly-seen xref objects to
    /// the queue. Returns the complete set of object numbers a merge function
    /// needs to copy.
    #[allow(dead_code)]
    pub(crate) fn collect_closure(&self, roots: &[u32]) -> Result<HashSet<u32>, PdfReadError> {
        let mut visited: HashSet<u32> = HashSet::new();
        let mut queue: Vec<u32> = roots.to_vec();

        while let Some(obj_num) = queue.pop() {
            if !visited.insert(obj_num) {
                continue; // already visited
            }

            if let Ok(bytes) = self.raw_object_bytes(obj_num) {
                for r in extract_indirect_refs(bytes) {
                    if !visited.contains(&r) && self.xref.contains_key(&r) {
                        queue.push(r);
                    }
                }
            }
        }

        Ok(visited)
    }

    #[allow(dead_code)]
    /// Return the raw bytes of object `obj_num` — from `N G obj` through `endobj`.
    ///
    /// The slice is a view into the internal buffer; no allocation occurs.
    ///
    /// **Limitation:** locates `endobj` by scanning for the literal bytes. If a
    /// stream body happens to contain those bytes (e.g. a binary font program
    /// compressed by an external tool), the returned slice will be truncated. For
    /// PDFs generated by this library this cannot occur.
    pub(crate) fn raw_object_bytes(&self, obj_num: u32) -> Result<&[u8], PdfReadError> {
        let offset = self
            .xref
            .get(&obj_num)
            .copied()
            .ok_or(PdfReadError::UnresolvableObject(obj_num))?;

        if offset >= self.data.len() {
            return Err(PdfReadError::UnresolvableObject(obj_num));
        }

        let slice = &self.data[offset..];
        let endobj_pos = slice
            .windows(6)
            .position(|w| w == b"endobj")
            .ok_or(PdfReadError::UnresolvableObject(obj_num))?;

        Ok(&slice[..endobj_pos + 6])
    }
}

// ── Internal parsing ───────────────────────────────────────────────────────────

/// Extract the PDF version from the `%PDF-x.y` header.
fn parse_version(data: &[u8]) -> Result<String, PdfReadError> {
    if data.len() < 8 || !data.starts_with(b"%PDF-") {
        return Err(PdfReadError::NotAPdf);
    }
    // Version is the characters after "%PDF-" up to the first whitespace.
    let rest = &data[5..];
    let end = rest
        .iter()
        .position(|&b| b == b'\n' || b == b'\r' || b == b' ')
        .unwrap_or(rest.len());
    let version = std::str::from_utf8(&rest[..end])
        .map(|s| s.to_string())
        .map_err(|_| PdfReadError::NotAPdf)?;
    Ok(version)
}

/// Scan backward from the end of the file to find the `startxref` offset.
///
/// The PDF spec places `startxref\n{offset}\n%%EOF` near the end of the file.
/// We search within the last 1024 bytes to handle comments or trailing whitespace.
fn find_startxref(data: &[u8]) -> Result<usize, PdfReadError> {
    let search_start = data.len().saturating_sub(1024);
    let tail = &data[search_start..];

    // Search backward for the keyword "startxref"
    let keyword = b"startxref";
    let pos = tail
        .windows(keyword.len())
        .rposition(|w| w == keyword)
        .ok_or(PdfReadError::StartxrefNotFound)?;

    // The offset integer follows on the next line.
    let after = &tail[pos + keyword.len()..];
    let offset_str = skip_whitespace_to_token(after).ok_or(PdfReadError::StartxrefNotFound)?;
    let offset: usize = offset_str
        .parse()
        .map_err(|_| PdfReadError::StartxrefNotFound)?;

    if offset >= data.len() {
        return Err(PdfReadError::StartxrefNotFound);
    }

    Ok(offset)
}

/// Parse the xref table starting at `xref_offset` and the following trailer.
///
/// Returns `(object_offset_map, root_object_number)`.
fn parse_xref_and_trailer(
    data: &[u8],
    xref_offset: usize,
) -> Result<(HashMap<u32, usize>, u32), PdfReadError> {
    if xref_offset >= data.len() {
        return Err(PdfReadError::MalformedXref);
    }

    let section = &data[xref_offset..];

    // Check for cross-reference stream (PDF 1.5+): starts with "N 0 obj" not "xref"
    let trimmed = skip_ascii_whitespace(section);
    if !trimmed.starts_with(b"xref") {
        return Err(PdfReadError::XrefStreamNotSupported);
    }

    let xref = parse_xref_table(section)?;
    let root = parse_trailer_root(data, xref_offset)?;

    Ok((xref, root))
}

/// Parse the traditional xref table.
///
/// Each subsection has a header line `{first_obj} {count}` followed by
/// 20-byte fixed-width entries: `{offset:010} {gen:05} {n|f}\r\n`.
fn parse_xref_table(section: &[u8]) -> Result<HashMap<u32, usize>, PdfReadError> {
    let mut map = HashMap::new();

    // Skip "xref\n"
    let rest = skip_ascii_whitespace(consume_token(section, b"xref")?);

    let mut cursor = rest;
    loop {
        let trimmed = skip_ascii_whitespace(cursor);
        // Stop at "trailer" or end of section
        if trimmed.is_empty() || trimmed.starts_with(b"trailer") {
            break;
        }

        // Subsection header: "{first_obj} {count}"
        let (first_obj_str, after_first) =
            next_token(trimmed).ok_or(PdfReadError::MalformedXref)?;
        let first_obj: u32 = first_obj_str
            .parse()
            .map_err(|_| PdfReadError::MalformedXref)?;

        let after_first = skip_ascii_whitespace(after_first);
        let (count_str, after_count) =
            next_token(after_first).ok_or(PdfReadError::MalformedXref)?;
        let count: usize = count_str.parse().map_err(|_| PdfReadError::MalformedXref)?;

        // Each entry is exactly 20 bytes: "oooooooooo ggggg n/f\r\n"
        let entries_start = skip_line(after_count);
        let entry_size = 20;
        let entries_bytes = entries_start.len();

        if entries_bytes < count * entry_size {
            return Err(PdfReadError::MalformedXref);
        }

        for i in 0..count {
            let entry = &entries_start[i * entry_size..(i + 1) * entry_size];
            // Offset: first 10 bytes
            let offset_bytes = &entry[..10];
            // Status: byte 17 ('n' = in-use, 'f' = free)
            let status = entry[17];

            if status == b'n' {
                let offset_str =
                    std::str::from_utf8(offset_bytes).map_err(|_| PdfReadError::MalformedXref)?;
                let offset: usize = offset_str
                    .parse()
                    .map_err(|_| PdfReadError::MalformedXref)?;
                let obj_num = first_obj + i as u32;
                if obj_num > 0 {
                    map.insert(obj_num, offset);
                }
            }
        }

        cursor = &entries_start[count * entry_size..];
    }

    Ok(map)
}

/// Extract the `/Root` object number from the trailer dictionary.
fn parse_trailer_root(data: &[u8], xref_offset: usize) -> Result<u32, PdfReadError> {
    // Find "trailer" after the xref table
    let section = &data[xref_offset..];
    let pos = section
        .windows(7)
        .position(|w| w == b"trailer")
        .ok_or(PdfReadError::MalformedTrailer)?;

    let after_trailer = skip_ascii_whitespace(&section[pos + 7..]);

    // Parse the trailer dictionary to find /Root
    let dict = parse_dict_bytes(after_trailer).ok_or(PdfReadError::MalformedTrailer)?;

    let root_ref = dict.get("Root").ok_or(PdfReadError::MalformedTrailer)?;
    // Root value is a reference: "N M R" — we only need N
    let obj_num: u32 = root_ref
        .parse()
        .map_err(|_| PdfReadError::MalformedTrailer)?;
    Ok(obj_num)
}

/// Follow the catalog → pages chain to read the `/Count` value.
fn resolve_page_count(
    data: &[u8],
    xref: &HashMap<u32, usize>,
    catalog_obj_num: u32,
) -> Result<usize, PdfReadError> {
    // Resolve catalog object → get /Pages reference
    let catalog_dict = resolve_dict(data, xref, catalog_obj_num)?;

    let pages_ref = catalog_dict
        .get("Pages")
        .ok_or(PdfReadError::MalformedPageTree)?;
    let pages_obj_num: u32 = pages_ref
        .parse()
        .map_err(|_| PdfReadError::MalformedPageTree)?;

    // Resolve pages object → read /Count
    let pages_dict = resolve_dict(data, xref, pages_obj_num)?;

    let count_str = pages_dict
        .get("Count")
        .ok_or(PdfReadError::MalformedPageTree)?;
    let count: usize = count_str
        .parse()
        .map_err(|_| PdfReadError::MalformedPageTree)?;

    Ok(count)
}

/// Resolve an indirect object by number, parse its body as a dictionary,
/// and return a flat `name → first-token-of-value` map.
fn resolve_dict(
    data: &[u8],
    xref: &HashMap<u32, usize>,
    obj_num: u32,
) -> Result<HashMap<String, String>, PdfReadError> {
    let offset = xref
        .get(&obj_num)
        .copied()
        .ok_or(PdfReadError::UnresolvableObject(obj_num))?;

    if offset >= data.len() {
        return Err(PdfReadError::UnresolvableObject(obj_num));
    }

    let slice = &data[offset..];

    // Skip "N G obj" header
    let after_header = skip_obj_header(slice).ok_or(PdfReadError::UnresolvableObject(obj_num))?;
    let after_ws = skip_ascii_whitespace(after_header);

    parse_dict_bytes(after_ws).ok_or(PdfReadError::UnresolvableObject(obj_num))
}

// ── Page tree helpers ──────────────────────────────────────────────────────────

#[allow(dead_code)]
/// Recursively walk a page tree node, appending leaf `/Page` object numbers to `result`.
fn walk_page_tree(
    data: &[u8],
    xref: &HashMap<u32, usize>,
    node: u32,
    result: &mut Vec<u32>,
) -> Result<(), PdfReadError> {
    let dict = resolve_dict(data, xref, node)?;
    match dict.get("Type").map(String::as_str) {
        Some("/Page") => {
            result.push(node);
        }
        Some("/Pages") | None => {
            let kids = resolve_kids(data, xref, node)?;
            for kid in kids {
                walk_page_tree(data, xref, kid, result)?;
            }
        }
        _ => {}
    }
    Ok(())
}

#[allow(dead_code)]
/// Extract the `/Kids` array of indirect object numbers from a Pages node.
fn resolve_kids(
    data: &[u8],
    xref: &HashMap<u32, usize>,
    obj_num: u32,
) -> Result<Vec<u32>, PdfReadError> {
    let offset = xref
        .get(&obj_num)
        .copied()
        .ok_or(PdfReadError::UnresolvableObject(obj_num))?;

    if offset >= data.len() {
        return Err(PdfReadError::UnresolvableObject(obj_num));
    }

    // Bound the search to this object's bytes only (up to and including `endobj`),
    // so we never accidentally find `/Kids` from a later object.
    let slice = &data[offset..];
    let obj_end = slice
        .windows(6)
        .position(|w| w == b"endobj")
        .map(|p| p + 6)
        .unwrap_or(slice.len());
    let slice = &slice[..obj_end];

    let after_header = skip_obj_header(slice).ok_or(PdfReadError::UnresolvableObject(obj_num))?;
    let after_ws = skip_ascii_whitespace(after_header);

    // Locate `/Kids` within the object bytes and parse the following array.
    let needle = b"/Kids";
    let kids_pos = after_ws
        .windows(needle.len())
        .position(|w| w == needle)
        .ok_or(PdfReadError::MalformedPageTree)?;

    let after_kids = skip_ascii_whitespace(&after_ws[kids_pos + needle.len()..]);
    if !after_kids.starts_with(b"[") {
        return Err(PdfReadError::MalformedPageTree);
    }

    parse_ref_array(after_kids).ok_or(PdfReadError::MalformedPageTree)
}

#[allow(dead_code)]
/// Parse `[N G R N G R ...]` and return the object numbers.
fn parse_ref_array(data: &[u8]) -> Option<Vec<u32>> {
    debug_assert!(data.starts_with(b"["));
    let end = data.iter().position(|&b| b == b']')?;
    let inner = &data[1..end];

    let mut result = Vec::new();
    let mut cursor = inner;

    loop {
        cursor = skip_ascii_whitespace(cursor);
        if cursor.is_empty() {
            break;
        }

        let (n_str, rest) = next_token(cursor)?;
        let Ok(n) = n_str.parse::<u32>() else { break };

        let rest = skip_ascii_whitespace(rest);
        let (_g_str, rest) = next_token(rest)?; // generation number

        let rest = skip_ascii_whitespace(rest);
        let (r_str, rest) = next_token(rest)?;
        if r_str != "R" {
            break;
        }

        result.push(n);
        cursor = rest;
    }

    Some(result)
}

#[allow(dead_code)]
/// Scan `data` for all indirect-reference tokens (`N G R`) and return the object numbers.
///
/// Tokenizes on ASCII whitespace and common PDF delimiters, then looks for triplets
/// where the first two tokens are decimal integers and the third is `R`. This approach
/// may produce false positives for binary streams; for the PDFs this library generates
/// that is not an issue because content streams use operators, not object references.
fn extract_indirect_refs(data: &[u8]) -> HashSet<u32> {
    let mut refs = HashSet::new();

    // Collect whitespace/delimiter-separated tokens as byte slices.
    let is_delim = |b: u8| b.is_ascii_whitespace() || matches!(b, b'<' | b'>' | b'[' | b']');
    let mut tokens: Vec<&[u8]> = Vec::new();
    let mut cursor = data;

    loop {
        // Skip delimiters
        let start = cursor.iter().position(|&b| !is_delim(b));
        let Some(start) = start else { break };
        cursor = &cursor[start..];

        // Read token up to next delimiter
        let end = cursor
            .iter()
            .position(|&b| is_delim(b))
            .unwrap_or(cursor.len());
        tokens.push(&cursor[..end]);
        cursor = &cursor[end..];
    }

    // Scan for "N G R" triplets
    let mut i = 0;
    while i + 2 < tokens.len() {
        let a = tokens[i];
        let b = tokens[i + 1];
        let c = tokens[i + 2];

        if c == b"R"
            && a.iter().all(|&x| x.is_ascii_digit())
            && b.iter().all(|&x| x.is_ascii_digit())
            && !a.is_empty()
        {
            if let Ok(s) = std::str::from_utf8(a) {
                if let Ok(n) = s.parse::<u32>() {
                    refs.insert(n);
                    i += 3;
                    continue;
                }
            }
        }
        i += 1;
    }

    refs
}

// ── Token / byte utilities ─────────────────────────────────────────────────────

/// Parse `<<...>>` dictionary bytes into a flat `key → first-token-of-value` map.
///
/// Values that are indirect references (`N G R`) are stored as just the object
/// number string. Nested dictionaries and arrays are skipped.
fn parse_dict_bytes(data: &[u8]) -> Option<HashMap<String, String>> {
    let data = skip_ascii_whitespace(data);
    if !data.starts_with(b"<<") {
        return None;
    }

    let mut map = HashMap::new();
    let mut cursor = &data[2..];

    loop {
        cursor = skip_ascii_whitespace(cursor);

        if cursor.starts_with(b">>") {
            break;
        }

        // Expect a name key: /KeyName
        if !cursor.starts_with(b"/") {
            // Skip unknown token
            let (_, rest) = next_token(cursor)?;
            cursor = rest;
            continue;
        }

        let (key, after_key) = next_token(&cursor[1..])?;
        cursor = skip_ascii_whitespace(after_key);

        // Read the value — we only need the first token (object number for refs)
        if cursor.starts_with(b"<<") {
            // Nested dict: skip to matching >>
            cursor = skip_nested_dict(cursor)?;
        } else if cursor.starts_with(b"[") {
            // Array: skip to ]
            cursor = skip_array(cursor)?;
        } else if cursor.starts_with(b"(") {
            // Literal string: skip to closing )
            cursor = skip_literal_string(cursor)?;
        } else {
            let (val, rest) = next_token(cursor)?;
            cursor = skip_ascii_whitespace(rest);

            // If it looks like an indirect reference (val=N, next="G R"), capture just N
            if let Some((gen_str, after_gen)) = next_token(cursor) {
                let after_gen_ws = skip_ascii_whitespace(after_gen);
                if let Some((r_str, after_r)) = next_token(after_gen_ws) {
                    if r_str == "R"
                        && val.chars().all(|c| c.is_ascii_digit())
                        && gen_str.chars().all(|c| c.is_ascii_digit())
                    {
                        map.insert(key.to_string(), val.to_string());
                        cursor = after_r;
                        continue;
                    }
                }
                // Not a reference: store the raw value token
                map.insert(key.to_string(), val.to_string());
            } else {
                map.insert(key.to_string(), val.to_string());
            }
        }
    }

    Some(map)
}

/// Skip over a `<<...>>` block (with nested dicts), returning bytes after `>>`.
///
/// Depth tracking: each `<<` increments depth, each `>>` decrements. We return
/// after the `>>` that brings depth back to zero (i.e. the outer closing `>>`).
fn skip_nested_dict(data: &[u8]) -> Option<&[u8]> {
    debug_assert!(data.starts_with(b"<<"));
    let mut depth = 0i32;
    let mut i = 0;
    while i < data.len() {
        if data[i..].starts_with(b"<<") {
            depth += 1;
            i += 2;
        } else if data[i..].starts_with(b">>") {
            depth -= 1;
            i += 2;
            if depth == 0 {
                return Some(&data[i..]);
            }
        } else {
            i += 1;
        }
    }
    None
}

/// Skip over a `[...]` array, returning bytes after `]`.
fn skip_array(data: &[u8]) -> Option<&[u8]> {
    debug_assert!(data.starts_with(b"["));
    let pos = data.iter().position(|&b| b == b']')?;
    Some(&data[pos + 1..])
}

/// Skip over a `(...)` literal string (handles backslash escapes), returning bytes after `)`.
fn skip_literal_string(data: &[u8]) -> Option<&[u8]> {
    debug_assert!(data.starts_with(b"("));
    let mut i = 1;
    let mut depth = 1i32;
    while i < data.len() {
        match data[i] {
            b'\\' => i += 2,
            b'(' => {
                depth += 1;
                i += 1;
            }
            b')' => {
                depth -= 1;
                i += 1;
                if depth == 0 {
                    return Some(&data[i..]);
                }
            }
            _ => i += 1,
        }
    }
    None
}

/// Skip "N G obj" indirect object header, returning bytes after "obj".
fn skip_obj_header(data: &[u8]) -> Option<&[u8]> {
    let (_, rest) = next_token(data)?; // object number
    let rest = skip_ascii_whitespace(rest);
    let (_, rest) = next_token(rest)?; // generation number
    let rest = skip_ascii_whitespace(rest);
    let (keyword, rest) = next_token(rest)?; // "obj"
    if keyword != "obj" {
        return None;
    }
    Some(rest)
}

/// Return a sub-slice starting at the first non-whitespace byte.
fn skip_ascii_whitespace(data: &[u8]) -> &[u8] {
    let pos = data
        .iter()
        .position(|&b| !b.is_ascii_whitespace())
        .unwrap_or(data.len());
    &data[pos..]
}

/// Skip to the end of the current line (past `\n` or `\r\n`).
fn skip_line(data: &[u8]) -> &[u8] {
    let pos = data
        .iter()
        .position(|&b| b == b'\n')
        .unwrap_or(data.len().saturating_sub(1));
    if pos + 1 < data.len() {
        &data[pos + 1..]
    } else {
        &data[data.len()..]
    }
}

/// Consume a literal byte sequence at the start of `data`, returning the remainder.
fn consume_token<'a>(data: &'a [u8], token: &[u8]) -> Result<&'a [u8], PdfReadError> {
    let trimmed = skip_ascii_whitespace(data);
    if trimmed.starts_with(token) {
        Ok(&trimmed[token.len()..])
    } else {
        Err(PdfReadError::MalformedXref)
    }
}

/// Read the next whitespace-delimited token from `data`.
/// Returns `(token_str, remaining_bytes)` or `None` if at end.
fn next_token(data: &[u8]) -> Option<(&str, &[u8])> {
    let data = skip_ascii_whitespace(data);
    if data.is_empty() {
        return None;
    }
    let end = data
        .iter()
        .position(|&b| b.is_ascii_whitespace() || b == b'<' || b == b'>')
        .unwrap_or(data.len());
    if end == 0 {
        // Single delimiter character
        let token = std::str::from_utf8(&data[..1]).ok()?;
        return Some((token, &data[1..]));
    }
    let token = std::str::from_utf8(&data[..end]).ok()?;
    Some((token, &data[end..]))
}

/// Find the first non-whitespace token in `data` and parse it as a string.
fn skip_whitespace_to_token(data: &[u8]) -> Option<&str> {
    let (tok, _) = next_token(data)?;
    Some(tok)
}

// ── Unit tests (pub(crate) surface) ────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;
    use crate::document::PdfDocument;

    fn make_pdf(n: usize) -> Vec<u8> {
        let mut doc = PdfDocument::new(Vec::new()).unwrap();
        for _ in 0..n {
            doc.begin_page(612.0, 792.0);
            doc.end_page().unwrap();
        }
        doc.end_document().unwrap()
    }

    // ── page_object_numbers ─────────────────────────────────────────────────────

    #[test]
    fn page_object_numbers_count_matches_page_count() {
        for n in [0, 1, 3, 10] {
            let bytes = make_pdf(n);
            let reader = PdfReader::from_bytes(bytes).unwrap();
            let nums = reader.page_object_numbers().unwrap();
            assert_eq!(nums.len(), n, "expected {n} page objects");
        }
    }

    #[test]
    fn page_object_numbers_are_unique_and_positive() {
        let bytes = make_pdf(5);
        let reader = PdfReader::from_bytes(bytes).unwrap();
        let nums = reader.page_object_numbers().unwrap();
        assert!(
            nums.iter().all(|&n| n > 0),
            "all object numbers must be > 0"
        );
        let unique: HashSet<_> = nums.iter().collect();
        assert_eq!(unique.len(), nums.len(), "object numbers must be unique");
    }

    #[test]
    fn page_object_numbers_order_is_stable() {
        // Calling twice must return the same sequence.
        let bytes = make_pdf(4);
        let reader = PdfReader::from_bytes(bytes).unwrap();
        let first = reader.page_object_numbers().unwrap();
        let second = reader.page_object_numbers().unwrap();
        assert_eq!(first, second);
    }

    // ── collect_closure ─────────────────────────────────────────────────────────

    #[test]
    fn collect_closure_contains_seed_objects() {
        let bytes = make_pdf(2);
        let reader = PdfReader::from_bytes(bytes).unwrap();
        let page_nums = reader.page_object_numbers().unwrap();
        let closure = reader.collect_closure(&page_nums).unwrap();
        for &n in &page_nums {
            assert!(closure.contains(&n), "closure must include seed object {n}");
        }
    }

    #[test]
    fn collect_closure_includes_dependencies() {
        // A page has at least a content stream and resource dictionary, so the
        // closure should be larger than just the page object itself.
        let bytes = make_pdf(1);
        let reader = PdfReader::from_bytes(bytes).unwrap();
        let page_nums = reader.page_object_numbers().unwrap();
        let closure = reader.collect_closure(&page_nums).unwrap();
        assert!(
            closure.len() > page_nums.len(),
            "closure must include objects beyond the page nodes"
        );
    }

    #[test]
    fn collect_closure_empty_roots_returns_empty() {
        let bytes = make_pdf(1);
        let reader = PdfReader::from_bytes(bytes).unwrap();
        let closure = reader.collect_closure(&[]).unwrap();
        assert!(closure.is_empty());
    }

    // ── raw_object_bytes ────────────────────────────────────────────────────────

    #[test]
    fn raw_object_bytes_starts_with_obj_header_and_ends_with_endobj() {
        let bytes = make_pdf(1);
        let reader = PdfReader::from_bytes(bytes).unwrap();
        let page_num = reader.page_object_numbers().unwrap()[0];
        let raw = reader.raw_object_bytes(page_num).unwrap();

        // Must contain " obj" (the indirect object header keyword).
        assert!(raw.windows(4).any(|w| w == b" obj"), "must contain ' obj'");
        // Must end with "endobj".
        assert!(raw.ends_with(b"endobj"), "must end with 'endobj'");
    }

    #[test]
    fn raw_object_bytes_error_on_missing_object() {
        let bytes = make_pdf(1);
        let reader = PdfReader::from_bytes(bytes).unwrap();
        assert!(
            reader.raw_object_bytes(99999).is_err(),
            "non-existent object must return Err"
        );
    }

    // ── Parser regression tests ─────────────────────────────────────────────────

    // Regression test for the skip_nested_dict depth-tracking bug:
    // previously checked `depth == 0` before decrementing, which caused the
    // outer dict's closing `>>` to be consumed when a nested dict was present.
    #[test]
    fn parse_dict_bytes_handles_nested_resources_dict() {
        // Simulate a page dict with an inline Resources dict like our writer produces.
        let dict = b"<< /Type /Page /Resources << /Font << >> >> >>";
        let map = parse_dict_bytes(dict).expect("should parse successfully");
        assert_eq!(
            map.get("Type").map(String::as_str),
            Some("/Page"),
            "Type must be /Page, not overwritten by the inner Pages object"
        );
    }

    #[test]
    fn skip_nested_dict_returns_after_matching_close() {
        // The slice after `<<...>>` should be exactly b" tail".
        let data = b"<< /K << >> >> tail";
        let rest = skip_nested_dict(data).expect("should find closing >>");
        assert_eq!(rest, b" tail");
    }
}