Extensive help text for -opt-inline-from

Allows StringSetting to be helping.

Author: lrytz

src/compiler/scala/tools/nsc/settings/AbsScalaSettings.scala

@@ -38,6 +38,6 @@ trait AbsScalaSettings {
   def OutputSetting(outputDirs: OutputDirs, default: String): OutputSetting
   def PathSetting(name: String, descr: String, default: String): PathSetting
   def PhasesSetting(name: String, descr: String, default: String): PhasesSetting
-  def StringSetting(name: String, helpArg: String, descr: String, default: String): StringSetting
+  def StringSetting(name: String, helpArg: String, descr: String, default: String, helpText: Option[String] = None): StringSetting
   def PrefixSetting(name: String, prefix: String, descr: String): PrefixSetting
 }

src/compiler/scala/tools/nsc/settings/MutableSettings.scala

@@ -235,7 +235,7 @@ class MutableSettings(val errorFn: String => Unit)
     add(new MultiChoiceSetting[E](name, helpArg, descr, domain, default))
   def OutputSetting(outputDirs: OutputDirs, default: String) = add(new OutputSetting(outputDirs, default))
   def PhasesSetting(name: String, descr: String, default: String = "") = add(new PhasesSetting(name, descr, default))
-  def StringSetting(name: String, arg: String, descr: String, default: String) = add(new StringSetting(name, arg, descr, default))
+  def StringSetting(name: String, arg: String, descr: String, default: String, helpText: Option[String]) = add(new StringSetting(name, arg, descr, default, helpText))
   def ScalaVersionSetting(name: String, arg: String, descr: String, initial: ScalaVersion, default: Option[ScalaVersion] = None) =
     add(new ScalaVersionSetting(name, arg, descr, initial, default))
   def PathSetting(name: String, descr: String, default: String): PathSetting = {
@@ -500,18 +500,30 @@ class MutableSettings(val errorFn: String => Unit)
     name: String,
     val arg: String,
     descr: String,
-    val default: String)
+    val default: String,
+    helpText: Option[String])
   extends Setting(name, descr) {
     type T = String
     protected var v: T = default
 
+    protected var sawHelp: Boolean = false
+
     def tryToSet(args: List[String]) = args match {
       case Nil      => errorAndValue("missing argument", None)
-      case x :: xs  => value = x ; Some(xs)
+      case x :: xs  =>
+        if (helpText.nonEmpty && x == "help")
+          sawHelp = true
+        else
+          value = x
+        Some(xs)
     }
     def unparse: List[String] = if (value == default) Nil else List(name, value)
 
     withHelpSyntax(name + " <" + arg + ">")
+
+    override def isHelping: Boolean = sawHelp
+
+    override def help = helpText.get
   }
 
   /** A setting represented by a Scala version.
@@ -554,7 +566,7 @@ class MutableSettings(val errorFn: String => Unit)
     default: String,
     prependPath: StringSetting,
     appendPath: StringSetting)
-  extends StringSetting(name, "path", descr, default) {
+  extends StringSetting(name, "path", descr, default, None) {
     import util.ClassPath.join
     def prepend(s: String) = prependPath.value = join(s, prependPath.value)
     def append(s: String) = appendPath.value = join(appendPath.value, s)
@@ -571,7 +583,7 @@ class MutableSettings(val errorFn: String => Unit)
   class OutputSetting private[nsc](
     private[nsc] val outputDirs: OutputDirs,
     default: String)
-    extends StringSetting("-d", "directory|jar", "destination for generated classfiles.", default) {
+    extends StringSetting("-d", "directory|jar", "destination for generated classfiles.", default, None) {
       value = default
       override def value_=(str: String) {
         super.value_=(str)

src/compiler/scala/tools/nsc/settings/ScalaSettings.scala

@@ -307,8 +307,26 @@ trait ScalaSettings extends AbsScalaSettings
   val optInlineFrom = StringSetting(
     "-opt-inline-from",
     "patterns",
-    "Classfile name patterns from which to allow inlining. ** = anything, * = package or class name, ! to exclude. Example: scala.**:!scala.Predef$:corp.*.util.*:corp.**.*Util*",
-    "")
+    "Patterns for classfile names from which to allow inlining, `help` for details.",
+    "",
+    helpText = Some(
+      """Patterns for classfile names from which the inliner is allowed to pull in code.
+        |  *              Matches classes in the empty package
+        |  **             All classes
+        |  a.C            Class a.C
+        |  a.*            Classes in package a
+        |  a.**           Classes in a and in sub-packages of a
+        |  **.Util        Classes named Util in any package (including the empty package)
+        |  a.**.*Util*    Classes in a and sub-packages with Util in their name (including a.Util)
+        |  a.C$D          The nested class D defined in class a.C
+        |  scala.Predef$  The scala.Predef object
+        |
+        |The setting accepts a colon-separated list of patterns. A leading `!` marks a pattern excluding.
+        |The last matching pattern defines whether a classfile is included or excluded (default: excluded).
+        |For example, `a.**:!a.b.**` includes classes in a and sub-packages, but not in a.b and sub-packages.
+        |
+        |Note: on the command-line you might need to quote patterns containing `*` to prevent the shell
+        |from expanding it to a list of files in the current directory.""".stripMargin))
 
   val YoptInlineHeuristics = ChoiceSetting(
     name = "-Yopt-inline-heuristics",