Class Lifter

[CAG2Mark]

Lifts classes and nested functions to the top-level.

Method

General idea: when functions have to capture local variables, we need to rewrite their parameter lists. For example:

fun f(arg) =
  let unused = 0
  fun g(arg2) = set arg1 = 1
  let foo = g
  foo(unused)
  arg

is transformed into

fun g(f_capture)(arg2) =
  set f_capture.arg1 = 1 
class f$capture(arg1)
fun f(arg) =
  let capture = f$capture(arg)
  let foo = g(capture)
  foo(unused)
  arg

Variables which are not mutated will be passed as a parameter directly.

TODO

• Lift functions.
• Lift classes:
  • Instantiate does not work at all
  • Functions within functions within classes are lifted out of the class. This is technically fine, but it's better to have them as class methods. However, we need private methods for this, which is not yet implemented.
  • Private variables can't be accessed by nested classes/functions after being lifted out.
  • Modules are not lifted properly For now we don't lift them at all
• Only pass mutated variables through the capture class. Move other variables by passing them as an argument directly. Note that there are some subtle cases where this causes problems, such as

  fun f() =
    let x = g
    let y = 2
    fun g() = y
    x()

  so for now, we only do this when the function is not passed around as a first-class object. More thorough analysis could be done in another PR.
  • More advanced analysis is work-in-progress.
• Replace calls with a single call where we can. For example

  fun f(arg) =
    let unused = 0
    fun g(arg2) = set arg1 = 1
    g(unused)
    arg

  could be rewritten as

  fun g(f_capture, arg2) =
    set f_capture.arg1 = 1
  fun g$(f_capture)(arg2) = g(f_capture, arg2)
  class f$capture(arg1)
  fun f(arg) =
    let capture = f$capture(arg)
    g(capture, unused)
    arg

  where the call g(unused) is symbolically replaced.
  ("lifting" curried functions is much easier than the lifting in general, so it can be done later)
• Class Lifter #266 (comment)

Auxiliary Parameters

Classes can now have auxiliary parameters (IR only currently) with curried constructors.

[LPTK]

What's the intended scheme regarding mutable local variables?

FWIW, we should distinguish mutable from immutable variables. I intend to let mut be used to annotate pattern variables, like in Rust, and to reject re-assignments to non-mut variables. Note that this would still leave let x; if b do x = 1 well-formed.

When there are only immutable variables being captured, the scheme can be simpler.

[CAG2Mark]

What's the intended scheme regarding mutable local variables?

FWIW, we should distinguish mutable from immutable variables. I intend to let mut be used to annotate pattern variables, like in Rust, and to reject re-assignments to non-mut variables. Note that this would still leave let x; if b do x = 1 well-formed.

When there are only immutable variables being captured, the scheme can be simpler.

I don't distinguish between local variables that are mutated / not mutated for now. I intend to move every local variable that's referenced inside a nested class / function into a closure.

Would it be better to add the immutable local variables to each class/function directly?

P.S. seems I accidentally marked this PR as ready earlier, but it's definitely not. It's now marked as a draft.

[CAG2Mark]

Added much more into to the the first comment.

[CAG2Mark]

I thought I did? The warnings are in the backlog file.

I was talking about the part that says "And please add this test to the PR [...]". I didn't find this test (but may have missed it).

Don't forget to assign me (or request my review again) when you're done addressing everything.

Ah, I see. I recall adding a modified version of the test that returns the output rather than printing it so I can use :expect. I think that's where the confusion is coming from.

[CAG2Mark]

@LPTK OK, I've addressed everything. There's some minor things that I would like your opinion on, which are all in the unresolved comments.

[LPTK]

Thanks, I'll take a look. Maybe next week tho. In the meantime can you pls deduplicate all tests?