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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
bitflags! {
    struct FunctionSetFlags: u8 {
        const FUNCTION_SET                  = 0b0010_0000;
        const INTERFACE_DATA_LENGTH_8BIT    = 0b0001_0000;
        const DISPLAY_LINES_NUMBER_2        = 0b0000_1000;
        const CHARACTER_FONT_5_10_DOTS      = 0b0000_0100;
        const INTERFACE_DATA_LENGTH_4BIT    = 0;
        const DISPLAY_LINES_NUMBER_1        = 0;
        const CHARACTER_FONT_5_8_DOTS       = 0;
    }
}

/// Enumeration of possible interface data lengths.
#[derive(Clone, Copy)]
pub enum DataLength {
    /// 4-bit mode
    FourBit,
    /// 8-bit mode
    EightBit,
}

impl From<DataLength> for FunctionSetFlags {
    fn from(length: DataLength) -> Self {
        match length {
            DataLength::FourBit => FunctionSetFlags::INTERFACE_DATA_LENGTH_4BIT,
            DataLength::EightBit => FunctionSetFlags::INTERFACE_DATA_LENGTH_8BIT,
        }
    }
}

/// Enumeration to set display line number.
#[derive(Clone, Copy)]
pub enum LineNumber {
    One,
    Two,
}

impl From<LineNumber> for FunctionSetFlags {
    fn from(number: LineNumber) -> Self {
        match number {
            LineNumber::One => FunctionSetFlags::DISPLAY_LINES_NUMBER_1,
            LineNumber::Two => FunctionSetFlags::DISPLAY_LINES_NUMBER_2,
        }
    }
}

/// Enumeration to set display character font.
#[derive(Clone, Copy)]
pub enum CharacterFont {
    Dots5By10,
    Dots5By8,
}

impl From<CharacterFont> for FunctionSetFlags {
    fn from(font: CharacterFont) -> Self {
        match font {
            CharacterFont::Dots5By10 => FunctionSetFlags::CHARACTER_FONT_5_10_DOTS,
            CharacterFont::Dots5By8 => FunctionSetFlags::CHARACTER_FONT_5_8_DOTS,
        }
    }
}

/// A struct for creating display function settings.
pub struct FunctionSetBuilder {
    data_length: DataLength,
    line_number: LineNumber,
    character_font: CharacterFont,
}

impl FunctionSetBuilder {
    pub fn set_data_length(&mut self, data_length: DataLength) -> &mut Self {
        self.data_length = data_length;
        self
    }

    pub fn set_line_number(&mut self, line_number: LineNumber) -> &mut Self {
        self.line_number = line_number;
        self
    }

    pub fn set_character_font(&mut self, character_font: CharacterFont) -> &mut Self {
        self.character_font = character_font;
        self
    }

    pub(crate) fn build_command(&self) -> u8 {
        let mut cmd = FunctionSetFlags::FUNCTION_SET;

        cmd |= FunctionSetFlags::from(self.data_length);
        cmd |= FunctionSetFlags::from(self.line_number);
        cmd |= FunctionSetFlags::from(self.character_font);

        cmd.bits()
    }
}

impl Default for FunctionSetBuilder {
    /// Make a new `FunctionSetBuilder` with the default settings described below.
    ///
    /// The default settings are:
    ///
    ///  - **data_length:**
    ///     - `FourBit` - 4-bit mode
    ///  - **line_number:**
    ///     - `One` - one line mode
    ///  - **character_font:**
    ///     - `Dots5By8` - 5x8 dots character font
    fn default() -> Self {
        Self {
            data_length: DataLength::FourBit,
            line_number: LineNumber::One,
            character_font: CharacterFont::Dots5By8,
        }
    }
}

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

    const FUNCTION_SET_FLAG: u8 = 0b0010_0000;
    const DATA_LENGTH_FLAG: u8 = 0b0001_0000;
    const LINE_NUMBER_FLAG: u8 = 0b0000_1000;
    const CHARACTER_FONT_FLAG: u8 = 0b0000_0100;

    fn has_bit(value: u8, bitmask: u8) -> bool {
        value & bitmask == bitmask
    }

    #[test]
    fn function_set_flag() {
        let b = FunctionSetBuilder::default();
        let cmd = b.build_command();

        assert!(has_bit(cmd, FUNCTION_SET_FLAG));
    }

    #[test]
    fn default_data_length() {
        let b = FunctionSetBuilder::default();
        let cmd = b.build_command();

        assert_eq!(has_bit(cmd, DATA_LENGTH_FLAG), false);
    }

    #[test]
    fn set_data_length() {
        let mut b = FunctionSetBuilder::default();

        let cmd = b.build_command();
        assert_eq!(has_bit(cmd, DATA_LENGTH_FLAG), false);

        b.set_data_length(DataLength::EightBit);

        let cmd = b.build_command();
        assert!(has_bit(cmd, DATA_LENGTH_FLAG));
    }

    #[test]
    fn default_line_number() {
        let b = FunctionSetBuilder::default();
        let cmd = b.build_command();

        assert_eq!(has_bit(cmd, LINE_NUMBER_FLAG), false);
    }

    #[test]
    fn set_line_number() {
        let mut b = FunctionSetBuilder::default();

        let cmd = b.build_command();
        assert_eq!(has_bit(cmd, LINE_NUMBER_FLAG), false);

        b.set_line_number(LineNumber::Two);

        let cmd = b.build_command();
        assert!(has_bit(cmd, LINE_NUMBER_FLAG));
    }

    #[test]
    fn default_character_font() {
        let b = FunctionSetBuilder::default();
        let cmd = b.build_command();

        assert_eq!(has_bit(cmd, CHARACTER_FONT_FLAG), false);
    }

    #[test]
    fn set_character_font() {
        let mut b = FunctionSetBuilder::default();

        let cmd = b.build_command();
        assert_eq!(has_bit(cmd, CHARACTER_FONT_FLAG), false);

        b.set_character_font(CharacterFont::Dots5By10);

        let cmd = b.build_command();
        assert!(has_bit(cmd, CHARACTER_FONT_FLAG));
    }
}