Use DocumentationTarget instead of DocumentationProvider for Image previews.

Author: BlueBoxWare

gradle.properties

@@ -6,11 +6,11 @@ pluginSinceBuild = 231.7665.28
 pluginUntilBuild =
 
 # See https://www.jetbrains.com/intellij-repository/snapshots/ for available build versions.
-pluginVerifierIdeVersions = 231.7665.28
+pluginVerifierIdeVersions = 231.8109.175
 
 platformType = IC
 #platformVersion = 223.8214.52
-platformVersion = 231.7665.28-EAP-SNAPSHOT
+platformVersion = 231.8109.175
 platformDownloadSources = true
 
 platformPlugins = java, Kotlin, Groovy, properties

…/ui/ImagePreviewDocumentationProvider.kt …in/ui/ImagePreviewDocumentationTarget.ktsrc/main/kotlin/com/gmail/blueboxware/libgdxplugin/ui/ImagePreviewDocumentationProvider.kt renamed to src/main/kotlin/com/gmail/blueboxware/libgdxplugin/ui/ImagePreviewDocumentationTarget.kt src/main/kotlin/com/gmail/blueboxware/libgdxplugin/ui/ImagePreviewDocumentationProvider.kt renamed to src/main/kotlin/com/gmail/blueboxware/libgdxplugin/ui/ImagePreviewDocumentationTarget.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Blue Box Ware
+ * Copyright 2023 Blue Box Ware
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,33 +14,38 @@
  * limitations under the License.
  */
 
+@file:Suppress("UnstableTypeUsedInSignature", "UnstableApiUsage")
+
 package com.gmail.blueboxware.libgdxplugin.ui
 
 import com.gmail.blueboxware.libgdxplugin.filetypes.atlas2.Atlas2File
 import com.gmail.blueboxware.libgdxplugin.filetypes.atlas2.psi.Atlas2Region
 import com.gmail.blueboxware.libgdxplugin.filetypes.skin.psi.*
 import com.gmail.blueboxware.libgdxplugin.filetypes.skin.utils.getRealClassNamesAsString
 import com.gmail.blueboxware.libgdxplugin.utils.*
-import com.intellij.lang.documentation.AbstractDocumentationProvider
+import com.intellij.model.Pointer
+import com.intellij.navigation.TargetPresentation
 import com.intellij.openapi.diagnostic.Logger
 import com.intellij.openapi.util.SystemInfo
 import com.intellij.openapi.util.io.FileUtil
 import com.intellij.openapi.util.text.HtmlBuilder
 import com.intellij.openapi.util.text.HtmlChunk
+import com.intellij.platform.backend.documentation.DocumentationTarget
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiJavaFile
 import com.intellij.psi.PsiLiteralExpression
 import com.intellij.util.ui.ImageUtil
 import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.psi.KtStringTemplateExpression
+import org.jetbrains.kotlin.psi.psiUtil.createSmartPointer
 import java.awt.image.BufferedImage
 import java.net.URI
 import java.net.URISyntaxException
 import javax.imageio.ImageIO
 
