Merge 4fd7c51 into a7a304d

SeeSharpSoft · Feb 7, 2020 · 7d6f92c · 7d6f92c
2 parents a7a304d + 4fd7c51
commit 7d6f92c
Show file tree

Hide file tree

Showing 54 changed files with 406 additions and 439 deletions.
diff --git a/gradle.properties b/gradle.properties
@@ -3,5 +3,5 @@
 # https://www.jetbrains.com/intellij-repository/snapshots
 
 name='CSV Plugin'
-javaVersion=1.8
-javaTargetVersion=1.8
+javaVersion=8
+javaTargetVersion=8
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/Csv.bnf b/src/main/java/net/seesharpsoft/intellij/plugins/csv/Csv.bnf
@@ -1,8 +1,6 @@
 {
   parserClass="net.seesharpsoft.intellij.plugins.csv.parser.CsvParser"
 
-  parserImports=["static net.seesharpsoft.intellij.plugins.csv.CsvParserUtil.*"]
-
   extends="com.intellij.extapi.psi.ASTWrapperPsiElement"
 
   psiClassPrefix="Csv"
@@ -25,10 +23,10 @@
 
 csvFile ::= record (CRLF record)* [CRLF]
 
-record ::= field ( << separator >> COMMA field)*
+record ::= field (COMMA field)*
 
 field ::= (escaped | nonEscaped)
 
-private escaped ::= QUOTE ( TEXT | << escapeCharacter >> ESCAPED_TEXT)* QUOTE
+private escaped ::= QUOTE (TEXT | ESCAPED_TEXT)* QUOTE
 
 private nonEscaped ::= TEXT*
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvEscapeCharacter.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvEscapeCharacter.java
@@ -0,0 +1,30 @@
+package net.seesharpsoft.intellij.plugins.csv;
+
+import java.util.regex.Pattern;
+
+public enum CsvEscapeCharacter {
+    QUOTE("\"", "Double Quote (\")"),
+    BACKSLASH("\\", "Backslash (\\)");
+
+    private final String myCharacter;
+    private final String myDisplay;
+    private final Pattern myPattern;
+
+    CsvEscapeCharacter(String character, String display) {
+        myCharacter = character;
+        myDisplay = display;
+        myPattern = Pattern.compile(Pattern.quote(myCharacter + "\""));
+    }
+
+    public String getCharacter() {
+        return myCharacter;
+    }
+
+    public String getDisplay() {
+        return myDisplay;
+    }
+
+    public boolean isEscapedQuote(String text) {
+        return myPattern.matcher(text).matches();
+    }
+}
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvHelper.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvHelper.java
@@ -18,7 +18,6 @@
 import com.intellij.psi.util.PsiTreeUtil;
 import net.seesharpsoft.intellij.lang.FileParserDefinition;
 import net.seesharpsoft.intellij.plugins.csv.components.CsvFileAttributes;
-import net.seesharpsoft.intellij.plugins.csv.editor.CsvEditorSettings;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvField;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvRecord;
@@ -152,16 +151,48 @@ public static int getFieldEndOffset(PsiElement field) {
         return separator == null ? field.getContainingFile().getTextLength() : separator.getTextOffset();
     }
 
-    public static CsvEditorSettings.EscapeCharacter getCurrentEscapeCharacter(CsvFile csvFile) {
-        return getCurrentEscapeCharacter(csvFile.getContainingFile());
+    public static VirtualFile getVirtualFile(PsiFile psiFile) {
+        return psiFile == null ? null : psiFile.getOriginalFile().getVirtualFile();
     }
 
-    public static CsvEditorSettings.EscapeCharacter getCurrentEscapeCharacter(PsiFile psiFile) {
-        return CsvFileAttributes.getInstance(psiFile.getProject()).getEscapeCharacter(psiFile);
+    public static Project getProject(PsiFile psiFile) {
+        return psiFile == null ? null : psiFile.getProject();
+    }
+
+    public static CsvValueSeparator getValueSeparator(CsvFile csvFile) {
+        return getValueSeparator(csvFile.getContainingFile());
+    }
+
+    public static CsvValueSeparator getValueSeparator(PsiFile psiFile) {
+        return getValueSeparator(getProject(psiFile), getVirtualFile(psiFile));
+    }
+
+    public static CsvValueSeparator getValueSeparator(Project project, VirtualFile virtualFile) {
+        return CsvFileAttributes.getInstance(project).getValueSeparator(project, virtualFile);
+    }
+
+    public static boolean hasValueSeparatorAttribute(@NotNull PsiFile psiFile) {
+        return CsvFileAttributes.getInstance(getProject(psiFile)).hasValueSeparatorAttribute(getProject(psiFile), getVirtualFile(psiFile));
+    }
+
+    public static CsvEscapeCharacter getEscapeCharacter(CsvFile csvFile) {
+        return getEscapeCharacter(csvFile.getContainingFile());
+    }
+
+    public static CsvEscapeCharacter getEscapeCharacter(PsiFile psiFile) {
+        return getEscapeCharacter(getProject(psiFile), getVirtualFile(psiFile));
+    }
+
+    public static CsvEscapeCharacter getEscapeCharacter(Project project, VirtualFile virtualFile) {
+        return CsvFileAttributes.getInstance(project).getEscapeCharacter(project, virtualFile);
+    }
+
+    public static boolean hasEscapeCharacterAttribute(@NotNull PsiFile psiFile) {
+        return CsvFileAttributes.getInstance(getProject(psiFile)).hasEscapeCharacterAttribute(getProject(psiFile), getVirtualFile(psiFile));
     }
 
     public static CsvColumnInfoMap<PsiElement> createColumnInfoMap(CsvFile csvFile) {
-        CsvEditorSettings.EscapeCharacter escapeCharacter = getCurrentEscapeCharacter(csvFile);
+        CsvEscapeCharacter escapeCharacter = getEscapeCharacter(csvFile);
         Map<Integer, CsvColumnInfo<PsiElement>> columnInfoMap = new HashMap<>();
         CsvRecord[] records = PsiTreeUtil.getChildrenOfType(csvFile, CsvRecord.class);
         int row = 0;
@@ -182,7 +213,7 @@ public static CsvColumnInfoMap<PsiElement> createColumnInfoMap(CsvFile csvFile)
         return new CsvColumnInfoMap(columnInfoMap, PsiTreeUtil.hasErrorElements(csvFile));
     }
 
-    public static String unquoteCsvValue(String content, CsvEditorSettings.EscapeCharacter escapeCharacter) {
+    public static String unquoteCsvValue(String content, CsvEscapeCharacter escapeCharacter) {
         if (content == null) {
             return "";
         }
@@ -194,15 +225,19 @@ public static String unquoteCsvValue(String content, CsvEditorSettings.EscapeCha
         return result;
     }
 
-    private static boolean isQuotingRequired(String content, String separator) {
-        return content != null && (content.contains(separator) || content.contains("\"") || content.contains("\n") || content.startsWith(" ") || content.endsWith(" "));
+    private static boolean isQuotingRequired(String content, CsvValueSeparator valueSeparator) {
+        return content != null &&
+                (content.contains(valueSeparator.getCharacter()) || content.contains("\"") || content.contains("\n") || content.startsWith(" ") || content.endsWith(" "));
     }
 
-    public static String quoteCsvField(String content, CsvEditorSettings.EscapeCharacter escapeCharacter, String separator, boolean quotingEnforced) {
+    public static String quoteCsvField(String content,
+                                       CsvEscapeCharacter escapeCharacter,
+                                       CsvValueSeparator valueSeparator,
+                                       boolean quotingEnforced) {
         if (content == null) {
             return "";
         }
-        if (quotingEnforced || isQuotingRequired(content, separator)) {
+        if (quotingEnforced || isQuotingRequired(content, valueSeparator)) {
             String result = content.replaceAll("\"", escapeCharacter.getCharacter() + "\"");
             return "\"" + result + "\"";
         }

diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvLexer.flex b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvLexer.flex
@@ -1,10 +1,9 @@
 package net.seesharpsoft.intellij.plugins.csv;
 
-import com.intellij.lexer.FlexLexer;
 import com.intellij.psi.tree.IElementType;
-import net.seesharpsoft.intellij.plugins.csv.editor.CsvEditorSettings;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvTypes;
 import com.intellij.psi.TokenType;
+import com.intellij.lexer.FlexLexer;
 
 import java.util.regex.Pattern;
 
@@ -16,17 +15,17 @@ import java.util.regex.Pattern;
 %function advance
 %type IElementType
 %{
-    private String currentSeparator;
-    private CsvEditorSettings.EscapeCharacter myEscapeCharacter;
+    private CsvValueSeparator myValueSeparator;
+    private CsvEscapeCharacter myEscapeCharacter;
 
     private static final Pattern ESCAPE_TEXT_PATTERN = Pattern.compile("[,;|\\t\\r\\n]");
 
     /**
      * Provide constructor that supports a Project as parameter.
      */
-    CsvLexer(java.io.Reader in, String separator, CsvEditorSettings.EscapeCharacter escapeCharacter) {
+    CsvLexer(java.io.Reader in, CsvValueSeparator valueSeparator, CsvEscapeCharacter escapeCharacter) {
       this(in);
-      this.currentSeparator = separator;
+      myValueSeparator = valueSeparator;
       myEscapeCharacter = escapeCharacter;
     }
 %}
@@ -82,7 +81,7 @@ WHITE_SPACE=[ \f]+
 
 <YYINITIAL, AFTER_TEXT, UNESCAPED_TEXT> {COMMA}
 {
-    if (currentSeparator.equals(yytext().toString())) {
+    if (myValueSeparator.isValueSeparator(yytext().toString())) {
         yybegin(YYINITIAL);
         return CsvTypes.COMMA;
     }

diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvLexerAdapter.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvLexerAdapter.java
@@ -1,10 +1,9 @@
 package net.seesharpsoft.intellij.plugins.csv;
 
 import com.intellij.lexer.FlexAdapter;
-import net.seesharpsoft.intellij.plugins.csv.editor.CsvEditorSettings;
 
 public class CsvLexerAdapter extends FlexAdapter {
-    public CsvLexerAdapter(String separator, CsvEditorSettings.EscapeCharacter escapeCharacter) {
+    public CsvLexerAdapter(CsvValueSeparator separator, CsvEscapeCharacter escapeCharacter) {
         super(new CsvLexer(null, separator, escapeCharacter));
     }
 }
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvParserDefinition.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvParserDefinition.java
@@ -11,12 +11,10 @@
 import com.intellij.psi.tree.IFileElementType;
 import com.intellij.psi.tree.TokenSet;
 import net.seesharpsoft.intellij.lang.FileParserDefinition;
-import net.seesharpsoft.intellij.plugins.csv.components.CsvFileAttributes;
 import net.seesharpsoft.intellij.plugins.csv.parser.CsvParser;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvFileElementType;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvTypes;
-import net.seesharpsoft.intellij.plugins.csv.settings.CsvCodeStyleSettings;
 import org.jetbrains.annotations.NotNull;
 
 public class CsvParserDefinition implements FileParserDefinition {
@@ -77,7 +75,7 @@ public PsiElement createElement(ASTNode node) {
 
     @Override
     public Lexer createLexer(@NotNull PsiFile file) {
-        return new CsvLexerAdapter(CsvCodeStyleSettings.getCurrentSeparator(file), CsvFileAttributes.getInstance(file.getProject()).getEscapeCharacter(file));
+        return new CsvLexerAdapter(CsvHelper.getValueSeparator(file), CsvHelper.getEscapeCharacter(file));
     }
 
     @Override

diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvParserUtil.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvParserUtil.java
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvSeparatorHolder.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvSeparatorHolder.java
@@ -1,5 +1,5 @@
 package net.seesharpsoft.intellij.plugins.csv;
 
 public interface CsvSeparatorHolder {
-    String getSeparator();
+    CsvValueSeparator getSeparator();
 }
diff --git a/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvValueSeparator.java b/src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvValueSeparator.java
@@ -0,0 +1,32 @@
+package net.seesharpsoft.intellij.plugins.csv;
+
+import java.util.regex.Pattern;
+
+public enum CsvValueSeparator {
+    COMMA(",", "Comma (,)"),
+    SEMICOLON(";", "Semicolon (;)"),
+    PIPE("|", "Pipe (|)"),
+    TAB("\t", "Tab (↹)");
+
+    private final String myCharacter;
+    private final String myDisplay;
+    private final Pattern myPattern;
+
+    CsvValueSeparator(String character, String display) {
+        myCharacter = character;
+        myDisplay = display;
+        myPattern = Pattern.compile(Pattern.quote(myCharacter));
+    }
+
+    public String getCharacter() {
+        return myCharacter;
+    }
+
+    public String getDisplay() {
+        return myDisplay;
+    }
+
+    public boolean isValueSeparator(String text) {
+        return myPattern.matcher(text).matches();
+    }
+}
diff --git a/...in/java/net/seesharpsoft/intellij/plugins/csv/actions/CsvChangeEscapeCharacterAction.java b/...in/java/net/seesharpsoft/intellij/plugins/csv/actions/CsvChangeEscapeCharacterAction.java
@@ -7,14 +7,15 @@
 import com.intellij.openapi.fileEditor.FileEditor;
 import com.intellij.psi.PsiFile;
 import com.intellij.util.FileContentUtilCore;
+import net.seesharpsoft.intellij.plugins.csv.CsvEscapeCharacter;
+import net.seesharpsoft.intellij.plugins.csv.CsvHelper;
 import net.seesharpsoft.intellij.plugins.csv.components.CsvFileAttributes;
-import net.seesharpsoft.intellij.plugins.csv.editor.CsvEditorSettings;
 import org.jetbrains.annotations.NotNull;
 
 public class CsvChangeEscapeCharacterAction extends ToggleAction {
-    private CsvEditorSettings.EscapeCharacter myEscapeCharacter;
+    private CsvEscapeCharacter myEscapeCharacter;
 
-    CsvChangeEscapeCharacterAction(CsvEditorSettings.EscapeCharacter escapeCharacter) {
+    CsvChangeEscapeCharacterAction(CsvEscapeCharacter escapeCharacter) {
         super(escapeCharacter.getDisplay());
         myEscapeCharacter = escapeCharacter;
     }
@@ -25,8 +26,7 @@ public boolean isSelected(@NotNull AnActionEvent anActionEvent) {
         if (psiFile == null) {
             return false;
         }
-        CsvFileAttributes csvFileAttributes = CsvFileAttributes.getInstance(psiFile.getProject());
-        return csvFileAttributes.hasEscapeCharacterAttribute(psiFile) && csvFileAttributes.getEscapeCharacter(psiFile).equals(myEscapeCharacter);
+        return CsvHelper.hasEscapeCharacterAttribute(psiFile) && CsvHelper.getEscapeCharacter(psiFile).equals(myEscapeCharacter);
     }
 
     @Override

diff --git a/...va/net/seesharpsoft/intellij/plugins/csv/actions/CsvChangeEscapeCharacterActionGroup.java b/...va/net/seesharpsoft/intellij/plugins/csv/actions/CsvChangeEscapeCharacterActionGroup.java
@@ -6,9 +6,9 @@
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.CommonDataKeys;
 import com.intellij.psi.PsiFile;
+import net.seesharpsoft.intellij.plugins.csv.CsvEscapeCharacter;
+import net.seesharpsoft.intellij.plugins.csv.CsvHelper;
 import net.seesharpsoft.intellij.plugins.csv.CsvLanguage;
-import net.seesharpsoft.intellij.plugins.csv.components.CsvFileAttributes;
-import net.seesharpsoft.intellij.plugins.csv.editor.CsvEditorSettings;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -17,9 +17,9 @@ public class CsvChangeEscapeCharacterActionGroup extends ActionGroup {
     private static final AnAction[] CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS;
 
     static {
-        CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS = new AnAction[CsvEditorSettings.EscapeCharacter.values().length + 1];
+        CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS = new AnAction[CsvEscapeCharacter.values().length + 1];
         for (int i = 0; i < CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS.length - 1; ++i) {
-            CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS[i] = new CsvChangeEscapeCharacterAction(CsvEditorSettings.EscapeCharacter.values()[i]);
+            CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS[i] = new CsvChangeEscapeCharacterAction(CsvEscapeCharacter.values()[i]);
         }
         CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS[CSV_ESCAPE_CHARACTER_CHANGE_ACTIONS.length - 1] = new CsvDefaultEscapeCharacterAction();
     }
@@ -31,7 +31,7 @@ public void update(AnActionEvent anActionEvent) {
         anActionEvent.getPresentation().setEnabledAndVisible(psiFile != null && language != null && language.isKindOf(CsvLanguage.INSTANCE));
 
         if (psiFile != null) {
-            CsvEditorSettings.EscapeCharacter escapeCharacter = CsvFileAttributes.getInstance(psiFile.getProject()).getEscapeCharacter(psiFile);
+            CsvEscapeCharacter escapeCharacter = CsvHelper.getEscapeCharacter(psiFile);
             anActionEvent.getPresentation().setText(String.format("CSV Escape Character: %s", escapeCharacter.getDisplay()));
         }
     }