Made the sorting of built-in function completion selectable.

Author: halirutan

src/de/halirutan/mathematica/codeinsight/completion/BuiltinFunctionCompletionProvider.java

@@ -21,16 +21,14 @@
 
 package de.halirutan.mathematica.codeinsight.completion;
 
-import com.intellij.codeInsight.completion.CompletionContributor;
-import com.intellij.codeInsight.completion.CompletionParameters;
-import com.intellij.codeInsight.completion.CompletionResultSet;
-import com.intellij.codeInsight.completion.CompletionType;
+import com.intellij.codeInsight.completion.*;
 import com.intellij.codeInsight.completion.impl.CamelHumpMatcher;
 import com.intellij.patterns.PsiElementPattern.Capture;
 import com.intellij.psi.PsiElement;
 import com.intellij.util.ProcessingContext;
 import de.halirutan.mathematica.codeinsight.completion.SymbolInformationProvider.SymbolInformation;
 import de.halirutan.mathematica.parsing.MathematicaElementTypes;
+import de.halirutan.mathematica.settings.MathematicaSettings;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.HashMap;
@@ -59,13 +57,18 @@ protected void addCompletions(@NotNull CompletionParameters parameters, Processi
     }
 
     String prefix = findCurrentText(parameters, parameters.getPosition());
-//    BetterPrefixMatcher matcher = new BetterPrefixMatcher(new CamelHumpMatcher(prefix, true), -1);
-    CamelHumpMatcher matcher = new CamelHumpMatcher(prefix, true);
+    final CamelHumpMatcher matcher = new CamelHumpMatcher(prefix, true);
     CompletionResultSet result2 = result.withPrefixMatcher(matcher);
 
+    final boolean sortByImportance = !MathematicaSettings.getInstance().isSortCompletionEntriesLexicographically();
+
     for (SymbolInformation info : symbols.values()) {
       BuiltinSymbolLookupElement lookup = new BuiltinSymbolLookupElement(info);
-      result2.addElement(lookup);
+      if (sortByImportance) {
+        result2.addElement(PrioritizedLookupElement.withPriority(lookup, info.importance));
+      } else {
+        result2.addElement(lookup);
+      }
     }
   }
 }

src/de/halirutan/mathematica/settings/MathematicaSettings.java

@@ -61,6 +61,7 @@ public enum SmartEnterResult {
   }
 
   public SmartEnterResult smartEnterResult = SmartEnterResult.INSERT_BRACES;
+  public boolean sortCompletionEntriesLexicographically = false;
 
   public static MathematicaSettings getInstance() {
     return ServiceManager.getService(MathematicaSettings.class);
@@ -87,12 +88,15 @@ public boolean equals(Object obj) {
     }
 
     final MathematicaSettings settings = (MathematicaSettings) obj;
-    return smartEnterResult == settings.smartEnterResult;
+    if (smartEnterResult != settings.smartEnterResult) return false;
+    return sortCompletionEntriesLexicographically == settings.sortCompletionEntriesLexicographically;
   }
 
   @Override
   public int hashCode() {
-    return (smartEnterResult.ordinal());
+    int result = (smartEnterResult.ordinal());
+    result = 29 * result + (sortCompletionEntriesLexicographically ? 1 : 0);
+    return result;
   }
 
   public SmartEnterResult getSmartEnterResult() {
@@ -103,4 +107,11 @@ public void setSmartEnterResult(SmartEnterResult result) {
     this.smartEnterResult = result;
   }
 
+  public boolean isSortCompletionEntriesLexicographically() {
+    return sortCompletionEntriesLexicographically;
+  }
+
+  public void setSortCompletionEntriesLexicographically(boolean shouldSort) {
+    this.sortCompletionEntriesLexicographically = shouldSort;
+  }
 }

src/de/halirutan/mathematica/settings/SettingsUI.java

@@ -36,6 +36,8 @@ public class SettingsUI extends JPanel {
   private JCheckBox insertTemplate;
   private JCheckBox insertAsCode;
   private JCheckBox insertBraces;
+  private JCheckBox sortByImportance;
+  private JCheckBox sortByName;
 
   SettingsUI() {
     init();
@@ -78,6 +80,23 @@ private void init() {
     insertPanel.add(insertAsCode, BorderLayout.NORTH);
     insertPanel.add(insertPanel = new JPanel(new BorderLayout()), BorderLayout.SOUTH);
     insertPanel.add(insertBraces);
+
+    sortByImportance = new JCheckBox("Sort by importance");
+    sortByImportance.setMnemonic('I');
+    sortByName = new JCheckBox("Sort by name");
+    sortByName.setMnemonic('N');
+
+    ButtonGroup g2 = new ButtonGroup();
+    g2.add(sortByImportance);
+    g2.add(sortByName);
+
+    JPanel sortPanel = new JPanel(new BorderLayout());
+    sortPanel.setBorder(IdeBorderFactory.createTitledBorder("Sorting of completion entries"));
+    panel.add(panel = new JPanel(new BorderLayout()), BorderLayout.SOUTH);
+    panel.add(sortPanel, BorderLayout.SOUTH);
+
+    sortPanel.add(sortByImportance, BorderLayout.NORTH);
+    sortPanel.add(sortByName, BorderLayout.SOUTH);
   }
 
   public MathematicaSettings getSettings() {
@@ -89,6 +108,7 @@ public MathematicaSettings getSettings() {
     } else if (insertTemplate.isSelected()) {
       settings.setSmartEnterResult(SmartEnterResult.INSERT_TEMPLATE);
     }
+    settings.setSortCompletionEntriesLexicographically(sortByName.isSelected());
     return settings;
   }
 
@@ -101,5 +121,11 @@ public void setSettings(MathematicaSettings settings) {
     insertTemplate.setSelected(
         settings.getSmartEnterResult().equals(SmartEnterResult.INSERT_TEMPLATE)
     );
+    sortByName.setSelected(
+        settings.isSortCompletionEntriesLexicographically()
+    );
+    sortByImportance.setSelected(
+        !settings.isSortCompletionEntriesLexicographically()
+    );
   }
 }