Further implementation of snippet compiler. Add package name and self type to pass context

Author: pikinier20

scaladoc/src/dotty/tools/scaladoc/api.scala

@@ -233,3 +233,5 @@ extension (s: Signature)
     }.mkString
 
 case class TastyMemberSource(val path: java.nio.file.Path, val lineNumber: Int)
+
+case class SnippetCompilerData(val packageName: String, val classType: Option[String], val classGenerics: Option[String], val imports: List[String])

scaladoc/src/dotty/tools/scaladoc/renderers/DocRenderer.scala

@@ -8,19 +8,17 @@ import dotty.tools.scaladoc.tasty.comments.wiki.WikiDocElement
 import dotty.tools.scaladoc.tasty.comments.markdown.DocFlexmarkRenderer
 import dotty.tools.scaladoc.snippets._
 
-class DocRender(signatureRenderer: SignatureRenderer)(using DocContext):
-
-  private val snippetChecker = SnippetChecker()
+class DocRender(signatureRenderer: SignatureRenderer, snippetChecker: SnippetChecker)(using DocContext):
 
   private val snippetCheckingFunc: Member => String => Unit =
   (m: Member) => {
     (str: String) => {
-      snippetChecker.checkSnippet(str) match {
-        case r @ SnippetCompilationResult(None, _) =>
-          println(s"In member ${m.name}:")
-          println(r.getSummary)
-        case _ =>
-      }
+        snippetChecker.checkSnippet(str, m.docs.map(_.snippetCompilerData)) match {
+          case r @ SnippetCompilationResult(None, _) =>
+            println(s"In member ${m.name}:")
+            println(r.getSummary)
+          case _ =>
+        }
     }
   }
 

scaladoc/src/dotty/tools/scaladoc/renderers/HtmlRenderer.scala

@@ -14,6 +14,8 @@ import java.nio.file.Files
 import java.nio.file.FileVisitOption
 import java.io.File
 
+import dotty.tools.scaladoc.snippets._
+
 case class Page(link: Link, content: Member | ResolvedTemplate | String, children: Seq[Page]):
   def withNewChildren(newChildren: Seq[Page]) = copy(children = children ++ newChildren)
 
@@ -26,6 +28,7 @@ case class Page(link: Link, content: Member | ResolvedTemplate | String, childre
 class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx: DocContext)
   extends SiteRenderer, Resources, Locations, Writer:
   private val args = summon[DocContext].args
+  private val snippetChecker = SnippetChecker()
   val staticSite = summon[DocContext].staticSiteContext
 
   val effectiveMembers = members
@@ -75,7 +78,7 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
         def link(dri: DRI): Option[String] =
           Some(pathToPage(currentDri, dri)).filter(_ != UnresolvedLocationLink)
 
-      MemberRenderer(signatureRenderer).fullMember(m)
+      MemberRenderer(signatureRenderer, snippetChecker).fullMember(m)
     case t: ResolvedTemplate => siteContent(page.link.dri, t)
     case a: String =>  raw(a)
 
@@ -122,6 +125,7 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
   def render(): Unit =
     val renderedResources = renderResources()
     val sites = allPages.map(renderPage(_, Vector.empty))
+    println(snippetChecker.summary)
 
   def mkHead(page: Page): AppliedTag =
     val resources = page.content match

scaladoc/src/dotty/tools/scaladoc/renderers/MemberRenderer.scala

@@ -9,8 +9,9 @@ import dotty.tools.scaladoc.tasty.comments.markdown.DocFlexmarkRenderer
 import com.vladsch.flexmark.util.ast.{Node => MdNode}
 import dotty.tools.scaladoc.tasty.comments.wiki.WikiDocElement
 import translators._
+import dotty.tools.scaladoc.snippets._
 
-class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) extends DocRender(signatureRenderer):
+class MemberRenderer(signatureRenderer: SignatureRenderer, snippetChecker: SnippetChecker)(using DocContext) extends DocRender(signatureRenderer, snippetChecker):
   import signatureRenderer._
 
   def doc(m: Member): Seq[AppliedTag] =  m.docs.fold(Nil)(d => Seq(renderDocPart(d.body)(using m)))

scaladoc/src/dotty/tools/scaladoc/snippets/SnippetChecker.scala

@@ -7,7 +7,25 @@ class SnippetChecker(
   private val compiler: SnippetCompiler = SnippetCompiler(),
   private val wrapper: SnippetWrapper = SnippetWrapper()
 ):
-  def checkSnippet(snippet: String): SnippetCompilationResult = {
-    val wrapped = wrapper.wrap(snippet)
-    compiler.compile(wrapped)
-  }
+  var warningsCount = 0
+  var errorsCount = 0
+
+  def checkSnippet(snippet: String, data: Option[SnippetCompilerData]): SnippetCompilationResult = {
+    val wrapped = wrapper.wrap(
+      snippet,
+      data.map(_.packageName),
+      data.flatMap(_.classType),
+      data.flatMap(_.classGenerics),
+      data.map(_.imports).getOrElse(Nil)
+    )
+    val res = compiler.compile(wrapped)
+    if !res.messages.filter(_.level == MessageLevel.Error).isEmpty then errorsCount = errorsCount + 1
+    if !res.messages.filter(_.level == MessageLevel.Warning).isEmpty then warningsCount = warningsCount + 1
+    res
+  }
+
+  def summary: String = s"""
+  |Snippet compiler summary:
+  |  Found $warningsCount warnings
+  |  Found $errorsCount errors
+  |""".stripMargin

