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
|
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.facebook.ktfmt.format
import com.facebook.ktfmt.debughelpers.printOps
import com.facebook.ktfmt.format.FormattingOptions.Style.DROPBOX
import com.facebook.ktfmt.format.FormattingOptions.Style.GOOGLE
import com.facebook.ktfmt.format.RedundantElementRemover.dropRedundantElements
import com.facebook.ktfmt.format.WhitespaceTombstones.indexOfWhitespaceTombstone
import com.facebook.ktfmt.kdoc.Escaping
import com.facebook.ktfmt.kdoc.KDocCommentsHelper
import com.google.common.collect.ImmutableList
import com.google.common.collect.Range
import com.google.googlejavaformat.Doc
import com.google.googlejavaformat.DocBuilder
import com.google.googlejavaformat.Newlines
import com.google.googlejavaformat.OpsBuilder
import com.google.googlejavaformat.java.FormatterException
import com.google.googlejavaformat.java.JavaOutput
import org.jetbrains.kotlin.com.intellij.openapi.util.text.StringUtil
import org.jetbrains.kotlin.com.intellij.openapi.util.text.StringUtilRt
import org.jetbrains.kotlin.com.intellij.psi.PsiComment
import org.jetbrains.kotlin.com.intellij.psi.PsiElement
import org.jetbrains.kotlin.com.intellij.psi.PsiElementVisitor
import org.jetbrains.kotlin.com.intellij.psi.PsiWhiteSpace
import org.jetbrains.kotlin.psi.KtImportDirective
import org.jetbrains.kotlin.psi.psiUtil.endOffset
import org.jetbrains.kotlin.psi.psiUtil.startOffset
object Formatter {
@JvmField
val GOOGLE_FORMAT = FormattingOptions(style = GOOGLE, blockIndent = 2, continuationIndent = 2)
/** A format that attempts to reflect https://kotlinlang.org/docs/coding-conventions.html. */
@JvmField
val KOTLINLANG_FORMAT = FormattingOptions(style = GOOGLE, blockIndent = 4, continuationIndent = 4)
@JvmField
val DROPBOX_FORMAT = FormattingOptions(style = DROPBOX, blockIndent = 4, continuationIndent = 4)
private val MINIMUM_KOTLIN_VERSION = KotlinVersion(1, 4)
/**
* format formats the Kotlin code given in 'code' and returns it as a string. This method is
* accessed through Reflection.
*/
@JvmStatic
@Throws(FormatterException::class, ParseError::class)
fun format(code: String): String = format(FormattingOptions(), code)
/**
* format formats the Kotlin code given in 'code' with 'removeUnusedImports' and returns it as a
* string. This method is accessed through Reflection.
*/
@JvmStatic
@Throws(FormatterException::class, ParseError::class)
fun format(code: String, removeUnusedImports: Boolean): String =
format(FormattingOptions(removeUnusedImports = removeUnusedImports), code)
/**
* format formats the Kotlin code given in 'code' with the 'maxWidth' and returns it as a string.
*/
@JvmStatic
@Throws(FormatterException::class, ParseError::class)
fun format(options: FormattingOptions, code: String): String {
val (shebang, kotlinCode) =
if (code.startsWith("#!")) {
code.split("\n".toRegex(), limit = 2)
} else {
listOf("", code)
}
checkEscapeSequences(kotlinCode)
val lfCode = StringUtilRt.convertLineSeparators(kotlinCode)
val sortedImports = sortedAndDistinctImports(lfCode)
val pretty = prettyPrint(sortedImports, options, "\n")
val noRedundantElements =
try {
dropRedundantElements(pretty, options)
} catch (e: ParseError) {
throw IllegalStateException("Failed to re-parse code after pretty printing:\n $pretty", e)
}
val prettyCode =
prettyPrint(noRedundantElements, options, Newlines.guessLineSeparator(kotlinCode)!!)
return if (shebang.isNotEmpty()) shebang + "\n" + prettyCode else prettyCode
}
/** prettyPrint reflows 'code' using google-java-format's engine. */
private fun prettyPrint(code: String, options: FormattingOptions, lineSeparator: String): String {
val file = Parser.parse(code)
val kotlinInput = KotlinInput(code, file)
val javaOutput =
JavaOutput(lineSeparator, kotlinInput, KDocCommentsHelper(lineSeparator, options.maxWidth))
val builder = OpsBuilder(kotlinInput, javaOutput)
file.accept(createAstVisitor(options, builder))
builder.sync(kotlinInput.text.length)
builder.drain()
val ops = builder.build()
if (options.debuggingPrintOpsAfterFormatting) {
printOps(ops)
}
val doc = DocBuilder().withOps(ops).build()
doc.computeBreaks(javaOutput.commentsHelper, options.maxWidth, Doc.State(+0, 0))
doc.write(javaOutput)
javaOutput.flush()
val tokenRangeSet =
kotlinInput.characterRangesToTokenRanges(ImmutableList.of(Range.closedOpen(0, code.length)))
return WhitespaceTombstones.replaceTombstoneWithTrailingWhitespace(
JavaOutput.applyReplacements(code, javaOutput.getFormatReplacements(tokenRangeSet)))
}
private fun createAstVisitor(options: FormattingOptions, builder: OpsBuilder): PsiElementVisitor {
if (KotlinVersion.CURRENT < MINIMUM_KOTLIN_VERSION) {
throw RuntimeException("Unsupported runtime Kotlin version: " + KotlinVersion.CURRENT)
}
return KotlinInputAstVisitor(options, builder)
}
private fun checkEscapeSequences(code: String) {
var index = code.indexOfWhitespaceTombstone()
if (index == -1) {
index = Escaping.indexOfCommentEscapeSequences(code)
}
if (index != -1) {
throw ParseError(
"ktfmt does not support code which contains one of {\\u0003, \\u0004, \\u0005} character" +
"; escape it",
StringUtil.offsetToLineColumn(code, index))
}
}
private fun sortedAndDistinctImports(code: String): String {
val file = Parser.parse(code)
val importList = file.importList ?: return code
if (importList.imports.isEmpty()) {
return code
}
val commentList = mutableListOf<PsiElement>()
// Find non-import elements; comments are moved, in order, to the top of the import list. Other
// non-import elements throw a ParseError.
var element = importList.firstChild
while (element != null) {
if (element is PsiComment) {
commentList.add(element)
} else if (element !is KtImportDirective && element !is PsiWhiteSpace) {
throw ParseError(
"Imports not contiguous: " + element.text,
StringUtil.offsetToLineColumn(code, element.startOffset))
}
element = element.nextSibling
}
fun canonicalText(importDirective: KtImportDirective) =
importDirective.importedFqName?.asString() +
" " +
importDirective.alias?.text?.replace("`", "") +
" " +
if (importDirective.isAllUnder) "*" else ""
val sortedImports = importList.imports.sortedBy(::canonicalText).distinctBy(::canonicalText)
val importsWithComments = commentList + sortedImports
return code.replaceRange(
importList.startOffset,
importList.endOffset,
importsWithComments.joinToString(separator = "\n") { imprt -> imprt.text } + "\n")
}
}
|
