azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor scripting infrastructure - convert usages to the new entities

Browse Source
This commit is contained in:
Ilya Chernikov
2019-07-02 11:58:39 +02:00
parent 80ada5113e
commit 4940f64265
11 changed files with 145 additions and 212 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scripting/scripting-compiler-impl/src/org/jetbrains/kotlin/scripting/definitions/ScriptDefinition.kt
+7 -3
View File
@@ -21,10 +21,11 @@ import kotlin.script.experimental.jvm.jvm
// TODO: name could be confused with KotlinScriptDefinition, discuss naming
abstract class ScriptDefinition : UserDataHolderBase() {
@Deprecated("Use configurations instead")
abstract val legacyDefinition: KotlinScriptDefinition
abstract val hostConfiguration: ScriptingHostConfiguration
abstract val compilationConfiguration: ScriptCompilationConfiguration
abstract val evaluationConfiguration: ScriptEvaluationConfiguration
abstract val evaluationConfiguration: ScriptEvaluationConfiguration?
abstract fun isScript(fileName: String): Boolean
abstract val fileExtension: String
@@ -43,9 +44,11 @@ abstract class ScriptDefinition : UserDataHolderBase() {
abstract val baseClassType: KotlinType
abstract val compilerOptions: Iterable<String>
@Suppress("DEPRECATION")
inline fun <reified T : KotlinScriptDefinition> asLegacyOrNull(): T? =
if (this is FromLegacy) legacyDefinition as? T else null
@Suppress("OverridingDeprecatedMember", "DEPRECATION")
open class FromLegacy(
override val hostConfiguration: ScriptingHostConfiguration,
override val legacyDefinition: KotlinScriptDefinition
@@ -105,6 +108,7 @@ abstract class ScriptDefinition : UserDataHolderBase() {
abstract class FromConfigurationsBase : ScriptDefinition() {
@Suppress("OverridingDeprecatedMember", "DEPRECATION")
override val legacyDefinition by lazy {
KotlinScriptDefinitionAdapterFromNewAPI(
compilationConfiguration,
@@ -136,13 +140,13 @@ abstract class ScriptDefinition : UserDataHolderBase() {
compilationConfiguration == it.compilationConfiguration && evaluationConfiguration == it.evaluationConfiguration
} == true
override fun hashCode(): Int = compilationConfiguration.hashCode() + 37 * evaluationConfiguration.hashCode()
override fun hashCode(): Int = compilationConfiguration.hashCode() + 37 * (evaluationConfiguration?.hashCode() ?: 0)
}
open class FromConfigurations(
override val hostConfiguration: ScriptingHostConfiguration,
override val compilationConfiguration: ScriptCompilationConfiguration,
override val evaluationConfiguration: ScriptEvaluationConfiguration
override val evaluationConfiguration: ScriptEvaluationConfiguration?
) : FromConfigurationsBase()
open class FromTemplate(
plugins/scripting/scripting-compiler-impl/src/org/jetbrains/kotlin/scripting/definitions/definitions.kt
+1 -1
View File
@@ -47,7 +47,7 @@ fun findScriptDefinitionByFileName(project: Project, fileName: String): ScriptDe
return scriptDefinitionProvider.findDefinition(fileName) ?: scriptDefinitionProvider.getDefaultDefinition()
}
private fun VirtualFile.isNonScript(): Boolean =
internal fun VirtualFile.isNonScript(): Boolean =
isDirectory ||
extension == KotlinFileType.EXTENSION ||
extension == JavaClassFileType.INSTANCE.defaultExtension ||
plugins/scripting/scripting-compiler-impl/src/org/jetbrains/kotlin/scripting/definitions/dynamicConfigurations.kt
+42
View File
@@ -0,0 +1,42 @@
/*
* Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.scripting.definitions
import com.intellij.openapi.project.Project
import com.intellij.openapi.vfs.VirtualFile
import com.intellij.psi.PsiFile
import org.jetbrains.kotlin.psi.KtFile
import org.jetbrains.kotlin.scripting.resolve.ScriptCompilationConfigurationResult
import kotlin.script.experimental.api.ScriptCompilationConfiguration
import kotlin.script.experimental.api.valueOr
fun PsiFile.findScriptCompilationConfiguration(): ScriptCompilationConfiguration? {
// Do not use psiFile.script, see comments in findScriptDefinition
if (this !is KtFile/* || this.script == null*/) return null
val file = virtualFile ?: originalFile.virtualFile ?: return null
if (file.isNonScript()) return null
val provider = ScriptDependenciesProvider.getInstance(project)
return provider?.getScriptConfigurationResult(this)?.valueOrError()?.configuration
?: findScriptDefinition()?.compilationConfiguration
}
fun VirtualFile.findScriptCompilationConfiguration(project: Project): ScriptCompilationConfiguration? {
if (!isValid || isNonScript()) return null
// see comments in findScriptDefinition
// we do not need expensive check as in findScriptDefinition here, since it is assumed that this function is called only for known scripts
val provider = ScriptDependenciesProvider.getInstance(project)
return provider?.getScriptConfigurationResult(this)?.valueOrError()?.configuration
?: findScriptDefinition(project)?.compilationConfiguration
}
private fun ScriptCompilationConfigurationResult.valueOrError() = valueOr { failure ->
throw IllegalArgumentException(
"Error retrieving script compilation configuration: ${failure.reports.joinToString { it.message }}",
failure.reports.find { it.exception != null }?.exception
)
}
plugins/scripting/scripting-compiler-impl/src/org/jetbrains/kotlin/scripting/resolve/LazyScriptDescriptor.kt
+38 -17
View File
@@ -36,7 +36,7 @@ import org.jetbrains.kotlin.resolve.source.toSourceElement
import org.jetbrains.kotlin.scripting.definitions.ScriptDefinition
import org.jetbrains.kotlin.scripting.definitions.ScriptDependenciesProvider
import org.jetbrains.kotlin.scripting.definitions.ScriptPriorities
import org.jetbrains.kotlin.scripting.definitions.findScriptDefinitionByFileName
import org.jetbrains.kotlin.scripting.definitions.findScriptCompilationConfiguration
import org.jetbrains.kotlin.types.TypeSubstitutor
import org.jetbrains.kotlin.types.typeUtil.isNothing
import org.jetbrains.kotlin.types.typeUtil.isUnit
@@ -44,7 +44,10 @@ import org.jetbrains.kotlin.utils.addToStdlib.firstIsInstanceOrNull
import java.io.File
import kotlin.reflect.KClass
import kotlin.reflect.KType
import kotlin.script.experimental.api.valueOrNull
import kotlin.script.experimental.api.*
import kotlin.script.experimental.host.GetScriptingClass
import kotlin.script.experimental.host.ScriptingHostConfiguration
import kotlin.script.experimental.host.getScriptingClass
class LazyScriptDescriptor(
@@ -105,14 +108,28 @@ class LazyScriptDescriptor(
override fun getPriority() = priority
// rewrite without using legacyDefinition below
val scriptDefinition: () -> ScriptDefinition = resolveSession.storageManager.createLazyValue {
findScriptDefinitionByFileName(
resolveSession.project,
scriptInfo.script.containingKtFile.name
)
val scriptCompilationConfiguration: () -> ScriptCompilationConfiguration = resolveSession.storageManager.createLazyValue {
scriptInfo.script.containingKtFile.findScriptCompilationConfiguration()
?: throw IllegalArgumentException("Unable to find script compilation configuration for the script ${scriptInfo.script.containingFile}")
}
private val scriptingHostConfiguration: () -> ScriptingHostConfiguration = resolveSession.storageManager.createLazyValue {
scriptCompilationConfiguration()[ScriptCompilationConfiguration.hostConfiguration]
?: throw IllegalArgumentException("Expecting 'hostConfiguration' property in the script compilation configuration for the script ${scriptInfo.script.containingFile}")
}
private val scriptingClassGetter: () -> GetScriptingClass = resolveSession.storageManager.createLazyValue {
scriptingHostConfiguration()[ScriptingHostConfiguration.getScriptingClass]
?: throw IllegalArgumentException("Expecting 'getScriptingClass' property in the scripting host configuration for the script ${scriptInfo.script.containingFile}")
}
fun getScriptingClass(type: KotlinType): KClass<*> =
scriptingClassGetter()(
type,
ScriptDefinition::class, // Assuming that the ScriptDefinition class is loaded in the proper classloader, TODO: consider more reliable way to load or cache classes
scriptingHostConfiguration()
)
override fun substitute(substitutor: TypeSubstitutor) = this
override fun <R, D> accept(visitor: DeclarationDescriptorVisitor<R, D>, data: D): R =
@@ -130,16 +147,20 @@ class LazyScriptDescriptor(
override fun getUnsubstitutedPrimaryConstructor() = super.getUnsubstitutedPrimaryConstructor()!!
internal val baseClassDescriptor: () -> ClassDescriptor? = resolveSession.storageManager.createNullableLazyValue {
val template = scriptDefinition().legacyDefinition.template
val baseClass = getScriptingClass(
scriptCompilationConfiguration()[ScriptCompilationConfiguration.baseClass]
?: throw IllegalStateException("Base class is not configured for the script ${scriptInfo.script.containingFile}")
)
findTypeDescriptor(
template,
if (template.qualifiedName?.startsWith("kotlin.script.templates.standard") == true) Errors.MISSING_SCRIPT_STANDARD_TEMPLATE
baseClass,
if (baseClass.qualifiedName?.startsWith("kotlin.script.templates.standard") == true) Errors.MISSING_SCRIPT_STANDARD_TEMPLATE
else Errors.MISSING_SCRIPT_BASE_CLASS
)
}
override fun computeSupertypes() = listOf(baseClassDescriptor()?.defaultType ?: builtIns.anyType)
// TODO: consider passing ScriptSource to avoid psi file fsearching
private inner class ImportedScriptDescriptorsFinder {
val fileManager = VirtualFileManager.getInstance()
@@ -153,7 +174,7 @@ class LazyScriptDescriptor(
return null
}
val vfile = localFS.findFileByPath(importedScriptFile.path)
val vfile = localFS.findFileByPath(importedScriptFile.absolutePath)
?: return errorDescriptor(MISSING_IMPORTED_SCRIPT_FILE)
val psiFile = psiManager.findFile(vfile)
?: return errorDescriptor(MISSING_IMPORTED_SCRIPT_PSI)
@@ -177,8 +198,8 @@ class LazyScriptDescriptor(
}
}
scriptDefinition().legacyDefinition.implicitReceivers.mapNotNullTo(res) { receiver ->
findTypeDescriptor(receiver, Errors.MISSING_SCRIPT_RECEIVER_CLASS)
scriptCompilationConfiguration()[ScriptCompilationConfiguration.implicitReceivers]?.mapNotNullTo(res) { receiver ->
findTypeDescriptor(getScriptingClass(receiver), Errors.MISSING_SCRIPT_RECEIVER_CLASS)
}
res
@@ -224,10 +245,10 @@ class LazyScriptDescriptor(
private val scriptOuterScope: () -> LexicalScope = resolveSession.storageManager.createLazyValue {
var outerScope = super.getOuterScope()
val outerScopeReceivers = implicitReceivers.let {
if (scriptDefinition().legacyDefinition.providedProperties.isEmpty()) {
it
} else {
if (scriptCompilationConfiguration()[ScriptCompilationConfiguration.providedProperties]?.isNotEmpty() == true) {
it + ScriptProvidedPropertiesDescriptor(this)
} else {
it
}
}
for (receiverClassDescriptor in outerScopeReceivers.asReversed()) {
plugins/scripting/scripting-compiler-impl/src/org/jetbrains/kotlin/scripting/resolve/ScriptProvidedPropertiesDescriptor.kt
+6 -4
View File
@@ -15,6 +15,9 @@ import org.jetbrains.kotlin.resolve.scopes.MemberScope
import org.jetbrains.kotlin.resolve.scopes.MemberScopeImpl
import org.jetbrains.kotlin.storage.LockBasedStorageManager
import org.jetbrains.kotlin.utils.Printer
import kotlin.script.experimental.api.ScriptCompilationConfiguration
import kotlin.script.experimental.api.providedProperties
import kotlin.script.experimental.jvm.util.toValidJvmIdentifier
class ScriptProvidedPropertiesDescriptor(script: LazyScriptDescriptor) :
MutableClassDescriptor(
@@ -42,10 +45,9 @@ class ScriptProvidedPropertiesDescriptor(script: LazyScriptDescriptor) :
override fun getUnsubstitutedMemberScope(): MemberScope = memberScope()
val properties: () -> List<ScriptProvidedPropertyDescriptor> = script.resolveSession.storageManager.createLazyValue {
script.scriptDefinition().legacyDefinition.providedProperties.mapNotNull { (name, type) ->
script.findTypeDescriptor(type, Errors.MISSING_SCRIPT_PROVIDED_PROPERTY_CLASS)?.let {
name to it
}
script.scriptCompilationConfiguration()[ScriptCompilationConfiguration.providedProperties].orEmpty().mapNotNull { (name, type) ->
script.findTypeDescriptor(script.getScriptingClass(type), Errors.MISSING_SCRIPT_PROVIDED_PROPERTY_CLASS)
?.let { name.toValidJvmIdentifier() to it }
}.map { (name, classDescriptor) ->
ScriptProvidedPropertyDescriptor(
Name.identifier(name),
plugins/scripting/scripting-compiler-impl/src/org/jetbrains/kotlin/scripting/resolve/refineCompilationConfiguration.kt
+25 -8
View File
@@ -28,14 +28,11 @@ import kotlin.script.experimental.dependencies.AsyncDependenciesResolver
import kotlin.script.experimental.dependencies.DependenciesResolver
import kotlin.script.experimental.dependencies.ScriptDependencies
import kotlin.script.experimental.host.*
import kotlin.script.experimental.jvm.JvmGetScriptingClass
import kotlin.script.experimental.jvm.*
import kotlin.script.experimental.jvm.compat.mapToDiagnostics
import kotlin.script.experimental.jvm.defaultJvmScriptingHostConfiguration
import kotlin.script.experimental.jvm.impl.refineWith
import kotlin.script.experimental.jvm.impl.toClassPathOrEmpty
import kotlin.script.experimental.jvm.impl.toDependencies
import kotlin.script.experimental.jvm.jdkHome
import kotlin.script.experimental.jvm.jvm
internal fun VirtualFile.loadAnnotations(
acceptedAnnotations: List<KClass<out Annotation>>,
@@ -147,6 +144,7 @@ abstract class ScriptCompilationConfigurationWrapper(val script: SourceCode) {
get() = configuration?.get(ScriptCompilationConfiguration.importScripts)
?.mapNotNull { (it as? FileBasedScriptSource)?.file }.orEmpty()
@Suppress("OverridingDeprecatedMember")
override val legacyDependencies: ScriptDependencies?
get() = configuration?.toDependencies(dependenciesClassPath)
@@ -156,9 +154,11 @@ abstract class ScriptCompilationConfigurationWrapper(val script: SourceCode) {
override fun hashCode(): Int = super.hashCode() + 23 * (configuration?.hashCode() ?: 1)
}
@Suppress("OverridingDeprecatedMember", "DEPRECATION")
class FromLegacy(
script: SourceCode,
override val legacyDependencies: ScriptDependencies?
override val legacyDependencies: ScriptDependencies?,
val definition: ScriptDefinition?
) : ScriptCompilationConfigurationWrapper(script) {
override val dependenciesClassPath: List<File>
@@ -177,8 +177,23 @@ abstract class ScriptCompilationConfigurationWrapper(val script: SourceCode) {
get() = legacyDependencies?.scripts.orEmpty()
override val configuration: ScriptCompilationConfiguration?
get() = legacyDependencies?.let {
TODO("drop or implement")
get() {
val legacy = legacyDependencies ?: return null
return definition?.compilationConfiguration?.let {
ScriptCompilationConfiguration(it) {
updateClasspath(legacy.classpath)
defaultImports.append(legacy.imports)
importScripts.append(legacy.scripts.map { FileScriptSource(it) })
jvm {
jdkHome.putIfNotNull(legacy.javaHome) // TODO: check if it is correct to supply javaHome as jdkHome
}
if (legacy.sources.isNotEmpty()) {
ide {
dependenciesSources.append(JvmDependency(legacy.sources))
}
}
}
}
}
override fun equals(other: Any?): Boolean =
@@ -190,6 +205,7 @@ abstract class ScriptCompilationConfigurationWrapper(val script: SourceCode) {
typealias ScriptCompilationConfigurationResult = ResultWithDiagnostics<ScriptCompilationConfigurationWrapper>
@Suppress("DEPRECATION")
fun refineScriptCompilationConfiguration(
script: SourceCode,
definition: ScriptDefinition,
@@ -240,7 +256,8 @@ fun refineScriptCompilationConfiguration(
else
ScriptCompilationConfigurationWrapper.FromLegacy(
ktFileSource,
result.dependencies?.adjustByDefinition(definition.legacyDefinition)
result.dependencies?.adjustByDefinition(definition.legacyDefinition),
definition
).asSuccess(result.reports.mapToDiagnostics())
}
}