Merge pull request #58 from SeeSharpSoft/master

Release 1.8.2

Author: SeeSharpSoft

README.md

@@ -21,6 +21,8 @@ This enables default editor features like syntax validation, highlighting and in
 - intentions (Alt+Enter), e.g. Quote/Unquote (all), Shift Column Left/Right
 - structure view (header-entry layout)
 - support for ',', ';', '|' and '↹' as value separator
+- highlight of active column values
+- customizable column coloring
 
 ### Syntax parser & validation
 
@@ -38,16 +40,6 @@ Please note that if a document is syntactically incorrect, other features like c
 
 ![Editor with syntax validation and highlighting](./docs/editor.png)
 
-### Highlighting
-
-The different symbols of a CSV document, namely the separator (comma), the quotes, the escaped literals and the text elements itself, are highlighted by a coloring scheme that can be customized:
-
-- _File > Settings > Editor > Color Scheme > CSV_
-
-Preset colors are based on Jetbrains IDE defaults and support the different UI themes.
-
-![Color scheme settings](./docs/colorsettings.png)
-
 ### Separator
 
 CSV files provide a high degree of flexibility and can be used universally for all kind of data.
@@ -63,6 +55,21 @@ Additionally the file type TSV was introduced as a kind of CSV language.
 For TSV files the same formatter and code style settings are applied as for CSV itself, but the separator is considered to be a tab.
 All functionality that is available for plain CSV files (inspections, intentions, structure view, etc.) can be used for TSV as well.   
 
+### Highlighting
+
+The different symbols of a CSV document, namely the separator (comma), the quotes, the escaped literals and the text elements itself, are highlighted by a coloring scheme that can be customized:
+
+- _File > Settings > Editor > Color Scheme > CSV_
+
+Preset colors are based on Jetbrains IDE defaults and support the different UI themes.
+
+![Color scheme settings](./docs/colorsettings.png)
+
+#### Column Highlighting Colors
+
+**NEW**
+Besides defining colors and font-style variants for the different CSV symbols, additionally up to 10 different column highlight colors can be defined. Those colors are applied to the columns round robin. Undefined column highlight colors will be skipped if they are not followed by any other color definition.
+
 ### Formatting
 
 - _File > Settings > Editor > Code Style > CSV_

docs/colorsettings.png

@@ -3,7 +3,7 @@
 # https://www.jetbrains.com/intellij-repository/snapshots
 
 name='CSV Plugin'
-pluginVersion=1.8.1
+pluginVersion=1.8.2
 javaVersion=1.8
 javaTargetVersion=1.8
 downloadIntellijSources=false

gradle.properties

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<module external.linked.project.id="intellij-csv-validator" external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$" external.system.id="GRADLE" external.system.module.group="net.seesharpsoft.intellij.plugins" external.system.module.version="1.8.1" relativePaths="true" type="JAVA_MODULE" version="4">
+<module external.linked.project.id="intellij-csv-validator" external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$" external.system.id="GRADLE" external.system.module.group="net.seesharpsoft.intellij.plugins" external.system.module.version="1.8.2" relativePaths="true" type="JAVA_MODULE" version="4">
   <component name="NewModuleRootManager" inherit-compiler-output="true">
     <exclude-output />
     <content url="file://$MODULE_DIR$">

intellij-csv-validator.iml

@@ -1,11 +1,12 @@
 package net.seesharpsoft.intellij.plugins.csv.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.lang.annotation.*;
+import com.intellij.openapi.editor.colors.ColorKey;
+import com.intellij.openapi.editor.colors.EditorColorsManager;
+import com.intellij.openapi.editor.colors.EditorColorsScheme;
 import com.intellij.openapi.editor.markup.TextAttributes;
+import com.intellij.openapi.options.colors.ColorDescriptor;
+import com.intellij.openapi.util.Key;
 import com.intellij.openapi.util.TextRange;
 import com.intellij.psi.PsiElement;
 import com.intellij.xml.util.XmlStringUtil;
@@ -15,12 +16,26 @@
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvTypes;
 import org.jetbrains.annotations.NotNull;
 
+import java.awt.*;
+import java.util.ArrayList;
+import java.util.List;
+
 import static com.intellij.spellchecker.SpellCheckerSeveritiesProvider.TYPO;
 
