tinylivecode 0.1.1

a tiny language for embedded live coding
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
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
#![no_std]

use micromath::F32Ext;

const MAX_STACK_SIZE: usize = 64;

pub enum ParseError {
    TooManyValuesInStack,
    NoValuesInStack,
    NumberNotParsed,
}

struct Stack<T> {
    stack: [Option<T>; MAX_STACK_SIZE],
    stack_top: usize,
}
impl<T: Copy> Stack<T> {
    fn new() -> Stack<T> {
        Stack {
            stack: [Option::None; MAX_STACK_SIZE],
            stack_top: 0,
        }
    }

    fn push(&mut self, val: T) -> Result<(), ParseError> {
        if self.stack_top >= MAX_STACK_SIZE {
            return Err(ParseError::TooManyValuesInStack);
        }

        self.stack[self.stack_top] = Some(val);
        self.stack_top += 1;
        Ok(())
    }

    fn pop(&mut self) -> Option<T> {
        if self.stack_top == 0 {
            return None;
        }

        // this will never be empty, i promise
        self.stack_top -= 1;
        let result = self.stack[self.stack_top].take();

        result
    }

    fn iter<'a>(&'a self) -> StackIter<'a, T> {
        StackIter {
            curr_loc: 0,
            end_loc: self.stack_top,
            data: self,
        }
    }
}

struct StackIter<'a, T> {
    curr_loc: usize,
    end_loc: usize,
    data: &'a Stack<T>,
}

impl<'a, T> StackIter<'a, T> {
    fn is_empty(&self) -> bool {
        self.curr_loc == self.end_loc
    }
}

impl<'a, T: Copy> Iterator for StackIter<'a, T> {
    type Item = T;

    fn next(&mut self) -> Option<Self::Item> {
        if self.is_empty() {
            None
        } else {
            let result = self.data.stack[self.curr_loc]; // there is a case that _shouldn't_ happen where this is None
            self.curr_loc += 1;
            result
        }
    }
}

pub struct TinyExpr {
    stack: Stack<ExprNode>,
}

impl TinyExpr {
    pub fn from_str(s: &str) -> ParseResult<TinyExpr> {
        let tokens = s.split_whitespace();

        let mut stack = Stack::new();

        for token in tokens {
            let val = ExprNode::parse_token(token)?;
            stack.push(val)?;
        }

        Ok(Self { stack })
    }

    pub fn eval(&self, x: f32, y: f32) -> ParseResult<f32> {
        let mut eval_stack = Stack::new();

        let mut stack_iterator = self.stack.iter();

        while let Some(curr_val) = stack_iterator.next() {
            // println!("curr_val {:?}", curr_val);
            // println!("eval_stack {:?}", eval_stack.stack);
            match curr_val {
                ExprNode::Lerp => {
                    let z: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let y: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push((1.0 - z) * x + z * y)?;
                }
                // binary
                ExprNode::Add => {
                    let y: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;

                    eval_stack.push(x + y)?;
                }
                ExprNode::Mul => {
                    let y: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x * y)?;
                }
                ExprNode::Div => {
                    let y: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x / y)?;
                }
                ExprNode::Sub => {
                    let y: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x - y)?;
                }
                ExprNode::Pow => {
                    let y: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.powf(y))?;
                }
                ExprNode::Atan2 => {
                    let y: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    let x: f32 = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.atan2(y))?;
                }

                // unary
                ExprNode::Sin => {
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.sin())?;
                }
                ExprNode::Cos => {
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.cos())?;
                }
                ExprNode::Fract => {
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.fract())?;
                }
                ExprNode::Sqrt => {
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.fract())?;
                }
                ExprNode::Floor => {
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.floor())?;
                }
                ExprNode::Abs => {
                    let x = eval_stack
                        .pop()
                        .ok_or_else(|| ParseError::NoValuesInStack)?;
                    eval_stack.push(x.abs())?;
                }
                // no variable
                ExprNode::Number(r) => eval_stack.push(r)?,
                ExprNode::X => eval_stack.push(x)?,
                ExprNode::Y => eval_stack.push(y)?,
            };
        }

        if let Some(x) = eval_stack.pop() {
            Ok(x)
        } else {
            Err(ParseError::NoValuesInStack)
        }
    }
}

pub type ParseResult<T> = Result<T, ParseError>;

#[derive(Copy, Clone, Debug)]
enum ExprNode {
    Number(f32),
    X,
    Y,
    // unary
    Sin,
    Cos,
    Fract,
    Sqrt,
    Floor,
    Abs,
    // binary
    Atan2,
    Pow,
    Add,
    Mul,
    Div,
    Sub,
    // ternary
    Lerp,
}

