Add and use compiler configuration implicit Config

Author: LPTK

hkmc2/jvm/src/test/scala/hkmc2/CompileTestRunner.scala

@@ -44,6 +44,8 @@ class CompileTestRunner
 
       val preludePath = dir/"mlscript"/"decls"/"Prelude.mls"
 
+      given Config = Config.default
+      
       val compiler = MLsCompiler(
         preludePath,
         mkOutput =>

hkmc2/shared/src/main/scala/hkmc2/Config.scala

@@ -0,0 +1,41 @@
+package hkmc2
+
+import mlscript.utils.*, shorthands.*
+import utils.*
+
+import Config.*
+
+
+def config(using Config): Config = summon
+
+case class Config(
+  sanityChecks: Opt[SanityChecks],
+  effectHandlers: Opt[EffectHandlers],
+):
+  
+  def stackSafety: Opt[StackSafety] = effectHandlers.flatMap(_.stackSafety)
+  
+end Config
+
+
+object Config:
+  
+  val default: Config = Config(
+    sanityChecks = N, // TODO make the default S
+    // sanityChecks = S(SanityChecks(light = true)),
+    effectHandlers = N,
+  )
+  
+  case class SanityChecks(light: Bool)
+  
+  case class EffectHandlers(stackSafety: Opt[StackSafety])
+  
+  case class StackSafety(stackLimit: Int)
+  object StackSafety:
+    val default: StackSafety = StackSafety(
+      stackLimit = 500,
+    )
+  
+end Config
+
+

hkmc2/shared/src/main/scala/hkmc2/MLsCompiler.scala

@@ -37,7 +37,7 @@ class ParserSetup(file: os.Path, dbgParsing: Bool)(using Elaborator.State, Raise
 
 
 // * The weird type of `mkOutput` is to allow wrapping the reporting of diagnostics in synchronized blocks
-class MLsCompiler(preludeFile: os.Path, mkOutput: ((Str => Unit) => Unit) => Unit):
+class MLsCompiler(preludeFile: os.Path, mkOutput: ((Str => Unit) => Unit) => Unit)(using Config):
 
   val runtimeFile: os.Path = preludeFile/os.up/os.up/os.up/"mlscript-compile"/"Runtime.mjs"
 
@@ -82,7 +82,8 @@ class MLsCompiler(preludeFile: os.Path, mkOutput: ((Str => Unit) => Unit) => Uni
       val (blk0, _) = elab.importFrom(parsed)
       val blk = blk0.copy(stats = semantics.Import(State.runtimeSymbol, runtimeFile.toString) :: blk0.stats)
       val low = ltl.givenIn:
-        codegen.Lowering(lowerHandlers = false, stackLimit = None) // TODO: properly hook up stack limit
+        new codegen.Lowering()
+          with codegen.LoweringSelSanityChecks
       val jsb = ltl.givenIn:
         codegen.js.JSBuilder()
       val le = low.program(blk)

hkmc2/shared/src/main/scala/hkmc2/codegen/Lowering.scala

@@ -52,7 +52,9 @@ end Subst
 import Subst.subst
 
 
-class Lowering(lowerHandlers: Bool, stackLimit: Option[Int])(using TL, Raise, State, Ctx):
+class Lowering()(using Config, TL, Raise, State, Ctx):
+  
+  val lowerHandlers: Bool = config.effectHandlers.isDefined
 
   private lazy val unreachableFn =
     Select(Select(Value.Ref(State.globalThisSymbol), Tree.Ident("Predef"))(N), Tree.Ident("unreachable"))(N)
@@ -583,9 +585,9 @@ class Lowering(lowerHandlers: Bool, stackLimit: Option[Int])(using TL, Raise, St
 
   def topLevel(t: st): Block =
     val res = term(t)(ImplctRet)(using Subst.empty)
-    val stackSafe = stackLimit match
-      case None => res
-      case Some(lim) => StackSafeTransform(lim).transformTopLevel(res)
+    val stackSafe = config.stackSafety match
+      case N => res
+      case S(sts) => StackSafeTransform(sts.stackLimit).transformTopLevel(res)
 
     if lowerHandlers then HandlerLowering().translateTopLevel(stackSafe)
     else stackSafe
@@ -623,9 +625,11 @@ class Lowering(lowerHandlers: Bool, stackLimit: Option[Int])(using TL, Raise, St
       Nil))
 
 
-trait LoweringSelSanityChecks
-        (instrument: Bool)(using TL, Raise, State)
+trait LoweringSelSanityChecks(using Config, TL, Raise, State)
     extends Lowering:
+  
+  private val instrument: Bool = config.sanityChecks.isDefined
+  
   override def setupSelection(prefix: st, nme: Tree.Ident, sym: Opt[FieldSymbol])(k: Result => Block)(using Subst): Block =
     if !instrument then return super.setupSelection(prefix, nme, sym)(k)
     subTerm(prefix): p =>
@@ -648,10 +652,9 @@ trait LoweringSelSanityChecks
 
 
 
-trait LoweringTraceLog
-        (instrument: Bool)(using TL, Raise, State)
+trait LoweringTraceLog(instrument: Bool)(using TL, Raise, State)
     extends Lowering:
-      
+  
   private def selFromGlobalThis(path: Str*): Path =
       path.foldLeft[Path](Value.Ref(State.globalThisSymbol)):
         (qual, name) => Select(qual, Tree.Ident(name))(N)

hkmc2/shared/src/main/scala/hkmc2/codegen/js/JSBuilder.scala

@@ -537,10 +537,11 @@ object JSBuilder:
 end JSBuilder
 
 
-trait JSBuilderArgNumSanityChecks
-    (instrument: Bool)(using Elaborator.State)
+trait JSBuilderArgNumSanityChecks(using Config, Elaborator.State)
     extends JSBuilder:
 
+  val instrument: Bool = config.sanityChecks.isDefined
+  
   override def checkMLsCalls: Bool = instrument
   override def checkSelections: Bool = instrument
 

hkmc2/shared/src/test/mlscript/handlers/BadHandlers.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 :re

hkmc2/shared/src/test/mlscript/handlers/EffectInHandler.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 class PrintEffect with
   fun p(s: String): ()

hkmc2/shared/src/test/mlscript/handlers/Effects.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect with

hkmc2/shared/src/test/mlscript/handlers/EffectsHygiene.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 // * Notice that the two module definitions are lifted to the top of the block.

hkmc2/shared/src/test/mlscript/handlers/EffectsInClasses.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect with

hkmc2/shared/src/test/mlscript/handlers/EffectsInMethods.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect with

hkmc2/shared/src/test/mlscript/handlers/GeneratorStack.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 import "../../mlscript-compile/Stack.mls"
 open Stack

hkmc2/shared/src/test/mlscript/handlers/Generators.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 abstract class Generator with
   fun produce(result): ()

hkmc2/shared/src/test/mlscript/handlers/HandlerBlockBindings.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect with

hkmc2/shared/src/test/mlscript/handlers/HandlersInClasses.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect with

hkmc2/shared/src/test/mlscript/handlers/HandlersInMethods.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect with

hkmc2/shared/src/test/mlscript/handlers/HandlersScratch.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 abstract class Effect
 

hkmc2/shared/src/test/mlscript/handlers/LeakingEffects.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect[A] with

hkmc2/shared/src/test/mlscript/handlers/ManualStackSafety.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 // * This file demonstrates the handler-based mechanism of our stack safety implementation
 // * by manually applying the transformation of a recursive factorial function

hkmc2/shared/src/test/mlscript/handlers/MultiResumption.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 class Logger with
   fun info(s: Str): ()

hkmc2/shared/src/test/mlscript/handlers/NestedFun.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 fun sum() = 0
 fun foo(x) =

hkmc2/shared/src/test/mlscript/handlers/NestedHandlers.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 let id = 0
 //│ id = 0

hkmc2/shared/src/test/mlscript/handlers/RecursiveHandlers.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 abstract class Effect[A] with

hkmc2/shared/src/test/mlscript/handlers/ReturnInHandler.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 abstract class Effect with
   fun f(): ()

hkmc2/shared/src/test/mlscript/handlers/StackSafety.mls

@@ -12,7 +12,7 @@ sum(100)
 // preserve tail calls
 // MUST see "return hi1(tmp)" in the output
 :stackSafe 5
-:handler
+:effectHandlers
 :expect 0
 :sjs
 fun hi(n) =
@@ -172,7 +172,7 @@ hi(0)
 
 :sjs
 :stackSafe 1000
-:handler
+:effectHandlers
 :expect 50005000
 fun sum(n) =
   if n == 0 then 0
@@ -358,7 +358,7 @@ fun sum(n) =
 sum(10000)
 //│ ═══[RUNTIME ERROR] RangeError: Maximum call stack size exceeded
 
-:handler
+:effectHandlers
 :stackSafe 100
 mut val ctr = 0
 fun dummy(x) = x
@@ -372,7 +372,7 @@ foo(foo)
 //│ ctr = 10001
 
 :stackSafe 1000
-:handler
+:effectHandlers
 :expect 50005000
 val foo =
   val f = n =>
@@ -396,7 +396,7 @@ abstract class Eff with
   fun perform(a): ()
 
 // functions and lambdas inside handlers
-:handler
+:effectHandlers
 :stackSafe 100
 :expect 50005000
 fun foo(h) = h.perform
@@ -410,7 +410,7 @@ foo(h)
 //│ = 50005000
 
 // function call and defn inside handler
-:handler
+:effectHandlers
 :stackSafe 100
 :expect 50005000
 handle h = Eff with
@@ -425,7 +425,7 @@ in
 //│ = 50005000
 
 :re
-:handler
+:effectHandlers
 fun foo(h) = h.perform(2)
 handle h = Eff with
   fun perform(a)(resume) =
@@ -436,7 +436,7 @@ handle h = Eff with
 foo(h)
 //│ ═══[RUNTIME ERROR] RangeError: Maximum call stack size exceeded
 
-:handler
+:effectHandlers
 :stackSafe
 :sjs
 fun max(a, b) = if a < b then b else a
@@ -453,31 +453,23 @@ fun max(a, b) = if a < b then b else a
 //│ };
 
 
-// * Note that currently the `:sjs` command will not run the code if there is a compilation error
 :sjs
 :stackSafe 42
-:ge
 fun hi(n) = n
 hi(0)
-//│ ═══[COMPILATION ERROR] This code requires effect handler instrumentation but was compiled without it.
+//│ /!!!\ Option ':stackSafe' requires ':effectHandlers' to be set
 //│ JS (unsanitized):
-//│ let hi1, stackHandler;
-//│ hi1 = function hi(n) {
-//│   return n
-//│ };
-//│ throw globalThis.Error("This code requires effect handler instrumentation but was compiled without it.");
-//│ ═══[RUNTIME ERROR] Error: This code requires effect handler instrumentation but was compiled without it.
+//│ let hi1; hi1 = function hi(n) { return n }; hi1(0)
+//│ = 0
 
 :stackSafe 42
-:ge
-:re
 hi(0)
-//│ ═══[COMPILATION ERROR] This code requires effect handler instrumentation but was compiled without it.
-//│ ═══[RUNTIME ERROR] Error: This code requires effect handler instrumentation but was compiled without it.
+//│ /!!!\ Option ':stackSafe' requires ':effectHandlers' to be set
+//│ = 0
 
 
 :stackSafe 1000
-:handler
+:effectHandlers
 :expect 100010000
 fun sum(n) =
   if n == 0 then 0
@@ -486,3 +478,4 @@ fun sum(n) =
 fun bad() = sum(10000) + sum(10000)
 bad()
 //│ = 100010000
+

hkmc2/shared/src/test/mlscript/handlers/TailCallOptimization.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 abstract class StackDelay with
   fun perform(): ()

hkmc2/shared/src/test/mlscript/handlers/UserThreadsSafe.mls

@@ -1,5 +1,5 @@
 :js
-:handler
+:effectHandlers
 
 
 class ThreadEffect with