+@SuppressWarnings("MagicNumber")
 public class CsvAnnotator implements Annotator {
 
-    private static final TextAttributes EMPTY_TEXT_ATTRIBUTES =
-            TextAttributes.fromFlyweight(AttributesFlyweight.create(null, null, 0, null, null, null));
+    protected static final Integer MAX_COLUMN_HIGHLIGHT_COLORS = 10;
+    protected static final Key<Integer> MAX_NO_OF_DEFINED_COLUMN_HIGHLIGHT_COLORS = Key.create("CSV_LAST_DEFINED_COLOR_INDEX_KEY");
+    
+    public static final ColorDescriptor[] COLOR_DESCRIPTORS;
+    static {
+        List<ColorDescriptor> colorDescriptorList = new ArrayList();
+        for (int i = 0; i < MAX_COLUMN_HIGHLIGHT_COLORS; ++i) {
+            colorDescriptorList.add(new ColorDescriptor(String.format("Column Highlighting Color %d", i + 1), ColorKey.createColorKey(String.format("CSV_COLUMN_COLOR_%d", i + 1), (Color) null), ColorDescriptor.Kind.BACKGROUND));
+        }
+        COLOR_DESCRIPTORS = colorDescriptorList.toArray(new ColorDescriptor[MAX_COLUMN_HIGHLIGHT_COLORS]);
+    }
 
     public static final HighlightSeverity CSV_COLUMN_INFO_SEVERITY =
             new HighlightSeverity("CSV_COLUMN_INFO_SEVERITY", TYPO.myVal + 5);
@@ -50,8 +65,26 @@ public void annotate(@NotNull final PsiElement element, @NotNull final Annotatio
             }
 
             Annotation annotation = holder.createAnnotation(CSV_COLUMN_INFO_SEVERITY, textRange, message, tooltip);
-            annotation.setEnforcedTextAttributes(EMPTY_TEXT_ATTRIBUTES);
+            annotation.setEnforcedTextAttributes(getTextAttributes(holder.getCurrentAnnotationSession(), columnInfo));
             annotation.setNeedsUpdateOnTyping(false);
         }
     }
+
+    protected TextAttributes getTextAttributes(AnnotationSession annotationSession, CsvColumnInfo<PsiElement> columnInfo) {
+        EditorColorsScheme editorColorsScheme = EditorColorsManager.getInstance().getGlobalScheme();
+        Integer maxNoOfDefinedColumnHighlightColors = annotationSession.getUserData(MAX_NO_OF_DEFINED_COLUMN_HIGHLIGHT_COLORS);
+        if (maxNoOfDefinedColumnHighlightColors == null) {
+            maxNoOfDefinedColumnHighlightColors = 0;
+            for (int colorDescriptorIndex = 0; colorDescriptorIndex < COLOR_DESCRIPTORS.length; ++colorDescriptorIndex) {
+                if (editorColorsScheme.getColor(COLOR_DESCRIPTORS[colorDescriptorIndex].getKey()) != null) {
+                    maxNoOfDefinedColumnHighlightColors = colorDescriptorIndex + 1;
+                }
+            }
+            annotationSession.putUserData(MAX_NO_OF_DEFINED_COLUMN_HIGHLIGHT_COLORS, maxNoOfDefinedColumnHighlightColors);
+        }
+        return maxNoOfDefinedColumnHighlightColors == 0 ? null :
+                new TextAttributes(null,
+                        editorColorsScheme.getColor(COLOR_DESCRIPTORS[columnInfo.getColumnIndex() % maxNoOfDefinedColumnHighlightColors].getKey()),
+                        null, null, 0);
+    }
 }

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

@@ -7,6 +7,7 @@
 import com.intellij.openapi.options.colors.ColorSettingsPage;
 import net.seesharpsoft.intellij.plugins.csv.CsvIconProvider;
 import net.seesharpsoft.intellij.plugins.csv.CsvLanguage;
+import net.seesharpsoft.intellij.plugins.csv.annotation.CsvAnnotator;
 import net.seesharpsoft.intellij.plugins.csv.highlighter.CsvSyntaxHighlighter;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -60,7 +61,7 @@ public AttributesDescriptor[] getAttributeDescriptors() {
     @NotNull
     @Override
     public ColorDescriptor[] getColorDescriptors() {
-        return ColorDescriptor.EMPTY_ARRAY;
+        return CsvAnnotator.COLOR_DESCRIPTORS;
     }
 
     @NotNull

src/main/java/net/seesharpsoft/intellij/plugins/csv/settings/CsvColorSettingsPage.java

@@ -18,6 +18,7 @@
         <li>structure view (header-entry layout)</li>
         <li>support for ',', ';', '|' or '&#8633;' as value separator</li>
         <li>highlight of active column values</li>
+        <li>customizable column coloring</li>
       </ul>
 
       <b>TSV file support:</b> <em>TSV files are recognized as such but treated as a variant of CSV files, the same syntax highlighting and code style settings are applied.</em>
@@ -37,15 +38,7 @@
     ]]></description>
 
     <change-notes><![CDATA[
-      <b>NEW:</b> Custom 'Wrapping' settings<br>
-      <b>NEW:</b> Column highlighter takes whitespaces into account<br>
-      <b>NEW:</b> East Asian full-width character support for 'Tabularize' (optional) - disabled by default due to lower performance<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>
-      <b>FIX:</b> Structure View: proper handling of <undefined> elements (instead of endless loading)<br>
-      + several code & performance improvements
+      <b>NEW:</b> Customizable column coloring (<i>File > Settings > Editor > Color Scheme > CSV</i><br>
       <br><br>
     ]]>
     </change-notes>