impl ExprNode {
    fn parse_token(token: &str) -> ParseResult<ExprNode> {
        match token {
            "x" => Ok(ExprNode::X),
            "y" => Ok(ExprNode::Y),
            "sin" => Ok(ExprNode::Sin),
            "cos" => Ok(ExprNode::Cos),
            "atan2" => Ok(ExprNode::Atan2),
            "fract" => Ok(ExprNode::Fract),
            "pow" => Ok(ExprNode::Pow),
            "sqrt" => Ok(ExprNode::Sqrt),
            "floor" => Ok(ExprNode::Floor),
            "abs" => Ok(ExprNode::Abs),
            "add" => Ok(ExprNode::Add),
            "mul" => Ok(ExprNode::Mul),
            "div" => Ok(ExprNode::Div),
            "sub" => Ok(ExprNode::Sub),
            "lerp" => Ok(ExprNode::Lerp),
            _ => {
                let float = token
                    .parse::<f32>()
                    .map_err(|_| ParseError::NumberNotParsed)?;
                Ok(ExprNode::Number(float))
            }
        }
    }
}

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

    enum TestEvalResult {
        Ok(f32),
        ErrFromStr(ParseError),
        ErrEval(ParseError),
    }

    impl TestEvalResult {
        /// Returns `true` if the test eval result is [`Ok`].
        ///
        /// [`Ok`]: TestEvalResult::Ok
        #[must_use]
        fn is_ok(&self) -> bool {
            matches!(self, Self::Ok(..))
        }

        /// Returns `true` if the test eval result is [`ErrFromStr`].
        ///
        /// [`ErrFromStr`]: TestEvalResult::ErrFromStr
        #[must_use]
        fn is_err_from_str(&self) -> bool {
            matches!(self, Self::ErrFromStr(..))
        }

        /// Returns `true` if the test eval result is [`ErrEval`].
        ///
        /// [`ErrEval`]: TestEvalResult::ErrEval
        #[must_use]
        fn is_err_eval(&self) -> bool {
            matches!(self, Self::ErrEval(..))
        }
    }

    fn evaluate(s: &str, x: f32, y: f32) -> TestEvalResult {
        let e = match TinyExpr::from_str(s) {
            Ok(r) => match r.eval(x, y) {
                Ok(a) => TestEvalResult::Ok(a),
                Err(err) => TestEvalResult::ErrEval(err),
            },
            Err(err) => TestEvalResult::ErrFromStr(err),
        };

        // can be useful to debug if you introduce std again
        // match &e {
        //     TestEvalResult::Ok(e) => println!("Ok, {}", e),
        //     TestEvalResult::ErrFromStr(parse_error) => println!("{}", "err from str"),
        //     TestEvalResult::ErrEval(parse_error) => println!("{}", "err from eval"),
        // };

        e
    }

    #[test]
    fn it_works() {
        match evaluate("2.3", 0.0, 0.0) {
            TestEvalResult::Ok(r) => assert_eq!(r, 2.3),
            _ => assert!(false),
        }

        match evaluate("2", 0.0, 0.0) {
            TestEvalResult::Ok(r) => assert_eq!(r, 2.0),
            _ => assert!(false),
        }

        match evaluate("x", 5.0, 0.0) {
            TestEvalResult::Ok(r) => assert_eq!(r, 5.0),
            _ => assert!(false),
        }

        match evaluate("y", 0.0, 6.0) {
            TestEvalResult::Ok(r) => assert_eq!(r, 6.0),
            _ => assert!(false),
        }

        match evaluate("x y add", 2.0, 5.0) {
            TestEvalResult::Ok(r) => {
                assert_eq!(r, 7.0)
            }
            _ => {
                assert!(false)
            }
        }

        match evaluate("x y 0.0 lerp", 2.0, 5.0) {
            TestEvalResult::Ok(r) => {
                assert_eq!(r, 2.0)
            }
            _ => {
                assert!(false)
            }
        }

        match evaluate("x y 1.0 lerp", 2.0, 5.0) {
            TestEvalResult::Ok(r) => {
                assert_eq!(r, 5.0)
            }
            _ => {
                assert!(false)
            }
        }

        match evaluate("x y mul 4.0 add", 2.0, 5.0) {
            TestEvalResult::Ok(r) => {
                assert_eq!(r, 14.0)
            }
            _ => {
                assert!(false)
            }
        }
    }

    #[test]
    fn it_does_not_work_empty() {
        let empty_result = evaluate("", 0.0, 0.0);
        assert!(empty_result.is_err_eval());
    }

    #[test]
    fn it_does_not_work_gobbligook() {
        let empty_result = evaluate("gobbligook", 0.0, 0.0);
        assert!(empty_result.is_err_from_str());
    }
}