bard 2.0.1

Creates PDF and HTML songbooks out of easy-to-write Markdown sources.
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

use handlebars::handlebars_helper;
use semver::Version;

use super::template::{DpiHelper, HbRender};
use super::tex_tools::TexTools;
use super::{Render, RenderContext};
use crate::app::App;
use crate::prelude::*;
use crate::project::{Output, Project};
use crate::render::tex_tools::TexRenderJob;
use crate::util::ImgCache;

default_template!(DEFAULT_TEMPLATE, "pdf.hbs");

fn latex_escape(input: &str, pre_spaces: bool) -> String {
    let mut res = String::with_capacity(input.len());
    for c in input.chars() {
        match c {
            ' ' if pre_spaces => res.push('~'),
            '&' | '%' | '$' | '#' | '_' | '{' | '}' => {
                res.push('\\');
                res.push(c);
            }
            '[' => res.push_str("{\\lbrack}"),
            ']' => res.push_str("{\\rbrack}"),
            '~' => res.push_str("{\\textasciitilde}"),
            '^' => res.push_str("{\\textasciicircum}"),
            '\\' => res.push_str("{\\textbackslash}"),
            c => res.push(c),
        }
    }

    res
}

fn hb_latex_escape(input: &str) -> String {
    latex_escape(input, false)
}

handlebars_helper!(hb_pre: |input: str| {
    latex_escape(input, true)
});

pub struct RPdf {
    hb: HbRender,
    toc_sort_key: Option<String>,
    tex_runs: u32,
}

impl RPdf {
    pub fn new(project: &Project, output: &Output, img_cache: &ImgCache) -> Result<Self> {
        let mut hb = HbRender::new(project, output, &DEFAULT_TEMPLATE, img_cache)?;

        // Setup TeX escaping and TeX-specific helpers
        hb.hb.register_escape_fn(hb_latex_escape);
        hb.hb.register_helper("pre", Box::new(hb_pre));
        hb.hb
            .register_helper("px2mm", DpiHelper::new(output, "px2mm"));

        Ok(Self {
            hb,
            toc_sort_key: output.toc_sort.then(|| output.toc_sort_key.clone()),
            tex_runs: output.tex_runs,
        })
    }
}

impl Render for RPdf {
    fn render(&self, app: &App, output: &Path, context: RenderContext) -> Result<()> {
        // Render TeX first
        let tex_file = output.with_extension("tex");
        self.hb.render(&tex_file, context)?;
        if self.tex_runs == 0 || !app.post_process() {
            // TODO: test this
            return Ok(());
        }

        // Run TeX
        let job = TexRenderJob::new(
            tex_file,
            output,
            app.keep_interm(),
            self.toc_sort_key.as_deref(),
            self.tex_runs - 1,
        )?;
        TexTools::get().render_pdf(app, job)
    }

    fn version(&self) -> Option<Version> {
        self.hb.version()
    }
}