-
Notifications
You must be signed in to change notification settings - Fork 276
/
Router.scala
2877 lines (2724 loc) · 114 KB
/
Router.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package org.scalafmt.internal
import org.scalafmt.Error.UnexpectedTree
import org.scalafmt.config.{Align, BinPack, Indents}
import org.scalafmt.config.{ImportSelectors, Newlines, ScalafmtConfig, Spaces}
import org.scalafmt.internal.ExpiresOn.{After, Before}
import org.scalafmt.internal.Length.{Num, StateColumn}
import org.scalafmt.internal.Policy.NoPolicy
import org.scalafmt.util._
import org.scalameta.FileLine
import scala.annotation.tailrec
import scala.language.implicitConversions
import scala.meta.classifiers.Classifier
import scala.meta.tokens.{Token => T}
import scala.meta._
object Constants {
val ShouldBeNewline = 100000
val ShouldBeSingleLine = 30
val BinPackAssignmentPenalty = 10
val SparkColonNewline = 10
val BracketPenalty = 20
val ExceedColumnPenalty = 1000
// Breaking a line like s"aaaaaaa${111111 + 22222}" should be last resort.
val BreakSingleLineInterpolatedString = 10 * ExceedColumnPenalty
}
/** Assigns splits to format tokens.
*
* NOTE(olafurpg). The pattern match in this file has gotten out of hand. It's
* difficult even for myself to keep track of what's going on in some cases,
* especially around applications and lambdas. I'm hoping to sunset this file
* along with BestFirstSearch in favor of
* https://github.com/scalameta/scalafmt/issues/917
*/
class Router(formatOps: FormatOps) {
import Constants._
import LoggerOps._
import PolicyOps._
import TokenOps._
import TreeOps._
import FormatOps._
import formatOps._
import tokens.{
matching,
matchingOpt,
prev,
next,
tokenBefore,
getLastNonTrivial,
prevNonComment,
nextNonComment,
prevNonCommentSameLine,
nextNonCommentSameLine
}
private def getSplitsImpl(implicit formatToken: FormatToken): Seq[Split] = {
implicit val style = styleMap.at(formatToken)
val leftOwner = formatToken.meta.leftOwner
val rightOwner = formatToken.meta.rightOwner
val newlines = formatToken.newlinesBetween
formatToken match {
// between sources (EOF -> @ -> BOF)
case FormatToken(_: T.EOF, _, _) => Seq(Split(Newline, 0))
case ft @ FormatToken(_, _: T.BOF, _) =>
Seq(Split(NoSplit.orNL(next(ft).right.is[T.EOF]), 0))
case FormatToken(_: T.BOF, _, _) =>
Seq(
Split(NoSplit, 0)
)
case FormatToken(_, _: T.EOF, _) =>
Seq(
Split(Newline, 0) // End files with trailing newline
)
case FormatToken(start: T.Interpolation.Start, _, m) =>
val end = matching(start)
val okNewlines =
style.newlines.inInterpolation.ne(Newlines.InInterpolation.avoid) &&
isTripleQuote(m.left.text)
def policy = PenalizeAllNewlines(end, BreakSingleLineInterpolatedString)
val split = Split(NoSplit, 0).withPolicy(policy, okNewlines)
val alignIndents = if (style.align.stripMargin) {
findInterpolate(leftOwner).flatMap { ti =>
getStripMarginChar(ti).map { pipe =>
val startsWithPipe = ti.parts.headOption match {
case Some(Lit.String(x)) => x.headOption.contains(pipe)
case _ => false
}
Seq(
Indent(StateColumn, end, After),
// -1 because of margin characters |
Indent(if (startsWithPipe) -1 else -2, end, After)
)
}
}
} else None
val indents =
alignIndents.getOrElse(Seq(Indent(style.indent.main, end, After)))
Seq(split.withIndents(indents))
// Interpolation
case FormatToken(
_: T.Interpolation.Id | _: T.Interpolation.Part |
_: T.Interpolation.Start | _: T.Interpolation.SpliceStart,
_,
_
) =>
Seq(
Split(NoSplit, 0)
)
case FormatToken(
_,
T.Interpolation.Part(_) | T.Interpolation.End() |
T.Interpolation.SpliceEnd(),
_
) =>
Seq(
Split(NoSplit, 0)
)
case FormatToken(T.LeftBrace(), T.RightBrace(), _) =>
Seq(
Split(NoSplit, 0)
)
// Import
case FormatToken(_: T.Dot, _, _)
if existsParentOfType[ImportExportStat](rightOwner) =>
Seq(Split(NoSplit, 0))
// Import left brace
case FormatToken(open: T.LeftBrace, _, _)
if existsParentOfType[ImportExportStat](leftOwner) =>
val close = matching(open)
val beforeClose = tokens.justBefore(close)
val policy = SingleLineBlock(
close,
okSLC = style.importSelectors eq ImportSelectors.singleLine
)
val newlineBeforeClosingCurly = decideNewlinesOnlyBeforeClose(close)
val mustDangleForTrailingCommas =
getMustDangleForTrailingCommas(beforeClose)
val mustUseNL = newlines != 0 &&
tokens.isRightCommentThenBreak(formatToken)
val newlinePolicy = style.importSelectors match {
case ImportSelectors.singleLine if mustUseNL =>
policy
case ImportSelectors.singleLine if !mustDangleForTrailingCommas =>
NoPolicy
case ImportSelectors.binPack =>
newlineBeforeClosingCurly
case _ =>
newlineBeforeClosingCurly & splitOneArgOneLine(close, leftOwner)
}
Seq(
Split(Space(style.spaces.inImportCurlyBraces), 0)
.notIf(mustUseNL || mustDangleForTrailingCommas)
.withPolicy(policy),
Split(Newline, 1)
.onlyIf(newlinePolicy ne NoPolicy)
.withPolicy(newlinePolicy)
.withIndent(style.indent.main, close, Before)
)
case FormatToken(_, _: T.RightBrace, _)
if existsParentOfType[ImportExportStat](rightOwner) =>
Seq(Split(Space(style.spaces.inImportCurlyBraces), 0))
// Interpolated string left brace
case FormatToken(open @ T.LeftBrace(), _, _)
if prev(formatToken).left.is[T.Interpolation.SpliceStart] =>
val close = matching(open)
val alignIndents =
if (style.align.inInterpolation) Some {
Seq(
Indent(Length.StateColumn, close, ExpiresOn.After),
Indent(Length.Num(style.indent.main), close, ExpiresOn.Before),
Indent(Length.Num(-1), close, ExpiresOn.After)
)
}
else None
def spaceSplit(implicit fileLine: FileLine) =
Split(Space(style.spaces.inInterpolatedStringCurlyBraces), 0)
.withIndents(alignIndents.getOrElse(Nil))
def newlineSplit(cost: Int)(implicit fileLine: FileLine) = {
def mainIndents = Seq(
Indent(style.indent.main, close, ExpiresOn.Before)
)
Split(Newline, cost)
.withIndents(alignIndents.getOrElse(mainIndents))
.withPolicy(decideNewlinesOnlyBeforeClose(close))
}
def isSimpleInterpolate = (leftOwner match {
case t: Pat.Interpolate => findArgAfter(open.end, t.args)
case t: Term.Interpolate => findArgAfter(open.end, t.args)
case t: Term.Block => getBlockSingleStat(t)
case _ => None
}).exists(!_.is[Term.If])
style.newlines.inInterpolation match {
case Newlines.InInterpolation.avoid => Seq(spaceSplit)
case _ if style.newlines.keepBreak(newlines) =>
Seq(newlineSplit(0))
case Newlines.InInterpolation.allow
if !dialect.allowSignificantIndentation || isSimpleInterpolate =>
Seq(spaceSplit)
case _ =>
/* sequence of tokens:
* - 0 RBrace
* - 1 Interpolation.SpliceEnd (empty)
* - 2 Interpolation.Part (next string)
* - 3 Interpolation.End (quotes) or Interpolation.SliceStart/LBrace (${)
*/
val afterClose = tokens(close, 3)
val lastPart = afterClose.left.is[T.Interpolation.End]
val slbEnd = if (lastPart) afterClose.left else afterClose.right
Seq(
spaceSplit.withSingleLine(slbEnd),
newlineSplit(1)
)
}
case FormatToken(_, _: T.RightBrace, _) if isInterpolate(rightOwner) =>
Seq(Split(Space(style.spaces.inInterpolatedStringCurlyBraces), 0))
// optional braces: block follows
case FormatToken(
_: T.Equals | _: T.Colon | _: T.KwWith | _: T.RightParen |
_: T.KwReturn | _: T.ContextArrow | _: T.LeftArrow |
_: T.RightArrow | _: T.KwMatch | _: T.KwThen | _: T.KwElse |
_: T.KwThrow | _: T.KwTry | _: T.KwCatch | _: T.KwFinally |
_: T.KwFor | _: T.KwDo | _: T.KwWhile | _: T.KwYield | _: T.KwIf,
_,
OptionalBraces(splits)
) if dialect.allowSignificantIndentation =>
splits
// { ... } Blocks
case tok @ FormatToken(open @ T.LeftBrace(), right, _) =>
val close = matching(open)
val closeFT = tokens(close)
val newlineBeforeClosingCurly = decideNewlinesOnlyBeforeClose(close)
val selfAnnotationLast: Option[T] = leftOwner match {
// Self type: trait foo { self => ... }
case t: Template => t.self.tokens.lastOption
case _ => None
}
val isSelfAnnotationNL = selfAnnotationLast.nonEmpty &&
style.optIn.selfAnnotationNewline &&
(formatToken.hasBreak || style.newlines.sourceIgnored)
val rightIsComment = right.is[T.Comment]
val nl: Modification =
if (rightIsComment && tok.noBreak) Space
else {
val double = tok.hasBlankLine ||
!isSelfAnnotationNL &&
rightIsComment && blankLineBeforeDocstring(tok)
NewlineT(double)
}
// lambdaNLOnly: None for single line only
val (lambdaExpire, lambdaArrow, lambdaIndent, lambdaNLOnly) =
startsStatement(right) match {
case Some(owner: Term.FunctionTerm) if (leftOwner match {
case t: Template =>
t.parent.exists(_.is[Term.NewAnonymous]) &&
isSingleElement(t.stats, owner)
case _ => true
}) =>
val arrow = getFuncArrow(lastLambda(owner))
val expire = arrow.getOrElse(tokens.getLast(owner))
val nlOnly =
if (style.newlines.alwaysBeforeCurlyLambdaParams) Some(true)
else if (
style.newlines.beforeCurlyLambdaParams eq
Newlines.BeforeCurlyLambdaParams.multiline
) None
else Some(false)
(expire, arrow.map(_.left), 0, nlOnly)
case Some(t: Case) if t.cond.isEmpty && (leftOwner match {
case x: Term.PartialFunction =>
isSingleElement(x.cases, t)
case x: Term.Match =>
isSingleElement(x.cases, t) && getMatchDot(x).isDefined
case _: Term.Try => false
case _ => tokens.tokenAfter(t).right eq close
}) =>
val arrow = getCaseArrow(t)
val nlOnly =
if (style.newlines.alwaysBeforeCurlyLambdaParams) Some(true)
else if (
style.newlines.beforeCurlyLambdaParams ne
Newlines.BeforeCurlyLambdaParams.never
) None
else Some(false)
(arrow, Some(arrow.left), 0, nlOnly)
case _ =>
val annoOpt = selfAnnotationLast.map { anno =>
val indent = style.indent.main
val annoFT = tokens(anno)
val arrow = annoFT.left.is[T.RightArrow]
val expire = if (arrow) annoFT else next(nextNonComment(annoFT))
(expire, Some(expire.left), indent, Some(isSelfAnnotationNL))
}
annoOpt.getOrElse { (null, None, 0, None) }
}
val lambdaPolicy =
if (lambdaExpire == null) null
else {
val arrowOptimal = getOptimalTokenFor(lambdaExpire)
newlineBeforeClosingCurly &
SingleLineBlock(arrowOptimal) &
decideNewlinesOnlyAfterToken(arrowOptimal)
}
def getSingleLineDecision = {
type Classifiers = Seq[Classifier[T, _]]
def classifiersByParent: Classifiers =
leftOwner.parent match {
case Some(_: Term.If) => Seq(T.KwElse.classifier)
case Some(_: Term.Try | _: Term.TryWithHandler) =>
Seq(T.KwCatch.classifier, T.KwFinally.classifier)
case _ => Seq.empty
}
val classifiers: Classifiers = leftOwner match {
// for catch with case, we should go up only one level
case _: Term.Try if rightOwner.is[Case] =>
Seq(T.KwFinally.classifier)
case _ => classifiersByParent
}
val breakSingleLineAfterClose = classifiers.nonEmpty && {
val afterClose = closeFT.right
classifiers.exists(_(afterClose))
}
if (!breakSingleLineAfterClose) Policy.NoPolicy
else decideNewlinesOnlyAfterClose(close)
}
def getClassicSingleLineDecisionOpt =
if (newlines > 0) None
else Some(getSingleLineDecision)
def getSingleLineLambdaDecisionOpt = {
val ok = !lambdaNLOnly.contains(true) &&
getSpaceAndNewlineAfterCurlyLambda(newlines)._1
if (ok) Some(getSingleLineDecision) else None
}
// null if skipping
val singleLineDecisionOpt = style.newlines.source match {
case Newlines.keep if newlines != 0 => None
case Newlines.unfold => None
case Newlines.fold =>
val isTopLevelBlock =
leftOwner.parent.exists(_.parent.isEmpty) || (leftOwner match {
case t: Template =>
// false for
// new A { () =>
// println("A")
// }
// but true for
// new A {
// def f = x
// }
!t.parent.exists(_.is[Term.NewAnonymous]) ||
t.stats.exists(_.is[Defn])
case _ => false
})
// do not fold top-level blocks
if (isTopLevelBlock) None
else if (lambdaPolicy != null) getSingleLineLambdaDecisionOpt
else
Some(getSingleLineDecision match {
case NoPolicy if leftOwner.is[Term.ForYield] =>
val postClose = nextNonComment(closeFT).right
val bodySlb = SingleLineBlock(getLastToken(leftOwner))
new Policy.Delay(bodySlb, Policy.End.On(postClose))
case x => x
})
// old behaviour
case _ =>
if (lambdaPolicy == null) getClassicSingleLineDecisionOpt
else getSingleLineLambdaDecisionOpt
}
val singleLineSplit =
singleLineDecisionOpt.fold(Split.ignored) { sld =>
val expire = endOfSingleLineBlock(closeFT)
Split(xmlSpace(leftOwner), 0)
.withSingleLine(expire, noSyntaxNL = true, killOnFail = true)
.andPolicy(sld)
}
val splits = Seq(
singleLineSplit,
Split(nl, 1)
.withPolicy(newlineBeforeClosingCurly)
.withIndent(style.indent.main, close, Before),
Split(Space, 0)
.onlyIf(lambdaNLOnly.contains(false) && lambdaPolicy != null)
.notIf(style.newlines.keepBreak(newlines))
.withOptimalTokenOpt(lambdaArrow)
.withIndent(lambdaIndent, close, Before)
.withPolicy(lambdaPolicy)
)
right match {
case t: T.Xml.Start => withIndentOnXmlStart(t, splits)
case _ => splits
}
case FormatToken(
T.RightArrow() | T.ContextArrow(),
_,
StartsStatementRight(stmt)
) if leftOwner.isInstanceOf[Term.FunctionTerm] =>
val leftFunc = leftOwner.asInstanceOf[Term.FunctionTerm]
val (afterCurlySpace, afterCurlyNewlines) =
getSpaceAndNewlineAfterCurlyLambda(newlines)
val spaceSplit =
if (stmt.isInstanceOf[Term.FunctionTerm]) Split(Space, 0)
else if (
afterCurlySpace &&
(!rightOwner.is[Defn] || style.newlines.source.eq(Newlines.fold))
)
Split(Space, 0).withSingleLineNoOptimal(
getOptimalTokenFor(getLastNonTrivial(leftFunc.body).left),
noSyntaxNL = true
)
else Split.ignored
val (endIndent, expiresOn) = functionExpire(leftFunc)
Seq(
spaceSplit,
Split(afterCurlyNewlines, 1)
.withIndent(style.indent.main, endIndent, expiresOn)
)
case FormatToken(_: T.RightArrow | _: T.ContextArrow, right, _)
if (leftOwner match {
case _: Term.FunctionTerm | _: Term.PolyFunction => true
case t: Template => t.parent.exists(_.is[Term.NewAnonymous])
case t: Self =>
t.parent.exists(_.parent.exists(_.is[Term.NewAnonymous]))
case _ => false
}) =>
val (endOfFunction, expiresOn) = leftOwner match {
case t: Term.FunctionTerm => functionExpire(t)
case t => getLastNonTrivialToken(t) -> ExpiresOn.Before
}
val hasSingleLineComment = tokens.isRightCommentThenBreak(formatToken)
val indent = // don't indent if the body is empty `{ x => }`
if (isEmptyFunctionBody(leftOwner) && !right.is[T.Comment]) 0
else if (leftOwner.is[Template]) 0 // { applied the indent
else
leftOwner.parent match {
case Some(ArgClauseParent(p: Term.Apply)) if isFewerBraces(p) =>
style.indent.getSignificant
case _ => style.indent.main
}
def noSingleLine = {
// for constructors with empty args lambda
// new Foo { () =>
// println("wow")
// }
val isCurlyLambda =
leftOwner.is[Template] || leftOwner.parent.exists(_.is[Template])
def noSquash =
style.newlines.afterCurlyLambdaParams ne
Newlines.AfterCurlyLambdaParams.squash
style.newlines.source match {
case Newlines.fold => false
case Newlines.unfold => isCurlyLambda && noSquash
case Newlines.keep => newlines != 0
case Newlines.classic => isCurlyLambda && newlines != 0 && noSquash
}
}
val singleLineSplit =
Split(Space, 0)
.notIf(hasSingleLineComment || noSingleLine)
.withSingleLineNoOptimal(endOfFunction)
def newlineSplit =
Split(Newline, 1 + nestedApplies(leftOwner))
.withIndent(indent, endOfFunction, expiresOn)
val multiLineSplits =
if (hasSingleLineComment)
Seq(newlineSplit)
else {
// 2020-01: break after same-line comments, and any open brace
val nonComment = nextNonCommentSameLine(formatToken)
val hasBlock = nonComment.right.is[T.LeftBrace] &&
(matching(nonComment.right) eq endOfFunction)
if (!hasBlock && (nonComment eq formatToken))
Seq(newlineSplit)
else {
// break after the brace or comment if fits, or now if doesn't
// if brace, don't add indent, the LeftBrace rule will do that
val spaceIndent = if (hasBlock) 0 else indent
Seq(
Split(Space, 0)
.withIndent(spaceIndent, endOfFunction, expiresOn)
.withOptimalToken(getOptimalTokenFor(next(nonComment))),
newlineSplit
)
}
}
singleLineSplit +: multiLineSplits
// Case arrow
case tok @ FormatToken(_: T.RightArrow, rt, _)
if leftOwner.is[CaseTree] && !rt.isAny[T.KwCatch, T.KwFinally] =>
val owner = leftOwner.asInstanceOf[CaseTree]
val body = owner.body
val condIsDefined = leftOwner match {
case c: Case => c.cond.isDefined
case _ => false
}
val bodyIsEmpty = body match {
case t: Term.Block => t.stats.isEmpty
case t => t.tokens.isEmpty
}
def baseSplit = Split(Space, 0)
def nlSplit(ft: FormatToken)(cost: Int)(implicit l: FileLine) =
Split(NewlineT(isDouble = ft.hasBlankLine && bodyIsEmpty), cost)
CtrlBodySplits.checkComment(tok, nlSplit(tok)) { ft =>
def withSlbSplit(implicit l: FileLine) = Seq(
baseSplit.withSingleLine(getLastNonTrivialToken(body)),
nlSplit(ft)(1)(nextLine)
)
val beforeMultiline = style.newlines.getBeforeMultiline
if (isCaseBodyABlock(ft, owner)) Seq(baseSplit)
else if (isCaseBodyEnclosedAsBlock(ft, owner)) Seq(baseSplit)
else if (ft.right.is[T.KwCase]) Seq(nlSplit(ft)(0))
else if (ft.hasBreak && !beforeMultiline.ignoreSourceSplit)
Seq(nlSplit(ft)(0))
else if (bodyIsEmpty) Seq(baseSplit, nlSplit(ft)(1))
else if (beforeMultiline eq Newlines.unfold) {
if (style.newlines.source ne Newlines.unfold) withSlbSplit
else Seq(nlSplit(ft)(0))
} else if (
condIsDefined ||
beforeMultiline.eq(Newlines.classic) ||
getSingleStatExceptEndMarker(body).isEmpty
) withSlbSplit
else {
val isKeep = beforeMultiline.eq(Newlines.keep)
CtrlBodySplits.foldedNonEmptyNonComment(body, nlSplit(ft), isKeep)
}
}
// New statement
case tok @ FormatToken(_: T.Semicolon, _, StartsStatementRight(stmt))
if newlines == 0 =>
val spaceSplit =
if (style.newlines.source eq Newlines.unfold) Split.ignored
else {
val expire = getLastToken(stmt)
Split(Space, 0).withSingleLine(expire)
}
Seq(
spaceSplit,
// For some reason, this newline cannot cost 1.
Split(NewlineT(isDouble = tok.hasBlankLine), 0)
)
case FormatToken(
_: T.RightParen,
_,
ParamClauseParentLeft(extGroup: Defn.ExtensionGroup)
) if !LeftParenOrBrace.unapply(nextNonComment(formatToken).right) =>
val expireToken = getLastToken(extGroup)
def nlSplit(cost: Int = 0)(implicit fileLine: FileLine) =
Split(Newline, cost).withIndent(style.indent.main, expireToken, After)
style.newlines.source match {
case Newlines.unfold =>
Seq(nlSplit())
case Newlines.keep if newlines != 0 =>
Seq(nlSplit())
case _ =>
Seq(
Split(Space, 0).withSingleLine(expireToken),
nlSplit(cost = 1)
)
}
case tok @ FormatToken(left, right, StartsStatementRight(_)) =>
val expire = rightOwner.tokens
.find(_.is[T.Equals])
.fold(getLastToken(rightOwner)) { equalsToken =>
val equalsFormatToken = tokens(equalsToken)
if (equalsFormatToken.right.is[T.LeftBrace]) {
equalsFormatToken.right
} else {
equalsToken
}
}
val annoRight = right.is[T.At]
val annoLeft = isSingleIdentifierAnnotation(prev(tok))
if (
(annoRight || annoLeft) &&
style.optIn.annotationNewlines && !style.newlines.sourceIgnored
)
Seq(Split(getMod(formatToken), 0))
else {
maybeGetInfixSplitsBeforeLhs(
formatToken,
Some(
if (left.is[T.Comment] && tok.noBreak) Space
else NewlineT(isDouble = tok.hasBlankLine)
)
) {
val spaceCouldBeOk = annoLeft && (style.newlines.source match {
case Newlines.unfold =>
right.is[T.Comment] ||
!style.optIn.annotationNewlines && annoRight
case Newlines.fold =>
right.is[T.Comment] || annoRight ||
!style.optIn.annotationNewlines && Reserved.unapply(right)
case Newlines.keep =>
newlines == 0 && (annoRight || Reserved.unapply(right))
case _ =>
newlines == 0 && Reserved.unapply(right)
})
Seq(
// This split needs to have an optimalAt field.
Split(Space, 0)
.onlyIf(spaceCouldBeOk)
.withSingleLine(expire),
// For some reason, this newline cannot cost 1.
Split(NewlineT(isDouble = tok.hasBlankLine), 0)
)
}
}
case FormatToken(_, T.RightBrace(), _) =>
Seq(
Split(xmlSpace(rightOwner), 0),
Split(NewlineT(isDouble = formatToken.hasBlankLine), 0)
)
case FormatToken(_: T.KwPackage, _, _) if leftOwner.is[Pkg] =>
Seq(
Split(Space, 0)
)
// Opening [ with no leading space.
// Opening ( with no leading space.
case ft @ FormatToken(left, open @ LeftParenOrBracket(), _)
if noSpaceBeforeOpeningParen(rightOwner) && {
val prevFt = prevNonComment(formatToken)
prevFt.left match {
case _: T.RightParen | _: T.RightBrace =>
prevFt.meta.leftOwner match {
case _: Term.For | _: Term.If | _: Term.While => false
case _ => true
}
case _: T.RightBracket | _: T.KwSuper | _: T.KwThis | _: T.Ident |
_: T.Underscore | _: T.Constant.Symbol =>
true
case _ => false
}
} =>
def modification: Modification = Space(leftOwner match {
case _ if left.is[T.Comment] => true
case _: Mod => true
// Add a space between constructor annotations and their parameter lists
// see:
// https://github.com/scalameta/scalafmt/pull/1516
// https://github.com/scalameta/scalafmt/issues/1528
case t: Init => t.parent.forall(_.is[Mod.Annot])
case Term.Name(name) =>
style.spaces.afterTripleEquals && name == "===" ||
(rightOwner match {
case _: Term.ArgClause =>
style.spaces.beforeApplyArgInParens(name)
case _: Member.ParamClause =>
style.spaces.afterSymbolicDefs && isSymbolicName(name)
case _ => false
})
case _: Defn.ExtensionGroup =>
style.spaces.afterKeywordBeforeParen &&
soft.KwExtension.unapply(left)
case _ => false
})
def baseNoSplit(implicit fileLine: FileLine) = Split(modification, 0)
val defn = isParamClauseSite(rightOwner)
val defRhs = if (defn) defDefBodyParent(rightOwner) else None
val beforeDefRhs = defRhs.flatMap(tokens.tokenJustBeforeOpt)
def getSplitsBeforeOpenParen(
src: Newlines.SourceHints,
indentLen: Int,
shouldAlignBefore: Align => Boolean
)(lastSyntaxClause: => Option[Member.SyntaxValuesClause]) = {
val close = matching(open)
val indent = Indent(indentLen, close, ExpiresOn.After)
val isAlignFirstParen = shouldAlignBefore(style.align) &&
!prevNonComment(ft).left.is[T.RightParen]
def noSplitSplit(implicit fileLine: FileLine) =
if (isAlignFirstParen) baseNoSplit
else baseNoSplit.withSingleLine(close)
val splits = src match {
case Newlines.unfold =>
val rightParent = rightOwner.parent.get
val slbEnd =
if (defn)
beforeDefRhs
.fold(getLastToken(rightParent))(prevNonComment(_).left)
else getLastToken(getLastCall(rightParent))
val multipleArgs = isSeqMulti(getArgs(next(ft).meta.leftOwner))
val nft = tokens.tokenAfter(close)
val nlPolicy = nft.right match {
case t: T.LeftParen => decideNewlinesOnlyBeforeClose(t)
case t: T.Colon
if defn && (nft.left.is[T.Comment] ||
style.newlines.sometimesBeforeColonInMethodReturnType
&& defDefReturnType(rightOwner).isDefined) =>
decideNewlinesOnlyBeforeClose(t)
case _ => NoPolicy
}
Seq(
baseNoSplit.withSingleLine(slbEnd),
Split(Newline, 1)
.withIndent(indent)
.withPolicy(
penalizeNewlineByNesting(open, close),
multipleArgs
)
.andPolicy(nlPolicy)
)
case Newlines.keep =>
if (newlines != 0)
Seq(Split(Newline, 0).withIndent(indent))
else
Seq(
noSplitSplit,
Split(Newline, 1).withIndent(indent)
)
case _ =>
def nlColonPolicy =
if (!style.newlines.sometimesBeforeColonInMethodReturnType) None
else if (!defn) None
else
defDefReturnType(rightOwner).flatMap { declTpe =>
tokenBefore(declTpe).left match {
case t: T.Colon => Some(decideNewlinesOnlyBeforeClose(t))
case _ => None
}
}
Seq(
noSplitSplit,
Split(Newline, 1)
.withIndent(indent)
.withPolicyOpt(nlColonPolicy)
)
}
val argsOpt = if (isAlignFirstParen) lastSyntaxClause else None
argsOpt.flatMap(getLastTokenOpt).fold(splits) { x =>
val noSplitIndents = Seq(
Indent(StateColumn, x, ExpiresOn.Before),
Indent(-indentLen, x, ExpiresOn.Before)
)
splits.map { s =>
if (s.isNL) s else s.withIndents(noSplitIndents)
}
}
}
val beforeOpenParenSplits =
if (!open.is[T.LeftParen]) None
else if (defn)
style.newlines.getBeforeOpenParenDefnSite.map { x =>
val beforeBody = defRhs.flatMap {
case t: Template => templateCurlyFt(t)
case _ => beforeDefRhs
}
val indent = beforeBody.fold(style.indent.main) { y =>
val ob = OptionalBraces.get(y).nonEmpty
style.indent.extraBeforeOpenParenDefnSite +
(if (ob) style.indent.getSignificant else style.indent.main)
}
getSplitsBeforeOpenParen(x, indent, _.beforeOpenParenDefnSite) {
@tailrec
def iter(tree: Tree): Option[Member.ParamClause] = tree match {
case _: Member.ParamClause =>
tree.parent match {
case Some(p) => iter(p)
case None => None
}
case p: Tree.WithParamClauses => p.paramClauses.lastOption
case _ => None
}
iter(rightOwner)
}
}
else if (style.dialect.allowSignificantIndentation)
style.newlines.getBeforeOpenParenCallSite.map { x =>
val indent = style.indent.getSignificant
@tailrec
def findLastCallArgs(t: Member.Apply): Member.ArgClause =
t.parent match {
case Some(p: Member.Apply) => findLastCallArgs(p)
case _ => t.argClause
}
getSplitsBeforeOpenParen(x, indent, _.beforeOpenParenCallSite) {
rightOwner.parent
.collect { case p: Member.Apply => findLastCallArgs(p) }
}
}
else None
beforeOpenParenSplits.getOrElse(Seq(baseNoSplit))
// Defn.{Object, Class, Trait, Enum}
case FormatToken(
_: T.KwObject | _: T.KwClass | _: T.KwTrait | _: T.KwEnum,
_,
WithTemplateOnLeft(template)
) =>
def expire = getTemplateGroups(template)
.flatMap(_.last.headOption.flatMap(_.tokens.headOption))
.getOrElse(getLastToken(leftOwner))
def forceNewlineBeforeExtends = Policy.before(expire) {
case Decision(FormatToken(_, soft.ExtendsOrDerives(), m), s)
if m.rightOwner.parent.contains(leftOwner) =>
s.filter(x => x.isNL && !x.isActiveFor(SplitTag.OnelineWithChain))
}
val policy =
if (style.binPack.keepParentConstructors) None
else
template.tokens.headOption.map { head =>
val policyEnd = Policy.End.Before(head)
delayedBreakPolicy(policyEnd)(forceNewlineBeforeExtends)
}
Seq(Split(Space, 0).withPolicyOpt(policy))
// DefDef
case FormatToken(_: T.KwDef, _: T.Ident, _) =>
Seq(Split(Space, 0))
case ft @ FormatToken(_: T.Equals, _, DefValAssignLeft(rhs)) =>
maybeGetInfixSplitsBeforeLhs(ft) {
getSplitsDefValEquals(ft, rhs) {
if (leftOwner.is[Tree.WithParamClauses]) getSplitsDefEquals(ft, rhs)
else getSplitsValEquals(ft, rhs)(getSplitsValEqualsClassic(ft, rhs))
}
}
// Parameter opening for one parameter group. This format works
// on the WHOLE defnSite (via policies)
case ft @ FormatToken(LeftParenOrBracket(), _, _)
if style.verticalMultiline.atDefnSite &&
isParamClauseSite(leftOwner) =>
verticalMultiline(ft)(style)
// Term.Apply and friends
case FormatToken(lp: T.LeftParen, _, LambdaAtSingleArgCallSite(lambda)) =>
val close = matching(lp)
val newlinePolicy =
if (!style.danglingParentheses.callSite) None
else Some(decideNewlinesOnlyBeforeClose(close))
val noSplitMod =
if (style.newlines.alwaysBeforeCurlyLambdaParams) null
else getNoSplit(formatToken, true)
def multilineSpaceSplit(implicit fileLine: FileLine): Split = {
val lambdaLeft: Option[T] =
matchingOpt(functionExpire(lambda)._1).filter(_.is[T.LeftBrace])
val arrowFt = getFuncArrow(lambda).get
val lambdaIsABlock = lambdaLeft.contains(arrowFt.right)
val lambdaToken =
getOptimalTokenFor(if (lambdaIsABlock) next(arrowFt) else arrowFt)
val spacePolicy = SingleLineBlock(lambdaToken) | {
if (lambdaIsABlock) None
else
newlinePolicy.map(
delayedBreakPolicy(Policy.End.On(lambdaLeft.getOrElse(close)))
)
}
Split(noSplitMod, 0)
.withPolicy(spacePolicy)
.withOptimalToken(lambdaToken)
}
if (noSplitMod == null)
Seq(
Split(Newline, 0)
.withPolicyOpt(newlinePolicy)
.withIndent(style.indent.callSite, close, Before)
)
else {
val newlinePenalty = 3 + nestedApplies(leftOwner)
val noMultiline = style.newlines.beforeCurlyLambdaParams eq
Newlines.BeforeCurlyLambdaParams.multiline
Seq(
Split(noSplitMod, 0).withSingleLine(close),
if (noMultiline) Split.ignored else multilineSpaceSplit,
Split(Newline, newlinePenalty)
.withPolicyOpt(newlinePolicy)
.withIndent(style.indent.callSite, close, Before)
)
}
case FormatToken(T.LeftParen(), T.RightParen(), _) =>
val noNL = style.newlines.sourceIgnored || formatToken.noBreak
Seq(Split(NoSplit.orNL(noNL), 0))
case tok @ FormatToken(open @ LeftParenOrBracket(), right, _) if {
if (isArgClauseSite(leftOwner))
style.binPack.callSite(open).isNever
else
style.binPack.defnSite(open).isNever &&
isParamClauseSite(leftOwner)
} =>
val close = matching(open)
val closeFormatToken = tokens(close)
val beforeClose = prev(closeFormatToken)
val tupleSite = isTuple(leftOwner)
val anyDefnSite = isParamClauseSite(leftOwner)
val defnSite = !tupleSite && anyDefnSite
val args = getArgs(leftOwner)
// In long sequence of select/apply, we penalize splitting on
// parens furthest to the right.
def leftOwnerIsEnclosed = leftOwner.is[Member.Function]
val lhsPenalty = leftOwner match {
case t: Member.SyntaxValuesClause =>
t.parent match {
case Some(p: Init) => treeDepth(p.tpe)
case Some(p: Member.Apply) => treeDepth(p.fun)
case Some(_: Member.Function) => maxTreeDepth(t.values)
case _ => 0
}
case t => treeDepth(t)
}
// XXX: sometimes we have zero args, so multipleArgs != !singleArgument
val numArgs = args.length
val singleArgument = numArgs == 1
val multipleArgs = numArgs > 1
val notTooManyArgs = multipleArgs && numArgs <= 100
val isBracket = open.is[T.LeftBracket]
val bracketCoef = if (isBracket) Constants.BracketPenalty else 1
val rightIsComment = right.is[T.Comment]
val onlyConfigStyle = mustUseConfigStyle(formatToken, beforeClose)
val sourceIgnored = style.newlines.sourceIgnored
val (onlyArgument, isSingleEnclosedArgument) =
if (singleArgument) {
val arg = args(0)
val maybeEnclosed = arg.parent match {
case Some(p: Member.SyntaxValuesClause)
if lhsPenalty != 0 && !p.is[Member.ArgClause] =>
p
case _ => arg
}
val isEnclosed = tokens.isEnclosedInMatching(maybeEnclosed)
if (isEnclosed) (maybeEnclosed, true) else (arg, false)
} else (null, false)
val useConfigStyle = onlyConfigStyle || (sourceIgnored &&
style.optIn.configStyleArguments && !isSingleEnclosedArgument)
val nestedPenalty = 1 + nestedApplies(leftOwner) + lhsPenalty
val indent =
if (anyDefnSite)
Num(style.indent.getDefnSite(leftOwner))
else
Num(style.indent.callSite)
val isBeforeOpenParen =
if (defnSite)
style.newlines.isBeforeOpenParenDefnSite
else
style.newlines.isBeforeOpenParenCallSite
val expirationToken: T =
if (isBeforeOpenParen) close
else if (defnSite && !isBracket)
defnSiteLastToken(closeFormatToken, leftOwner)
else
rhsOptimalToken(closeFormatToken)
val mustDangleForTrailingCommas =
getMustDangleForTrailingCommas(beforeClose)
val mustDangle = onlyConfigStyle || expirationToken.is[T.Comment] ||
mustDangleForTrailingCommas
val shouldDangle =
if (defnSite) !shouldNotDangleAtDefnSite(leftOwner.parent, false)
else style.danglingParentheses.tupleOrCallSite(tupleSite)
val wouldDangle = shouldDangle ||
beforeClose.hasBreak && beforeClose.left.is[T.Comment]
val newlinePolicy: Policy =
if (wouldDangle || mustDangle) {
decideNewlinesOnlyBeforeClose(close)
} else {
Policy.NoPolicy