-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix 242 icon loading by providing new key-based API (#430)
* Implement icon keys generator This gradle task generates the icon keys for the platform icons that we'll need to load icons from a key instead of a path. * Define IconIdInterpreter and NewUiChecker * Do icon key generation for AllIcons in ui module * Implement proper key-based icon loading * Remove old TODO and unused code * Undo change to run config * Rename AllIcons to PlatformIcon, move to its own file * Remove unnecessary suppression * Run apiDump * Made icon generation more maintainable (#432) * Made icon generation more maintainable * Cleanup code * Fix ktlint implicitly trying to check generated code --------- Co-authored-by: Sebastiano Poggi <[email protected]> --------- Co-authored-by: Lamberto Basti <[email protected]>
- Loading branch information
Showing
29 changed files
with
2,160 additions
and
78 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,9 +4,6 @@ | |
| .AppleDouble | ||
| .LSOverride | ||
|
|
||
| # Icon must end with two \r | ||
| Icon | ||
|
|
||
| # Thumbnails | ||
| ._* | ||
|
|
||
|
|
||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
333 changes: 333 additions & 0 deletions
333
buildSrc/src/main/kotlin/icon-keys-generator.gradle.kts
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,333 @@ | ||
| @file:Suppress("UnstableApiUsage") | ||
|
|
||
| import com.squareup.kotlinpoet.ClassName | ||
| import com.squareup.kotlinpoet.FileSpec | ||
| import com.squareup.kotlinpoet.PropertySpec | ||
| import com.squareup.kotlinpoet.TypeSpec | ||
| import io.gitlab.arturbosch.detekt.Detekt | ||
| import kotlinx.serialization.json.Json | ||
| import kotlinx.serialization.json.JsonArray | ||
| import kotlinx.serialization.json.JsonElement | ||
| import kotlinx.serialization.json.JsonNull | ||
| import kotlinx.serialization.json.JsonObject | ||
| import kotlinx.serialization.json.JsonPrimitive | ||
| import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension | ||
| import org.jetbrains.kotlin.gradle.tasks.BaseKotlinCompile | ||
| import java.lang.reflect.Field | ||
| import java.net.URLClassLoader | ||
|
|
||
| private val defaultOutputDir: Provider<Directory> = layout.buildDirectory.dir("generated/iconKeys") | ||
|
|
||
| class IconKeysGeneratorContainer( | ||
| container: NamedDomainObjectContainer<IconKeysGeneration>, | ||
| ) : NamedDomainObjectContainer<IconKeysGeneration> by container | ||
|
|
||
| class IconKeysGeneration( | ||
| val name: String, | ||
| project: Project, | ||
| ) { | ||
| val outputDirectory: DirectoryProperty = | ||
| project.objects | ||
| .directoryProperty() | ||
| .convention(defaultOutputDir) | ||
|
|
||
| val sourceClassName: Property<String> = project.objects.property<String>() | ||
| val generatedClassName: Property<String> = project.objects.property<String>() | ||
| } | ||
|
|
||
| val iconGeneration by configurations.registering { | ||
| isCanBeConsumed = false | ||
| isCanBeResolved = true | ||
| } | ||
|
|
||
| val extension = IconKeysGeneratorContainer(container<IconKeysGeneration> { IconKeysGeneration(it, project) }) | ||
|
|
||
| extensions.add("intelliJIconKeysGenerator", extension) | ||
|
|
||
| extension.all item@{ | ||
| val task = | ||
| tasks.register<IconKeysGeneratorTask>("generate${name}Keys") task@{ | ||
| this@task.outputDirectory = this@item.outputDirectory | ||
| this@task.sourceClassName = this@item.sourceClassName | ||
| this@task.generatedClassName = this@item.generatedClassName | ||
| configuration.from(iconGeneration) | ||
| dependsOn(iconGeneration) | ||
| } | ||
|
|
||
| tasks { | ||
| withType<BaseKotlinCompile> { dependsOn(task) } | ||
| withType<Detekt> { dependsOn(task) } | ||
| } | ||
| } | ||
|
|
||
| pluginManager.withPlugin("org.jetbrains.kotlin.jvm") { | ||
| the<KotlinJvmProjectExtension>() | ||
| .sourceSets["main"] | ||
| .kotlin | ||
| .srcDir(defaultOutputDir) | ||
| } | ||
|
|
||
| open class IconKeysGeneratorTask : DefaultTask() { | ||
|
|
||
| @get:OutputDirectory | ||
| val outputDirectory: DirectoryProperty = project.objects.directoryProperty() | ||
|
|
||
| @get:Input | ||
| val sourceClassName = project.objects.property<String>() | ||
|
|
||
| @get:Input | ||
| val generatedClassName = project.objects.property<String>() | ||
|
|
||
| @get:InputFiles | ||
| val configuration: ConfigurableFileCollection = project.objects.fileCollection() | ||
|
|
||
| init { | ||
| group = "jewel" | ||
| } | ||
|
|
||
| @TaskAction | ||
| fun generate() { | ||
| val guessedSourceClassName = sourceClassName | ||
| .map { ClassName.bestGuess(it).canonicalName.replace('.', '/') + ".kt" } | ||
| .get() | ||
|
|
||
| // The icons artifacts are loaded on the iconGeneration configuration's classpath, | ||
| // so we need a classloader that can access these classes. | ||
| val classLoader = createClassLoader() | ||
| val sourceClass = classLoader.loadClass(sourceClassName.get()) | ||
| ?: throw GradleException( | ||
| "Unable to load ${sourceClassName.get()}. " + | ||
| "Is the correct dependency declared on the iconGeneration configuration?" | ||
| ) | ||
|
|
||
| // Step 1) load icon mappings from JSON | ||
| val mappingsJsonBytes = | ||
| classLoader.getResourceAsStream("PlatformIconMappings.json") | ||
| ?.use { it.readAllBytes() } | ||
| ?: error("Icon mapping JSON not found") | ||
|
|
||
| val iconMappingJson = | ||
| json.parseToJsonElement(mappingsJsonBytes.decodeToString()) | ||
|
|
||
| // Step 2) Transform mappings to a map oldPath -> newPath | ||
| val iconMapping = readIconMappingJson(iconMappingJson) | ||
| logger.lifecycle("Icon mapping JSON read. It has ${iconMapping.size} entries") | ||
|
|
||
| // Step 3) Traverse sourceClass by using reflection, collecting all members | ||
| // This step uses the mappings to add the new paths where available. | ||
| val dummyIconClass = classLoader.loadClass("com.intellij.ui.DummyIconImpl") | ||
| val pathField = dummyIconClass.getPathField() | ||
|
|
||
| val rootHolder = IconKeyHolder(sourceClass.simpleName) | ||
| pathField.whileForcingAccessible { | ||
| visitSourceClass(sourceClass, iconMapping, rootHolder, pathField, classLoader) | ||
| } | ||
| logger.lifecycle("Read icon keys from ${sourceClass.name}") | ||
|
|
||
| // Step 4) Generate output Kotlin file | ||
| val fileSpec = generateKotlinCode(rootHolder) | ||
| val directory = outputDirectory.get().asFile | ||
| fileSpec.writeTo(directory) | ||
|
|
||
| logger.lifecycle("Written icon keys for $guessedSourceClassName into $directory") | ||
| } | ||
|
|
||
| private fun createClassLoader(): URLClassLoader { | ||
| val arrayOfURLs = configuration.files | ||
| .map { it.toURI().toURL() } | ||
| .toTypedArray() | ||
|
|
||
| return URLClassLoader( | ||
| arrayOfURLs, | ||
| IconKeysGeneratorTask::class.java.classLoader | ||
| ) | ||
| } | ||
|
|
||
| private fun readIconMappingJson(rawMapping: JsonElement): Map<String, String> { | ||
| val flattenedMappings = mutableMapOf<String, Set<String>>() | ||
|
|
||
| visitMapping(oldUiPath = "", node = rawMapping, map = flattenedMappings) | ||
|
|
||
| return flattenedMappings | ||
| .flatMap { (newPath, oldPaths) -> | ||
| oldPaths.map { oldPath -> oldPath to newPath } | ||
| }.toMap() | ||
| } | ||
|
|
||
| private fun visitMapping( | ||
| oldUiPath: String, | ||
| node: JsonElement, | ||
| map: MutableMap<String, Set<String>>, | ||
| ) { | ||
| when (node) { | ||
| is JsonPrimitive -> { | ||
| if (!node.isString) return | ||
| map[oldUiPath] = setOf(node.content) | ||
| } | ||
|
|
||
| is JsonArray -> { | ||
| map[oldUiPath] = | ||
| node | ||
| .filterIsInstance<JsonPrimitive>() | ||
| .filter { child -> child.isString } | ||
| .map { it.content } | ||
| .toSet() | ||
| } | ||
|
|
||
| is JsonObject -> { | ||
| for ((key, value) in node.entries) { | ||
| val childOldPath = if (oldUiPath.isNotEmpty()) "$oldUiPath/$key" else key | ||
| visitMapping(oldUiPath = childOldPath, node = value, map = map) | ||
| } | ||
| } | ||
|
|
||
| JsonNull -> error("Null nodes not supported") | ||
| } | ||
| } | ||
|
|
||
| private fun Field.whileForcingAccessible(action: () -> Unit) { | ||
| @Suppress("DEPRECATION") | ||
| val wasAccessible = isAccessible | ||
| isAccessible = true | ||
| try { | ||
| action() | ||
| } finally { | ||
| isAccessible = wasAccessible | ||
| } | ||
| } | ||
|
|
||
| private fun visitSourceClass( | ||
| sourceClass: Class<*>, | ||
| iconMappings: Map<String, String>, | ||
| parentHolder: IconKeyHolder, | ||
| pathField: Field, | ||
| classLoader: ClassLoader, | ||
| ) { | ||
| for (child in sourceClass.declaredClasses) { | ||
| val childName = "${parentHolder.name}.${child.simpleName}" | ||
| val childHolder = IconKeyHolder(childName) | ||
| parentHolder.holders += childHolder | ||
| visitSourceClass(child, iconMappings, childHolder, pathField, classLoader) | ||
| } | ||
| parentHolder.holders.sortBy { it.name } | ||
|
|
||
| sourceClass.declaredFields | ||
| .filter { it.type == javax.swing.Icon::class.java } | ||
| .forEach { field -> | ||
| val fieldName = "${parentHolder.name}.${field.name}" | ||
|
|
||
| if (field.annotations.isNotEmpty()) { | ||
| logger.lifecycle( | ||
| "$fieldName -> ${field.annotations.joinToString { it!!.annotationClass.qualifiedName!! }}", | ||
| ) | ||
| } | ||
|
|
||
| if (field.annotations.any { it.annotationClass == java.lang.Deprecated::class }) { | ||
| logger.lifecycle("Ignoring deprecated field: $fieldName") | ||
| return | ||
| } | ||
|
|
||
| val icon = field.get(sourceClass) | ||
| val oldPath = pathField.get(icon) as String | ||
|
|
||
| val newPath = iconMappings[oldPath] | ||
| validatePath(oldPath, fieldName, classLoader) | ||
| newPath?.let { validatePath(it, fieldName, classLoader) } | ||
| parentHolder.keys += IconKey(fieldName, oldPath, newPath) | ||
| } | ||
| parentHolder.keys.sortBy { it.name } | ||
| } | ||
|
|
||
| private fun validatePath( | ||
| path: String, | ||
| fieldName: String, | ||
| classLoader: ClassLoader, | ||
| ) { | ||
| val iconsClass = classLoader.loadClass(sourceClassName.get()) | ||
| if (iconsClass.getResourceAsStream("/${path.trimStart('/')}") == null) { | ||
| logger.warn("Icon $fieldName: '$path' does not exist") | ||
| } | ||
| } | ||
|
|
||
| private fun generateKotlinCode(rootHolder: IconKeyHolder): FileSpec { | ||
| val className = ClassName.bestGuess(generatedClassName.get()) | ||
|
|
||
| return FileSpec | ||
| .builder(className) | ||
| .apply { | ||
| indent(" ") | ||
| addFileComment("Generated by the Jewel icon keys generator\n") | ||
| addFileComment("Source class: ${sourceClassName.get()}") | ||
|
|
||
| addImport(keyClassName.packageName, keyClassName.simpleName) | ||
|
|
||
| val objectName = ClassName.bestGuess(generatedClassName.get()) | ||
| addType( | ||
| TypeSpec | ||
| .objectBuilder(objectName) | ||
| .apply { | ||
| for (childHolder in rootHolder.holders) { | ||
| generateKotlinCodeInner(childHolder) | ||
| } | ||
|
|
||
| for (key in rootHolder.keys) { | ||
| addProperty( | ||
| PropertySpec | ||
| .builder(key.name.substringAfterLast('.'), keyClassName) | ||
| .initializer( | ||
| "%L", | ||
| """IntelliJIconKey("${key.oldPath}", "${key.newPath ?: key.oldPath}")""", | ||
| ).build(), | ||
| ) | ||
| } | ||
| }.build(), | ||
| ) | ||
| }.build() | ||
| } | ||
|
|
||
| private fun TypeSpec.Builder.generateKotlinCodeInner(holder: IconKeyHolder) { | ||
| val objectName = holder.name.substringAfterLast('.') | ||
| addType( | ||
| TypeSpec | ||
| .objectBuilder(objectName) | ||
| .apply { | ||
| for (childHolder in holder.holders) { | ||
| generateKotlinCodeInner(childHolder) | ||
| } | ||
|
|
||
| for (key in holder.keys) { | ||
| addProperty( | ||
| PropertySpec | ||
| .builder(key.name.substringAfterLast('.'), keyClassName) | ||
| .initializer( | ||
| "%L", | ||
| """IntelliJIconKey("${key.oldPath}", "${key.newPath ?: key.oldPath}")""" | ||
| ) | ||
| .build(), | ||
| ) | ||
| } | ||
| }.build(), | ||
| ) | ||
| } | ||
|
|
||
| companion object { | ||
|
|
||
| private fun Class<*>.getPathField(): Field = declaredFields.first { it.name == "path" } | ||
|
|
||
| private val keyClassName = ClassName("org.jetbrains.jewel.ui.icon", "IntelliJIconKey") | ||
|
|
||
| private val json = Json { isLenient = true } | ||
| } | ||
| } | ||
|
|
||
| private data class IconKeyHolder( | ||
| val name: String, | ||
| val holders: MutableList<IconKeyHolder> = mutableListOf(), | ||
| val keys: MutableList<IconKey> = mutableListOf(), | ||
| ) | ||
|
|
||
| private data class IconKey( | ||
| val name: String, | ||
| val oldPath: String, | ||
| val newPath: String?, | ||
| ) |
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
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
Oops, something went wrong.