-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support source set's hierarchy for compose resources (#4589)
Compose resources can be located in different KMP source sets in the `composeResources` directory. For each resource an accessor will be generated in the suitable kotlin source set.
- Loading branch information
Showing
39 changed files
with
714 additions
and
365 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
...ins/compose/src/main/kotlin/org/jetbrains/compose/resources/ComposeResourcesGeneration.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| package org.jetbrains.compose.resources | ||
|
|
||
| import org.gradle.api.Project | ||
| import org.gradle.api.provider.Provider | ||
| import org.jetbrains.compose.ComposePlugin | ||
| import org.jetbrains.compose.internal.utils.uppercaseFirstChar | ||
| import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension | ||
| import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet | ||
| import java.io.File | ||
|
|
||
| internal fun Project.configureComposeResourcesGeneration( | ||
| kotlinExtension: KotlinProjectExtension, | ||
| resClassSourceSetName: String, | ||
| config: Provider<ResourcesExtension>, | ||
| generateModulePath: Boolean | ||
| ) { | ||
| logger.info("Configure compose resources generation") | ||
|
|
||
| //lazy check a dependency on the Resources library | ||
| val shouldGenerateCode = config.map { | ||
| when (it.generateResClass) { | ||
| ResourcesExtension.ResourceClassGeneration.Auto -> { | ||
| configurations.run { | ||
| val commonSourceSet = kotlinExtension.sourceSets.getByName(resClassSourceSetName) | ||
| //because the implementation configuration doesn't extend the api in the KGP ¯\_(ツ)_/¯ | ||
| getByName(commonSourceSet.implementationConfigurationName).allDependencies + | ||
| getByName(commonSourceSet.apiConfigurationName).allDependencies | ||
| }.any { dep -> | ||
| val depStringNotation = dep.let { "${it.group}:${it.name}:${it.version}" } | ||
| depStringNotation == ComposePlugin.CommonComponentsDependencies.resources | ||
| } | ||
| } | ||
|
|
||
| ResourcesExtension.ResourceClassGeneration.Always -> true | ||
| ResourcesExtension.ResourceClassGeneration.Never -> false | ||
| } | ||
| } | ||
| val packageName = config.getResourcePackage(project) | ||
| val makeAccessorsPublic = config.map { it.publicResClass } | ||
| val packagingDir = config.getModuleResourcesDir(project) | ||
|
|
||
| kotlinExtension.sourceSets.all { sourceSet -> | ||
| if (sourceSet.name == resClassSourceSetName) { | ||
| configureResClassGeneration( | ||
| sourceSet, | ||
| shouldGenerateCode, | ||
| packageName, | ||
| makeAccessorsPublic, | ||
| packagingDir, | ||
| generateModulePath | ||
| ) | ||
| } | ||
|
|
||
| //common resources must be converted (XML -> CVR) | ||
| val preparedResourcesTask = registerPrepareComposeResourcesTask(sourceSet) | ||
| val preparedResources = preparedResourcesTask.flatMap { it.outputDir.asFile } | ||
| configureResourceAccessorsGeneration( | ||
| sourceSet, | ||
| preparedResources, | ||
| shouldGenerateCode, | ||
| packageName, | ||
| makeAccessorsPublic, | ||
| packagingDir, | ||
| generateModulePath | ||
| ) | ||
| } | ||
|
|
||
| //setup task execution during IDE import | ||
| tasks.configureEach { importTask -> | ||
| if (importTask.name == "prepareKotlinIdeaImport") { | ||
| importTask.dependsOn(tasks.withType(CodeGenerationTask::class.java)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun Project.configureResClassGeneration( | ||
| resClassSourceSet: KotlinSourceSet, | ||
| shouldGenerateCode: Provider<Boolean>, | ||
| packageName: Provider<String>, | ||
| makeAccessorsPublic: Provider<Boolean>, | ||
| packagingDir: Provider<File>, | ||
| generateModulePath: Boolean | ||
| ) { | ||
| logger.info("Configure Res class generation for ${resClassSourceSet.name}") | ||
|
|
||
| val genTask = tasks.register( | ||
| "generateComposeResClass", | ||
| GenerateResClassTask::class.java | ||
| ) { task -> | ||
| task.packageName.set(packageName) | ||
| task.shouldGenerateCode.set(shouldGenerateCode) | ||
| task.makeAccessorsPublic.set(makeAccessorsPublic) | ||
| task.codeDir.set(layout.buildDirectory.dir("$RES_GEN_DIR/kotlin/commonResClass")) | ||
|
|
||
| if (generateModulePath) { | ||
| task.packagingDir.set(packagingDir) | ||
| } | ||
| } | ||
|
|
||
| //register generated source set | ||
| resClassSourceSet.kotlin.srcDir(genTask.map { it.codeDir }) | ||
| } | ||
|
|
||
| private fun Project.configureResourceAccessorsGeneration( | ||
| sourceSet: KotlinSourceSet, | ||
| resourcesDir: Provider<File>, | ||
| shouldGenerateCode: Provider<Boolean>, | ||
| packageName: Provider<String>, | ||
| makeAccessorsPublic: Provider<Boolean>, | ||
| packagingDir: Provider<File>, | ||
| generateModulePath: Boolean | ||
| ) { | ||
| logger.info("Configure resource accessors generation for ${sourceSet.name}") | ||
|
|
||
| val genTask = tasks.register( | ||
| "generateResourceAccessorsFor${sourceSet.name.uppercaseFirstChar()}", | ||
| GenerateResourceAccessorsTask::class.java | ||
| ) { task -> | ||
| task.packageName.set(packageName) | ||
| task.sourceSetName.set(sourceSet.name) | ||
| task.shouldGenerateCode.set(shouldGenerateCode) | ||
| task.makeAccessorsPublic.set(makeAccessorsPublic) | ||
| task.resDir.set(resourcesDir) | ||
| task.codeDir.set(layout.buildDirectory.dir("$RES_GEN_DIR/kotlin/${sourceSet.name}ResourceAccessors")) | ||
|
|
||
| if (generateModulePath) { | ||
| task.packagingDir.set(packagingDir) | ||
| } | ||
| } | ||
|
|
||
| //register generated source set | ||
| sourceSet.kotlin.srcDir(genTask.map { it.codeDir }) | ||
| } |
Oops, something went wrong.