Merge pull request scala#4576 from som-snytt/issue/9206-more

SI-9206 REPL custom bits

Author: SethTisue

src/compiler/scala/tools/nsc/Properties.scala

@@ -12,8 +12,16 @@ object Properties extends scala.util.PropertiesTrait {
   protected def pickJarBasedOn = classOf[Global]
 
   // settings based on jar properties, falling back to System prefixed by "scala."
+
+  // messages to display at startup or prompt, format string with string parameters
+  // Scala version, Java version, JVM name
   def residentPromptString = scalaPropOrElse("resident.prompt", "\nnsc> ")
   def shellPromptString    = scalaPropOrElse("shell.prompt", "%nscala> ")
+  def shellWelcomeString   = scalaPropOrElse("shell.welcome",
+    """Welcome to Scala %1$#s (%3$s, Java %2$s).
+      |Type in expressions for evaluation. Or try :help.""".stripMargin
+  )
+
   // message to display at EOF (which by default ends with
   // a newline so as not to break the user's terminal)
   def shellInterruptedString = scalaPropOrElse("shell.interrupted", f":quit$lineSeparator")

src/library/scala/sys/BooleanProp.scala

@@ -50,6 +50,7 @@ object BooleanProp {
     def get: String = "" + value
     val clear, enable, disable, toggle = ()
     def option = if (isSet) Some(value) else None
+    //def or[T1 >: Boolean](alt: => T1): T1 = if (value) true else alt
 
     protected def zero = false
   }

src/library/scala/sys/Prop.scala

@@ -58,6 +58,10 @@ trait Prop[+T] {
    */
   def option: Option[T]
 
+  // Do not open until 2.12.
+  //** This value if the property is set, an alternative value otherwise. */
+  //def or[T1 >: T](alt: => T1): T1
+
   /** Removes the property from the underlying map.
    */
   def clear(): Unit

src/partest-extras/scala/tools/partest/ReplTest.scala

@@ -6,8 +6,9 @@
 package scala.tools.partest
 
 import scala.tools.nsc.Settings
-import scala.tools.nsc.interpreter.ILoop
+import scala.tools.nsc.interpreter.{ ILoop, replProps }
 import java.lang.reflect.{ Method => JMethod, Field => JField }
+import scala.util.matching.Regex
 import scala.util.matching.Regex.Match
 
 /** A class for testing repl code.
@@ -19,30 +20,33 @@ abstract class ReplTest extends DirectTest {
   // final because we need to enforce the existence of a couple settings.
   final override def settings: Settings = {
     val s = super.settings
-    // s.Yreplsync.value = true
     s.Xnojline.value = true
     transformSettings(s)
   }
+  def normalize(s: String) = s
   /** True for SessionTest to preserve session text. */
   def inSession: Boolean = false
-  /** True to preserve welcome text. */
+  /** True to preserve welcome header, eliding version number. */
   def welcoming: Boolean = false
-  lazy val welcome = "(Welcome to Scala) version .*".r
-  def normalize(s: String) = s match {
-    case welcome(w) => w
-    case s          => s
-  }
-  def unwelcoming(s: String) = s match {
-    case welcome(w) => false
-    case _          => true
-  }
+  lazy val header = replProps.welcome
   def eval() = {
     val s = settings
     log("eval(): settings = " + s)
-    //ILoop.runForTranscript(code, s).lines drop 1  // not always first line
     val lines = ILoop.runForTranscript(code, s, inSession = inSession).lines
-    if (welcoming) lines map normalize
-    else lines filter unwelcoming
+    (if (welcoming) {
+      val welcome = "(Welcome to Scala).*".r
+      //val welcome = Regex.quote(header.lines.next).r
+      //val version = "(.*version).*".r   // version on separate line?
+      //var inHead  = false
+      lines map {
+        //case s @ welcome()        => inHead = true  ; s
+        //case version(s) if inHead => inHead = false ; s
+        case welcome(s) => s
+        case s          => s
+      }
+    } else {
+      lines drop header.lines.size
+    }) map normalize
   }
   def show() = eval() foreach println
 }

src/repl-jline/scala/tools/nsc/interpreter/jline/FileBackedHistory.scala

@@ -7,9 +7,9 @@ package scala.tools.nsc.interpreter.jline
 
 import _root_.jline.console.history.PersistentHistory
 
-
 import scala.tools.nsc.interpreter
-import scala.tools.nsc.io.{File, Path}
+import scala.reflect.io.{ File, Path }
+import scala.tools.nsc.Properties.{ propOrNone, userHome }
 
 /** TODO: file locking.
   */
@@ -85,9 +85,9 @@ object FileBackedHistory {
   //   val ContinuationChar = '\003'
   //   val ContinuationNL: String = Array('\003', '\n').mkString
 
-  import scala.tools.nsc.Properties.userHome
-
-  def defaultFileName = ".scala_history"
+  final val defaultFileName = ".scala_history"
 
-  def defaultFile: File = File(Path(userHome) / defaultFileName)
+  def defaultFile: File = File(
+    propOrNone("scala.shell.histfile") map (Path.apply) getOrElse (Path(userHome) / defaultFileName)
+  )
 }

src/repl/scala/tools/nsc/interpreter/Formatting.scala

@@ -30,3 +30,6 @@ class Formatting(indent: Int) {
     }
   )
 }
