Add SBT tab completion for scala{,c,doc}

Also refactor the partest parser to use the improved tab
completion for test paths.

1 files changed, 128 insertions, 0 deletions

diff --git a/project/ScalaOptionParser.scala b/project/ScalaOptionParser.scala
new file mode 100644
index 0000000000..a11bd93d82
--- /dev/null
+++ b/project/ScalaOptionParser.scala
@@ -0,0 +1,128 @@
+import ParserUtil._
+import sbt._
+import sbt.complete.Parser._
+import sbt.complete.Parsers._
+import sbt.complete._
+
+object ScalaOptionParser {
+  /** A SBT parser for the Scala command line runners (scala, scalac, etc) */
+  def scalaParser(entryPoint: String, globalBase: File): Parser[String] = {
+    def BooleanSetting(name: String): Parser[String] =
+      token(name)
+    def StringSetting(name: String): Parser[String] = {
+      val valueParser = name match {
+        case "-d" => JarOrDirectoryParser
+        case _ => token(StringBasic, TokenCompletions.displayOnly("<value>"))
+      }
+      concat(concat(token(name ~ Space.string)) ~ valueParser)
+    }
+    def MultiStringSetting(name: String): Parser[String] =
+      concat(concat(token(name ~ ":")) ~ repsep(token(StringBasicNotStartingWithDash, TokenCompletions.displayOnly("<value>")), token(",")).map(_.mkString))
+    def IntSetting(name: String): Parser[String] =
+      concat(concat(token(name ~ ":")) ~ token(IntBasic.map(_.toString), TokenCompletions.displayOnly("<integer>")))
+    def ChoiceSetting(name: String, choices: List[String]): Parser[String] =
+      concat(token(concat(name ~ ":")) ~ token(StringBasic.examples(choices: _*)).map(_.mkString))
+    def MultiChoiceSetting(name: String, choices: List[String]): Parser[String] =
+      concat(token(concat(name ~ ":")) ~ rep1sep(token(StringBasic.examples(choices: _*)), token(",")).map(_.mkString))
+    def PathSetting(name: String): Parser[String] = {
+      concat(concat(token(name) ~ Space.string) ~ rep1sep(JarOrDirectoryParser.filter(!_.contains(":"), x => x), token(java.io.File.pathSeparator)).map(_.mkString))
+    }
+    def FileSetting(name: String): Parser[String] = {
+      concat(concat(token(name) ~ Space.string) ~ rep1sep(JarOrDirectoryParser.filter(!_.contains(":"), x => x), token(java.io.File.pathSeparator)).map(_.mkString))
+    }
+    val Phase = token(NotSpace.examples(phases: _*))
+    def PhaseSettingParser(name: String): Parser[String] = {
+      MultiChoiceSetting(name, phases)
+    }
+    def ScalaVersionSetting(name: String): Parser[String] = {
+      concat(concat(token(name ~ Space.string)) ~ token(StringBasic, TokenCompletions.displayOnly("<scala version>")))
+    }
+    val Property: Parser[String] = {
+      val PropName = concat(token("-D" ~ oneOrMore(NotSpaceClass & not('=', "not =")).string, TokenCompletions.displayOnly("-D<property name>")))
+      val EqualsValue = concat("=" ~ token(OptNotSpace, TokenCompletions.displayOnly("<property value>")))
+      concat(PropName ~ EqualsValue.?.map(_.getOrElse("")))
+    }
+
+    val sourceFile = FileParser(GlobFilter("*.scala") | GlobFilter("*.java"))
+
+    // TODO Allow JVM settings via -J-... and temporarily add them to the ForkOptions
+    val UniversalOpt = Property | oneOf(pathSettingNames.map(PathSetting) ++ phaseSettings.map(PhaseSettingParser) ++ booleanSettingNames.map(BooleanSetting) ++ stringSettingNames.map(StringSetting) ++ multiStringSettingNames.map(MultiStringSetting) ++ intSettingNames.map(IntSetting) ++ choiceSettingNames.map { case (k, v) => ChoiceSetting(k, v) } ++ multiChoiceSettingNames.map { case (k, v) => MultiChoiceSetting(k, v) } ++ scalaVersionSettings.map(ScalaVersionSetting))
+    val ScalacOpt = sourceFile | UniversalOpt
+
+    val ScalaExtraSettings = oneOf(
+      scalaChoiceSettingNames.map { case (k, v) => ChoiceSetting(k,v)}.toList
+      ++ scalaStringSettingNames.map(StringSetting)
+      ++ scalaBooleanSettingNames.map(BooleanSetting))
+    val ScalaOpt = UniversalOpt | ScalaExtraSettings
+
+    val ScalaDocExtraSettings = oneOf(
+      scalaDocBooleanSettingNames.map(BooleanSetting)
+      ++ scalaDocIntSettingNames.map(IntSetting)
+      ++ scalaDocChoiceSettingNames.map { case (k, v) => ChoiceSetting(k, v)}
+      ++ scaladocStringSettingNames.map(StringSetting)
+      ++ scaladocPathSettingNames.map(PathSetting)
+      ++ scaladocMultiStringSettingNames.map(MultiStringSetting)
+    )
+    val ScalaDocOpt = sourceFile | ScalaOpt | ScalaDocExtraSettings
+
+    entryPoint match {
+      case "scala" =>
+        val runnable = token(StringBasicNotStartingWithDash, TokenCompletions.displayOnly("<script|class|object|jar>")).filter(!_.startsWith("-"), x => x)
+        val runnableAndArgs = concat(runnable ~ Opt(concat(Space.string ~ repsep(token(StringBasic, TokenCompletions.displayOnly("<arg>")), Space).map(_.mkString(" ")))))
+        val options = repsep(ScalaOpt, Space).map(_.mkString(" "))
+        Opt(Space ~> EitherOr(options, runnableAndArgs))
+      case "scaladoc" =>
+        Opt(Space ~> Opt(repsep(ScalaDocOpt, Space).map(_.mkString(" "))))
+      case "scalac" =>
+        Opt(Space ~> repsep(ScalacOpt, Space).map(_.mkString(" ")))
+    }
+  }
+
+  // TODO retrieve this data programatically, ala https://github.com/scala/scala-tool-support/blob/master/bash-completion/src/main/scala/BashCompletion.scala
+  private def booleanSettingNames = List("-X", "-Xcheckinit", "-Xdev", "-Xdisable-assertions", "-Xexperimental", "-Xfatal-warnings", "-Xfull-lubs", "-Xfuture", "-Xlog-free-terms", "-Xlog-free-types", "-Xlog-implicit-conversions", "-Xlog-implicits", "-Xlog-reflective-calls",
+    "-Xno-forwarders", "-Xno-patmat-analysis", "-Xno-uescape", "-Xnojline", "-Xprint-pos", "-Xprint-types", "-Xprompt", "-Xresident", "-Xshow-phases", "-Xstrict-inference", "-Xverify", "-Y",
+    "-Ybreak-cycles", "-Yclosure-elim", "-Yconst-opt", "-Ydead-code", "-Ydebug", "-Ycompact-trees", "-Ydisable-unreachable-prevention", "-YdisableFlatCpCaching", "-Ydoc-debug",
+    "-Yeta-expand-keeps-star", "-Yide-debug", "-Yinfer-argument-types", "-Yinfer-by-name", "-Yinfer-debug", "-Yinline", "-Yinline-handlers",
+    "-Yinline-warnings", "-Yissue-debug", "-Ylog-classpath", "-Ymacro-debug-lite", "-Ymacro-debug-verbose", "-Ymacro-no-expand",
+    "-Yno-completion", "-Yno-generic-signatures", "-Yno-imports", "-Yno-load-impl-class", "-Yno-predef", "-Ynooptimise",
+    "-Yoverride-objects", "-Yoverride-vars", "-Ypatmat-debug", "-Yno-adapted-args", "-Ypos-debug", "-Ypresentation-debug",
+    "-Ypresentation-strict", "-Ypresentation-verbose", "-Yquasiquote-debug", "-Yrangepos", "-Yreify-copypaste", "-Yreify-debug", "-Yrepl-class-based",
+    "-Yrepl-sync", "-Yshow-member-pos", "-Yshow-symkinds", "-Yshow-symowners", "-Yshow-syms", "-Yshow-trees", "-Yshow-trees-compact", "-Yshow-trees-stringified", "-Ytyper-debug",
+    "-Ywarn-adapted-args", "-Ywarn-dead-code", "-Ywarn-inaccessible", "-Ywarn-infer-any", "-Ywarn-nullary-override", "-Ywarn-nullary-unit", "-Ywarn-numeric-widen", "-Ywarn-unused", "-Ywarn-unused-import", "-Ywarn-value-discard",
+    "-deprecation", "-explaintypes", "-feature", "-help", "-no-specialization", "-nobootcp", "-nowarn", "-optimise", "-print", "-unchecked", "-uniqid", "-usejavacp", "-usemanifestcp", "-verbose", "-version")
+  private def stringSettingNames = List("-Xgenerate-phase-graph", "-Xmain-class", "-Xpluginsdir", "-Xshow-class", "-Xshow-object", "-Xsource-reader", "-Ydump-classes", "-Ygen-asmp",
+    "-Ygen-javap", "-Ypresentation-log", "-Ypresentation-replay", "-Yrepl-outdir", "-d", "-dependencyfile", "-encoding", "-Xscript")
+  private def pathSettingNames = List("-bootclasspath", "-classpath", "-extdirs", "-javabootclasspath", "-javaextdirs", "-sourcepath", "-toolcp")
+  private val phases = List("all", "parser", "namer", "packageobjects", "typer", "patmat", "superaccessors", "extmethods", "pickler", "refchecks", "uncurry", "tailcalls", "specialize", "explicitouter", "erasure", "posterasure", "lazyvals", "lambdalift", "constructors", "flatten", "mixin", "cleanup", "delambdafy", "icode", "jvm", "terminal")
+  private val phaseSettings = List("-Xprint-icode", "-Ystop-after", "-Yskip", "-Yshow", "-Ystop-before", "-Ybrowse", "-Ylog", "-Ycheck", "-Xprint")
+  private def multiStringSettingNames = List("-Xmacro-settings", "-Xplugin", "-Xplugin-disable", "-Xplugin-require")
+  private def intSettingNames = List("-Xmax-classfile-name", "-Xelide-below", "-Ypatmat-exhaust-depth", "-Ypresentation-delay", "-Yrecursion")
+  private def choiceSettingNames = Map[String, List[String]](
+    "-Ybackend" -> List("GenASM", "GenBCode"),
+    "-YclasspathImpl" -> List("flat", "recursive"),
+    "-Ydelambdafy" -> List("inline", "method"),
+    "-Ylinearizer" -> List("dfs", "dump", "normal", "rpo"),
+    "-Ymacro-expand" -> List("discard", "none"),
+    "-Yresolve-term-conflict" -> List("error", "object", "package"),
+    "-g" -> List("line", "none", "notailcails", "source", "vars"),
+    "-target" -> List("jvm-1.5", "jvm-1.6", "jvm-1.7", "jvm-1.8"))
+  private def multiChoiceSettingNames = Map[String, List[String]](
+    "-Xlint" -> List("adapted-args", "nullary-unit", "inaccessible", "nullary-override", "infer-any", "missing-interpolator", "doc-detached", "private-shadow", "type-parameter-shadow", "poly-implicit-overload", "option-implicit", "delayedinit-select", "by-name-right-associative", "package-object-classes", "unsound-match", "stars-align"),
+    "-language" -> List("help", "_", "dynamics", "postfixOps", "reflectiveCalls", "implicitConversions", "higherKinds", "existentials", "experimental.macros"),
+    "-Yopt" -> List("l:none", "l:default", "l:method", "l:project", "l:classpath", "unreachable-code", "simplify-jumps", "empty-line-numbers", "empty-labels", "compact-locals", "nullness-tracking", "closure-elimination", "inline-project", "inline-global"),
+    "-Ystatistics" -> List("parser", "typer", "patmat", "erasure", "cleanup", "jvm")
+  )
+  private def scalaVersionSettings = List("-Xmigration", "-Xsource")
+
+  private def scalaChoiceSettingNames = Map("-howtorun" -> List("object", "script", "jar", "guess"))
+  private def scalaStringSettingNames = List("-i", "-e")
+  private def scalaBooleanSettingNames = List("-nc", "-save")
+
+  private def scalaDocBooleanSettingNames = List("-Yuse-stupid-types", "-implicits", "-implicits-debug", "-implicits-show-all", "-implicits-sound-shadowing", "-implicits-hide", "-author", "-diagrams", "-diagrams-debug", "-raw-output", "-no-prefixes", "-no-link-warnings", "-expand-all-types", "-groups")
+  private def scalaDocIntSettingNames = List("-diagrams-max-classes", "-diagrams-max-implicits", "-diagrams-dot-timeout", "-diagrams-dot-restart")
+  private def scalaDocChoiceSettingNames = Map("-doc-format" -> List("html"))
+  private def scaladocStringSettingNames = List("-doc-title", "-doc-version", "-doc-footer", "-doc-no-compile", "-doc-source-url", "-doc-generator", "-skip-packages")
+  private def scaladocPathSettingNames = List("-doc-root-content", "-diagrams-dot-path")
+  private def scaladocMultiStringSettingNames = List("-doc-external-doc")
+
+}