stutter 0.1.0

An API capturing computations which can be subdivided into smaller steps
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

/// A simple example illustrating a steppable computation of the kind
/// this library was designed for.
use std::collections::HashMap;
use stutter::{Output, StepFn};

/// A simple expression tree.
enum Expr {
    IntLiteral(i64),
    BoolLiteral(bool),
    Variable(String),
    Add(Box<Expr>, Box<Expr>),
    Sub(Box<Expr>, Box<Expr>),
    Value(Value),
}

/// A value which represents the outcome from evaluating an expression
/// tree in a given environment.
#[derive(Copy, Clone, PartialEq, Debug)]
enum Value {
    Int(i64),
    Bool(bool),
    Stuck,
}

/// An environment captures a mapping of variable names to their given
/// values.  Given an environment, we can evaluate a given expression
/// to produce a value.
struct Environment {
    bindings: HashMap<String, Value>,
}

impl Environment {
    pub fn new() -> Environment {
        // Construct initially empty environment.
        Self {
            bindings: HashMap::new(),
        }
    }

    pub fn set(&mut self, var: String, value: Value) {
        self.bindings.insert(var, value);
    }
}

impl StepFn<Expr, Value> for Environment {
    /// Take a single step.  Note, this is not particularly efficient,
    /// but it doesn't need to be!
    fn step(&self, expr: Expr) -> Output<Expr, Value> {
        match expr {
            Expr::IntLiteral(i) => {
                let v = Value::Int(i);
                Output::More(Expr::Value(v))
            }
            Expr::BoolLiteral(b) => {
                let v = Value::Bool(b);
                Output::More(Expr::Value(v))
            }
            Expr::Variable(n) => {
                let r = self.bindings.get(&n);
                match r {
                    Some(v) => Output::Done(*v),
                    None => Output::Done(Value::Stuck),
                }
            }
            Expr::Value(v) => Output::Done(v),
            _ => {
                // Hack for now.
                Output::Done(Value::Stuck)
            }
        }
    }
}

// ===============================================================
// Step Tests
// ===============================================================

#[test]
fn test_step_01() {
    let e = Expr::IntLiteral(1);
    eval(e, 1, Value::Int(1));
}

// ===============================================================
// Helpers
// ===============================================================

fn eval(mut expr: Expr, n: u64, expecting: Value) {
    let env = Environment::new();
    // Evaluate exactly n steps
    for i in 0..n {
        expr = env.step(expr).more();
    }
    // Final step
    let v = env.step(expr).done();
    //
    assert_eq!(v, expecting);
}