+object Formatting {
+  def forPrompt(prompt: String) = new Formatting(prompt.lines.toList.last.length)
+}

src/repl/scala/tools/nsc/interpreter/ILoop.scala

@@ -56,13 +56,9 @@ class ILoop(in0: Option[BufferedReader], protected val out: JPrintWriter)
 
   private var globalFuture: Future[Boolean] = _
 
-  /** Print a welcome message */
-  def printWelcome() {
-    echo(s"""
-      |Welcome to Scala $versionString ($javaVmName, Java $javaVersion).
-      |Type in expressions to have them evaluated.
-      |Type :help for more information.""".trim.stripMargin
-    )
+  /** Print a welcome message! */
+  def printWelcome(): Unit = {
+    Option(replProps.welcome) filter (!_.isEmpty) foreach echo
     replinfo("[info] started at " + new java.util.Date)
   }
 
@@ -111,10 +107,6 @@ class ILoop(in0: Option[BufferedReader], protected val out: JPrintWriter)
   }
 
   class ILoopInterpreter extends IMain(settings, out) {
-    // the expanded prompt but without color escapes and without leading newline, for purposes of indenting
-    override lazy val formatting: Formatting = new Formatting(
-      (replProps.promptString format Properties.versionNumberString).lines.toList.last.length
-    )
     override protected def parentClassLoader =
       settings.explicitParentLoader.getOrElse( classOf[ILoop].getClassLoader )
   }
