flpdf 0.9.0

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
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
//! PCLm writer behavior.
//!
//! The PCLm enqueue order itself lives with qpdf's one standard-writer queue
//! in [`crate::writer::plain::body`] (`QPDFWriter::enqueueObjectsPCLm`); this
//! module holds the PCLm-specific regression coverage for the route that
//! queue drives.
//!
//! qpdf correspondence: `QPDFWriter::enqueueObjectsPCLm`.

#[cfg(test)]
mod tests {
    use crate::pipeline::{Pipeline, PipelineError, PipelineResult};
    use crate::token_filter::{TokenFilter, TokenFilterOutput};
    use crate::tokenizer::{Token, TokenType};
    use crate::{Error, ObjectHandle, ObjectRef, Pdf, PdfWriter, Result, StreamDataProvider};
    use std::cell::RefCell;
    use std::io::{self, Cursor, Read, Seek, SeekFrom, Write};
    use std::path::PathBuf;
    use std::process::Command;
    use std::rc::Rc;

    struct ReadFailingCursor {
        inner: Cursor<Vec<u8>>,
        fail_reads: bool,
    }

    impl Read for ReadFailingCursor {
        fn read(&mut self, buffer: &mut [u8]) -> std::io::Result<usize> {
            if self.fail_reads {
                return Err(std::io::Error::other("injected PCLm planner read failure"));
            }
            self.inner.read(buffer)
        }
    }

    impl Seek for ReadFailingCursor {
        fn seek(&mut self, position: SeekFrom) -> std::io::Result<u64> {
            self.inner.seek(position)
        }
    }

    fn fixture_pdf() -> Pdf<Cursor<Vec<u8>>> {
        Pdf::open(Cursor::new(
            include_bytes!("../../../../tests/fixtures/compat/three-page.pdf").to_vec(),
        ))
        .expect("fixture must open")
    }

    fn one_page_fixture_pdf() -> Pdf<Cursor<Vec<u8>>> {
        Pdf::open(Cursor::new(
            include_bytes!("../../../../tests/fixtures/compat/one-page.pdf").to_vec(),
        ))
        .expect("one-page fixture must open")
    }

    fn one_page_fixture_with_unplanned_trailer_refs() -> Pdf<Cursor<Vec<u8>>> {
        let mut pdf = one_page_fixture_pdf();
        let probe = pdf
            .make_indirect_from_object_handle(ObjectHandle::string(b"unreachable".to_vec()))
            .expect("allocate the trailer-only object");
        assert_eq!(probe.object_ref(), Some(ObjectRef::new(8, 0)));
        pdf.trailer()
            .replace_key(b"/Probe", probe.clone())
            .expect("add a live trailer reference");
        pdf.trailer()
            .replace_key(b"/ProbeAgain", probe)
            .expect("add a repeated live trailer reference");
        pdf
    }

    #[derive(Clone)]
    struct Events(Rc<RefCell<Vec<&'static str>>>);

    impl Events {
        fn new() -> Self {
            Self(Rc::new(RefCell::new(Vec::new())))
        }

        fn record(&self, event: &'static str) {
            self.0.borrow_mut().push(event);
        }

        fn snapshot(&self) -> Vec<&'static str> {
            self.0.borrow().clone()
        }
    }

    struct EventProvider {
        event: &'static str,
        payload: &'static [u8],
        events: Events,
    }

    struct SuccessfulUnfilteredRetryProvider {
        calls: Rc<RefCell<Vec<(bool, bool)>>>,
    }

    struct PassThroughFilter;

    impl TokenFilter for PassThroughFilter {
        fn handle_token(
            &mut self,
            token: &Token,
            output: &mut TokenFilterOutput<'_>,
        ) -> PipelineResult<()> {
            output.write_token(token)
        }
    }

    impl StreamDataProvider for SuccessfulUnfilteredRetryProvider {
        fn supports_retry(&self) -> bool {
            true
        }

        fn provide_stream_data_with_retry_by_id(
            &self,
            _object_number: u32,
            _generation: u16,
            pipeline: &mut dyn Pipeline,
            suppress_warnings: bool,
            will_retry: bool,
        ) -> crate::Result<bool> {
            self.calls
                .borrow_mut()
                .push((suppress_warnings, will_retry));
            pipeline
                .write(b"PCLm-unfiltered-success")
                .map_err(Error::from)?;
            pipeline.finish().map_err(Error::from)?;
            Ok(true)
        }
    }

