Introduce different types of SirFile.

touchlab · Mar 18, 2024 · 3f45bb2 · 3f45bb2
1 parent a9a3160
commit 3f45bb2
Show file tree

Hide file tree

Showing 37 changed files with 301 additions and 181 deletions.
diff --git a/SKIE/acceptance-tests b/SKIE/acceptance-tests
diff --git a/SKIE/common/util/src/commonMain/kotlin/co/touchlab/skie/util/directory/SkieBuildDirectory.kt b/SKIE/common/util/src/commonMain/kotlin/co/touchlab/skie/util/directory/SkieBuildDirectory.kt
@@ -77,8 +77,7 @@ class SkieBuildDirectory(
 
         val custom: Custom = Custom(this)
 
-        class Generated(parent: Directory) : PermanentDirectory(parent, "generated") {
-        }
+        class Generated(parent: Directory) : PermanentDirectory(parent, "generated")
 
         class Custom(parent: Directory) : PermanentDirectory(parent, "custom")
     }
@@ -99,9 +98,11 @@ class SkieBuildDirectory(
 
         class ObjectFiles(parent: Directory) : PermanentDirectory(parent, "object-files") {
 
+            // WIP Replace
             val allFiles: List<File>
                 get() = directory.walkTopDown().toList()
 
+            // WIP Replace
             val allObjectFiles: List<File>
                 get() = allFiles.filter { it.extension == "o" }
 

diff --git a/.../compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/context/SirPhaseContext.kt b/.../compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/context/SirPhaseContext.kt
@@ -10,8 +10,9 @@ import co.touchlab.skie.oir.type.translation.OirTypeTranslator
 import co.touchlab.skie.phases.SirPhase
 import co.touchlab.skie.phases.SkiePhase
 import co.touchlab.skie.phases.oir.util.ExternalApiNotesProvider
+import co.touchlab.skie.sir.ClassNamespaceProvider
+import co.touchlab.skie.sir.SirFileProvider
 import co.touchlab.skie.sir.SirProvider
-import co.touchlab.skie.sir.SkieNamespaceProvider
 import co.touchlab.skie.sir.builtin.SirBuiltins
 import co.touchlab.skie.sir.type.translation.SirTypeTranslator
 import org.jetbrains.kotlin.backend.konan.objcexport.ObjCExportNamer
@@ -30,13 +31,15 @@ class SirPhaseContext(
 
     override val sirProvider: SirProvider = SirProvider(framework, kirProvider, configurationProvider, skieConfiguration)
 
+    override val sirFileProvider: SirFileProvider = sirProvider.fileProvider
+
     override val kirBuiltins: KirBuiltins = kirProvider.kirBuiltins
 
     override val oirBuiltins: OirBuiltins = oirProvider.oirBuiltins
 
     override val sirBuiltins: SirBuiltins = sirProvider.sirBuiltins
 
-    override val skieNamespaceProvider: SkieNamespaceProvider = SkieNamespaceProvider(
+    override val classNamespaceProvider: ClassNamespaceProvider = ClassNamespaceProvider(
         kirProvider = kirProvider,
         sirProvider = sirProvider,
         mainModuleDescriptor = mainSkieContext.mainModuleDescriptor,

diff --git a/...compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/oir/element/OirExtension.kt b/...compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/oir/element/OirExtension.kt
@@ -7,6 +7,7 @@ class OirExtension(
     override val parent: OirTopLevelDeclarationParent,
 ) : OirTopLevelDeclaration, OirCallableDeclarationParent {
 
+    // WIP Should be set
     lateinit var sirExtension: SirExtension
 
     override val callableDeclarations: MutableList<OirCallableDeclaration> = mutableListOf()

diff --git a/SKIE/compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/phases/SirPhase.kt b/SKIE/compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/phases/SirPhase.kt
@@ -8,7 +8,8 @@ import co.touchlab.skie.oir.builtin.OirBuiltins
 import co.touchlab.skie.oir.type.translation.OirTypeTranslator
 import co.touchlab.skie.phases.oir.util.ExternalApiNotesProvider
 import co.touchlab.skie.sir.SirProvider
-import co.touchlab.skie.sir.SkieNamespaceProvider
+import co.touchlab.skie.sir.ClassNamespaceProvider
+import co.touchlab.skie.sir.SirFileProvider
 import co.touchlab.skie.sir.builtin.SirBuiltins
 import co.touchlab.skie.sir.type.translation.SirTypeTranslator
 import org.jetbrains.kotlin.backend.konan.objcexport.ObjCExportNamer
@@ -25,13 +26,15 @@ interface SirPhase : SkiePhase<SirPhase.Context> {
 
         val sirProvider: SirProvider
 
+        val sirFileProvider: SirFileProvider
+
         val kirBuiltins: KirBuiltins
 
         val oirBuiltins: OirBuiltins
 
         val sirBuiltins: SirBuiltins
 
-        val skieNamespaceProvider: SkieNamespaceProvider
+        val classNamespaceProvider: ClassNamespaceProvider
 
         val externalApiNotesProvider: ExternalApiNotesProvider
 

diff --git a/...ompiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/phases/SkiePhaseScheduler.kt b/...ompiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/phases/SkiePhaseScheduler.kt
@@ -43,7 +43,7 @@ import co.touchlab.skie.phases.other.DeclareMissingSymbolsPhase
 import co.touchlab.skie.phases.other.DeleteSkieFrameworkContentPhase
 import co.touchlab.skie.phases.other.DisableWildcardExportPhase
 import co.touchlab.skie.phases.other.ExtraClassExportPhase
-import co.touchlab.skie.phases.other.FixDuplicatedOverridenFunctionsPhase
+import co.touchlab.skie.phases.other.FixDuplicatedOverriddenFunctionsPhase
 import co.touchlab.skie.phases.other.FixLibrariesShortNamePhase
 import co.touchlab.skie.phases.other.VerifyMinOSVersionPhase
 import co.touchlab.skie.phases.other.VerifyNoBitcodeEmbeddingPhase
@@ -61,9 +61,9 @@ import co.touchlab.skie.phases.sir.type.CreateStableNameTypeAliasesPhase
 import co.touchlab.skie.phases.sir.type.FixNamesOfInaccessibleNestedClassesPhase
 import co.touchlab.skie.phases.sir.type.InitializeSirTypesSuperTypesForOirPhase
 import co.touchlab.skie.phases.swift.CompileSwiftPhase
-import co.touchlab.skie.phases.swift.GenerateSirFileCodePhase
+import co.touchlab.skie.phases.swift.ConvertSirIrFilesToSourceFilesPhase
 import co.touchlab.skie.phases.swift.SwiftCacheSetupPhase
-import co.touchlab.skie.phases.swift.WriteSirFileContentToDiskPhase
+import co.touchlab.skie.phases.swift.ConvertSirSourceFilesToCompilableFilesPhase
 import co.touchlab.skie.phases.typeconflicts.RenameTypesConflictingWithKeywordsPhase
 import co.touchlab.skie.phases.typeconflicts.RenameTypesConflictingWithKotlinModulePhase
 import co.touchlab.skie.phases.typeconflicts.RenameTypesConflictsWithOtherTypesPhase
@@ -145,6 +145,7 @@ class SkiePhaseScheduler {
 
             KotlinRuntimeHidingPhase,
             SwiftRuntimeGenerator,
+            // WIP Load custom files
 
             RenameConflictingCallableDeclarationsPhase,
 
@@ -181,7 +182,7 @@ class SkiePhaseScheduler {
             RenameCallableDeclarationsConflictingWithTypeDeclarationsPhase,
             RenameParametersNamedSelfPhase,
             RenameConflictingCallableDeclarationsPhase,
-            FixDuplicatedOverridenFunctionsPhase,
+            FixDuplicatedOverriddenFunctionsPhase,
             TemporarilyRenameTypesConflictingWithExternalModulesPhase,
             FixOirFunctionSignaturesForApiNotesPhase(context),
             CreateFakeObjCConstructorsPhase,
@@ -195,8 +196,8 @@ class SkiePhaseScheduler {
             ApiNotesGenerationPhase.ForSwiftCompilation,
             FixForwardDeclarationsPhase(context),
             AddTypeDefPhase(context),
-            GenerateSirFileCodePhase,
-            WriteSirFileContentToDiskPhase,
+            ConvertSirIrFilesToSourceFilesPhase,
+            ConvertSirSourceFilesToCompilableFilesPhase,
             GenerateFakeObjCDependenciesPhase,
             DisableWildcardExportPhase,
             SwiftCacheSetupPhase,

diff --git a/.../src/kgp_common/kotlin/co/touchlab/skie/phases/features/enums/ExhaustiveEnumsGenerator.kt b/.../src/kgp_common/kotlin/co/touchlab/skie/phases/features/enums/ExhaustiveEnumsGenerator.kt
@@ -12,8 +12,8 @@ import co.touchlab.skie.phases.util.doInPhase
 import co.touchlab.skie.sir.element.SirClass
 import co.touchlab.skie.sir.element.SirEnumCase
 import co.touchlab.skie.sir.element.SirExtension
-import co.touchlab.skie.sir.element.SirFile
 import co.touchlab.skie.sir.element.SirGetter
+import co.touchlab.skie.sir.element.SirIrFile
 import co.touchlab.skie.sir.element.SirProperty
 import co.touchlab.skie.sir.element.SirScope
 import co.touchlab.skie.sir.element.SirSimpleFunction
@@ -79,9 +79,9 @@ private fun createBridgingEnum(enumKirClass: KirClass): SirClass =
         parent = enumKirClass.originalSirClass.namespace?.let { namespace ->
             sirProvider.getExtension(
                 classDeclaration = namespace.classDeclaration,
-                parent = skieNamespaceProvider.getNamespaceFile(enumKirClass),
+                parent = classNamespaceProvider.getNamespaceFile(enumKirClass),
             )
-        } ?: skieNamespaceProvider.getNamespaceFile(enumKirClass),
+        } ?: classNamespaceProvider.getNamespaceFile(enumKirClass),
         kind = SirClass.Kind.Enum,
     ).apply {
         addEnumCases(enumKirClass)
@@ -146,14 +146,14 @@ private fun SirClass.addCompanionObjectPropertyIfNeeded(enum: KirClass) {
 
 context(SirPhase.Context)
 private fun KirClass.addConversionExtensions(bridgedEnum: SirClass) {
-    skieNamespaceProvider.getNamespaceFile(this).apply {
+    classNamespaceProvider.getNamespaceFile(this).apply {
         addToKotlinConversionExtension(originalSirClass, bridgedEnum)
         addToSwiftConversionExtension(originalSirClass, bridgedEnum)
     }
 }
 
 context(SirPhase.Context)
-private fun SirFile.addToKotlinConversionExtension(enum: SirClass, bridgedEnum: SirClass) {
+private fun SirIrFile.addToKotlinConversionExtension(enum: SirClass, bridgedEnum: SirClass) {
     this.getExtension(
         classDeclaration = bridgedEnum,
     ).apply {
@@ -173,7 +173,7 @@ private fun SirExtension.addToKotlinConversionMethod(enum: SirClass) {
 }
 
 context(SirPhase.Context)
-private fun SirFile.addToSwiftConversionExtension(enum: SirClass, bridgedEnum: SirClass) {
+private fun SirIrFile.addToSwiftConversionExtension(enum: SirClass, bridgedEnum: SirClass) {
     this.getExtension(
         classDeclaration = enum,
     ).apply {
@@ -200,7 +200,7 @@ private fun createStableNameTypeAliasIfRequested(bridgedEnum: SirClass, kirClass
 
     SirTypeAlias(
         baseName = "Enum",
-        parent = skieNamespaceProvider.getNamespace(kirClass),
+        parent = classNamespaceProvider.getNamespace(kirClass),
         visibility = SirVisibility.PublicButReplaced,
     ) {
         bridgedEnum.defaultType.withFqName()

diff --git a/...ommon/kotlin/co/touchlab/skie/phases/features/flow/FlowConversionConstructorsGenerator.kt b/...ommon/kotlin/co/touchlab/skie/phases/features/flow/FlowConversionConstructorsGenerator.kt
@@ -6,7 +6,7 @@ import co.touchlab.skie.sir.element.SirClass
 import co.touchlab.skie.sir.element.SirConditionalConstraint
 import co.touchlab.skie.sir.element.SirConstructor
 import co.touchlab.skie.sir.element.SirExtension
-import co.touchlab.skie.sir.element.SirFile
+import co.touchlab.skie.sir.element.SirIrFile
 import co.touchlab.skie.sir.element.SirSimpleFunction
 import co.touchlab.skie.sir.element.SirTypeParameter
 import co.touchlab.skie.sir.element.SirValueParameter
@@ -28,34 +28,34 @@ class FlowConversionConstructorsGenerator(
 
     context(SirPhase.Context)
     override fun execute() {
-        val file = sirProvider.getSkieNamespaceFile("FlowConversions")
+        val file = sirFileProvider.getIrFileFromSkieNamespace("FlowConversions")
 
         SupportedFlow.values().forEach {
             it.generateAllConversions(file)
         }
     }
 
-    private fun SupportedFlow.generateAllConversions(file: SirFile) {
+    private fun SupportedFlow.generateAllConversions(file: SirIrFile) {
         requiredVariant.generateAllConversions(file)
         optionalVariant.generateAllConversions(file)
     }
 
-    private fun SupportedFlow.Variant.generateAllConversions(file: SirFile) {
+    private fun SupportedFlow.Variant.generateAllConversions(file: SirIrFile) {
         generateAllKotlinClassConversions(this, file)
         generateAllSwiftClassConversions(this, file)
     }
 
-    private fun generateAllKotlinClassConversions(variant: SupportedFlow.Variant, file: SirFile) {
+    private fun generateAllKotlinClassConversions(variant: SupportedFlow.Variant, file: SirIrFile) {
         generateKotlinClassWithAnyObjectConversions(variant, file)
         generateKotlinClassWithBridgeableConversions(variant, file)
     }
 
-    private fun generateAllSwiftClassConversions(variant: SupportedFlow.Variant, file: SirFile) {
+    private fun generateAllSwiftClassConversions(variant: SupportedFlow.Variant, file: SirIrFile) {
         generateSwiftClassWithAnyObjectConversions(variant, file)
         generateSwiftClassWithBridgeableConversions(variant, file)
     }
 
-    private fun generateKotlinClassWithAnyObjectConversions(variant: SupportedFlow.Variant, file: SirFile) {
+    private fun generateKotlinClassWithAnyObjectConversions(variant: SupportedFlow.Variant, file: SirIrFile) {
         file.addConversions(variant) { from ->
             addSwiftToKotlinConversion(
                 from,
@@ -65,7 +65,7 @@ class FlowConversionConstructorsGenerator(
         }
     }
 
-    private fun generateKotlinClassWithBridgeableConversions(variant: SupportedFlow.Variant, file: SirFile) {
+    private fun generateKotlinClassWithBridgeableConversions(variant: SupportedFlow.Variant, file: SirIrFile) {
         file.addConversions(variant) { from ->
             addSwiftToKotlinConversion(
                 from,
@@ -75,7 +75,7 @@ class FlowConversionConstructorsGenerator(
         }
     }
 
-    private fun generateSwiftClassWithAnyObjectConversions(variant: SupportedFlow.Variant, file: SirFile) {
+    private fun generateSwiftClassWithAnyObjectConversions(variant: SupportedFlow.Variant, file: SirIrFile) {
         generateSwiftClassConversions(
             variant,
             file,
@@ -88,7 +88,7 @@ class FlowConversionConstructorsGenerator(
         }
     }
 
-    private fun generateSwiftClassWithBridgeableConversions(variant: SupportedFlow.Variant, file: SirFile) {
+    private fun generateSwiftClassWithBridgeableConversions(variant: SupportedFlow.Variant, file: SirIrFile) {
         generateSwiftClassConversions(
             variant,
             file,
@@ -107,7 +107,7 @@ class FlowConversionConstructorsGenerator(
 
     private fun generateSwiftClassConversions(
         variant: SupportedFlow.Variant,
-        file: SirFile,
+        file: SirIrFile,
         typeBound: SirType,
         bodyFactory: SirExtension.(SirTypeParameter) -> Unit,
     ) {
@@ -143,7 +143,7 @@ class FlowConversionConstructorsGenerator(
             .forEach(action)
     }
 
-    private fun SirFile.addSwiftToKotlinConversion(
+    private fun SirIrFile.addSwiftToKotlinConversion(
         from: SupportedFlow.Variant,
         to: SupportedFlow.Variant,
         typeBound: SirType,

diff --git a/...on/kotlin/co/touchlab/skie/phases/features/functions/FileScopeConversionParentProvider.kt b/...on/kotlin/co/touchlab/skie/phases/features/functions/FileScopeConversionParentProvider.kt
@@ -9,6 +9,7 @@ import co.touchlab.skie.sir.element.SirClass
 import co.touchlab.skie.sir.element.SirDeclarationParent
 import co.touchlab.skie.sir.element.SirExtension
 import co.touchlab.skie.sir.element.SirFile
+import co.touchlab.skie.sir.element.SirIrFile
 import co.touchlab.skie.sir.element.SirSimpleFunction
 import co.touchlab.skie.sir.element.receiverDeclaration
 import co.touchlab.skie.sir.element.resolveAsKirClass
@@ -54,7 +55,7 @@ class FileScopeConversionParentProvider(
         return when (callableDeclaration.origin) {
             KirCallableDeclaration.Origin.Member -> error("Member callable are not supported. Was: $callableDeclaration")
             KirCallableDeclaration.Origin.Extension -> getExtensions(callableDeclaration, sirCallableDeclaration)
-            KirCallableDeclaration.Origin.Global -> context.skieNamespaceProvider.getNamespaceFile(callableDeclaration.owner).let(::listOf)
+            KirCallableDeclaration.Origin.Global -> context.classNamespaceProvider.getNamespaceFile(callableDeclaration.owner).let(::listOf)
         }
     }
 
@@ -99,11 +100,11 @@ class FileScopeConversionParentProvider(
     private fun getExtensionNamespace(
         callableDeclaration: KirCallableDeclaration<*>,
         parentType: SirType,
-    ): SirFile {
+    ): SirIrFile {
         val extensionReceiverKirClass = getExtensionReceiverKirClassIfExists(parentType)
 
-        return extensionReceiverKirClass?.let { context.skieNamespaceProvider.getNamespaceFile(it) }
-            ?: context.skieNamespaceProvider.getNamespaceFile(callableDeclaration.owner)
+        return extensionReceiverKirClass?.let { context.classNamespaceProvider.getNamespaceFile(it) }
+            ?: context.classNamespaceProvider.getNamespaceFile(callableDeclaration.owner)
     }
 
     private fun getExtensionReceiverKirClassIfExists(parentType: SirType): KirClass? =
@@ -114,7 +115,7 @@ class FileScopeConversionParentProvider(
             else -> null
         }
 
-    private fun createNonOptionalExtension(file: SirFile, sirClass: SirClass): SirExtension? =
+    private fun createNonOptionalExtension(file: SirIrFile, sirClass: SirClass): SirExtension? =
         if (sirClass.typeParameters.isEmpty()) {
             sirProvider.getExtension(
                 classDeclaration = sirClass,
@@ -125,6 +126,7 @@ class FileScopeConversionParentProvider(
             null
         }
 
+    @Suppress("UNUSED_PARAMETER")
     private fun getOptionalExtensions(callableDeclaration: KirCallableDeclaration<*>, type: NullableSirType, namespace: SirFile): List<SirExtension> {
 //         val nonNullType = type.type
 //

diff --git a/.../kgp_common/kotlin/co/touchlab/skie/phases/features/sealed/SealedEnumGeneratorDelegate.kt b/.../kgp_common/kotlin/co/touchlab/skie/phases/features/sealed/SealedEnumGeneratorDelegate.kt
@@ -17,7 +17,7 @@ class SealedEnumGeneratorDelegate(
         SirClass(
             baseName = "Sealed",
             kind = SirClass.Kind.Enum,
-            parent = skieNamespaceProvider.getNamespace(kirClass),
+            parent = classNamespaceProvider.getNamespace(kirClass),
             visibility = SirVisibility.PublicButReplaced,
         ).apply {
             addConformanceToHashableIfPossible(kirClass)

diff --git a/..._common/kotlin/co/touchlab/skie/phases/features/sealed/SealedFunctionGeneratorDelegate.kt b/..._common/kotlin/co/touchlab/skie/phases/features/sealed/SealedFunctionGeneratorDelegate.kt
@@ -54,7 +54,7 @@ class SealedFunctionGeneratorDelegate(
     ): SirSimpleFunction =
         SirSimpleFunction(
             identifier = kirClass.enumConstructorFunctionName,
-            parent = context.skieNamespaceProvider.getNamespaceFile(kirClass),
+            parent = context.classNamespaceProvider.getNamespaceFile(kirClass),
             returnType = enum.toTypeFromEnclosingTypeParameters(enum.typeParameters).let(returnTypeModifier),
         ).apply {
             copyTypeParametersFrom(enum)

diff --git a/...c/kgp_common/kotlin/co/touchlab/skie/phases/features/suspend/SkieClassSuspendGenerator.kt b/...c/kgp_common/kotlin/co/touchlab/skie/phases/features/suspend/SkieClassSuspendGenerator.kt
@@ -29,7 +29,7 @@ class SkieClassSuspendGenerator {
     private fun createSkieClass(suspendFunctionOwner: KirClass): SirClass =
         SirClass(
             baseName = "Suspend",
-            parent = skieNamespaceProvider.getNamespace(suspendFunctionOwner),
+            parent = classNamespaceProvider.getNamespace(suspendFunctionOwner),
             visibility = SirVisibility.PublicButReplaced,
             kind = SirClass.Kind.Struct,
         ).apply {
@@ -42,7 +42,7 @@ class SkieClassSuspendGenerator {
     private fun generateNamespaceProvider(suspendFunctionOwner: KirClass, skieClass: SirClass) {
         SirSimpleFunction(
             identifier = "skie",
-            parent = skieNamespaceProvider.getNamespaceFile(suspendFunctionOwner),
+            parent = classNamespaceProvider.getNamespaceFile(suspendFunctionOwner),
             returnType = sirBuiltins.Swift.Void.defaultType,
         ).apply {
             copyTypeParametersFrom(skieClass)

diff --git a/...p_common/kotlin/co/touchlab/skie/phases/features/suspend/SwiftSuspendGeneratorDelegate.kt b/...p_common/kotlin/co/touchlab/skie/phases/features/suspend/SwiftSuspendGeneratorDelegate.kt
@@ -43,7 +43,7 @@ class SwiftSuspendGeneratorDelegate(
 
             val extension = sirProvider.getExtension(
                 classDeclaration = bridgeModel.extensionTypeDeclarationForBridgingFunction,
-                parent = skieNamespaceProvider.getNamespaceFile(bridgeModel.suspendFunctionOwner),
+                parent = classNamespaceProvider.getNamespaceFile(bridgeModel.suspendFunctionOwner),
             )
 
             bridgeModel.suspendKirFunction.bridgedSirFunction = extension.createSwiftBridgingFunction(bridgeModel)