Merge pull request #11582 from pikinier20/snippet-compiler

Snippet compiler

Author: pikinier20

compiler/src/dotty/tools/dotc/reporting/StoreReporter.scala

@@ -37,7 +37,7 @@ class StoreReporter(outer: Reporter = Reporter.NoReporter) extends Reporter {
     if (infos != null) try infos.toList finally infos = null
     else Nil
 
-  override def pendingMessages(using Context): List[Diagnostic] = infos.toList
+  override def pendingMessages(using Context): List[Diagnostic] = if (infos != null) infos.toList else Nil
 
   override def errorsReported: Boolean = hasErrors || (outer != null && outer.errorsReported)
 }

dist/bin/scaladoc

@@ -127,6 +127,7 @@ eval "\"$JAVACMD\"" \
      ${JAVA_OPTS:-$default_java_opts} \
      "${java_args[@]}" \
      "${jvm_cp_args-}" \
+      -Dscala.usejavacp=true \
      "dotty.tools.scaladoc.Main"  \
      "${scala_args[@]}" \
      "${residual_args[@]}" \

docs/css/dottydoc.css

@@ -180,18 +180,6 @@ h5:hover a.anchor:hover {
   font-family: var(--font-family-monospace);
 }
 
-/* code */
-pre, code {
-  font-variant-ligatures: none;
-}
-pre {
-  padding: 0;
-  font-size: 13px;
-  background: var(--pre-bg);
-  border-radius: 2px;
-  border: 1px solid rgba(0, 0, 0, 0.1);
-}
-
 /* admonitions */
 blockquote {
   padding: 0 1em;

project/Build.scala

@@ -1243,16 +1243,19 @@ object Build {
       libraryDependencies += ("org.scala-js" %%% "scalajs-dom" % "1.1.0").cross(CrossVersion.for3Use2_13)
     )
 
-  def generateDocumentation(targets: Seq[String], name: String, outDir: String, ref: String, params: Seq[String] = Nil) =
+  def generateDocumentation(targets: Seq[String], name: String, outDir: String, ref: String, params: Seq[String] = Nil, usingScript: Boolean = true) =
     Def.taskDyn {
       val distLocation = (dist / pack).value
       val projectVersion = version.value
       IO.createDirectory(file(outDir))
       val stdLibVersion = stdlibVersion(Bootstrapped)
+      val scalaLib = findArtifactPath(externalCompilerClasspathTask.value, "scala-library")
+      val dottyLib = (`scala3-library` / Compile / classDirectory).value
       // TODO add versions etc.
       def srcManaged(v: String, s: String) = s"out/bootstrap/stdlib-bootstrapped/scala-$v/src_managed/main/$s-library-src"
       def scalaSrcLink(v: String, s: String) = s"-source-links:$s=github://scala/scala/v$v#src/library"
       def dottySrcLink(v: String, s: String) = s"-source-links:$s=github://lampepfl/dotty/$v#library/src"
+
       val revision = Seq("-revision", ref, "-project-version", projectVersion)
       val cmd = Seq(
         "-d",
@@ -1264,7 +1267,20 @@ object Build {
         s"-source-links:github://lampepfl/dotty/$referenceVersion",
       ) ++ scalacOptionsDocSettings ++ revision ++ params ++ targets
       import _root_.scala.sys.process._
-      Def.task((s"$distLocation/bin/scaladoc" +: cmd).!)
+      if (usingScript)
+        Def.task((s"$distLocation/bin/scaladoc" +: cmd).!)
+      else {
+        val escapedCmd = cmd.map(arg => if(arg.contains(" ")) s""""$arg"""" else arg)
+        Def.task {
+          try {
+            (Compile / run).toTask(escapedCmd.mkString(" ", " ", "")).value
+            0
+          } catch {
+            case _ : Throwable => 1
+          }
+        }
+      }
+
     }
 
   val SourceLinksIntegrationTest = config("sourceLinksIntegrationTest") extend Test
@@ -1311,7 +1327,7 @@ object Build {
       generateSelfDocumentation := Def.taskDyn {
         generateDocumentation(
           (Compile / classDirectory).value.getAbsolutePath :: Nil,
-          "scaladoc", "scaladoc/output/self", VersionUtil.gitHash,
+          "scaladoc", "scaladoc/output/self", VersionUtil.gitHash
         )
       }.value,
       generateScalaDocumentation := Def.inputTaskDyn {
@@ -1352,7 +1368,7 @@ object Build {
             s"-source-links:docs=github://lampepfl/dotty/master#docs",
             "-doc-root-content", docRootFile.toString,
             "-Ydocument-synthetic-types"
-          )
+          ), usingScript = false
         ))
       }.evaluated,
 
@@ -1361,7 +1377,8 @@ object Build {
           (Test / Build.testcasesOutputDir).value,
           "scaladoc testcases",
           "scaladoc/output/testcases",
-          "master")
+          "master"
+        )
       }.value,
 
       Test / buildInfoKeys := Seq[BuildInfoKey](

scaladoc-js/resources/scaladoc-searchbar.css

@@ -100,5 +100,38 @@
 
 .pull-right {
     float: right;
-    margin-left: auto
+    margin-left: auto;
 }
+
+.snippet-comment-button {
+    position: absolute;
+    display: inline-block;
+    left: 50%;
+    width: 24px;
+    height: 24px;
+    background:
+        linear-gradient(#fff, #fff),
+        linear-gradient(#fff, #fff),
+        #aaa;
+    background-position: center;
+    background-size: 50% 2px, 2px 50%;
+    background-repeat: no-repeat;
+    border-radius: 12px;
+    box-shadow: 0 0 2px black;
+}
+
+.snippet-comment-button:hover {
+    background:
+        linear-gradient(#444, #444),
+        linear-gradient(#444, #444),
+        #ddd;
+    background-position: center;
+    background-size: 50% 2px, 2px 50%;
+    background-repeat: no-repeat;
+}
+
+.hide-snippet-comments-button {
+    -ms-transform: rotate(45deg);
+    transform: rotate(45deg);
+}
+

scaladoc-js/src/Main.scala

@@ -3,4 +3,5 @@ package dotty.tools.scaladoc
 object Main extends App {
   Searchbar()
   SocialLinks()
+  CodeSnippets()
 }

scaladoc-js/src/searchbar/code-snippets/CodeSnippets.scala

@@ -0,0 +1,27 @@
+package dotty.tools.scaladoc
+
+import org.scalajs.dom._
+import org.scalajs.dom.ext._
+
+class CodeSnippets:
+  def toggleHide(e: html.Element | html.Document) = e.querySelectorAll("code span.hideable").foreach {
+    case e: html.Element if e.style.getPropertyValue("display").isEmpty => e.style.setProperty("display", "none")
+    case e: html.Element => e.style.removeProperty("display")
+  }
+
+  toggleHide(document)
+
+  document.querySelectorAll("pre").foreach {
+    case e: html.Element if e.querySelectorAll("code span.hideable").nonEmpty =>
+      val a = document.createElement("a")
+      a.addEventListener("click", { (_: MouseEvent) =>
+        if(a.classList.contains("hide-snippet-comments-button")) {
+          a.classList.remove("hide-snippet-comments-button")
+        } else {
+          a.classList.add("hide-snippet-comments-button")
+        }
+        toggleHide(e)
+      })
+      a.classList.add("snippet-comment-button")
+      e.insertBefore(a, e.firstChild)
+  }

scaladoc-testcases/docs/docs/index.md

@@ -0,0 +1,13 @@
+---
+
+
+---
+
+```scala sc:compile
+2 + List(0)
+```
+
+```scala sc:compile
+new snippetCompiler.Snippet0 { }
+```
+

scaladoc-testcases/src/tests/snippetComments.scala

@@ -0,0 +1,31 @@
+package tests.snippetComments
+
+
+/**
+ * This is my codeblock
+ * 
+ * ```
+ * //{{
+ * import xd
+ * import xd2
+ * //}}
+ *
+ *
+ * val x = 1 // This is my valid comment
+ *
+ * /*
+ *  multi line comment
+ *  */
+ * val reallyFLongDeclaration = "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
+ * val y = 2 // comment in the same line
+ * // comment in new line
+ * val z = 3
+ * 
+ * //{{
+ * val hideMe = 7
+ * //}}
+ * ```
+ *
+ * The end of my codeblock
+ */
+class A

scaladoc-testcases/src/tests/snippetCompilerTests.scala

@@ -0,0 +1,68 @@
+package tests
+package snippetCompilerTests
+
+/**
+  * ```scala sc:compile
+  * //{
+  * import scala.collection.Seq
+  * //}
+  *
+  * def a = 2
+  * val x = 1 + List()
+  * a
+  *
+  * try {
+  *   2+3
+  * }
+  *
+  * /*
+  *   Huge comment
+  * */
+  * val xd: String = 42
+  *
+  * def a(i: Int): Boolean = i match // This is a function
+  *   case 1 => true
+  *
+  * val b: Int = 2.3 /* Also quite a big comment */
+  *
+  * val d: Long = "asd"
+  * ```
+  *
+  * ```scala sc:fail
+  * def a = 2
+  * val x = 1 + List()
+  * a
+  * ```
+  *
+  * ```scala sc:fail
+  * def a = 2
+  * ```
+  *
+  * ```scala sc:nocompile
+  * def a = 3
+  * a()
+  * ```
+  */
+class A {
+  trait B
+}
+
+/**
+ * ```scala sc:compile
+ * val c: Int = 4.5
+ * ```
+ */
+class B { }
+
+trait Quotes {
+  val reflect: reflectModule = ???
+  trait reflectModule { self: reflect.type =>
+    /**
+      * ```scala sc:compile
+      * 2 + List()
+      * ```
+      *
+      */
+    def a = 3
+  }
+}