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

use std::fmt;

use semver::Version;

use crate::app::App;
use crate::prelude::*;

pub struct AstVersion {
    pub ver: Version,
    pub description: &'static str,
}

impl AstVersion {
    pub const fn new(ver_maj: u32, ver_min: u32, description: &'static str) -> Self {
        Self {
            ver: Version::new(ver_maj as u64, ver_min as u64, 0),
            description,
        }
    }
}

impl fmt::Display for AstVersion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}: {}.", self.ver, self.description)
    }
}

pub static AST_VERSION_LOG: &[AstVersion] = &[
    AstVersion::new(1, 0, "Initial version"),
    AstVersion::new(1, 1, "New style, added support for HTML snippets, TTF font files, and baseline chords"),
    AstVersion::new(1, 2, "Added scaling of images in HTML via the dpi setting, width and height are now provided in i-image elements"),
];

pub fn current() -> &'static Version {
    AST_VERSION_LOG
        .iter()
        .last()
        .as_ref()
        .map(|v| &v.ver)
        .unwrap()
}

fn log_changes(app: &App, since: &Version) {
    app.status("", format!("Changes since version {}:", since));

    for ver in AST_VERSION_LOG.iter().skip_while(|v| &v.ver <= since) {
        app.status("", ver);
    }
}

pub fn compat_check(app: &App, tpl_path: &Path, tpl_version: &Version) {
    let current = current();
    if current < tpl_version {
        // Template's AST is newer than this bard's AST
        app.warning(format!(
            "The version of template {:?} is {}, which is newer than what this bard uses ({}).
Maybe this project was created with a newer bard version.
This may cause errors while rendering...",
            tpl_path, tpl_version, current,
        ));
    } else if current.major > tpl_version.major {
        // Template's AST major version is older than this bard's AST, incompatibly
        app.warning(
            format!("The version of template {:?} is {}, which is from an older generation than what this bard uses ({}).
This may cause errors while rendering. It may be needed to convert the template to the newer format.",
            tpl_path, tpl_version, current,
        ));
        log_changes(app, tpl_version);
    } else if current > tpl_version {
        // Template's AST version is older than this bard's AST, compatibly
        app.status(
            "Notice",
            format!(
                "The version of template {:?} is {}. This version of bard supports {}.
This is not a problem, but the new version may offer improvements.",
                tpl_path, tpl_version, current,
            ),
        );
        log_changes(app, tpl_version);
    }
}