Merge pull request #23 from rsmenon/feat_named_slots

Support for named slots

Author: Patrick Scheibe

src/de/halirutan/mathematica/codeinsight/highlighting/MathematicaHighlightingAnnotator.java

@@ -30,15 +30,18 @@
 import com.intellij.openapi.editor.markup.TextAttributes;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.ResolveState;
+import com.intellij.psi.tree.IElementType;
 import com.intellij.psi.util.PsiTreeUtil;
 import de.halirutan.mathematica.codeinsight.completion.SymbolInformationProvider;
+import de.halirutan.mathematica.parsing.MathematicaElementTypes;
 import de.halirutan.mathematica.parsing.psi.MathematicaRecursiveVisitor;
 import de.halirutan.mathematica.parsing.psi.MathematicaVisitor;
 import de.halirutan.mathematica.parsing.psi.api.MessageName;
-import de.halirutan.mathematica.parsing.psi.api.Slot;
+import de.halirutan.mathematica.parsing.psi.api.slots.Slot;
 import de.halirutan.mathematica.parsing.psi.api.StringifiedSymbol;
 import de.halirutan.mathematica.parsing.psi.api.Symbol;
 import de.halirutan.mathematica.parsing.psi.api.function.Function;
+import de.halirutan.mathematica.parsing.psi.api.slots.SlotExpression;
 import de.halirutan.mathematica.parsing.psi.util.LocalDefinitionResolveProcessor;
 import de.halirutan.mathematica.parsing.psi.util.LocalizationConstruct;
 import org.jetbrains.annotations.NotNull;
@@ -122,6 +125,16 @@ public void visitFunction(final Function function) {
       public void visitSlot(final Slot slot) {
         setHighlighting(slot, myHolder, MathematicaSyntaxHighlighterColors.PATTERN);
       }
+
+      @Override
+      public void visitSlotExpression(final SlotExpression slotExpr) {
+        IElementType head = slotExpr.getFirstChild().getNode().getElementType();
+        if (head.equals(MathematicaElementTypes.ASSOCIATION_SLOT)) {
+          setHighlighting(slotExpr, myHolder, MathematicaSyntaxHighlighterColors.PATTERN);
+        } else {
+          setHighlighting(slotExpr.getFirstChild(), myHolder, MathematicaSyntaxHighlighterColors.PATTERN);
+        }
+      }
     };
     function.accept(slotVisitor);
 

src/de/halirutan/mathematica/lexer/Mathematica.flex

@@ -52,7 +52,7 @@ ScientificNumber = {PrecisionNumber} "\*^"(-?){Digits}
 BaseScientificNumber = {BasePrecisionNumber} "\*^"(-?){Digits}
 
 Slot = "#" [0-9]*
-AssociationSlot = "#" [a-zA-Z\$][a-zA-Z0-9\$]*
+AssociationSlot = "#" {Identifier} | "#\"" {Identifier} "\"" | "#\\[" {Identifier} "\\]"
 SlotSequence = "##" [0-9]*
 
 Out = "%"+

src/de/halirutan/mathematica/lexer/_MathematicaLexer.java

@@ -50,6 +50,8 @@
 import de.halirutan.mathematica.parsing.psi.impl.rules.ReplaceRepeatedImpl;
 import de.halirutan.mathematica.parsing.psi.impl.rules.RuleDelayedImpl;
 import de.halirutan.mathematica.parsing.psi.impl.rules.RuleImpl;
+import de.halirutan.mathematica.parsing.psi.impl.slots.SlotExpressionImpl;
+import de.halirutan.mathematica.parsing.psi.impl.slots.SlotImpl;
 import de.halirutan.mathematica.parsing.psi.impl.string.StringExpressionImpl;
 import de.halirutan.mathematica.parsing.psi.impl.string.StringImpl;
 import de.halirutan.mathematica.parsing.psi.impl.string.StringJoinImpl;
@@ -97,7 +99,6 @@ public interface MathematicaElementTypes {
       STRING_LITERAL, STRING_LITERAL_END, STRING_LITERAL_BEGIN, STRING_NAMED_CHARACTER
   );
   IElementType IDENTIFIER = new MathematicaElementType("IDENTIFIER");
