Remove redundant debug mode from snippet compiler.

pikinier20 · pikinier20 · commit 6b524c7f67ee · 2021-08-02T10:39:45.000+02:00
diff --git a/scaladoc-testcases/src/tests/snippetTestcase1.scala b/scaladoc-testcases/src/tests/snippetTestcase1.scala
@@ -2,7 +2,7 @@ package tests.snippetTestcase1
 
 class SnippetTestcase1:
   /**
-    * SNIPPET(OUTERLINEOFFSET:8,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:3,INNERCOLUMNOFFSET:2)
+    * SNIPPET(OUTERLINEOFFSET:8,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:5,INNERCOLUMNOFFSET:2)
     * ERROR(LINE:8,COLUMN:8)
     * ```scala sc:fail
     * 2 + List()
@@ -11,17 +11,17 @@ class SnippetTestcase1:
     */
   def a = 3
   /**
-    * SNIPPET(OUTERLINEOFFSET:16,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:3,INNERCOLUMNOFFSET:2)
+    * SNIPPET(OUTERLINEOFFSET:16,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:5,INNERCOLUMNOFFSET:2)
     * ```scala sc:compile sc-name:1
     * val xs: List[Int] = List()
     * ```
     *
-    * SNIPPET(OUTERLINEOFFSET:21,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:3,INNERCOLUMNOFFSET:2)
+    * SNIPPET(OUTERLINEOFFSET:21,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:5,INNERCOLUMNOFFSET:2)
     * ```scala sc:compile sc-compile-with:1 sc-name:2
     * val ys = xs.map(x => x * 2)
     * ```
     *
-    * SNIPPET(OUTERLINEOFFSET:26,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:3,INNERCOLUMNOFFSET:2)
+    * SNIPPET(OUTERLINEOFFSET:26,OUTERCOLUMNOFFSET:6,INNERLINEOFFSET:5,INNERCOLUMNOFFSET:2)
     * ```scala sc:compile sc-compile-with:2
     * xs ++ ys
     * ```
diff --git a/scaladoc-testcases/src/tests/snippetTestcase2.scala b/scaladoc-testcases/src/tests/snippetTestcase2.scala
@@ -7,7 +7,7 @@ trait Quotes2[A] {
     type X
     object Y {
       /**
-        * SNIPPET(OUTERLINEOFFSET:13,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:6,INNERCOLUMNOFFSET:6)
+        * SNIPPET(OUTERLINEOFFSET:13,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:8,INNERCOLUMNOFFSET:6)
         * ERROR(LINE:13,COLUMN:12)
         * ```scala sc:fail
         * 2 + List()
@@ -19,7 +19,7 @@ trait Quotes2[A] {
      val z: zModule = ???
      trait zModule {
       /**
-        * SNIPPET(OUTERLINEOFFSET:25,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:7,INNERCOLUMNOFFSET:6)
+        * SNIPPET(OUTERLINEOFFSET:25,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:9,INNERCOLUMNOFFSET:6)
         * ERROR(LINE:25,COLUMN:12)
         * ```scala sc:fail
         * 2 + List()
@@ -33,7 +33,7 @@ trait Quotes2[A] {
     type X
     object Y {
       /**
-        * SNIPPET(OUTERLINEOFFSET:39,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:5,INNERCOLUMNOFFSET:6)
+        * SNIPPET(OUTERLINEOFFSET:39,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:7,INNERCOLUMNOFFSET:6)
         * ERROR(LINE:39,COLUMN:12)
         * ```scala sc:fail
         * 2 + List()
@@ -45,7 +45,7 @@ trait Quotes2[A] {
     val z: zModule = ???
     trait zModule {
       /**
-        * SNIPPET(OUTERLINEOFFSET:51,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:6,INNERCOLUMNOFFSET:6)
+        * SNIPPET(OUTERLINEOFFSET:51,OUTERCOLUMNOFFSET:10,INNERLINEOFFSET:8,INNERCOLUMNOFFSET:6)
         * ERROR(LINE:51,COLUMN:12)
         * ```scala sc:fail
         * 2 + List()
diff --git a/scaladoc/src/dotty/tools/scaladoc/DocContext.scala b/scaladoc/src/dotty/tools/scaladoc/DocContext.scala
@@ -74,7 +74,7 @@ case class NavigationNode(name: String, dri: DRI, nested: Seq[NavigationNode])
 case class DocContext(args: Scaladoc.Args, compilerContext: CompilerContext):
   lazy val sourceLinks = SourceLinks.load(args.sourceLinks, args.revision)(using compilerContext)
 
-  lazy val snippetCompilerArgs = snippets.SnippetCompilerArgs.load(args.snippetCompiler, args.snippetCompilerDebug)(using compilerContext)
+  lazy val snippetCompilerArgs = snippets.SnippetCompilerArgs.load(args.snippetCompiler)(using compilerContext)
 
   lazy val snippetChecker = snippets.SnippetChecker(args)(using compilerContext)
 
diff --git a/scaladoc/src/dotty/tools/scaladoc/Scaladoc.scala b/scaladoc/src/dotty/tools/scaladoc/Scaladoc.scala
@@ -55,7 +55,6 @@ object Scaladoc:
     docCanonicalBaseUrl: String = "",
     documentSyntheticTypes: Boolean = false,
     snippetCompiler: List[String] = Nil,
-    snippetCompilerDebug: Boolean = false,
     noLinkWarnings: Boolean = false,
     versionsDictionaryUrl: Option[String] = None,
     generateInkuire : Boolean = false,
@@ -222,7 +221,6 @@ object Scaladoc:
         YdocumentSyntheticTypes.get,
         snippetCompiler.get,
         noLinkWarnings.get,
-        snippetCompilerDebug.get,
         versionsDictionaryUrl.nonDefault,
         generateInkuire.get,
         apiSubdirectory.get,
diff --git a/scaladoc/src/dotty/tools/scaladoc/ScaladocSettings.scala b/scaladoc/src/dotty/tools/scaladoc/ScaladocSettings.scala
@@ -114,14 +114,11 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
   val snippetCompiler: Setting[List[String]] =
     MultiStringSetting("-snippet-compiler", "snippet-compiler", snippets.SnippetCompilerArgs.usage)
 
-  val snippetCompilerDebug: Setting[Boolean] =
-    BooleanSetting("-Ysnippet-compiler-debug", snippets.SnippetCompilerArgs.debugUsage, false)
-
   val generateInkuire: Setting[Boolean] =
     BooleanSetting("-Ygenerate-inkuire", "Generates InkuireDB and enables Hoogle-like searches", false)
 
   val apiSubdirectory: Setting[Boolean] =
     BooleanSetting("-Yapi-subdirectory", "Put the API documentation pages inside a directory `api/`", false)
 
   def scaladocSpecificSettings: Set[Setting[_]] =
-    Set(sourceLinks, syntax, revision, externalDocumentationMappings, socialLinks, skipById, skipByRegex, deprecatedSkipPackages, docRootContent, snippetCompiler, snippetCompilerDebug, generateInkuire)
+    Set(sourceLinks, syntax, revision, externalDocumentationMappings, socialLinks, skipById, skipByRegex, deprecatedSkipPackages, docRootContent, snippetCompiler, generateInkuire)
diff --git a/scaladoc/src/dotty/tools/scaladoc/site/templates.scala b/scaladoc/src/dotty/tools/scaladoc/site/templates.scala
@@ -106,7 +106,7 @@ case class TemplateFile(
       // Snippet compiler currently supports markdown only
       val parser: Parser = Parser.builder(defaultMarkdownOptions).build()
       val parsedMd = parser.parse(rendered)
-      val processed = FlexmarkSnippetProcessor.processSnippets(parsedMd, ssctx.snippetCompilerArgs.debug, snippetCheckingFunc)(using ssctx.outerCtx)
+      val processed = FlexmarkSnippetProcessor.processSnippets(parsedMd, snippetCheckingFunc)(using ssctx.outerCtx)
       HtmlRenderer.builder(defaultMarkdownOptions).build().render(processed)
 
     layoutTemplate match
diff --git a/scaladoc/src/dotty/tools/scaladoc/snippets/FlexmarkSnippetProcessor.scala b/scaladoc/src/dotty/tools/scaladoc/snippets/FlexmarkSnippetProcessor.scala
@@ -10,7 +10,7 @@ import collection.JavaConverters._
 import dotty.tools.scaladoc.tasty.comments.markdown.ExtendedFencedCodeBlock
 
 object FlexmarkSnippetProcessor:
-  def processSnippets(root: mdu.Node, debug: Boolean, checkingFunc: => SnippetChecker.SnippetCheckingFunc)(using CompilerContext): mdu.Node = {
+  def processSnippets(root: mdu.Node, checkingFunc: => SnippetChecker.SnippetCheckingFunc)(using CompilerContext): mdu.Node = {
     lazy val cf: SnippetChecker.SnippetCheckingFunc = checkingFunc
 
     val nodes = root.getDescendants().asScala.collect {
@@ -67,7 +67,7 @@ object FlexmarkSnippetProcessor:
 
         val fullSnippet = Seq(snippetImports, snippet).mkString("\n").trim
         val snippetCompilationResult = cf(fullSnippet, lineOffset, argOverride) match {
-          case result@Some(SnippetCompilationResult(wrapped, _, _, _)) if debug =>
+          case result@Some(SnippetCompilationResult(wrapped, _, _, _)) =>
             node.setContentString(wrapped.snippet)
             result
           case result =>
diff --git a/scaladoc/src/dotty/tools/scaladoc/snippets/SnippetCompiler.scala b/scaladoc/src/dotty/tools/scaladoc/snippets/SnippetCompiler.scala
@@ -59,7 +59,7 @@ class SnippetCompiler(
       case diagnostic if diagnostic.position.isPresent =>
         val diagPos = diagnostic.position.get
         val pos = Some(
-          Position(diagPos.line + line - innerLineOffset, diagPos.column + column - innerColumnOffset, diagPos.lineContent, if arg.debug then diagPos.line else diagPos.line - innerLineOffset)
+          Position(diagPos.line + line - innerLineOffset, diagPos.column + column - innerColumnOffset, diagPos.lineContent, diagPos.line)
         )
         val dmsg = Try(diagnostic.message) match {
           case Success(msg) => msg
diff --git a/scaladoc/src/dotty/tools/scaladoc/snippets/SnippetCompilerArgs.scala b/scaladoc/src/dotty/tools/scaladoc/snippets/SnippetCompilerArgs.scala
@@ -3,7 +3,7 @@ package snippets
 
 import java.nio.file.Path
 
-case class SnippetCompilerArg(flag: SCFlags, debug: Boolean):
+case class SnippetCompilerArg(flag: SCFlags):
   def overrideFlag(f: SCFlags): SnippetCompilerArg = copy(flag = f)
 
 sealed trait SCFlags(val flagName: String)
@@ -15,16 +15,16 @@ object SCFlags:
 
   def values: Seq[SCFlags] = Seq(Compile, NoCompile, Fail)
 
-case class SnippetCompilerArgs(scFlags: PathBased[SCFlags], val debug: Boolean, defaultFlag: SCFlags):
+case class SnippetCompilerArgs(scFlags: PathBased[SCFlags], defaultFlag: SCFlags):
   def get(member: Member): SnippetCompilerArg =
     member.sources
       .flatMap(s => scFlags.get(s.path).map(_.elem))
-      .fold(SnippetCompilerArg(defaultFlag, debug))(SnippetCompilerArg(_, debug))
+      .fold(SnippetCompilerArg(defaultFlag))(SnippetCompilerArg(_))
 
   def get(path: Option[Path]): SnippetCompilerArg =
     path
       .flatMap(p => scFlags.get(p).map(_.elem))
-      .fold(SnippetCompilerArg(defaultFlag, debug))(SnippetCompilerArg(_, debug))
+      .fold(SnippetCompilerArg(defaultFlag))(SnippetCompilerArg(_))
 
 
 object SnippetCompilerArgs:
@@ -46,11 +46,7 @@ object SnippetCompilerArgs:
     |
     """.stripMargin
 
-  val debugUsage = """
-  |Setting this option causes snippet compiler to print snippet as it is compiled (after wrapping).
-  """.stripMargin
-
-  def load(args: List[String], debug: Boolean, defaultFlag: SCFlags = SCFlags.NoCompile)(using CompilerContext): SnippetCompilerArgs = {
+  def load(args: List[String], defaultFlag: SCFlags = SCFlags.NoCompile)(using CompilerContext): SnippetCompilerArgs = {
     PathBased.parse[SCFlags](args)(using SCFlagsParser) match {
       case PathBased.ParsingResult(errors, res) =>
         if errors.nonEmpty then report.warning(s"""
@@ -60,7 +56,7 @@ object SnippetCompilerArgs:
             |$usage
             |""".stripMargin
         )
-        SnippetCompilerArgs(res, debug, defaultFlag)
+        SnippetCompilerArgs(res, defaultFlag)
     }
   }
 
diff --git a/scaladoc/src/dotty/tools/scaladoc/snippets/WrappedSnippet.scala b/scaladoc/src/dotty/tools/scaladoc/snippets/WrappedSnippet.scala
@@ -13,11 +13,15 @@ object WrappedSnippet:
   def apply(str: String): WrappedSnippet =
     val baos = new ByteArrayOutputStream()
     val ps = new PrintStream(baos)
+    ps.startHide()
     ps.println("package snippets")
     ps.println("object Snippet {")
+    ps.endHide()
     str.split('\n').foreach(ps.printlnWithIndent(indent, _))
+    ps.startHide()
     ps.println("}")
-    WrappedSnippet(baos.toString, 0, 0, indent, indent)
+    ps.endHide()
+    WrappedSnippet(baos.toString, 0, 0, indent + 2 /*Hide tokens*/, indent)
 
   def apply(
     str: String,
@@ -29,6 +33,7 @@ object WrappedSnippet:
   ): WrappedSnippet =
     val baos = new ByteArrayOutputStream()
     val ps = new PrintStream(baos)
