resurgence 0.1.4

A VM backend library that makes developing interpreters easy. Can be used either as an entire backend, or to create a backend
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

use super::register::Register;
use smartstring::alias::String;

/// `Constant`: Represents a constant in the backend
/// 
/// Possible Values:
/// * `Int(i64)`
/// * `Double(f64)`
/// * `String(String)`
/// * `Boolean(bool)`
#[derive(Clone, Debug, PartialEq)]

pub enum Constant {
    Int(i64),
    Double(f64),
    String(String),
    Boolean(bool),
    Address(Register)
}

impl Constant {
    /// Adds 2 numerical Constants together
    /// 
    /// `constant` (`&Constant::Int` or `&Constant::Double`): Constant you want to add to self
    /// 
    /// # Examples
    /// ```no_run
    /// let int_const = create_constant_int(&5);
    /// let res = int_const.add(&create_constant_int(&5));
    /// assert_eq!(res, Constant::Int(10));
    /// ```
    pub fn add(&self, constant: &Constant) -> Constant {
        match (self.clone(), (*constant).clone()) {
            (Constant::Int(val_1), Constant::Int(val_2)) => {
                Constant::Int(val_1 + val_2)
            },
            (Constant::Double(val_1), Constant::Double(val_2)) => {
                Constant::Double(val_1 + val_2)
            },
            (Constant::Int(val_1), Constant::Double(val_2)) | (Constant::Double(val_2), Constant::Int(val_1)) => {
                Constant::Double(val_1 as f64 + val_2)
            },
            _ => {
                panic!("Can't add non-numerical types");
            }
        }
    }

    /// Subtracts 2 numerical Constants together
    /// 
    /// `constant` (`&Constant::Int` or `&Constant::Double`): Constant you want to subtract from self
    /// # Examples
    /// ```no_run
    /// let int_const = create_constant_int(&5);
    /// let res = int_const.sub(&create_constant_int(&5));
    /// assert_eq!(res, Constant::Int(0));
    /// ```
    pub fn sub(&self, constant: &Constant) -> Constant {
        match (self.clone(), (*constant).clone()) {
            (Constant::Int(val_1), Constant::Int(val_2)) => {
                Constant::Int(val_1 - val_2)
            },
            (Constant::Double(val_1), Constant::Double(val_2)) => {
                Constant::Double(val_1 - val_2)
            },
            (Constant::Int(val_1), Constant::Double(val_2)) | (Constant::Double(val_2), Constant::Int(val_1)) => {
                Constant::Double(val_1 as f64 - val_2)
            },
            _ => {
                panic!("Can't subtract non-numerical types");
            }
        }
    }

    /// Multiplies 2 numerical Constants together
    /// 
    /// `constant` (`&Constant::Int` or `&Constant::Double`): Constant you want to multiply self by
    /// 
    /// # Examples
    /// ```no_run
    /// let int_const = create_constant_int(&5);
    /// let res = int_const.mul(&create_constant_int(&5));
    /// assert_eq!(res, Constant::Int(25));
    /// ```
    pub fn mul(&self, constant: &Constant) -> Constant {
        match (self.clone(), (*constant).clone()) {
            (Constant::Int(val_1), Constant::Int(val_2)) => {
                Constant::Int(val_1 * val_2)
            },
            (Constant::Double(val_1), Constant::Double(val_2)) => {
                Constant::Double(val_1 * val_2)
            },
            (Constant::Int(val_1), Constant::Double(val_2)) | (Constant::Double(val_2), Constant::Int(val_1)) => {
                Constant::Double(val_1 as f64 * val_2)
            },
            _ => {
                panic!("Can't multiply non-numerical types");
            }
        }
    }

    /// Divides 2 numerical Constants together
    /// 
    /// `constant` (`&Constant::Int` or `&Constant::Double`): Constant you want to divide self by
    /// 
    /// # Examples
    /// ```no_run
    /// let int_const = create_constant_int(&5);
    /// let res = int_const.div(&create_constant_int(&5));
    /// assert_eq!(res, Constant::Int(1));
    /// ```
    pub fn div(&self, constant: &Constant) -> Constant {
        match (self.clone(), (*constant).clone()) {
            (Constant::Int(val_1), Constant::Int(val_2)) => {
                Constant::Int(val_1 / val_2)
            },
            (Constant::Double(val_1), Constant::Double(val_2)) => {
                Constant::Double(val_1 / val_2)
            },
            (Constant::Int(val_1), Constant::Double(val_2)) | (Constant::Double(val_2), Constant::Int(val_1)) => {
                Constant::Double(val_1 as f64 / val_2)
            },
            _ => {
                panic!("Can't subtract non-numerical types");
            }
        }
    }

