Clean and fix new scripting API

This commit is contained in:
Ilya Chernikov
2018-07-13 19:05:37 +02:00
parent f2a8e5c248
commit a54675abe7
20 changed files with 111 additions and 95 deletions
@@ -210,8 +210,8 @@ fun loadDefinitionsFromTemplates(
template.annotations.firstIsInstanceOrNull<kotlin.script.experimental.annotations.KotlinScript>() != null -> { template.annotations.firstIsInstanceOrNull<kotlin.script.experimental.annotations.KotlinScript>() != null -> {
KotlinScriptDefinitionAdapterFromNewAPI( KotlinScriptDefinitionAdapterFromNewAPI(
ScriptDefinitionFromAnnotatedBaseClass( ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(template),
ScriptingEnvironment( ScriptingEnvironment(
ScriptingEnvironmentProperties.baseClass to KotlinType(template),
ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)), ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)),
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass() ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
) )
@@ -21,19 +21,17 @@ import kotlin.script.experimental.misc.*
fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> { fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> {
val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(), DummyCompiledJvmScriptCache()) val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(), DummyCompiledJvmScriptCache())
val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass( val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(MyScriptWithMavenDeps::class),
ScriptingEnvironment( ScriptingEnvironment(
ScriptingEnvironmentProperties.baseClass<MyScriptWithMavenDeps>(),
ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass()) ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass())
) )
) )
val host = JvmBasicScriptingHost( val host = JvmBasicScriptingHost(scriptCompiler, scriptDefinition.evaluator)
scriptDefinition.compilationConfigurator,
scriptCompiler,
scriptDefinition.evaluator
)
return host.eval(scriptFile.toScriptSource(), ScriptCompileConfiguration(myJvmConfigParams), ScriptEvaluationEnvironment()) return host.eval(
scriptFile.toScriptSource(), scriptDefinition, ScriptCompileConfiguration(myJvmConfigParams), ScriptEvaluationEnvironment()
)
} }
fun main(vararg args: String) { fun main(vararg args: String) {
@@ -25,19 +25,17 @@ val myJvmConfigParams = jvmJavaHomeParams + with(ScriptCompileConfigurationPrope
fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> { fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> {
val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(), DummyCompiledJvmScriptCache()) val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(), DummyCompiledJvmScriptCache())
val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass( val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(MyScript::class),
ScriptingEnvironment( ScriptingEnvironment(
ScriptingEnvironmentProperties.baseClass<MyScript>(),
ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass()) ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass())
) )
) )
val host = JvmBasicScriptingHost( val host = JvmBasicScriptingHost(scriptCompiler, scriptDefinition.evaluator)
scriptDefinition.compilationConfigurator,
scriptCompiler,
scriptDefinition.evaluator
)
return host.eval(scriptFile.toScriptSource(), ScriptCompileConfiguration(myJvmConfigParams), ScriptEvaluationEnvironment()) return host.eval(
scriptFile.toScriptSource(), scriptDefinition, ScriptCompileConfiguration(myJvmConfigParams), ScriptEvaluationEnvironment()
)
} }
fun main(vararg args: String) { fun main(vararg args: String) {
@@ -9,8 +9,8 @@ interface ScriptCompiler {
suspend fun compile( suspend fun compile(
script: ScriptSource, script: ScriptSource,
configurator: ScriptCompilationConfigurator? = null, scriptDefinition: ScriptDefinition,
additionalConfiguration: ScriptCompileConfiguration? = null // overrides parameters from configurator.defaultConfiguration additionalConfiguration: ScriptCompileConfiguration? = null // overrides properties from definition and configurator.defaultConfiguration
): ResultWithDiagnostics<CompiledScript<*>> ): ResultWithDiagnostics<CompiledScript<*>>
} }
@@ -17,7 +17,7 @@ typealias ProcessedScriptData = ChainedPropertyBag
interface ScriptCompilationConfigurator { interface ScriptCompilationConfigurator {
// constructor(environment: ScriptingEnvironment) // the constructor is expected from implementations // constructor(properties: ScriptDefinitionPropertiesBag) // the constructor is expected from implementations
val defaultConfiguration: ScriptCompileConfiguration val defaultConfiguration: ScriptCompileConfiguration
@@ -13,7 +13,7 @@ object ScriptCompileConfigurationProperties {
val sourceFragments by typedKey<List<ScriptSourceNamedFragment>>() val sourceFragments by typedKey<List<ScriptSourceNamedFragment>>()
val baseClass = ScriptingEnvironmentProperties.baseClass val baseClass = ScriptDefinitionProperties.baseClass
val scriptBodyTarget by typedKey<ScriptBodyTarget>() val scriptBodyTarget by typedKey<ScriptBodyTarget>()
@@ -7,6 +7,7 @@
package kotlin.script.experimental.api package kotlin.script.experimental.api
import kotlin.reflect.KClass
import kotlin.script.experimental.util.ChainedPropertyBag import kotlin.script.experimental.util.ChainedPropertyBag
import kotlin.script.experimental.util.typedKey import kotlin.script.experimental.util.typedKey
@@ -18,7 +19,7 @@ interface ScriptDefinition {
val properties: ScriptDefinitionPropertiesBag val properties: ScriptDefinitionPropertiesBag
val compilationConfigurator: ScriptCompilationConfigurator val compilationConfigurator: ScriptCompilationConfigurator?
val evaluator: ScriptEvaluator<*>? val evaluator: ScriptEvaluator<*>?
} }
@@ -28,4 +29,12 @@ object ScriptDefinitionProperties {
val name by typedKey<String>() // Name of the script type, by default "Kotlin script" val name by typedKey<String>() // Name of the script type, by default "Kotlin script"
val fileExtension by typedKey<String>() // default: "kts" val fileExtension by typedKey<String>() // default: "kts"
}
val baseClass by typedKey<KotlinType>() // script base class
}
fun ScriptDefinitionPropertiesBag.getScriptBaseClass(contextClass: KClass<*>): KClass<*> =
getScriptingClass(get(ScriptDefinitionProperties.baseClass), contextClass)
fun ScriptDefinitionPropertiesBag.getScriptBaseClass(context: Any): KClass<*> =
getScriptingClass(get(ScriptDefinitionProperties.baseClass), context::class)
@@ -27,7 +27,7 @@ data class EvaluationResult(val returnValue: Any?, val environment: ScriptEvalua
// NOTE: name inconsistency: run vs evaluate // NOTE: name inconsistency: run vs evaluate
interface ScriptEvaluator<in ScriptBase : Any> { interface ScriptEvaluator<in ScriptBase : Any> {
// constructor(environment: ScriptingEnvironment) // the constructor is expected from implementations // constructor(properties: ScriptDefinitionPropertiesBag) // the constructor is expected from implementations
suspend fun eval( suspend fun eval(
compiledScript: CompiledScript<ScriptBase>, compiledScript: CompiledScript<ScriptBase>,
@@ -13,9 +13,6 @@ typealias ScriptingEnvironment = ChainedPropertyBag
object ScriptingEnvironmentProperties { object ScriptingEnvironmentProperties {
// required by definitions that extract data from script base class annotations
val baseClass by typedKey<KotlinType>()
// should contain all dependencies needed for baseClass and compilationConfigurator // should contain all dependencies needed for baseClass and compilationConfigurator
val configurationDependencies by typedKey<List<ScriptDependency>>() val configurationDependencies by typedKey<List<ScriptDependency>>()
@@ -40,8 +37,3 @@ fun ScriptingEnvironment.getScriptingClass(type: KotlinType, contextClass: KClas
fun ScriptingEnvironment.getScriptingClass(type: KotlinType, context: Any): KClass<*> = getScriptingClass(type, context::class) fun ScriptingEnvironment.getScriptingClass(type: KotlinType, context: Any): KClass<*> = getScriptingClass(type, context::class)
fun ScriptingEnvironment.getScriptBaseClass(contextClass: KClass<*>): KClass<*> =
getScriptingClass(get(ScriptingEnvironmentProperties.baseClass), contextClass)
fun ScriptingEnvironment.getScriptBaseClass(context: Any): KClass<*> =
getScriptingClass(get(ScriptingEnvironmentProperties.baseClass), context::class)
@@ -13,10 +13,10 @@ import kotlin.script.experimental.util.TypedKey
private const val ILLEGAL_CONFIG_ANN_ARG = private const val ILLEGAL_CONFIG_ANN_ARG =
"Illegal argument to KotlinScriptDefaultCompilationConfiguration annotation: expecting List-derived object or default-constructed class of configuration parameters" "Illegal argument to KotlinScriptDefaultCompilationConfiguration annotation: expecting List-derived object or default-constructed class of configuration parameters"
open class AnnotationsBasedCompilationConfigurator(val environment: ScriptingEnvironment) : ScriptCompilationConfigurator { open class AnnotationsBasedCompilationConfigurator(val properties: ScriptDefinitionPropertiesBag) : ScriptCompilationConfigurator {
override val defaultConfiguration by lazy(LazyThreadSafetyMode.PUBLICATION) { override val defaultConfiguration by lazy(LazyThreadSafetyMode.PUBLICATION) {
val baseClass = environment.getScriptBaseClass(this) val baseClass = properties.getScriptBaseClass(this)
val cfg = baseClass.annotations.filterIsInstance(KotlinScriptDefaultCompilationConfiguration::class.java).flatMap { ann -> val cfg = baseClass.annotations.filterIsInstance(KotlinScriptDefaultCompilationConfiguration::class.java).flatMap { ann ->
val params = try { val params = try {
ann.compilationConfiguration.objectInstance ?: ann.compilationConfiguration.createInstance() ann.compilationConfiguration.objectInstance ?: ann.compilationConfiguration.createInstance()
@@ -29,7 +29,7 @@ open class AnnotationsBasedCompilationConfigurator(val environment: ScriptingEnv
} }
params as List<Pair<TypedKey<*>, Any?>> params as List<Pair<TypedKey<*>, Any?>>
} }
ScriptCompileConfiguration(environment, cfg) ScriptCompileConfiguration(properties, cfg)
} }
} }
@@ -13,52 +13,52 @@ import kotlin.script.experimental.api.*
import kotlin.script.experimental.basic.AnnotationsBasedCompilationConfigurator import kotlin.script.experimental.basic.AnnotationsBasedCompilationConfigurator
import kotlin.script.experimental.basic.DummyEvaluator import kotlin.script.experimental.basic.DummyEvaluator
import kotlin.script.experimental.util.TypedKey import kotlin.script.experimental.util.TypedKey
import kotlin.script.experimental.util.chainPropertyBags
private const val ERROR_MSG_PREFIX = "Unable to construct script definition: " private const val ERROR_MSG_PREFIX = "Unable to construct script definition: "
open class ScriptDefinitionFromAnnotatedBaseClass(val environment: ScriptingEnvironment) : ScriptDefinition { open class ScriptDefinitionFromAnnotatedBaseClass(
protected val baseClassType: KotlinType,
val environment: ScriptingEnvironment
) : ScriptDefinition {
private val getScriptingClass = environment.getOrNull(ScriptingEnvironmentProperties.getScriptingClass) private val getScriptingClass = environment.getOrNull(ScriptingEnvironmentProperties.getScriptingClass)
?: throw IllegalArgumentException("${ERROR_MSG_PREFIX}Expecting 'getScriptingClass' parameter in the scripting environment") ?: throw IllegalArgumentException("${ERROR_MSG_PREFIX}Expecting 'getScriptingClass' parameter in the scripting environment")
private val baseClass: KClass<*> = run { private val baseClass: KClass<*> =
val baseClassType = environment.getOrNull(ScriptingEnvironmentProperties.baseClass)
?: throw IllegalArgumentException("${ERROR_MSG_PREFIX}Expecting 'baseClass' parameter in the scripting environment")
try { try {
getScriptingClass(baseClassType, this::class, environment) getScriptingClass(baseClassType, this::class, environment)
} catch (e: Throwable) { } catch (e: Throwable) {
throw IllegalArgumentException("${ERROR_MSG_PREFIX}Unable to load base class $baseClassType", e) throw IllegalArgumentException("${ERROR_MSG_PREFIX}Unable to load base class $baseClassType", e)
} }
}
private val mainAnnotation = baseClass.findAnnotation<KotlinScript>() private val mainAnnotation = baseClass.findAnnotation<KotlinScript>()
?: throw IllegalArgumentException("${ERROR_MSG_PREFIX}Expecting KotlinScript annotation on the $baseClass") ?: throw IllegalArgumentException("${ERROR_MSG_PREFIX}Expecting KotlinScript annotation on the $baseClass")
private val explicitDefinition: ScriptDefinition? = private val explicitDefinition: ScriptDefinition? =
baseClass.findAnnotation<KotlinScriptDefinition>()?.definition.takeIf { it != this::class }?.let { it.instantiateScriptHandler() } baseClass.findAnnotation<KotlinScriptDefinition>()?.definition.takeIf { it != this::class }?.let { it.instantiateScriptHandler() }
override val properties = run { override val properties = run {
val baseProperties = explicitDefinition?.properties ?: environment val baseProperties = chainPropertyBags(explicitDefinition?.properties, environment)
val toAdd = arrayListOf<Pair<TypedKey<*>, Any>>() val propertiesData = arrayListOf<Pair<TypedKey<*>, Any>>(ScriptDefinitionProperties.baseClass to baseClassType)
baseClass.findAnnotation<KotlinScriptFileExtension>()?.let { baseClass.findAnnotation<KotlinScriptFileExtension>()?.let {
toAdd += ScriptDefinitionProperties.fileExtension to it.extension propertiesData += ScriptDefinitionProperties.fileExtension to it.extension
} }
if (baseProperties.getOrNull(ScriptDefinitionProperties.name) == null) { if (baseProperties.getOrNull(ScriptDefinitionProperties.name) == null) {
toAdd += ScriptDefinitionProperties.name to mainAnnotation.name propertiesData += ScriptDefinitionProperties.name to mainAnnotation.name
} }
if (toAdd.isEmpty()) baseProperties ScriptingEnvironment(baseProperties, propertiesData)
else ScriptingEnvironment(baseProperties, toAdd)
} }
override val compilationConfigurator = override val compilationConfigurator =
baseClass.findAnnotation<KotlinScriptCompilationConfigurator>()?.compilationConfigurator?.instantiateScriptHandler() baseClass.findAnnotation<KotlinScriptCompilationConfigurator>()?.compilationConfigurator?.instantiateScriptHandler()
?: explicitDefinition?.compilationConfigurator ?: explicitDefinition?.compilationConfigurator
?: AnnotationsBasedCompilationConfigurator::class.instantiateScriptHandler() ?: AnnotationsBasedCompilationConfigurator::class.instantiateScriptHandler()
override val evaluator = override val evaluator =
baseClass.findAnnotation<KotlinScriptEvaluator>()?.evaluator?.instantiateScriptHandler() baseClass.findAnnotation<KotlinScriptEvaluator>()?.evaluator?.instantiateScriptHandler()
?: explicitDefinition?.evaluator ?: explicitDefinition?.evaluator
?: DummyEvaluator::class.instantiateScriptHandler() ?: DummyEvaluator::class.instantiateScriptHandler()
private fun <T : Any> KClass<T>.instantiateScriptHandler(): T { private fun <T : Any> KClass<T>.instantiateScriptHandler(): T {
val klass: KClass<T> = try { val klass: KClass<T> = try {
@@ -68,7 +68,7 @@ open class ScriptDefinitionFromAnnotatedBaseClass(val environment: ScriptingEnvi
} }
try { try {
// TODO: fix call after deciding on constructor parameters // TODO: fix call after deciding on constructor parameters
return klass.objectInstance ?: klass.primaryConstructor!!.call(environment) return klass.objectInstance ?: klass.primaryConstructor!!.call(properties)
} catch (e: Throwable) { } catch (e: Throwable) {
throw IllegalArgumentException("${ERROR_MSG_PREFIX}Unable to instantiate handler $this: $e", e) throw IllegalArgumentException("${ERROR_MSG_PREFIX}Unable to instantiate handler $this: $e", e)
} }
@@ -23,19 +23,20 @@ import kotlinx.coroutines.experimental.runBlocking
import kotlin.script.experimental.api.* import kotlin.script.experimental.api.*
abstract class BasicScriptingHost<ScriptBase : Any>( abstract class BasicScriptingHost<ScriptBase : Any>(
val configurator: ScriptCompilationConfigurator,
val compiler: ScriptCompiler, val compiler: ScriptCompiler,
// TODO: does it belong here or to the definition?
val evaluator: ScriptEvaluator<ScriptBase> val evaluator: ScriptEvaluator<ScriptBase>
) { ) {
open fun <T> runInCoroutineContext(block: suspend CoroutineScope.() -> T): T = runBlocking { block() } open fun <T> runInCoroutineContext(block: suspend CoroutineScope.() -> T): T = runBlocking { block() }
open fun eval( open fun eval(
script: ScriptSource, script: ScriptSource,
scriptDefinition: ScriptDefinition,
compileConfiguration: ScriptCompileConfiguration, compileConfiguration: ScriptCompileConfiguration,
environment: ScriptEvaluationEnvironment environment: ScriptEvaluationEnvironment
): ResultWithDiagnostics<EvaluationResult> = ): ResultWithDiagnostics<EvaluationResult> =
runInCoroutineContext { runInCoroutineContext {
val compiled = compiler.compile(script, configurator, compileConfiguration) val compiled = compiler.compile(script, scriptDefinition, compileConfiguration)
when (compiled) { when (compiled) {
is ResultWithDiagnostics.Failure -> compiled is ResultWithDiagnostics.Failure -> compiled
is ResultWithDiagnostics.Success -> { is ResultWithDiagnostics.Success -> {
@@ -27,8 +27,8 @@ open class ChainedPropertyBag private constructor(private val parent: ChainedPro
fun cloneWithNewParent(newParent: ChainedPropertyBag?): ChainedPropertyBag = when { fun cloneWithNewParent(newParent: ChainedPropertyBag?): ChainedPropertyBag = when {
newParent == null -> this newParent == null -> this
parent == null -> ChainedPropertyBag(newParent, data) parent == null -> createOptimized(newParent, data)
else -> ChainedPropertyBag(parent.cloneWithNewParent(newParent), data) else -> createOptimized(parent.cloneWithNewParent(newParent), data)
} }
inline operator fun <reified T> get(key: TypedKey<T>): T = getRaw(key) as T inline operator fun <reified T> get(key: TypedKey<T>): T = getRaw(key) as T
@@ -38,4 +38,16 @@ open class ChainedPropertyBag private constructor(private val parent: ChainedPro
inline fun <reified T> getOrNull(key: TypedKey<T>): T? = getOrNullRaw(key)?.let { it as T } inline fun <reified T> getOrNull(key: TypedKey<T>): T? = getOrNullRaw(key)?.let { it as T }
fun <T> getOrNullRaw(key: TypedKey<T>): Any? = data[key] ?: parent?.getOrNullRaw(key) ?: key.defaultValue fun <T> getOrNullRaw(key: TypedKey<T>): Any? = data[key] ?: parent?.getOrNullRaw(key) ?: key.defaultValue
companion object {
fun createOptimized(parent: ChainedPropertyBag?, data: Map<TypedKey<*>, Any?>): ChainedPropertyBag = when {
parent != null && data.isEmpty() -> parent
else -> ChainedPropertyBag(parent, data)
}
}
} }
fun chainPropertyBags(propertyBags: Iterable<ChainedPropertyBag?>): ChainedPropertyBag =
propertyBags.fold(ChainedPropertyBag()) { res, next -> if (next == null) res else res.cloneWithNewParent(next) }
fun chainPropertyBags(vararg propertyBags: ChainedPropertyBag?): ChainedPropertyBag = chainPropertyBags(propertyBags.asIterable())
@@ -44,6 +44,7 @@ import kotlin.script.experimental.jvm.JvmScriptCompileConfigurationProperties
import kotlin.script.experimental.jvm.JvmScriptEvaluationEnvironmentProperties import kotlin.script.experimental.jvm.JvmScriptEvaluationEnvironmentProperties
import kotlin.script.experimental.jvm.KJVMCompilerProxy import kotlin.script.experimental.jvm.KJVMCompilerProxy
import kotlin.script.experimental.jvm.impl.BridgeDependenciesResolver import kotlin.script.experimental.jvm.impl.BridgeDependenciesResolver
import kotlin.script.experimental.util.chainPropertyBags
class KJVMCompiledScript<out ScriptBase : Any>( class KJVMCompiledScript<out ScriptBase : Any>(
override val configuration: ScriptCompileConfiguration, override val configuration: ScriptCompileConfiguration,
@@ -63,7 +64,7 @@ class KJVMCompiledScript<out ScriptBase : Any>(
val clazz = classLoader.loadClass(scriptClassFQName) val clazz = classLoader.loadClass(scriptClassFQName)
(clazz as? ScriptBase)?.asSuccess() (clazz as? ScriptBase)?.asSuccess()
?: ResultWithDiagnostics.Failure("Compiled class expected to be a subclass of the <ScriptBase>, but got ${clazz.javaClass.name}".asErrorDiagnostics()) ?: ResultWithDiagnostics.Failure("Compiled class expected to be a subclass of the <ScriptBase>, but got ${clazz.javaClass.name}".asErrorDiagnostics())
} catch (e: Throwable) { } catch (e: Throwable) {
ResultWithDiagnostics.Failure(ScriptDiagnostic("Unable to instantiate class $scriptClassFQName", exception = e)) ResultWithDiagnostics.Failure(ScriptDiagnostic("Unable to instantiate class $scriptClassFQName", exception = e))
} }
@@ -73,7 +74,7 @@ class KJVMCompilerImpl : KJVMCompilerProxy {
override fun compile( override fun compile(
script: ScriptSource, script: ScriptSource,
configurator: ScriptCompilationConfigurator?, scriptDefinition: ScriptDefinition,
additionalConfiguration: ScriptCompileConfiguration additionalConfiguration: ScriptCompileConfiguration
): ResultWithDiagnostics<CompiledScript<*>> { ): ResultWithDiagnostics<CompiledScript<*>> {
val messageCollector = ScriptDiagnosticsMessageCollector() val messageCollector = ScriptDiagnosticsMessageCollector()
@@ -84,8 +85,11 @@ class KJVMCompilerImpl : KJVMCompilerProxy {
try { try {
setIdeaIoUseFallback() setIdeaIoUseFallback()
val scriptCompileConfiguration = configurator?.defaultConfiguration?.let { additionalConfiguration.cloneWithNewParent(it) } val scriptCompileConfiguration = chainPropertyBags(
?: additionalConfiguration additionalConfiguration,
scriptDefinition.compilationConfigurator?.defaultConfiguration,
scriptDefinition.properties
)
var environment: KotlinCoreEnvironment? = null var environment: KotlinCoreEnvironment? = null
var updatedScriptCompileConfiguration = scriptCompileConfiguration var updatedScriptCompileConfiguration = scriptCompileConfiguration
@@ -104,7 +108,7 @@ class KJVMCompilerImpl : KJVMCompilerProxy {
val kotlinCompilerConfiguration = org.jetbrains.kotlin.config.CompilerConfiguration().apply { val kotlinCompilerConfiguration = org.jetbrains.kotlin.config.CompilerConfiguration().apply {
add( add(
JVMConfigurationKeys.SCRIPT_DEFINITIONS, JVMConfigurationKeys.SCRIPT_DEFINITIONS,
BridgeScriptDefinition(scriptCompileConfiguration, configurator, ::updateClasspath) BridgeScriptDefinition(scriptDefinition, scriptCompileConfiguration, ::updateClasspath)
) )
put<MessageCollector>(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, messageCollector) put<MessageCollector>(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, messageCollector)
put(JVMConfigurationKeys.RETAIN_OUTPUT_IN_MEMORY, true) put(JVMConfigurationKeys.RETAIN_OUTPUT_IN_MEMORY, true)
@@ -157,7 +161,7 @@ class KJVMCompilerImpl : KJVMCompilerProxy {
charset = CharsetToolkit.UTF8_CHARSET charset = CharsetToolkit.UTF8_CHARSET
} }
val psiFile: KtFile = psiFileFactory.trySetupPsiForFile(virtualFile, KotlinLanguage.INSTANCE, true, false) as KtFile? val psiFile: KtFile = psiFileFactory.trySetupPsiForFile(virtualFile, KotlinLanguage.INSTANCE, true, false) as KtFile?
?: return failure("Unable to make PSI file from script".asErrorDiagnostics()) ?: return failure("Unable to make PSI file from script".asErrorDiagnostics())
val sourceFiles = listOf(psiFile) val sourceFiles = listOf(psiFile)
@@ -237,18 +241,18 @@ class ScriptDiagnosticsMessageCollector : MessageCollector {
// A bridge to the current scripting // A bridge to the current scripting
internal class BridgeScriptDefinition( internal class BridgeScriptDefinition(
scriptCompilerConfiguration: ScriptCompileConfiguration, scriptDefinition: ScriptDefinition,
scriptConfigurator: ScriptCompilationConfigurator?, calculatedBcriptCompilerConfiguration: ScriptCompileConfiguration,
updateClasspath: (List<File>) -> Unit updateClasspath: (List<File>) -> Unit
) : KotlinScriptDefinition(scriptCompilerConfiguration.getScriptBaseClass(BridgeScriptDefinition::class)) { ) : KotlinScriptDefinition(calculatedBcriptCompilerConfiguration.getScriptBaseClass(BridgeScriptDefinition::class)) {
override val acceptedAnnotations = run { override val acceptedAnnotations = run {
val cl = this::class.java.classLoader val cl = this::class.java.classLoader
scriptCompilerConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineConfigurationOnAnnotations) calculatedBcriptCompilerConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineConfigurationOnAnnotations)
?.map { (cl.loadClass(it.typeName) as Class<out Annotation>).kotlin } ?.map { (cl.loadClass(it.typeName) as Class<out Annotation>).kotlin }
?: emptyList() ?: emptyList()
} }
override val dependencyResolver: DependenciesResolver = override val dependencyResolver: DependenciesResolver =
BridgeDependenciesResolver(scriptConfigurator, scriptCompilerConfiguration, updateClasspath) BridgeDependenciesResolver(scriptDefinition, calculatedBcriptCompilerConfiguration, updateClasspath)
} }
@@ -16,13 +16,12 @@ import kotlin.script.experimental.dependencies.ScriptDependencies
import kotlin.script.experimental.dependencies.ScriptReport import kotlin.script.experimental.dependencies.ScriptReport
import kotlin.script.experimental.host.toScriptSource import kotlin.script.experimental.host.toScriptSource
import kotlin.script.experimental.jvm.JvmDependency import kotlin.script.experimental.jvm.JvmDependency
import kotlin.script.experimental.jvm.defaultConfiguration
import kotlin.script.experimental.jvm.mapToLegacyScriptReportPosition import kotlin.script.experimental.jvm.mapToLegacyScriptReportPosition
import kotlin.script.experimental.jvm.mapToLegacyScriptReportSeverity import kotlin.script.experimental.jvm.mapToLegacyScriptReportSeverity
class BridgeDependenciesResolver( class BridgeDependenciesResolver(
val scriptConfigurator: ScriptCompilationConfigurator?, val scriptDefinition: ScriptDefinition,
val baseScriptCompilerConfiguration: ScriptCompileConfiguration = scriptConfigurator.defaultConfiguration, val calculatedBaseScriptCompilerConfiguration: ScriptCompileConfiguration,
val onClasspathUpdated: (List<File>) -> Unit = {} val onClasspathUpdated: (List<File>) -> Unit = {}
) : AsyncDependenciesResolver { ) : AsyncDependenciesResolver {
@@ -38,10 +37,10 @@ class BridgeDependenciesResolver(
val processedScriptData = val processedScriptData =
ProcessedScriptData(ProcessedScriptDataProperties.foundAnnotations to scriptContents.annotations) ProcessedScriptData(ProcessedScriptDataProperties.foundAnnotations to scriptContents.annotations)
val refinedConfiguration = scriptConfigurator?.let { val refinedConfiguration = scriptDefinition.compilationConfigurator?.let { scriptConfigurator ->
val res = scriptConfigurator.refineConfiguration( val res = scriptConfigurator.refineConfiguration(
scriptContents.toScriptSource(), scriptContents.toScriptSource(),
baseScriptCompilerConfiguration, calculatedBaseScriptCompilerConfiguration,
processedScriptData processedScriptData
) )
when (res) { when (res) {
@@ -52,12 +51,12 @@ class BridgeDependenciesResolver(
res.value res.value
} }
} }
} ?: baseScriptCompilerConfiguration } ?: calculatedBaseScriptCompilerConfiguration
val newClasspath = refinedConfiguration.getOrNull(ScriptCompileConfigurationProperties.dependencies) val newClasspath = refinedConfiguration.getOrNull(ScriptCompileConfigurationProperties.dependencies)
?.flatMap { (it as JvmDependency).classpath } ?: emptyList() ?.flatMap { (it as JvmDependency).classpath } ?: emptyList()
if (refinedConfiguration != baseScriptCompilerConfiguration) { if (refinedConfiguration != calculatedBaseScriptCompilerConfiguration) {
val oldClasspath = baseScriptCompilerConfiguration.getOrNull(ScriptCompileConfigurationProperties.dependencies) val oldClasspath = calculatedBaseScriptCompilerConfiguration.getOrNull(ScriptCompileConfigurationProperties.dependencies)
?.flatMap { (it as JvmDependency).classpath } ?: emptyList() ?.flatMap { (it as JvmDependency).classpath } ?: emptyList()
if (newClasspath != oldClasspath) { if (newClasspath != oldClasspath) {
onClasspathUpdated(newClasspath) onClasspathUpdated(newClasspath)
@@ -16,18 +16,18 @@ open class JvmScriptCompiler(
override suspend fun compile( override suspend fun compile(
script: ScriptSource, script: ScriptSource,
configurator: ScriptCompilationConfigurator?, scriptDefinition: ScriptDefinition,
additionalConfiguration: ScriptCompileConfiguration? additionalConfiguration: ScriptCompileConfiguration?
): ResultWithDiagnostics<CompiledScript<*>> { ): ResultWithDiagnostics<CompiledScript<*>> {
val baseConfiguration = additionalConfiguration?.cloneWithNewParent(configurator?.defaultConfiguration) val baseConfiguration = additionalConfiguration?.cloneWithNewParent(scriptDefinition.compilationConfigurator?.defaultConfiguration)
?: configurator?.defaultConfiguration ?: scriptDefinition.compilationConfigurator?.defaultConfiguration
?: ScriptCompileConfiguration() ?: ScriptCompileConfiguration()
val refinedConfiguration = val refinedConfiguration =
if (baseConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineBeforeParsing) == true) { if (baseConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineBeforeParsing) == true) {
if (configurator == null) { if (scriptDefinition.compilationConfigurator == null) {
return ResultWithDiagnostics.Failure("Non-null configurator expected".asErrorDiagnostics()) return ResultWithDiagnostics.Failure("Non-null configurator expected".asErrorDiagnostics())
} }
configurator.refineConfiguration(script, baseConfiguration).let { scriptDefinition.compilationConfigurator!!.refineConfiguration(script, baseConfiguration).let {
when (it) { when (it) {
is ResultWithDiagnostics.Failure -> return it is ResultWithDiagnostics.Failure -> return it
is ResultWithDiagnostics.Success -> it.value is ResultWithDiagnostics.Success -> it.value
@@ -40,7 +40,7 @@ open class JvmScriptCompiler(
if (cached != null) return cached.asSuccess() if (cached != null) return cached.asSuccess()
return compilerProxy.compile(script, configurator, refinedConfiguration).also { return compilerProxy.compile(script, scriptDefinition, refinedConfiguration).also {
if (it is ResultWithDiagnostics.Success) { if (it is ResultWithDiagnostics.Success) {
cache.store(it.value, refinedConfiguration) cache.store(it.value, refinedConfiguration)
} }
@@ -56,7 +56,7 @@ interface CompiledJvmScriptsCache {
interface KJVMCompilerProxy { interface KJVMCompilerProxy {
fun compile( fun compile(
script: ScriptSource, script: ScriptSource,
configurator: ScriptCompilationConfigurator?, scriptDefinition: ScriptDefinition,
additionalConfiguration: ScriptCompileConfiguration additionalConfiguration: ScriptCompileConfiguration
): ResultWithDiagnostics<CompiledScript<*>> ): ResultWithDiagnostics<CompiledScript<*>>
} }
@@ -7,16 +7,14 @@
package kotlin.script.experimental.jvm package kotlin.script.experimental.jvm
import kotlin.script.experimental.api.ScriptCompilationConfigurator
import kotlin.script.experimental.api.ScriptEvaluator import kotlin.script.experimental.api.ScriptEvaluator
import kotlin.script.experimental.host.BasicScriptingHost import kotlin.script.experimental.host.BasicScriptingHost
import kotlin.script.experimental.util.typedKey import kotlin.script.experimental.util.typedKey
open class JvmBasicScriptingHost<ScriptBase : Any>( open class JvmBasicScriptingHost<ScriptBase : Any>(
configurationExtractor: ScriptCompilationConfigurator,
compiler: JvmScriptCompiler, compiler: JvmScriptCompiler,
evaluator: ScriptEvaluator<ScriptBase> evaluator: ScriptEvaluator<ScriptBase>
) : BasicScriptingHost<ScriptBase>(configurationExtractor, compiler, evaluator) ) : BasicScriptingHost<ScriptBase>(compiler, evaluator)
object JvmScriptEvaluationEnvironmentProperties { object JvmScriptEvaluationEnvironmentProperties {
val baseClassLoader by typedKey<ClassLoader?>() val baseClassLoader by typedKey<ClassLoader?>()
@@ -18,6 +18,7 @@ import kotlin.script.experimental.api.*
import kotlin.script.experimental.dependencies.DependenciesResolver import kotlin.script.experimental.dependencies.DependenciesResolver
import kotlin.script.experimental.jvm.impl.BridgeDependenciesResolver import kotlin.script.experimental.jvm.impl.BridgeDependenciesResolver
import kotlin.script.experimental.location.ScriptExpectedLocation import kotlin.script.experimental.location.ScriptExpectedLocation
import kotlin.script.experimental.util.chainPropertyBags
// temporary trick with passing Any as a template and overwriting it below, TODO: fix after introducing new script definitions hierarchy // temporary trick with passing Any as a template and overwriting it below, TODO: fix after introducing new script definitions hierarchy
abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinition(Any::class) { abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinition(Any::class) {
@@ -26,8 +27,12 @@ abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinit
abstract val scriptFileExtensionWithDot: String abstract val scriptFileExtensionWithDot: String
protected val baseCompilationConfiguration by lazy(LazyThreadSafetyMode.PUBLICATION) {
chainPropertyBags(scriptDefinition.compilationConfigurator?.defaultConfiguration, scriptDefinition.properties)
}
open val baseClass: KClass<*> by lazy(LazyThreadSafetyMode.PUBLICATION) { open val baseClass: KClass<*> by lazy(LazyThreadSafetyMode.PUBLICATION) {
getScriptingClass(scriptDefinition.compilationConfigurator.defaultConfiguration[ScriptingEnvironmentProperties.baseClass]) getScriptingClass(baseCompilationConfiguration[ScriptDefinitionProperties.baseClass])
} }
override val template: KClass<*> get() = baseClass override val template: KClass<*> get() = baseClass
@@ -49,28 +54,28 @@ abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinit
get() = emptyList() get() = emptyList()
override val dependencyResolver: DependenciesResolver by lazy(LazyThreadSafetyMode.PUBLICATION) { override val dependencyResolver: DependenciesResolver by lazy(LazyThreadSafetyMode.PUBLICATION) {
BridgeDependenciesResolver(scriptDefinition.compilationConfigurator) BridgeDependenciesResolver(scriptDefinition, baseCompilationConfiguration)
} }
override val acceptedAnnotations: List<KClass<out Annotation>> by lazy(LazyThreadSafetyMode.PUBLICATION) { override val acceptedAnnotations: List<KClass<out Annotation>> by lazy(LazyThreadSafetyMode.PUBLICATION) {
scriptDefinition.compilationConfigurator.defaultConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineConfigurationOnAnnotations) baseCompilationConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineConfigurationOnAnnotations)
.orEmpty() .orEmpty()
.map { getScriptingClass(it) as KClass<out Annotation> } .map { getScriptingClass(it) as KClass<out Annotation> }
} }
override val implicitReceivers: List<KType> by lazy(LazyThreadSafetyMode.PUBLICATION) { override val implicitReceivers: List<KType> by lazy(LazyThreadSafetyMode.PUBLICATION) {
scriptDefinition.compilationConfigurator.defaultConfiguration.getOrNull(ScriptCompileConfigurationProperties.scriptImplicitReceivers) baseCompilationConfiguration.getOrNull(ScriptCompileConfigurationProperties.scriptImplicitReceivers)
.orEmpty() .orEmpty()
.map { getScriptingClass(it).starProjectedType } .map { getScriptingClass(it).starProjectedType }
} }
override val environmentVariables: List<Pair<String, KType>> by lazy(LazyThreadSafetyMode.PUBLICATION) { override val environmentVariables: List<Pair<String, KType>> by lazy(LazyThreadSafetyMode.PUBLICATION) {
scriptDefinition.compilationConfigurator.defaultConfiguration.getOrNull(ScriptCompileConfigurationProperties.contextVariables) baseCompilationConfiguration.getOrNull(ScriptCompileConfigurationProperties.contextVariables)
?.map { (k, v) -> k to getScriptingClass(v).starProjectedType }.orEmpty() ?.map { (k, v) -> k to getScriptingClass(v).starProjectedType }.orEmpty()
} }
override val additionalCompilerArguments: List<String> override val additionalCompilerArguments: List<String>
get() = scriptDefinition.compilationConfigurator.defaultConfiguration.getOrNull(ScriptCompileConfigurationProperties.compilerOptions) get() = baseCompilationConfiguration.getOrNull(ScriptCompileConfigurationProperties.compilerOptions)
.orEmpty() .orEmpty()
override val scriptExpectedLocations: List<ScriptExpectedLocation> = override val scriptExpectedLocations: List<ScriptExpectedLocation> =
@@ -80,11 +85,11 @@ abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinit
) )
override val targetClassAnnotations: List<Annotation> override val targetClassAnnotations: List<Annotation>
get() = scriptDefinition.compilationConfigurator.defaultConfiguration.getOrNull(ScriptCompileConfigurationProperties.generatedClassAnnotations) get() = baseCompilationConfiguration.getOrNull(ScriptCompileConfigurationProperties.generatedClassAnnotations)
.orEmpty() .orEmpty()
override val targetMethodAnnotations: List<Annotation> override val targetMethodAnnotations: List<Annotation>
get() = scriptDefinition.compilationConfigurator.defaultConfiguration.getOrNull(ScriptCompileConfigurationProperties.generatedMethodAnnotations) get() = baseCompilationConfiguration.getOrNull(ScriptCompileConfigurationProperties.generatedMethodAnnotations)
.orEmpty() .orEmpty()
private val scriptingClassGetter by lazy(LazyThreadSafetyMode.PUBLICATION) { private val scriptingClassGetter by lazy(LazyThreadSafetyMode.PUBLICATION) {
@@ -41,8 +41,8 @@ class LazyScriptDefinitionFromDiscoveredClass internal constructor(
) )
try { try {
ScriptDefinitionFromAnnotatedBaseClass( ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(className),
ScriptingEnvironment( ScriptingEnvironment(
ScriptingEnvironmentProperties.baseClass to KotlinType(className),
ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)), ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)),
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass() ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
) )
@@ -276,8 +276,8 @@ private fun loadScriptDefinition(
if (cls.annotations.firstIsInstanceOrNull<KotlinScript>() != null) { if (cls.annotations.firstIsInstanceOrNull<KotlinScript>() != null) {
KotlinScriptDefinitionAdapterFromNewAPI( KotlinScriptDefinitionAdapterFromNewAPI(
ScriptDefinitionFromAnnotatedBaseClass( ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(cls.kotlin),
ScriptingEnvironment( ScriptingEnvironment(
ScriptingEnvironmentProperties.baseClass to KotlinType(cls.kotlin),
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass() ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
) )
) )