-class ImagePreviewDocumentationProvider : AbstractDocumentationProvider() {
-
-    override fun generateDoc(el: PsiElement, originalElement: PsiElement?): String? {
+class ImagePreviewDocumentationTarget(val element: PsiElement, private val originalElement: PsiElement?) :
+    DocumentationTarget {
+    override fun computeDocumentationHint(): String? {
         val currentFile = originalElement?.containingFile ?: return null
         if (currentFile !is SkinFile && currentFile !is PsiJavaFile && currentFile !is KtFile && currentFile !is Atlas2File) {
             return null
@@ -69,8 +74,8 @@ class ImagePreviewDocumentationProvider : AbstractDocumentationProvider() {
 
             when (currentFile) {
                 is SkinFile -> element.getParentOfType<SkinStringLiteral>(false)
-                is PsiJavaFile -> element.getParentOfType<PsiLiteralExpression>()
-                is KtFile -> element.getParentOfType<KtStringTemplateExpression>()
+                is PsiJavaFile -> element.getParentOfType<PsiLiteralExpression>(false)
+                is KtFile -> element.getParentOfType<KtStringTemplateExpression>(false)
                 else -> null
             }?.references?.forEach { reference ->
                 reference.resolve()?.let { target ->
@@ -132,6 +137,17 @@ class ImagePreviewDocumentationProvider : AbstractDocumentationProvider() {
         return null
     }
 
+    override fun computePresentation(): TargetPresentation = TargetPresentation.builder("Test").presentation()
+
+    override fun createPointer(): Pointer<out DocumentationTarget> {
+        val elementPtr = element.createSmartPointer()
+        val originalElementPtr = originalElement?.createSmartPointer()
+        return Pointer {
+            val element = elementPtr.dereference() ?: return@Pointer null
+            ImagePreviewDocumentationTarget(element, originalElementPtr?.dereference())
+        }
+    }
+
     private fun createDoc(image: BufferedImage, name: String?, file: String?): String? {
 
 
@@ -196,7 +212,9 @@ class ImagePreviewDocumentationProvider : AbstractDocumentationProvider() {
 
     }
 
+
     companion object {
-        val LOG = Logger.getInstance(ImagePreviewDocumentationProvider::class.java)
+        val LOG = Logger.getInstance(ImagePreviewDocumentationTarget::class.java)
     }
+
 }

src/main/kotlin/com/gmail/blueboxware/libgdxplugin/ui/ImagePreviewPsiDocumentationTargetProvider.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2023 Blue Box Ware
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.gmail.blueboxware.libgdxplugin.ui
+
+import com.gmail.blueboxware.libgdxplugin.filetypes.atlas2.LibGDXAtlas2Language
+import com.gmail.blueboxware.libgdxplugin.filetypes.skin.LibGDXSkinLanguage
+import com.intellij.lang.java.JavaLanguage
+import com.intellij.platform.backend.documentation.DocumentationTarget
+import com.intellij.platform.backend.documentation.PsiDocumentationTargetProvider
+import com.intellij.psi.PsiElement
+import org.jetbrains.kotlin.idea.KotlinLanguage
+
+class ImagePreviewPsiDocumentationTargetProvider : PsiDocumentationTargetProvider {
+    override fun documentationTarget(element: PsiElement, originalElement: PsiElement?): DocumentationTarget? =
+        if (element.language in languages) ImagePreviewDocumentationTarget(element, originalElement) else null
+
+    companion object {
+        private val languages = listOf(
+            LibGDXSkinLanguage.INSTANCE,
+            LibGDXAtlas2Language.INSTANCE,
+            KotlinLanguage.INSTANCE,
+            JavaLanguage.INSTANCE
+        )
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -87,7 +87,7 @@
 
         <iconProvider implementation="com.gmail.blueboxware.libgdxplugin.ui.LibGDXIconProvider"/>
 
-        <documentationProvider implementation="com.gmail.blueboxware.libgdxplugin.ui.ImagePreviewDocumentationProvider" />
+        <platform.backend.documentation.psiTargetProvider implementation="com.gmail.blueboxware.libgdxplugin.ui.ImagePreviewPsiDocumentationTargetProvider" />
 
         <debugger.nodeRenderer implementation="com.gmail.blueboxware.libgdxplugin.ui.LibGDXColorObjectRenderer"/>
 

src/test/kotlin/com/gmail/blueboxware/libgdxplugin/TestTextTextureRegionPreview.kt

@@ -1,6 +1,6 @@
 package com.gmail.blueboxware.libgdxplugin
 
-import com.gmail.blueboxware.libgdxplugin.ui.ImagePreviewDocumentationProvider
+import com.gmail.blueboxware.libgdxplugin.ui.ImagePreviewDocumentationTarget
 import java.awt.Color
 import java.net.URL
 import javax.imageio.ImageIO
@@ -46,7 +46,7 @@ class TestTextTextureRegionPreview : LibGDXCodeInsightFixtureTestCase() {
         configureByFile(fileName)
         val element = file.findElementAt(myFixture.caretOffset) ?: throw AssertionError()
         val preview: String =
-            ImagePreviewDocumentationProvider().generateDoc(element, element) ?: throw AssertionError()
+            ImagePreviewDocumentationTarget(element, element).computeDocumentationHint() ?: throw AssertionError()
         val imageFile = Regex("""src="([^"]+)"""").find(preview)?.groupValues?.get(1) ?: throw AssertionError()
         val image = ImageIO.read(URL(imageFile))
         assertEquals(width, image.width)