lightweight-pdf-writer 0.2.1

Minimal, zero-dependency PDF object/xref/stream writer for lightweight-pdf
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

//! Thin, allocation-light layer directly over PDF object syntax: typed
//! object IDs, dict/stream writing, xref table + trailer. Architecturally
//! modeled after `pdf-writer` (ADR-004) but self-written for zero
//! dependencies and full control over every emitted byte.

/// A PDF indirect object reference (generation is always 0 in V1 — we never
/// rewrite an existing file).
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub struct Ref(pub u32);

impl Ref {
    /// `"N 0 R"` as used inside dictionaries/arrays.
    pub fn write(&self) -> String {
        format!("{} 0 R", self.0)
    }
}

pub struct PdfWriter {
    buf: Vec<u8>,
    /// Byte offset of each object, indexed by `id - 1` (object 0 is the
    /// reserved free-list head and is not stored here).
    offsets: Vec<usize>,
    next_id: u32,
}

impl Default for PdfWriter {
    fn default() -> Self {
        Self::new()
    }
}

impl PdfWriter {
    pub fn new() -> Self {
        let mut buf = Vec::new();
        buf.extend_from_slice(b"%PDF-1.7\n%\xE2\xE3\xCF\xD3\n");
        PdfWriter {
            buf,
            offsets: Vec::new(),
            next_id: 1,
        }
    }

    pub fn alloc(&mut self) -> Ref {
        let id = self.next_id;
        self.next_id += 1;
        Ref(id)
    }

    fn record_offset(&mut self, id: Ref) {
        // `id.0` is a `u32` object id; `usize` is at least 32 bits on every
        // platform this crate targets, so this widening conversion never
        // fails.
        let idx = usize::try_from(id.0 - 1).expect("PDF object ids fit in usize for any realistic document, see round 2 rationale");
        if self.offsets.len() <= idx {
            self.offsets.resize(idx + 1, 0);
        }
        self.offsets[idx] = self.buf.len();
    }

    /// Writes a plain indirect object: `id 0 obj\n<body>\nendobj\n`.
    pub fn object(&mut self, id: Ref, body: &str) {
        self.record_offset(id);
        self.buf.extend_from_slice(format!("{} 0 obj\n", id.0).as_bytes());
        self.buf.extend_from_slice(body.as_bytes());
        self.buf.extend_from_slice(b"\nendobj\n");
    }

    /// Writes an indirect stream object. `dict_extra` are additional
    /// dictionary entries (e.g. `/Length1 1234`); `/Length` is computed and
    /// added automatically. No compression in V1 (see phase-0 notes).
    pub fn stream(&mut self, id: Ref, dict_extra: &str, data: &[u8]) {
        self.record_offset(id);
        self.buf
            .extend_from_slice(format!("{} 0 obj\n<< /Length {} {} >>\nstream\n", id.0, data.len(), dict_extra).as_bytes());
        self.buf.extend_from_slice(data);
        self.buf.extend_from_slice(b"\nendstream\nendobj\n");
    }

    /// Writes the xref table, trailer and `%%EOF`, consuming the writer.
    /// Crate-internal: only [`crate::doc::PdfDocument::write`] calls this —
    /// `PdfWriter` is `PdfDocument`'s implementation detail, not part of
    /// this crate's public surface.
    pub(crate) fn finish(mut self, root: Ref, info: Option<Ref>) -> Vec<u8> {
        let xref_offset = self.buf.len();
        let count = self.next_id; // includes object 0
        self.buf.extend_from_slice(format!("xref\n0 {count}\n").as_bytes());
        self.buf.extend_from_slice(b"0000000000 65535 f \n");
        for i in 0..(count - 1) {
            // `i` is a `u32` object index; `usize` is at least 32 bits on
            // every platform this crate targets, so this widening
            // conversion never fails.
            let idx = usize::try_from(i).expect("PDF object counts fit in usize for any realistic document, see round 2 rationale");
            let offset = *self.offsets.get(idx).unwrap_or(&0);
            self.buf.extend_from_slice(format!("{offset:010} 00000 n \n").as_bytes());
        }
        let info_str = match info {
            Some(r) => format!(" /Info {}", r.write()),
            None => String::new(),
        };
        self.buf.extend_from_slice(
            format!(
                "trailer\n<< /Size {count} /Root {}{info_str} >>\nstartxref\n{xref_offset}\n%%EOF",
                root.write()
            )
            .as_bytes(),
        );
        self.buf
    }
}

/// Formats an `f32` with a fixed, compact precision suitable for PDF
/// content streams (avoids Rust's default float `Display`, which can emit
/// scientific notation or excessive digits).
pub fn fmt_num(v: f32) -> String {
    let rounded = (v * 1000.0).round() / 1000.0;
    let mut s = format!("{rounded:.3}");
    while s.ends_with('0') {
        s.pop();
    }
    if s.ends_with('.') {
        s.pop();
    }
    if s.is_empty() || s == "-" {
        s = "0".to_string();
    }
    s
}

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

    #[test]
    fn produces_a_minimal_valid_structure() {
        let mut w = PdfWriter::new();
        let catalog = w.alloc();
        let pages = w.alloc();
        w.object(pages, "<< /Type /Pages /Kids [] /Count 0 >>");
        w.object(catalog, &format!("<< /Type /Catalog /Pages {} >>", pages.write()));
        let bytes = w.finish(catalog, None);
        let text = String::from_utf8_lossy(&bytes);
        assert!(text.starts_with("%PDF-1.7"));
        assert!(text.contains("trailer"));
        assert!(text.contains("startxref"));
        assert!(text.ends_with("%%EOF"));
    }

    #[test]
    fn fmt_num_is_compact() {
        assert_eq!(fmt_num(12.0), "12");
        assert_eq!(fmt_num(12.5), "12.5");
        assert_eq!(fmt_num(0.0), "0");
        assert_eq!(fmt_num(-3.14149), "-3.141");
    }
}