Implement source sections compiler plugin

allows to compile only parts of the source files, denoted by top-level
"sections" (function with lambda param calls), but preserving original
file line/column numbers for easier diagnostics. Allow e.g. to compile
gradle "buildscript" section without preprocessing original file in
advance. See tests for examples.
This commit is contained in:
Ilya Chernikov
2017-03-10 16:15:11 +01:00
parent 63c276d444
commit 4b430b49a7
17 changed files with 708 additions and 4 deletions
@@ -0,0 +1 @@
org.jetbrains.kotlin.sourceSections.SourceSectionsCommandLineProcessor
@@ -0,0 +1 @@
org.jetbrains.kotlin.sourceSections.SourceSectionsComponentRegistrar
@@ -0,0 +1,145 @@
/*
* Copyright 2010-2017 JetBrains s.r.o.
*
* 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 org.jetbrains.kotlin.sourceSections
import com.intellij.openapi.vfs.VirtualFile
import com.intellij.openapi.vfs.VirtualFileSystem
import com.intellij.testFramework.LightVirtualFile
import org.jetbrains.kotlin.lexer.KotlinLexer
import org.jetbrains.kotlin.lexer.KtTokens
import java.io.ByteArrayInputStream
import java.io.InputStream
import java.io.OutputStream
import java.nio.ByteBuffer
import java.nio.CharBuffer
import java.nio.charset.Charset
class FilteredSectionsVirtualFile(val delegate: VirtualFile, val sectionIds: Collection<String>) : VirtualFile() {
override fun refresh(asynchronous: Boolean, recursive: Boolean, postRunnable: Runnable?) {
delegate.refresh(asynchronous, recursive, postRunnable)
}
override fun getLength(): Long = delegate.length
override fun getFileSystem(): VirtualFileSystem = delegate.fileSystem
override fun getPath(): String = delegate.path
override fun isDirectory(): Boolean = delegate.isDirectory
override fun getTimeStamp(): Long = delegate.timeStamp
override fun getName(): String = delegate.name
override fun contentsToByteArray(): ByteArray = filterByteContents(sectionIds, delegate.contentsToByteArray(), delegate.charset)
override fun getInputStream(): InputStream = ByteArrayInputStream(contentsToByteArray())
override fun isValid(): Boolean =delegate.isValid
override fun getParent(): VirtualFile = delegate.parent
override fun getChildren(): Array<VirtualFile> = delegate.children
override fun isWritable(): Boolean = delegate.isWritable
override fun getOutputStream(requestor: Any?, newModificationStamp: Long, newTimeStamp: Long): OutputStream =
delegate.getOutputStream(requestor, newModificationStamp, newTimeStamp)
}
class FilteredSectionsLightVirtualFile(val delegate: LightVirtualFile, val sectionIds: Collection<String>) : LightVirtualFile(delegate.name, delegate.fileType, delegate.content, delegate.charset, delegate.modificationStamp) {
override fun getContent(): CharSequence = filterStringBuilderContents(StringBuilder(delegate.content), sectionIds)
override fun contentsToByteArray(): ByteArray = filterByteContents(sectionIds, delegate.contentsToByteArray(), delegate.charset)
}
private fun filterByteContents(sectionIds: Collection<String>, bytes: ByteArray, charset: Charset): ByteArray {
val content = StringBuilder(charset.decode(ByteBuffer.wrap(bytes)))
filterStringBuilderContents(content, sectionIds)
val buffer = charset.encode(CharBuffer.wrap(content))
return if (buffer.limit() == buffer.capacity()) buffer.array()
else {
val res = ByteArray(buffer.limit())
buffer.get(res)
res
}
}
private fun filterStringBuilderContents(content: StringBuilder, sectionIds: Collection<String>): StringBuilder {
var curPos = 0
val sectionsIter = FilteredSectionsTokensRangeIterator(content, sectionIds)
for (range in sectionsIter) {
for (i in curPos..range.start - 1) {
if (content[i] != '\n') {
content.setCharAt(i, ' ')
}
}
curPos = range.end
}
for (i in curPos..content.length - 1) {
if (content[i] != '\n') {
content.setCharAt(i, ' ')
}
}
return content
}
private class TokenRange(val start: Int, val end: Int)
private class FilteredSectionsTokensRangeIterator(script: CharSequence, val sectionIds: Collection<String>) : Iterator<TokenRange> {
private val lexer = KotlinLexer().apply {
start(script)
}
private var currentRange: TokenRange? = advanceToNextFilteredSection()
fun advanceToNextFilteredSection(): TokenRange? {
fun KotlinLexer.skipWhiteSpaceAndComments() {
while (tokenType in KtTokens.WHITE_SPACE_OR_COMMENT_BIT_SET) {
advance()
}
}
var depth = 0
var sectionStartPos = 0
var inside = false
with(lexer) {
loop@ while (tokenType != null) {
if (!inside && depth == 0 && tokenType == KtTokens.IDENTIFIER && tokenText in sectionIds) {
sectionStartPos = currentPosition.offset
advance()
skipWhiteSpaceAndComments()
inside = (tokenType == KtTokens.LBRACE)
}
when (tokenType) {
KtTokens.LBRACE -> depth += 1
KtTokens.RBRACE -> depth -= 1
}
if (inside && depth == 0) {
advance()
break@loop
}
advance()
}
}
return if (lexer.tokenType == null && !inside) null
else TokenRange(sectionStartPos, lexer.currentPosition.offset)
}
override fun hasNext(): Boolean = currentRange != null
override fun next(): TokenRange {
val ret = currentRange
currentRange = advanceToNextFilteredSection()
return ret!!
}
}
@@ -0,0 +1,39 @@
/*
* Copyright 2010-2017 JetBrains s.r.o.
*
* 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 org.jetbrains.kotlin.sourceSections
import com.intellij.openapi.vfs.VirtualFile
import com.intellij.testFramework.LightVirtualFile
import org.jetbrains.kotlin.extensions.PreprocessedVirtualFileFactoryExtension
class FilteredSectionsVirtualFileExtension(val allowedSections: Set<String>?) : PreprocessedVirtualFileFactoryExtension {
override fun isPassThrough(): Boolean = allowedSections == null || allowedSections.isEmpty()
override fun createPreprocessedFile(file: VirtualFile?): VirtualFile? =
when {
file == null || allowedSections == null || allowedSections.isEmpty() -> file
file is LightVirtualFile -> FilteredSectionsLightVirtualFile(file, allowedSections)
else -> FilteredSectionsVirtualFile(file, allowedSections)
}
override fun createPreprocessedLightFile(file: LightVirtualFile?): LightVirtualFile? =
when {
file == null || allowedSections == null || allowedSections.isEmpty() -> file
else -> FilteredSectionsLightVirtualFile(file, allowedSections)
}
}
@@ -0,0 +1,68 @@
/*
* Copyright 2010-2017 JetBrains s.r.o.
*
* 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 org.jetbrains.kotlin.sourceSections
import com.intellij.mock.MockProject
import com.intellij.openapi.project.Project
import org.jetbrains.kotlin.compiler.plugin.CliOption
import org.jetbrains.kotlin.compiler.plugin.CliOptionProcessingException
import org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor
import org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar
import org.jetbrains.kotlin.config.CompilerConfiguration
import org.jetbrains.kotlin.config.CompilerConfigurationKey
import org.jetbrains.kotlin.extensions.PreprocessedVirtualFileFactoryExtension
import org.jetbrains.kotlin.extensions.PreprocessedVirtualFileFactoryExtension.Companion
object SourceSectionsConfigurationKeys {
val SECTIONS_OPTION: CompilerConfigurationKey<List<String>> =
CompilerConfigurationKey.create("allowed section name")
}
class SourceSectionsCommandLineProcessor : CommandLineProcessor {
companion object {
val SECTIONS_OPTION = CliOption("allowedSection", "<name>", "Allowed section name",
required = true, allowMultipleOccurrences = true)
val PLUGIN_ID = "org.jetbrains.kotlin.sourceSections"
}
override val pluginId = PLUGIN_ID
override val pluginOptions = listOf(SECTIONS_OPTION)
override fun processOption(option: CliOption, value: String, configuration: CompilerConfiguration) = when (option) {
SECTIONS_OPTION -> {
val paths = configuration.getList(SourceSectionsConfigurationKeys.SECTIONS_OPTION).toMutableList()
paths.add(value)
configuration.put(SourceSectionsConfigurationKeys.SECTIONS_OPTION, paths)
}
else -> throw CliOptionProcessingException("Unknown option: ${option.name}")
}
}
class SourceSectionsComponentRegistrar : ComponentRegistrar {
override fun registerProjectComponents(project: MockProject, configuration: CompilerConfiguration) {
val sections = configuration.get(SourceSectionsConfigurationKeys.SECTIONS_OPTION) ?: return
registerAllowedSourceSections(project, sections)
}
}
fun registerAllowedSourceSections(project: Project, sections: List<String>) {
if (!sections.isEmpty()) {
PreprocessedVirtualFileFactoryExtension.registerExtension(project, FilteredSectionsVirtualFileExtension(sections.toHashSet()))
}
}