inkhaven 1.3.3

Inkhaven — TUI literary work editor for Typst books
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

//! 1.3.0 PDF-1 P1 — imposition preview (RFC App. D).  Pure: a summary of
//! the plan (signatures / sheets / blanks / creep) plus the first sheet's
//! schematic, rendered to text lines the `Ctrl+B I` overlay (and any
//! dry-run) display.

use super::super::geometry::{pt_to_mm, Size};
use super::layout::{self, Sheet, Slot};
use super::marks::MarkConfig;
use super::{BindingStyle, CreepStrategy, ImpositionParams};

/// Everything the preview shows, computed from the plan.
#[derive(Debug, Clone)]
pub struct ImpositionPreview {
    pub profile: String,
    pub source_pages: usize,
    pub style: BindingStyle,
    pub signature_pages: usize,
    pub sheets_per_signature: usize,
    pub signatures: usize,
    pub total_sheets: usize,
    pub imposed_pages: usize,
    pub blanks: usize,
    pub sheet_size: Size,
    pub paper_thickness_mm: f32,
    pub creep: CreepStrategy,
    pub max_creep_mm: f32,
    pub marks: MarkConfig,
    pub first_sheet: Option<Sheet>,
}

pub fn build(profile: &str, source_pages: usize, params: &ImpositionParams) -> ImpositionPreview {
    let l = layout::plan(
        params.style,
        params.sheets_per_signature,
        source_pages,
        params.blank,
    );
    let total_sheets = l.sheets.len();
    let max_creep = super::creep::max_creep_mm(
        params.creep,
        l.sheets_per_signature,
        params.paper_thickness_mm,
    );
    ImpositionPreview {
        profile: profile.to_string(),
        source_pages,
        style: params.style,
        signature_pages: l.sheets_per_signature * if params.style.is_folded() { 4 } else { 2 },
        sheets_per_signature: l.sheets_per_signature,
        signatures: l.signatures,
        total_sheets,
        imposed_pages: total_sheets * 2,
        blanks: l.padded_pages.saturating_sub(l.source_pages),
        sheet_size: params.sheet_size,
        paper_thickness_mm: params.paper_thickness_mm,
        creep: params.creep,
        max_creep_mm: max_creep,
        marks: params.marks,
        first_sheet: l.sheets.into_iter().next(),
    }
}

impl ImpositionPreview {
    /// The preview body as text lines (RFC App. D).
    pub fn lines(&self) -> Vec<String> {
        let mut v = vec![
            format!("Profile        : {}", self.profile),
            format!("Source pages   : {}", self.source_pages),
            format!("Style          : {}", style_name(self.style)),
        ];
        if self.style.is_folded() {
            v.push(format!(
                "Signature      : {} pages ({} sheet{})",
                self.signature_pages,
                self.sheets_per_signature,
                plural(self.sheets_per_signature),
            ));
        }
        v.push(format!(
            "Signatures     : {}  ({} imposed page{}, +{} blank{})",
            self.signatures,
            self.imposed_pages,
            plural(self.imposed_pages),
            self.blanks,
            plural(self.blanks),
        ));
        v.push(format!(
            "Sheet size     : {:.0} × {:.0} pt  ({:.0} × {:.0} mm)",
            self.sheet_size.width,
            self.sheet_size.height,
            pt_to_mm(self.sheet_size.width),
            pt_to_mm(self.sheet_size.height),
        ));
        v.push(format!(
            "Paper / creep  : {:.2} mm · {}",
            self.paper_thickness_mm,
            creep_desc(self.creep, self.max_creep_mm),
        ));
        v.push(format!("Marks          : {}", marks_desc(&self.marks)));
        if let Some(sheet) = &self.first_sheet {
            v.push(String::new());
            v.push("Sheet 1 (signature 1, outermost):".to_string());
            v.push(format!("  Front: {}", fmt_side(&sheet.front)));
            v.push(format!("  Back:  {}", fmt_side(&sheet.back)));
        }
        v
    }
}

fn fmt_side(side: &[Slot]) -> String {
    side.iter()
        .map(|s| match s.page {
            Some(p) => format!("[{p:>4} ]"),
            None => "[  —  ]".to_string(),
        })
        .collect::<Vec<_>>()
        .join("")
}

fn style_name(s: BindingStyle) -> &'static str {
    match s {
        BindingStyle::SaddleStitch => "saddle-stitch",
        BindingStyle::PerfectBound => "perfect-bound",
        BindingStyle::Concertina => "concertina",
        BindingStyle::Stab => "stab",
    }
}

fn creep_desc(c: CreepStrategy, max_mm: f32) -> String {
    match c {
        CreepStrategy::None => "no creep".to_string(),
        CreepStrategy::Shingle => format!("shingle, max {max_mm:.2} mm"),
        CreepStrategy::Pushout => format!("push-out, max {max_mm:.2} mm"),
    }
}

fn marks_desc(m: &MarkConfig) -> String {
    let mut on = Vec::new();
    if m.crop {
        on.push("crop");
    }
    if m.fold {
        on.push("fold");
    }
    if m.registration {
        on.push("registration");
    }
    if m.spine_marker {
        on.push("spine");
    }
    if m.signature_number {
        on.push("sig#");
    }
    if m.color_bar {
        on.push("color-bar");
    }
    if on.is_empty() {
        "none".to_string()
    } else {
        on.join(" · ")
    }
}

fn plural(n: usize) -> &'static str {
    if n == 1 {
        ""
    } else {
        "s"
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use super::super::{BlankPolicy, CreepStrategy};

    fn params(style: BindingStyle) -> ImpositionParams {
        ImpositionParams {
            style,
            sheets_per_signature: 1,
            blank: BlankPolicy::Append,
            sheet_size: Size::from_mm(420.0, 297.0),
            creep: CreepStrategy::Shingle,
            paper_thickness_mm: 0.10,
            marks: MarkConfig::default(),
            crop_offset_mm: 5.0,
            fold_mark_length_mm: 8.0,
        }
    }

    #[test]
    fn saddle_8_summary_and_schematic() {
        let p = build("default", 8, &params(BindingStyle::SaddleStitch));
        assert_eq!(p.signatures, 1);
        assert_eq!(p.total_sheets, 2);
        assert_eq!(p.imposed_pages, 4);
        assert_eq!(p.blanks, 0);
        let text = p.lines().join("\n");
        assert!(text.contains("Style          : saddle-stitch"));
        assert!(text.contains("(420 × 297 mm)"));
        // first sheet front [8][1], back [2][7]
        assert!(text.contains("Front: [   8 ][   1 ]"), "got:\n{text}");
        assert!(text.contains("Back:  [   2 ][   7 ]"));
        assert!(text.contains("shingle, max"));
    }

    #[test]
    fn padding_blanks_reported() {
        let p = build("default", 6, &params(BindingStyle::SaddleStitch));
        assert_eq!(p.blanks, 2);
        let text = p.lines().join("\n");
        assert!(text.contains("+2 blanks"));
        assert!(text.contains("[  —  ]"), "blank cell shown: {text}");
    }

    #[test]
    fn stab_one_up_no_signature_line() {
        let p = build("default", 5, &params(BindingStyle::Stab));
        let text = p.lines().join("\n");
        assert!(!text.contains("Signature      :")); // 1-up has no folded signature line
        assert!(text.contains("Front: [   1 ]"));
    }
}