-  IElementType ASSOCIATION_SLOT = new MathematicaElementType("ASSOCIATION_SLOT");
   IElementType STRINGIFIED_IDENTIFIER = new MathematicaElementType("STRINGIFIED_IDENTIFIER");
   IElementType NUMBER = new MathematicaElementType("NUMBER");
   TokenSet LITERALS = TokenSet.create(
@@ -183,9 +184,8 @@ public interface MathematicaElementTypes {
   IElementType QUESTION_MARK = new MathematicaElementType("QUESTION_MARK");
   IElementType SLOT = new MathematicaElementType("SLOT");
   IElementType SLOT_SEQUENCE = new MathematicaElementType("SLOT_SEQUENCE");
-  TokenSet SLOTS = TokenSet.create(
-      SLOT, SLOT_SEQUENCE, ASSOCIATION_SLOT
-  );
+  IElementType ASSOCIATION_SLOT = new MathematicaElementType("ASSOCIATION_SLOT");
+  TokenSet SLOTS = TokenSet.create(SLOT, SLOT_SEQUENCE);
   IElementType FUNCTION = new MathematicaElementType("FUNCTION");
   IElementType BACK_TICK = new MathematicaElementType("BACK_TICK");
   IElementType INFIX_CALL = new MathematicaElementType("INFIX_CALL");
@@ -239,6 +239,7 @@ public interface MathematicaElementTypes {
   // THIS SECTION IS AUTOMATICALLY CREATED WITH MATHEMATICA
   IElementType LIST_EXPRESSION = new MathematicaElementType("LIST_EXPRESSION");
   IElementType ASSOCIATION_EXPRESSION = new MathematicaElementType("ASSOCIATION_EXPRESSION");
+  IElementType SLOT_EXPRESSION = new MathematicaElementType("SLOT_EXPRESSION");
   IElementType NUMBER_EXPRESSION = new MathematicaElementType("NUMBER_EXPRESSION");
   IElementType SYMBOL_EXPRESSION = new MathematicaElementType("SYMBOL_EXPRESSION");
   IElementType STRINGIFIED_SYMBOL_EXPRESSION = new MathematicaElementType("STRINGIFIED_SYMBOL_EXPRESSION");
@@ -331,6 +332,7 @@ public static PsiElement create(ASTNode node) {
       if (type.equals(SYMBOL_EXPRESSION)) return new SymbolImpl(node);
       if (type.equals(STRINGIFIED_SYMBOL_EXPRESSION)) return new StringifiedSymbolImpl(node);
       if (SLOTS.contains(type)) return new SlotImpl(node);
+      if (type.equals(SLOT_EXPRESSION) || type.equals(ASSOCIATION_SLOT)) return new SlotExpressionImpl(node);
       if (type.equals(NUMBER_EXPRESSION)) return new NumberImpl(node);
       if (type.equals(STRING_LITERAL_EXPRESSION)) return new StringImpl(node);
 

src/de/halirutan/mathematica/parsing/MathematicaElementTypes.java

@@ -59,7 +59,7 @@ public class ParseletProvider {
 
     register(MathematicaElementTypes.SLOT_SEQUENCE, MathematicaElementTypes.SLOT_SEQUENCE, new SlotParselet(77)); // ##n expressions
     register(MathematicaElementTypes.SLOT, MathematicaElementTypes.SLOT, new SlotParselet(77)); // ##n expressions
-    register(MathematicaElementTypes.ASSOCIATION_SLOT, MathematicaElementTypes.ASSOCIATION_SLOT, new SlotParselet(77)); // #foo123 expressions
+    register(MathematicaElementTypes.ASSOCIATION_SLOT, MathematicaElementTypes.ASSOCIATION_SLOT, new SlotExpressionParselet(77)); // #foo123 expressions
 
     register(MathematicaElementTypes.BLANK, MathematicaElementTypes.BLANK_EXPRESSION, new BlankParselet(76)); // Blank(_)
     register(MathematicaElementTypes.BLANK, MathematicaElementTypes.BLANK_EXPRESSION, new PrefixBlankParselet(76)); // Blank(_)

src/de/halirutan/mathematica/parsing/prattparser/ParseletProvider.java

@@ -29,7 +29,8 @@
 import de.halirutan.mathematica.parsing.prattparser.MathematicaParser;
 
 /**
- * Parses functions calls like f[x] and array element access like l[[i]] since both start with an opening bracket.
+ * Parses functions calls like f[x] or slot expressions like #["name"] or #[name] (used often with Associations)
+ * and array element access like l[[i]] since they all start with an opening bracket.
  *
  * @author patrick (3/27/13)
  */
@@ -50,12 +51,19 @@ public MathematicaParser.Result parse(MathematicaParser parser, MathematicaParse
 
     PsiBuilder.Marker mainMark = left.getMark().precede();
 
-    // parse the start. Either a Part expression like list[[ or a function call f[
+    // parse the start. Could be one of the following:
+    //   1. a Part expression like list[[
+    //   2. a function call f[
+    //   3. a slot expression like #[ which could be a function call or an Association lookup
     boolean isPartExpr = false;
+    boolean isAssociationSlot = false;
     if (parser.matchesToken(MathematicaElementTypes.LEFT_BRACKET, MathematicaElementTypes.LEFT_BRACKET)) {
       isPartExpr = true;
       parser.advanceLexer();
       parser.advanceLexer();
+    } else if (left.getToken().equals(MathematicaElementTypes.SLOT)) {
+      isAssociationSlot = true;
+      parser.advanceLexer();
     } else {
       parser.advanceLexer();
     }
@@ -81,6 +89,10 @@ public MathematicaParser.Result parse(MathematicaParser parser, MathematicaParse
         parser.error(ParserBundle.message("General.closing", "']]'"));
         mainMark.done(MathematicaElementTypes.PART_EXPRESSION);
         return MathematicaParser.result(mainMark, MathematicaElementTypes.PART_EXPRESSION, false);
+      } else if (isAssociationSlot) {
+        parser.advanceLexer();
+        mainMark.done(MathematicaElementTypes.SLOT_EXPRESSION);
+        return MathematicaParser.result(mainMark, MathematicaElementTypes.SLOT_EXPRESSION, true);
       } else {
         parser.advanceLexer();
         mainMark.done(MathematicaElementTypes.FUNCTION_CALL_EXPRESSION);

src/de/halirutan/mathematica/parsing/prattparser/parselets/FunctionCallParselet.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2015 Patrick Scheibe
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package de.halirutan.mathematica.parsing.prattparser.parselets;
+
+import com.intellij.lang.PsiBuilder;
+import com.intellij.psi.tree.IElementType;
+import de.halirutan.mathematica.parsing.MathematicaElementTypes;
+import de.halirutan.mathematica.parsing.prattparser.CriticalParserError;
+import de.halirutan.mathematica.parsing.prattparser.MathematicaParser;
+
+/**
+ * Parselet for Association style slots
+ * Created by rsmenon on 11/8/15.
+ */
+public class SlotExpressionParselet implements PrefixParselet {
+
+    private final int myPrecedence;
+
+    public SlotExpressionParselet(int precedence) {
+        this.myPrecedence = precedence;
+    }
+
+    @Override
+    public MathematicaParser.Result parse(MathematicaParser parser) throws CriticalParserError {
+        PsiBuilder.Marker symbolMark = parser.mark();
+        final IElementType tokenType = parser.getTokenType();
+        if (tokenType.equals(MathematicaElementTypes.ASSOCIATION_SLOT)) {
+            parser.advanceLexer();
+            symbolMark.done(tokenType);
+            return MathematicaParser.result(symbolMark, tokenType, true);
+        } else {
+            return MathematicaParser.notParsed();
+        }
+
+    }
+
+    public int getPrecedence() {
+        return myPrecedence;
+    }
+}

src/de/halirutan/mathematica/parsing/prattparser/parselets/SlotExpressionParselet.java

@@ -34,6 +34,8 @@
 import de.halirutan.mathematica.parsing.psi.api.rules.ReplaceRepeated;
 import de.halirutan.mathematica.parsing.psi.api.rules.Rule;
 import de.halirutan.mathematica.parsing.psi.api.rules.RuleDelayed;
+import de.halirutan.mathematica.parsing.psi.api.slots.Slot;
+import de.halirutan.mathematica.parsing.psi.api.slots.SlotExpression;
 
 
 /**
@@ -169,6 +171,10 @@ public void visitSlot(Slot slot) {
     visitElement(slot);
   }
 
+  public void visitSlotExpression(SlotExpression slotExpr) {
+    visitElement(slotExpr);
+  }
+
   public void visitUndirectedEdge(final UndirectedEdge undirectedEdge) {
     visitElement(undirectedEdge);
   }

src/de/halirutan/mathematica/parsing/psi/MathematicaVisitor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014 Patrick Scheibe
+ * Copyright (c) 2015 Patrick Scheibe
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -19,7 +19,9 @@
  * THE SOFTWARE.
  */
 
-package de.halirutan.mathematica.parsing.psi.api;
+package de.halirutan.mathematica.parsing.psi.api.slots;
+
+import de.halirutan.mathematica.parsing.psi.api.Expression;
 
 /**
  * Created with IntelliJ IDEA. User: patrick Date: 3/28/13 Time: 12:33 AM Purpose:

…an/mathematica/parsing/psi/api/Slot.java …hematica/parsing/psi/api/slots/Slot.javasrc/de/halirutan/mathematica/parsing/psi/api/Slot.java renamed to src/de/halirutan/mathematica/parsing/psi/api/slots/Slot.java src/de/halirutan/mathematica/parsing/psi/api/Slot.java renamed to src/de/halirutan/mathematica/parsing/psi/api/slots/Slot.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2015 Patrick Scheibe
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package de.halirutan.mathematica.parsing.psi.api.slots;
+
+import de.halirutan.mathematica.parsing.psi.api.Expression;
+
+/**
+ * Created by rsmenon on 11/8/15.
+ */
+public interface SlotExpression extends Expression {
+
+}