Skip to content

Extend pattern type constraining to sealed hierarchies #16924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions compiler/src/dotty/tools/dotc/core/Flags.scala
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,8 @@ object Flags {
val JavaOrPrivateOrSynthetic: FlagSet = Artifact | JavaDefined | Private | Synthetic
val PrivateOrSynthetic: FlagSet = Artifact | Private | Synthetic
val EnumCase: FlagSet = Case | Enum
val CaseOrFinalOrSealed: FlagSet = Case | Final | Sealed
val CaseOrSealed: FlagSet = Case | Sealed
val CovariantLocal: FlagSet = Covariant | Local // A covariant type parameter
val ContravariantLocal: FlagSet = Contravariant | Local // A contravariant type parameter
val EffectivelyErased = ConstructorProxy | Erased
Expand Down
20 changes: 5 additions & 15 deletions compiler/src/dotty/tools/dotc/core/PatternTypeConstrainer.scala
Original file line number Diff line number Diff line change
Expand Up @@ -221,29 +221,19 @@ trait PatternTypeConstrainer { self: TypeComparer =>
*
* It'd be unsound for us to say that `t <: T`, even though that follows from `D[t] <: C[T]`.
* Note, however, that if `D` was a final class, we *could* rely on that relationship.
* To support typical case classes, we also assume that this relationship holds for them and their parent traits.
* This is enforced by checking that classes inheriting from case classes do not extend the parent traits of those
* case classes without also appropriately extending the relevant case class
* (see `RefChecks#checkCaseClassInheritanceInvariant`).
* Case classes and sealed traits (and sealed classes) are supported,
* by assuming that this relationship holds for them and their parent traits.
* This is enforced by checking no subclass of them mixes in any parent trait with a different type argument.
* (see `RefChecks#checkVariantInheritanceProblems`).
*/
def constrainSimplePatternType(patternTp: Type, scrutineeTp: Type, forceInvariantRefinement: Boolean): Boolean = {
def refinementIsInvariant(tp: Type): Boolean = tp match {
case tp: SingletonType => true
case tp: ClassInfo => tp.cls.is(Final) || tp.cls.is(Case)
case tp: ClassInfo => tp.cls.isOneOf(CaseOrFinalOrSealed)
case tp: TypeProxy => refinementIsInvariant(tp.superType)
case _ => false
}

def widenVariantParams(tp: Type) = tp match {
case tp @ AppliedType(tycon, args) =>
val args1 = args.zipWithConserve(tycon.typeParams)((arg, tparam) =>
if (tparam.paramVarianceSign != 0) TypeBounds.empty else arg
)
tp.derivedAppliedType(tycon, args1)
case tp =>
tp
}

val patternCls = patternTp.classSymbol
val scrutineeCls = scrutineeTp.classSymbol

Expand Down
32 changes: 19 additions & 13 deletions compiler/src/dotty/tools/dotc/typer/RefChecks.scala
Original file line number Diff line number Diff line change
Expand Up @@ -901,20 +901,26 @@ object RefChecks {
}
}

/** Check that inheriting a case class does not constitute a variant refinement
/** Check that inheriting a case class or a sealed trait (or a sealed class) does not constitute a variant refinement
* of a base type of the case class. It is because of this restriction that we
* can assume invariant refinement for case classes in `constrainPatternType`.
* can assume invariant refinement for these classes in `constrainSimplePatternType`.
*/
def checkCaseClassInheritanceInvariant() =
def checkVariantInheritanceProblems() =
for
caseCls <- clazz.info.baseClasses.tail.find(_.is(Case))
baseCls <- caseCls.info.baseClasses.tail
middle <- clazz.info.baseClasses.tail
if middle.isOneOf(CaseOrSealed)
baseCls <- middle.info.baseClasses.tail
if baseCls.typeParams.exists(_.paramVarianceSign != 0)
problem <- variantInheritanceProblems(baseCls, caseCls, i"base $baseCls", "case ")
withExplain = problem.appendExplanation:
"""Refining a basetype of a case class is not allowed.
|This is a limitation that enables better GADT constraints in case class patterns""".stripMargin
do report.errorOrMigrationWarning(withExplain, clazz.srcPos, MigrationVersion.Scala2to3)
problem <- {
val middleStr = if middle.is(Case) then "case " else if middle.is(Sealed) then "sealed " else ""
variantInheritanceProblems(baseCls, middle, "", middleStr)
}
do
val withExplain = problem.appendExplanation:
"""Refining a basetype of a case class or a sealed trait (or a sealed class) is not allowed.
|This is a limitation that enables better GADT constraints in case class and sealed hierarchy patterns""".stripMargin
report.errorOrMigrationWarning(withExplain, clazz.srcPos, MigrationVersion.Scala2to3)

checkNoAbstractMembers()
if (abstractErrors.isEmpty)
checkNoAbstractDecls(clazz)
Expand All @@ -923,7 +929,7 @@ object RefChecks {
report.error(abstractErrorMessage, clazz.srcPos)

checkMemberTypesOK()
checkCaseClassInheritanceInvariant()
checkVariantInheritanceProblems()
}

if (!clazz.is(Trait) && checker.checkInheritedTraitParameters) {
Expand All @@ -943,7 +949,7 @@ object RefChecks {
for {
cls <- clazz.info.baseClasses.tail
if cls.paramAccessors.nonEmpty && !mixins.contains(cls)
problem <- variantInheritanceProblems(cls, clazz.asClass.superClass, i"parameterized base $cls", "super")
problem <- variantInheritanceProblems(cls, clazz.asClass.superClass, "parameterized ", "super")
}
report.error(problem, clazz.srcPos)
}
Expand All @@ -966,7 +972,7 @@ object RefChecks {
if (combinedBT =:= thisBT) None // ok
else
Some(
em"""illegal inheritance: $clazz inherits conflicting instances of $baseStr.
em"""illegal inheritance: $clazz inherits conflicting instances of ${baseStr}base $baseCls.
|
| Direct basetype: $thisBT
| Basetype via $middleStr$middle: $combinedBT""")
Expand Down
4 changes: 2 additions & 2 deletions tests/neg/i18552.check
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
|---------------------------------------------------------------------------------------------------------------------
| Explanation (enabled by `-explain`)
|- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
| Refining a basetype of a case class is not allowed.
| This is a limitation that enables better GADT constraints in case class patterns
| Refining a basetype of a case class or a sealed trait (or a sealed class) is not allowed.
| This is a limitation that enables better GADT constraints in case class and sealed hierarchy patterns
---------------------------------------------------------------------------------------------------------------------
21 changes: 21 additions & 0 deletions tests/pos/i4790.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
class Test:
def foo(as: Seq[Int]) =
val List(_, bs: _*) = as: @unchecked
val cs: Seq[Int] = bs

class Test2:
def foo(as: SSeq[Int]) =
val LList(_, tail) = as: @unchecked
val cs: SSeq[Int] = tail

trait SSeq[+A]
sealed trait LList[+A] extends SSeq[A]
final case class CCons[+A](head: A, tail: LList[A]) extends LList[A]
case object NNil extends LList[Nothing]
object LList:
def unapply[A](xs: LList[A]): Extractor[A] = Extractor[A](xs)
final class Extractor[A](private val xs: LList[A]) extends AnyVal:
def get: this.type = this
def isEmpty: Boolean = xs.isInstanceOf[CCons[?]]
def _1: A = xs.asInstanceOf[CCons[A]].head
def _2: SSeq[A] = xs.asInstanceOf[CCons[A]].tail
Loading