@@ -680,9 +672,8 @@ class ILoop(in0: Option[BufferedReader], protected val out: JPrintWriter)
   }
 
   def verbosity() = {
-    val old = intp.printResults
-    intp.printResults = !old
-    echo("Switched " + (if (old) "off" else "on") + " result printing.")
+    intp.printResults = !intp.printResults
+    replinfo(s"Result printing is ${ if (intp.printResults) "on" else "off" }.")
   }
 
   /** Run one command submitted by the user.  Two values are returned:
@@ -762,7 +753,8 @@ class ILoop(in0: Option[BufferedReader], protected val out: JPrintWriter)
 
   private object paste extends Pasted {
     import scala.util.matching.Regex.quote
-    val ContinueString = "     | "
+    val ContinuePrompt = replProps.continuePrompt
+    val ContinueString = replProps.continueText     // "     | "
     val PromptString   = prompt.lines.toList.last
     val anyPrompt = s"""\\s*(?:${quote(PromptString.trim)}|${quote(AltPromptString.trim)})\\s*""".r
 
@@ -806,7 +798,7 @@ class ILoop(in0: Option[BufferedReader], protected val out: JPrintWriter)
         echo("You typed two blank lines.  Starting a new command.")
         None
       case IR.Incomplete =>
-        in.readLine(paste.ContinueString) match {
+        in.readLine(paste.ContinuePrompt) match {
           case null =>
             // we know compilation is going to fail since we're at EOF and the
             // parser thinks the input is still incomplete, but since this is
@@ -949,8 +941,9 @@ object ILoop {
       Console.withOut(ostream) {
         val output = new JPrintWriter(new OutputStreamWriter(ostream), true) {
           // skip margin prefix for continuation lines, unless preserving session text for test
+          // should test for repl.paste.ContinueString or replProps.continueText.contains(ch)
           override def write(str: String) =
-            if (!inSession && (str forall (ch => ch.isWhitespace || ch == '|'))) ()  // repl.paste.ContinueString
+            if (!inSession && (str forall (ch => ch.isWhitespace || ch == '|'))) ()
             else super.write(str)
         }
         val input = new BufferedReader(new StringReader(code.trim + "\n")) {

src/repl/scala/tools/nsc/interpreter/IMain.scala

@@ -113,9 +113,7 @@ class IMain(@BeanProperty val factory: ScriptEngineFactory, initialSettings: Set
   def this() = this(new Settings())
 
   // the expanded prompt but without color escapes and without leading newline, for purposes of indenting
-  lazy val formatting: Formatting = new Formatting(
-    (replProps.promptString format Properties.versionNumberString).lines.toList.last.length
-  )
+  lazy val formatting = Formatting.forPrompt(replProps.promptText)
   lazy val reporter: ReplReporter = new ReplReporter(this)
 
   import formatting.indentCode

src/repl/scala/tools/nsc/interpreter/ReplProps.scala

@@ -6,9 +6,11 @@
 package scala.tools.nsc
 package interpreter
 
-import Properties.shellPromptString
+import Properties.{ javaVersion, javaVmName, shellPromptString, shellWelcomeString,
+                    versionString, versionNumberString }
 import scala.sys._
 import Prop._
+import java.util.{ Formattable, FormattableFlags, Formatter }
 
 class ReplProps {
   private def bool(name: String) = BooleanProp.keyExists(name)
@@ -22,12 +24,44 @@ class ReplProps {
   val trace = bool("scala.repl.trace")
   val power = bool("scala.repl.power")
 
-  // Handy system prop for shell prompt, or else pick it up from compiler.properties
-  val promptString = Prop[String]("scala.repl.prompt").option getOrElse (if (info) "%nscala %s> " else shellPromptString)
-  val prompt = {
+  def enversion(s: String) = {
+    import FormattableFlags._
+    val v = new Formattable {
+      override def formatTo(formatter: Formatter, flags: Int, width: Int, precision: Int) = {
+        val version = if ((flags & ALTERNATE) != 0) versionNumberString else versionString
+        val left    = if ((flags & LEFT_JUSTIFY) != 0) "-" else ""
+        val w       = if (width >= 0) s"$width" else ""
+        val p       = if (precision >= 0) s".$precision" else ""
+        val fmt     = s"%${left}${w}${p}s"
+        formatter.format(fmt, version)
+      }
+    }
+    s.format(v, javaVersion, javaVmName)
+  }
+  def encolor(s: String)   = {
     import scala.io.AnsiColor.{ MAGENTA, RESET }
-    val p = promptString format Properties.versionNumberString
-    if (colorOk) s"$MAGENTA$p$RESET" else p
+    if (colorOk) s"$MAGENTA$s$RESET" else s
+  }
+
+  // Handy system prop for shell prompt, or else pick it up from compiler.properties
+  val promptString = Prop[String]("scala.repl.prompt").option getOrElse (if (info) "%nscala %#s> " else shellPromptString)
+  val promptText   = enversion(promptString)
+  val prompt       = encolor(promptText)
+
+  // Prompt for continued input, will be right-adjusted to width of the primary prompt
+  val continueString = Prop[String]("scala.repl.continue").option getOrElse "| "
+  val continueText   = {
+    val text   = enversion(continueString)
+    val margin = promptText.lines.toList.last.length - text.length
+    if (margin > 0) " " * margin + text else text
+  }
+  val continuePrompt = encolor(continueText)
+
+  // Next time.
+  //def welcome = enversion(Prop[String]("scala.repl.welcome") or shellWelcomeString)
+  def welcome = enversion {
+    val p = Prop[String]("scala.repl.welcome")
+    if (p.isSet) p.get else shellWelcomeString
   }
 
   /** CSV of paged,across to enable pagination or `-x` style

test/files/jvm/interpreter.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> // basics
 

test/files/jvm/throws-annot-from-java.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> :power
 ** Power User mode enabled - BEEP WHIR GYVE **

test/files/jvm/xml05.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> <city name="San Jos&eacute;"/>
 res0: scala.xml.Elem = <city name="San Jos&eacute;"/>

test/files/run/class-symbol-contravariant.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> :power
 ** Power User mode enabled - BEEP WHIR GYVE **

test/files/run/constant-type.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> :power
 ** Power User mode enabled - BEEP WHIR GYVE **

test/files/run/constrained-types.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> class Annot(obj: Any) extends annotation.Annotation with annotation.TypeConstraint
 defined class Annot

test/files/run/kind-repl-command.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> :kind scala.Option
 scala.Option's kind is F[+A]

test/files/run/lub-visibility.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> // should infer List[scala.collection.immutable.Seq[Nothing]]
 

test/files/run/macro-bundle-repl.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> import scala.language.experimental.macros
 import scala.language.experimental.macros

test/files/run/macro-repl-basic.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> import language.experimental.macros
 import language.experimental.macros

test/files/run/macro-repl-dontexpand.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> def bar1(c: scala.reflect.macros.blackbox.Context) = ???
 bar1: (c: scala.reflect.macros.blackbox.Context)Nothing

test/files/run/macro-system-properties.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> import scala.language.experimental._, scala.reflect.macros.blackbox.Context
 import scala.language.experimental._

test/files/run/reflection-equality.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> class X {
    def methodIntIntInt(x: Int, y: Int) = x+y

test/files/run/reflection-magicsymbols-repl.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> import scala.reflect.runtime.universe._
 import scala.reflect.runtime.universe._

test/files/run/reflection-repl-classes.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> class A
 defined class A

test/files/run/reflection-repl-elementary.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> scala.reflect.runtime.universe.typeOf[List[Nothing]]
 res0: reflect.runtime.universe.Type = scala.List[Nothing]

test/files/run/reify-repl-fail-gracefully.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> import language.experimental.macros
 import language.experimental.macros

test/files/run/reify_newimpl_22.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> import scala.reflect.runtime.universe._
 import scala.reflect.runtime.universe._

test/files/run/reify_newimpl_23.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> import scala.reflect.runtime.universe._
 import scala.reflect.runtime.universe._

test/files/run/reify_newimpl_25.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> {
   import scala.reflect.runtime.universe._

test/files/run/reify_newimpl_26.check

@@ -1,5 +1,3 @@
-Type in expressions to have them evaluated.
-Type :help for more information.
 
 scala> def foo[T]{
   import scala.reflect.runtime.universe._