sl_compiler/
backquote.rs

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
409
410
411
412
413
414
use compile_state::state::{CompileState, SloshVm, SloshVmTrait};
use slvm::{Interned, VMError, VMResult, Value};

use crate::compile;
use crate::pass1::pass1;

macro_rules! is_tag {
    ($vm:expr, $exp:expr, $form:expr) => {{
        match $exp {
            slvm::Value::Pair(_) | slvm::Value::List(_, _) => {
                let (car, _) = $exp.get_pair($vm).expect("List/Pair not a List/Pair?");
                if car.is_symbol($form) {
                    return true;
                }
            }
            slvm::Value::Vector(handle) => {
                let v = $vm.get_vector(handle);
                if let Some(car) = v.get(0) {
                    if car.is_symbol($form) {
                        return true;
                    }
                }
            }
            _ => {}
        }
        false
    }};
}

macro_rules! get_data {
    ($vm:expr, $exp:expr) => {{
        match $exp {
            slvm::Value::Pair(_) | slvm::Value::List(_, _) => {
                let (_, cdr) = $exp.get_pair($vm).expect("List/Pair not a List/Pair?");
                if let slvm::Value::Pair(_handle) | slvm::Value::List(_handle, _) = cdr {
                    let (ncar, ncdr) = cdr.get_pair($vm).expect("List/Pair not a List/Pair?");
                    if ncdr.is_nil() {
                        return Ok(ncar);
                    } else {
                        let (line, col) = (
                            $vm.get_heap_property(cdr, "dbg-line"),
                            $vm.get_heap_property(cdr, "dbg-col"),
                        );
                        if let (Some(slvm::Value::Int(line)), Some(slvm::Value::Int(col))) =
                            (line, col)
                        {
                            let line = slvm::from_i56(&line);
                            let col = slvm::from_i56(&col);
                            return Err(slvm::VMError::new_compile(format!(
                                "Invalid tag at {}:{}, takes one expression.",
                                line, col
                            )));
                        } else {
                            return Err(slvm::VMError::new_compile(
                                "Invalid tag, takes one expression.",
                            ));
                        }
                    }
                }
            }
            slvm::Value::Vector(handle) => {
                let v = $vm.get_vector(handle);
                if v.len() != 2 {
                    return Err(slvm::VMError::new_compile(
                        "Invalid tag, takes one expression.",
                    ));
                }
                return Ok(v[1]);
            }
            _ => {}
        }
        Err(slvm::VMError::new_compile(
            "Invalid tag, takes one expression.",
        ))
    }};
}

pub struct Tag {
    backquote: Interned,
    unquote: Interned,
    splice: Interned,
    splice_bang: Interned,
}

impl Tag {
    pub fn new(vm: &mut SloshVm) -> Self {
        Tag {
            backquote: vm.intern("back-quote"),
            unquote: vm.intern("unquote"),
            splice: vm.intern("unquote-splice"),
            splice_bang: vm.intern("unquote-splice!"),
        }
    }

    pub fn is_backquote(&self, vm: &SloshVm, exp: Value) -> bool {
        is_tag!(vm, exp, self.backquote)
    }

    pub fn is_unquote(&self, vm: &SloshVm, exp: Value) -> bool {
        is_tag!(vm, exp, self.unquote)
    }

    pub fn is_splice(&self, vm: &SloshVm, exp: Value) -> bool {
        is_tag!(vm, exp, self.splice)
    }

    pub fn is_splice_bang(&self, vm: &SloshVm, exp: Value) -> bool {
        is_tag!(vm, exp, self.splice_bang)
    }

    pub fn data(vm: &SloshVm, exp: Value) -> VMResult<Value> {
        get_data!(vm, exp)
    }
}

fn quote(vm: &mut SloshVm, exp: Value) -> Value {
    let cdr = vm.alloc_pair_ro(exp, Value::Nil);
    let q_i = vm.specials().quote;
    vm.alloc_pair_ro(Value::Symbol(q_i), cdr)
}

fn list(vm: &mut SloshVm, exp: Value) -> Value {
    let cdr = vm.alloc_pair_ro(exp, Value::Nil);
    let q_i = vm.intern_static("list");
    vm.alloc_pair_ro(Value::Symbol(q_i), cdr)
}

fn vec(vm: &mut SloshVm, v: &[Value]) -> Value {
    let mut last_pair = Value::Nil;
    if !v.is_empty() {
        let mut i = v.len();
        while i > 0 {
            last_pair = vm.alloc_pair_ro(v[i - 1], last_pair);
            i -= 1;
        }
    }
    let q_i = vm.intern_static("vec");
    vm.alloc_pair_ro(Value::Symbol(q_i), last_pair)
}

fn list2(vm: &mut SloshVm, exp: Value) -> Value {
    let q_i = vm.intern_static("list");
    vm.alloc_pair_ro(Value::Symbol(q_i), exp)
}

