#44: Search for usages for custom options

kshchepanovskyi · kshchepanovskyi · commit 335aca460066 · 2017-04-22T17:52:19.000+03:00
diff --git a/gradle.properties b/gradle.properties
@@ -2,7 +2,7 @@
 # https://www.jetbrains.com/intellij-repository/releases
 # https://www.jetbrains.com/intellij-repository/snapshots
 version=0.8.0
-ideaVersion=2016.1
+ideaVersion=2017.1
 # https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under
 # Java 8 is required to run IntelliJ IDEA starting from version 16
 javaVersion=1.8
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/ProtoFindUsagesProvider.java b/src/main/java/io/protostuff/jetbrains/plugin/ProtoFindUsagesProvider.java
@@ -5,7 +5,9 @@
 import com.intellij.lang.findUsages.FindUsagesProvider;
 import com.intellij.psi.PsiElement;
 import io.protostuff.jetbrains.plugin.psi.DataType;
+import io.protostuff.jetbrains.plugin.psi.DataTypeContainer;
 import io.protostuff.jetbrains.plugin.psi.EnumNode;
+import io.protostuff.jetbrains.plugin.psi.MessageField;
 import io.protostuff.jetbrains.plugin.psi.MessageNode;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -29,7 +31,8 @@ public WordsScanner getWordsScanner() {
 
     @Override
     public boolean canFindUsagesFor(@NotNull PsiElement psiElement) {
-        return psiElement instanceof DataType;
+        return psiElement instanceof DataType
+                || psiElement instanceof MessageField;
     }
 
     @Nullable
@@ -47,6 +50,9 @@ public String getType(@NotNull PsiElement element) {
         if (element instanceof EnumNode) {
             return "enum";
         }
+        if (element instanceof MessageField) {
+            return "field";
+        }
         return "";
     }
 
@@ -57,6 +63,10 @@ public String getDescriptiveName(@NotNull PsiElement element) {
             DataType type = (DataType) element;
             return type.getFullName();
         }
+        if (element instanceof MessageField) {
+            MessageField field = (MessageField) element;
+            return field.getFieldName();
+        }
         return "";
     }
 
@@ -71,6 +81,28 @@ public String getNodeText(@NotNull PsiElement element, boolean useFullName) {
             //noinspection ConstantConditions
             return type.getName();
         }
+        if (element instanceof MessageField) {
+            MessageField field = (MessageField) element;
+            if (useFullName) {
+                String namespace = getNamespace(field);
+                return namespace + field.getFieldName();
+            }
+            return field.getFieldName();
+        }
+        return "";
+    }
+
+    private String getNamespace(MessageField field) {
+        PsiElement tmp = field;
+        while (tmp != null) {
+            tmp = tmp.getParent();
+            if (tmp instanceof DataTypeContainer) {
+                DataTypeContainer container = (DataTypeContainer) tmp;
+                return container.getNamespace();
+            }
+        }
         return "";
     }
+
+
 }
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/DataTypeContainer.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/DataTypeContainer.java
@@ -1,13 +1,14 @@
 package io.protostuff.jetbrains.plugin.psi;
 
+import com.intellij.psi.PsiElement;
 import java.util.Collection;
 
 /**
  * Container node that can hold user types - can be a message or proto file.
  *
  * @author Kostiantyn Shchepanovskyi
  */
