Improve IconKey API to include a classloader (#507)

This prevents issues when running in release-mode IDEs, where providing a classloader is mandatory to successfully load icons. The icon keys generator script has also been updated to include the class in each entry. This has been tested in standalone, in the normal IDE sample mode, and as a built plugin in a release-mode IDE.
JetBrains · Jul 31, 2024 · cde0289 · cde0289
1 parent dae048c
commit cde0289
Show file tree

Hide file tree

Showing 21 changed files with 261 additions and 134 deletions.
diff --git a/buildSrc/src/main/kotlin/icon-keys-generator.gradle.kts b/buildSrc/src/main/kotlin/icon-keys-generator.gradle.kts
@@ -216,49 +216,48 @@ open class IconKeysGeneratorTask : DefaultTask() {
                         .objectBuilder(objectName)
                         .apply {
                             for (childHolder in rootHolder.holders) {
-                                generateKotlinCodeInner(childHolder)
+                                generateKotlinCodeInner(childHolder, className)
                             }
 
                             for (key in rootHolder.keys) {
-                                addProperty(
-                                    PropertySpec
-                                        .builder(key.name.substringAfterLast('.'), keyClassName)
-                                        .initializer(
-                                            "%L",
-                                            """IntelliJIconKey("${key.oldPath}", "${key.newPath ?: key.oldPath}")""",
-                                        ).build(),
-                                )
+                                addProperty(buildIconKeyEntry(key, className))
                             }
                         }.build(),
                 )
             }.build()
     }
 