fn append(vm: &mut SloshVm, exp1: Value, exp2: Value) -> Value {
    let cdr1 = vm.alloc_pair_ro(exp2, Value::Nil);
    let cdr2 = vm.alloc_pair_ro(exp1, cdr1);
    let q_i = vm.intern_static("list-append");
    vm.alloc_pair_ro(Value::Symbol(q_i), cdr2)
}

fn rewrap(vm: &mut SloshVm, exp: Value, sym: &'static str) -> Value {
    let cdr = vm.alloc_pair_ro(exp, Value::Nil);
    let q_i = vm.intern_static(sym);
    let car = quote(vm, Value::Symbol(q_i));
    let cdr = vm.alloc_pair_ro(car, cdr);
    list2(vm, cdr)
}

fn unquote(vm: &mut SloshVm, exp: Value) -> Value {
    rewrap(vm, exp, "unquote")
}

fn splice(vm: &mut SloshVm, exp: Value) -> Value {
    rewrap(vm, exp, "unquote-splice")
}

fn splice_bang(vm: &mut SloshVm, exp: Value) -> Value {
    rewrap(vm, exp, "unquote-splice!")
}

fn back_quote(vm: &mut SloshVm, exp: Value) -> Value {
    rewrap(vm, exp, "back-quote")
}

// Algorithm initially from
// https://3e8.org/pub/scheme/doc/Quasiquotation%20in%20Lisp%20(Bawden).pdf
fn qq_expand(vm: &mut SloshVm, exp: Value, line: u32, depth: u32) -> VMResult<Value> {
    let tag = Tag::new(vm);
    if tag.is_unquote(vm, exp) {
        if depth == 0 {
            Ok(Tag::data(vm, exp)?)
        } else {
            let expand = qq_expand(vm, Tag::data(vm, exp)?, line, depth - 1)?;
            Ok(unquote(vm, expand))
        }
    } else if tag.is_splice(vm, exp) {
        if depth == 0 {
            Err(VMError::new_compile(format!(
                ",@ not valid here: line {line}"
            )))
        } else {
            let expand = qq_expand(vm, Tag::data(vm, exp)?, line, depth - 1)?;
            Ok(splice(vm, expand))
        }
    } else if tag.is_splice_bang(vm, exp) {
        if depth == 0 {
            Err(VMError::new_compile(format!(
                ",. not valid here: line {line}"
            )))
        } else {
            let expand = qq_expand(vm, Tag::data(vm, exp)?, line, depth - 1)?;
            Ok(splice_bang(vm, expand))
        }
    } else if tag.is_backquote(vm, exp) {
        let inner = qq_expand(vm, Tag::data(vm, exp)?, line, depth + 1)?;
        Ok(back_quote(vm, inner))
    } else {
        match exp {
            Value::Pair(_) | Value::List(_, _) => {
                let (car, cdr) = exp.get_pair(vm).expect("Pair/List not a Pair or List?");
                let l1 = qq_expand_list(vm, car, line, depth)?;
                if cdr.is_nil() {
                    Ok(l1)
                } else {
                    let l2 = qq_expand(vm, cdr, line, depth)?;
                    Ok(append(vm, l1, l2))
                }
            }
            Value::Vector(handle) => {
                let vector = vm.get_vector(handle);
                let mut new_vec: Vec<Value> = vector.to_vec();
                for i in &mut new_vec {
                    *i = qq_expand(vm, *i, line, depth)?;
                }
                Ok(vec(vm, &new_vec[..]))
            }
            _ => Ok(quote(vm, exp)),
        }
    }
}

