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

Clean and fix new scripting API

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
libraries/scripting/common/src/kotlin/script/experimental/api/scriptCompilation.kt
+2 -2
View File
@@ -9,8 +9,8 @@ interface ScriptCompiler {
suspend fun compile(
script: ScriptSource,
configurator: ScriptCompilationConfigurator? = null,
additionalConfiguration: ScriptCompileConfiguration? = null // overrides parameters from configurator.defaultConfiguration
scriptDefinition: ScriptDefinition,
additionalConfiguration: ScriptCompileConfiguration? = null // overrides properties from definition and configurator.defaultConfiguration
): ResultWithDiagnostics<CompiledScript<*>>
}
libraries/scripting/common/src/kotlin/script/experimental/api/scriptConfiguration.kt
+1 -1
View File
@@ -17,7 +17,7 @@ typealias ProcessedScriptData = ChainedPropertyBag
interface ScriptCompilationConfigurator {
// constructor(environment: ScriptingEnvironment) // the constructor is expected from implementations
// constructor(properties: ScriptDefinitionPropertiesBag) // the constructor is expected from implementations
val defaultConfiguration: ScriptCompileConfiguration
libraries/scripting/common/src/kotlin/script/experimental/api/scriptConfigurationProperties.kt
+1 -1
View File
@@ -13,7 +13,7 @@ object ScriptCompileConfigurationProperties {
val sourceFragments by typedKey<List<ScriptSourceNamedFragment>>()
val baseClass = ScriptingEnvironmentProperties.baseClass
val baseClass = ScriptDefinitionProperties.baseClass
val scriptBodyTarget by typedKey<ScriptBodyTarget>()
libraries/scripting/common/src/kotlin/script/experimental/api/scriptDefinition.kt
+11 -2
View File
@@ -7,6 +7,7 @@
package kotlin.script.experimental.api
import kotlin.reflect.KClass
import kotlin.script.experimental.util.ChainedPropertyBag
import kotlin.script.experimental.util.typedKey
@@ -18,7 +19,7 @@ interface ScriptDefinition {
val properties: ScriptDefinitionPropertiesBag
val compilationConfigurator: ScriptCompilationConfigurator
val compilationConfigurator: ScriptCompilationConfigurator?
val evaluator: ScriptEvaluator<*>?
}
@@ -28,4 +29,12 @@ object ScriptDefinitionProperties {
val name by typedKey<String>() // Name of the script type, by default "Kotlin script"
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)
libraries/scripting/common/src/kotlin/script/experimental/api/scriptEvaluation.kt
+1 -1
View File
@@ -27,7 +27,7 @@ data class EvaluationResult(val returnValue: Any?, val environment: ScriptEvalua
// NOTE: name inconsistency: run vs evaluate
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(
compiledScript: CompiledScript<ScriptBase>,
libraries/scripting/common/src/kotlin/script/experimental/api/scriptingEnvironment.kt
-8
View File
@@ -13,9 +13,6 @@ typealias ScriptingEnvironment = ChainedPropertyBag
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
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.getScriptBaseClass(contextClass: KClass<*>): KClass<*> =
getScriptingClass(get(ScriptingEnvironmentProperties.baseClass), contextClass)
fun ScriptingEnvironment.getScriptBaseClass(context: Any): KClass<*> =
getScriptingClass(get(ScriptingEnvironmentProperties.baseClass), context::class)
libraries/scripting/common/src/kotlin/script/experimental/basic/basicScript.kt
+3 -3
View File
@@ -13,10 +13,10 @@ import kotlin.script.experimental.util.TypedKey
private const val ILLEGAL_CONFIG_ANN_ARG =
"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) {
val baseClass = environment.getScriptBaseClass(this)
val baseClass = properties.getScriptBaseClass(this)
val cfg = baseClass.annotations.filterIsInstance(KotlinScriptDefaultCompilationConfiguration::class.java).flatMap { ann ->
val params = try {
ann.compilationConfiguration.objectInstance ?: ann.compilationConfiguration.createInstance()
@@ -29,7 +29,7 @@ open class AnnotationsBasedCompilationConfigurator(val environment: ScriptingEnv
}
params as List<Pair<TypedKey<*>, Any?>>
}
ScriptCompileConfiguration(environment, cfg)
ScriptCompileConfiguration(properties, cfg)
}
}
libraries/scripting/common/src/kotlin/script/experimental/definitions/definitionFromAnnotation.kt
+18 -18
View File
@@ -13,52 +13,52 @@ import kotlin.script.experimental.api.*
import kotlin.script.experimental.basic.AnnotationsBasedCompilationConfigurator
import kotlin.script.experimental.basic.DummyEvaluator
import kotlin.script.experimental.util.TypedKey
import kotlin.script.experimental.util.chainPropertyBags
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)
?: 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 {
val baseClassType = environment.getOrNull(ScriptingEnvironmentProperties.baseClass)
?: throw IllegalArgumentException("${ERROR_MSG_PREFIX}Expecting 'baseClass' parameter in the scripting environment")
private val baseClass: KClass<*> =
try {
getScriptingClass(baseClassType, this::class, environment)
} catch (e: Throwable) {
throw IllegalArgumentException("${ERROR_MSG_PREFIX}Unable to load base class $baseClassType", e)
}
}
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? =
baseClass.findAnnotation<KotlinScriptDefinition>()?.definition.takeIf { it != this::class }?.let { it.instantiateScriptHandler() }
override val properties = run {
val baseProperties = explicitDefinition?.properties ?: environment
val toAdd = arrayListOf<Pair<TypedKey<*>, Any>>()
val baseProperties = chainPropertyBags(explicitDefinition?.properties, environment)
val propertiesData = arrayListOf<Pair<TypedKey<*>, Any>>(ScriptDefinitionProperties.baseClass to baseClassType)
baseClass.findAnnotation<KotlinScriptFileExtension>()?.let {
toAdd += ScriptDefinitionProperties.fileExtension to it.extension
propertiesData += ScriptDefinitionProperties.fileExtension to it.extension
}
if (baseProperties.getOrNull(ScriptDefinitionProperties.name) == null) {
toAdd += ScriptDefinitionProperties.name to mainAnnotation.name
propertiesData += ScriptDefinitionProperties.name to mainAnnotation.name
}
if (toAdd.isEmpty()) baseProperties
else ScriptingEnvironment(baseProperties, toAdd)
ScriptingEnvironment(baseProperties, propertiesData)
}
override val compilationConfigurator =
baseClass.findAnnotation<KotlinScriptCompilationConfigurator>()?.compilationConfigurator?.instantiateScriptHandler()
?: explicitDefinition?.compilationConfigurator
?: AnnotationsBasedCompilationConfigurator::class.instantiateScriptHandler()
?: explicitDefinition?.compilationConfigurator
?: AnnotationsBasedCompilationConfigurator::class.instantiateScriptHandler()
override val evaluator =
baseClass.findAnnotation<KotlinScriptEvaluator>()?.evaluator?.instantiateScriptHandler()
?: explicitDefinition?.evaluator
?: DummyEvaluator::class.instantiateScriptHandler()
?: explicitDefinition?.evaluator
?: DummyEvaluator::class.instantiateScriptHandler()
private fun <T : Any> KClass<T>.instantiateScriptHandler(): T {
val klass: KClass<T> = try {
@@ -68,7 +68,7 @@ open class ScriptDefinitionFromAnnotatedBaseClass(val environment: ScriptingEnvi
}
try {
// 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) {
throw IllegalArgumentException("${ERROR_MSG_PREFIX}Unable to instantiate handler $this: $e", e)
}
libraries/scripting/common/src/kotlin/script/experimental/host/BasicScriptingHost.kt
+3 -2
View File
@@ -23,19 +23,20 @@ import kotlinx.coroutines.experimental.runBlocking
import kotlin.script.experimental.api.*
abstract class BasicScriptingHost<ScriptBase : Any>(
val configurator: ScriptCompilationConfigurator,
val compiler: ScriptCompiler,
// TODO: does it belong here or to the definition?
val evaluator: ScriptEvaluator<ScriptBase>
) {
open fun <T> runInCoroutineContext(block: suspend CoroutineScope.() -> T): T = runBlocking { block() }
open fun eval(
script: ScriptSource,
scriptDefinition: ScriptDefinition,
compileConfiguration: ScriptCompileConfiguration,
environment: ScriptEvaluationEnvironment
): ResultWithDiagnostics<EvaluationResult> =
runInCoroutineContext {
val compiled = compiler.compile(script, configurator, compileConfiguration)
val compiled = compiler.compile(script, scriptDefinition, compileConfiguration)
when (compiled) {
is ResultWithDiagnostics.Failure -> compiled
is ResultWithDiagnostics.Success -> {
libraries/scripting/common/src/kotlin/script/experimental/util/propertyBag.kt
+14 -2
View File
@@ -27,8 +27,8 @@ open class ChainedPropertyBag private constructor(private val parent: ChainedPro
fun cloneWithNewParent(newParent: ChainedPropertyBag?): ChainedPropertyBag = when {
newParent == null -> this
parent == null -> ChainedPropertyBag(newParent, data)
else -> ChainedPropertyBag(parent.cloneWithNewParent(newParent), data)
parent == null -> createOptimized(newParent, data)
else -> createOptimized(parent.cloneWithNewParent(newParent), data)
}
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 }
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())