-    private fun TypeSpec.Builder.generateKotlinCodeInner(holder: IconKeyHolder) {
+    private fun TypeSpec.Builder.generateKotlinCodeInner(holder: IconKeyHolder, rootClassName: ClassName) {
         val objectName = holder.name.substringAfterLast('.')
         addType(
             TypeSpec
                 .objectBuilder(objectName)
                 .apply {
                     for (childHolder in holder.holders) {
-                        generateKotlinCodeInner(childHolder)
+                        generateKotlinCodeInner(childHolder, rootClassName)
                     }
 
                     for (key in holder.keys) {
-                        addProperty(
-                            PropertySpec
-                                .builder(key.name.substringAfterLast('.'), keyClassName)
-                                .initializer(
-                                    "%L",
-                                    """IntelliJIconKey("${key.oldPath}", "${key.newPath ?: key.oldPath}")"""
-                                )
-                                .build(),
-                        )
+                        addProperty(buildIconKeyEntry(key, rootClassName))
                     }
                 }.build(),
         )
     }
 
+    private fun buildIconKeyEntry(
+        key: IconKey,
+        rootClassName: ClassName,
+    ) =
+        PropertySpec
+            .builder(key.name.substringAfterLast('.'), keyClassName)
+            .initializer(
+                "%L",
+                "IntelliJIconKey(\"${key.oldPath}\", " +
+                    "\"${key.newPath ?: key.oldPath}\", " +
+                    "${rootClassName.simpleName}::class.java)",
+            )
+            .build()
+
     companion object {
 
         private fun Class<*>.getOriginalPathField(): Field = declaredFields.first { it.name == "originalPath" }

diff --git a/ide-laf-bridge/api/ide-laf-bridge.api b/ide-laf-bridge/api/ide-laf-bridge.api
@@ -89,7 +89,8 @@ public final class org/jetbrains/jewel/bridge/actionSystem/ProvideDataKt {
 }
 
 public final class org/jetbrains/jewel/bridge/icon/IntelliJIconKeyKt {
-	public static final fun fromPlatformIcon (Lorg/jetbrains/jewel/ui/icon/IntelliJIconKey$Companion;Ljavax/swing/Icon;)Lorg/jetbrains/jewel/ui/icon/IconKey;
+	public static final fun fromPlatformIcon (Lorg/jetbrains/jewel/ui/icon/IntelliJIconKey$Companion;Ljavax/swing/Icon;Ljava/lang/Class;)Lorg/jetbrains/jewel/ui/icon/IconKey;
+	public static synthetic fun fromPlatformIcon$default (Lorg/jetbrains/jewel/ui/icon/IntelliJIconKey$Companion;Ljavax/swing/Icon;Ljava/lang/Class;ILjava/lang/Object;)Lorg/jetbrains/jewel/ui/icon/IconKey;
 }
 
 public final class org/jetbrains/jewel/bridge/theme/BridgeGlobalColorsKt {

diff --git a/ide-laf-bridge/src/main/kotlin/org/jetbrains/jewel/bridge/icon/IntelliJIconKey.kt b/ide-laf-bridge/src/main/kotlin/org/jetbrains/jewel/bridge/icon/IntelliJIconKey.kt
@@ -4,7 +4,10 @@ import com.intellij.ui.icons.IconPathProvider
 import org.jetbrains.jewel.ui.icon.IconKey
 import org.jetbrains.jewel.ui.icon.IntelliJIconKey
 
-public fun IntelliJIconKey.Companion.fromPlatformIcon(icon: javax.swing.Icon): IconKey {
+public fun IntelliJIconKey.Companion.fromPlatformIcon(
+    icon: javax.swing.Icon,
+    iconClass: Class<*> = icon::class.java,
+): IconKey {
     check(icon is IconPathProvider) {
         "Only icons implementing IconPathsProvider are supported (e.g., coming from AllIcons)"
     }
@@ -15,5 +18,5 @@ public fun IntelliJIconKey.Companion.fromPlatformIcon(icon: javax.swing.Icon): I
         }
 
     val newUiPath = icon.expUIPath ?: oldUiPath
-    return IntelliJIconKey(oldUiPath, newUiPath)
+    return IntelliJIconKey(oldUiPath, newUiPath, iconClass)
 }
diff --git a/ide-laf-bridge/src/main/kotlin/org/jetbrains/jewel/bridge/theme/IntUiBridge.kt b/ide-laf-bridge/src/main/kotlin/org/jetbrains/jewel/bridge/theme/IntUiBridge.kt
@@ -372,7 +372,7 @@ private fun readCheckboxStyle(): CheckboxStyle {
                 outlineSelectedFocusedSize = metrics.outlineSelectedFocusedSize,
                 iconContentGap = metrics.iconContentGap,
             ),
-        icons = CheckboxIcons(checkbox = PathIconKey("${iconsBasePath}checkBox.svg")),
+        icons = CheckboxIcons(checkbox = PathIconKey("${iconsBasePath}checkBox.svg", CheckboxIcons::class.java)),
     )
 }
 
@@ -776,7 +776,7 @@ private fun readRadioButtonStyle(): RadioButtonStyle {
                     retrieveIntAsDpOrUnspecified("RadioButton.textIconGap")
                         .takeOrElse { metrics.iconContentGap },
             ),
-        icons = RadioButtonIcons(radioButton = PathIconKey("${iconsBasePath}radio.svg")),
+        icons = RadioButtonIcons(radioButton = PathIconKey("${iconsBasePath}radio.svg", RadioButtonIcons::class.java)),
     )
 }
 

diff --git a/...lone/src/main/kotlin/org/jetbrains/jewel/intui/standalone/styling/IntUiCheckboxStyling.kt b/...lone/src/main/kotlin/org/jetbrains/jewel/intui/standalone/styling/IntUiCheckboxStyling.kt
@@ -69,9 +69,19 @@ public fun CheckboxMetrics.Companion.defaults(
     )
 
 @Composable
-public fun CheckboxIcons.Companion.light(checkbox: IconKey = PathIconKey("com/intellij/ide/ui/laf/icons/intellij/checkBox.svg")): CheckboxIcons =
-    CheckboxIcons(checkbox)
+public fun CheckboxIcons.Companion.light(
+    checkbox: IconKey =
+        PathIconKey(
+            path = "com/intellij/ide/ui/laf/icons/intellij/checkBox.svg",
+            iconClass = CheckboxIcons::class.java,
+        ),
+): CheckboxIcons = CheckboxIcons(checkbox)
 
 @Composable