scaladoc/src/dotty/tools/scaladoc/snippets/SnippetWrapper.scala

@@ -5,7 +5,7 @@ import java.io.ByteArrayOutputStream
 import java.io.PrintStream
 
 class SnippetWrapper:
-  extension (ps: PrintStream) def printlnWithIndent(indent: Int, str: String) =
+  extension (ps: PrintStream) private def printlnWithIndent(indent: Int, str: String) =
     ps.println((" " * indent) + str)
   def wrap(str: String): String =
     val baos = new ByteArrayOutputStream()
@@ -16,6 +16,16 @@ class SnippetWrapper:
     ps.println("}")
     baos.toString
 
+  def wrap(str:String, packageName: Option[String], className: Option[String], classGenerics: Option[String], imports: List[String]) =
+    val baos = new ByteArrayOutputStream()
+    val ps = new PrintStream(baos)
+    ps.println(s"package ${packageName.getOrElse("snippets")}")
+    imports.foreach(i => ps.println(s"import $i"))
+    ps.println(s"trait Snippet${classGenerics.getOrElse("")} { ${className.fold("")(cn => s"self: $cn =>")}")
+    str.split('\n').foreach(ps.printlnWithIndent(2, _))
+    ps.println("}")
+    baos.toString
+
 object SnippetWrapper:
-  val lineOffset = 2
-  val columnOffset = 2
+  private val lineOffset = 2
+  private val columnOffset = 2

scaladoc/src/dotty/tools/scaladoc/tasty/comments/Comments.scala

@@ -40,7 +40,8 @@ case class Comment (
   groupNames:              SortedMap[String, DocPart],
   groupPrio:               SortedMap[String, Int],
   /** List of conversions to hide - containing e.g: `scala.Predef.FloatArrayOps` */
-  hideImplicitConversions: List[DocPart]
+  hideImplicitConversions: List[DocPart],
+  snippetCompilerData:     SnippetCompilerData
 )
 
 case class PreparsedComment(
@@ -84,8 +85,7 @@ abstract class MarkupConversion[T](val repr: Repr)(using DocContext) {
   private given qctx.type = qctx
 
   object SymOpsWithLinkCache extends SymOpsWithLinkCache
-  export SymOpsWithLinkCache.dri
-  export SymOpsWithLinkCache.driInContextOfInheritingParent
+  export SymOpsWithLinkCache._
 
   def resolveLink(queryStr: String): DocLink =
     if SchemeUri.matches(queryStr) then DocLink.ToURL(queryStr)
@@ -122,6 +122,38 @@ abstract class MarkupConversion[T](val repr: Repr)(using DocContext) {
       case _ => None
     }
 
+  private def getSnippetCompilerData(sym: qctx.reflect.Symbol): SnippetCompilerData =
+    val packageName = sym.packageName
+    if !sym.isPackageDef then sym.tree match {
+      case c: qctx.reflect.ClassDef =>
+        import qctx.reflect._
+        import dotty.tools.dotc
+        given dotc.core.Contexts.Context = qctx.asInstanceOf[scala.quoted.runtime.impl.QuotesImpl].ctx
+        val cSym = c.symbol.asInstanceOf[dotc.core.Symbols.ClassSymbol]
+
+        def createTypeConstructor(tpe: dotc.core.Types.Type, topLevel: Boolean = true): String = tpe match {
+            case t @ dotc.core.Types.TypeBounds(upper, lower) => lower match {
+              case l: dotc.core.Types.HKTypeLambda =>
+                (if topLevel then "" else "?") + l.paramInfos.map(p => createTypeConstructor(p, false)).mkString("[",", ","]")
+              case _ => (if topLevel then "" else "_")
+            }
+          }
+        val classType =
+          val ct = cSym.classInfo.selfType.show.replace(".this.",".")
+          Some(ct)
+        val classGenerics = Option.when(
+            !cSym.typeParams.isEmpty
+          )(
+            cSym.typeParams.map(_.typeRef).map(t =>
+              t.show +
+              createTypeConstructor(t.asInstanceOf[dotc.core.Types.TypeRef].underlying)
+            ).mkString("[",", ","]")
+          )
+        SnippetCompilerData(packageName, classType, classGenerics, Nil)
+      case _ => getSnippetCompilerData(sym.maybeOwner)
+    } else SnippetCompilerData(packageName, None, None, Nil)
+
+
   final def parse(preparsed: PreparsedComment): Comment =
     val body = markupToDokkaCommentBody(stringToMarkup(preparsed.body))
     Comment(
@@ -144,7 +176,8 @@ abstract class MarkupConversion[T](val repr: Repr)(using DocContext) {
       groupDesc               = filterEmpty(preparsed.groupDesc).view.mapValues(markupToDokka).to(SortedMap),
       groupNames              = filterEmpty(preparsed.groupNames).view.mapValues(markupToDokka).to(SortedMap),
       groupPrio               = preparsed.groupPrio,
-      hideImplicitConversions = filterEmpty(preparsed.hideImplicitConversions).map(markupToDokka)
+      hideImplicitConversions = filterEmpty(preparsed.hideImplicitConversions).map(markupToDokka),
+      snippetCompilerData     = getSnippetCompilerData(owner)
     )
 }