+    ps.startHide()
     ps.println(s"package ${packageName.getOrElse("snippets")}")
     imports.foreach(i => ps.println(s"import $i"))
     val notEmptyClassInfos = if classInfos.isEmpty then Seq(SnippetCompilerData.ClassInfo(None, Nil, None)) else classInfos
@@ -38,17 +43,23 @@ object WrappedSnippet:
         ps.printlnWithIndent(indent * i + indent, s"val $name = self")
       }
     }
+    ps.endHide()
     str.split('\n').foreach(ps.printlnWithIndent(notEmptyClassInfos.size * indent, _))
+    ps.startHide()
     (0 to notEmptyClassInfos.size -1).reverse.foreach( i => ps.printlnWithIndent(i * indent, "}"))
+    ps.endHide()
     WrappedSnippet(
       baos.toString,
       outerLineOffset,
       outerColumnOffset,
-      notEmptyClassInfos.size + notEmptyClassInfos.flatMap(_.names).size + packageName.size,
+      notEmptyClassInfos.size + notEmptyClassInfos.flatMap(_.names).size + packageName.size + 2 /*Hide tokens*/,
       notEmptyClassInfos.size * indent
     )
 
-  extension (ps: PrintStream) private def printlnWithIndent(indent: Int, str: String) =
-    ps.println((" " * indent) + str)
+  extension (ps: PrintStream)
+    private def printlnWithIndent(indent: Int, str: String) =
+      ps.println((" " * indent) + str)
+    private def startHide() = ps.println(raw"//{")
+    private def endHide() = ps.println(raw"//}")
 
 
diff --git a/scaladoc/src/dotty/tools/scaladoc/tasty/comments/Comments.scala b/scaladoc/src/dotty/tools/scaladoc/tasty/comments/Comments.scala
@@ -197,7 +197,7 @@ class MarkdownCommentParser(repr: Repr)(using dctx: DocContext)
       .mapValues(stringToMarkup).to(SortedMap)
 
   def processSnippets(root: mdu.Node): mdu.Node =
