Exclude named given from synthetics (when name starts with given_)

Author: tanishiking

compiler/src/dotty/tools/dotc/semanticdb/ExtractSemanticDB.scala

@@ -168,11 +168,11 @@ class ExtractSemanticDB extends Phase:
                 // ignore rhs
 
               // `given Int` (syntax sugar of `given given_Int: Int`)
-              case tree: ValDef if tree.symbol.isInventedGiven =>
-                synth.tryFindSynthetic(tree).foreach { synth =>
-                  synthetics += synth
-                }
-                traverse(tree.tpt)
+              case tree: ValDef if isInventedGiven(tree) =>
+                  synth.tryFindSynthetic(tree).foreach { synth =>
+                    synthetics += synth
+                  }
+                  traverse(tree.tpt)
               case PatternValDef(pat, rhs) =>
                 traverse(rhs)
                 PatternValDef.collectPats(pat).foreach(traverse)
@@ -334,24 +334,6 @@ class ExtractSemanticDB extends Phase:
       if !sym.is(Package) then
         registerSymbol(sym, symkinds)
 
-    private def namePresentInSource(sym: Symbol, span: Span, source:SourceFile)(using Context): Boolean =
-      if !span.exists then false
-      else
-        val content = source.content()
-        val (start, end) =
-          if content.lift(span.end - 1).exists(_ == '`') then
-            (span.start + 1, span.end - 1)
-          else (span.start, span.end)
-        val nameInSource = content.slice(start, end).mkString
-        // for secondary constructors `this`
-        if sym.isConstructor && nameInSource == nme.THISkw.toString then
-          true
-        else
-          val target =
-            if sym.isPackageObject then sym.owner
-            else sym
-          nameInSource == target.name.stripModuleClassSuffix.lastPart.toString
-
     private def spanOfSymbol(sym: Symbol, span: Span, treeSource: SourceFile)(using Context): Span =
       val contents = if treeSource.exists then treeSource.content() else Array.empty[Char]
       val idx = contents.indexOfSlice(sym.name.show, span.start)

compiler/src/dotty/tools/dotc/semanticdb/Scala3.scala

@@ -36,6 +36,24 @@ object Scala3:
     val (endLine, endCol) = lineCol(span.end)
     Some(Range(startLine, startCol, endLine, endCol))
 
+  def namePresentInSource(sym: Symbol, span: Span, source:SourceFile)(using Context): Boolean =
+    if !span.exists then false
+    else
+      val content = source.content()
+      val (start, end) =
+        if content.lift(span.end - 1).exists(_ == '`') then
+          (span.start + 1, span.end - 1)
+        else (span.start, span.end)
+      val nameInSource = content.slice(start, end).mkString
+      // for secondary constructors `this`
+      if sym.isConstructor && nameInSource == nme.THISkw.toString then
+        true
+      else
+        val target =
+          if sym.isPackageObject then sym.owner
+          else sym
+        nameInSource == target.name.stripModuleClassSuffix.lastPart.toString
+
   sealed trait FakeSymbol {
     private[Scala3] var sname: Option[String] = None
   }
@@ -230,12 +248,6 @@ object Scala3:
       def isSyntheticWithIdent(using Context): Boolean =
         sym.is(Synthetic) && !sym.isAnonymous && !sym.name.isEmptyNumbered
 
-      /** Check if the symbol is invented by Desugar.inventGivenOrExtensionName
-       *  return true if the symbol is defined as `given Int = ...` and name is invented as "given_Int"
-       */
-      def isInventedGiven(using Context): Boolean =
-        sym.is(Given) && sym.name.startsWith("given_")
-
       /** The semanticdb name of the given symbol */
       def symbolName(using builder: SemanticSymbolBuilder)(using Context): String =
         builder.symbolName(sym)
@@ -498,4 +510,16 @@ object Scala3:
 
   end IdentifierOrdering
 
+  /** Check if the symbol is invented by Desugar.inventGivenOrExtensionName
+   *  return true if the symbol is defined as `given Int = ...` and name is invented as "given_Int"
+   */
+  def isInventedGiven(tree: tpd.Tree)(using Context): Boolean =
+    tree match
+      case tree: tpd.ValDef =>
+        val sym = tree.symbol
+        sym.is(Given) &&
+          sym.name.startsWith("given_") &&
+          !namePresentInSource(sym, tree.nameSpan, tree.source)
+      case _ => false
+
 end Scala3

compiler/src/dotty/tools/dotc/semanticdb/SyntheticsExtractor.scala

@@ -15,7 +15,7 @@ class SyntheticsExtractor:
     extension (synth: s.Synthetic)
       def toOpt: Some[s.Synthetic] = Some(synth)
 
-    if tree.span.isSynthetic || tree.symbol.isInventedGiven then
+    if tree.span.isSynthetic || isInventedGiven(tree) then
       tree match
         case tree: Apply if isForSynthetic(tree) =>
           None // not yet supported (for synthetics)

tests/semanticdb/metac.expect

@@ -1705,7 +1705,7 @@ Text => empty
 Language => Scala
 Symbols => 45 entries
 Occurrences => 61 entries
-Synthetics => 7 entries
+Synthetics => 5 entries
 
 Symbols:
 givens/InventedNames$package. => final package object givens extends Object { self: givens.type => +24 decls }
@@ -1820,8 +1820,6 @@ Occurrences:
 Synthetics:
 [14:0..14:20):given String = "str" => given_String
 [15:13..15:16):Int => x$1
-[17:0..17:28):given given_Char: Char = '?' => given_Char
-[18:0..18:32):given `given_Float`: Float = 3.0 => given_Float
 [24:13..24:14):X => x$1
 [34:8..34:20):given_Double => *(intValue)
 [40:8..40:15):given_Y => *(given_X)