28: Spellchecker support

Fixes #28
Fixes #92

Author: kshchepanovskyi

build.gradle

@@ -33,7 +33,7 @@ dependencies {
         exclude group: 'org.slf4j'
     }
     compile 'com.google.guava:guava:21.0'
-    compile ('io.protostuff:protostuff-parser:2.2.25') {
+    compile ('io.protostuff:protostuff-parser:2.2.26') {
         exclude group: 'org.slf4j'
     }
     compile ('io.sentry:sentry:1.7.5') {

src/main/java/io/protostuff/jetbrains/plugin/spellchecker/ProtoSpellcheckingStrategy.java

@@ -0,0 +1,38 @@
+package io.protostuff.jetbrains.plugin.spellchecker;
+
+import com.intellij.lang.ASTNode;
+import com.intellij.psi.PsiElement;
+import com.intellij.spellchecker.inspections.PlainTextSplitter;
+import com.intellij.spellchecker.tokenizer.SpellcheckingStrategy;
+import com.intellij.spellchecker.tokenizer.TokenConsumer;
+import com.intellij.spellchecker.tokenizer.Tokenizer;
+import io.protostuff.compiler.parser.ProtoLexer;
+import io.protostuff.jetbrains.plugin.ProtoParserDefinition;
+import org.antlr.jetbrains.adapter.lexer.TokenIElementType;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Spellchecker support.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class ProtoSpellcheckingStrategy extends SpellcheckingStrategy {
+
+    private static final TokenIElementType STRING_VALUE_TOKEN = ProtoParserDefinition.token(ProtoLexer.STRING_VALUE);
+    private static final Tokenizer<PsiElement> STRING_VALUE_TOKENIZER = new Tokenizer<PsiElement>() {
+        @Override
+        public void tokenize(@NotNull PsiElement element, TokenConsumer consumer) {
+            consumer.consumeToken(element, PlainTextSplitter.getInstance());
+        }
+    };
+
+    @NotNull
+    @Override
+    public Tokenizer getTokenizer(PsiElement element) {
+        ASTNode node = element.getNode();
+        if (node != null && node.getElementType() == STRING_VALUE_TOKEN) {
+            return STRING_VALUE_TOKENIZER;
+        }
+        return super.getTokenizer(element);
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -213,6 +213,9 @@
         <stubIndex implementation="io.protostuff.jetbrains.plugin.psi.indices.DataTypeFullNameIndex"/>
         <stubIndex implementation="io.protostuff.jetbrains.plugin.psi.indices.DataTypeNameIndex"/>
 
+        <spellchecker.support
+                language="PROTO"
+                implementationClass="io.protostuff.jetbrains.plugin.spellchecker.ProtoSpellcheckingStrategy" />
     </extensions>
 
     <actions>

src/test/java/io/protostuff/jetbrains/plugin/spellchecker/SpellcheckerTest.java

@@ -0,0 +1,25 @@
+package io.protostuff.jetbrains.plugin.spellchecker;
+
+import com.google.common.collect.ImmutableList;
+import com.intellij.spellchecker.inspections.SpellCheckingInspection;
+import io.protostuff.jetbrains.plugin.AbstractProtobufLibraryDependentTestCase;
+
+/**
+ * Test for spell checker.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class SpellcheckerTest extends AbstractProtobufLibraryDependentTestCase {
+
+    @Override
+    protected String getTestDataPath() {
+        return "src/test/resources/";
+    }
+
+
+    public void testSpellchecking() {
+        myFixture.configureByFile("spellchecker/SpellcheckerTest.proto");
+        myFixture.enableInspections(ImmutableList.of(SpellCheckingInspection.class));
+        myFixture.checkHighlighting();
+    }
+}

src/test/resources/spellchecker/SpellcheckerTest.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+import "google/<TYPO descr="Typo: In word 'protobuf'">protobuf</TYPO>/descriptor.proto";
+
+// <TYPO descr="Typo: In word 'badcomment'">badcomment</TYPO>
+
+message <TYPO descr="Typo: In word 'Badmessagename'">Badmessagename</TYPO> {
+int32 <TYPO descr="Typo: In word 'badfieldname'">badfieldname</TYPO> = 1 [(note) = "<TYPO descr="Typo: In word 'badstringliteral'">badstringliteral</TYPO>"];
+}
+
+enum <TYPO descr="Typo: In word 'Badenumname'">Badenumname</TYPO> {
+    <TYPO descr="Typo: In word 'BADENUMCONSTANTNAME'">BADENUMCONSTANTNAME</TYPO> = 0;
+}
+
+extend google.protobuf.FieldOptions {
+    string note = 50003;
+}