Merge pull request #40 from protostuff/feature/option-references

Resolve option references

Author: kshchepanovskyi

build.gradle

@@ -18,6 +18,7 @@ description = 'Protobuf Plugin for JetBrains IDEs'
 
 repositories {
     jcenter()
+    mavenCentral()
     mavenLocal()
     maven {
         url "https://dl.bintray.com/antlr/maven/"
@@ -30,7 +31,7 @@ dependencies {
         exclude group: 'com.jetbrains'
     }
     compile 'com.google.guava:guava:21.0'
-    compile 'io.protostuff:protostuff-parser:2.0.0-alpha35'
+    compile 'io.protostuff:protostuff-parser:2.0.0-alpha36'
 }
 
 apply plugin: 'idea'

src/main/java/io/protostuff/jetbrains/plugin/ProtoParserDefinition.java

@@ -18,11 +18,14 @@
 import com.intellij.psi.tree.TokenSet;
 import io.protostuff.compiler.parser.ProtoLexer;
 import io.protostuff.compiler.parser.ProtoParser;
+import io.protostuff.jetbrains.plugin.psi.CustomFieldReferenceNode;
 import io.protostuff.jetbrains.plugin.psi.EnumConstantNode;
 import io.protostuff.jetbrains.plugin.psi.EnumNode;
+import io.protostuff.jetbrains.plugin.psi.ExtendEntryNode;
 import io.protostuff.jetbrains.plugin.psi.ExtendNode;
 import io.protostuff.jetbrains.plugin.psi.ExtensionsNode;
 import io.protostuff.jetbrains.plugin.psi.FieldNode;
+import io.protostuff.jetbrains.plugin.psi.FieldReferenceNode;
 import io.protostuff.jetbrains.plugin.psi.FileReferenceNode;
 import io.protostuff.jetbrains.plugin.psi.GroupNode;
 import io.protostuff.jetbrains.plugin.psi.ImportNode;
@@ -33,7 +36,6 @@
 import io.protostuff.jetbrains.plugin.psi.OneOfNode;
 import io.protostuff.jetbrains.plugin.psi.OneofFieldNode;
 import io.protostuff.jetbrains.plugin.psi.OptionEntryNode;
-import io.protostuff.jetbrains.plugin.psi.OptionNameNode;
 import io.protostuff.jetbrains.plugin.psi.OptionNode;
 import io.protostuff.jetbrains.plugin.psi.OptionValueNode;
 import io.protostuff.jetbrains.plugin.psi.PackageStatement;
@@ -45,6 +47,7 @@
 import io.protostuff.jetbrains.plugin.psi.RpcMethodNode;
 import io.protostuff.jetbrains.plugin.psi.RpcMethodTypeNode;
 import io.protostuff.jetbrains.plugin.psi.ServiceNode;
+import io.protostuff.jetbrains.plugin.psi.StandardFieldReferenceNode;
 import io.protostuff.jetbrains.plugin.psi.SyntaxNode;
 import io.protostuff.jetbrains.plugin.psi.TypeReferenceNode;
 import java.util.HashMap;
@@ -244,11 +247,14 @@ public ProtoParserDefinition() {
         register(ProtoParser.RULE_rpcMethod, RpcMethodNode::new);
         register(ProtoParser.RULE_optionEntry, OptionEntryNode::new);
         register(ProtoParser.RULE_option, OptionNode::new);
-        register(ProtoParser.RULE_optionName, OptionNameNode::new);
+        register(ProtoParser.RULE_fieldRerefence, FieldReferenceNode::new);
+        register(ProtoParser.RULE_standardFieldRerefence, StandardFieldReferenceNode::new);
+        register(ProtoParser.RULE_customFieldReference, CustomFieldReferenceNode::new);
         register(ProtoParser.RULE_optionValue, OptionValueNode::new);
         register(ProtoParser.RULE_oneof, OneOfNode::new);
         register(ProtoParser.RULE_oneofField, OneofFieldNode::new);
         register(ProtoParser.RULE_extendBlock, ExtendNode::new);
+        register(ProtoParser.RULE_extendBlockEntry, ExtendEntryNode::new);
         register(ProtoParser.RULE_extensions, ExtensionsNode::new);
         register(ProtoParser.RULE_map, MapNode::new);
         register(ProtoParser.RULE_mapKey, MapKeyNode::new);

src/main/java/io/protostuff/jetbrains/plugin/formatter/BlockFactory.java

@@ -1,5 +1,6 @@
 package io.protostuff.jetbrains.plugin.formatter;
 
+import static io.protostuff.compiler.parser.ProtoParser.RULE_customFieldReference;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_enumBlock;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_enumField;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_enumFieldName;
@@ -12,6 +13,7 @@
 import static io.protostuff.compiler.parser.ProtoParser.RULE_fieldModifier;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_fieldName;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_fieldOptions;
+import static io.protostuff.compiler.parser.ProtoParser.RULE_fieldRerefence;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_fileReference;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_fullIdent;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_groupBlock;
@@ -29,7 +31,6 @@
 import static io.protostuff.compiler.parser.ProtoParser.RULE_oneofName;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_option;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_optionEntry;
-import static io.protostuff.compiler.parser.ProtoParser.RULE_optionName;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_optionValue;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_packageName;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_packageStatement;
@@ -45,6 +46,7 @@
 import static io.protostuff.compiler.parser.ProtoParser.RULE_rpcType;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_serviceBlock;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_serviceName;
+import static io.protostuff.compiler.parser.ProtoParser.RULE_standardFieldRerefence;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_syntax;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_tag;
 import static io.protostuff.compiler.parser.ProtoParser.RULE_textFormat;
@@ -88,7 +90,9 @@ class BlockFactory {
         register(rule(RULE_fieldName), LeafBlock::new);
         register(rule(RULE_textFormatOptionName), LeafBlock::new);
         register(rule(RULE_textFormatOptionValue), LeafBlock::new);
-        register(rule(RULE_optionName), LeafBlock::new);
+        register(rule(RULE_fieldRerefence), LeafBlock::new);
+        register(rule(RULE_standardFieldRerefence), LeafBlock::new);
+        register(rule(RULE_customFieldReference), LeafBlock::new);
         register(rule(RULE_optionValue), LeafBlock::new);
         register(rule(RULE_fieldModifier), LeafBlock::new);
         register(rule(RULE_typeReference), LeafBlock::new);

src/main/java/io/protostuff/jetbrains/plugin/psi/AbstractFieldReferenceNode.java

@@ -0,0 +1,24 @@
+package io.protostuff.jetbrains.plugin.psi;
+
+import com.intellij.lang.ASTNode;
+import org.antlr.jetbrains.adapter.psi.AntlrPsiNode;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Base class for field reference node parts, used in option name.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public abstract class AbstractFieldReferenceNode extends AntlrPsiNode {
+
+    public AbstractFieldReferenceNode(@NotNull ASTNode node) {
+        super(node);
+    }
+
+
+    /**
+     * Returns true if field reference refers to an extension field.
+     */
+    public abstract boolean isExtension();
+
+}

src/main/java/io/protostuff/jetbrains/plugin/psi/CustomFieldReferenceNode.java

@@ -0,0 +1,22 @@
+package io.protostuff.jetbrains.plugin.psi;
+
+import com.intellij.lang.ASTNode;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Custom field reference node, part of option name (custom options).
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class CustomFieldReferenceNode extends AbstractFieldReferenceNode {
+
+    public CustomFieldReferenceNode(@NotNull ASTNode node) {
+        super(node);
+    }
+
+    @Override
+    public boolean isExtension() {
+        return true;
+    }
+
+}

src/main/java/io/protostuff/jetbrains/plugin/psi/DataTypeContainer.java

@@ -17,4 +17,6 @@ public interface DataTypeContainer {
 
     Collection<DataType> getDeclaredDataTypes();
 
+    Collection<ExtendNode> getDeclaredExtensions();
+
 }

src/main/java/io/protostuff/jetbrains/plugin/psi/ExtendEntryNode.java

@@ -0,0 +1,18 @@
+package io.protostuff.jetbrains.plugin.psi;
+
+import com.intellij.lang.ASTNode;
+import org.antlr.jetbrains.adapter.psi.AntlrPsiNode;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Extend entry node.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class ExtendEntryNode extends AntlrPsiNode implements KeywordsContainer {
+
+    public ExtendEntryNode(@NotNull ASTNode node) {
+        super(node);
+    }
+
+}

src/main/java/io/protostuff/jetbrains/plugin/psi/ExtendNode.java

@@ -1,6 +1,9 @@
 package io.protostuff.jetbrains.plugin.psi;
 
 import com.intellij.lang.ASTNode;
+import com.intellij.psi.PsiElement;
+import java.util.HashMap;
+import java.util.Map;
 import org.antlr.jetbrains.adapter.psi.AntlrPsiNode;
 import org.jetbrains.annotations.NotNull;
 
@@ -15,4 +18,39 @@ public ExtendNode(@NotNull ASTNode node) {
         super(node);
     }
 
+    public TypeReferenceNode getTarget() {
+        return findChildByClass(TypeReferenceNode.class);
+    }
+
+    /**
+     * Returns namespace for fields of this extension.
+     */
+    public String getNamespace() {
+        PsiElement parent = getParent();
+        while (parent != null) {
+            if (parent instanceof DataTypeContainer) {
+                DataTypeContainer message = (DataTypeContainer) parent;
+                return message.getNamespace();
+            }
+        }
+        return ".";
+    }
+
+    /**
+     * Returns extension fields.
+     */
+    public Map<String, FieldNode> getExtensionFields() {
+        Map<String, FieldNode> result = new HashMap<>();
+        ExtendEntryNode[] entries = findChildrenByClass(ExtendEntryNode.class);
+        for (ExtendEntryNode entry : entries) {
+            for (PsiElement element : entry.getChildren()) {
+                if (element instanceof FieldNode) {
+                    FieldNode field = (FieldNode) element;
+                    result.put(field.getFieldName(), field);
+                }
+            }
+        }
+        return result;
+    }
+
 }

src/main/java/io/protostuff/jetbrains/plugin/psi/FieldNode.java

@@ -48,6 +48,10 @@ public String getFieldName() {
         return "";
     }
 
+    public TypeReferenceNode getFieldType() {
+        return findChildByClass(TypeReferenceNode.class);
+    }
+
     @Override
     public ASTNode getFieldNameNode() {
         ASTNode node = getNode();

src/main/java/io/protostuff/jetbrains/plugin/psi/FieldReferenceNode.java

@@ -0,0 +1,35 @@
+package io.protostuff.jetbrains.plugin.psi;
+
+import com.intellij.lang.ASTNode;
+import com.intellij.psi.PsiReference;
+import io.protostuff.jetbrains.plugin.reference.FieldReferenceProvider;
+import org.antlr.jetbrains.adapter.psi.AntlrPsiNode;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Option name node.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class FieldReferenceNode extends AntlrPsiNode implements KeywordsContainer {
+
+    public FieldReferenceNode(@NotNull ASTNode node) {
+        super(node);
+    }
+
+    @Override
+    public PsiReference getReference() {
+        PsiReference[] references = getReferences();
+        if (references.length > 0) {
+            return references[0];
+        }
+        return null;
+    }
+
+    @NotNull
+    @Override
+    public PsiReference[] getReferences() {
+        FieldReferenceProvider referenceProvider = getProject().getComponent(FieldReferenceProvider.class);
+        return referenceProvider.getReferencesByElement(this);
+    }
+}