Skip to content
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.

Sign up for GitHub

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

Router: remove overlapping match rules #4580

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Router: remove overlapping match rules #4580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
82 changes: 37 additions & 45 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/internal/Router.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ class Router(formatOps: FormatOps) {
case FT(_, _: T.EOF, _) => Seq(Split(Newline, 0))
case FT(_: T.BOF, _, _) => Seq(Split(NoSplit, 0))
case FT(_: T.Shebang, _, _) => Seq(Split(Newline2x(ft), 0))

// Interpolation
case FT(_: T.Interpolation.Start, _, m) =>
val end = matchingLeft(ft)
val policy = {
Expand Down Expand Up @@ -118,20 +120,19 @@ class Router(formatOps: FormatOps) {
val indents = alignIndents
.getOrElse(Seq(Indent(style.indent.main, end, After)))
Seq(split.withIndents(indents))
// Interpolation
case FT(
_: T.Interpolation.Id | _: T.Interpolation.Part |
_: T.Interpolation.Start | _: T.Interpolation.SpliceStart,
_: T.Interpolation.SpliceStart,
_,
_,
) => Seq(Split(NoSplit, 0))
case FT(
_,
T.Interpolation.Part(_) | T.Interpolation.End() | T.Interpolation
.SpliceEnd(),
_: T.Interpolation.Part | _: T.Interpolation.End |
_: T.Interpolation.SpliceEnd,
_,
) => Seq(Split(NoSplit, 0))
case FT(T.LeftBrace(), T.RightBrace(), _) => Seq(Split(NoSplit, 0))

// Import
case FT(_: T.Dot, _, _)
if existsParentOfType[ImportExportStat](rightOwner) =>
Expand Down Expand Up @@ -170,7 +171,7 @@ class Router(formatOps: FormatOps) {
Seq(Split(Space(style.spaces.inImportCurlyBraces), 0))

// Interpolated string left brace
case FT(open @ T.LeftBrace(), _, _)
case FT(open: T.LeftBrace, _, _)
if prev(ft).left.is[T.Interpolation.SpliceStart] =>
val close = matchingLeft(ft)
val alignIndents =
Expand Down Expand Up @@ -245,6 +246,7 @@ class Router(formatOps: FormatOps) {
}

// { ... } Blocks
case FT(_: T.LeftBrace, _: T.RightBrace, _) => Seq(Split(NoSplit, 0))
case FT(_: T.LeftBrace, right, _) =>
val close = matchingLeft(ft)
val isSelfAnnotationNL = style.optIn.selfAnnotationNewline &&
Expand Down Expand Up @@ -1508,12 +1510,12 @@ class Router(formatOps: FormatOps) {
.withOptimalToken(expire, killOnFail = false),
)

case FT(T.LeftParen(), T.LeftBrace(), _) => Seq(Split(NoSplit, 0))
case FT(_: T.LeftParen, _: T.LeftBrace, _) => Seq(Split(NoSplit, 0))

case FT(_, T.LeftBrace(), _) if isXmlBrace(rightOwner) =>
case FT(_, _: T.LeftBrace, _) if isXmlBrace(rightOwner) =>
withIndentOnXmlSpliceStart(ft, Seq(Split(NoSplit, 0)))

case FT(T.RightBrace(), _, _) if isXmlBrace(leftOwner) =>
case FT(_: T.RightBrace, _, _) if isXmlBrace(leftOwner) =>
Seq(Split(NoSplit, 0))
// non-statement starting curly brace
case FT(_: T.Comma, _: T.LeftBrace, _)
Expand Down Expand Up @@ -2003,7 +2005,7 @@ class Router(formatOps: FormatOps) {
else baseSplits ++ splits.map(_.onlyFor(SplitTag.SelectChainFirstNL))

// ApplyUnary
case FT(T.Ident(_), T.Literal(), _) if leftOwner == rightOwner =>
case FT(_: T.Ident, _: T.Literal, _) if leftOwner eq rightOwner =>
Seq(Split(NoSplit, 0))
case FT(op: T.Ident, right, _) if leftOwner.parent.exists {
case unary: Term.ApplyUnary => unary.op.tokens.head == op
Expand All @@ -2012,8 +2014,8 @@ class Router(formatOps: FormatOps) {
// Annotations, see #183 for discussion on this.
case FT(_, _: T.At, _) if rightOwner.is[Pat.Bind] => Seq(Split(Space, 0))
case FT(_: T.At, _, _) if leftOwner.is[Pat.Bind] => Seq(Split(Space, 0))
case FT(T.At(), _: T.Symbolic, _) => Seq(Split(NoSplit, 0))
case FT(T.At(), right @ T.Ident(_), _) =>
case FT(_: T.At, _: T.Symbolic, _) => Seq(Split(NoSplit, 0))
case FT(_: T.At, right: T.Ident, _) =>
// Add space if right starts with a symbol
Seq(Split(identModification(right), 0))

Expand Down Expand Up @@ -2236,11 +2238,7 @@ class Router(formatOps: FormatOps) {
Seq(Split(Space(isSymbolicIdent(right)), 0))

// Kind projector type lambda
case FT(T.Ident("+" | "-"), T.Underscore(), _) if rightOwner.is[Type] =>
Seq(Split(NoSplit, 0))

// Var args
case FT(_, T.Ident("*"), _) if rightOwner.is[Type.Repeated] =>
case FT(T.Ident("+" | "-"), _: T.Underscore, _) if rightOwner.is[Type] =>
Seq(Split(NoSplit, 0))

case FT(open: T.LeftParen, right, _) =>
Expand Down Expand Up @@ -2532,12 +2530,14 @@ class Router(formatOps: FormatOps) {
case FT(_, T.Ident("|"), _) if rightOwner.is[Pat.Alternative] =>
val noNL = !style.newlines.keepBreak(newlines)
Seq(Split(Space.orNL(noNL), 0))

case FT(_, T.Ident("*"), _)
if rightOwner.is[Pat.SeqWildcard] || rightOwner.is[Term.Repeated] ||
rightOwner.is[Pat.Repeated] => Seq(Split(NoSplit, 0))
if rightOwner.isAny[Tree.Repeated, Pat.SeqWildcard] =>
Seq(Split(NoSplit, 0))

case FT(
T.Ident(_) | T.Literal() | T.Interpolation.End() | T.Xml.End(),
T.Ident(_) | T.Literal() | T.Xml.Start(),
_: T.Ident | _: T.Literal | _: T.Interpolation.End | _: T.Xml.End,
_: T.Ident | _: T.Literal,
_,
) => Seq(Split(Space, 0))

Expand All @@ -2547,12 +2547,6 @@ class Router(formatOps: FormatOps) {
val noSplit = left.is[T.Dot] && dialect.allowMatchAsOperator
Seq(Split(Space(!noSplit), 0))

// Protected []
case FT(_, T.LeftBracket(), _) if isModPrivateProtected(leftOwner) =>
Seq(Split(NoSplit, 0))
case FT(T.LeftBracket(), _, _) if isModPrivateProtected(leftOwner) =>
Seq(Split(NoSplit, 0))

// Term.ForYield
case FT(_, _: T.KwIf, _) if rightOwner.is[Enumerator.Guard] =>
/* this covers the first guard only; second and later consecutive guards
Expand All @@ -2571,17 +2565,13 @@ class Router(formatOps: FormatOps) {
}
// Interpolation
case FT(_, _: T.Interpolation.Id, _) => Seq(Split(Space, 0))
// Throw exception
case FT(T.KwThrow(), _, _) => Seq(Split(Space, 0))

// Singleton types
case FT(_, T.KwType(), _) if rightOwner.is[Type.Singleton] =>
case FT(_, _: T.KwType, _) if rightOwner.is[Type.Singleton] =>
Seq(Split(NoSplit, 0))
// seq to var args foo(seq:_*)
case FT(T.Colon(), T.Underscore(), _)
if next(ft).meta.right.text == "*" => Seq(Split(Space, 0))
case FT(T.Underscore(), T.Ident("*"), _) if prev(ft).left.is[T.Colon] =>
Seq(Split(NoSplit, 0))
case FT(_: T.Colon, _: T.Underscore, _)
if leftOwner.isAny[Term.Repeated, Pat.Repeated] => Seq(Split(Space, 0))

// Xml
case FT(_, _: T.Xml.Start, _) => Seq(Split(Space, 0))
Expand All @@ -2592,18 +2582,22 @@ class Router(formatOps: FormatOps) {
case FT(_: T.Xml.SpliceStart, _, _)
if style.xmlLiterals.assumeFormatted =>
withIndentOnXmlSpliceStart(ft, Seq(Split(NoSplit, 0)))
case FT(T.Xml.Part(_), _, _) => Seq(Split(NoSplit, 0))
case FT(_, T.Xml.Part(_), _) => Seq(Split(NoSplit, 0))
case FT(_: T.Xml.Part, _, _) => Seq(Split(NoSplit, 0))
case FT(_, _: T.Xml.Part, _) => Seq(Split(NoSplit, 0))

// Fallback
case FT(_, T.Dot(), _) => Seq(Split(NoSplit, 0))
case FT(left, T.Hash(), _) =>
case FT(_, _: T.Dot, _) => Seq(Split(NoSplit, 0))
case FT(_: T.Dot, _, _) => Seq(Split(NoSplit, 0))
case FT(left, _: T.Hash, _) =>
Seq(Split(Space(endsWithSymbolIdent(left)), 0))
case FT(T.Hash(), ident: T.Ident, _) =>
case FT(_: T.Hash, ident: T.Ident, _) =>
Seq(Split(Space(isSymbolicIdent(ident)), 0))
case FT(T.Dot(), T.Ident(_) | T.KwThis() | T.KwSuper(), _) =>
Seq(Split(NoSplit, 0))
case FT(_, T.RightBracket(), _) => Seq(Split(NoSplit, 0))

case FT(_, _: T.LeftBracket, _) =>
val noSpace = isModPrivateProtected(leftOwner)
Seq(Split(Space(!noSpace), 0))
case FT(_: T.LeftBracket, _, _) => Seq(Split(NoSplit, 0))
case FT(_, _: T.RightBracket, _) => Seq(Split(NoSplit, 0))
case FT(_, _: T.RightParen, _) =>
val ok = !style.newlines.keepBreak(newlines) ||
style.binPack.siteFor(rightOwner)
Expand Down Expand Up @@ -2649,10 +2643,8 @@ class Router(formatOps: FormatOps) {
case FT(_, Reserved(), _) => Seq(Split(Space, 0))
case FT(Reserved(), _, _) => Seq(Split(Space, 0))

case FT(T.LeftBracket(), _, _) => Seq(Split(NoSplit, 0))
case FT(_, _: T.Symbolic, _) => Seq(Split(Space, 0))
case FT(T.Underscore(), T.Ident("*"), _) => Seq(Split(NoSplit, 0))
case FT(T.RightArrow(), _, _) if leftOwner.is[Type.ByName] =>
case FT(_: T.RightArrow, _, _) if leftOwner.is[Type.ByName] =>
val mod = Space(style.spaces.inByNameTypes)
Seq(Split(mod, 0))
case FT(_: T.Colon, _, _) if style.spaces.notAfterColon(leftOwner) =>
Expand Down
2 changes: 1 addition & 1 deletion scalafmt-core/shared/src/main/scala/org/scalafmt/util/TokenClasses.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sealed trait TokenClassifier extends Function[T, Boolean] {

object Reserved extends TokenClassifier {
def matches(token: T): Boolean = token match {
case _: Keyword | _: KwFalse | _: KwNull | _: KwTrue => true
case _: Keyword | _: KwNull | _: BooleanConstant => true
case _ => false
}
}
Expand Down