Refactor USDDocumentationProvider: Add tooltips to USDBreadcrumbsProv…

…ider
justint · Aug 8, 2021 · 8a10e35 · 8a10e35
1 parent 6811828
commit 8a10e35
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 17 deletions.
diff --git a/src/main/java/com/justint/usdidea/codeinsight/USDBreadcrumbsProvider.java b/src/main/java/com/justint/usdidea/codeinsight/USDBreadcrumbsProvider.java
@@ -5,10 +5,13 @@
 import com.intellij.ui.breadcrumbs.BreadcrumbsProvider;
 import com.justint.usdidea.lang.USDLanguage;
 import com.justint.usdidea.lang.psi.USDBreadcrumbItem;
+import com.justint.usdidea.lang.psi.USDFile;
+import com.justint.usdidea.lang.psi.usdPrimSpec;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import javax.swing.*;
+import java.util.ArrayList;
 
 public class USDBreadcrumbsProvider implements BreadcrumbsProvider {
 
@@ -35,9 +38,9 @@ public String getElementInfo(@NotNull PsiElement psiElement) {
 //        return null;
 //    }
 //
-//    @Nullable
-//    @Override
-//    public String getElementTooltip(@NotNull PsiElement element) {
-//        return null;
-//    }
+    @Nullable
+    @Override
+    public String getElementTooltip(@NotNull PsiElement element) {
+        return String.join(" ", USDDocumentationProvider.getUSDPsiElementDocStringArray(element));
+    }
 }
diff --git a/src/main/java/com/justint/usdidea/codeinsight/USDDocumentationProvider.java b/src/main/java/com/justint/usdidea/codeinsight/USDDocumentationProvider.java
@@ -9,9 +9,8 @@
 import java.util.ArrayList;
 
 public class USDDocumentationProvider implements DocumentationProvider {
-    @Nullable
-    @Override
-    public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) {
+
+    public static ArrayList<String> getUSDPsiElementDocStringArray(PsiElement element) {
         ArrayList<String> result = new ArrayList<>();
 
         // Handle layer files
@@ -20,18 +19,25 @@ public String getQuickNavigateInfo(PsiElement element, PsiElement originalElemen
             result.add("layer file");
             result.add(codedString(usdFile.getVirtualFile().getPath()));
         }
-        // Handle USD elements
-        else {
-            if (element instanceof usdPrimSpec) {
-                result.add("prim");
+        else if (element instanceof usdPrimSpec) {
+            result.add("prim");
 
-                usdPrimSpec primSpec = (usdPrimSpec)element;
-                String primType = primSpec.getPrimType();
-                if (primType != null) result.add(primType);
+            usdPrimSpec primSpec = (usdPrimSpec)element;
+            String primType = primSpec.getPrimType();
+            if (primType != null) result.add(primType);
 
-                result.add(codedString(primSpec.getPrimPath()));
-            }
+            result.add(codedString(primSpec.getPrimPath()));
+        }
+
+        return result;
+    }
+
+    @Nullable
+    @Override
+    public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) {
+        ArrayList<String> result = new ArrayList<>(getUSDPsiElementDocStringArray(element));
 
+        if (element instanceof usdPrimSpec) {
             // Include element layer path, if from another layer file
             if (element.getContainingFile() != originalElement.getContainingFile()) {
                 result.add("\nin layer file " + element.getContainingFile().getVirtualFile().getPath());