Merge pull request #10201 from dotty-staging/clenup-quote-matcher

Cleanup quote matcher API and docs

Author: nicolasstucki

compiler/src/dotty/tools/dotc/ast/Desugar.scala

@@ -919,8 +919,8 @@ object desugar {
   def quotedPatternTypeDef(tree: TypeDef)(using Context): TypeDef = {
     assert(ctx.mode.is(Mode.QuotedPattern))
     if (tree.name.startsWith("$") && !tree.isBackquoted) {
-      val patternBindHoleAnnot = New(ref(defn.InternalQuotedPatterns_patternTypeAnnot.typeRef)).withSpan(tree.span)
-      val mods = tree.mods.withAddedAnnotation(patternBindHoleAnnot)
+      val patternTypeAnnot = New(ref(defn.InternalQuotedPatterns_patternTypeAnnot.typeRef)).withSpan(tree.span)
+      val mods = tree.mods.withAddedAnnotation(patternTypeAnnot)
       tree.withMods(mods)
     }
     else tree

compiler/src/dotty/tools/dotc/typer/QuotesAndSplices.scala

@@ -197,7 +197,7 @@ trait QuotesAndSplices {
       )
 
   /** Split a typed quoted pattern is split into its type bindings, pattern expression and inner patterns.
-   *  Type definitions with `@patternBindHole` will be inserted in the pattern expression for each type binding.
+   *  Type definitions with `@patternType` will be inserted in the pattern expression for each type binding.
    *
    *  A quote pattern
    *  ```
@@ -208,7 +208,7 @@ trait QuotesAndSplices {
    *  (
    *    Map(<$t>: Symbol -> <$t @ _>: Bind),
    *    <'{
-   *       @scala.internal.Quoted.patternBindHole type $t
+   *       @scala.internal.Quoted.patternType type $t
    *       scala.internal.Quoted.patternHole[List[$t]]
    *    }>: Tree,
    *    List(<ls: Expr[List[$t]]>: Tree)
@@ -366,7 +366,7 @@ trait QuotesAndSplices {
    *  ```
    *
    *  For each type splice we will create a new type binding in the pattern match ($t @ _ in this case)
-   *  and a corresponding type in the quoted pattern as a hole (@patternBindHole type $t in this case).
+   *  and a corresponding type in the quoted pattern as a hole (@patternType type $t in this case).
    *  All these generated types are inserted at the start of the quoted code.
    *
    *  After typing the tree will resemble
@@ -388,7 +388,7 @@ trait QuotesAndSplices {
    *            (implicit t @ _, ls @ _: Expr[List[$t]]) // from the spliced patterns
    *        )(
    *         '{ // Runtime quote Matcher.unapply uses to mach against. Expression directly inside the quoted pattern without the splices
-   *            @scala.internal.Quoted.patternBindHole type $t
+   *            @scala.internal.Quoted.patternType type $t
    *            scala.internal.Quoted.patternHole[List[$t]]
    *          },
    *          true, // If there is at least one type splice. Used to instantiate the context with or without GADT constraints

docs/docs/reference/other-new-features/quoted-pattern-spec.md

@@ -5,28 +5,23 @@ import scala.annotation.{Annotation, compileTimeOnly}
 object Patterns {
 
   /** A splice in a quoted pattern is desugared by the compiler into a call to this method */
-  @compileTimeOnly("Illegal reference to `scala.internal.quoted.CompileTime.patternHole`")
+  @compileTimeOnly("Illegal reference to `scala.internal.quoted.Patterns.patternHole`")
   def patternHole[T]: T = ???
 
-  @compileTimeOnly("Illegal reference to `scala.internal.quoted.CompileTime.patternHigherOrderHole`")
+  @compileTimeOnly("Illegal reference to `scala.internal.quoted.Patterns.patternHigherOrderHole`")
   /** A higher order splice in a quoted pattern is desugared by the compiler into a call to this method */
   def patternHigherOrderHole[U](pat: Any, args: Any*): U = ???
 
-  @compileTimeOnly("Illegal reference to `scala.internal.quoted.CompileTime.higherOrderHole`")
+  @compileTimeOnly("Illegal reference to `scala.internal.quoted.Patterns.higherOrderHole`")
   /** A higher order splice in a quoted pattern is desugared by the compiler into a call to this method */
   def higherOrderHole[U](args: Any*): U = ???
 
-  // TODO remove
-  /** A splice of a name in a quoted pattern is desugared by wrapping getting this annotation */
-  @compileTimeOnly("Illegal reference to `scala.internal.quoted.CompileTime.patternBindHole`")
-  class patternBindHole extends Annotation
-
   /** A splice of a name in a quoted pattern is that marks the definition of a type splice */
-  @compileTimeOnly("Illegal reference to `scala.internal.quoted.CompileTime.patternType`")
+  @compileTimeOnly("Illegal reference to `scala.internal.quoted.Patterns.patternType`")
   class patternType extends Annotation
 
   /** A type pattern that must be aproximated from above */
-  @compileTimeOnly("Illegal reference to `scala.internal.quoted.CompileTime.fromAbove`")
+  @compileTimeOnly("Illegal reference to `scala.internal.quoted.Patterns.fromAbove`")
   class fromAbove extends Annotation
 
 }