    /// Combines 2 `Constant::String`s together
    /// 
    /// `constant` (`&Constant::String`): String you want to combine with the self
    /// 
    /// # Examples
    /// ```no_run
    /// use smartstring::alias::String;
    /// 
    /// let (hello, world) = (create_constant_string("Hello "), create_constant_string("World!"));
    /// let hello_world = hello.concat(&world);
    /// assert_eq!(hello_world, create_constant_string("Hello World!"));
    /// ```
    pub fn concat(&self, constant: &Constant) -> Constant {
        if let (Constant::String(str_1), Constant::String(str_2)) = (self.clone(), &*constant) {
            Constant::String(str_1 + str_2)
        } 
        else {
            panic!("Concat only works for strings!");
        }
    }
}

/// Creates a `Constant::Int`
/// 
/// `init_val` (`&i64`): The value you want to create a Constant with
/// 
/// # Examples
/// ```no_run
/// let constant = create_constant_int(&10);
/// ```
pub fn create_constant_int(init_val: &i64) -> Constant {
    Constant::Int(*init_val)
}

/// Creates a `Constant::Double`
/// 
/// `init_val` (`&f64`): The value you want to create a Constant with
/// 
/// # Examples
/// ```no_run
/// let constant = create_constant_double(&3.2);
/// ```
pub fn create_constant_double(init_val: &f64) -> Constant {
    Constant::Double(*init_val)
}

/// Creates a `Constant::String`
/// 
/// `init_val` (`&str`): The value you want to create a Constant with
///
/// # Examples
/// ```no_run
/// use smartstring::alias::String;
/// let constant = create_constant_string("Hello World!");
/// ```
pub fn create_constant_string(init_val: &str) -> Constant {
    Constant::String(String::from(init_val))
}

/// Creates a `Constant::Bool`
/// 
/// `init_val` (`&bool`): The value you want to create a Constant with
///
/// # Examples
/// ```no_run
/// let constant = create_constant_bool(&true);
/// ```
pub fn create_constant_bool(init_val: &bool) -> Constant {
    Constant::Boolean(*init_val)
}

#[cfg(test)]
mod constant_init_tests {
    use super::*;
    use smartstring::alias::String;

    #[test]
    fn const_int() {
        let test_int = 99;
        let constant = create_constant_int(&test_int);
        assert_eq!(constant, Constant::Int(test_int));
    }
    
    #[test]
    fn const_double() {
        let test_double = std::f64::consts::PI;
        let constant = create_constant_double(&test_double);
        assert_eq!(constant, Constant::Double(test_double));
    }

    #[test]
    fn const_string() {
        let test_string = "Hello World";
        let constant = create_constant_string(test_string);
        assert_eq!(constant, Constant::String(String::from(test_string)))
    }

    #[test]
    fn const_bool() {
        let test_bool = true;
        let constant = create_constant_bool(&test_bool);
        assert_eq!(constant, Constant::Boolean(test_bool));
    }
}

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

    #[test]
    fn math_test() {
        let int_const = create_constant_int(&99);
        let double_const = create_constant_double(&1.5);

        let add_constant = int_const.add(&double_const);
        let sub_constant = int_const.sub(&double_const);
        let mul_constant = int_const.mul(&double_const);
        let div_constant = int_const.div(&double_const);

        if let Constant::Double(res) = add_constant {
            assert_eq!(res, 99.0 + 1.5);
        }
        if let Constant::Double(res) = sub_constant {
            assert_eq!(res, 99.0 - 1.5);
        }
        if let Constant::Double(res) = mul_constant {
            assert_eq!(res, 99.0 * 1.5);
        }
        if let Constant::Double(res) = div_constant {
            assert_eq!(res, 99.0 / 1.5);
        }
    }

    #[test]
    fn concat_test() {
        let (hello, world) = (create_constant_string("Hello "), create_constant_string("World!"));
        let hello_world = hello.concat(&world);
        assert_eq!(hello_world, create_constant_string("Hello World!"));
    }
}