Add initial spans to source tree (#957)

This PR starts the effort on adding spans to the source syntax tree. It
is just the first of several steps of this transition.

---------

Co-authored-by: Jonathan Brachthäuser <[email protected]>
Co-authored-by: Jakub Schwenkbeck <[email protected]>

Author: 3 people

effekt/jvm/src/main/scala/effekt/Repl.scala

@@ -108,7 +108,7 @@ class Repl(driver: Driver) extends REPL[Tree, EffektConfig, EffektError] {
       }
       output.emitln("")
 
-      runFrontend(StringSource(""), module.make(UnitLit()), config) { cu =>
+      runFrontend(StringSource(""), module.make(StringSource(""), UnitLit()), config) { cu =>
         module.definitions.foreach {
           case u: Def =>
             outputCode(DeclPrinter(context.symbolOf(u)), config)
@@ -122,7 +122,7 @@ class Repl(driver: Driver) extends REPL[Tree, EffektConfig, EffektError] {
     def typecheck(source: Source, config: EffektConfig): Unit =
       parse(source) match {
         case Success(e: Term, _) =>
-          runFrontend(source, module.make(e), config) { mod =>
+          runFrontend(source, module.make(source, e), config) { mod =>
             // TODO this is a bit ad-hoc
             val mainSym = mod.exports.terms("main").head
             val mainTpe = context.functionTypeOf(mainSym)
@@ -184,7 +184,7 @@ class Repl(driver: Driver) extends REPL[Tree, EffektConfig, EffektError] {
    */
   def process(source: Source, tree: Tree, config: EffektConfig): Unit = tree match {
     case e: Term =>
-      runCompiler(source, module.makeEval(e), config)
+      runCompiler(source, module.makeEval(source, e), config)
 
     case i: Include =>
       val extendedIncludes = module + i
@@ -217,7 +217,7 @@ class Repl(driver: Driver) extends REPL[Tree, EffektConfig, EffektError] {
 
     case d: Def =>
       val extendedDefs = module + d
-      val decl = extendedDefs.make(UnitLit())
+      val decl = extendedDefs.make(source, UnitLit())
 
       runFrontend(source, decl, config) { cu =>
         module = extendedDefs
@@ -309,17 +309,20 @@ class Repl(driver: Driver) extends REPL[Tree, EffektConfig, EffektError] {
     /**
      * Create a module declaration using the given expression as body of main
      */
-    def make(expr: Term): ModuleDecl = {
+    def make(source: Source, expr: Term): ModuleDecl = {
 
       val body = Return(expr)
-
+      val fakeSpan = Span(source, 0, 0, origin = Origin.Synthesized)
+      val fullSpan = Span(source, 0, source.content.length, origin = Origin.Synthesized)
       ModuleDecl("interactive", includes,
-        definitions :+ FunDef(IdDef("main"), Nil, Nil, Nil, None,
-          body))
+        definitions :+ FunDef(IdDef("main", fakeSpan), Many.empty(fakeSpan), Many.empty(fakeSpan), Many.empty(fakeSpan), Maybe.None(fakeSpan),
+          body, fullSpan), fullSpan)
     }
 
-    def makeEval(expr: Term): ModuleDecl =
-      make(Call(IdTarget(IdRef(List(), "println")), Nil, List(expr), Nil))
+    def makeEval(source: Source, expr: Term): ModuleDecl = {
+      val fakeSpan = Span(source, 0, 0, origin = Origin.Synthesized)
+      make(source, Call(IdTarget(IdRef(List(), "println", fakeSpan)), Nil, List(expr), Nil))
+    }
   }
   lazy val emptyModule = ReplModule(Nil, Nil)
 }

effekt/jvm/src/test/scala/effekt/LSPTests.scala

@@ -723,17 +723,15 @@ class LSPTests extends FunSuite {
   test("When showIR=source, server should provide source AST") {
     withClientAndServer { (client, server) =>
       val source =
-        raw"""
-             |def main() = { println("Hello, world!") }
-             |"""
-      val textDoc = new TextDocumentItem("file://path/to/test.effekt", "effekt", 0, source.stripMargin)
+        raw"""def main() = <>""".textDocument
+      val textDoc = new TextDocumentItem("file://path/to/test.effekt", "effekt", 0, source.getText)
       val initializeParams = new InitializeParams()
       val initializationOptions = """{"showIR": "source"}"""
       initializeParams.setInitializationOptions(JsonParser.parseString(initializationOptions))
       server.initialize(initializeParams).get()
 
       val didOpenParams = new DidOpenTextDocumentParams()
-      didOpenParams.setTextDocument(helloWorld)
+      didOpenParams.setTextDocument(source)
       server.getTextDocumentService().didOpen(didOpenParams)
 
       val expectedIRContents =
@@ -742,28 +740,36 @@ class LSPTests extends FunSuite {
              |  Nil,
              |  List(
              |    FunDef(
-             |      IdDef(main),
-             |      Nil,
-             |      Nil,
-             |      Nil,
-             |      None(),
-             |      BlockStmt(
-             |        Return(
-             |          Call(
-             |            IdTarget(IdRef(Nil, println)),
-             |            Nil,
-             |            List(Literal(Hello, world!, ValueTypeApp(String_whatever, Nil))),
-             |            Nil
-             |          )
-             |        )
-             |      )
+             |      IdDef(
+             |        main,
+             |        Span(StringSource(def main() = <>, file://test.effekt), 4, 8, Real())
+             |      ),
+             |      Many(
+             |        Nil,
+             |        Span(StringSource(def main() = <>, file://test.effekt), 8, 8, Real())
+             |      ),
+             |      Many(
+             |        Nil,
+             |        Span(StringSource(def main() = <>, file://test.effekt), 8, 10, Real())
+             |      ),
+             |      Many(
+             |        Nil,
+             |        Span(StringSource(def main() = <>, file://test.effekt), 10, 10, Real())
+             |      ),
+             |      Maybe(
+             |        None(),
+             |        Span(StringSource(def main() = <>, file://test.effekt), 10, 10, Real())
+             |      ),
+             |      Return(Hole(Return(Literal((), ValueTypeApp(Unit_whatever, Nil))))),
+             |      Span(StringSource(def main() = <>, file://test.effekt), 0, 15, Real())
              |    )
-             |  )
+             |  ),
+             |  Span(StringSource(def main() = <>, file://test.effekt), 0, 15, Real())
              |)""".stripMargin
 
       val receivedIRContent = client.receivedIR()
       assertEquals(receivedIRContent.length, 1)
-      val fixedReceivedIR = receivedIRContent.head.content.replaceAll("String_\\d+", "String_whatever")
+      val fixedReceivedIR = receivedIRContent.head.content.replaceAll("Unit_\\d+", "Unit_whatever")
       assertEquals(fixedReceivedIR, expectedIRContents)
     }
   }