Skip to content

Commit

Permalink
Eliminate FromJavaObject from TASTy of Java sources (#19259)
Browse files Browse the repository at this point in the history 
Do not pickle type references to `FromJavaObject` for Java sources,
instead insert them at unpickling time. This ensures consistency of
`IDENTtpt` (where `Object` is given an explicit type) and `SELECTtpt`
where the type has to be resolved from just the name `Object`.

modify `-Ytest-pickler` to check for the presence of `FromJavaObject`

Also we compare unpicking Java signatures from TASTy to unpicking from
class files to ensure consistency

fixes #19246
  • Loading branch information
@bishabosha
bishabosha committed Dec 15, 2023
2 parents b1d1fe8 + 67e94be commit 08572ee
Show file tree
Hide file tree
Showing 36 changed files with 568 additions and 63 deletions.
1 change: 0 additions & 1 deletion compiler/src/dotty/tools/dotc/ast/untpd.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,6 @@ object untpd extends Trees.Instance[Untyped] with UntypedTreeInfo {
def scalaRuntimeDot(name: Name)(using SourceFile): Select = Select(scalaDot(nme.runtime), name)
def scalaUnit(implicit src: SourceFile): Select = scalaDot(tpnme.Unit)
def scalaAny(implicit src: SourceFile): Select = scalaDot(tpnme.Any)
def javaDotLangDot(name: Name)(implicit src: SourceFile): Select = Select(Select(Ident(nme.java), nme.lang), name)

def captureRoot(using Context): Select =
Select(scalaDot(nme.caps), nme.CAPTURE_ROOT)
Expand Down
29 changes: 21 additions & 8 deletions compiler/src/dotty/tools/dotc/core/tasty/TreePickler.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import ast.{untpd, tpd}
import Contexts.*, Symbols.*, Types.*, Names.*, Constants.*, Decorators.*, Annotations.*, Flags.*
import Comments.{Comment, docCtx}
import NameKinds.*
import StdNames.nme
import StdNames.{nme, tpnme}
import config.Config
import collection.mutable
import reporting.{Profile, NoProfile}
Expand Down Expand Up @@ -49,6 +49,9 @@ class TreePickler(pickler: TastyPickler, attributes: Attributes) {

private var profile: Profile = NoProfile

private val isOutlinePickle: Boolean = attributes.isOutline
private val isJavaPickle: Boolean = attributes.isJava

def treeAnnots(tree: untpd.MemberDef): List[Tree] =
val ts = annotTrees.lookup(tree)
if ts == null then Nil else ts.toList
Expand Down Expand Up @@ -188,19 +191,19 @@ class TreePickler(pickler: TastyPickler, attributes: Attributes) {
def pickleExternalRef(sym: Symbol) = {
val isShadowedRef =
sym.isClass && tpe.prefix.member(sym.name).symbol != sym
if (sym.is(Flags.Private) || isShadowedRef) {
if sym.is(Flags.Private) || isShadowedRef then
writeByte(if (tpe.isType) TYPEREFin else TERMREFin)
withLength {
pickleNameAndSig(sym.name, sym.signature, sym.targetName)
pickleType(tpe.prefix)
pickleType(sym.owner.typeRef)
}
}
else {
else if isJavaPickle && sym == defn.FromJavaObjectSymbol then
pickleType(defn.ObjectType) // when unpickling Java TASTy, replace by <FromJavaObject>
else
writeByte(if (tpe.isType) TYPEREF else TERMREF)
pickleNameAndSig(sym.name, tpe.signature, sym.targetName)
pickleType(tpe.prefix)
}
}
if (sym.is(Flags.Package)) {
writeByte(if (tpe.isType) TYPEREFpkg else TERMREFpkg)
Expand Down Expand Up @@ -342,7 +345,7 @@ class TreePickler(pickler: TastyPickler, attributes: Attributes) {
case _: Template | _: Hole => pickleTree(tpt)
case _ if tpt.isType => pickleTpt(tpt)
}
if attributes.isOutline && sym.isTerm && attributes.isJava then
if isOutlinePickle && sym.isTerm && isJavaPickle then
// TODO: if we introduce outline typing for Scala definitions
// then we will need to update the check here
pickleElidedUnlessEmpty(rhs, tpt.tpe)
Expand All @@ -358,7 +361,7 @@ class TreePickler(pickler: TastyPickler, attributes: Attributes) {
else
throw ex
if sym.is(Method) && sym.owner.isClass then
profile.recordMethodSize(sym, currentAddr.index - addr.index, mdef.span)
profile.recordMethodSize(sym, (currentAddr.index - addr.index) max 1, mdef.span)
for docCtx <- ctx.docCtx do
val comment = docCtx.docstrings.lookup(sym)
if comment != null then
Expand Down Expand Up @@ -614,7 +617,17 @@ class TreePickler(pickler: TastyPickler, attributes: Attributes) {
}
}
}
pickleStats(tree.constr :: rest)
if isJavaPickle then
val rest0 = rest.dropWhile:
case stat: ValOrDefDef => stat.symbol.is(Flags.Invisible)
case _ => false
if tree.constr.symbol.is(Flags.Invisible) then
writeByte(SPLITCLAUSE)
pickleStats(rest0)
else
pickleStats(tree.constr :: rest0)
else
pickleStats(tree.constr :: rest)
}
case Import(expr, selectors) =>
writeByte(IMPORT)
Expand Down
66 changes: 55 additions & 11 deletions compiler/src/dotty/tools/dotc/core/tasty/TreeUnpickler.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,11 @@ class TreeUnpickler(reader: TastyReader,
def forkAt(start: Addr): TreeReader = new TreeReader(subReader(start, endAddr))
def fork: TreeReader = forkAt(currentAddr)

def skipParentTree(tag: Int): Unit = {
if tag == SPLITCLAUSE then ()
else skipTree(tag)
}
def skipParentTree(): Unit = skipParentTree(readByte())
def skipTree(tag: Int): Unit = {
if (tag >= firstLengthTreeTag) goto(readEnd())
else if (tag >= firstNatASTTreeTag) { readNat(); skipTree() }
Expand Down Expand Up @@ -441,7 +446,11 @@ class TreeUnpickler(reader: TastyReader,
readPackageRef().termRef
case TYPEREF =>
val name = readName().toTypeName
TypeRef(readType(), name)
val pre = readType()
if unpicklingJava && name == tpnme.Object && (pre.termSymbol eq defn.JavaLangPackageVal) then
defn.FromJavaObjectType
else
TypeRef(pre, name)
case TERMREF =>
val sname = readName()
val prefix = readType()
Expand Down Expand Up @@ -1007,7 +1016,7 @@ class TreeUnpickler(reader: TastyReader,
* parsed in this way as InferredTypeTrees.
*/
def readParents(withArgs: Boolean)(using Context): List[Tree] =
collectWhile(nextByte != SELFDEF && nextByte != DEFDEF) {
collectWhile({val tag = nextByte; tag != SELFDEF && tag != DEFDEF && tag != SPLITCLAUSE}) {
nextUnsharedTag match
case APPLY | TYPEAPPLY | BLOCK =>
if withArgs then readTree()
Expand All @@ -1034,7 +1043,8 @@ class TreeUnpickler(reader: TastyReader,
val bodyFlags = {
val bodyIndexer = fork
// The first DEFDEF corresponds to the primary constructor
while (bodyIndexer.reader.nextByte != DEFDEF) bodyIndexer.skipTree()
while ({val tag = bodyIndexer.reader.nextByte; tag != DEFDEF && tag != SPLITCLAUSE}) do
bodyIndexer.skipParentTree()
bodyIndexer.indexStats(end)
}
val parentReader = fork
Expand All @@ -1053,7 +1063,38 @@ class TreeUnpickler(reader: TastyReader,
cls.owner.thisType, cls, parentTypes, cls.unforcedDecls,
selfInfo = if (self.isEmpty) NoType else self.tpt.tpe
).integrateOpaqueMembers
val constr = readIndexedDef().asInstanceOf[DefDef]

val constr =
if nextByte == SPLITCLAUSE then
assert(unpicklingJava, s"unexpected SPLITCLAUSE at $start")
val tag = readByte()
def ta = ctx.typeAssigner
val flags = Flags.JavaDefined | Flags.PrivateLocal | Flags.Invisible
val ctorCompleter = new LazyType {
def complete(denot: SymDenotation)(using Context) =
val sym = denot.symbol
val pflags = flags | Flags.Param
val tparamRefs = tparams.map(_.symbol.asType)
lazy val derivedTparamSyms: List[TypeSymbol] = tparams.map: tdef =>
val completer = new LazyType {
def complete(denot: SymDenotation)(using Context) =
denot.info = tdef.symbol.asType.info.subst(tparamRefs, derivedTparamRefs)
}
newSymbol(sym, tdef.name, Flags.JavaDefined | Flags.Param, completer, coord = cls.coord)
lazy val derivedTparamRefs: List[Type] = derivedTparamSyms.map(_.typeRef)
val vparamSym =
newSymbol(sym, nme.syntheticParamName(1), pflags, defn.UnitType, coord = cls.coord)
val vparamSymss: List[List[Symbol]] = List(vparamSym) :: Nil
val paramSymss =
if derivedTparamSyms.nonEmpty then derivedTparamSyms :: vparamSymss else vparamSymss
val res = effectiveResultType(sym, paramSymss)
denot.info = methodType(paramSymss, res)
denot.setParamss(paramSymss)
}
val ctorSym = newSymbol(ctx.owner, nme.CONSTRUCTOR, flags, ctorCompleter, coord = coordAt(start))
tpd.DefDef(ctorSym, EmptyTree).setDefTree // fake primary constructor
else
readIndexedDef().asInstanceOf[DefDef]
val mappedParents: LazyTreeList =
if parents.exists(_.isInstanceOf[InferredTypeTree]) then
// parents were not read fully, will need to be read again later on demand
Expand Down Expand Up @@ -1174,6 +1215,9 @@ class TreeUnpickler(reader: TastyReader,

// ------ Reading trees -----------------------------------------------------

private def ElidedTree(tpe: Type)(using Context): Tree =
untpd.Ident(nme.WILDCARD).withType(tpe)

def readTree()(using Context): Tree = {
val sctx = sourceChangeContext()
if (sctx `ne` ctx) return readTree()(using sctx)
Expand Down Expand Up @@ -1202,12 +1246,11 @@ class TreeUnpickler(reader: TastyReader,

def completeSelect(name: Name, sig: Signature, target: Name): Select =
val qual = readTree()
val denot0 = accessibleDenot(qual.tpe.widenIfUnstable, name, sig, target)
val denot =
if unpicklingJava && name == tpnme.Object && denot0.symbol == defn.ObjectClass then
defn.FromJavaObjectType.denot
if unpicklingJava && name == tpnme.Object && qual.symbol == defn.JavaLangPackageVal then
defn.FromJavaObjectSymbol.denot
else
denot0
accessibleDenot(qual.tpe.widenIfUnstable, name, sig, target)
makeSelect(qual, name, denot)

def readQualId(): (untpd.Ident, TypeRef) =
Expand All @@ -1228,9 +1271,10 @@ class TreeUnpickler(reader: TastyReader,
untpd.Ident(readName()).withType(readType())
case ELIDED =>
if !isOutline then
report.error(
s"Illegal elided tree in unpickler without ${attributeTagToString(OUTLINEattr)}, ${ctx.source}")
untpd.Ident(nme.WILDCARD).withType(readType())
val msg =
s"Illegal elided tree in unpickler at $start without ${attributeTagToString(OUTLINEattr)}, ${ctx.source}"
report.error(msg)
ElidedTree(readType())
case IDENTtpt =>
untpd.Ident(readName().toTypeName).withType(readType())
case SELECT =>
Expand Down
Loading

0 comments on commit 08572ee

Please sign in to comment.