voltaic-driver 0.2.0

Incremental compilation driver for the Voltaic compiler.
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
use voltaic_ast::BinaryOp;

use voltaic_ast::Block;

use voltaic_ast::CaseArm;

use voltaic_ast::ClassMember;

use voltaic_ast::ClauseBody;

use voltaic_ast::Condition;

use voltaic_ast::ConditionOperand;

use voltaic_ast::Expr;

use voltaic_ast::FieldInit;

use voltaic_ast::Guard;

use voltaic_ast::Item;

use voltaic_ast::Program;

use voltaic_ast::Qualifier;

use voltaic_ast::Section;

use voltaic_ast::Stmt;

use voltaic_ast::StrInterpPart;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Pass {
  BlankNumbers,
  Pipelines,
}
#[allow(unused_imports)]
use Pass::*;

pub fn rewrite_program(program: &mut Program, step: Pass) {
  for item in program.items.iter_mut() {
    rewrite_item(item, step);
  }
  ();
}

pub fn rewrite_item(item: &mut Item, step: Pass) {
  match item {
    Item::Fn(f) => {
      for clause in f.clauses.iter_mut() {
        match &mut clause.body {
          ClauseBody::Plain(block) => rewrite_block(block, step),
          ClauseBody::Guarded(rows) => {
            for row in rows.iter_mut() {
              rewrite_guard(row, step);
            }
            ()
          }
        };
        for stmt in clause.wheres.iter_mut() {
          rewrite_stmt(stmt, step);
        }
      }
      ()
    }
    Item::Instance(block) => {
      for member in block.members.iter_mut() {
        if let ClassMember::Method(f) = member {
          for clause in f.clauses.iter_mut() {
            match &mut clause.body {
              ClauseBody::Plain(b) => rewrite_block(b, step),
              ClauseBody::Guarded(rows) => {
                for row in rows.iter_mut() {
                  rewrite_guard(row, step);
                }
                ()
              }
            };
            for stmt in clause.wheres.iter_mut() {
              rewrite_stmt(stmt, step);
            }
          }
        }
      }
      ()
    }
    Item::Test(t) => rewrite_block(&mut t.body, step),
    Item::Const(c) => rewrite_expr(&mut c.value, step),
    _ => (),
  };
}

pub fn rewrite_block(block: &mut Block, step: Pass) {
  for stmt in block.stmts.iter_mut() {
    rewrite_stmt(stmt, step);
  }
  ();
}

pub fn rewrite_stmt(stmt: &mut Stmt, step: Pass) {
  rewrite_expr(&mut stmt.expr, step);
  ();
}

pub fn rewrite_guard(row: &mut Guard, step: Pass) {
  if let Some(cond) = &mut row.condition {
    rewrite_condition(cond, step);
  }
  rewrite_block(&mut row.body, step);
  ();
}

pub fn rewrite_condition(cond: &mut Condition, step: Pass) {
  for operand in cond.operands.iter_mut() {
    match operand {
      ConditionOperand::Expr(e) => rewrite_expr(e, step),
      ConditionOperand::Pattern { source, .. } => rewrite_expr(source, step),
    };
  }
  ();
}

pub fn rewrite_arm(arm: &mut CaseArm, step: Pass) {
  if let Some(cond) = &mut arm.r#guard {
    rewrite_condition(cond, step);
  }
  rewrite_expr(&mut arm.body, step);
  ();
}

pub fn rewrite_field(field: &mut FieldInit, step: Pass) {
  if let Some(e) = &mut field.value {
    rewrite_expr(e, step);
  }
  ();
}

pub fn rewrite_part(part: &mut StrInterpPart, step: Pass) {
  match part {
    StrInterpPart::Interp { expr, .. } => rewrite_expr(expr, step),
    StrInterpPart::Text(_) => (),
  };
}

pub fn rewrite_qualifier(q: &mut Qualifier, step: Pass) {
  match q {
    Qualifier::Draw { source, .. } => rewrite_expr(source, step),
    Qualifier::Guard(e) => rewrite_expr(e, step),
  };
}

pub fn rewrite_section(s: &mut Section, step: Pass) {
  match s {
    Section::Right { operand, .. } => rewrite_expr(operand, step),
    Section::Left { operand, .. } => rewrite_expr(operand, step),
    Section::Field(_) => (),
  };
}

pub fn rewrite_expr(e: &mut Expr, step: Pass) {
  descend(e, step);
  apply_pass(e, step);
  ();
}