fn qq_expand_list(vm: &mut SloshVm, exp: Value, line: u32, depth: u32) -> VMResult<Value> {
    let tag = Tag::new(vm);
    if tag.is_unquote(vm, exp) {
        if depth == 0 {
            let data = Tag::data(vm, exp)?;
            Ok(list(vm, data))
        } else {
            let expand = qq_expand(vm, Tag::data(vm, exp)?, line, depth - 1)?;
            let inner = unquote(vm, expand);
            Ok(list(vm, inner))
        }
    } else if tag.is_splice(vm, exp) {
        if depth == 0 {
            Ok(Tag::data(vm, exp)?)
        } else {
            let expand = qq_expand(vm, Tag::data(vm, exp)?, line, depth - 1)?;
            let inner = splice(vm, expand);
            Ok(list(vm, inner))
        }
    } else if tag.is_splice_bang(vm, exp) {
        if depth == 0 {
            Ok(Tag::data(vm, exp)?)
        } else {
            let expand = qq_expand(vm, Tag::data(vm, exp)?, line, depth - 1)?;
            let inner = splice_bang(vm, expand);
            Ok(list(vm, inner))
        }
    } else if tag.is_backquote(vm, exp) {
        let inner = qq_expand(vm, Tag::data(vm, exp)?, line, depth + 1)?;
        let inner = back_quote(vm, inner);
        Ok(list(vm, inner))
    } else {
        match exp {
            Value::Pair(_) | Value::List(_, _) => {
                let (car, cdr) = exp.get_pair(vm).expect("List/Pair not a List/Pair?");
                let l1 = qq_expand_list(vm, car, line, depth)?;
                if cdr.is_nil() {
                    Ok(list(vm, l1))
                } else {
                    let l2 = qq_expand(vm, cdr, line, depth)?;
                    let app = append(vm, l1, l2);
                    Ok(list(vm, app))
                }
            }
            Value::Vector(handle) => {
                let vector = vm.get_vector(handle);
                let mut new_vec: Vec<Value> = vector.to_vec();
                for i in &mut new_vec {
                    *i = qq_expand(vm, *i, line, depth)?;
                }
                let vv = vec(vm, &new_vec[..]);
                Ok(list(vm, vv))
            }
            _ => {
                let q = quote(vm, exp);
                Ok(list(vm, q))
            }
        }
    }
}

pub fn backquote(
    env: &mut SloshVm,
    state: &mut CompileState,
    exp: Value,
    result: usize,
) -> VMResult<()> {
    env.pause_gc();
    let line = env.line_num();
    let result = qq_expand(env, exp, line, 0).and_then(|expand| {
        // XXX disable line numbering?
        pass1(env, state, expand).and_then(|_| compile(env, state, expand, result))
    });
    env.unpause_gc();
    result
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{ReadError, Reader};
    use compile_state::state::new_slosh_vm;
    use slvm::{VMError, VMResult, Value, RET};
    use std::sync::Arc;

    fn read_test(vm: &mut SloshVm, text: &'static str) -> Result<Value, ReadError> {
        let reader = Reader::from_string(text.to_string(), vm, "", 1, 0);
        let exps: Vec<Value> = reader.collect::<Result<Vec<Value>, ReadError>>()?;
        // Don't exit early without unpausing....
        vm.pause_gc();
        let res = if exps.len() == 1 {
            Ok(exps[0])
        } else {
            Ok(vm.alloc_vector_ro(exps))
        };
        vm.unpause_gc();
        res
    }

    fn exec(vm: &mut SloshVm, input: &'static str) -> VMResult<Value> {
        let exp = read_test(vm, input);
        if let Ok(exp) = exp {
            let mut state = CompileState::new();
            compile(vm, &mut state, exp, 0)?;
            state.chunk.encode0(RET, Some(1))?;
            vm.execute(Arc::new(state.chunk))?;
            Ok(vm.stack(0))
        } else {
            panic!("Got unexpected token error: {exp:?}");
        }
    }

    #[test]
    fn test_quote() -> VMResult<()> {
        let mut vm = new_slosh_vm();
        let result = exec(&mut vm, "'(1 2 3)")?;
        let expected = read_test(&mut vm, "(1 2 3)").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "'(x y z)")?;
        let expected = read_test(&mut vm, "(x y z)").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "'x")?;
        let expected = read_test(&mut vm, "x").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "'5")?;
        let expected = read_test(&mut vm, "5").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        Ok(())
    }

    #[test]
    fn test_backquote() -> VMResult<()> {
        let mut vm = new_slosh_vm();
        let result = exec(&mut vm, "(do (def x 3) `(1 2 ~x))")?;
        let expected = read_test(&mut vm, "(1 2 3)").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "(let (x 3) `(1 2 ~x))")?;
        let expected = read_test(&mut vm, "(1 2 3)").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "(let (x 3) `(1 2 (x y ~x) ~x))")?;
        let expected =
            read_test(&mut vm, "(1 2 (x y 3) 3)").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "(let (x 3) `~x)")?;
        let expected = read_test(&mut vm, "3").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "(let (z '(1 2 3)) `(~@z 4 5 6))")?;
        let expected =
            read_test(&mut vm, "(1 2 3 4 5 6)").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "(let (y 'x) `~y)")?;
        let expected = read_test(&mut vm, "x").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());
        let result = exec(&mut vm, "(let (y 'x) ``~~y)")?;
        let expected = read_test(&mut vm, "`~x").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "(let (x \"xxx\") `~x)")?;
        let expected = read_test(&mut vm, "\"xxx\"").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "(do (def x \"xxx\") `~x)")?;
        let expected = read_test(&mut vm, "\"xxx\"").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        let result = exec(&mut vm, "`~5")?;
        let expected = read_test(&mut vm, "5").map_err(|e| VMError::new("read", e.reason))?;
        assert!(vm.is_equal_pair(expected, result)?.is_true());

        Ok(())
    }
}