Merge pull request #25 from ty1824/improvements

Dialector * Fixed a nullable cast bug in the resolve extension function * Now allows properties with default values. The hasDefault property must be set on the @Property annotation and a default getter must be provided by the property itself. * Attempted to add formatting capabilities to the Dialector code generator. This is disabled until a reflective access bug is fixed by the ktlint team/their upstream libraries. Inkt * Formalized the error messaging when a cycle occurs so it is more useful and complete.
ty1824 · Jul 27, 2023 · 9ff9251 · 9ff9251
2 parents a76528d + e43ce0b
commit 9ff9251
Show file tree

Hide file tree

Showing 31 changed files with 270 additions and 149 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -37,4 +37,15 @@ subprojects {
     repositories {
         mavenCentral()
     }
+
+    // configure Kotlin to allow these opt-in features throughout the project
+    tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
+        compilerOptions {
+            freeCompilerArgs.addAll(
+                "-opt-in=kotlin.time.ExperimentalTime",
+                "-opt-in=kotlin.contracts.ExperimentalContracts",
+                "-Xcontext-receivers"
+            )
+        }
+    }
 }
diff --git a/dialector-kt-processor/build.gradle.kts b/dialector-kt-processor/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
 }
 
 val kspVersion: String by project
+val ktlintVersion: String by project
 
 repositories {
     google()
@@ -22,6 +23,9 @@ dependencies {
     implementation("com.squareup:kotlinpoet-ksp:1.12.0")
     implementation("com.google.devtools.ksp:symbol-processing-api:$kspVersion")
     implementation(kotlin("reflect"))
+    implementation("com.pinterest.ktlint:ktlint-core:$ktlintVersion")
+    implementation("com.pinterest.ktlint:ktlint-rule-engine:$ktlintVersion")
+    implementation("com.pinterest.ktlint:ktlint-ruleset-standard:$ktlintVersion")
 
     testImplementation("org.jetbrains.kotlin:kotlin-test")
     testImplementation(project(":dialector-kt"))
@@ -114,4 +118,4 @@ signing {
         )
         sign(publishing.publications)
     }
-}
+}
diff --git a/dialector-kt-processor/src/main/kotlin/dev/dialector/processor/DialectorSymbolProcessor.kt b/dialector-kt-processor/src/main/kotlin/dev/dialector/processor/DialectorSymbolProcessor.kt
diff --git a/...ctor-kt-processor/src/test/kotlin/dev/dialector/processor/DialectorSymbolProcessorTest.kt b/...ctor-kt-processor/src/test/kotlin/dev/dialector/processor/DialectorSymbolProcessorTest.kt
@@ -31,6 +31,7 @@ class DialectorSymbolProcessorTest {
         // Verify raw values
         assertEquals("hello", node.property)
         assertEquals("provided", node.optionalProperty)
+        assertEquals("default", node.defaultProperty)
         assertEquals(singleChildValue, node.singleChild)
         assertEquals(optionalChildValue, node.optionalChild)
         assertEquals(listOf(pluralFirstChildValue, pluralSecondChildValue, pluralThirdChildValue), node.pluralChildren)

diff --git a/dialector-kt-processor/src/test/kotlin/dev/dialector/processor/SampleModel.kt b/dialector-kt-processor/src/test/kotlin/dev/dialector/processor/SampleModel.kt
@@ -15,6 +15,10 @@ interface SimpleNode : Node {
     @Property
     val optionalProperty: String?
 
+    @Property(hasDefault = true)
+    val defaultProperty: String
+        get() = "default"
+
     @Child
     val singleChild: ChildNode
 

diff --git a/dialector-kt/src/main/kotlin/dev/dialector/semantic/ScopeConstraints.kt b/dialector-kt/src/main/kotlin/dev/dialector/semantic/ScopeConstraints.kt
@@ -23,7 +23,7 @@ public interface ScopeVariable : SemanticVariable {
 public data class InheritScopeConstraint(
     val scope: ScopeVariable,
     val inheritFrom: ScopeVariable,
-    val label: String
+    val label: String,
 ) : SemanticConstraint
 
 /**
@@ -33,7 +33,7 @@ public data class DeclareElementConstraint(
     val scope: ScopeVariable,
     val namespace: Namespace,
     val element: Node,
-    val name: String
+    val name: String,
 ) : SemanticConstraint
 
 /**
@@ -44,7 +44,7 @@ public data class AliasElementConstraint(
     val namespace: Namespace,
     val original: String,
     val aliasNamespace: Namespace,
-    val alias: String
+    val alias: String,
 ) : SemanticConstraint
 
 /**
@@ -56,7 +56,7 @@ public data class ReferenceIdentifierConstraint(
     /** The [Namespace] the search should use */
     val namespace: Namespace,
     /** The [NodeReference] to resolve */
-    val reference: NodeReference<out Node>
+    val reference: NodeReference<out Node>,
 ) : SemanticConstraint
 
 public object Scopes : ConstraintCreator {

diff --git a/dialector-kt/src/main/kotlin/dev/dialector/semantic/SemanticConstraintSystem.kt b/dialector-kt/src/main/kotlin/dev/dialector/semantic/SemanticConstraintSystem.kt
@@ -75,7 +75,7 @@ public data class ReferencedTypeConstraint(
     val scope: ScopeVariable,
     val namespace: Namespace,
     val reference: NodeReference<out Node>,
-    val variable: TypeVariable
+    val variable: TypeVariable,
 ) : SemanticConstraint
 
 /**
@@ -88,7 +88,7 @@ public data class TypeScopeConstraint(
     /** The type from which to derive the scope. */
     val type: Type,
     /** Describes this inheritance relation for debugging purposes. */
-    val label: String
+    val label: String,
 ) : SemanticConstraint
 
 /**
@@ -100,7 +100,7 @@ public data class DeclareElementTypeConstraint(
     val scope: ScopeVariable,
     val namespace: Namespace,
     val name: String,
-    val type: Type
+    val type: Type,
 ) : SemanticConstraint
 
 public object TypeScopes : ConstraintCreator {
@@ -221,7 +221,7 @@ public typealias ReductionRoutine = ReductionContext.(constraint: TypeRelationCo
 private class SimpleReductionRule<T : SemanticConstraint>(
     override val name: String,
     override val isValidFor: ConstraintClause<T>,
-    override val reduce: ReductionContext.(T) -> Unit
+    override val reduce: ReductionContext.(T) -> Unit,
 ) : ReductionRule<T>
 
 public fun <T : SemanticConstraint> ConstraintClause<T>.reducesTo(name: String, routine: ReductionContext.(T) -> Unit): ReductionRule<T> =
@@ -277,7 +277,7 @@ public interface Bound {
 public data class BaseBound(
     override val relation: TypeRelation,
     override val variable: TypeVariable,
-    override val boundingType: Type
+    override val boundingType: Type,
 ) : Bound
 
 /*

diff --git a/dialector-kt/src/main/kotlin/dev/dialector/semantic/TypeConstraints.kt b/dialector-kt/src/main/kotlin/dev/dialector/semantic/TypeConstraints.kt
@@ -10,7 +10,8 @@ public interface TypeVariable : Type, SemanticVariable {
 public enum class TypeRelation(public val symbol: String) {
     SUBTYPE("<"),
     SUPERTYPE(">"),
-    EQUIVALENT("=");
+    EQUIVALENT("="),
+    ;
 
     public fun opposite(): TypeRelation = when (this) {
         SUBTYPE -> SUPERTYPE
@@ -23,7 +24,7 @@ public enum class TypeRelation(public val symbol: String) {
 
 public enum class VariableConstraintKind {
     PULL_UP,
-    PUSH_DOWN
+    PUSH_DOWN,
 }
 
 /**
@@ -34,7 +35,7 @@ public enum class VariableConstraintKind {
  */
 public data class TypeVariableConstraint(
     val variable: TypeVariable,
-    val kind: VariableConstraintKind
+    val kind: VariableConstraintKind,
 ) : SemanticConstraint
 
 /**
@@ -47,7 +48,7 @@ public data class TypeRelationConstraint(
     val relation: TypeRelation,
     val left: Type,
     val right: Type,
-    val mutual: Boolean = false
+    val mutual: Boolean = false,
 ) : SemanticConstraint
 
 public object Types : ConstraintCreator {

diff --git a/dialector-kt/src/main/kotlin/dev/dialector/semantic/scope/ScopeGraph.kt b/dialector-kt/src/main/kotlin/dev/dialector/semantic/scope/ScopeGraph.kt
@@ -60,7 +60,7 @@ interface ScopeGraph : ReferenceResolver {
 
 class SingleRootScopeGraph private constructor(
     private val targets: Map<NodeReference<*>, Node>,
-    private val visibleElements: Map<NodeReference<*>, Sequence<Pair<Node, String>>>
+    private val visibleElements: Map<NodeReference<*>, Sequence<Pair<Node, String>>>,
 ) : ScopeGraph {
     companion object {
         suspend operator fun invoke(root: Node, rules: List<ScopeTraversalRule<out Node>>): SingleRootScopeGraph {
@@ -166,21 +166,21 @@ class LinearScopeDescriptor(private val onReference: ReferenceHandler) : ScopeDe
     private data class ExplicitDeclaration(
         override val namespace: Namespace,
         override val node: Node,
-        override val identifier: String
+        override val identifier: String,
     ) : Declaration
 
     private data class AliasDeclaration(
         val forDeclaration: Declaration,
         override val namespace: Namespace,
-        override val identifier: String
+        override val identifier: String,
     ) : Declaration {
         override val node: Node
             get() = forDeclaration.node
     }
 
     private data class IncomingReference(
         val namespace: Namespace,
-        val index: Int
+        val index: Int,
     )
 
     private val declarations: MutableList<Declaration> = mutableListOf()
@@ -263,7 +263,7 @@ class LinearScopeDescriptor(private val onReference: ReferenceHandler) : ScopeDe
 
 class SimpleScopeTraversalContext(
     val createScope: () -> ScopeDescriptor,
-    val onTraversal: suspend ScopeTraversalContext.(node: Node, scope: ScopeDescriptor) -> Unit
+    val onTraversal: suspend ScopeTraversalContext.(node: Node, scope: ScopeDescriptor) -> Unit,
 ) : ScopeTraversalContext {
 
     override val semantics: SemanticAnalysisContext =
@@ -275,7 +275,7 @@ class SimpleScopeTraversalContext(
 }
 
 class LinearScopeGraph private constructor(
-    private val referenceScopes: Map<NodeReference<*>, LinearScopeDescriptor>
+    private val referenceScopes: Map<NodeReference<*>, LinearScopeDescriptor>,
 ) : ScopeGraph {
     companion object {
         suspend operator fun invoke(root: Node, rules: List<ScopeTraversalRule<out Node>>): LinearScopeGraph {

diff --git a/dialector-kt/src/main/kotlin/dev/dialector/semantic/type/inference/BaseInferenceEngine.kt b/dialector-kt/src/main/kotlin/dev/dialector/semantic/type/inference/BaseInferenceEngine.kt
@@ -21,7 +21,7 @@ internal class MutableInferenceGroup(
     variableTerms: Set<VariableTerm>,
     typeTerms: Set<TypeTerm> = setOf(),
     upperBounds: Set<MutableInferenceGroup> = setOf(),
-    lowerBounds: Set<MutableInferenceGroup> = setOf()
+    lowerBounds: Set<MutableInferenceGroup> = setOf(),
 ) : InferenceGroup {
     override val variableTerms: MutableSet<VariableTerm> = variableTerms.toMutableSet()
     override val typeTerms: MutableSet<TypeTerm> = typeTerms.toMutableSet()

diff --git a/dialector-kt/src/main/kotlin/dev/dialector/semantic/type/inference/InferenceGraph.kt b/dialector-kt/src/main/kotlin/dev/dialector/semantic/type/inference/InferenceGraph.kt
@@ -59,7 +59,7 @@ class InferenceSys {
  * An [InferenceVariable] is a special [Type] that represents a "hole" in the type system.
  */
 class InferenceVariable internal constructor(
-    val id: Int
+    val id: Int,
     /*val context: VariableContext*/
 ) : Type {
     override fun equals(other: Any?): Boolean = this === other
@@ -88,12 +88,12 @@ enum class Directionality {
     /**
      * The effect is mutually applied, from "left" to "right" and "right" to "left".
      */
-    Bidirectional
+    Bidirectional,
 }
 
 data class InferenceConstraint(
     val left: Term,
-    val right: Term
+    val right: Term,
     /*val directionality: Directionality = Directionality.Left,*/
     /*val context: ConstraintContext*/
 )
@@ -154,7 +154,7 @@ interface IncorporationRule
 class InferenceState(
     val lattice: TypeLattice,
     val reductionRules: List<ReductionRule>,
-    val incorporationRules: List<IncorporationRule>
+    val incorporationRules: List<IncorporationRule>,
 ) {
     val constraints: MutableSet<InferenceConstraint> = mutableSetOf()
     val currentConstraints: MutableList<InferenceConstraint> = mutableListOf()

diff --git a/...rc/main/kotlin/dev/dialector/semantic/type/inference/new/BaseInferenceConstraintSystem.kt b/...rc/main/kotlin/dev/dialector/semantic/type/inference/new/BaseInferenceConstraintSystem.kt
@@ -59,7 +59,7 @@ typealias ReductionRoutine = ReductionContext.(constraint: RelationalConstraint)
 
 private class SimpleReductionRule(
     override val isValidFor: RelationalConstraintClause,
-    override val reduce: ReductionRoutine
+    override val reduce: ReductionRoutine,
 ) : ReductionRule
 
 infix fun RelationalConstraintClause.reducesTo(routine: ReductionRoutine): ReductionRule = SimpleReductionRule(this, routine)
@@ -89,7 +89,7 @@ private class BaseInferenceVariable(override val id: String) : InferenceVariable
 data class BaseBound(
     override val relation: TypeRelation,
     override val variable: InferenceVariable,
-    override val boundingType: Type
+    override val boundingType: Type,
 ) : Bound
 
 sealed class BoundGraphNode {
@@ -218,7 +218,7 @@ class BoundSystemGraph {
 
 class BaseInferenceContext(
     val createVariable: () -> InferenceVariable,
-    val addConstraint: (InferenceConstraint) -> Unit
+    val addConstraint: (InferenceConstraint) -> Unit,
 ) : InferenceContext, ConstraintCreator by SimpleConstraintCreator {
     override fun typeVar(): InferenceVariable = createVariable()
 
@@ -233,7 +233,7 @@ class BaseReductionContext(
     constraint: RelationalConstraint,
     rule: ReductionRule,
     private val addConstraint: (RelationalConstraint, InferenceOrigin) -> Unit,
-    private val addBound: (Bound, InferenceOrigin) -> Unit
+    private val addBound: (Bound, InferenceOrigin) -> Unit,
 ) : ReductionContext {
     private val origin = ReducedFromConstraint(constraint, rule)
     override fun constraint(routine: ConstraintCreator.() -> RelationalConstraint) {
@@ -324,7 +324,7 @@ class BaseInferenceConstraintSystem : InferenceConstraintSystem {
     private fun reduce(
         reductionRules: List<ReductionRule>,
         constraints: ConstraintSystem,
-        bounds: BoundSystemGraph
+        bounds: BoundSystemGraph,
     ) {
         constraints.reduce { constraint ->
             when (val currentConstraint = constraint) {
@@ -341,7 +341,7 @@ class BaseInferenceConstraintSystem : InferenceConstraintSystem {
                             },
                             { bound, origin ->
                                 bounds.addBound(bound, origin)
-                            }
+                            },
                         )
                         reductionContext.reduce(currentConstraint)
                     }
@@ -353,7 +353,7 @@ class BaseInferenceConstraintSystem : InferenceConstraintSystem {
 
     private fun incorporate(
         constraints: ConstraintSystem,
-        boundSystem: BoundSystemGraph
+        boundSystem: BoundSystemGraph,
     ) {
         SimpleConstraintCreator.apply {
             // TODO: Handle constraint origin once supported

diff --git a/...kt/src/main/kotlin/dev/dialector/semantic/type/inference/new/InferenceConstraintSystem.kt b/...kt/src/main/kotlin/dev/dialector/semantic/type/inference/new/InferenceConstraintSystem.kt
@@ -30,7 +30,8 @@ interface InferenceVariable : Type {
 enum class TypeRelation(val symbol: String) {
     SUBTYPE("<"),
     SUPERTYPE(">"),
-    EQUIVALENT("=");
+    EQUIVALENT("="),
+    ;
 
     fun opposite(): TypeRelation = when (this) {
         SUBTYPE -> SUPERTYPE
@@ -43,7 +44,7 @@ enum class TypeRelation(val symbol: String) {
 
 enum class VariableConstraintKind {
     PULL_UP,
-    PUSH_DOWN
+    PUSH_DOWN,
 }
 
 interface InferenceOrigin
@@ -52,14 +53,14 @@ sealed class InferenceConstraint
 
 data class VariableConstraint(
     val variable: InferenceVariable,
-    val kind: VariableConstraintKind
+    val kind: VariableConstraintKind,
 ) : InferenceConstraint()
 
 data class RelationalConstraint(
     val relation: TypeRelation,
     val left: Type,
     val right: Type,
-    val mutual: Boolean = false
+    val mutual: Boolean = false,
 ) : InferenceConstraint()
 
 interface Bound {