pub fn descend(e: &mut Expr, step: Pass) {
  match e {
    Expr::Call { callee, args, .. } => {
      rewrite_expr(callee, step);
      for a in args.iter_mut() {
        rewrite_expr(a, step);
      }
      ()
    }
    Expr::Field { recv, .. } => rewrite_expr(recv, step),
    Expr::Dot { recv, args, .. } => {
      rewrite_expr(recv, step);
      for a in args.iter_mut() {
        rewrite_expr(a, step);
      }
      ()
    }
    Expr::Index { recv, index, .. } => {
      rewrite_expr(recv, step);
      rewrite_expr(index, step)
    }
    Expr::Binary { lhs, rhs, .. } => {
      rewrite_expr(lhs, step);
      rewrite_expr(rhs, step)
    }
    Expr::UserBinary { lhs, rhs, .. } => {
      rewrite_expr(lhs, step);
      rewrite_expr(rhs, step)
    }
    Expr::Over {
      function, place, ..
    } => {
      rewrite_expr(function, step);
      rewrite_expr(place, step)
    }
    Expr::Unary { operand, .. } => rewrite_expr(operand, step),
    Expr::Paren { inner, .. } => rewrite_expr(inner, step),
    Expr::Lambda { body, .. } => rewrite_expr(body, step),
    Expr::AsyncBlock { body, .. } => rewrite_block(body, step),
    Expr::UnsafeBlock { body, .. } => rewrite_block(body, step),
    Expr::TryBlock { body, .. } => rewrite_block(body, step),
    Expr::BindBlock { body, .. } => rewrite_block(body, step),
    Expr::Ascribe { inner, .. } => rewrite_expr(inner, step),
    Expr::StrInterp { parts, .. } => {
      for p in parts.iter_mut() {
        rewrite_part(p, step);
      }
      ()
    }
    Expr::Tuple { items, .. } => {
      for i in items.iter_mut() {
        rewrite_expr(i, step);
      }
      ()
    }
    Expr::ArrayRepeat { value, count, .. } => {
      rewrite_expr(value, step);
      rewrite_expr(count, step)
    }
    Expr::Record { head, fields, .. } => {
      rewrite_expr(head, step);
      for f in fields.iter_mut() {
        rewrite_field(f, step);
      }
      ()
    }
    Expr::List { items, .. } => {
      for i in items.iter_mut() {
        rewrite_expr(i, step);
      }
      ()
    }
    Expr::Comprehension {
      element,
      qualifiers,
      ..
    } => {
      rewrite_expr(element, step);
      for q in qualifiers.iter_mut() {
        rewrite_qualifier(q, step);
      }
      ()
    }
    Expr::If {
      condition,
      then_block,
      r#otherwise,
      ..
    } => {
      rewrite_condition(condition, step);
      rewrite_block(then_block, step);
      if let Some(block) = r#otherwise {
        rewrite_block(block, step);
      }
      ()
    }
    Expr::Block { body, .. } => rewrite_block(body, step),
    Expr::Try { inner, .. } => rewrite_expr(inner, step),
    Expr::Section { section, .. } => rewrite_section(section, step),
    Expr::Case {
      scrutinee, arms, ..
    } => {
      rewrite_expr(scrutinee, step);
      for a in arms.iter_mut() {
        rewrite_arm(a, step);
      }
      ()
    }
    Expr::Ladder { rows, .. } => {
      for row in rows.iter_mut() {
        rewrite_guard(row, step);
      }
      ()
    }
    Expr::Binding(b) => {
      rewrite_expr(&mut b.value, step);
      if let Some(block) = &mut b.r#otherwise {
        rewrite_block(block, step);
      }
      ()
    }
    Expr::Item { item, .. } => rewrite_item(item, step),
    Expr::Return { value, .. } => {
      if let Some(v) = value {
        rewrite_expr(v, step);
      }
      ()
    }
    Expr::Draw { value, .. } => rewrite_expr(value, step),
    Expr::Await { value, .. } => rewrite_expr(value, step),
    Expr::Assign { target, value, .. } => {
      rewrite_expr(target, step);
      rewrite_expr(value, step)
    }
    Expr::Guard {
      source,
      r#otherwise,
      ..
    } => {
      rewrite_expr(source, step);
      rewrite_block(r#otherwise, step)
    }
    Expr::While {
      condition, body, ..
    } => {
      rewrite_condition(condition, step);
      rewrite_block(body, step)
    }
    Expr::For { source, body, .. } => {
      rewrite_expr(source, step);
      rewrite_block(body, step)
    }
    Expr::Loop { body, .. } => rewrite_block(body, step),
    Expr::Break { value, .. } => {
      if let Some(v) = value {
        rewrite_expr(v, step);
      }
      ()
    }
    Expr::MacroCall { args, .. } => {
      for a in args.iter_mut() {
        rewrite_expr(a, step);
      }
      ()
    }
    Expr::Path { .. }
    | Expr::MethodRef { .. }
    | Expr::StrLit { .. }
    | Expr::RawLit { .. }
    | Expr::Unit { .. }
    | Expr::Num { .. }
    | Expr::Bool { .. }
    | Expr::Char { .. }
    | Expr::SelfField { .. }
    | Expr::SelfType { .. }
    | Expr::Ident(_)
    | Expr::Continue { .. }
    | Expr::RustHatch { .. } => (),
  };
}

