keyset 0.2.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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use itertools::Itertools;
use kurbo::{Affine, PathEl, Point};
use svg::node::element::{Group, Path as SvgPath};
use svg::Document;

use crate::drawing::Drawing;

use super::{KeyDrawing, Path};

macro_rules! fmt_num {
    ($fmt:literal, $($args:expr),*) => {
        format!($fmt, $(($args * 1e5).round() / 1e5),*)
    };
}

pub(crate) fn draw(drawing: &Drawing) -> String {
    let size = drawing.bounds.size() * drawing.scale;
    let view_box = drawing.bounds.scale_from_origin(1e3); // Use 1000 user units per key

    let document = Document::new()
        .set("width", fmt_num!("{}mm", size.width * 19.05))
        .set("height", fmt_num!("{}mm", size.height * 19.05))
        .set(
            "viewBox",
            fmt_num!(
                "{} {} {} {}",
                view_box.origin().x,
                view_box.origin().y,
                view_box.size().width,
                view_box.size().height
            ),
        );

    let document = drawing
        .keys
        .iter()
        .map(draw_key)
        .fold(document, Document::add);

    document.to_string()
}

fn draw_key(key: &KeyDrawing) -> Group {
    // scale from keyboard units to drawing units (milliunits)
    let pos = Affine::scale(1e3) * key.origin;

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

    key.paths.iter().map(draw_path).fold(group, Group::add)
}

fn draw_path(path: &Path) -> SvgPath {
    let data = path
        .path
        .iter()
        .scan((Point::ORIGIN, Point::ORIGIN), |(origin, point), el| {
            let str = match el {
                PathEl::MoveTo(p) => {
                    *origin = p;
                    *point = p;
                    fmt_num!("M{} {}", p.x, p.y)
                }
                PathEl::LineTo(p) => {
                    let d = p - *point;
                    *point = p;
                    fmt_num!("l{} {}", d.x, d.y)
                }
                PathEl::CurveTo(p1, p2, p) => {
                    let d1 = p1 - *point;
                    let d2 = p2 - *point;
                    let d = p - *point;
                    *point = p;
                    fmt_num!("c{} {} {} {} {} {}", d1.x, d1.y, d2.x, d2.y, d.x, d.y)
                }
                // GRCOV_EXCL_START - no quads in example
                PathEl::QuadTo(p1, p) => {
                    let d1 = p1 - *point;
                    let d = p - *point;
                    *point = p;
                    fmt_num!("q{} {} {} {}", d1.x, d1.y, d.x, d.y)
                }
                // GRCOV_EXCL_STOP
                PathEl::ClosePath => {
                    *point = *origin;
                    "z".into()
                }
            };

            Some(str)
        })
        .join("");

    let fill = if let Some(color) = path.fill {
        color.to_string()
    } else {
        "none".into()
    };
    let svg_path = SvgPath::new().set("d", data).set("fill", fill);

    if let Some(outline) = path.outline {
        svg_path
            .set("stroke", outline.color.to_string())
            .set("stroke-width", fmt_num!("{}", outline.width))
    } else {
        svg_path.set("stroke", "none")
    }
}

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

    use crate::{DrawingOptions, Key};

    #[test]
    fn test_to_svg() {
        let options = DrawingOptions {
            show_margin: true,
            ..Default::default()
        };
        let keys = [Key::example()];
        let drawing = options.draw(&keys);

        let svg = drawing.to_svg();

        assert_eq!(
            svg,
            unindent(
                r##"<svg height="19.05mm" viewBox="0 0 1000 1000" width="19.05mm" xmlns="http://www.w3.org/2000/svg">
                <g transform="translate(0, 0)">
                <path d="M25 90c0 -35.89851 29.10149 -65 65 -65l820 0c35.89851 -0 65 29.10149 65 65l0 820c0 35.89851 -29.10149 65 -65 65l-820 0c-35.89851 0 -65 -29.10149 -65 -65z" fill="#cccccc" stroke="#aeaeae" stroke-width="10"/>
                <path d="M170 120c0 -35.89851 29.10149 -65 65 -65l530 0c35.89851 -0 65 29.10149 65 65l0 605c0 35.89851 -29.10149 65 -65 65l-530 0c-35.89851 0 -65 -29.10149 -65 -65z" fill="#cccccc" stroke="#aeaeae" stroke-width="10"/>
                <path d="M220 105l560 0l0 635l-560 0z" fill="none" stroke="#ff0000" stroke-width="5"/>
                <path d="M220 299.44444l0 194.44444l126.38889 0l0 -194.44444l-126.38889 0zM235.55556 328.61111l36.94444 68.05556l-36.94444 68.05556l0 -136.11111zM244.30556 478.33333l38.88889 -70l38.88889 70l-77.77778 0zM330.83333 464.72222l-36.94444 -68.05556l36.94444 -68.05556l0 136.11111zM322.08333 315l-38.88889 70l-38.88889 -70l77.77778 0z" fill="#000000" stroke="none"/>
                <path d="M653.61111 299.44444l0 194.44444l126.38889 0l0 -194.44444l-126.38889 0zM669.16667 328.61111l36.94444 68.05556l-36.94444 68.05556l0 -136.11111zM677.91667 478.33333l38.88889 -70l38.88889 70l-77.77778 0zM764.44444 464.72222l-36.94444 -68.05556l36.94444 -68.05556l0 136.11111zM755.69444 315l-38.88889 70l-38.88889 -70l77.77778 0z" fill="#000000" stroke="none"/>
                <path d="M220 740l0 194.44444l126.38889 0l0 -194.44444l-126.38889 0zM235.55556 769.16667l36.94444 68.05556l-36.94444 68.05556l0 -136.11111zM244.30556 918.88889l38.88889 -70l38.88889 70l-77.77778 0zM330.83333 905.27778l-36.94444 -68.05556l36.94444 -68.05556l0 136.11111zM322.08333 755.55556l-38.88889 70l-38.88889 -70l77.77778 0z" fill="#000000" stroke="none"/>
                <path d="M653.61111 740l0 194.44444l126.38889 0l0 -194.44444l-126.38889 0zM669.16667 769.16667l36.94444 68.05556l-36.94444 68.05556l0 -136.11111zM677.91667 918.88889l38.88889 -70l38.88889 70l-77.77778 0zM764.44444 905.27778l-36.94444 -68.05556l36.94444 -68.05556l0 136.11111zM755.69444 755.55556l-38.88889 70l-38.88889 -70l77.77778 0z" fill="#000000" stroke="none"/>
                </g>
                </svg>"##
            )
        );
    }
}