Language Server Protocol Experiments

.gitignore

@@ -1,6 +1,9 @@
 # various directories
 target/
+.bloop/
+.bsp/
 .idea/
+.metals/
 project/target
 project/project/target/
 stuff
@@ -14,6 +17,7 @@ include-*/
 
 # hidden files
 *.~
+.DS_Store
 
 #tools
 *.bat

.scalafmt.conf

@@ -0,0 +1 @@
+version = "2.6.4"

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [    
+    {
+      "type": "scala",
+      "name": "Debug",
+      "request": "launch",
+      "mainClass": "millfork.Main",
+      // optional jvm properties to use
+      "jvmOptions": [],
+      "args": []
+    },
+
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "files.watcherExclude": {
+    "**/target": true
+  }
+}

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Compile Millfork",
+      "type": "shell",
+      "command": "sbt -DskipTests=true compile && sbt -DskipTests=true assembly",
+      "problemMatcher": [],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
+}

build.sbt

@@ -10,6 +10,10 @@ libraryDependencies += "com.lihaoyi" %% "fastparse" % "1.0.0"
 
 libraryDependencies += "org.apache.commons" % "commons-configuration2" % "2.2"
 
+libraryDependencies += "org.eclipse.lsp4j" % "org.eclipse.lsp4j" % "0.9.0"
+
+libraryDependencies += "net.liftweb" %% "lift-json" % "3.4.2"
+
 libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.8" % "test"
 
 val testDependencies = Seq(
@@ -33,7 +37,7 @@ val testDependencies = Seq(
 
 val includesTests = System.getProperty("skipTests") == null
 
-libraryDependencies ++=(
+libraryDependencies ++= (
   if (includesTests) {
     println("Including test dependencies")
     testDependencies
@@ -43,26 +47,27 @@ libraryDependencies ++=(
 )
 
 (if (!includesTests) {
-  // Disable assembling tests
-  sbt.internals.DslEntry.fromSettingsDef(test in assembly := {})
-} else {
-  sbt.internals.DslEntry.fromSettingsDef(Seq[sbt.Def.Setting[_]]())
-})
+   // Disable assembling tests
+   sbt.internal.DslEntry.fromSettingsDef(test in assembly := {})
+ } else {
+   sbt.internal.DslEntry.fromSettingsDef(Seq[sbt.Def.Setting[_]]())
+ })
 
 mainClass in Compile := Some("millfork.Main")
 
 assemblyJarName := "millfork.jar"
 
-lazy val root = (project in file(".")).
-  enablePlugins(BuildInfoPlugin).
-  settings(
+lazy val root = (project in file("."))
+  .enablePlugins(BuildInfoPlugin)
+  .settings(
     buildInfoKeys := Seq[BuildInfoKey](name, version, scalaVersion, sbtVersion),
     buildInfoPackage := "millfork.buildinfo"
   )
 
 import sbtassembly.AssemblyKeys
 
-val releaseDist = TaskKey[File]("release-dist", "Creates a distributable zip file.")
+val releaseDist =
+  TaskKey[File]("release-dist", "Creates a distributable zip file.")
 
 releaseDist := {
   val jar = AssemblyKeys.assembly.value
@@ -79,7 +84,10 @@ releaseDist := {
   IO.createDirectory(distDir)
   IO.copyFile(jar, distDir / jar.name)
   IO.copyFile(base / "LICENSE", distDir / "LICENSE")
-  IO.copyFile(base / "src/3rd-party-licenses.txt", distDir / "3rd-party-licenses.txt")
+  IO.copyFile(
+    base / "src/3rd-party-licenses.txt",
+    distDir / "3rd-party-licenses.txt"
+  )
   IO.copyFile(base / "CHANGELOG.md", distDir / "CHANGELOG.md")
   IO.copyFile(base / "README.md", distDir / "README.md")
   IO.copyFile(base / "COMPILING.md", distDir / "COMPILING.md")
@@ -89,8 +97,14 @@ releaseDist := {
   }
   copyDir("include")
   copyDir("docs")
-  def entries(f: File): List[File] = f :: (if (f.isDirectory) IO.listFiles(f).toList.flatMap(entries) else Nil)
-  IO.zip(entries(distDir).map(d => (d, d.getAbsolutePath.substring(distDir.getParent.length + 1))), zipFile)
+  def entries(f: File): List[File] =
+    f :: (if (f.isDirectory) IO.listFiles(f).toList.flatMap(entries) else Nil)
+  IO.zip(
+    entries(distDir).map(d =>
+      (d, d.getAbsolutePath.substring(distDir.getParent.length + 1))
+    ),
+    zipFile
+  )
   IO.delete(distDir)
   zipFile
 }

project/build.properties

@@ -1 +1 @@
-sbt.version = 0.13.18
+sbt.version = 1.4.0

project/metals.sbt

@@ -0,0 +1,4 @@
+// DO NOT EDIT! This file is auto-generated.
+// This file enables sbt-bloop to create bloop config files.
+
+addSbtPlugin("ch.epfl.scala" % "sbt-bloop" % "1.4.4-13-408f4d80")

project/project/metals.sbt

@@ -0,0 +1,4 @@
+// DO NOT EDIT! This file is auto-generated.
+// This file enables sbt-bloop to create bloop config files.
+
+addSbtPlugin("ch.epfl.scala" % "sbt-bloop" % "1.4.4-13-408f4d80")

project/project/project/metals.sbt

@@ -0,0 +1,4 @@
+// DO NOT EDIT! This file is auto-generated.
+// This file enables sbt-bloop to create bloop config files.
+
+addSbtPlugin("ch.epfl.scala" % "sbt-bloop" % "1.4.4-13-408f4d80")

src/main/scala/millfork/Context.scala

@@ -9,6 +9,7 @@ import millfork.error.Logger
 case class Context(errorReporting: Logger,
                    inputFileNames: List[String],
                    outputFileName: Option[String] = None,
+                   configFilePath: Option[String] = None,
                    runFileName: Option[String] = None,
                    runParams: Seq[String] = Vector(),
                    optimizationLevel: Option[Int] = None,
@@ -21,7 +22,8 @@ case class Context(errorReporting: Logger,
                    extraIncludePath: Seq[String] = IndexedSeq(),
                    flags: Map[CompilationFlag.Value, Boolean] = Map(),
                    features: Map[String, Long] = Map(),
-                   verbosity: Option[Int] = None) {
+                   verbosity: Option[Int] = None,
+                   languageServer: Boolean = false) {
   def changeFlag(f: CompilationFlag.Value, b: Boolean): Context = {
     if (flags.contains(f)) {
       if (flags(f) != b) {

src/main/scala/millfork/Main.scala

@@ -19,11 +19,15 @@ import millfork.node.StandardCallGraph
 import millfork.output._
 import millfork.parser.{MSourceLoadingQueue, MosSourceLoadingQueue, TextCodecRepository, ZSourceLoadingQueue}
 
+import millfork.language.{MfLanguageServer,MfLanguageClient,LanguageServerLogger}
+import org.eclipse.lsp4j.services.LanguageServer
+import org.eclipse.lsp4j.jsonrpc.Launcher
+import java.util.concurrent.Executors
+import java.io.PrintWriter
+import millfork.cli.JsonConfigParser
 
 
 object Main {
-
-
   def main(args: Array[String]): Unit = {
     val errorReporting = new ConsoleLogger
     implicit val __implicitLogger: Logger = errorReporting
@@ -34,15 +38,16 @@ object Main {
 
     val startTime = System.nanoTime()
     val (status, c0) = parser(errorReporting).parse(Context(errorReporting, Nil), args.toList)
+    val c1 = JsonConfigParser.parseConfig(c0, errorReporting)
     status match {
       case CliStatus.Quit => return
       case CliStatus.Failed =>
         errorReporting.fatalQuit("Invalid command line")
       case CliStatus.Ok => ()
     }
     errorReporting.assertNoErrors("Invalid command line")
-    errorReporting.verbosity = c0.verbosity.getOrElse(0)
-    if (c0.inputFileNames.isEmpty) {
+    errorReporting.verbosity = c1.verbosity.getOrElse(0)
+    if (c1.inputFileNames.isEmpty && !c1.languageServer) {
       errorReporting.fatalQuit("No input files")
     }
 
@@ -51,14 +56,14 @@ object Main {
     errorReporting.trace("This program comes with ABSOLUTELY NO WARRANTY.")
     errorReporting.trace("This is free software, and you are welcome to redistribute it under certain conditions")
     errorReporting.trace("You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/")
-    val c = fixMissingIncludePath(c0).filloutFlags()
+    val c = fixMissingIncludePath(c1).filloutFlags()
     if (c.includePath.isEmpty) {
       errorReporting.warn("Failed to detect the default include directory, consider using the -I option")
     }
 
     val textCodecRepository = new TextCodecRepository("." :: c.includePath)
     val platform = Platform.lookupPlatformFile("." :: c.includePath, c.platform.getOrElse {
-      errorReporting.info("No platform selected, defaulting to `c64`")
+      if (!c1.languageServer) errorReporting.info("No platform selected, defaulting to `c64`")
       "c64"
     }, textCodecRepository)
     val options = CompilationOptions(platform, c.flags, c.outputFileName, c.zpRegisterSize.getOrElse(platform.zpRegisterSize), c.features, textCodecRepository, JobContext(errorReporting, new LabelGenerator))
@@ -67,6 +72,25 @@ object Main {
       case (f, b) => errorReporting.debug(f"    $f%-30s : $b%s")
     }
 
+    if (c1.languageServer) {
+      // We cannot log anything to stdout when starting the language server (otherwise it's a protocol violation)
+      errorReporting.setOutput(true)
+      val server = new MfLanguageServer(c, options)
+
+      val exec = Executors.newCachedThreadPool()
+
+      val launcher = new Launcher.Builder[MfLanguageClient]()
+        .setExecutorService(exec)
+        .setInput(System.in)
+        .setOutput(System.out)
+        .setRemoteInterface(classOf[MfLanguageClient])
+        .setLocalService(server)
+        .create()
+      val clientProxy = launcher.getRemoteProxy
+      server.client = Some(clientProxy)
+      launcher.startListening().get()
+    }
+
     val output = c.outputFileName match {
       case Some(ofn) => ofn
       case None => c.inputFileNames match {
@@ -252,7 +276,7 @@ object Main {
     val unoptimized = new MosSourceLoadingQueue(
       initialFilenames = c.inputFileNames,
       includePath = c.includePath,
-      options = options).run()
+      options = options).run().compilationOrderProgram
 
     val program = if (optLevel > 0) {
       OptimizationPresets.NodeOpt.foldLeft(unoptimized)((p, opt) => p.applyNodeOptimization(opt, options))
@@ -306,7 +330,7 @@ object Main {
     val unoptimized = new ZSourceLoadingQueue(
       initialFilenames = c.inputFileNames,
       includePath = c.includePath,
-      options = options).run()
+      options = options).run().compilationOrderProgram
 
     val program = if (optLevel > 0) {
       OptimizationPresets.NodeOpt.foldLeft(unoptimized)((p, opt) => p.applyNodeOptimization(opt, options))
@@ -346,7 +370,7 @@ object Main {
     val unoptimized = new MSourceLoadingQueue(
       initialFilenames = c.inputFileNames,
       includePath = c.includePath,
-      options = options).run()
+      options = options).run().compilationOrderProgram
 
     val program = if (optLevel > 0) {
       OptimizationPresets.NodeOpt.foldLeft(unoptimized)((p, opt) => p.applyNodeOptimization(opt, options))
@@ -376,7 +400,7 @@ object Main {
     val unoptimized = new ZSourceLoadingQueue(
       initialFilenames = c.inputFileNames,
       includePath = c.includePath,
-      options = options).run()
+      options = options).run().compilationOrderProgram
 
     val program = if (optLevel > 0) {
       OptimizationPresets.NodeOpt.foldLeft(unoptimized)((p, opt) => p.applyNodeOptimization(opt, options))
@@ -429,6 +453,15 @@ object Main {
       c.copy(outputLabels = true, outputLabelsFormatOverride = Some(f))
     }.description("Generate also the label file in the given format. Available options: vice, nesasm, sym.")
 
+    flag("-lsp").action { c =>
+      c.copy(languageServer = true)
+    }.description("Start the Millfork language server. Does not start compilation.")
+
+    parameter("-c", "--config").placeholder("<file>").action { (p, c) =>
+      assertNone(c.outputFileName, "Config file already defined")
+      c.copy(configFilePath = Some(p))
+    }.description("The Millfork config file. Suppliments the provided CLI options.")
+
     boolean("-fbreakpoints", "-fno-breakpoints").action((c,v) =>
       c.changeFlag(CompilationFlag.EnableBreakpoints, v)
     ).description("Include breakpoints in the label file. Requires either -g or -G.")

src/main/scala/millfork/cli/JsonConfigParser.scala

@@ -0,0 +1,65 @@
+package millfork.cli
+
+import net.liftweb.json._
+import java.nio.file.Files
+import java.nio.file.Paths
+import java.nio.charset.StandardCharsets
+import scala.collection.mutable
+import scala.collection.convert.ImplicitConversionsToScala._
+import java.io.InputStreamReader
+import millfork.Context
+import millfork.error.ConsoleLogger
+
+case class JsonConfig(
+    include: Option[List[String]],
+    platform: Option[String],
+    inputFiles: Option[List[String]]
+)
+
+object JsonConfigParser {
+  implicit val formats = DefaultFormats
+
+  def parseConfig(context: Context, logger: ConsoleLogger): Context = {
+    var newContext = context
+
+    var defaultConfig = false
+    val filePath = context.configFilePath.getOrElse({
+      defaultConfig = true
+      ".millforkrc.json"
+    })
+
+    val path = Paths.get(filePath)
+
+    try {
+      val jsonString =
+        Files
+          .readAllLines(path, StandardCharsets.UTF_8)
+          .toIndexedSeq
+          .mkString("")
+
+      val result = parse(jsonString).extract[JsonConfig]
+
+      if (context.inputFileNames.length < 1 && result.inputFiles.isDefined) {
+        newContext = newContext.copy(inputFileNames = result.inputFiles.get)
+      }
+
+      if (context.includePath.length < 1 && result.include.isDefined) {
+        newContext =
+          newContext.copy(extraIncludePath = result.include.get.toSeq)
+      }
+
+      if (context.platform.isEmpty && result.platform.isDefined) {
+        newContext = newContext.copy(platform = Some(result.platform.get))
+      }
+    } catch {
+      case default: Throwable => {
+        if (!defaultConfig) {
+          // Only throw error if not default config
+          logger.fatalQuit("Invalid config file")
+        }
+      }
+    }
+
+    newContext
+  }
+}