-    FlexmarkSnippetProcessor.processSnippets(root, dctx.snippetCompilerArgs.debug, snippetCheckingFunc(owner))
+    FlexmarkSnippetProcessor.processSnippets(root, snippetCheckingFunc(owner))
 }
 
 class WikiCommentParser(repr: Repr)(using DocContext)
diff --git a/scaladoc/src/dotty/tools/scaladoc/tasty/comments/markdown/SnippetRenderer.scala b/scaladoc/src/dotty/tools/scaladoc/tasty/comments/markdown/SnippetRenderer.scala
@@ -58,6 +58,18 @@ object SnippetRenderer:
     }
     mRes.getOrElse(snippetLines)
 
+  private def wrapCommonIndent(snippetLines: Seq[SnippetLine]): Seq[SnippetLine] =
+    val nonHiddenSnippetLines = snippetLines.filter(l => !l.classes.contains("hideable"))
+    nonHiddenSnippetLines.headOption.map(_.content.takeWhile(_ == ' ')).map { prefix =>
+      val maxCommonIndent = nonHiddenSnippetLines.foldLeft(prefix) { (currPrefix, elem) =>
+        if elem.content.startsWith(currPrefix) then currPrefix else elem.content.takeWhile(_ == ' ')
+      }
+      snippetLines.map { line =>
+        if line.classes.contains("hideable") then line
+        else line.copy(content = span(cls := "hideable")(maxCommonIndent).toString + line.content.stripPrefix(maxCommonIndent))
+      }
+    }.getOrElse(snippetLines)
+
   private def wrapLineInBetween(startSymbol: Option[String], endSymbol: Option[String], line: SnippetLine): SnippetLine =
     val startIdx = startSymbol.map(s => line.content.indexOf(s))
     val endIdx = endSymbol.map(s => line.content.indexOf(s))
