diff --git a/orx-parameters/build.gradle b/orx-parameters/build.gradle deleted file mode 100644 index 82634771..00000000 --- a/orx-parameters/build.gradle +++ /dev/null @@ -1,3 +0,0 @@ -dependencies { - implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlinVersion" -} \ No newline at end of file diff --git a/orx-parameters/build.gradle.kts b/orx-parameters/build.gradle.kts new file mode 100644 index 00000000..d22ff0ed --- /dev/null +++ b/orx-parameters/build.gradle.kts @@ -0,0 +1,81 @@ +plugins { + kotlin("multiplatform") + kotlin("plugin.serialization") +} + +val kotlinxSerializationVersion: String by rootProject.extra +val kotestVersion: String by rootProject.extra +val junitJupiterVersion: String by rootProject.extra +val jvmTarget: String by rootProject.extra +val kotlinApiVersion: String by rootProject.extra +val kotlinVersion: String by rootProject.extra +val kotlinLoggingVersion: String by rootProject.extra +val kluentVersion: String by rootProject.extra +val openrndrVersion: String by rootProject.extra +val openrndrOS: String by rootProject.extra +val spekVersion: String by rootProject.extra + +kotlin { + jvm { + compilations.all { + kotlinOptions.jvmTarget = jvmTarget + kotlinOptions.apiVersion = kotlinApiVersion + } + testRuns["test"].executionTask.configure { + useJUnitPlatform() + } + } + js(IR) { + browser() + nodejs() + } + + sourceSets { + val shaderKotlin by creating { + this.kotlin.srcDir("$projectDir/build/generated/shaderKotlin") + } + @Suppress("UNUSED_VARIABLE") + val commonMain by getting { + dependencies { + implementation("org.openrndr:openrndr-math:$openrndrVersion") + implementation("org.jetbrains.kotlin:kotlin-reflect:$kotlinVersion") + implementation("io.github.microutils:kotlin-logging:$kotlinLoggingVersion") + } + } + @Suppress("UNUSED_VARIABLE") + val commonTest by getting { + dependencies { + implementation(kotlin("test-common")) + implementation(kotlin("test-annotations-common")) + implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinxSerializationVersion") + implementation("io.kotest:kotest-assertions-core:$kotestVersion") + } + } + @Suppress("UNUSED_VARIABLE") + val jvmMain by getting + + @Suppress("UNUSED_VARIABLE") + val jvmTest by getting { + dependencies { + implementation(kotlin("test-common")) + implementation(kotlin("test-annotations-common")) + implementation(kotlin("test-junit5")) + implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinxSerializationVersion") + runtimeOnly("org.junit.jupiter:junit-jupiter-api:$junitJupiterVersion") + runtimeOnly("org.junit.jupiter:junit-jupiter-engine:$junitJupiterVersion") + implementation("org.spekframework.spek2:spek-dsl-jvm:$spekVersion") + implementation("org.amshove.kluent:kluent:$kluentVersion") + } + } + + @Suppress("UNUSED_VARIABLE") + val jsMain by getting + + @Suppress("UNUSED_VARIABLE") + val jsTest by getting { + dependencies { + implementation(kotlin("test-js")) + } + } + } +} diff --git a/orx-parameters/src/main/kotlin/Annotations.kt b/orx-parameters/src/commonMain/kotlin/Annotations.kt similarity index 58% rename from orx-parameters/src/main/kotlin/Annotations.kt rename to orx-parameters/src/commonMain/kotlin/Annotations.kt index aefb669d..ecb92472 100644 --- a/orx-parameters/src/main/kotlin/Annotations.kt +++ b/orx-parameters/src/commonMain/kotlin/Annotations.kt @@ -4,10 +4,6 @@ import org.openrndr.math.Vector2 import kotlin.reflect.KCallable import kotlin.reflect.KClass import kotlin.reflect.KMutableProperty1 -import kotlin.reflect.KVisibility -import kotlin.reflect.full.declaredMemberFunctions -import kotlin.reflect.full.findAnnotation -import kotlin.reflect.full.memberProperties /* In case you are here to add an extra annotation type: 1. Add an annotation class @@ -30,7 +26,7 @@ annotation class Description(val title: String, val description: String = "") @Target(AnnotationTarget.PROPERTY) @Retention(AnnotationRetention.RUNTIME) -annotation class OptionParameter(val label: String, val order: Int = Integer.MAX_VALUE) +annotation class OptionParameter(val label: String, val order: Int = Int.MAX_VALUE) /** * DoubleParameter annotation for a double precision parameter @@ -42,8 +38,7 @@ annotation class OptionParameter(val label: String, val order: Int = Integer.MAX */ @Target(AnnotationTarget.PROPERTY) @Retention(AnnotationRetention.RUNTIME) -annotation class DoubleParameter(val label: String, val low: Double, val high: Double, val precision: Int = 3, val order: Int = Integer.MAX_VALUE) - +annotation class DoubleParameter(val label: String, val low: Double, val high: Double, val precision: Int = 3, val order: Int = Int.MAX_VALUE) /** * DoubleListParameter annotation for a double precision parameter @@ -64,7 +59,7 @@ annotation class DoubleListParameter( val minimumListLength: Int = 1, val maximumListLength: Int = 16, val precision: Int = 3, - val order: Int = Integer.MAX_VALUE + val order: Int = Int.MAX_VALUE ) /** @@ -76,7 +71,7 @@ annotation class DoubleListParameter( */ @Target(AnnotationTarget.PROPERTY) @Retention(AnnotationRetention.RUNTIME) -annotation class IntParameter(val label: String, val low: Int, val high: Int, val order: Int = Integer.MAX_VALUE) +annotation class IntParameter(val label: String, val low: Int, val high: Int, val order: Int = Int.MAX_VALUE) /** * BooleanParameter annotation for a boolean parameter @@ -85,7 +80,7 @@ annotation class IntParameter(val label: String, val low: Int, val high: Int, va */ @Target(AnnotationTarget.PROPERTY) @Retention(AnnotationRetention.RUNTIME) -annotation class BooleanParameter(val label: String, val order: Int = Integer.MAX_VALUE) +annotation class BooleanParameter(val label: String, val order: Int = Int.MAX_VALUE) /** * TextParameter annotation for a text parameter @@ -94,7 +89,7 @@ annotation class BooleanParameter(val label: String, val order: Int = Integer.MA */ @Target(AnnotationTarget.PROPERTY) @Retention(AnnotationRetention.RUNTIME) -annotation class TextParameter(val label: String, val order: Int = Integer.MAX_VALUE) +annotation class TextParameter(val label: String, val order: Int = Int.MAX_VALUE) /** * ColorParameter annotation for a ColorRGBa parameter @@ -103,7 +98,7 @@ annotation class TextParameter(val label: String, val order: Int = Integer.MAX_V */ @Target(AnnotationTarget.PROPERTY) @Retention(AnnotationRetention.RUNTIME) -annotation class ColorParameter(val label: String, val order: Int = Integer.MAX_VALUE) +annotation class ColorParameter(val label: String, val order: Int = Int.MAX_VALUE) /** @@ -122,7 +117,7 @@ annotation class XYParameter( val precision: Int = 2, val showVector: Boolean = false, val invertY: Boolean = true, - val order: Int = Integer.MAX_VALUE + val order: Int = Int.MAX_VALUE ) @Target(AnnotationTarget.PROPERTY) @@ -132,7 +127,7 @@ annotation class Vector2Parameter( val min: Double = -1.0, val max: Double = 1.0, val precision: Int = 2, - val order: Int = Integer.MAX_VALUE + val order: Int = Int.MAX_VALUE ) @Target(AnnotationTarget.PROPERTY) @@ -142,7 +137,7 @@ annotation class Vector3Parameter( val min: Double = -1.0, val max: Double = 1.0, val precision: Int = 2, - val order: Int = Integer.MAX_VALUE + val order: Int = Int.MAX_VALUE ) @Target(AnnotationTarget.PROPERTY) @@ -152,7 +147,7 @@ annotation class Vector4Parameter( val min: Double = -1.0, val max: Double = 1.0, val precision: Int = 2, - val order: Int = Integer.MAX_VALUE + val order: Int = Int.MAX_VALUE ) /** @@ -162,7 +157,7 @@ annotation class Vector4Parameter( */ @Target(AnnotationTarget.FUNCTION) @Retention(AnnotationRetention.RUNTIME) -annotation class ActionParameter(val label: String, val order: Int = Integer.MAX_VALUE) +annotation class ActionParameter(val label: String, val order: Int = Int.MAX_VALUE) // // @@ -182,11 +177,9 @@ enum class ParameterType(val annotationClass: KClass) { ; companion object { - fun forParameterAnnotationClass(annotation: Annotation): ParameterType = - values().find { it.annotationClass == annotation.annotationClass } ?: error("no type for $annotation") - val parameterAnnotationClasses get() = values().map { it.annotationClass } } + } // // @@ -222,129 +215,11 @@ class Parameter( /** * List all parameters, (public var properties with a parameter annotation) */ -fun Any.listParameters(): List { - return (this::class.memberProperties.filter { property -> - !property.isConst && - property is KMutableProperty1<*, *> && - property.visibility == KVisibility.PUBLIC && - property.annotations.map { it.annotationClass }.intersect(ParameterType.parameterAnnotationClasses).isNotEmpty() - }.map { property -> - val annotations = property.annotations.filter { it.annotationClass in ParameterType.parameterAnnotationClasses } - var intRange: IntRange? = null - var doubleRange: ClosedRange? = null - var sizeRange: ClosedRange? = null - var order: Int = Integer.MAX_VALUE - var label = "" - var precision: Int? = null - var type: ParameterType? = null - var vectorRange = Pair(Vector2(-1.0, -1.0), Vector2(1.0, 1.0)) - var invertY: Boolean? = null - var showVector: Boolean? = null - annotations.forEach { - type = ParameterType.forParameterAnnotationClass(it) - when (it) { - is BooleanParameter -> { - label = it.label - order = it.order - } - is DoubleParameter -> { - label = it.label - doubleRange = it.low..it.high - precision = it.precision - order = it.order - } - is IntParameter -> { - label = it.label - intRange = it.low..it.high - order = it.order - } - is TextParameter -> { - label = it.label - order = it.order - } - is ColorParameter -> { - label = it.label - order = it.order - } - is XYParameter -> { - label = it.label - order = it.order - vectorRange = Pair(Vector2(it.minX, it.minY), Vector2(it.maxX, it.maxY)) - precision = it.precision - invertY = it.invertY - showVector = it.showVector - } - is DoubleListParameter -> { - label = it.label - order = it.order - doubleRange = it.low..it.high - precision = it.precision - sizeRange = it.minimumListLength..it.maximumListLength - } - is Vector2Parameter -> { - label = it.label - order = it.order - doubleRange = it.min..it.max - precision = it.precision - } - is Vector3Parameter -> { - label = it.label - order = it.order - doubleRange = it.min..it.max - precision = it.precision - } - is Vector4Parameter -> { - label = it.label - order = it.order - doubleRange = it.min..it.max - precision = it.precision - } - is OptionParameter -> { - label = it.label - order = it.order - } - } - } - Parameter( - parameterType = type ?: error("no type"), - property = property as KMutableProperty1, - function = null, - label = label, - doubleRange = doubleRange, - vectorRange = vectorRange, - sizeRange = sizeRange, - intRange = intRange, - precision = precision, - showVector = showVector, - invertY = invertY, - order = order - ) - } + this::class.declaredMemberFunctions.filter { - it.findAnnotation() != null - }.map { - val annotation = it.findAnnotation()!! - val label = annotation.label - val order = annotation.order - val type = ParameterType.Action - Parameter( - type, - property = null, - function = it as KCallable, - label = label, - doubleRange = null, - intRange = null, - sizeRange = null, - vectorRange = null, - precision = null, - showVector = null, - invertY = null, - order = order - ) - }).sortedBy { it.order } -} // -fun Any.title() = this::class.findAnnotation()?.title -fun Any.description() = this::class.findAnnotation()?.description +expect fun Any.title(): String? + +expect fun Any.description(): String? + diff --git a/orx-parameters/src/jsMain/kotlin/description.kt b/orx-parameters/src/jsMain/kotlin/description.kt new file mode 100644 index 00000000..04705a0d --- /dev/null +++ b/orx-parameters/src/jsMain/kotlin/description.kt @@ -0,0 +1,9 @@ +package org.openrndr.extra.parameters + +actual fun Any.description(): String? { + error("not supported") +} + +actual fun Any.title(): String? { + error("not supported") +} \ No newline at end of file diff --git a/orx-parameters/src/jvmMain/kotlin/Annotations.kt b/orx-parameters/src/jvmMain/kotlin/Annotations.kt new file mode 100644 index 00000000..d39e8832 --- /dev/null +++ b/orx-parameters/src/jvmMain/kotlin/Annotations.kt @@ -0,0 +1,142 @@ +package org.openrndr.extra.parameters + +import org.openrndr.math.Vector2 +import kotlin.reflect.KCallable +import kotlin.reflect.KMutableProperty1 +import kotlin.reflect.full.findAnnotation +import kotlin.reflect.KVisibility +import kotlin.reflect.full.declaredMemberFunctions +import kotlin.reflect.full.memberProperties + +fun ParameterType.Companion.forParameterAnnotationClass(annotation: Annotation): ParameterType = + ParameterType.values().find { it.annotationClass == annotation.annotationClass } ?: error("no type for $annotation") + +val ParameterType.Companion.parameterAnnotationClasses get() = ParameterType.values().map { it.annotationClass } + +fun Any.listParameters(): List { + return (this::class.memberProperties.filter { property -> + !property.isConst && + property is KMutableProperty1<*, *> && + property.visibility == KVisibility.PUBLIC && + property.annotations.map { it.annotationClass }.intersect(ParameterType.parameterAnnotationClasses).isNotEmpty() + }.map { property -> + val annotations = property.annotations.filter { it.annotationClass in ParameterType.parameterAnnotationClasses } + var intRange: IntRange? = null + var doubleRange: ClosedRange? = null + var sizeRange: ClosedRange? = null + var order: Int = Int.MAX_VALUE + var label = "" + var precision: Int? = null + var type: ParameterType? = null + var vectorRange = Pair(Vector2(-1.0, -1.0), Vector2(1.0, 1.0)) + var invertY: Boolean? = null + var showVector: Boolean? = null + + for (it in annotations) { + type = ParameterType.forParameterAnnotationClass(it) + when (it) { + is BooleanParameter -> { + label = it.label + order = it.order + } + is DoubleParameter -> { + label = it.label + doubleRange = it.low..it.high + precision = it.precision + order = it.order + } + is IntParameter -> { + label = it.label + intRange = it.low..it.high + order = it.order + } + is TextParameter -> { + label = it.label + order = it.order + } + is ColorParameter -> { + label = it.label + order = it.order + } + is XYParameter -> { + label = it.label + order = it.order + vectorRange = Pair(Vector2(it.minX, it.minY), Vector2(it.maxX, it.maxY)) + precision = it.precision + invertY = it.invertY + showVector = it.showVector + } + is DoubleListParameter -> { + label = it.label + order = it.order + doubleRange = it.low..it.high + precision = it.precision + sizeRange = it.minimumListLength..it.maximumListLength + } + is Vector2Parameter -> { + label = it.label + order = it.order + doubleRange = it.min..it.max + precision = it.precision + } + is Vector3Parameter -> { + label = it.label + order = it.order + doubleRange = it.min..it.max + precision = it.precision + } + is Vector4Parameter -> { + label = it.label + order = it.order + doubleRange = it.min..it.max + precision = it.precision + } + is OptionParameter -> { + label = it.label + order = it.order + } + } + } + Parameter( + parameterType = type ?: error("no type"), + property = property as KMutableProperty1, + function = null, + label = label, + doubleRange = doubleRange, + vectorRange = vectorRange, + sizeRange = sizeRange, + intRange = intRange, + precision = precision, + showVector = showVector, + invertY = invertY, + order = order + ) + } + this::class.declaredMemberFunctions.filter { + it.findAnnotation() != null + }.map { + val annotation = it.findAnnotation()!! + val label = annotation.label + val order = annotation.order + val type = ParameterType.Action + Parameter( + type, + property = null, + function = it as KCallable, + label = label, + doubleRange = null, + intRange = null, + sizeRange = null, + vectorRange = null, + precision = null, + showVector = null, + invertY = null, + order = order + ) + }).sortedBy { it.order } +} + +actual fun Any.title() = this::class.findAnnotation()?.title + +actual fun Any.description(): String? = this::class.findAnnotation()?.description + + diff --git a/orx-parameters/src/test/kotlin/TestAnnotations.kt b/orx-parameters/src/jvmTest/kotlin/TestAnnotations.kt similarity index 100% rename from orx-parameters/src/test/kotlin/TestAnnotations.kt rename to orx-parameters/src/jvmTest/kotlin/TestAnnotations.kt