-public interface DataTypeContainer {
+public interface DataTypeContainer extends PsiElement {
 
     /**
      * Returns string prefix that is common for all children full names.
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/EnumConstantNode.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/EnumConstantNode.java
@@ -6,6 +6,8 @@
 import static io.protostuff.jetbrains.plugin.psi.Util.decodeIntegerFromText;
 
 import com.intellij.lang.ASTNode;
+import com.intellij.navigation.ItemPresentation;
+import com.intellij.navigation.ItemPresentationProviders;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiNamedElement;
 import io.protostuff.compiler.parser.ProtoParser;
@@ -59,4 +61,9 @@ public ASTNode getConstantValueNode() {
         return node.findChildByType(rule(RULE_enumFieldValue));
     }
 
+    @Override
+    public ItemPresentation getPresentation() {
+        return ItemPresentationProviders.getItemPresentation(this);
+    }
+
 }
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/FieldNode.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/FieldNode.java
@@ -6,6 +6,8 @@
 import static io.protostuff.jetbrains.plugin.psi.Util.decodeIntegerFromText;
 
 import com.intellij.lang.ASTNode;
+import com.intellij.navigation.ItemPresentation;
+import com.intellij.navigation.ItemPresentationProviders;
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.psi.PsiElement;
 import io.protostuff.compiler.parser.ProtoParser;
@@ -86,6 +88,11 @@ public ASTNode getFieldLabelNode() {
         return node.findChildByType(R_FIELD_MODIFIER);
     }
 
+    @Override
+    public ItemPresentation getPresentation() {
+        return ItemPresentationProviders.getItemPresentation(this);
+    }
+
     @Override
     public String toString() {
         return "FieldNode(" + getFieldName() + "=" + getTag() + ")";
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/MapNode.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/MapNode.java
@@ -5,6 +5,8 @@
 import static io.protostuff.jetbrains.plugin.psi.Util.decodeIntegerFromText;
 
 import com.intellij.lang.ASTNode;
+import com.intellij.navigation.ItemPresentation;
+import com.intellij.navigation.ItemPresentationProviders;
 import java.util.Optional;
 import org.antlr.jetbrains.adapter.psi.AntlrPsiNode;
 import org.jetbrains.annotations.NotNull;
@@ -65,4 +67,9 @@ public ASTNode getFieldLabelNode() {
         return null;
     }
 
+    @Override
+    public ItemPresentation getPresentation() {
+        return ItemPresentationProviders.getItemPresentation(this);
+    }
+
 }
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/MessageField.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/MessageField.java
@@ -1,15 +1,15 @@
 package io.protostuff.jetbrains.plugin.psi;
 
 import com.intellij.lang.ASTNode;
-import com.intellij.psi.PsiElement;
+import com.intellij.psi.NavigatablePsiElement;
 import java.util.Optional;
 
 /**
  * Message field node.
  *
  * @author Kostiantyn Shchepanovskyi
  */
-public interface MessageField extends PsiElement {
+public interface MessageField extends NavigatablePsiElement {
 
     String getFieldName();
 
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/OneofFieldNode.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/OneofFieldNode.java
@@ -6,6 +6,8 @@
 import static io.protostuff.jetbrains.plugin.psi.Util.decodeIntegerFromText;
 
 import com.intellij.lang.ASTNode;
+import com.intellij.navigation.ItemPresentation;
+import com.intellij.navigation.ItemPresentationProviders;
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.psi.PsiElement;
 import io.protostuff.compiler.parser.ProtoParser;
@@ -82,4 +84,9 @@ public TypeReferenceNode getFieldType() {
         return findChildByClass(TypeReferenceNode.class);
     }
 
+    @Override
+    public ItemPresentation getPresentation() {
+        return ItemPresentationProviders.getItemPresentation(this);
+    }
+
 }
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/presentation/EnumValuePresentationProvider.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/presentation/EnumValuePresentationProvider.java
@@ -0,0 +1,24 @@
+package io.protostuff.jetbrains.plugin.psi.presentation;
+
+import io.protostuff.jetbrains.plugin.Icons;
+import io.protostuff.jetbrains.plugin.psi.EnumConstantNode;
+import javax.swing.Icon;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Message node presentation provider.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class EnumValuePresentationProvider extends AbstractPresentationProvider<EnumConstantNode> {
+
+    @Override
+    protected Icon getIcon() {
+        return Icons.CONSTANT;
+    }
+
+    @Override
+    protected String getName(@NotNull EnumConstantNode item) {
+        return PresentationUtil.getNameForElement(item);
+    }
+}
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/presentation/FieldPresentationProvider.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/presentation/FieldPresentationProvider.java
@@ -0,0 +1,24 @@
+package io.protostuff.jetbrains.plugin.psi.presentation;
+
+import io.protostuff.jetbrains.plugin.Icons;
+import io.protostuff.jetbrains.plugin.psi.MessageField;
+import javax.swing.Icon;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Message node presentation provider.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class FieldPresentationProvider extends AbstractPresentationProvider<MessageField> {
+
+    @Override
+    protected Icon getIcon() {
+        return Icons.FIELD;
+    }
+
+    @Override
+    protected String getName(@NotNull MessageField item) {
+        return PresentationUtil.getNameForElement(item);
+    }
+}
diff --git a/src/main/java/io/protostuff/jetbrains/plugin/psi/presentation/PresentationUtil.java b/src/main/java/io/protostuff/jetbrains/plugin/psi/presentation/PresentationUtil.java
@@ -1,12 +1,13 @@
 package io.protostuff.jetbrains.plugin.psi.presentation;
 
 import com.intellij.psi.PsiElement;
-import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiNamedElement;
 import com.intellij.psi.util.PsiTreeUtil;
 import io.protostuff.jetbrains.plugin.ProtostuffBundle;
-import io.protostuff.jetbrains.plugin.psi.MessageNode;
-import org.jetbrains.annotations.NotNull;
+import io.protostuff.jetbrains.plugin.psi.DataType;
+import io.protostuff.jetbrains.plugin.psi.DataTypeContainer;
+import io.protostuff.jetbrains.plugin.psi.MessageField;
+import io.protostuff.jetbrains.plugin.psi.ProtoRootNode;
 import org.jetbrains.annotations.Nullable;
 
 /**
@@ -21,36 +22,34 @@ public class PresentationUtil {
      */
     @Nullable
     public static String getNameForElement(PsiElement element) {
-        if (element instanceof PsiNamedElement) {
-            PsiNamedElement message = (PsiNamedElement) element;
-            String name = message.getName();
-            String context = getContextName(message);
-            if (context != null) {
-                return ProtostuffBundle.message("element.context.display", name, context);
-            } else {
-                return name;
-            }
-        }
-        return null;
-    }
-
-    private static String getContextName(@NotNull PsiElement element) {
-        PsiElement parent = PsiTreeUtil.getParentOfType(element, MessageNode.class);
-        if (parent == null) {
-            parent = element.getContainingFile();
+        if (element instanceof DataType) {
+            DataType type = (DataType) element;
+            return type.getFullName();
         }
-        while (true) {
-            if (parent == null) {
+        if (element instanceof ProtoRootNode) {
+            ProtoRootNode rootNode = (ProtoRootNode) element;
+            String packageName = rootNode.getPackageName();
+            if (packageName.isEmpty()) {
                 return null;
             }
-            if (parent instanceof PsiFile) {
-                return null;
-            }
-            String name = getNameForElement(parent);
-            if (name != null) {
-                return name;
+            return packageName;
+        }
+        if (element instanceof MessageField) {
+            MessageField field = (MessageField) element;
+            String fieldName = field.getFieldName();
+            DataTypeContainer container = PsiTreeUtil.getParentOfType(element, DataTypeContainer.class);
+            String conteinerName = getNameForElement(container);
+            if (conteinerName != null) {
+                return ProtostuffBundle.message("element.context.display", fieldName, conteinerName);
+            } else {
+                return fieldName;
             }
-            parent = parent.getParent();
         }
+        if (element instanceof PsiNamedElement) {
+            PsiNamedElement namedElement = (PsiNamedElement) element;
+            return namedElement.getName();
+        }
+        return null;
     }
+
 }
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -66,7 +66,7 @@
 
     <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html
          for description -->
-    <idea-version since-build="145"/>
+    <idea-version since-build="171"/>
 
     <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
          on how to target different products -->
@@ -146,6 +146,18 @@
         <itemPresentationProvider
                 forClass="io.protostuff.jetbrains.plugin.psi.MessageNode"
                 implementationClass="io.protostuff.jetbrains.plugin.psi.presentation.MessagePresentationProvider"/>
+        <itemPresentationProvider
+                forClass="io.protostuff.jetbrains.plugin.psi.FieldNode"
+                implementationClass="io.protostuff.jetbrains.plugin.psi.presentation.FieldPresentationProvider"/>
+        <itemPresentationProvider
+                forClass="io.protostuff.jetbrains.plugin.psi.OneofFieldNode"
+                implementationClass="io.protostuff.jetbrains.plugin.psi.presentation.FieldPresentationProvider"/>
+        <itemPresentationProvider
+                forClass="io.protostuff.jetbrains.plugin.psi.MapNode"
+                implementationClass="io.protostuff.jetbrains.plugin.psi.presentation.FieldPresentationProvider"/>
+        <itemPresentationProvider
+                forClass="io.protostuff.jetbrains.plugin.psi.EnumConstantNode"
+                implementationClass="io.protostuff.jetbrains.plugin.psi.presentation.EnumValuePresentationProvider"/>
         <itemPresentationProvider
                 forClass="io.protostuff.jetbrains.plugin.psi.EnumNode"
                 implementationClass="io.protostuff.jetbrains.plugin.psi.presentation.EnumPresentationProvider"/>
diff --git a/src/test/java/io/protostuff/jetbrains/plugin/reference/FindUsagesTest.java b/src/test/java/io/protostuff/jetbrains/plugin/reference/FindUsagesTest.java
diff --git a/src/test/java/io/protostuff/jetbrains/plugin/usages/FindUsagesTest.java b/src/test/java/io/protostuff/jetbrains/plugin/usages/FindUsagesTest.java
diff --git a/src/test/resources/usages/CustomOptionReference.proto b/src/test/resources/usages/CustomOptionReference.proto
diff --git a/src/test/resources/usages/FieldTypeReference.proto b/src/test/resources/usages/FieldTypeReference.proto
diff --git a/src/test/resources/usages/Options.proto b/src/test/resources/usages/Options.proto
diff --git a/src/test/resources/usages/StandardOptionReference.proto b/src/test/resources/usages/StandardOptionReference.proto
