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
144
145
146
147
148
149
150
151
152
153

use kurbo::{Point, Size};

use crate::utils::Color;

#[derive(Debug, Clone, Copy)]
pub enum Homing {
    Scoop,
    Bar,
    Bump,
}

#[derive(Debug, Clone, Copy)]
pub enum Type {
    None,   // a.k.a. decal in KLE lingo
    Normal, // Just a regular ol' key
    Homing(Option<Homing>),
    Space,
}

#[derive(Debug, Clone, Copy)]
pub enum Shape {
    Normal(Size),
    SteppedCaps,
    IsoVertical,
    IsoHorizontal,
}

impl Shape {
    #[inline]
    pub fn size(self) -> Size {
        match self {
            Self::Normal(s) => s,
            Self::IsoHorizontal | Self::IsoVertical => Size::new(1.5, 2.0),
            Self::SteppedCaps => Size::new(1.75, 1.0),
        }
    }
}

impl From<Size> for Shape {
    fn from(value: Size) -> Self {
        Self::Normal(value)
    }
}

#[derive(Debug, Clone)]
pub struct Legend {
    pub text: String,
    pub size: usize,
    pub color: Color,
}

#[derive(Debug, Clone)]
pub struct Key {
    pub position: Point,
    pub shape: Shape,
    pub typ: Type,
    pub color: Color,
    pub legends: [[Option<Legend>; 3]; 3],
}

impl Key {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    // Example non-blank key used in some of our tests
    pub(crate) fn example() -> Self {
        Self {
            legends: [
                [
                    Some(Legend {
                        text: "!".into(),
                        size: 4,
                        color: Color::new(0, 0, 0),
                    }),
                    None,
                    Some(Legend {
                        text: "¹".into(),
                        size: 4,
                        color: Color::new(0, 0, 0),
                    }),
                ],
                [None, None, None],
                [
                    Some(Legend {
                        text: "1".into(),
                        size: 4,
                        color: Color::new(0, 0, 0),
                    }),
                    None,
                    Some(Legend {
                        text: "¡".into(),
                        size: 4,
                        color: Color::new(0, 0, 0),
                    }),
                ],
            ],
            ..Self::default()
        }
    }
}

impl Default for Key {
    fn default() -> Self {
        Self {
            position: Point::ORIGIN,
            shape: Shape::Normal(Size::new(1., 1.)),
            typ: Type::Normal,
            color: Color::new(0xCC, 0xCC, 0xCC),
            legends: Default::default(), // [[None; 3]; 3] won't work since Option<Legend> : !Copy
        }
    }
}

#[cfg(test)]
pub mod tests {
    use super::*;

    use assert_matches::assert_matches;

    #[test]
    fn test_shape_size() {
        assert_eq!(
            Shape::Normal(Size::new(2.25, 1.)).size(),
            Size::new(2.25, 1.)
        );
        assert_eq!(Shape::IsoVertical.size(), Size::new(1.5, 2.0));
        assert_eq!(Shape::IsoHorizontal.size(), Size::new(1.5, 2.0));
        assert_eq!(Shape::SteppedCaps.size(), Size::new(1.75, 1.0));
    }

    #[test]
    fn test_shape_from() {
        let shape = Shape::from(Size::new(1.75, 1.));
        assert_matches!(shape, Shape::Normal(x) if x == Size::new(1.75, 1.));
    }

    #[test]
    fn test_key_new() {
        let key = Key::new();

        assert_eq!(key.position, Point::new(0., 0.));
        assert_matches!(key.shape, Shape::Normal(size) if size == Size::new(1., 1.));
        assert_matches!(key.typ, Type::Normal);
        assert_eq!(key.color, Color::new(0xCC, 0xCC, 0xCC));
        for row in key.legends {
            for el in row {
                assert!(el.is_none());
            }
        }
    }
}