-
Notifications
You must be signed in to change notification settings - Fork 249
/
KotlinSymbolProcessingExtension.kt
391 lines (366 loc) · 16.7 KB
/
KotlinSymbolProcessingExtension.kt
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
/*
* Copyright 2020 Google LLC
* Copyright 2010-2020 JetBrains s.r.o. and Kotlin Programming Language contributors.
*
* 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.google.devtools.ksp
import com.google.devtools.ksp.processing.KSPLogger
import com.google.devtools.ksp.processing.PlatformInfo
import com.google.devtools.ksp.processing.SymbolProcessor
import com.google.devtools.ksp.processing.SymbolProcessorEnvironment
import com.google.devtools.ksp.processing.SymbolProcessorProvider
import com.google.devtools.ksp.processing.impl.CodeGeneratorImpl
import com.google.devtools.ksp.processing.impl.JsPlatformInfoImpl
import com.google.devtools.ksp.processing.impl.JvmPlatformInfoImpl
import com.google.devtools.ksp.processing.impl.KSPCompilationError
import com.google.devtools.ksp.processing.impl.MessageCollectorBasedKSPLogger
import com.google.devtools.ksp.processing.impl.NativePlatformInfoImpl
import com.google.devtools.ksp.processing.impl.ResolverImpl
import com.google.devtools.ksp.processing.impl.UnknownPlatformInfoImpl
import com.google.devtools.ksp.symbol.KSAnnotated
import com.google.devtools.ksp.symbol.KSFile
import com.google.devtools.ksp.symbol.Origin
import com.google.devtools.ksp.symbol.impl.java.KSFileJavaImpl
import com.google.devtools.ksp.symbol.impl.kotlin.KSFileImpl
import com.intellij.openapi.project.Project
import com.intellij.openapi.vfs.StandardFileSystems
import com.intellij.openapi.vfs.VirtualFileManager
import com.intellij.psi.PsiJavaFile
import com.intellij.psi.PsiManager
import org.jetbrains.kotlin.analyzer.AnalysisResult
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
import org.jetbrains.kotlin.cli.jvm.plugins.ServiceLoaderLite
import org.jetbrains.kotlin.container.ComponentProvider
import org.jetbrains.kotlin.context.ProjectContext
import org.jetbrains.kotlin.descriptors.ModuleDescriptor
import org.jetbrains.kotlin.load.java.components.FilesByFacadeFqNameIndexer
import org.jetbrains.kotlin.platform.js.JsPlatform
import org.jetbrains.kotlin.platform.jvm.JdkPlatform
import org.jetbrains.kotlin.platform.konan.NativePlatform
import org.jetbrains.kotlin.psi.KtFile
import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.BindingTrace
import org.jetbrains.kotlin.resolve.extensions.AnalysisHandlerExtension
import java.io.File
import java.io.PrintWriter
import java.io.StringWriter
import java.net.URLClassLoader
import java.nio.file.Files
class KotlinSymbolProcessingExtension(
options: KspOptions,
logger: KSPLogger,
val testProcessor: SymbolProcessorProvider? = null,
) : AbstractKotlinSymbolProcessingExtension(options, logger, testProcessor != null) {
override fun loadProviders(): List<SymbolProcessorProvider> {
if (!initialized) {
providers = if (testProcessor != null) {
listOf(testProcessor)
} else {
val processingClasspath = options.processingClasspath
val classLoader =
URLClassLoader(processingClasspath.map { it.toURI().toURL() }.toTypedArray(), javaClass.classLoader)
ServiceLoaderLite.loadImplementations(SymbolProcessorProvider::class.java, classLoader).filter {
options.processors.isEmpty() || it.javaClass.name in options.processors
}
}
if (providers.isEmpty()) {
logger.error("No providers found in processor classpath.")
} else {
logger.info(
"loaded provider(s): " +
"${providers.joinToString(separator = ", ", prefix = "[", postfix = "]") { it.javaClass.name }}"
)
}
}
return providers
}
}
abstract class AbstractKotlinSymbolProcessingExtension(
val options: KspOptions,
val logger: KSPLogger,
val testMode: Boolean,
) :
AnalysisHandlerExtension {
var initialized = false
var finished = false
val deferredSymbols = mutableMapOf<SymbolProcessor, List<KSAnnotated>>()
lateinit var providers: List<SymbolProcessorProvider>
lateinit var processors: List<SymbolProcessor>
lateinit var incrementalContext: IncrementalContext
lateinit var dirtyFiles: Set<KSFile>
lateinit var cleanFilenames: Set<String>
lateinit var codeGenerator: CodeGeneratorImpl
var newFileNames: Collection<String> = emptySet()
var rounds = 0
companion object {
private const val KSP_PACKAGE_NAME = "com.google.devtools.ksp"
private const val KOTLIN_PACKAGE_NAME = "org.jetbrains.kotlin"
private const val MULTI_ROUND_THRESHOLD = 100
}
override fun doAnalysis(
project: Project,
module: ModuleDescriptor,
projectContext: ProjectContext,
files: Collection<KtFile>,
bindingTrace: BindingTrace,
componentProvider: ComponentProvider,
): AnalysisResult? {
// with `withCompilation == true`:
// * KSP returns AnalysisResult.RetryWithAdditionalRoots in last round of processing, to notify compiler the generated sources.
// * This function will be called again, and returning null tells compiler to fall through with normal compilation.
if (finished) {
if (!options.withCompilation)
throw IllegalStateException("KSP is re-entered unexpectedly.")
return null
}
rounds++
if (rounds > MULTI_ROUND_THRESHOLD) {
logger.warn("Current processing rounds exceeds 100, check processors for potential infinite rounds")
}
logger.logging("round $rounds of processing")
val psiManager = PsiManager.getInstance(project)
if (initialized) {
psiManager.dropPsiCaches()
}
val localFileSystem = VirtualFileManager.getInstance().getFileSystem(StandardFileSystems.FILE_PROTOCOL)
val javaSourceRoots =
if (initialized) options.javaSourceRoots + options.javaOutputDir else options.javaSourceRoots
val javaFiles = javaSourceRoots
.sortedBy { Files.isSymbolicLink(it.toPath()) } // Get non-symbolic paths first
.flatMap { root -> root.walk().filter { it.isFile && it.extension == "java" }.toList() }
.sortedBy { Files.isSymbolicLink(it.toPath()) } // This time is for .java files
.distinctBy { it.canonicalPath }
.mapNotNull { localFileSystem.findFileByPath(it.path)?.let { psiManager.findFile(it) } as? PsiJavaFile }
val anyChangesWildcard = AnyChanges(options.projectBaseDir)
val ksFiles = files.map { KSFileImpl.getCached(it) } + javaFiles.map { KSFileJavaImpl.getCached(it) }
lateinit var newFiles: List<KSFile>
handleException(module, project) {
val fileClassProcessor = FilesByFacadeFqNameIndexer(bindingTrace)
if (!initialized) {
incrementalContext = IncrementalContext(
options, componentProvider,
File(anyChangesWildcard.filePath).relativeTo(options.projectBaseDir)
)
dirtyFiles = incrementalContext.calcDirtyFiles(ksFiles).toSet()
cleanFilenames = ksFiles.filterNot { it in dirtyFiles }.map { it.filePath }.toSet()
newFiles = dirtyFiles.toList()
files.forEach { fileClassProcessor.preprocessFile(it) }
} else {
newFiles = ksFiles.filter {
when (it) {
is KSFileImpl -> it.file
is KSFileJavaImpl -> it.psi
else -> null
}?.virtualFile?.let { virtualFile ->
if (System.getProperty("os.name").startsWith("windows", ignoreCase = true)) {
virtualFile.canonicalPath ?: virtualFile.path
} else {
File(virtualFile.path).canonicalPath
}
} in newFileNames
}
incrementalContext.registerGeneratedFiles(newFiles)
newFiles.filterIsInstance<KSFileImpl>().forEach { fileClassProcessor.preprocessFile(it.file) }
}
}?.let { return@doAnalysis it }
// dirtyFiles cannot be reused because they are created in the old container.
val resolver = ResolverImpl(
module,
ksFiles.filterNot {
it.filePath in cleanFilenames
},
newFiles, deferredSymbols, bindingTrace, project, componentProvider, incrementalContext, options
)
val providers = loadProviders()
if (!initialized) {
codeGenerator = CodeGeneratorImpl(
options.classOutputDir,
options.javaOutputDir,
options.kotlinOutputDir,
options.resourceOutputDir,
options.projectBaseDir,
anyChangesWildcard,
ksFiles,
options.incremental
)
processors = providers.mapNotNull { provider ->
var processor: SymbolProcessor? = null
handleException(module, project) {
processor = provider.create(
SymbolProcessorEnvironment(
options.processingOptions,
options.languageVersion,
codeGenerator,
logger,
options.apiVersion,
options.compilerVersion,
findTargetInfos(module)
)
)
}?.let { analysisResult -> return@doAnalysis analysisResult }
if (logger.hasError()) {
return@mapNotNull null
}
processor?.also { deferredSymbols[it] = mutableListOf() }
}
/* Kotlin compiler expects a source dir to exist, but processors might not generate Kotlin source.
Create it during initialization just in case. */
options.kotlinOutputDir.mkdirs()
initialized = true
}
if (!logger.hasError()) {
processors.forEach processing@{ processor ->
handleException(module, project) {
deferredSymbols[processor] =
processor.process(resolver).filter { it.origin == Origin.KOTLIN || it.origin == Origin.JAVA }
}?.let { return it }
if (logger.hasError()) {
return@processing
}
if (!deferredSymbols.containsKey(processor) || deferredSymbols[processor]!!.isEmpty()) {
deferredSymbols.remove(processor)
}
}
}
// Post processing.
newFileNames = codeGenerator.generatedFile.filter { it.extension == "kt" || it.extension == "java" }
.map { it.canonicalPath.replace(File.separatorChar, '/') }.toSet()
if (codeGenerator.generatedFile.isEmpty()) {
finished = true
}
KSObjectCacheManager.clear()
codeGenerator.closeFiles()
if (logger.hasError()) {
finished = true
processors.forEach { processor ->
handleException(module, project) {
processor.onError()
}?.let { return it }
}
} else {
if (finished) {
processors.forEach { processor ->
handleException(module, project) {
processor.finish()
}?.let { return it }
}
if (deferredSymbols.isNotEmpty()) {
deferredSymbols.map { entry ->
logger.warn(
"Unable to process:${entry.key::class.qualifiedName}: ${
entry.value.map { it.toString() }.joinToString(";")
}"
)
}
}
if (!logger.hasError()) {
incrementalContext.updateCachesAndOutputs(
dirtyFiles,
codeGenerator.outputs,
codeGenerator.sourceToOutputs
)
}
}
}
if (finished) {
logger.reportAll()
}
return if (finished && !options.withCompilation) {
if (!options.returnOkOnError && logger.hasError()) {
AnalysisResult.compilationError(BindingContext.EMPTY)
} else {
AnalysisResult.success(BindingContext.EMPTY, module, shouldGenerateCode = false)
}
} else {
AnalysisResult.RetryWithAdditionalRoots(
BindingContext.EMPTY,
module,
listOf(options.javaOutputDir),
listOf(options.kotlinOutputDir),
listOf(options.classOutputDir)
)
}
}
abstract fun loadProviders(): List<SymbolProcessorProvider>
private var annotationProcessingComplete = false
private fun setAnnotationProcessingComplete(): Boolean {
if (annotationProcessingComplete) return true
annotationProcessingComplete = true
return false
}
private fun KSPLogger.reportAll() {
(this as MessageCollectorBasedKSPLogger).reportAll()
}
private fun KSPLogger.hasError(): Boolean {
return (this as MessageCollectorBasedKSPLogger).recordedEvents.any {
it.severity == CompilerMessageSeverity.ERROR || it.severity == CompilerMessageSeverity.EXCEPTION
}
}
private fun handleException(module: ModuleDescriptor, project: Project, call: () -> Unit): AnalysisResult? {
try {
call()
} catch (e: Exception) {
fun Exception.logToError() {
val sw = StringWriter()
printStackTrace(PrintWriter(sw))
logger.error(sw.toString())
}
fun Exception.isNotRecoverable(): Boolean =
stackTrace.first().className.let {
// TODO: convert non-critical exceptions thrown by KSP to recoverable errors.
it.startsWith(KSP_PACKAGE_NAME) || it.startsWith(KOTLIN_PACKAGE_NAME)
}
// Returning non-null here allows
// 1. subsequent processing of other processors in current round.
// 2. processor.onError() be called.
//
// In other words, returning non-null let current round finish.
when {
e is KSPCompilationError -> {
logger.error("${project.findLocationString(e.file, e.offset)}: ${e.message}")
logger.reportAll()
return if (options.returnOkOnError) {
AnalysisResult.success(BindingContext.EMPTY, module, shouldGenerateCode = false)
} else {
AnalysisResult.compilationError(BindingContext.EMPTY)
}
}
e.isNotRecoverable() -> {
e.logToError()
logger.reportAll()
return if (options.returnOkOnError) {
AnalysisResult.success(BindingContext.EMPTY, module, shouldGenerateCode = false)
} else {
AnalysisResult.internalError(BindingContext.EMPTY, e)
}
}
// Let this round finish.
else -> {
e.logToError()
}
}
}
return null
}
}
fun findTargetInfos(module: ModuleDescriptor): List<PlatformInfo> =
module.platform?.componentPlatforms?.map { platform ->
when (platform) {
is JdkPlatform -> JvmPlatformInfoImpl(platform.platformName, platform.targetVersion.toString())
is JsPlatform -> JsPlatformInfoImpl(platform.platformName)
is NativePlatform -> NativePlatformInfoImpl(platform.platformName, platform.targetName)
// Unknown platform; toString() may be more informative than platformName
else -> UnknownPlatformInfoImpl(platform.toString())
}
} ?: emptyList()