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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
pub mod placeholder;
pub mod prefix;
pub mod unit;
pub mod value;

use std::collections::HashMap;
use std::convert::TryInto;

use crate::config::SharedConfig;
use crate::errors::*;
use crate::widgets::{text::TextWidget, Spacing};
use placeholder::Placeholder;
use value::Value;

#[derive(Debug, Clone)]
pub struct FormatTemplate {
    tokens: Vec<Token>,
}

#[derive(Debug, Clone, PartialEq)]
enum Token {
    Text(String),
    Var(Placeholder),
}

#[derive(Debug, Clone)]
pub enum RenderedWidget {
    Text(TextWidget),
    Var(String, TextWidget),
}

fn unexpected_token<T>(token: char) -> Result<T> {
    Err(ConfigurationError(
        format!(
            "failed to parse formatting string: unexpected token '{}'",
            token
        ),
        String::new(),
    ))
}

impl FormatTemplate {
    pub fn from_string(s: &str) -> Result<Self> {
        let mut tokens = vec![];

        let mut text_buf = String::new();
        let mut var_buf = String::new();
        let mut inside_var = false;

        let mut current_buf = &mut text_buf;

        for c in s.chars() {
            match c {
                '{' => {
                    if inside_var {
                        return unexpected_token(c);
                    }
                    if !text_buf.is_empty() {
                        tokens.push(Token::Text(text_buf.clone()));
                        text_buf.clear();
                    }
                    current_buf = &mut var_buf;
                    inside_var = true;
                }
                '}' => {
                    if !inside_var {
                        return unexpected_token(c);
                    }
                    tokens.push(Token::Var(var_buf.as_str().try_into()?));
                    var_buf.clear();
                    current_buf = &mut text_buf;
                    inside_var = false;
                }
                x => current_buf.push(x),
            }
        }
        if inside_var {
            return Err(ConfigurationError(
                "failed to parse formatting string: missing '}'".to_string(),
                "".to_string(),
            ));
        }
        if !text_buf.is_empty() {
            tokens.push(Token::Text(text_buf.clone()));
        }

        Ok(FormatTemplate { tokens })
    }

    pub fn render(&self, vars: &HashMap<&str, Value>) -> Result<String> {
        let mut rendered = String::new();

        for token in &self.tokens {
            match token {
                Token::Text(text) => rendered.push_str(&text),
                Token::Var(var) => rendered.push_str(
                    &vars
                        .get(&*var.name)
                        .internal_error(
                            "util",
                            &format!("Unknown placeholder in format string: {}", var.name),
                        )?
                        .format(&var)?,
                ),
            }
        }

        Ok(rendered)
    }

    // Experimental function: avoid using this function in your block.
    // TODO reconsider the interface
    pub fn render_widgets(
        &self,
        config: SharedConfig,
        id: usize,
        vars: &HashMap<&str, Value>,
    ) -> Result<Vec<RenderedWidget>> {
        let mut rendered = Vec::new();

        for token in &self.tokens {
            match token {
                Token::Text(text) => rendered.push(RenderedWidget::Text(
                    TextWidget::new(id, rendered.len(), config.clone()).with_text(text),
                )),
                Token::Var(var) => rendered.push(RenderedWidget::Var(
                    var.name.clone(),
                    TextWidget::new(id, rendered.len(), config.clone())
                        .with_spacing(Spacing::Hidden)
                        .with_text(
                            &vars
                                .get(&*var.name)
                                .internal_error(
                                    "util",
                                    &format!("Unknown placeholder in format string: {}", var.name),
                                )?
                                .format(&var)?,
                        ),
                )),
            }
        }

        Ok(rendered)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use prefix::Prefix;
    use unit::Unit;

    #[test]
    fn from_string() {
        let ft = FormatTemplate::from_string(
            "some text {var} var again {var*_}{new_var:3} {bar:2#100} {freq;1}.",
        );
        assert!(ft.is_ok());

        let mut tokens = ft.unwrap().tokens.into_iter();
        assert_eq!(
            tokens.next().unwrap(),
            Token::Text("some text ".to_string())
        );
        assert_eq!(
            tokens.next().unwrap(),
            Token::Var(Placeholder {
                name: "var".to_string(),
                min_width: None,
                max_width: None,
                pad_with: None,
                min_prefix: None,
                unit: None,
                unit_hidden: false,
                bar_max_value: None
            })
        );
        assert_eq!(
            tokens.next().unwrap(),
            Token::Text(" var again ".to_string())
        );
        assert_eq!(
            tokens.next().unwrap(),
            Token::Var(Placeholder {
                name: "var".to_string(),
                min_width: None,
                max_width: None,
                pad_with: None,
                min_prefix: None,
                unit: Some(Unit::None),
                unit_hidden: true,
                bar_max_value: None
            })
        );
        assert_eq!(
            tokens.next().unwrap(),
            Token::Var(Placeholder {
                name: "new_var".to_string(),
                min_width: Some(3),
                max_width: None,
                pad_with: None,
                min_prefix: None,
                unit: None,
                unit_hidden: false,
                bar_max_value: None
            })
        );
        assert_eq!(tokens.next().unwrap(), Token::Text(" ".to_string()));
        assert_eq!(
            tokens.next().unwrap(),
            Token::Var(Placeholder {
                name: "bar".to_string(),
                min_width: Some(2),
                max_width: None,
                pad_with: None,
                min_prefix: None,
                unit: None,
                unit_hidden: false,
                bar_max_value: Some(100.)
            })
        );
        assert_eq!(tokens.next().unwrap(), Token::Text(" ".to_string()));
        assert_eq!(
            tokens.next().unwrap(),
            Token::Var(Placeholder {
                name: "freq".to_string(),
                min_width: None,
                max_width: None,
                pad_with: None,
                min_prefix: Some(Prefix::One),
                unit: None,
                unit_hidden: false,
                bar_max_value: None
            })
        );
        assert_eq!(tokens.next().unwrap(), Token::Text(".".to_string()));
        assert!(matches!(tokens.next(), None));
    }

    #[test]
    fn render() {
        let ft = FormatTemplate::from_string(
            "some text {var} var again {var}{new_var:3} {bar:2#100} {freq;1}.",
        );
        assert!(ft.is_ok());

        let values = map!(
            "var" => Value::from_string("|var value|".to_string()),
            "new_var" => Value::from_integer(12),
            "bar" => Value::from_integer(25),
            "freq" => Value::from_float(0.01).hertz(),
        );

        assert_eq!(
            ft.unwrap().render(&values).unwrap().as_str(),
            "some text |var value| var again |var value| 12 \u{258c}  0.0Hz."
        );
    }
}