@@ -90,6 +102,7 @@ object SnippetRenderer:
     }
     wrapImportedSection
       .andThen(wrapHiddenSymbols)
+      .andThen(wrapCommonIndent)
       .apply(snippetLines)
 
   private def addCompileMessages(messages: Seq[SnippetCompilerMessage])(codeLines: Seq[SnippetLine]): Seq[SnippetLine] =
diff --git a/scaladoc/test/dotty/tools/scaladoc/snippets/SnippetCompilerTest.scala b/scaladoc/test/dotty/tools/scaladoc/snippets/SnippetCompilerTest.scala
@@ -18,7 +18,7 @@ class SnippetCompilerTest {
     0
   )
 
-  def runTest(str: String) = compiler.compile(wrapFn(str), SnippetCompilerArg(SCFlags.Compile, false))
+  def runTest(str: String) = compiler.compile(wrapFn(str), SnippetCompilerArg(SCFlags.Compile))
 
   private def assertSuccessfulCompilation(res: SnippetCompilationResult): Unit = res match {
     case r @ SnippetCompilationResult(_, isSuccessful, _, messages) => assert(isSuccessful, r.getSummary)
diff --git a/scaladoc/test/dotty/tools/scaladoc/snippets/SnippetsE2eTest.scala b/scaladoc/test/dotty/tools/scaladoc/snippets/SnippetsE2eTest.scala
@@ -18,7 +18,7 @@ import collection.JavaConverters._
 
 import dotty.tools.scaladoc.tasty.comments.markdown.ExtendedFencedCodeBlock
 
-abstract class SnippetsE2eTest(testName: String, flag: SCFlags, debug: Boolean) extends ScaladocTest(testName):
+abstract class SnippetsE2eTest(testName: String, flag: SCFlags) extends ScaladocTest(testName):
 
   import SnippetsE2eTest._
 
@@ -29,16 +29,13 @@ abstract class SnippetsE2eTest(testName: String, flag: SCFlags, debug: Boolean)
   def report(str: String) = s"""|In test $testName:
                                 |$str""".stripMargin
 
-  println(BuildInfo.test_testcasesOutputDir.map(_ + s"/tests/$testName"))
-
   override def args = Scaladoc.Args(
       name = "test",
       tastyDirs = BuildInfo.test_testcasesOutputDir.map(java.io.File(_)).toSeq,
       tastyFiles = tastyFiles(testName),
       output = getTempDir().getRoot,
       projectVersion = Some("1.0"),
-      snippetCompiler = List(s"${BuildInfo.test_testcasesSourceRoot}/tests=${flag.flagName}"),
-      snippetCompilerDebug = debug
+      snippetCompiler = List(s"${BuildInfo.test_testcasesSourceRoot}/tests=${flag.flagName}")
     )
 
   override def withModule(op: DocContext ?=> Module => Unit) =
@@ -85,17 +82,10 @@ abstract class SnippetsE2eTest(testName: String, flag: SCFlags, debug: Boolean)
 
     def checkRelativeLines(msg: Message, cmsg: SnippetCompilerMessage): Seq[String] =
       val pos = cmsg.position.get
-      if debug then {
-        if !(pos.relativeLine == pos.line - ws.outerLineOffset + ws.innerLineOffset) then Seq(
-          s"Expected ${msg.level.text} message at relative line: ${pos.line - ws.outerLineOffset + ws.innerLineOffset} " +
-            s"but found at ${pos.relativeLine}"
-        ) else Nil
-      } else {
-        if !(pos.relativeLine == pos.line - ws.outerLineOffset) then Seq(
-          s"Expected ${msg.level.text} message at relative line: ${pos.line - ws.outerLineOffset} " +
-            s"but found at ${pos.relativeLine}"
-        ) else Nil
-      }
+      if !(pos.relativeLine == pos.line - ws.outerLineOffset + ws.innerLineOffset) then Seq(
+        s"Expected ${msg.level.text} message at relative line: ${pos.line - ws.outerLineOffset + ws.innerLineOffset} " +
+          s"but found at ${pos.relativeLine}"
+      ) else Nil
 
     val mResult = compilationMessagesWithPos.flatMap { cmsg =>
       messages
diff --git a/scaladoc/test/dotty/tools/scaladoc/snippets/SnippetsE2eTestcases.scala b/scaladoc/test/dotty/tools/scaladoc/snippets/SnippetsE2eTestcases.scala
@@ -1,10 +1,8 @@
 package dotty.tools.scaladoc
 package snippets
 
-class SnippetE2eTestcase1 extends SnippetsE2eTest("snippetTestcase1", SCFlags.Compile, false)
+class SnippetE2eTestcase1 extends SnippetsE2eTest("snippetTestcase1", SCFlags.Compile)
 
-class SnippetE2eTestcase1Debug extends SnippetsE2eTest("snippetTestcase1", SCFlags.Compile, true)
 
-class SnippetE2eTestcase2 extends SnippetsE2eTest("snippetTestcase2", SCFlags.Compile, false)
+class SnippetE2eTestcase2 extends SnippetsE2eTest("snippetTestcase2", SCFlags.Compile)
 
-class SnippetE2eTestcase2Debug extends SnippetsE2eTest("snippetTestcase2", SCFlags.Compile, true)

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ class SnippetCompiler(`
`59`	`59`	`case diagnostic if diagnostic.position.isPresent =>`
`60`	`60`	`val diagPos = diagnostic.position.get`
`61`	`61`	`val pos = Some(`
`62`		`- Position(diagPos.line + line - innerLineOffset, diagPos.column + column - innerColumnOffset, diagPos.lineContent, if arg.debug then diagPos.line else diagPos.line - innerLineOffset)`
	`62`	`+ Position(diagPos.line + line - innerLineOffset, diagPos.column + column - innerColumnOffset, diagPos.lineContent, diagPos.line)`
`63`	`63`	`)`
`64`	`64`	`val dmsg = Try(diagnostic.message) match {`
`65`	`65`	`case Success(msg) => msg`