Factor out javaSimpleName, javaClassName and javaBinaryName

Author: nicolasstucki

compiler/src/dotty/tools/backend/jvm/BCodeAsmCommon.scala

@@ -92,7 +92,7 @@ final class BCodeAsmCommon[I <: DottyBackendInterface](val interface: I) {
       ctx.debuglog(s"enclosing method for $classSym is $methodOpt (in ${methodOpt.map(_.enclosingClass)})")
       Some(EnclosingMethodEntry(
         classDesc(enclosingClassForEnclosingMethodAttribute(classSym)),
-        methodOpt.map(_.name.mangledString.toString).orNull,
+        methodOpt.map(_.javaSimpleName).orNull,
         methodOpt.map(methodDesc).orNull))
     } else {
       None

compiler/src/dotty/tools/backend/jvm/BCodeBodyBuilder.scala

@@ -468,7 +468,7 @@ trait BCodeBodyBuilder extends BCodeSkelBuilder {
       val useSpecificReceiver = specificReceiver != null && !field.isScalaStatic
 
       val owner      = internalName(if (useSpecificReceiver) specificReceiver else field.owner)
-      val fieldJName = field.name.mangledString.toString
+      val fieldJName = field.javaSimpleName
       val fieldDescr = symInfoTK(field).descriptor
       val isStatic   = field.isStaticMember
       val opc =
@@ -516,7 +516,7 @@ trait BCodeBodyBuilder extends BCodeSkelBuilder {
         case EnumTag   =>
           val sym       = const.symbolValue
           val ownerName = internalName(sym.owner)
-          val fieldName = sym.name.mangledString.toString
+          val fieldName = sym.javaSimpleName
           val underlying = sym.info match {
             case t: TypeProxy => t.underlying
             case t => t
@@ -705,7 +705,7 @@ trait BCodeBodyBuilder extends BCodeSkelBuilder {
             // we initialize the MODULE$ field immediately after the super ctor
             if (!isModuleInitialized &&
               jMethodName == INSTANCE_CONSTRUCTOR_NAME &&
-              fun.symbol.name.mangledString.toString == INSTANCE_CONSTRUCTOR_NAME &&
+              fun.symbol.javaSimpleName == INSTANCE_CONSTRUCTOR_NAME &&
               claszSymbol.isStaticModuleClass) {
               isModuleInitialized = true
               mnode.visitVarInsn(asm.Opcodes.ALOAD, 0)
@@ -803,7 +803,7 @@ trait BCodeBodyBuilder extends BCodeSkelBuilder {
               // Emitting `def f(c: C) = c.clone()` as `Object.clone()` gives a VerifyError.
               val target: String = tpeTK(qual).asRefBType.classOrArrayType
               val methodBType = asmMethodType(sym)
-              bc.invokevirtual(target, sym.name.mangledString.toString, methodBType.descriptor)
+              bc.invokevirtual(target, sym.javaSimpleName, methodBType.descriptor)
               generatedType = methodBType.returnType
             } else {
               val receiverClass = if (!invokeStyle.isVirtual) null else {
@@ -1158,7 +1158,7 @@ trait BCodeBodyBuilder extends BCodeSkelBuilder {
       receiverClass.info // ensure types the type is up to date; erasure may add lateINTERFACE to traits
       val receiverName = internalName(receiverClass)
 
-      val jname    = method.name.mangledString.toString
+      val jname    = method.javaSimpleName
       val bmType   = asmMethodType(method)
       val mdescr   = bmType.descriptor
 
@@ -1447,7 +1447,7 @@ trait BCodeBodyBuilder extends BCodeSkelBuilder {
       val targetHandle =
         new asm.Handle(invokeStyle,
           classBTypeFromSymbol(lambdaTarget.owner).internalName,
-          lambdaTarget.name.mangledString,
+          lambdaTarget.javaSimpleName,
           asmMethodType(lambdaTarget).descriptor,
           /* itf = */ isInterface)
 
@@ -1473,7 +1473,7 @@ trait BCodeBodyBuilder extends BCodeSkelBuilder {
         }
       }
 
-      val methodName = abstractMethod.name.mangledString
+      val methodName = abstractMethod.javaSimpleName
       val applyN = {
         val mt = asmMethodType(abstractMethod)
         mt.toASMType

compiler/src/dotty/tools/backend/jvm/BCodeHelpers.scala

@@ -27,6 +27,8 @@ import dotty.tools.dotc.core.TypeErasure
 import dotty.tools.dotc.transform.GenericSignatures
 import dotty.tools.io.AbstractFile
 
+import dotty.tools.backend.jvm.DottyBackendInterface.symExtensions
+
 /*
  *  Traits encapsulating functionality to convert Scala AST Trees into ASM ClassNodes.
  *
@@ -369,7 +371,7 @@ trait BCodeHelpers extends BCodeIdiomatic with BytecodeWriters {
             case ClazzTag => av.visit(name, typeToTypeKind(const.typeValue)(bcodeStore)(innerClasesStore).toASMType)
             case EnumTag =>
               val edesc = innerClasesStore.typeDescriptor(const.tpe) // the class descriptor of the enumeration class.
-              val evalue = const.symbolValue.name.mangledString // value the actual enumeration value.
+              val evalue = const.symbolValue.javaSimpleName // value the actual enumeration value.
               av.visitEnum(name, edesc, evalue)
           }
         case t: TypeApply if (t.fun.symbol == defn.Predef_classOf) =>
@@ -378,7 +380,7 @@ trait BCodeHelpers extends BCodeIdiomatic with BytecodeWriters {
           // An underscore argument indicates that we want to use the default value for this parameter, so do not emit anything
         case t: tpd.RefTree if t.symbol.denot.owner.isAllOf(Flags.JavaEnumTrait) =>
           val edesc = innerClasesStore.typeDescriptor(t.tpe) // the class descriptor of the enumeration class.
-          val evalue = t.symbol.name.mangledString // value the actual enumeration value.
+          val evalue = t.symbol.javaSimpleName // value the actual enumeration value.
           av.visitEnum(name, edesc, evalue)
         case t: SeqLiteral =>
           val arrAnnotV: AnnotationVisitor = av.visitArray(name)
@@ -517,7 +519,7 @@ trait BCodeHelpers extends BCodeIdiomatic with BytecodeWriters {
 
       val jReturnType = toTypeKind(methodInfo.resultType)
       val mdesc = MethodBType(paramJavaTypes, jReturnType).descriptor
-      val mirrorMethodName = m.name.mangledString.toString
+      val mirrorMethodName = m.javaSimpleName
       val mirrorMethod: asm.MethodVisitor = jclass.visitMethod(
         flags,
         mirrorMethodName,

compiler/src/dotty/tools/backend/jvm/BCodeSkelBuilder.scala

@@ -263,7 +263,7 @@ trait BCodeSkelBuilder extends BCodeHelpers {
 
         val jfield = new asm.tree.FieldNode(
           flags,
-          f.name.mangledString.toString,
+          f.javaSimpleName,
           symInfoTK(f).descriptor,
           javagensig,
           null // no initial value
@@ -404,7 +404,7 @@ trait BCodeSkelBuilder extends BCodeHelpers {
 
       private def makeLocal(sym: Symbol, tk: BType): Local = {
         assert(nxtIdx != -1, "not a valid start index")
-        val loc = Local(tk, sym.name.mangledString.toString, nxtIdx, sym.is(Flags.Synthetic))
+        val loc = Local(tk, sym.javaSimpleName, nxtIdx, sym.is(Flags.Synthetic))
         val existing = slots.put(sym, loc)
         if (existing.isDefined)
           ctx.error("attempt to create duplicate local var.", ctx.source.atSpan(sym.span))
@@ -545,7 +545,7 @@ trait BCodeSkelBuilder extends BCodeHelpers {
       assert(mnode == null, "GenBCode detected nested method.")
 
       methSymbol  = dd.symbol
-      jMethodName = methSymbol.name.mangledString.toString
+      jMethodName = methSymbol.javaSimpleName
       returnType  = asmMethodType(dd.symbol).returnType
       isMethSymStaticCtor = methSymbol.isStaticConstructor
 
@@ -659,7 +659,7 @@ trait BCodeSkelBuilder extends BCodeHelpers {
         insnModA      = new asm.tree.TypeInsnNode(asm.Opcodes.NEW, className)
         // INVOKESPECIAL <init>
         val callee = methSymbol.enclosingClass.primaryConstructor
-        val jname  = callee.name.mangledString.toString
+        val jname  = callee.javaSimpleName
         val jowner = internalName(callee.owner)
         val jtype  = asmMethodType(callee).descriptor
         insnModB   = new asm.tree.MethodInsnNode(asm.Opcodes.INVOKESPECIAL, jowner, jname, jtype, false)
@@ -681,7 +681,7 @@ trait BCodeSkelBuilder extends BCodeHelpers {
         // INVOKESTATIC CREATOR(): android.os.Parcelable$Creator; -- TODO where does this Android method come from?
         val callee = claszSymbol.companionModule.info.member(androidFieldName).symbol
         val jowner = internalName(callee.owner)
-        val jname  = callee.name.mangledString.toString
+        val jname  = callee.javaSimpleName
         val jtype  = asmMethodType(callee).descriptor
         insnParcA  = new asm.tree.MethodInsnNode(asm.Opcodes.INVOKESTATIC, jowner, jname, jtype, false)
         // PUTSTATIC `thisName`.CREATOR;

compiler/src/dotty/tools/backend/jvm/BTypesFromSymbols.scala

@@ -83,7 +83,7 @@ class BTypesFromSymbols[I <: DottyBackendInterface](val int: I) extends BTypes {
       s"Cannot create ClassBType for special class symbol ${classSym.showFullName}")
 
     convertedClasses.getOrElse(classSym, {
-      val internalName = classSym.fullName.mangledString.replace('.', '/')
+      val internalName = classSym.javaBinaryName
       // We first create and add the ClassBType to the hash map before computing its info. This
       // allows initializing cylic dependencies, see the comment on variable ClassBType._info.
       val classBType = new ClassBType(internalName)
@@ -240,7 +240,7 @@ class BTypesFromSymbols[I <: DottyBackendInterface](val int: I) extends BTypes {
         if (isAnonymousOrLocalClass(innerClassSym)) {
           None
         } else {
-          val outerName = innerClassSym.originalOwner.originalLexicallyEnclosingClass.fullName.mangledString.replace('.', '/')
+          val outerName = innerClassSym.originalOwner.originalLexicallyEnclosingClass.javaBinaryName
           def dropModule(str: String): String =
             if (!str.isEmpty && str.last == '$') str.take(str.length - 1) else str
           // Java compatibility. See the big comment in BTypes that summarizes the InnerClass spec.

compiler/src/dotty/tools/backend/jvm/DottyBackendInterface.scala

@@ -162,6 +162,9 @@ object DottyBackendInterface {
         toDenot(sym).owner.is(Flags.PackageClass)
       }
 
+    def javaSimpleName(using Context): String = toDenot(sym).name.mangledString
+    def javaClassName(using Context): String = toDenot(sym).fullName.mangledString
+    def javaBinaryName(using Context): String = javaClassName.replace('.', '/')
   }
 
   private val primitiveCompilationUnits = Set(

compiler/src/dotty/tools/backend/sjs/JSEncoding.scala

@@ -30,6 +30,8 @@ import ScopedVar.withScopedVars
 import JSDefinitions._
 import JSInterop._
 
+import dotty.tools.backend.jvm.DottyBackendInterface.symExtensions
+
 /** Encoding of symbol names for JavaScript
  *
  *  Some issues that this encoding solves:
@@ -119,7 +121,7 @@ object JSEncoding {
       js.LabelIdent(freshLabelName(base))
 
     def labelSymbolName(sym: Symbol)(implicit ctx: Context): LabelName =
-      labelSymbolNames.getOrElseUpdate(sym, freshLabelName(sym.name.mangledString))
+      labelSymbolNames.getOrElseUpdate(sym, freshLabelName(sym.javaSimpleName))
 
     def getEnclosingReturnLabel()(implicit pos: ir.Position): js.LabelIdent = {
       if (returnLabelName.isEmpty)
@@ -157,7 +159,7 @@ object JSEncoding {
     require(sym.owner.isClass && sym.isTerm && !sym.is(Flags.Method) && !sym.is(Flags.Module),
         "encodeFieldSym called with non-field symbol: " + sym)
 
-    val name0 = sym.name.mangledString
+    val name0 = sym.javaSimpleName
     val name =
       if (name0.charAt(name0.length()-1) != ' ') name0
       else name0.substring(0, name0.length()-1)
@@ -247,7 +249,7 @@ object JSEncoding {
        */
       ir.Names.BoxedUnitClass
     } else {
-      ClassName(sym1.fullName.mangledString)
+      ClassName(sym1.javaClassName)
     }
   }
 

compiler/src/dotty/tools/dotc/core/SymbolLoaders.scala

@@ -20,6 +20,8 @@ import parsing.Parsers.OutlineParser
 import reporting.trace
 import ast.desugar
 
+import dotty.tools.backend.jvm.DottyBackendInterface.symExtensions
+
 object SymbolLoaders {
   import ast.untpd._
 
@@ -279,7 +281,7 @@ object SymbolLoaders {
       if (!sourceModule.isCompleted)
         sourceModule.completer.complete(sourceModule)
 
-      val packageName = if (root.isEffectiveRoot) "" else root.fullName.mangledString
+      val packageName = if (root.isEffectiveRoot) "" else root.symbol.javaClassName
 
       enterFlatClasses = Some { ctx =>
         enterFlatClasses = None

compiler/src/dotty/tools/dotc/transform/TreeChecker.scala

@@ -23,6 +23,7 @@ import scala.internal.Chars._
 import collection.mutable
 import ProtoTypes._
 
+import dotty.tools.backend.jvm.DottyBackendInterface.symExtensions
 
 import scala.util.control.NonFatal
 
@@ -50,7 +51,7 @@ class TreeChecker extends Phase with SymTransformer {
   val NoSuperClassFlags: FlagSet = Trait | Package
 
   def testDuplicate(sym: Symbol, registry: mutable.Map[String, Symbol], typ: String)(using Context): Unit = {
-    val name = sym.fullName.mangledString
+    val name = sym.javaClassName
     val isDuplicate = this.flatClasses && registry.contains(name)
     assert(!isDuplicate, s"$typ defined twice $sym ${sym.id} ${registry(name).id}")
     registry(name) = sym