Declarative API + VCS inlays

.gitignore

@@ -43,4 +43,5 @@ bin/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store
+/.idea/

README.md

@@ -878,7 +878,7 @@ As can be seen in the diagram above, a class of type _InlayHintProvider_ must im
 which will allow you to configure the inlay hint case in the IDE, allowing you to configure it in the appropriate menus
 for a
 programming language. The most important point concerns the _getCollectorFor(PsiFile, Editor, S,
-InlayHintsSink)_ method. This method returns a class of type [
+InlayTreeSink)_ method. This method returns a class of type [
 _InlayHintsCollector_](https://github.com/JetBrains/intellij-community/blob/idea/232.9921.47/platform/lang-api/src/com/intellij/codeInsight/hints/InlayHintsCollector.kt).
 This class that is responsible for scanning
 the source code elements and execute the logic to identify the point where the addition of an inlay hint is necessary.
@@ -896,12 +896,12 @@ class diagram available for this purpose.
 ![Collector Class Diagram - Example](docs/screenshots/CECollectorDiagram.png)
 
 The _InlayHintsCollector_ framework interface can be implemented in the plugin by the _CECollector_ and
-_CECollectorMulti_. The interface defines the _collect(PsiElement, Editor, InlayHintsSink)_ method. _CECollectorMulti_
+_CECollectorMulti_. The interface defines the _collect(PsiElement, Editor, InlayTreeSink)_ method. _CECollectorMulti_
 allows you to implement this method using a list of collectors, useful for use with _CEProviderMulti_.
 
 The _CECollector_ abstract class is the main class for implementing a collector. It extends the abstract class
 _CEInlayBuilder_ which contains all the methods for manipulating inlay hints. Child classes must implement
-_processCollect(PsiElement, Editor, InlayHintsSink)_.
+_processCollect(PsiElement, Editor, InlayTreeSink)_.
 
 ![CECollector Class Diagram - Example](docs/screenshots/CECollectorWithInlayBuilder.png)
 
@@ -932,7 +932,7 @@ referenced in the source code: _Reference Class_, _Reference Field_ and _Referen
 Example of use:
 
 ````java
-public class GetMethodDoesNotReturn extends CEProvider<NoSettings> {
+public class GetMethodDoesNotReturn extends CEProvider<CEDefaultSettings> {
 
     @Override
     public String getPreviewText() {
@@ -945,7 +945,7 @@ public class GetMethodDoesNotReturn extends CEProvider<NoSettings> {
     }
 
     @Override
-    public @NotNull InlayHintsCollector buildCollector(@NotNull Editor editor) {
+    public @NotNull InlayHintsCollector createCollector(@NotNull PsiFile psiFile, @NotNull Editor editor) {
         return new CEMethodCollector(editor, getKeyId(), CONFUSED) {
             @Override
             public boolean needsHint(@NotNull PsiMethod element, @NotNull Map<?, ?> externalInfo) {

build.gradle.kts

@@ -26,7 +26,6 @@ dependencies {
     compileOnly("org.projectlombok:lombok:1.18.28")
     annotationProcessor("org.projectlombok:lombok:1.18.28")
     implementation("com.google.code.gson:gson:2.10.1")
-    implementation("org.json:json:20240303")
 }
 
 
@@ -39,7 +38,10 @@ intellij {
     updateSinceUntilBuild.set(true)
     val platformPlugins = properties("platformPlugins").split(',').map(String::trim).filter(String::isNotEmpty)
     plugins.set(
-            platformPlugins + listOf("com.intellij.java")
+            platformPlugins + listOf(
+                    "com.intellij.java",
+                    "Git4Idea"
+            )
     )
 }
 

gradle.properties

@@ -1,10 +1,11 @@
 pluginGroup=codeemoji
-pluginVersion=5.0.0
+pluginVersion=6.0.0
 pluginSinceBuild=231
-pluginUntilBuild=232.*
-pluginVerifierIdeVersions=2023.1,2023.1.1,2023.1.2,2023.1.3,2023.1.4,2023.1.5,2023.1.6,2023.1.7,2023.2,2023.2.1,2023.2.2,2023.2.3,2023.2.4,2023.2.5,2023.2.6,2023.2.7,2023.2.8
+pluginUntilBuild=252.*
+pluginVerifierIdeVersions=2023.1,2023.1.1,2023.1.2,2023.1.3,2023.1.4,2023.1.5,2023.1.6,2023.1.7,2023.2,2023.2.1,2023.2.2,2023.2.3,2023.2.4,2023.2.5,2023.2.6,2023.2.7,2023.2.8,2023.3
 platformType=IC
-platformVersion=2023.2.8
+## IC for community
+platformVersion= 2023.3
 platformDownloadSources=true
 platformPlugins=
 kotlin.stdlib.default.dependency=false

src/main/java/codeemoji/core/collector/CECollector.java

@@ -1,31 +1,46 @@
 package codeemoji.core.collector;
 
-import com.intellij.codeInsight.hints.InlayHintsCollector;
-import com.intellij.codeInsight.hints.InlayHintsSink;
-import com.intellij.codeInsight.hints.presentation.InlayPresentation;
+import codeemoji.core.external.CEExternalAnalyzer;
+import codeemoji.core.util.CEBundle;
+import codeemoji.core.util.CESymbol;
+import com.intellij.codeInsight.hints.declarative.*;
 import com.intellij.openapi.editor.Editor;
 import com.intellij.openapi.editor.ex.util.EditorUtil;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementVisitor;
+import com.intellij.psi.PsiJavaFile;
+import kotlin.Unit;
 import lombok.Getter;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 @Getter
-@SuppressWarnings("UnstableApiUsage")
-public abstract non-sealed class CECollector<A extends PsiElement> extends CEInlayBuilder implements InlayHintsCollector {
+public abstract class CECollector<H extends PsiElement, A extends PsiElement> implements SharedBypassCollector {
+
+    private final Editor editor;
+    private final String key;
 
-    protected CECollector(Editor editor) {
-        super(editor);
+    protected CECollector(Editor editor, String key) {
+        this.editor = editor;
+        this.key = key;
     }
 
-    @SuppressWarnings("SameReturnValue")
-    public abstract boolean processCollect(@NotNull PsiElement psiElement, @NotNull Editor editor, @NotNull InlayHintsSink inlayHintsSink);
+    public abstract PsiElementVisitor createElementVisitor(@NotNull Editor editor, @NotNull InlayTreeSink InlayTreeSink);
 
-    public final boolean collect(@NotNull PsiElement psiElement, @NotNull Editor editor, @NotNull InlayHintsSink inlayHintsSink) {
+    @Nullable
+    protected abstract InlayVisuals createInlayFor(@NotNull H element);
+
+    @Override
+    public void collectFromElement(@NotNull PsiElement psiElement, @NotNull InlayTreeSink inlayTreeSink) {
         if (isEnabled()) {
-            return processCollect(psiElement, editor, inlayHintsSink);
+            if (psiElement instanceof PsiJavaFile) {
+                psiElement.accept(createElementVisitor(getEditor(), inlayTreeSink));
+            }
         }
-        return false;
     }
 
     protected int calcOffset(@Nullable A element) {
@@ -39,19 +54,49 @@ protected boolean isEnabled() {
         return true;
     }
 
-    public final void addInlayInline(@Nullable A element, @NotNull InlayHintsSink sink, @NotNull InlayPresentation inlay) {
+    public final void addInlayInline(@Nullable A element, @NotNull InlayTreeSink sink, @NotNull InlayVisuals inlay) {
         if (null != element) {
-            sink.addInlineElement(calcOffset(element), false, inlay, false);
+
+            sink.addPresentation(
+                    new InlineInlayPosition(element.getTextRange().getEndOffset(), true, 0),
+                    List.of(),
+                    inlay.tooltip(),
+                    inlay.hasBackground(),
+                    builder -> {
+                        builder.text(inlay.text(), null);
+                        return Unit.INSTANCE;
+                    }
+            );
         }
     }
 
-    public final void addInlayBlock(@Nullable A element, @NotNull InlayHintsSink sink, InlayPresentation inlay) {
+    public final void addInlayBlock(@Nullable A element, @NotNull InlayTreeSink sink, InlayVisuals inlay) {
         if (null != element) {
             var indentFactor = EditorUtil.getPlainSpaceWidth(getEditor());
             var indent = EditorUtil.getTabSize(getEditor()) * indentFactor;
-            inlay = getFactory().inset(inlay, indent, 0, 0, 0);
-            sink.addBlockElement(element.getTextOffset(), true, true, 0, inlay);
+            // inlay = getFactory().inset(inlay, indent, 0, 0, 0);
+
+            //TODO: check this
+            sink.addPresentation(
+                    new InlineInlayPosition(element.getTextRange().getEndOffset()-indent, true,  0),
+                    List.of(),
+                    inlay.tooltip(),
+                    inlay.hasBackground(),
+                    builder -> {
+                        builder.text(inlay.text(), null);
+                        return Unit.INSTANCE;
+                    }
+            );
+        }
+    }
+
+    //helper function. we are not feeding this all the time into craete inlay
+    protected @NotNull Map<?, ?> getExternalInfo(@Nullable H element) {
+        Map<?, ?> result = new HashMap<>();
+        if (element != null) {
+            CEExternalAnalyzer.getInstance().buildExternalInfo(result, element);
         }
+        return result;
     }
 
 }

src/main/java/codeemoji/core/collector/CECollectorMulti.java

@@ -1,23 +1,23 @@
 package codeemoji.core.collector;
 
-import com.intellij.codeInsight.hints.InlayHintsCollector;
-import com.intellij.codeInsight.hints.InlayHintsSink;
+import com.intellij.codeInsight.hints.declarative.InlayTreeSink;
+import com.intellij.codeInsight.hints.declarative.InlayHintsCollector;
+import com.intellij.codeInsight.hints.declarative.InlayTreeSink;
+import com.intellij.codeInsight.hints.declarative.SharedBypassCollector;
 import com.intellij.openapi.editor.Editor;
 import com.intellij.psi.PsiElement;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.List;
 
-@SuppressWarnings("UnstableApiUsage")
-public record CECollectorMulti(List<InlayHintsCollector> collectors) implements InlayHintsCollector {
+public record CECollectorMulti(List<SharedBypassCollector> collectors) implements SharedBypassCollector {
 
     @Override
-    public boolean collect(@NotNull PsiElement psiElement, @NotNull Editor editor, @NotNull InlayHintsSink inlayHintsSink) {
+    public void collectFromElement(@NotNull PsiElement psiElement, @NotNull InlayTreeSink inlayTreeSink) {
         if (null != collectors()) {
             for (var collector : collectors()) {
-                collector.collect(psiElement, editor, inlayHintsSink);
+                collector.collectFromElement(psiElement, inlayTreeSink);
             }
         }
-        return false;
     }
 }