-public fun CheckboxIcons.Companion.dark(checkbox: IconKey = PathIconKey("com/intellij/ide/ui/laf/icons/darcula/checkBox.svg")): CheckboxIcons =
-    CheckboxIcons(checkbox)
+public fun CheckboxIcons.Companion.dark(
+    checkbox: IconKey =
+        PathIconKey(
+            path = "com/intellij/ide/ui/laf/icons/darcula/checkBox.svg",
+            iconClass = CheckboxIcons::class.java,
+        ),
+): CheckboxIcons = CheckboxIcons(checkbox)
diff --git a/...e/src/main/kotlin/org/jetbrains/jewel/intui/standalone/styling/IntUiRadioButtonStyling.kt b/...e/src/main/kotlin/org/jetbrains/jewel/intui/standalone/styling/IntUiRadioButtonStyling.kt
@@ -82,8 +82,17 @@ public fun RadioButtonMetrics.Companion.defaults(
     )
 
 public fun RadioButtonIcons.Companion.light(
-    radioButton: IconKey = PathIconKey("com/intellij/ide/ui/laf/icons/intellij/radio.svg"),
+    radioButton: IconKey =
+        PathIconKey(
+            path = "com/intellij/ide/ui/laf/icons/intellij/radio.svg",
+            iconClass = RadioButtonIcons::class.java,
+        ),
 ): RadioButtonIcons = RadioButtonIcons(radioButton)
 
-public fun RadioButtonIcons.Companion.dark(radioButton: IconKey = PathIconKey("com/intellij/ide/ui/laf/icons/darcula/radio.svg")): RadioButtonIcons =
-    RadioButtonIcons(radioButton)
+public fun RadioButtonIcons.Companion.dark(
+    radioButton: IconKey =
+        PathIconKey(
+            path = "com/intellij/ide/ui/laf/icons/darcula/radio.svg",
+            iconClass = RadioButtonIcons::class.java,
+        ),
+): RadioButtonIcons = RadioButtonIcons(radioButton)
diff --git a/markdown/extension/gfm-alerts/api/gfm-alerts.api b/markdown/extension/gfm-alerts/api/gfm-alerts.api
@@ -86,23 +86,23 @@ public abstract interface class org/jetbrains/jewel/markdown/extensions/github/a
 	public abstract fun getPathEffect ()Landroidx/compose/ui/graphics/PathEffect;
 	public abstract fun getStrokeCap-KaPHkGw ()I
 	public abstract fun getTextColor-0d7_KjU ()J
-	public abstract fun getTitleIconPath ()Ljava/lang/String;
+	public abstract fun getTitleIconKey ()Lorg/jetbrains/jewel/ui/icon/IconKey;
 	public abstract fun getTitleIconTint-0d7_KjU ()J
 	public abstract fun getTitleTextStyle ()Landroidx/compose/ui/text/TextStyle;
 }
 
 public final class org/jetbrains/jewel/markdown/extensions/github/alerts/CautionAlertStyling : org/jetbrains/jewel/markdown/extensions/github/alerts/BaseAlertStyling {
 	public static final field $stable I
 	public static final field Companion Lorg/jetbrains/jewel/markdown/extensions/github/alerts/CautionAlertStyling$Companion;
-	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Ljava/lang/String;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Lorg/jetbrains/jewel/ui/icon/IconKey;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun equals (Ljava/lang/Object;)Z
 	public fun getLineColor-0d7_KjU ()J
 	public fun getLineWidth-D9Ej5fM ()F
 	public fun getPadding ()Landroidx/compose/foundation/layout/PaddingValues;
 	public fun getPathEffect ()Landroidx/compose/ui/graphics/PathEffect;
 	public fun getStrokeCap-KaPHkGw ()I
 	public fun getTextColor-0d7_KjU ()J
-	public fun getTitleIconPath ()Ljava/lang/String;
+	public fun getTitleIconKey ()Lorg/jetbrains/jewel/ui/icon/IconKey;
 	public fun getTitleIconTint-0d7_KjU ()J
 	public fun getTitleTextStyle ()Landroidx/compose/ui/text/TextStyle;
 	public fun hashCode ()I
@@ -119,6 +119,16 @@ public final class org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubA
 	public fun render (Lorg/jetbrains/jewel/markdown/MarkdownBlock$CustomBlock;Lorg/jetbrains/jewel/markdown/rendering/MarkdownBlockRenderer;Lorg/jetbrains/jewel/markdown/rendering/InlineMarkdownRenderer;ZLkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function0;Landroidx/compose/runtime/Composer;I)V
 }
 
