[INTERNAL] Column highlighting only happens on selection

Author: SeeSharpSoft

src/main/java/net/seesharpsoft/intellij/plugins/csv/highlighter/CsvHighlightUsagesHandler.java

@@ -1,7 +1,6 @@
 package net.seesharpsoft.intellij.plugins.csv.highlighter;
 
 import com.intellij.codeInsight.highlighting.HighlightUsagesHandlerBase;
-import com.intellij.lang.injection.InjectedLanguageManager;
 import com.intellij.openapi.editor.Caret;
 import com.intellij.openapi.editor.Editor;
 import com.intellij.openapi.util.TextRange;
@@ -28,6 +27,10 @@ protected CsvFile getCsvFile() {
 
     @Override
     public List<PsiElement> getTargets() {
+        if (!this.myEditor.getSelectionModel().hasSelection()) {
+            return Collections.emptyList();
+        }
+
         Caret primaryCaret = this.myEditor.getCaretModel().getPrimaryCaret();
         PsiElement myFocusedElement = this.myFile.getViewProvider().findElementAt(primaryCaret.getOffset());
         if (myFocusedElement == null) {
@@ -39,8 +42,7 @@ public List<PsiElement> getTargets() {
             return Collections.emptyList();
         }
 
-        CsvColumnInfo<PsiElement> columnInfo = getCsvFile().getMyColumnInfoMap().getColumnInfo(myFocusedElement);
-        return columnInfo == null ? Collections.emptyList() : Collections.unmodifiableList(columnInfo.getElements());
+        return Collections.singletonList(myFocusedElement);
     }
 
     @Override
@@ -51,19 +53,21 @@ protected void selectTargets(List<PsiElement> list, Consumer<List<PsiElement>> c
     @Override
     public void computeUsages(List<PsiElement> list) {
         CsvColumnInfoMap<PsiElement> columnInfoMap = getCsvFile().getMyColumnInfoMap();
-        list.forEach(element -> {
-            if (element != null && !element.getText().isEmpty()) { this.addOccurrence(columnInfoMap.getRowInfo(element)); }
-        });
+        for (PsiElement listElement : list) {
+            CsvColumnInfo<PsiElement> csvColumnInfo = getCsvFile().getMyColumnInfoMap().getColumnInfo(listElement);
+            if (csvColumnInfo == null) {
+                continue;
+            }
+            csvColumnInfo.getElements().forEach(element -> this.addOccurrence(columnInfoMap.getRowInfo(element)));
+        }
     }
 
     protected void addOccurrence(CsvColumnInfo<PsiElement>.RowInfo rowInfo) {
         if (rowInfo == null) {
             return;
         }
         TextRange range = rowInfo.getTextRange();
-        if (range != null) {
-            PsiElement element = rowInfo.getElement();
-            range = InjectedLanguageManager.getInstance(element.getProject()).injectedToHost(element, range);
+        if (range != null && range.getLength() > 0) {
             this.myReadUsages.add(range);
         }
     }

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

@@ -39,6 +39,7 @@
     <change-notes><![CDATA[
       <b>NEW:</b> Custom 'Wrapping' settings<br>
       <b>NEW:</b> Column highlighter takes whitespaces into account<br>
+      <b>CHANGE:</b> Column highlighting only happens on selection<br>
       <b>FIX:</b> CSV column info tooltip trumps spellchecker tooltip (but keeps the visualization of a typo)<br>
       <b>FIX:</b> Show tooltip even when caret is at the last position withing the CSV file<br>
       <b>FIX:</b> Support for suppressing inspections not relevant for CSV (e.g. 'Problematic Whitespace')<br>

src/test/java/net/seesharpsoft/intellij/plugins/csv/highlighter/CsvHighlightUsagesHandlerTest.java

@@ -1,5 +1,9 @@
 package net.seesharpsoft.intellij.plugins.csv.highlighter;
 
+import com.intellij.codeInsight.highlighting.HighlightUsagesHandler;
+import com.intellij.codeInsight.highlighting.HighlightUsagesHandlerBase;
+import com.intellij.featureStatistics.FeatureUsageTracker;
+import com.intellij.openapi.editor.Editor;
 import com.intellij.openapi.editor.markup.RangeHighlighter;
 import com.intellij.openapi.util.TextRange;
 import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
@@ -12,59 +16,80 @@ protected String getTestDataPath() {
     }
 
     private void assertHighlightedText(RangeHighlighter rangeHighlighter, String text) {
-        assertEquals(text,rangeHighlighter.getDocument().getText(TextRange.create(rangeHighlighter.getStartOffset(), rangeHighlighter.getEndOffset())));
+        assertEquals(text, rangeHighlighter.getDocument().getText(TextRange.create(rangeHighlighter.getStartOffset(), rangeHighlighter.getEndOffset())));
+    }
+
+    private RangeHighlighter[] testHighlightUsages(String... fileNames) {
+        myFixture.configureByFiles(fileNames);
+
+        HighlightUsagesHandlerBase handler = HighlightUsagesHandler.createCustomHandler(myFixture.getEditor(), myFixture.getFile());
+
+        String featureId = handler.getFeatureId();
+        if (featureId != null) {
+            FeatureUsageTracker.getInstance().triggerFeatureUsed(featureId);
+        }
+
+        handler.highlightUsages();
+
+        Editor editor = this.getEditor();
+        return editor.getMarkupModel().getAllHighlighters();
     }
 
     public void testHighlightUsages01() {
-        RangeHighlighter[] rangeHighlighters = myFixture.testHighlightUsages("HighlightUsagesTestData01.csv");
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData01.csv");
 
         assertSize(2, rangeHighlighters);
         assertHighlightedText(rangeHighlighters[0], " Header 2");
         assertHighlightedText(rangeHighlighters[1], " Value 2");
     }
 
     public void testHighlightUsages02() {
-        RangeHighlighter[] rangeHighlighters = myFixture.testHighlightUsages("HighlightUsagesTestData02.csv");
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData02.csv");
 
         assertSize(2, rangeHighlighters);
         assertHighlightedText(rangeHighlighters[0], " Header 2");
         assertHighlightedText(rangeHighlighters[1], " Value 2");
     }
 
     public void testHighlightUsages03() {
-        RangeHighlighter[] rangeHighlighters = myFixture.testHighlightUsages("HighlightUsagesTestData03.csv");
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData03.csv");
 
         assertSize(2, rangeHighlighters);
         assertHighlightedText(rangeHighlighters[0], "Header 1");
         assertHighlightedText(rangeHighlighters[1], "Value 1");
     }
 
     public void testHighlightUsages04() {
-        RangeHighlighter[] rangeHighlighters = myFixture.testHighlightUsages("HighlightUsagesTestData04.csv");
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData04.csv");
 
         assertSize(1, rangeHighlighters);
         assertHighlightedText(rangeHighlighters[0], " Value 3");
     }
 
     public void testHighlightUsages05() {
-        RangeHighlighter[] rangeHighlighters = myFixture.testHighlightUsages("HighlightUsagesTestData05.csv");
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData05.csv");
 
         assertSize(2, rangeHighlighters);
         assertHighlightedText(rangeHighlighters[0], " Header 2");
         assertHighlightedText(rangeHighlighters[1], " Value 2");
     }
 
     public void testHighlightUsages06() {
-        RangeHighlighter[] rangeHighlighters = myFixture.testHighlightUsages("HighlightUsagesTestData06.csv");
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData06.csv");
 
         assertSize(1, rangeHighlighters);
         assertHighlightedText(rangeHighlighters[0], " Value 3");
     }
 
     public void testHighlightUsages07() {
-        RangeHighlighter[] rangeHighlighters = myFixture.testHighlightUsages("HighlightUsagesTestData07.csv");
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData07.csv");
 
-        assertSize(1, rangeHighlighters);
-        assertHighlightedText(rangeHighlighters[0], " Header 2");
+        assertSize(0, rangeHighlighters);
+    }
+
+    public void testHighlightUsages08() {
+        RangeHighlighter[] rangeHighlighters = testHighlightUsages("HighlightUsagesTestData08.csv");
+
+        assertSize(0, rangeHighlighters);
     }
 }

src/test/resources/highlighter/HighlightUsagesTestData01.csv

@@ -1,2 +1,2 @@
 Header 1, Header 2
-Value 1, Value<caret> 2, Value 3
+Value 1, <selection>Value<caret></selection> 2, Value 3

src/test/resources/highlighter/HighlightUsagesTestData02.csv

@@ -1,2 +1,2 @@
-Header 1, Header 2<caret>
+Header 1, Header <selection>2<caret></selection>
 Value 1, Value 2, Value 3

src/test/resources/highlighter/HighlightUsagesTestData03.csv

@@ -1,2 +1,3 @@
 Header 1, Header 2
-Value 1<caret>, Value 2, Value 3
+,
+<selection>Value 1<caret></selection>, Value 2, Value 3

src/test/resources/highlighter/HighlightUsagesTestData04.csv

@@ -1,2 +1,2 @@
 Header 1, Header 2
-Value 1, Value 2, Value <caret>3
+Value 1, Value 2, Value<selection> <caret></selection>3

src/test/resources/highlighter/HighlightUsagesTestData05.csv

@@ -1,3 +1,3 @@
 Header 1, Header 2
 Value 1, Value 2, Value 3
-,<caret>,
+<selection>,<caret></selection>,

src/test/resources/highlighter/HighlightUsagesTestData06.csv

@@ -1,2 +1,2 @@
 Header 1, Header 2
-Value 1, Value 2, Value 3<caret>
+Value 1, Value 2, Value <selection>3<caret></selection>

src/test/resources/highlighter/HighlightUsagesTestData07.csv

@@ -1,2 +1,2 @@
 Header 1, Header 2
-Value 1,<caret>
+Value 1,<selection><caret></selection>