Intelligent commands can now suppress normal tab completable targets, so /ctcp foo <tab> will only complete valid CTCP types, rather than completing valid CTCP types, nicknames, channel names and command names.

git-svn-id: http://svn.dmdirc.com/trunk@1585 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/addons/nowplaying/plugin/NowPlayingCommand.java

@@ -28,8 +28,8 @@ import com.dmdirc.addons.nowplaying.MediaSource;
 import com.dmdirc.commandparser.ChannelCommand;
 import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.IntelligentCommand;
+import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.interfaces.InputWindow;
-import java.util.ArrayList;
 
 import java.util.List;
 
@@ -142,8 +142,10 @@ public final class NowPlayingCommand extends ChannelCommand implements Intellige
     }
     
     /** {@inheritDoc} */
-    public List<String> getSuggestions(int arg, List<String> previousArgs) {
-        final List<String> res = new ArrayList<String>();
+    public AdditionalTabTargets getSuggestions(int arg, List<String> previousArgs) {
+        final AdditionalTabTargets res = new AdditionalTabTargets();
+        
+        res.setIncludeNormal(false);
         
         if (arg == 0) {
             res.add("--sources");

src/com/dmdirc/commandparser/IntelligentCommand.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.commandparser;
 
+import com.dmdirc.ui.input.AdditionalTabTargets;
 import java.util.List;
 
 /**
@@ -38,6 +39,6 @@ public interface IntelligentCommand {
      * @param previousArgs The contents of the previous arguments, if any
      * @return A list of suggestions for the argument
      */
-    List<String> getSuggestions(int arg, List<String> previousArgs);
+    AdditionalTabTargets getSuggestions(int arg, List<String> previousArgs);
     
 }

src/com/dmdirc/commandparser/commands/global/LoadPlugin.java

@@ -26,9 +26,9 @@ import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.GlobalCommand;
 import com.dmdirc.commandparser.IntelligentCommand;
 import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.interfaces.InputWindow;
 
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
@@ -85,10 +85,11 @@ public final class LoadPlugin extends GlobalCommand implements IntelligentComman
     }
 
     /** {@inheritDoc} */
-    public List<String> getSuggestions(int arg, List<String> previousArgs) {
-        final List<String> res = new ArrayList<String>();
+    public AdditionalTabTargets getSuggestions(int arg, List<String> previousArgs) {
+        final AdditionalTabTargets res = new AdditionalTabTargets();
         
         if (arg == 0) {
+            res.setIncludeNormal(false);
             res.addAll(Arrays.asList(PluginManager.getPluginManager().getNames()));
         }
         

src/com/dmdirc/commandparser/commands/global/Set.java

@@ -26,9 +26,9 @@ import com.dmdirc.Config;
 import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.GlobalCommand;
 import com.dmdirc.commandparser.IntelligentCommand;
+import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.interfaces.InputWindow;
 
-import java.util.ArrayList;
 import java.util.List;
 
 /**
@@ -172,13 +172,15 @@ public final class Set extends GlobalCommand implements IntelligentCommand {
     }
     
     /** {@inheritDoc} */
-    public List<String> getSuggestions(int arg, List<String> previousArgs) {
-        final List<String> res = new ArrayList<String>();
+    public AdditionalTabTargets getSuggestions(int arg, List<String> previousArgs) {
+        final AdditionalTabTargets res = new AdditionalTabTargets();
         
         if (arg == 0) {
             res.addAll(Config.getDomains());
+            res.setIncludeNormal(false);
         } else if (arg == 1 && previousArgs.size() >= 1) {
             res.addAll(Config.getOptions(previousArgs.get(0)));
+            res.setIncludeNormal(false);
         }
         
         return res;

src/com/dmdirc/commandparser/commands/server/Ctcp.java

@@ -27,8 +27,9 @@ import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.IntelligentCommand;
 import com.dmdirc.commandparser.ServerCommand;
+import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.interfaces.InputWindow;
-import java.util.ArrayList;
+
 import java.util.List;
 
 /**
@@ -92,8 +93,8 @@ public final class Ctcp extends ServerCommand implements IntelligentCommand {
     }
     
     /** {@inheritDoc} */
-    public List<String> getSuggestions(int arg, List<String> previousArgs) {
-        final List<String> res = new ArrayList<String>();
+    public AdditionalTabTargets getSuggestions(int arg, List<String> previousArgs) {
+        final AdditionalTabTargets res = new AdditionalTabTargets();
         
         if (arg == 1) {
             res.add("VERSION");
@@ -104,6 +105,7 @@ public final class Ctcp extends ServerCommand implements IntelligentCommand {
             res.add("FINGER");
             res.add("SOURCE");
             res.add("TIME");
+            res.setIncludeNormal(false);
         }
         
         return res;

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

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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 com.dmdirc.ui.input;
+
+import java.util.ArrayList;
+
+/**
+ * The AdditionalTabTargets class is a basic wrapper around an arraylist that
+ * adds an additional property to determine whether or not to include normal
+ * tab-completable targets (such as nicknames and channels).
+ * 
+ * @author chris
+ */
+public class AdditionalTabTargets extends ArrayList<String> {
+    
+    /** Whether to include normal targets. */
+    private boolean includeNormal = true;
+
+    /**
+     * Determines if this set of tab targets precludes the inclusion of
+     * standard targets.
+     * 
+     * @return True if normal targets are included, false otherwise
+     */
+    public boolean shouldIncludeNormal() {
+        return includeNormal;
+    }
+
+    /**
+     * Sets whether or not these results preclude the inclusion of the standard
+     * tab-completable targets.
+     * 
+     * @param includeNormal Whether normal targets should be included or not
+     */
+    public void setIncludeNormal(final boolean includeNormal) {
+        this.includeNormal = includeNormal;
+    }    
+
+}

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

@@ -321,7 +321,7 @@ public final class InputHandler implements KeyListener, ActionListener {
                 }
             }
             
-            final List<String> results = ((IntelligentCommand) command).getSuggestions(args, previousArgs);
+            final AdditionalTabTargets results = ((IntelligentCommand) command).getSuggestions(args, previousArgs);
             
             doNormalTabCompletion(text, start, end, results);
         } else {
@@ -338,7 +338,7 @@ public final class InputHandler implements KeyListener, ActionListener {
      * @param additional A list of additional strings to use
      */
     private void doNormalTabCompletion(final String text, final int start,
-            final int end, final List<String> additional) {
+            final int end, final AdditionalTabTargets additional) {
         final String word = text.substring(start, end);
         
         if (start == lastPosition && word.equals(lastWord)) {

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

@@ -46,7 +46,7 @@ public final class TabCompleter {
     
     /** Creates a new instance of TabCompleter. */
     public TabCompleter() {
-	//Do nothing.
+        //Do nothing.
     }
     
     /**
@@ -55,45 +55,47 @@ public final class TabCompleter {
      * local ones fail
      */
     public TabCompleter(final TabCompleter newParent) {
-	this.parent = newParent;
+        this.parent = newParent;
     }
     
     /**
      * Attempts to complete the partial string.
-     * 
+     *
      * @param partial The string to tab complete
      * @param additionals A list of additional strings to use
      * @return A TabCompleterResult containing any matches found
      */
     public TabCompleterResult complete(final String partial,
-            final List<String> additionals) {
-	final TabCompleterResult result = new TabCompleterResult();
+            final AdditionalTabTargets additionals) {
+        final TabCompleterResult result = new TabCompleterResult();
         
         final List<String> targets = new ArrayList<String>();
-        
-        if (additionals != null) { 
+                
+        if (additionals != null) {
             targets.addAll(additionals);
         }
         
-        targets.addAll(entries);
-	
-	for (String entry : targets) {
-	    if (Config.getOptionBool("tabcompletion", "casesensitive")) {
-		if (entry.startsWith(partial)) {
-		    result.addResult(entry);
-		}
-	    } else {
-		if (entry.toLowerCase(Locale.getDefault())
-		.startsWith(partial.toLowerCase(Locale.getDefault()))) {
-		    result.addResult(entry);
-		}
-	    }
-	}
-	
-	if (parent != null) {
-	    result.merge(parent.complete(partial, null));
-	}
-	return result;
+        if (additionals == null || additionals.shouldIncludeNormal()) {
+            targets.addAll(entries);
+        }
+        
+        for (String entry : targets) {
+            if (Config.getOptionBool("tabcompletion", "casesensitive")) {
+                if (entry.startsWith(partial)) {
+                    result.addResult(entry);
+                }
+            } else {
+                if (entry.toLowerCase(Locale.getDefault())
+                        .startsWith(partial.toLowerCase(Locale.getDefault()))) {
+                    result.addResult(entry);
+                }
+            }
+        }
+        
+        if (parent != null && (additionals == null || additionals.shouldIncludeNormal())) {
+            result.merge(parent.complete(partial, null));
+        }
+        return result;
     }
     
     /**
@@ -101,7 +103,7 @@ public final class TabCompleter {
      * @param entry The new entry to be added
      */
     public void addEntry(final String entry) {
-	entries.add(entry);
+        entries.add(entry);
     }
     
     /**
@@ -109,13 +111,13 @@ public final class TabCompleter {
      * @param newEntries Entries to be added
      */
     public void addEntries(final List<String> newEntries) {
-	if (newEntries == null) {
-	    return;
-	}
-	
-	for (String entry : newEntries) {
-	    addEntry(entry);
-	}
+        if (newEntries == null) {
+            return;
+        }
+        
+        for (String entry : newEntries) {
+            addEntry(entry);
+        }
     }
     
     /**
@@ -123,7 +125,7 @@ public final class TabCompleter {
      * @param entry The entry to be removed
      */
     public void removeEntry(final String entry) {
-	entries.remove(entry);
+        entries.remove(entry);
     }
     
     /**
@@ -131,7 +133,7 @@ public final class TabCompleter {
      * @param newEntries the new entries to use
      */
     public void replaceEntries(final List<String> newEntries) {
-	entries = newEntries;
+        entries = newEntries;
     }
     
 }