keyset 0.1.0

A Rust tool to create pretty keyset layout diagrams using correct fonts and icons.
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

mod font;
mod path;
mod profile;

use svg::node::element::Group;
use svg::Document;

use crate::drawing::Drawing;
use crate::layout::Key;
use crate::utils::{Scale, Size, Trim};

use font::Draw as _;
use profile::Draw as _;

pub trait ToSvg {
    fn to_svg(&self) -> String;
}

impl ToSvg for Drawing {
    #[must_use]
    fn to_svg(&self) -> String {
        // scale from keyboard units to drawing units (milliunits)
        let scale = Scale::new(1e3, 1e3);
        let size = self.layout.size * scale;

        // w and h are in dpi units, the 0.75 is keyboard units per inch
        let Size { w, h } = self.layout.size * self.options.dpi * 0.75;

        let document = Document::new()
            .set("width", format!("{}", Trim(w)))
            .set("height", format!("{}", Trim(h)))
            .set("viewBox", format!("0 0 {:.0} {:.0}", size.w, size.h));

        let document = self
            .layout
            .keys
            .iter()
            .map(|key| self.draw_key(key))
            .fold(document, Document::add);

        document.to_string()
    }
}

impl Drawing {
    fn draw_key(&self, key: &Key) -> Group {
        let scale = Scale::new(1e3, 1e3);
        let pos = key.position * scale;

        let result = Group::new().set("transform", format!("translate({}, {})", pos.x, pos.y));

        let mut elements = vec![];
        if self.options.show_keys {
            elements.extend(self.profile.draw_key(key));
        }
        if self.options.show_margin {
            elements.extend(self.profile.draw_margin(key));
        }
        elements.extend(self.font.draw_legends(&self.profile, key));

        elements.into_iter().fold(result, Group::add)
    }
}

#[cfg(test)]
mod tests {
    use crate::drawing::DrawingOptions;
    use crate::font::Font;
    use crate::layout::tests::test_key;
    use crate::layout::Layout;
    use crate::profile::Profile;
    use crate::utils::Size;

    use super::*;

    #[test]
    fn test_to_svg() {
        let layout = Layout {
            size: Size::new(1., 1.),
            keys: vec![],
        };
        let profile = Profile::default();
        let font = Font::from_ttf(&std::fs::read("tests/fonts/demo.ttf").unwrap()).unwrap();
        let options = DrawingOptions::default();
        let drawing = Drawing::new(layout, profile, font, options);

        assert_eq!(
            drawing.to_svg(),
            r#"<svg height="72" viewBox="0 0 1000 1000" width="72" xmlns="http://www.w3.org/2000/svg"/>"#
        );
    }

    #[test]
    fn test_draw_key() {
        let key = test_key();
        let layout = Layout {
            size: Size::new(1., 1.),
            keys: vec![],
        };
        let profile = Profile::default();
        let font = Font::from_ttf(&std::fs::read("tests/fonts/demo.ttf").unwrap()).unwrap();

        let test_config = vec![
            (DrawingOptions::default(), 6),
            (
                DrawingOptions {
                    show_keys: false,
                    ..DrawingOptions::default()
                },
                4,
            ),
            (
                DrawingOptions {
                    show_margin: true,
                    ..DrawingOptions::default()
                },
                7,
            ),
        ];

        for (options, len) in test_config {
            let drawing = Drawing::new(layout.clone(), profile.clone(), font.clone(), options);
            let group = drawing.draw_key(&key);

            assert_eq!(group.get_children().len(), len);
        }
    }
}