+public final class org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertIcons {
+	public static final field $stable I
+	public static final field INSTANCE Lorg/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertIcons;
+	public final fun getCaution ()Lorg/jetbrains/jewel/ui/icon/IconKey;
+	public final fun getImportant ()Lorg/jetbrains/jewel/ui/icon/IconKey;
+	public final fun getNote ()Lorg/jetbrains/jewel/ui/icon/IconKey;
+	public final fun getTip ()Lorg/jetbrains/jewel/ui/icon/IconKey;
+	public final fun getWarning ()Lorg/jetbrains/jewel/ui/icon/IconKey;
+}
+
 public final class org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertProcessorExtension : org/jetbrains/jewel/markdown/extensions/MarkdownProcessorExtension {
 	public static final field $stable I
 	public static final field INSTANCE Lorg/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertProcessorExtension;
@@ -138,15 +148,15 @@ public final class org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubA
 public final class org/jetbrains/jewel/markdown/extensions/github/alerts/ImportantAlertStyling : org/jetbrains/jewel/markdown/extensions/github/alerts/BaseAlertStyling {
 	public static final field $stable I
 	public static final field Companion Lorg/jetbrains/jewel/markdown/extensions/github/alerts/ImportantAlertStyling$Companion;
-	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Ljava/lang/String;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Lorg/jetbrains/jewel/ui/icon/IconKey;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun equals (Ljava/lang/Object;)Z
 	public fun getLineColor-0d7_KjU ()J
 	public fun getLineWidth-D9Ej5fM ()F
 	public fun getPadding ()Landroidx/compose/foundation/layout/PaddingValues;
 	public fun getPathEffect ()Landroidx/compose/ui/graphics/PathEffect;
 	public fun getStrokeCap-KaPHkGw ()I
 	public fun getTextColor-0d7_KjU ()J
-	public fun getTitleIconPath ()Ljava/lang/String;
+	public fun getTitleIconKey ()Lorg/jetbrains/jewel/ui/icon/IconKey;
 	public fun getTitleIconTint-0d7_KjU ()J
 	public fun getTitleTextStyle ()Landroidx/compose/ui/text/TextStyle;
 	public fun hashCode ()I
@@ -159,15 +169,15 @@ public final class org/jetbrains/jewel/markdown/extensions/github/alerts/Importa
 public final class org/jetbrains/jewel/markdown/extensions/github/alerts/NoteAlertStyling : org/jetbrains/jewel/markdown/extensions/github/alerts/BaseAlertStyling {
 	public static final field $stable I
 	public static final field Companion Lorg/jetbrains/jewel/markdown/extensions/github/alerts/NoteAlertStyling$Companion;
-	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Ljava/lang/String;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Lorg/jetbrains/jewel/ui/icon/IconKey;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun equals (Ljava/lang/Object;)Z
 	public fun getLineColor-0d7_KjU ()J
 	public fun getLineWidth-D9Ej5fM ()F
 	public fun getPadding ()Landroidx/compose/foundation/layout/PaddingValues;
 	public fun getPathEffect ()Landroidx/compose/ui/graphics/PathEffect;
 	public fun getStrokeCap-KaPHkGw ()I
 	public fun getTextColor-0d7_KjU ()J
-	public fun getTitleIconPath ()Ljava/lang/String;
+	public fun getTitleIconKey ()Lorg/jetbrains/jewel/ui/icon/IconKey;
 	public fun getTitleIconTint-0d7_KjU ()J
 	public fun getTitleTextStyle ()Landroidx/compose/ui/text/TextStyle;
 	public fun hashCode ()I
@@ -180,15 +190,15 @@ public final class org/jetbrains/jewel/markdown/extensions/github/alerts/NoteAle
 public final class org/jetbrains/jewel/markdown/extensions/github/alerts/TipAlertStyling : org/jetbrains/jewel/markdown/extensions/github/alerts/BaseAlertStyling {
 	public static final field $stable I
 	public static final field Companion Lorg/jetbrains/jewel/markdown/extensions/github/alerts/TipAlertStyling$Companion;
-	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Ljava/lang/String;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Lorg/jetbrains/jewel/ui/icon/IconKey;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun equals (Ljava/lang/Object;)Z
 	public fun getLineColor-0d7_KjU ()J
 	public fun getLineWidth-D9Ej5fM ()F
 	public fun getPadding ()Landroidx/compose/foundation/layout/PaddingValues;
 	public fun getPathEffect ()Landroidx/compose/ui/graphics/PathEffect;
 	public fun getStrokeCap-KaPHkGw ()I
 	public fun getTextColor-0d7_KjU ()J
-	public fun getTitleIconPath ()Ljava/lang/String;
+	public fun getTitleIconKey ()Lorg/jetbrains/jewel/ui/icon/IconKey;
 	public fun getTitleIconTint-0d7_KjU ()J
 	public fun getTitleTextStyle ()Landroidx/compose/ui/text/TextStyle;
 	public fun hashCode ()I
@@ -201,15 +211,15 @@ public final class org/jetbrains/jewel/markdown/extensions/github/alerts/TipAler
 public final class org/jetbrains/jewel/markdown/extensions/github/alerts/WarningAlertStyling : org/jetbrains/jewel/markdown/extensions/github/alerts/BaseAlertStyling {
 	public static final field $stable I
 	public static final field Companion Lorg/jetbrains/jewel/markdown/extensions/github/alerts/WarningAlertStyling$Companion;
-	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Ljava/lang/String;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (Landroidx/compose/foundation/layout/PaddingValues;FJLandroidx/compose/ui/graphics/PathEffect;ILandroidx/compose/ui/text/TextStyle;Lorg/jetbrains/jewel/ui/icon/IconKey;JJLkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun equals (Ljava/lang/Object;)Z
 	public fun getLineColor-0d7_KjU ()J
 	public fun getLineWidth-D9Ej5fM ()F
 	public fun getPadding ()Landroidx/compose/foundation/layout/PaddingValues;
 	public fun getPathEffect ()Landroidx/compose/ui/graphics/PathEffect;
 	public fun getStrokeCap-KaPHkGw ()I
 	public fun getTextColor-0d7_KjU ()J
-	public fun getTitleIconPath ()Ljava/lang/String;
+	public fun getTitleIconKey ()Lorg/jetbrains/jewel/ui/icon/IconKey;
 	public fun getTitleIconTint-0d7_KjU ()J
 	public fun getTitleTextStyle ()Landroidx/compose/ui/text/TextStyle;
 	public fun hashCode ()I

diff --git a/.../kotlin/org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertBlockRenderer.kt b/.../kotlin/org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertBlockRenderer.kt
@@ -93,7 +93,7 @@ public class GitHubAlertBlockRenderer(
                 horizontalArrangement = Arrangement.spacedBy(8.dp),
                 verticalAlignment = Alignment.CenterVertically,
             ) {
-                val titleIconProvider = styling.titleIconPath
+                val titleIconProvider = styling.titleIconKey
                 if (titleIconProvider != null) {
                     val colorFilter =
                         remember(styling.titleIconTint) {

diff --git a/...src/main/kotlin/org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertIcons.kt b/...src/main/kotlin/org/jetbrains/jewel/markdown/extensions/github/alerts/GitHubAlertIcons.kt
@@ -0,0 +1,32 @@
+package org.jetbrains.jewel.markdown.extensions.github.alerts
+
+import org.jetbrains.jewel.ui.icon.IconKey
+import org.jetbrains.jewel.ui.icon.PathIconKey
+
+public object GitHubAlertIcons {
+    public val Note: IconKey =
+        PathIconKey(
+            path = "icons/markdown/extensions/github/alerts/alert-note.svg",
+            iconClass = GitHubAlertIcons::class.java,
+        )
+    public val Tip: IconKey =
+        PathIconKey(
+            path = "icons/markdown/extensions/github/alerts/alert-tip.svg",
+            iconClass = GitHubAlertIcons::class.java,
+        )
+    public val Important: IconKey =
+        PathIconKey(
+            path = "icons/markdown/extensions/github/alerts/alert-important.svg",
+            iconClass = GitHubAlertIcons::class.java,
+        )
+    public val Warning: IconKey =
+        PathIconKey(
+            path = "icons/markdown/extensions/github/alerts/alert-warning.svg",
+            iconClass = GitHubAlertIcons::class.java,
+        )
+    public val Caution: IconKey =
+        PathIconKey(
+            path = "icons/markdown/extensions/github/alerts/alert-caution.svg",
+            iconClass = GitHubAlertIcons::class.java,
+        )
+}