[FIX] higher priority for CSV tooltips than for spellchecker

Fixes #40

Author: SeeSharpSoft

src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvAnnotator.java

@@ -12,10 +12,14 @@
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvTypes;
 import org.jetbrains.annotations.NotNull;
 
+import static com.intellij.spellchecker.SpellCheckerSeveritiesProvider.TYPO;
+
 public class CsvAnnotator implements Annotator {
 
     private static final TextAttributes EMPTY_TEXT_ATTRIBUTES = TextAttributes.fromFlyweight(AttributesFlyweight.create(null, null, 0, null, null, null));
 
+    public static final HighlightSeverity CSV_COLUMN_INFO_SEVERITY = new HighlightSeverity("CSV_COLUMN_INFO_SEVERITY", TYPO.myVal + 5);
+
     @Override
     public void annotate(@NotNull final PsiElement element, @NotNull AnnotationHolder holder) {
         if (CsvHelper.getElementType(element) != CsvTypes.FIELD || !(element.getContainingFile() instanceof CsvFile)) {
@@ -30,7 +34,7 @@ public void annotate(@NotNull final PsiElement element, @NotNull AnnotationHolde
             String message = XmlStringUtil.escapeString(headerElement == null ? "" : headerElement.getText(), true);
             String tooltip = XmlStringUtil.wrapInHtml(String.format("%s<br /><br />Header: %s<br />Index: %d", XmlStringUtil.escapeString(element.getText(), true), message, columnInfo.getColumnIndex()));
 
-            Annotation annotation = holder.createAnnotation(HighlightSeverity.INFORMATION, element.getTextRange(), message, tooltip);
+            Annotation annotation = holder.createAnnotation(CSV_COLUMN_INFO_SEVERITY, element.getTextRange(), message, tooltip);
             annotation.setEnforcedTextAttributes(EMPTY_TEXT_ATTRIBUTES);
             annotation.setNeedsUpdateOnTyping(false);
         }

src/test/java/net/seesharpsoft/intellij/plugins/csv/CsvAnnotatorTest.java

@@ -1,6 +1,29 @@
 package net.seesharpsoft.intellij.plugins.csv;
 
+import com.intellij.codeInsight.daemon.impl.DaemonCodeAnalyzerImpl;
+import com.intellij.codeInsight.daemon.impl.HighlightInfo;
+import com.intellij.codeInsight.daemon.impl.HighlightInfoType;
+import com.intellij.openapi.Disposable;
+import com.intellij.openapi.editor.Document;
+import com.intellij.openapi.project.DumbService;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.Disposer;
+import com.intellij.psi.PsiDocumentManager;
+import com.intellij.psi.PsiFile;
+import com.intellij.psi.impl.cache.CacheManager;
+import com.intellij.psi.impl.source.PsiFileImpl;
+import com.intellij.psi.impl.source.tree.FileElement;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.testFramework.EdtTestUtil;
+import com.intellij.testFramework.ExpectedHighlightingData;
 import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+
+import static net.seesharpsoft.intellij.plugins.csv.CsvAnnotator.CSV_COLUMN_INFO_SEVERITY;
 
 public class CsvAnnotatorTest extends LightCodeInsightFixtureTestCase {
 
@@ -11,7 +34,68 @@ protected String getTestDataPath() {
 
     public void testAnnotator() {
         myFixture.configureByFile("AnnotatorTestData.csv");
-        myFixture.checkHighlighting(true, true, true, true);
+        this.collectAndCheckHighlighting();
+    }
+
+    private long collectAndCheckHighlighting() {
+        ExpectedHighlightingData data = new ExpectedHighlightingData(myFixture.getEditor().getDocument(), false, false, true, false, this.getHostFile());
+        data.registerHighlightingType("csv_column_info", new ExpectedHighlightingData.ExpectedHighlightingSet(CSV_COLUMN_INFO_SEVERITY, false, true));
+        data.init();
+        return this.collectAndCheckHighlighting(data);
+    }
+
+    private PsiFile getHostFile() {
+        return myFixture.getFile();
+    }
+
+    private long collectAndCheckHighlighting(@NotNull ExpectedHighlightingData data) {
+        Project project = myFixture.getProject();
+        EdtTestUtil.runInEdtAndWait(() -> {
+            PsiDocumentManager.getInstance(project).commitAllDocuments();
+        });
+        PsiFileImpl file = (PsiFileImpl)this.getHostFile();
+        FileElement hardRefToFileElement = file.calcTreeElement();
+        if (!DumbService.isDumb(project)) {
+            CacheManager.SERVICE.getInstance(project).getFilesWithWord("XXX", (short)2, GlobalSearchScope.allScope(project), true);
+        }
+
+        long start = System.currentTimeMillis();
+        Disposable disposable = Disposer.newDisposable();
+
+        List infos;
+        try {
+            infos = myFixture.doHighlighting();
+            this.removeDuplicatedRangesForInjected(infos);
+        } finally {
+            Disposer.dispose(disposable);
+        }
+
+        long elapsed = System.currentTimeMillis() - start;
+        data.checkResult(infos, file.getText());
+        if (data.hasLineMarkers()) {
+            Document document = myFixture.getDocument(this.getFile());
+            data.checkLineMarkers(DaemonCodeAnalyzerImpl.getLineMarkers(document, myFixture.getProject()), document.getText());
+        }
+
+        hardRefToFileElement.hashCode();
+        return elapsed;
+    }
+
+    private static void removeDuplicatedRangesForInjected(@NotNull List<HighlightInfo> infos) {
+        Collections.sort(infos, (o1, o2) -> {
+            int i = o2.startOffset - o1.startOffset;
+            return i != 0 ? i : o1.getSeverity().myVal - o2.getSeverity().myVal;
+        });
+        HighlightInfo prevInfo = null;
+
+        HighlightInfo info;
+        for(Iterator it = infos.iterator(); it.hasNext(); prevInfo = info.type == HighlightInfoType.INJECTED_LANGUAGE_FRAGMENT ? info : null) {
+            info = (HighlightInfo)it.next();
+            if (prevInfo != null && info.getSeverity() == HighlightInfoType.SYMBOL_TYPE_SEVERITY && info.getDescription() == null && info.startOffset == prevInfo.startOffset && info.endOffset == prevInfo.endOffset) {
+                it.remove();
+            }
+        }
+
     }
 
 }

src/test/resources/AnnotatorTestData.csv

@@ -1,2 +1,2 @@
-<info descr="Header 1">Header 1</info>, <info descr="Header 2">Header 2</info>
-<info descr="Header 1">Value 1</info>, <info descr="Header 2">Value 2</info>, <info descr="">Value 3</info>
+<csv_column_info descr="Header 1">Header 1</csv_column_info>, <csv_column_info descr="Header 2">Header 2</csv_column_info>
+<csv_column_info descr="Header 1">Value 1</csv_column_info>, <csv_column_info descr="Header 2">Value 2</csv_column_info>, <csv_column_info descr="">Value 3</csv_column_info>