Merge pull request #47 from protostuff/feature/find-usages-for-options

#44: Search for usages for custom options

Author: kshchepanovskyi

README.md

@@ -4,21 +4,35 @@
 
 [Protobuf Support Plugin](https://plugins.jetbrains.com/plugin/8277) for IntelliJ IDEA & other JetBrains products.
 
-Plugin is compatible with IntelliJ IDEA 2016.1. Other JetBrains IDEs of the same or higher version should be supported as well. 
+Latest plugin release is compatible with IntelliJ IDEA 2017.1 (older releases are compatible with IDEA 13+). 
+Other JetBrains IDEs of the same or higher version should be supported as well. 
+
+### Installation
+
+IntelliJ IDEA should suggest you to install plugin automatically 
+when you open `.proto` file.
+You can install plugin manually by opening "Plugins" settings, 
+"Browse repositories..." - search for "Protobuf Support".
+
+Plugin page: https://plugins.jetbrains.com/plugin/8277-protobuf-support
+
 
 ### Roadmap
 
 https://github.com/protostuff/protobuf-jetbrains-plugin/wiki/Roadmap
 
 ### Build
 
+Run following command in the shell:
+
 ```
 ./gradlew build
 ```
 
-Requirements:
+It should be possible to run build on any platform (Linux, Windows, MacOS) where
+[Gradle](https://gradle.org/) is supported.
 
-1. JDK 8
+JDK 8 must be installed and available on PATH in order to run build.
 
 ### Run IntelliJ IDEA with enabled plugin (for development)
 

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

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 "";
     }
+
+
 }

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.

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);
+    }
+
 }

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() + ")";

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);
+    }
+
 }

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();
 

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);
+    }
+
 }

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);
+    }
+}