Scaladoc: Option to fully disable capture checking

Author: bracevac

project/ScaladocGeneration.scala

@@ -141,6 +141,10 @@ object ScaladocGeneration {
     def key: String = "-dynamic-side-menu"
   }
 
+  case class SuppressCC(value: Boolean) extends Arg[Boolean] {
+    def key: String = "-suppressCC"
+  }
+
   import _root_.scala.reflect._
 
   trait GenerationConfig {

scaladoc/src/dotty/tools/scaladoc/Scaladoc.scala

@@ -47,6 +47,7 @@ object Scaladoc:
     defaultTemplate: Option[String] = None,
     quickLinks: List[QuickLink] = List.empty,
     dynamicSideMenu: Boolean = false,
+    suppressCC: Boolean = false, // suppress rendering anything related to experimental capture checking
   )
 
   def run(args: Array[String], rootContext: CompilerContext): Reporter =
@@ -231,6 +232,7 @@ object Scaladoc:
         defaultTemplate.nonDefault,
         quickLinksParsed,
         dynamicSideMenu.get,
+        suppressCC.get,
       )
       (Some(docArgs), newContext)
     }

scaladoc/src/dotty/tools/scaladoc/ScaladocSettings.scala

@@ -144,5 +144,8 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
   val dynamicSideMenu: Setting[Boolean] =
     BooleanSetting(RootSetting, "dynamic-side-menu", "Generate side menu via JS instead of embedding it in every html file", false)
 
+  val suppressCC: Setting[Boolean] =
+    BooleanSetting(RootSetting, "suppressCC", "Suppress rendering anything related to experimental capture checking", false)
+
   def scaladocSpecificSettings: Set[Setting[?]] =
-    Set(sourceLinks, legacySourceLink, syntax, revision, externalDocumentationMappings, socialLinks, skipById, skipByRegex, deprecatedSkipPackages, docRootContent, snippetCompiler, generateInkuire, defaultTemplate, scastieConfiguration, quickLinks, dynamicSideMenu)
+    Set(sourceLinks, legacySourceLink, syntax, revision, externalDocumentationMappings, socialLinks, skipById, skipByRegex, deprecatedSkipPackages, docRootContent, snippetCompiler, generateInkuire, defaultTemplate, scastieConfiguration, quickLinks, dynamicSideMenu, suppressCC)

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

@@ -177,7 +177,8 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
       cls := s"documentableName $depStyle",
     )
 
-    val signature: MemberSignature = signatureProvider.rawSignature(member)()
+    val ctx = summon[DocContext]
+    val signature: MemberSignature = signatureProvider.rawSignature(member)(!ctx.args.suppressCC)()
     val isSubtype = signature.suffix.exists {
       case Keyword(keyword) => keyword.contains("extends")
       case _ => false

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

@@ -213,7 +213,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
       val (res, pageName) =  page.content match
         case m: Member if m.kind != Kind.RootPackage =>
           def processMember(member: Member, fqName: List[String]): Seq[(JSON, Seq[String])] =
-            val signature: MemberSignature = signatureProvider.rawSignature(member)()
+            val signature: MemberSignature = signatureProvider.rawSignature(member)(!ctx.args.suppressCC)()
             val sig = Signature(Plain(member.name)) ++ signature.suffix
             val descr = if member.kind == Kind.Package then "" else fqName.mkString(".")
             val extraDescr = member.docs.map(d => docPartRenderPlain(d.body)).getOrElse("")

scaladoc/src/dotty/tools/scaladoc/tasty/BasicSupport.scala

@@ -43,7 +43,7 @@ trait BasicSupport:
     def getAnnotations(): List[Annotation] =
       // Custom annotations should be documented only if annotated by @java.lang.annotation.Documented
       // We allow also some special cases
-      val fqNameAllowlist = Set(
+      val fqNameAllowlist0 = Set(
         "scala.specialized",
         "scala.throws",
         "scala.transient",
@@ -54,9 +54,11 @@ trait BasicSupport:
         "scala.annotation.targetName",
         "scala.annotation.threadUnsafe",
         "scala.annotation.varargs",
-        CaptureDefs.useAnnotFullName,
-        CaptureDefs.consumeAnnotFullName,
       )
+      val fqNameAllowlist =
+        if ccEnabled then
+          fqNameAllowlist0 + CaptureDefs.useAnnotFullName + CaptureDefs.consumeAnnotFullName
+        else fqNameAllowlist0
       val documentedSymbol = summon[Quotes].reflect.Symbol.requiredClass("java.lang.annotation.Documented")
       val annotations = sym.annotations.filter { a =>
         a.tpe.typeSymbol.hasAnnotation(documentedSymbol) || fqNameAllowlist.contains(a.symbol.fullName)

scaladoc/src/dotty/tools/scaladoc/tasty/ClassLikeSupport.scala

@@ -21,6 +21,15 @@ trait ClassLikeSupport:
 
   private given qctx.type = qctx
 
+  extension (symbol: Symbol) {
+    def getExtraModifiers(): Seq[Modifier] =
+      val mods = SymOps.getExtraModifiers(symbol)()
+      if ccEnabled && symbol.flags.is(Flags.Mutable)then
+        mods :+ Modifier.Update
+      else
+        mods
+  }
+
   private def bareClasslikeKind(using Quotes)(symbol: reflect.Symbol): Kind =
     import reflect._
     if symbol.flags.is(Flags.Module) then Kind.Object

scaladoc/src/dotty/tools/scaladoc/tasty/PackageSupport.scala

@@ -15,7 +15,7 @@ trait PackageSupport:
 
     def parsePackage(pck: PackageClause): (String, Member) =
       val name = pck.symbol.fullName
-      ccFlag = false // FIXME: would be better if we had access to the tasty attribute
+      ccFlag = false
       pck.stats.foreach {
           case CCImport() => ccFlag = true
           case _ =>

scaladoc/src/dotty/tools/scaladoc/tasty/SymOps.scala

@@ -100,7 +100,6 @@ object SymOps:
         Flags.Case -> Modifier.Case,
         Flags.Opaque -> Modifier.Opaque,
         Flags.AbsOverride -> Modifier.AbsOverride,
-        Flags.Mutable -> Modifier.Update, // under CC
       ).collect {
         case (flag, mod) if sym.flags.is(flag) => mod
       }

scaladoc/src/dotty/tools/scaladoc/tasty/TastyParser.scala

@@ -188,7 +188,7 @@ case class TastyParser(
   private given qctx.type = qctx
 
   protected var ccFlag: Boolean = false
-  def ccEnabled: Boolean = ccFlag
+  def ccEnabled: Boolean = !ctx.args.suppressCC && ccFlag
 
   val intrinsicClassDefs = Set(
     defn.AnyClass,