[FEATURE] CSV Usages Handler added

- includes several code reworks for better re-use and improved performance

Fixes #30

Author: SeeSharpSoft

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

@@ -1,6 +1,9 @@
 package net.seesharpsoft.intellij.plugins.csv;
 
-import com.intellij.lang.annotation.*;
+import com.intellij.lang.annotation.Annotation;
+import com.intellij.lang.annotation.AnnotationHolder;
+import com.intellij.lang.annotation.Annotator;
+import com.intellij.lang.annotation.HighlightSeverity;
 import com.intellij.openapi.editor.markup.AttributesFlyweight;
 import com.intellij.openapi.editor.markup.TextAttributes;
 import com.intellij.psi.PsiElement;
@@ -9,45 +12,27 @@
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvTypes;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.Map;
-
 public class CsvAnnotator implements Annotator {
 
     private static final TextAttributes EMPTY_TEXT_ATTRIBUTES = TextAttributes.fromFlyweight(AttributesFlyweight.create(null, null, 0, null, null, null));
 
     @Override
     public void annotate(@NotNull final PsiElement element, @NotNull AnnotationHolder holder) {
-        if (CsvHelper.getElementType(element) != CsvTypes.FIELD) {
+        if (CsvHelper.getElementType(element) != CsvTypes.FIELD || !(element.getContainingFile() instanceof CsvFile)) {
             return;
         }
 
-        AnnotationSession currentAnnotationSession = holder.getCurrentAnnotationSession();
-        Map<Integer, CsvColumnInfo<PsiElement>> columnInfoMap = currentAnnotationSession.getUserData(CsvHelper.COLUMN_INFO_KEY);
-        if (columnInfoMap == null) {
-            columnInfoMap = CsvHelper.createColumnInfoMap((CsvFile)element.getContainingFile());
-            currentAnnotationSession.putUserData(CsvHelper.COLUMN_INFO_KEY, columnInfoMap);
-        }
-
-        CsvColumnInfo<PsiElement> columnInfo = getColumnInfo(element, columnInfoMap);
+        CsvFile csvFile = (CsvFile)element.getContainingFile();
+        CsvColumnInfo<PsiElement> columnInfo = csvFile.getMyColumnInfoMap().getColumnInfo(element);
 
         if (columnInfo != null) {
             PsiElement headerElement = columnInfo.getHeaderElement();
             String message = XmlStringUtil.escapeString(headerElement == null ? "" : headerElement.getText(), true);
             String tooltip = XmlStringUtil.wrapInHtml(String.format("%s<br /><br />Column: %s<br />Index: %d", XmlStringUtil.escapeString(element.getText(), true), message, columnInfo.getColumnIndex()));
 
-            Annotation annotation = holder.createAnnotation(HighlightSeverity.WARNING, element.getTextRange(), message, tooltip);
+            Annotation annotation = holder.createAnnotation(HighlightSeverity.INFORMATION, element.getTextRange(), message, tooltip);
             annotation.setEnforcedTextAttributes(EMPTY_TEXT_ATTRIBUTES);
             annotation.setNeedsUpdateOnTyping(false);
         }
     }
-
-    protected CsvColumnInfo<PsiElement> getColumnInfo(@NotNull final PsiElement element, @NotNull Map<Integer, CsvColumnInfo<PsiElement>> columnInfoMap) {
-        for (Map.Entry<Integer, CsvColumnInfo<PsiElement>> entry : columnInfoMap.entrySet()) {
-            CsvColumnInfo<PsiElement> columnInfo = entry.getValue();
-            if (columnInfo.containsElement(element)) {
-                return columnInfo;
-            }
-        }
-        return null;
-    }
 }

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

@@ -0,0 +1,37 @@
+package net.seesharpsoft.intellij.plugins.csv;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+public class CsvColumnInfoMap<T> {
+
+    private final Map<Integer, CsvColumnInfo<T>> infoColumnMap;
+    private final Map<T, CsvColumnInfo<T>> reverseInfoColumnMap;
+
+    public CsvColumnInfoMap(Map<Integer, CsvColumnInfo<T>> infoColumnMap) {
+        this.infoColumnMap = infoColumnMap;
+        this.reverseInfoColumnMap = new HashMap<>();
+        buildReverseMap();
+    }
+
+    private void buildReverseMap() {
+        for (CsvColumnInfo<T> columnInfo : this.infoColumnMap.values()) {
+            for (T element : columnInfo.getElements()) {
+                this.reverseInfoColumnMap.put(element, columnInfo);
+            }
+        }
+    }
+
+    public CsvColumnInfo<T> getColumnInfo(T element) {
+        return reverseInfoColumnMap.get(element);
+    }
+
+    public CsvColumnInfo<T> getColumnInfo(int columnIndex) {
+        return infoColumnMap.get(columnIndex);
+    }
+
+    public Map<Integer, CsvColumnInfo<T>> getColumnInfos() {
+        return Collections.unmodifiableMap(this.infoColumnMap);
+    }
+}

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

@@ -3,7 +3,6 @@
 import com.intellij.lang.*;
 import com.intellij.lexer.Lexer;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.util.Key;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiManager;
 import com.intellij.psi.TokenType;
@@ -22,8 +21,6 @@
 
 public class CsvHelper {
 
-    public static final Key<Map<Integer, CsvColumnInfo<PsiElement>>> COLUMN_INFO_KEY = Key.create("COLUMN_INFO_KEY");
-
     // replaces PsiElementFactory.SERVICE.getInstance(element.getProject()).createDummyHolder("<undefined>", CsvTypes.FIELD, null);
     // https://github.com/SeeSharpSoft/intellij-csv-validator/issues/4
     public static PsiElement createEmptyCsvField(Project project) {
@@ -45,7 +42,19 @@ public static IElementType getElementType(PsiElement element) {
     }
 
     public static PsiElement getParentFieldElement(PsiElement element) {
-        if (CsvHelper.getElementType(element) == TokenType.WHITE_SPACE) {
+        IElementType elementType = CsvHelper.getElementType(element);
+
+        if(elementType == CsvTypes.COMMA || elementType == CsvTypes.CRLF) {
+            element = element.getPrevSibling();
+            elementType = CsvHelper.getElementType(element);
+        }
+
+        if(elementType == CsvTypes.RECORD) {
+            element = element.getLastChild();
+            elementType = CsvHelper.getElementType(element);
+        }
+
+        if (elementType == TokenType.WHITE_SPACE) {
             if (CsvHelper.getElementType(element.getParent()) == CsvTypes.FIELD) {
                 element = element.getParent();
             } else if (CsvHelper.getElementType(element.getPrevSibling()) == CsvTypes.FIELD) {
@@ -56,14 +65,15 @@ public static PsiElement getParentFieldElement(PsiElement element) {
                 element = null;
             }
         } else {
-            while (element != null && CsvHelper.getElementType(element) != CsvTypes.FIELD) {
+            while (element != null && elementType != CsvTypes.FIELD) {
                 element = element.getParent();
+                elementType = CsvHelper.getElementType(element);
             }
         }
         return element;
     }
 
-    public static Map<Integer, CsvColumnInfo<PsiElement>> createColumnInfoMap(CsvFile csvFile) {
+    public static CsvColumnInfoMap<PsiElement> createColumnInfoMap(CsvFile csvFile) {
         Map<Integer, CsvColumnInfo<PsiElement>> columnInfoMap = new HashMap<>();
         CsvRecord[] records = PsiTreeUtil.getChildrenOfType(csvFile, CsvRecord.class);
         int row = 0;
@@ -81,7 +91,6 @@ public static Map<Integer, CsvColumnInfo<PsiElement>> createColumnInfoMap(CsvFil
             }
             ++row;
         }
-        return columnInfoMap;
+        return new CsvColumnInfoMap(columnInfoMap);
     }
-
 }

src/main/java/net/seesharpsoft/intellij/plugins/csv/formatter/CsvFormattingInfo.java

@@ -3,16 +3,13 @@
 import com.intellij.formatting.SpacingBuilder;
 import com.intellij.lang.ASTNode;
 import com.intellij.psi.codeStyle.CodeStyleSettings;
-import net.seesharpsoft.intellij.plugins.csv.settings.CsvCodeStyleSettings;
 import net.seesharpsoft.intellij.plugins.csv.CsvColumnInfo;
+import net.seesharpsoft.intellij.plugins.csv.CsvColumnInfoMap;
+import net.seesharpsoft.intellij.plugins.csv.settings.CsvCodeStyleSettings;
 
-import java.util.HashMap;
 import java.util.Map;
 
-public class CsvFormattingInfo {
-    private Map<Integer, CsvColumnInfo<ASTNode>> infoColumnMap;
-    
-    private Map<ASTNode, CsvColumnInfo<ASTNode>> reverseInfoColumnMap;
+public class CsvFormattingInfo extends CsvColumnInfoMap<ASTNode> {
 
     public SpacingBuilder getSpacingBuilder() {
         return spacingBuilder;
@@ -31,27 +28,8 @@ public CodeStyleSettings getCodeStyleSettings() {
     private CodeStyleSettings codeStyleSettings;
 
     public CsvFormattingInfo(CodeStyleSettings codeStyleSettings, SpacingBuilder spacingBuilder, Map<Integer, CsvColumnInfo<ASTNode>> infoColumnMap) {
-        this.infoColumnMap = infoColumnMap;
+        super(infoColumnMap);
         this.spacingBuilder = spacingBuilder;
         this.codeStyleSettings = codeStyleSettings;
-        buildReverseMap();
-    }
-    
-    private void buildReverseMap() {
-        reverseInfoColumnMap = new HashMap<>();
-        for (CsvColumnInfo<ASTNode> columnInfo : infoColumnMap.values()) {
-            for (ASTNode node : columnInfo.getElements()) {
-                reverseInfoColumnMap.put(node, columnInfo);
-            }
-        }
-    }
-
-    public CsvColumnInfo getColumnInfo(ASTNode node) {
-        return reverseInfoColumnMap.get(node);
-    }
-
-    public CsvColumnInfo getColumnInfo(int columnIndex) {
-        return infoColumnMap.get(columnIndex);
     }
-
 }

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

@@ -0,0 +1,50 @@
+package net.seesharpsoft.intellij.plugins.csv.highlighter;
+
+import com.intellij.codeInsight.highlighting.HighlightUsagesHandlerBase;
+import com.intellij.openapi.editor.Caret;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.psi.PsiElement;
+import com.intellij.util.Consumer;
+import net.seesharpsoft.intellij.plugins.csv.CsvColumnInfo;
+import net.seesharpsoft.intellij.plugins.csv.CsvHelper;
+import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collections;
+import java.util.List;
+
+public class CsvHighlightUsagesHandler extends HighlightUsagesHandlerBase<PsiElement> {
+
+    protected CsvHighlightUsagesHandler(@NotNull Editor editor, @NotNull CsvFile file) {
+        super(editor, file);
+    }
+
+    protected CsvFile getCsvFile() {
+        return (CsvFile)this.myFile;
+    }
+
+    @Override
+    public List<PsiElement> getTargets() {
+        Caret primaryCaret = this.myEditor.getCaretModel().getPrimaryCaret();
+        PsiElement myFocusedFieldElement = CsvHelper.getParentFieldElement(this.myFile.getViewProvider().findElementAt(primaryCaret.getOffset()));
+
+        if (myFocusedFieldElement == null) {
+            return Collections.emptyList();
+        }
+
+        CsvColumnInfo<PsiElement> columnInfo = getCsvFile().getMyColumnInfoMap().getColumnInfo(myFocusedFieldElement);
+        return columnInfo == null ? Collections.emptyList() : Collections.unmodifiableList(columnInfo.getElements());
+    }
+
+    @Override
+    protected void selectTargets(List<PsiElement> list, Consumer<List<PsiElement>> consumer) {
+        consumer.consume(list);
+    }
+
+    @Override
+    public void computeUsages(List<PsiElement> list) {
+        list.forEach(element -> {
+            if (element != null && !element.getText().isEmpty()) { this.addOccurrence(element); }
+        });
+    }
+}

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

@@ -0,0 +1,20 @@
+package net.seesharpsoft.intellij.plugins.csv.highlighter;
+
+import com.intellij.codeInsight.highlighting.HighlightUsagesHandlerBase;
+import com.intellij.codeInsight.highlighting.HighlightUsagesHandlerFactory;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.psi.PsiFile;
+import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class CsvHighlightUsagesHandlerFactory implements HighlightUsagesHandlerFactory {
+    @Nullable
+    @Override
+    public HighlightUsagesHandlerBase createHighlightUsagesHandler(@NotNull Editor editor, @NotNull PsiFile psiFile) {
+        if (psiFile instanceof CsvFile) {
+            return new CsvHighlightUsagesHandler(editor, (CsvFile)psiFile);
+        }
+        return null;
+    }
+}

src/main/java/net/seesharpsoft/intellij/plugins/csv/intention/CsvShiftColumnLeftIntentionAction.java

@@ -5,12 +5,11 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.util.IncorrectOperationException;
 import net.seesharpsoft.intellij.plugins.csv.CsvColumnInfo;
+import net.seesharpsoft.intellij.plugins.csv.CsvColumnInfoMap;
 import net.seesharpsoft.intellij.plugins.csv.CsvHelper;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.Map;
-
 public class CsvShiftColumnLeftIntentionAction extends CsvShiftColumnIntentionAction {
 
     public CsvShiftColumnLeftIntentionAction() {
@@ -19,27 +18,20 @@ public CsvShiftColumnLeftIntentionAction() {
 
     @Override
     public void invoke(@NotNull Project project, Editor editor, @NotNull PsiElement psiElement) throws IncorrectOperationException {
-        CsvFile psiFile = (CsvFile)psiElement.getContainingFile();
+        CsvFile csvFile = (CsvFile)psiElement.getContainingFile();
 
         psiElement = CsvHelper.getParentFieldElement(psiElement);
 
-        Map<Integer, CsvColumnInfo<PsiElement>> columnInfoMap = CsvHelper.createColumnInfoMap(psiFile);
-
-        CsvColumnInfo<PsiElement> rightColumnInfo = null;
-        for (CsvColumnInfo columnInfo : columnInfoMap.values()) {
-            if (columnInfo.containsElement(psiElement)) {
-                rightColumnInfo = columnInfo;
-                break;
-            }
-        }
+        CsvColumnInfoMap<PsiElement> columnInfoMap = csvFile.getMyColumnInfoMap();
+        CsvColumnInfo<PsiElement> rightColumnInfo = columnInfoMap.getColumnInfo(psiElement);
 
         // column must be at least index 1 to be shifted left
         if (rightColumnInfo == null || rightColumnInfo.getColumnIndex() < 1) {
             return;
         }
 
-        CsvColumnInfo<PsiElement> leftColumnInfo = columnInfoMap.get(rightColumnInfo.getColumnIndex() - 1);
+        CsvColumnInfo<PsiElement> leftColumnInfo = columnInfoMap.getColumnInfo(rightColumnInfo.getColumnIndex() - 1);
 
-        changeLeftAndRightColumnOrder(project, psiFile, leftColumnInfo, rightColumnInfo);
+        changeLeftAndRightColumnOrder(project, csvFile, leftColumnInfo, rightColumnInfo);
     }
 }

src/main/java/net/seesharpsoft/intellij/plugins/csv/intention/CsvShiftColumnRightIntentionAction.java

@@ -5,12 +5,11 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.util.IncorrectOperationException;
 import net.seesharpsoft.intellij.plugins.csv.CsvColumnInfo;
+import net.seesharpsoft.intellij.plugins.csv.CsvColumnInfoMap;
 import net.seesharpsoft.intellij.plugins.csv.CsvHelper;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.Map;
-
 public class CsvShiftColumnRightIntentionAction extends CsvShiftColumnIntentionAction {
 
     public CsvShiftColumnRightIntentionAction() {
@@ -19,27 +18,20 @@ public CsvShiftColumnRightIntentionAction() {
 
     @Override
     public void invoke(@NotNull Project project, Editor editor, @NotNull PsiElement psiElement) throws IncorrectOperationException {
-        CsvFile psiFile = (CsvFile)psiElement.getContainingFile();
+        CsvFile csvFile = (CsvFile)psiElement.getContainingFile();
 
         psiElement = CsvHelper.getParentFieldElement(psiElement);
 
-        Map<Integer, CsvColumnInfo<PsiElement>> columnInfoMap = CsvHelper.createColumnInfoMap(psiFile);
-
-        CsvColumnInfo<PsiElement> leftColumnInfo = null;
-        for (CsvColumnInfo columnInfo : columnInfoMap.values()) {
-            if (columnInfo.containsElement(psiElement)) {
-                leftColumnInfo = columnInfo;
-                break;
-            }
-        }
+        CsvColumnInfoMap<PsiElement> columnInfoMap = csvFile.getMyColumnInfoMap();
+        CsvColumnInfo<PsiElement> leftColumnInfo = columnInfoMap.getColumnInfo(psiElement);
 
         // column must be at least index 1 to be shifted left
-        if (leftColumnInfo == null || leftColumnInfo.getColumnIndex() + 1 >= columnInfoMap.size()) {
+        if (leftColumnInfo == null || leftColumnInfo.getColumnIndex() + 1 >= columnInfoMap.getColumnInfos().size()) {
             return;
         }
 
-        CsvColumnInfo<PsiElement> rightColumnInfo = columnInfoMap.get(leftColumnInfo.getColumnIndex() + 1);
+        CsvColumnInfo<PsiElement> rightColumnInfo = columnInfoMap.getColumnInfo(leftColumnInfo.getColumnIndex() + 1);
 
-        changeLeftAndRightColumnOrder(project, psiFile, leftColumnInfo, rightColumnInfo);
+        changeLeftAndRightColumnOrder(project, csvFile, leftColumnInfo, rightColumnInfo);
     }
 }