Move tab completion styles to addons

Fixes issue 2171, fixes issue 2310 (dev error), fixes issue 2311 (dev error)

src/com/dmdirc/ui/input/tabstyles/BashStyle.java → src/com/dmdirc/addons/tabcompletion_bash/BashStyle.java

@@ -20,17 +20,19 @@
  * SOFTWARE.
  */
 
-package com.dmdirc.ui.input.tabstyles;
+package com.dmdirc.addons.tabcompletion_bash;
 
+import com.dmdirc.plugins.Plugin;
 import com.dmdirc.ui.input.AdditionalTabTargets;
+import com.dmdirc.ui.input.TabCompleter;
 import com.dmdirc.ui.input.TabCompleterResult;
+import com.dmdirc.ui.input.tabstyles.TabCompletionResult;
+import com.dmdirc.ui.input.tabstyles.TabCompletionStyle;
+import com.dmdirc.ui.interfaces.InputWindow;
 
 import java.awt.Toolkit;
 
-public class BashStyle extends TabCompletionStyle {
-    
-    /** The name of this style. */
-    private static final String NAME = "bash";
+public class BashStyle extends Plugin implements TabCompletionStyle {
     
     /** The last position the user tab-completed at. */
     private int lastPosition = -1;
@@ -40,13 +42,22 @@ public class BashStyle extends TabCompletionStyle {
     
     /** The last word that was tab completed. */
     private String lastWord = "";
-    
+
+    /** The tab completer that we use. */
+    protected TabCompleter tabCompleter;
+
+    /** The input window that we use. */
+    protected InputWindow window;
+
     /** {@inheritDoc} */
-    public String getName() {
-        return NAME;
+    @Override
+    public void setContext(final TabCompleter completer, final InputWindow window) {
+        this.tabCompleter = completer;
+        this.window = window;
     }
     
     /** {@inheritDoc} */
+    @Override
     public TabCompletionResult getResult(final String original, final int start,
             final int end, final AdditionalTabTargets additional) {
         final String word = original.substring(start, end);
@@ -87,5 +98,17 @@ public class BashStyle extends TabCompletionStyle {
             }
         }
     }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        // Do nothing
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        // Do nothing
+    }
     
 }

src/com/dmdirc/addons/tabcompletion_bash/plugin.config

@@ -0,0 +1,25 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  updates
+#  version
+
+metadata:
+  author=Chris <chris@dmdirc.com>
+  mainclass=com.dmdirc.addons.tabcompletion_bash.BashStyle
+  description=Tab completion that lists all possible matches
+  name=tabcompletion_bash
+  nicename=Bash-style completion
+
+updates:
+  id=43
+
+#version:
+#  friendly=0
+
+provides:
+  bash tabcompletion

src/com/dmdirc/ui/input/tabstyles/MircStyle.java → src/com/dmdirc/addons/tabcompletion_mirc/MircStyle.java

@@ -20,19 +20,21 @@
  * SOFTWARE.
  */
 
-package com.dmdirc.ui.input.tabstyles;
+package com.dmdirc.addons.tabcompletion_mirc;
 
 import com.dmdirc.Channel;
+import com.dmdirc.plugins.Plugin;
 import com.dmdirc.ui.input.AdditionalTabTargets;
+import com.dmdirc.ui.input.TabCompleter;
 import com.dmdirc.ui.input.TabCompleterResult;
+import com.dmdirc.ui.input.tabstyles.TabCompletionResult;
+import com.dmdirc.ui.input.tabstyles.TabCompletionStyle;
+import com.dmdirc.ui.interfaces.InputWindow;
 
 import java.awt.Toolkit;
 import java.util.List;
 
-public class MircStyle extends TabCompletionStyle {
-    
-    /** The name of this style. */
-    private static final String NAME = "mirc";
+public class MircStyle extends Plugin implements TabCompletionStyle {
     
     /** The last set of results we retrieved. */
     private List<String> lastResult;
@@ -40,12 +42,21 @@ public class MircStyle extends TabCompletionStyle {
     /** The last word that was tab completed. */
     private String lastWord;
     
+    /** The tab completer that we use. */
+    protected TabCompleter tabCompleter;
+
+    /** The input window that we use. */
+    protected InputWindow window;
+
     /** {@inheritDoc} */
-    public String getName() {
-        return NAME;
+    @Override
+    public void setContext(final TabCompleter completer, final InputWindow window) {
+        this.tabCompleter = completer;
+        this.window = window;
     }
     
     /** {@inheritDoc} */
+    @Override
     public TabCompletionResult getResult(final String original, final int start,
             final int end, final AdditionalTabTargets additional) {
         
@@ -64,7 +75,8 @@ public class MircStyle extends TabCompletionStyle {
                 return null;
             } else {
                 if (word.length() > 0 && window.getContainer() instanceof Channel
-                        && ((Channel) window.getContainer()).getChannelInfo().getName().startsWith(word)) {
+                        && ((Channel) window.getContainer())
+                        .getChannelInfo().getName().startsWith(word)) {
                     target = ((Channel) window.getContainer()).getChannelInfo().getName();
                 } else {
                     target = res.getResults().get(0);
@@ -75,9 +87,20 @@ public class MircStyle extends TabCompletionStyle {
         
         lastWord = target;
         
-        return new TabCompletionResult(
-                original.substring(0, start) + target + original.substring(end),
-                start + target.length());
+        return new TabCompletionResult(original.substring(0, start) + target
+                + original.substring(end), start + target.length());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        // Do nothing
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        // Do nothing
     }
     
 }

src/com/dmdirc/addons/tabcompletion_mirc/plugin.config

@@ -0,0 +1,25 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  updates
+#  version
+
+metadata:
+  author=Chris <chris@dmdirc.com>
+  mainclass=com.dmdirc.addons.tabcompletion_mirc.MircStyle
+  description=Tab completion that cycles through matches
+  name=tabcompletion_mirc
+  nicename=mIRC-style completion
+
+updates:
+  id=44
+
+#version:
+#  friendly=0
+
+provides:
+  mirc tabcompletion

src/com/dmdirc/config/prefs/PreferencesManager.java

@@ -25,6 +25,8 @@ import com.dmdirc.Main;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.config.prefs.validator.NumericalValidator;
+import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.plugins.Service;
 import com.dmdirc.util.ListenerList;
 
 import java.util.ArrayList;
@@ -171,8 +173,9 @@ public class PreferencesManager {
                 "contains more than this many lines."));
         
         final Map<String, String> taboptions = new HashMap<String, String>();
-        taboptions.put("bash", "Bash style");
-        taboptions.put("mirc", "mIRC style (cyclic)");
+        for (Service service : PluginManager.getPluginManager().getServicesByType("tabcompletion")) {
+            taboptions.put(service.getName(), service.getName());
+        }
         
         category.addSetting(new PreferencesSetting("tabcompletion", "style",
                 "Tab completion style", "Determines the behaviour of " +

src/com/dmdirc/ui/input/InputHandler.java

@@ -33,8 +33,8 @@ import com.dmdirc.commandparser.commands.WrappableCommand;
 import com.dmdirc.commandparser.parsers.CommandParser;
 import com.dmdirc.config.prefs.validator.ValidationResponse;
 import com.dmdirc.interfaces.ConfigChangeListener;
-import com.dmdirc.ui.input.tabstyles.BashStyle;
-import com.dmdirc.ui.input.tabstyles.MircStyle;
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.plugins.PluginManager;
 import com.dmdirc.ui.input.tabstyles.TabCompletionResult;
 import com.dmdirc.ui.input.tabstyles.TabCompletionStyle;
 import com.dmdirc.ui.interfaces.InputField;
@@ -173,12 +173,9 @@ public abstract class InputHandler implements ConfigChangeListener {
      * Sets this inputhandler's tab completion style.
      */
     private void setStyle() {
-        if ("bash".equals(parentWindow.getConfigManager().getOption("tabcompletion",
-                "style"))) {
-            style = new BashStyle();
-        } else {
-            style = new MircStyle();
-        }
+        style = (TabCompletionStyle) ((PluginInfo) PluginManager.getPluginManager()
+                .getServiceProvider("tabcompletion", parentWindow.getConfigManager()
+                .getOption("tabcompletion", "style"))).getPlugin();
         
         style.setContext(tabCompleter, parentWindow);
     }

src/com/dmdirc/ui/input/tabstyles/TabCompletionStyle.java

@@ -32,13 +32,7 @@ import com.dmdirc.ui.interfaces.InputWindow;
  * 
  * @author Chris
  */
-public abstract class TabCompletionStyle {
-        
-    /** The tab completer that we use. */
-    protected TabCompleter tabCompleter;
-    
-    /** The input window that we use. */
-    protected InputWindow window;
+public interface TabCompletionStyle {
     
     /**
      * Sets this style's tab completer and window to the ones specified.
@@ -46,17 +40,7 @@ public abstract class TabCompletionStyle {
      * @param completer The new tab completer to use
      * @param window The window in which the tab completer is used
      */
-    public void setContext(final TabCompleter completer, final InputWindow window) {
-        this.tabCompleter = completer;
-        this.window = window;
-    }
-    
-    /**
-     * Retrieves a name for this completion style.
-     * 
-     * @return The name for this completion style
-     */
-    public abstract String getName();
+    void setContext(final TabCompleter completer, final InputWindow window);
     
     /**
      * Retrieves this style's result for the specified parameters.
@@ -67,7 +51,7 @@ public abstract class TabCompletionStyle {
      * @param additional A list of additional targets which may match
      * @return This style's proposed result
      */
-    public abstract TabCompletionResult getResult(final String original,
-            final int start, final int end, final AdditionalTabTargets additional);
+    TabCompletionResult getResult(final String original, final int start,
+            final int end, final AdditionalTabTargets additional);
     
 }