    impl StreamDataProvider for EventProvider {
        fn provide_stream_data_by_id(
            &self,
            _object_number: u32,
            _generation: u16,
            pipeline: &mut dyn Pipeline,
        ) -> crate::Result<()> {
            self.events.record(self.event);
            pipeline.write(self.payload).map_err(Error::from)?;
            pipeline.finish().map_err(Error::from)
        }
    }

    struct SegmentFailureProvider {
        events: Events,
    }

    struct SegmentFailure<'a> {
        next: &'a mut dyn Pipeline,
    }

    impl Pipeline for SegmentFailure<'_> {
        fn identifier(&self) -> &str {
            "PCLm provider segment"
        }

        fn write(&mut self, data: &[u8]) -> PipelineResult<()> {
            self.next.write(data)
        }

        fn finish(&mut self) -> PipelineResult<()> {
            Err(PipelineError::runtime(
                "PCLm provider segment finish failure",
            ))
        }
    }

    impl StreamDataProvider for SegmentFailureProvider {
        fn provide_stream_data_by_id(
            &self,
            _object_number: u32,
            _generation: u16,
            pipeline: &mut dyn Pipeline,
        ) -> crate::Result<()> {
            self.events.record("provider:A");
            let mut segment = SegmentFailure { next: pipeline };
            assert_eq!(segment.identifier(), "PCLm provider segment");
            segment.write(b"PCLm-provider-A").map_err(Error::from)?;
            segment.finish().map_err(Error::from)
        }
    }

    struct EventWriter {
        events: Events,
        bytes: Rc<RefCell<Vec<u8>>>,
    }

    impl Write for EventWriter {
        fn write(&mut self, data: &[u8]) -> io::Result<usize> {
            self.events.record("sink-write");
            self.bytes.borrow_mut().extend_from_slice(data);
            Ok(data.len())
        }

        fn flush(&mut self) -> io::Result<()> {
            Ok(())
        }
    }

    struct PayloadRejectingWriter {
        events: Events,
    }

    impl Write for PayloadRejectingWriter {
        fn write(&mut self, data: &[u8]) -> io::Result<usize> {
            if data
                .windows(b"PCLm-provider-A".len())
                .any(|window| window == b"PCLm-provider-A")
            {
                self.events.record("sink-error:A");
                return Err(io::Error::other("PCLm sink rejected provider A"));
            }
            Ok(data.len())
        }

        fn flush(&mut self) -> io::Result<()> {
            Ok(())
        }
    }

    struct FinishRejectingPipeline {
        events: Events,
    }

    #[test]
    fn pass_through_filter_forwards_a_token_to_its_pipeline_output() {
        let mut buffer = crate::pipeline::buffer::Buffer::new("PCLm token buffer", None);
        let mut output = TokenFilterOutput::new(Some(&mut buffer));
        let mut filter = PassThroughFilter;
        let token = Token::new(TokenType::Word, b"Do".to_vec());

        {
            filter
                .handle_token(&token, &mut output)
                .expect("pass-through filter forwards the token");
        }
        buffer.finish().expect("token buffer finish");
        assert_eq!(buffer.take_buffer().expect("token bytes"), b"Do");
    }

    impl Pipeline for FinishRejectingPipeline {
        fn identifier(&self) -> &str {
            "PCLm final sink"
        }

        fn write(&mut self, _data: &[u8]) -> PipelineResult<()> {
            Ok(())
        }

        fn finish(&mut self) -> PipelineResult<()> {
            self.events.record("sink-finish-error");
            Err(PipelineError::runtime("PCLm final sink finish failure"))
        }
    }

    fn provider_stream(
        pdf: &Pdf<Cursor<Vec<u8>>>,
        provider: impl StreamDataProvider + 'static,
    ) -> ObjectHandle {
        let stream = pdf.new_stream().expect("create PCLm provider stream");
        stream
            .replace_stream_data_provider(Rc::new(provider), None, None)
            .expect("register PCLm provider");
        stream
    }

    fn attach_root_streams(
        pdf: &mut Pdf<Cursor<Vec<u8>>>,
        first: ObjectHandle,
        second: ObjectHandle,
    ) {
        let root = pdf.root_handle().expect("resolve PCLm Catalog");
        root.replace_key(b"/PclmProviderA", first)
            .expect("attach first PCLm provider");
        root.replace_key(b"/PclmProviderB", second)
            .expect("attach second PCLm provider");
    }

    fn configure_pclm_writer<'pdf>(
        pdf: &'pdf mut Pdf<Cursor<Vec<u8>>>,
    ) -> PdfWriter<'pdf, Cursor<Vec<u8>>> {
        let mut writer = PdfWriter::new(pdf);
        writer.set_pclm(true);
        writer.set_static_id(true);
        writer
    }

    /// Drive the PCLm route the way a caller does, returning the emitted
    /// bytes or the first writer error.
    fn write_pclm_bytes<R: std::io::Read + Seek + 'static>(pdf: &mut Pdf<R>) -> Result<Vec<u8>> {
        let mut writer = PdfWriter::new(pdf);
        writer.set_pclm(true);
        writer.set_static_id(true);
        writer.set_output_memory()?;
        writer.write()?;
        writer.get_buffer()
    }

    fn exact_qpdf_11_9() -> bool {
        Command::new("qpdf")
            .arg("--version")
            .output()
            .ok()
            .and_then(|output| {
                String::from_utf8(output.stdout)
                    .ok()
                    .and_then(|stdout| stdout.lines().next().map(str::to_owned))
            })
            .is_some_and(|line| line == "qpdf version 11.9.0")
    }

    fn pinned_qpdf_source_from(command: &std::path::Path) -> Option<PathBuf> {
        let output = Command::new(command).arg("--print-path").output().ok()?;
        if !output.status.success() {
            return None;
        }
        let path = String::from_utf8(output.stdout).ok()?;
        Some(PathBuf::from(path.trim()))
    }

    fn pinned_qpdf_source() -> Option<PathBuf> {
        let workspace = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../..");
        pinned_qpdf_source_from(&workspace.join("scripts/fetch-qpdf-source.sh"))
    }

    fn oracle_source_for(
        label: &str,
        qpdf_available: bool,
        source: Option<PathBuf>,
    ) -> Option<PathBuf> {
        if !qpdf_available {
            eprintln!("qpdf 11.9.0 is unavailable; skipping {label} oracle");
            return None;
        }
        let Some(source) = source else {
            eprintln!("pinned qpdf source is unavailable; skipping {label} oracle");
            return None;
        };
        Some(source)
    }

    fn pclm_oracle_source(label: &str) -> Option<PathBuf> {
        let qpdf_available = exact_qpdf_11_9();
        let source = qpdf_available.then(pinned_qpdf_source).flatten();
        oracle_source_for(label, qpdf_available, source)
    }

    fn first_page_content(path: &std::path::Path) -> Vec<u8> {
        let pages = Command::new("qpdf")
            .arg("--show-pages")
            .arg(path)
            .output()
            .expect("inspect page content references");
        let pages_error = format!(
            "qpdf --show-pages failed: {}",
            String::from_utf8_lossy(&pages.stderr)
        );
        assert!(pages.status.success(), "{pages_error}");
        let pages = String::from_utf8(pages.stdout).expect("qpdf page listing is UTF-8");
        let content = pages
            .split_once("  content:\n")
            .and_then(|(_, rest)| rest.lines().next())
            .expect("qpdf page listing has a content stream");
        let object = content
            .split_whitespace()
            .next()
            .expect("content stream has an object number");
        let stream = Command::new("qpdf")
            .arg(format!("--show-object={object}"))
            .arg("--raw-stream-data")
            .arg(path)
            .output()
            .expect("read qpdf content stream");
        let stream_error = format!(
            "qpdf --show-object failed: {}",
            String::from_utf8_lossy(&stream.stderr)
        );
        assert!(stream.status.success(), "{stream_error}");
        stream.stdout
    }

    #[test]
    fn pclm_oracle_helpers_cover_unavailable_and_failed_command_paths() {
        assert!(oracle_source_for("test", false, Some(PathBuf::from("/tmp/source"))).is_none());
        assert!(oracle_source_for("test", true, None).is_none());
        let source = PathBuf::from("/tmp/source");
        assert_eq!(
            oracle_source_for("test", true, Some(source.clone())),
            Some(source)
        );
        assert!(pinned_qpdf_source_from(std::path::Path::new("/bin/false")).is_none());
    }

    /// qpdf's PCLm seed enqueues pages, their contents, their strips, one
    /// image-transform stream per strip, and finally `/Root`
    /// (`QPDFWriter::enqueueObjectsPCLm`, `libqpdf/QPDFWriter.cc:2927-2955`).
    /// A Catalog child is not part of that seed: it is discovered when the
    /// Catalog itself is unparsed, so it is numbered after every seeded
    /// object.
    #[test]
    fn pclm_catalog_child_is_numbered_after_the_initial_enqueue() {
        let mut pdf = one_page_fixture_pdf();
        let child = pdf
            .make_indirect_from_object_handle(ObjectHandle::string(b"late-child".to_vec()))
            .expect("allocate a Catalog child");
        pdf.root_handle()
            .expect("resolve Catalog")
            .replace_key(b"/LateChild", child)
            .expect("attach Catalog child");

        let mut writer = configure_pclm_writer(&mut pdf);
        writer.set_output_memory().expect("install memory output");
        writer.write().expect("write PCLm output");
        let output = writer.get_buffer().expect("PCLm output bytes");
        let output = String::from_utf8_lossy(&output);

        // The one-page fixture seeds page, contents, and Catalog, so the
        // Catalog is object 3. Everything numbered above 3 was discovered
        // while a seeded object was unparsed: the page's own children first,
        // then the Catalog's.
        let catalog = output
            .split_once("\n3 0 obj\n")
            .expect("PCLm Catalog is the last seeded object")
            .1;
        assert!(
            catalog.starts_with("<< /LateChild 6 0 R"),
            "a Catalog child belongs to emission-time discovery: {catalog:.120}"
        );
        assert!(
            output.contains("\n6 0 obj\n(late-child)\nendobj\n"),
            "the discovered child is appended to the same queue: {output}"
        );
    }

    #[test]
    fn pclm_reaches_the_final_sink_before_requesting_the_next_provider() {
        let events = Events::new();
        let bytes = Rc::new(RefCell::new(Vec::new()));
        let mut pdf = one_page_fixture_pdf();
        let first = provider_stream(
            &pdf,
            EventProvider {
                event: "provider:A",
                payload: b"PCLm-provider-A",
                events: events.clone(),
            },
        );
        let second = provider_stream(
            &pdf,
            EventProvider {
                event: "provider:B",
                payload: b"PCLm-provider-B",
                events: events.clone(),
            },
        );
        attach_root_streams(&mut pdf, first, second);

        let mut writer = configure_pclm_writer(&mut pdf);
        writer
            .set_output_writer(EventWriter {
                events: events.clone(),
                bytes: Rc::clone(&bytes),
            })
            .expect("install PCLm event sink");
        writer.write().expect("PCLm writer succeeds");

        assert!(!bytes.borrow().is_empty());
        let events = events.snapshot();
        let provider_a = events
            .iter()
            .position(|event| *event == "provider:A")
            .expect("provider A event");
        let provider_b = events
            .iter()
            .position(|event| *event == "provider:B")
            .expect("provider B event");
        assert!(
            events[provider_a + 1..provider_b].contains(&"sink-write"),
            "PCLm must emit A before requesting B; events: {events:?}"
        );
    }

    #[test]
    fn pclm_forced_uncompressed_successful_first_call_retries_on_filter_result() {
        let mut pdf = one_page_fixture_pdf();
        let calls = Rc::new(RefCell::new(Vec::new()));
        let stream = provider_stream(
            &pdf,
            SuccessfulUnfilteredRetryProvider {
                calls: Rc::clone(&calls),
            },
        );
        stream
            .add_token_filter(Rc::new(RefCell::new(PassThroughFilter)))
            .expect("mark the provider stream as modified");
        pdf.root_handle()
            .expect("resolve Catalog")
            .replace_key(b"/PclmProvider", stream)
            .expect("attach PCLm provider");

        let mut writer = configure_pclm_writer(&mut pdf);
        writer.set_output_memory().expect("install memory output");
        writer
            .write()
            .expect("PCLm raw retry after an unfiltered success");

        assert_eq!(*calls.borrow(), vec![(false, true), (false, false)]);
    }

    #[test]
    fn pclm_progress_failure_happens_before_current_object_bytes_reach_sink() {
        let events = Events::new();
        let bytes = Rc::new(RefCell::new(Vec::new()));
        let mut pdf = one_page_fixture_pdf();
        let mut writer = configure_pclm_writer(&mut pdf);
        writer
            .set_output_writer(EventWriter {
                events,
                bytes: Rc::clone(&bytes),
            })
            .expect("install PCLm event sink");
        writer.register_progress_reporter(Box::new(|percent| {
            assert_eq!(percent, 0);
            Err(Error::System("PCLm progress failure".to_owned()))
        }));

        let error = writer
            .write()
            .expect_err("PCLm progress failure must escape before object output");

        assert!(error.to_string().contains("PCLm progress failure"));
        let bytes = bytes.borrow();
        assert!(bytes.starts_with(b"%PDF-"));
        assert!(
            !bytes
                .windows(b"1 0 obj\n".len())
                .any(|window| window == b"1 0 obj\n"),
            "progress failure must not leave the current PCLm object in the sink"
        );
    }

    #[test]
    fn pclm_content_normalization_matches_qpdf_11_9() {
        if let Some(source) = pclm_oracle_source("PCLm normalization") {
            let input = source.join("qpdf/qtest/qpdf/good7.pdf");
            let temporary = tempfile::tempdir().expect("PCLm normalization tempdir");
            let normalized = temporary.path().join("qpdf-normalized.pdf");
            let qpdf = Command::new("qpdf")
                .args([
                    "--normalize-content=y",
                    "--stream-data=uncompress",
                    "--object-streams=disable",
                    "--static-id",
                ])
                .arg(&input)
                .arg(&normalized)
                .output()
                .expect("run qpdf content normalization");
            let qpdf_error = format!(
                "qpdf normalization failed: {}",
                String::from_utf8_lossy(&qpdf.stderr)
            );
            assert!(qpdf.status.success(), "{qpdf_error}");

            let mut pdf = Pdf::open(Cursor::new(
                std::fs::read(&input).expect("read qpdf normalization input"),
            ))
            .expect("open qpdf normalization input");
            let mut writer = PdfWriter::new(&mut pdf);
            writer.set_pclm(true);
            writer.set_content_normalization(true);
            writer.set_static_id(true);
            writer
                .set_output_memory()
                .expect("install PCLm memory output");
            writer.write().expect("write normalized PCLm output");
            let actual = writer.get_buffer().expect("read normalized PCLm output");
            let actual_path = temporary.path().join("pclm-normalized.pdf");
            std::fs::write(&actual_path, actual).expect("write PCLm normalization output");

            assert_eq!(
                first_page_content(&actual_path),
                first_page_content(&normalized),
                "PCLm page content normalization must match qpdf 11.9.0"
            );
        } // cov:ignore: LLVM maps the covered PCLm normalization branch exit to this line
    }

    #[test]
    fn pclm_filtering_disabled_false_uses_the_first_retryable_attempt_once() {
        let mut pdf = one_page_fixture_pdf();
        let calls = Rc::new(RefCell::new(Vec::new()));
        let calls_for_provider = Rc::clone(&calls);
        let stream = pdf.new_stream().expect("create retry-aware PCLm stream");
        stream
            .replace_stream_data_with_retry_callback(
                move |pipeline, suppress_warnings, will_retry| {
                    calls_for_provider
                        .borrow_mut()
                        .push((suppress_warnings, will_retry));
                    pipeline
                        .write(b"PCLm-disabled-filter")
                        .map_err(Error::from)?;
                    pipeline.finish().map_err(Error::from)?;
                    Ok(false)
                },
                None,
                None,
            )
            .expect("register retry-aware PCLm stream");
        stream
            .set_filter_on_write(false)
            .expect("disable filtering on PCLm stream");
        pdf.root_handle()
            .expect("resolve Catalog")
            .replace_key(b"/PclmProvider", stream)
            .expect("attach PCLm provider");

        let mut writer = configure_pclm_writer(&mut pdf);
        writer.set_output_memory().expect("install memory output");
        writer
            .write()
            .expect("filter-disabled false keeps the first source buffer");
        let output = writer.get_buffer().expect("PCLm memory output");

        assert_eq!(*calls.borrow(), vec![(false, true)]);
        assert!(output
            .windows(b"PCLm-disabled-filter".len())
            .any(|window| window == b"PCLm-disabled-filter"));
    }

    #[test]
    fn pclm_recoverable_filter_failure_retries_only_the_same_stream() {
        let mut pdf = one_page_fixture_pdf();
        let calls = Rc::new(RefCell::new(Vec::new()));
        let calls_for_provider = Rc::clone(&calls);
        let stream = pdf.new_stream().expect("create retry-aware PCLm stream");
        stream
            .replace_stream_data_with_retry_callback(
                move |pipeline, suppress_warnings, will_retry| {
                    calls_for_provider
                        .borrow_mut()
                        .push((suppress_warnings, will_retry));
                    if will_retry {
                        return Ok(false);
                    }
                    pipeline.write(b"PCLm-retry-payload").map_err(Error::from)?;
                    pipeline.finish().map_err(Error::from)?;
                    Ok(true)
                },
                None,
                None,
            )
            .expect("register retry-aware PCLm stream");
        stream
            .add_token_filter(Rc::new(RefCell::new(PassThroughFilter)))
            .expect("mark the retrying stream as modified");
        pdf.root_handle()
            .expect("resolve Catalog")
            .replace_key(b"/PclmProvider", stream)
            .expect("attach PCLm provider");

        let mut writer = configure_pclm_writer(&mut pdf);
        writer.set_output_memory().expect("install memory output");
        writer.write().expect("PCLm raw retry succeeds");

        assert_eq!(*calls.borrow(), vec![(false, true), (false, false)]);
        assert!(writer
            .get_buffer()
            .expect("PCLm memory output")
            .windows(b"PCLm-retry-payload".len())
            .any(|window| window == b"PCLm-retry-payload"));
    }

    #[test]
    fn pclm_provider_segment_failure_never_requests_a_later_provider() {
        let events = Events::new();
        let mut pdf = one_page_fixture_pdf();
        let first = provider_stream(
            &pdf,
            SegmentFailureProvider {
                events: events.clone(),
            },
        );
        let second = provider_stream(
            &pdf,
            EventProvider {
                event: "provider:B",
                payload: b"PCLm-provider-B",
                events: events.clone(),
            },
        );
        attach_root_streams(&mut pdf, first, second);

        let mut writer = configure_pclm_writer(&mut pdf);
        writer.set_output_memory().expect("install memory output");
        let error = writer
            .write()
            .expect_err("PCLm provider segment failure must escape");

        assert!(error
            .to_string()
            .contains("PCLm provider segment finish failure"));
        assert_eq!(events.snapshot(), vec!["provider:A"]);
    }

    #[test]
    fn pclm_sink_write_failure_never_requests_a_later_provider() {
        let events = Events::new();
        let mut pdf = one_page_fixture_pdf();
        let first = provider_stream(
            &pdf,
            EventProvider {
                event: "provider:A",
                payload: b"PCLm-provider-A",
                events: events.clone(),
            },
        );
        let second = provider_stream(
            &pdf,
            EventProvider {
                event: "provider:B",
                payload: b"PCLm-provider-B",
                events: events.clone(),
            },
        );
        attach_root_streams(&mut pdf, first, second);

        let mut writer = configure_pclm_writer(&mut pdf);
        writer
            .set_output_writer(PayloadRejectingWriter {
                events: events.clone(),
            })
            .expect("install rejecting PCLm sink");
        let error = writer.write().expect_err("PCLm sink failure must escape");

        assert!(error.to_string().contains("PCLm sink rejected provider A"));
        let events = events.snapshot();
        assert!(events.contains(&"provider:A"));
        assert!(events.contains(&"sink-error:A"));
        assert!(
            !events.contains(&"provider:B"),
            "a terminal PCLm sink failure must stop the live queue: {events:?}"
        );
    }

    #[test]
    fn pclm_final_sink_finish_failure_never_requests_a_later_provider() {
        let events = Events::new();
        let mut pdf = one_page_fixture_pdf();
        let page = crate::pages::page_refs(&mut pdf).expect("PCLm page refs")[0];
        pdf.get_object_handle(page)
            .replace_key(b"/Contents", ObjectHandle::null())
            .expect("remove the fixture content stream");
        let first = provider_stream(
            &pdf,
            EventProvider {
                event: "provider:A",
                payload: b"PCLm-provider-A",
                events: events.clone(),
            },
        );
        let second = provider_stream(
            &pdf,
            EventProvider {
                event: "provider:B",
                payload: b"PCLm-provider-B",
                events: events.clone(),
            },
        );
        attach_root_streams(&mut pdf, first, second);

        let mut writer = configure_pclm_writer(&mut pdf);
        let final_sink = FinishRejectingPipeline {
            events: events.clone(),
        };
        assert_eq!(final_sink.identifier(), "PCLm final sink");
        writer
            .set_output_pipeline(final_sink)
            .expect("install finish-rejecting PCLm pipeline");
        let error = writer
            .write()
            .expect_err("PCLm final sink finish failure must escape");

        assert!(error.to_string().contains("PCLm final sink finish failure"));
        let events = events.snapshot();
        assert!(events.contains(&"provider:A"));
        assert!(events.contains(&"sink-finish-error"));
        assert!(
            !events.contains(&"provider:B"),
            "a PCLm segment finish failure must stop the live queue: {events:?}"
        );
    }

    #[test]
    fn pclm_static_id_bytes_and_check_exit_match_qpdf_11_9() {
        if let Some(source) = pclm_oracle_source("PCLm byte") {
            let fixture = source.join("qpdf/qtest/qpdf/pclm-in.pdf");
            let oracle = source.join("qpdf/qtest/qpdf/pclm-out.pdf");
            let mut pdf = Pdf::open(Cursor::new(
                std::fs::read(&fixture).expect("read qpdf PCLm input"),
            ))
            .expect("open qpdf PCLm input");
            let mut writer = configure_pclm_writer(&mut pdf);
            writer.set_output_memory().expect("install memory output");
            writer.write().expect("write qpdf PCLm fixture");
            let actual = writer.get_buffer().expect("PCLm output bytes");
            let expected = std::fs::read(&oracle).expect("read qpdf 11.9.0 PCLm output");

            assert_eq!(actual, expected, "PCLm output must be byte-identical");

            let temporary = tempfile::tempdir().expect("PCLm oracle tempdir");
            let actual_path = temporary.path().join("actual.pdf");
            std::fs::write(&actual_path, &actual).expect("write PCLm output for qpdf check");
            let actual_check = Command::new("qpdf")
                .arg("--check")
                .arg(&actual_path)
                .output()
                .expect("check flpdf PCLm output");
            let oracle_check = Command::new("qpdf")
                .arg("--check")
                .arg(&oracle)
                .output()
                .expect("check qpdf PCLm output");
            assert_eq!(
                actual_check.status.code(),
                oracle_check.status.code(),
                "flpdf and qpdf PCLm outputs must have the same qpdf --check exit"
            );
            assert!(actual_check.status.success());
        } // cov:ignore: LLVM attributes the covered qpdf-check success branch to the nested assertion.
    }

    #[test]
    fn pclm_deterministic_id_output_is_repeatable_and_qpdf_readable() {
        fn write() -> Vec<u8> {
            let mut pdf = one_page_fixture_pdf();
            let mut writer = PdfWriter::new(&mut pdf);
            writer.set_pclm(true);
            writer.set_deterministic_id(true);
            writer.set_output_memory().expect("install memory output");
            writer.write().expect("write deterministic PCLm output");
            writer.get_buffer().expect("deterministic PCLm bytes")
        }

        let first = write();
        let second = write();
        assert_eq!(first, second, "PCLm deterministic IDs must be repeatable");

        if exact_qpdf_11_9() {
            let temporary = tempfile::tempdir().expect("deterministic PCLm tempdir");
            let output = temporary.path().join("deterministic-pclm.pdf");
            std::fs::write(&output, first).expect("write deterministic PCLm output");
            let check = Command::new("qpdf")
                .arg("--check")
                .arg(output)
                .output()
                .expect("check deterministic PCLm output");
            let check_error = format!(
                "qpdf rejected deterministic PCLm output: {}",
                String::from_utf8_lossy(&check.stderr)
            );
            assert!(check.status.success(), "{check_error}");
        } // cov:ignore: LLVM attributes the covered exact-qpdf branch exit to the assertion above.
    }

    #[test]
    fn pclm_reports_qpdf_dictionary_error_for_a_missing_root() {
        let mut pdf = Pdf::open(Cursor::new(
            b"%PDF-1.3\nxref\n0 1\n0000000000 65535 f \ntrailer\n<< /Size 1 >>\n\
              startxref\n9\n%%EOF\n"
                .to_vec(),
        ))
        .expect("rootless fixture must open");

        let error = write_pclm_bytes(&mut pdf).expect_err("PCLm requires a trailer /Root");
        assert_eq!(error.to_string(), "unable to find /Root dictionary");
    }

    #[test]
    fn pclm_reports_qpdf_dictionary_error_for_an_indirect_null_root() {
        let mut bytes = b"%PDF-1.3\n".to_vec();
        let object_offset = bytes.len();
        bytes.extend_from_slice(b"1 0 obj\nnull\nendobj\n");
        let xref_offset = bytes.len();
        bytes.extend_from_slice(
            format!("xref\n0 2\n0000000000 65535 f \n{object_offset:010} 00000 n \n").as_bytes(),
        );
        bytes.extend_from_slice(
            format!("trailer\n<< /Size 2 /Root 1 0 R >>\nstartxref\n{xref_offset}\n%%EOF\n")
                .as_bytes(),
        );
        let mut pdf = Pdf::open(Cursor::new(bytes)).expect("indirect-null-root fixture must open");

        let error =
            write_pclm_bytes(&mut pdf).expect_err("an indirect null Root is not a dictionary");
        assert_eq!(error.to_string(), "unable to find /Root dictionary");
    }

    #[test]
    fn pclm_seeds_a_non_page_kids_leaf_like_qpdf() {
        let mut pdf = fixture_pdf();
        let page = crate::pages::page_refs(&mut pdf).unwrap()[0];
        pdf.replace_object(page, ObjectHandle::integer(42))
            .expect("replace page with a scalar through the canonical route");

        let output = write_pclm_bytes(&mut pdf).expect("a scalar page leaf is seeded like qpdf");
        let output = String::from_utf8_lossy(&output);

        // qpdf's `getAllPagesInternal` treats any `/Kids` entry without
        // `/Kids` as a page leaf, scalar or not (`libqpdf/QPDF_pages.cc:91-131`),
        // and the PCLm seed numbers the first page object first.
        assert!(
            output.contains("\n1 0 obj\n42\nendobj"),
            "a scalar leaf is seeded as the first PCLm page: {output}"
        );
    }

    #[test]
    fn pclm_propagates_page_contents_resolution_errors() {
        let mut pdf = Pdf::open(ReadFailingCursor {
            inner: Cursor::new(
                include_bytes!("../../../../tests/fixtures/compat/three-page.pdf").to_vec(),
            ),
            fail_reads: false,
        })
        .expect("fixture must open");
        let page = crate::pages::page_refs(&mut pdf).unwrap()[0];
        let page_handle = pdf.get_object_handle(page);
        page_handle.try_is_scalar().unwrap();
        let replacement = page_handle
            .shallow_copy()
            .expect("page dictionary must be shallow-copyable");
        let contents = ObjectHandle::dictionary(vec![(
            b"/Broken".to_vec(),
            pdf.get_object_handle(ObjectRef::new(11, 0)),
        )]);
        replacement
            .replace_key(b"/Contents", contents)
            .expect("replace page contents through the canonical route");
        pdf.replace_object(page, replacement)
            .expect("replace page through the canonical route");
        pdf.resolver
            .with_reader_mut(|reader| reader.fail_reads = true);

        assert!(write_pclm_bytes(&mut pdf).is_err());
    }

    #[test]
    fn pclm_enqueues_xobject_and_its_synthetic_transform() {
        let mut pdf = fixture_pdf();
        let page = crate::pages::page_refs(&mut pdf).unwrap()[0];
        let page_handle = pdf.get_object_handle(page);
        page_handle.try_is_scalar().unwrap();
        let replacement = page_handle
            .shallow_copy()
            .expect("page dictionary must be shallow-copyable");
        let image = pdf
            .new_stream_with_data(std::rc::Rc::new(b"image".to_vec()))
            .expect("create image stream through the canonical route");
        let xobjects = ObjectHandle::dictionary(vec![(b"/Im0".to_vec(), image)]);
        let resources = ObjectHandle::dictionary(vec![(b"/XObject".to_vec(), xobjects)]);
        let contents =
            ObjectHandle::dictionary(vec![(b"/Marker".to_vec(), ObjectHandle::integer(1))]);
        replacement
            .replace_key(b"/Resources", resources)
            .expect("replace page resources through the canonical route");
        replacement
            .replace_key(b"/Contents", contents)
            .expect("replace page contents through the canonical route");
        pdf.replace_object(page, replacement)
            .expect("replace page through the canonical route");

        let output = write_pclm_bytes(&mut pdf).expect("XObject PCLm output");

        assert!(
            String::from_utf8_lossy(&output).contains("q /image Do Q\n"),
            "each strip is followed by its image-transform stream"
        );
    }

    #[test]
    fn writer_emits_unplanned_trailer_refs_with_qpdf_late_numbers() {
        let mut pdf = one_page_fixture_with_unplanned_trailer_refs();

        let mut writer = PdfWriter::new(&mut pdf);
        writer.set_pclm(true);
        writer.set_deterministic_id(true);
        writer.set_output_memory().expect("install memory output");
        writer.write().expect("qpdf-compatible PCLm output");
        let output = writer.get_buffer().expect("PCLm output bytes");
        let output = String::from_utf8_lossy(&output);
        assert!(output.contains("xref\n0 7\n"));
        assert!(output.contains("/Info 7 0 R"));
        assert!(output.contains("/Probe 8 0 R"));
        assert!(output.contains("/ProbeAgain 8 0 R"));
        assert!(!output.contains("7 0 obj\n"));
        assert!(!output.contains("8 0 obj\n"));
    }

    #[test]
    fn writer_emits_unplanned_trailer_refs_with_generated_id() {
        let mut pdf = one_page_fixture_with_unplanned_trailer_refs();
        let mut writer = PdfWriter::new(&mut pdf);
        writer.set_pclm(true);
        writer.set_output_memory().expect("install memory output");
        writer.write().expect("qpdf-compatible PCLm output");
        let output = writer.get_buffer().expect("PCLm output bytes");
        let output = String::from_utf8_lossy(&output);
        assert!(output.contains("/Info 7 0 R"));
        assert!(output.contains("/Probe 8 0 R"));
        assert!(output.contains("/ProbeAgain 8 0 R"));
        assert!(!output.contains("7 0 obj\n"));
        assert!(!output.contains("8 0 obj\n"));
    }
}