pub fn apply_pass(e: &mut Expr, pass: Pass) {
  match pass {
    Pass::BlankNumbers => blank_number(e),
    Pass::Pipelines => collapse_pipeline(e),
  };
}

pub(crate) fn blank_number(e: &mut Expr) {
  if let Expr::Num { text, .. } = e {
    *text = "9".to_string();
  }
  ();
}

pub(crate) fn collapse_pipeline(e: &mut Expr) {
  let Expr::Binary { op, lhs, rhs, span } = e else {
    return ();
  };
  if *op != BinaryOp::Pipeline {
    return ();
  }
  let mut named = None;
  let mut found: Vec<Expr> = Vec::new();
  if let Expr::MethodRef { name, .. } = rhs.as_ref() {
    named = Some(name.clone());
  }
  if let Expr::Call { callee, args, .. } = rhs.as_ref()
    && let Expr::MethodRef { name, .. } = callee.as_ref()
  {
    named = Some(name.clone());
    found = args.as_slice().to_vec();
  }
  let Some(name) = named else {
    return ();
  };
  *e = Expr::Dot {
    recv: lhs.clone(),
    name,
    args: found,
    span: *span,
  };
  ();
}

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

  #[test]
  fn a_leaf_has_no_children_so_descending_it_is_a_no_op() {
    let mut e = Expr::Bool {
      value: true,
      span: (0, 1),
    };
    let before = e.clone();
    rewrite_expr(&mut e, Pass::BlankNumbers);
    assert_eq!(e, before);
  }

  #[test]
  fn the_traversal_reaches_a_numeral_in_every_expression_position() {
    let source = "f : u64 -> u64\nf n =\n  m = n + 1\n  xs = [2, 3] : Vec<u64>\n  case m of\n    4 -> 5\n    _ -> m * 6\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    rewrite_program(&mut program, Pass::BlankNumbers);
    let shown = format!("{:?}", program);
    for digit in &["\"1\"", "\"2\"", "\"3\"", "\"5\"", "\"6\""] {
      assert!(!shown.as_str().contains(*digit));
    }
  }

  #[test]
  fn a_numeral_in_a_pattern_is_left_alone_because_a_pass_must_not_change_what_matches() {
    let source = "f : u64 -> u64\nf n = case n of\n  4 -> 5\n  _ -> 6\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    rewrite_program(&mut program, Pass::BlankNumbers);
    let shown = format!("{:?}", program);
    assert!(shown.as_str().contains("\"4\""));
    assert!(!shown.as_str().contains("\"5\""));
    assert!(!shown.as_str().contains("\"6\""));
  }

  #[test]
  fn a_numeral_the_traversal_cannot_reach_would_survive_which_is_what_this_pins() {
    let source = "f : u64 -> u64\nf n = n + 7\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    let before = format!("{:?}", program);
    assert!(before.as_str().contains("\"7\""));
    rewrite_program(&mut program, Pass::BlankNumbers);
    let after = format!("{:?}", program);
    assert!(!after.as_str().contains("\"7\""));
  }

  #[test]
  fn a_pipeline_with_no_arguments_collapses_now_that_the_printer_writes_the_parentheses() {
    let source = "f : &str -> usize\nf s = s |> .len\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    rewrite_program(&mut program, Pass::Pipelines);
    let shown = format!("{:?}", program);
    assert!(!shown.as_str().contains("Pipeline"));
    assert!(shown.as_str().contains("Dot"));
  }

  #[test]
  fn a_pipeline_with_arguments_keeps_them_receiver_first() {
    let source = "f : u64 -> u64\nf n = n |> .max 3\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    rewrite_program(&mut program, Pass::Pipelines);
    let shown = format!("{:?}", program);
    assert!(shown.as_str().contains("Dot"));
    assert!(shown.as_str().contains("\"max\""));
    assert!(shown.as_str().contains("\"3\""));
  }

  #[test]
  fn a_chain_collapses_every_stage_arguments_or_not() {
    let source = "f : u64 -> u64\nf n = n |> .max 3 |> .min 8\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    rewrite_program(&mut program, Pass::Pipelines);
    let shown = format!("{:?}", program);
    assert!(!shown.as_str().contains("Pipeline"));
  }

  #[test]
  fn a_mixed_chain_collapses_both_stages_the_one_with_arguments_and_the_one_without() {
    let source = "f : &str -> usize\nf s = s |> .replacen \"a\" \"b\" 1 |> .len\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    rewrite_program(&mut program, Pass::Pipelines);
    let shown = format!("{:?}", program);
    assert!(shown.as_str().contains("Dot"));
    assert!(!shown.as_str().contains("Pipeline"));
  }

  #[test]
  fn a_binary_that_is_not_a_pipeline_is_left_alone() {
    let source = "f : u64 -> u64\nf n = n + 1\n";
    let mut program = voltaic_parser::parse_source(source).expect("should parse");
    let before = format!("{:?}", program);
    rewrite_program(&mut program, Pass::Pipelines);
    let after = format!("{:?}", program);
    assert_eq!(after, before);
  }
}