massive command parser butchering

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

src/com/dmdirc/Channel.java

@@ -25,6 +25,7 @@ package com.dmdirc;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.config.ConfigManager;
 import com.dmdirc.parser.ChannelClientInfo;
@@ -123,8 +124,8 @@ public final class Channel extends MessageTarget
         icon = IconManager.getIconManager().getIcon("channel");
         
         tabCompleter = new TabCompleter(server.getTabCompleter());
-        tabCompleter.addEntries(CommandManager.getChannelCommandNames());
-        tabCompleter.addEntries(CommandManager.getChatCommandNames());
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_CHANNEL));
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_CHAT));
         
         window = Main.getUI().getChannel(Channel.this);
         WindowManager.addWindow(server.getFrame(), window);
@@ -424,8 +425,8 @@ public final class Channel extends MessageTarget
         }
         
         tabCompleter.replaceEntries(names);
-        tabCompleter.addEntries(CommandManager.getChannelCommandNames());
-        tabCompleter.addEntries(CommandManager.getChatCommandNames());
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_CHANNEL));
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_CHAT));
         
         ActionManager.processEvent(CoreActionType.CHANNEL_GOTNAMES, null, this);
     }

src/com/dmdirc/GlobalWindow.java

@@ -23,6 +23,7 @@
 package com.dmdirc;
 
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.parsers.GlobalCommandParser;
 import com.dmdirc.config.ConfigManager;
 import com.dmdirc.config.IdentityManager;
@@ -45,7 +46,7 @@ public class GlobalWindow extends WritableFrameContainer {
         super();
         
         final TabCompleter tabCompleter = new TabCompleter();
-        tabCompleter.addEntries(CommandManager.getGlobalCommandNames());
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_GLOBAL));
         
         window = Main.getUI().getInputWindow(this, GlobalCommandParser.getGlobalCommandParser());
         

src/com/dmdirc/Query.java

@@ -25,6 +25,7 @@ package com.dmdirc;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.parser.ClientInfo;
@@ -96,8 +97,8 @@ public final class Query extends MessageTarget implements
         }
         
         tabCompleter = new TabCompleter(server.getTabCompleter());
-        tabCompleter.addEntries(CommandManager.getQueryCommandNames());
-        tabCompleter.addEntries(CommandManager.getChatCommandNames());
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_QUERY));
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_CHAT));
         window.getInputHandler().setTabCompleter(tabCompleter);
         
         reregister();

src/com/dmdirc/Server.java

@@ -26,6 +26,7 @@ import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.actions.wrappers.AliasWrapper;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.config.ConfigManager;
 import com.dmdirc.config.Identity;
 import com.dmdirc.config.IdentityManager;
@@ -170,8 +171,8 @@ public final class Server extends WritableFrameContainer implements Serializable
 
         window.open();
 
-        tabCompleter.addEntries(CommandManager.getServerCommandNames());
-        tabCompleter.addEntries(CommandManager.getGlobalCommandNames());
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_SERVER));
+        tabCompleter.addEntries(CommandManager.getCommandNames(CommandType.TYPE_GLOBAL));
 
         this.autochannels = autochannels;
 

src/com/dmdirc/commandparser/CommandInfo.java

@@ -0,0 +1,77 @@
+/*
+ * 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.commandparser;
+
+/**
+ *
+ * @author chris
+ */
+public abstract class CommandInfo {
+    
+    /**
+     * Returns the signature of this command. For polyadic commands, the signature
+     * is simply the name. For other commands, the signature is a concatenation of
+     * the name, a literal "/", and the arity.
+     * @return The signature of this command
+     */
+    public final String getSignature() {
+        if (isPolyadic()) {
+            return getName();
+        } else {
+            return getName() + "/" + getArity();
+        }
+    }
+        
+    /**
+     * Returns this command's name.
+     * @return The name of this command
+     */
+    public abstract String getName();
+    
+    /**
+     * Returns whether or not this command should be shown in help messages.
+     * @return True iff the command should be shown, false otherwise
+     */
+    public abstract boolean showInHelp();
+    
+    /**
+     * Indicates whether this command is polyadic or not.
+     * @return True iff this command is polyadic, false otherwise
+     */
+    public abstract boolean isPolyadic();
+    
+    /**
+     * Returns the arity of this command.
+     * @return This command's arity
+     */
+    public abstract int getArity();
+    
+    /**
+     * Returns a string representing the help message for this command.
+     * @return the help message for this command
+     */
+    public abstract String getHelp();
+    
+    public abstract CommandType getType();
+
+}

src/com/dmdirc/commandparser/CommandManager.java

@@ -41,10 +41,13 @@ import com.dmdirc.config.IdentityManager;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.ui.input.TabCompleter;
+import com.dmdirc.util.MapList;
 import com.dmdirc.util.WeakList;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * The command manager creates and manages a single instance of all commands,
@@ -54,44 +57,14 @@ import java.util.List;
  */
 public final class CommandManager {
     
-    /**
-     * The global commands that have been instansiated.
-     */
-    private static final List<Command> globalCommands = new ArrayList<Command>();
-    /**
-     * The server commands that have been instansiated.
-     */
-    private static final List<Command> serverCommands = new ArrayList<Command>();
-    /**
-     * The channel commands that have been instansiated.
-     */
-    private static final List<Command> channelCommands = new ArrayList<Command>();
-    /**
-     * The query commands that have been instansiated.
-     */
-    private static final List<Command> queryCommands = new ArrayList<Command>();
-    /**
-     * The "chat" commands that have been instansiated.
-     */
-    private static final List<Command> chatCommands = new ArrayList<Command>();
-    
-    /**
-     * The parsers that have requested global commands.
-     */
-    private static final List<CommandParser> globalParsers = new WeakList<CommandParser>();
-    /**
-     * The parsers that have requested server commands.
-     */
-    private static final List<CommandParser> serverParsers = new WeakList<CommandParser>();
-    /**
-     * The parsers that have requested channel commands.
-     */
-    private static final List<CommandParser> channelParsers = new WeakList<CommandParser>();
-    /**
-     * The parsers that have requested query commands.
-     */
-    private static final List<CommandParser> queryParsers = new WeakList<CommandParser>();
+    /** A list of commands that have been instansiated. */
+    private static final Map<CommandInfo, Command> commands
+            = new HashMap<CommandInfo, Command>();
     
+    /** A list of command parsers that have been instansiated. */
+    private static final MapList<CommandType, CommandParser> parsers
+            = new MapList<CommandType, CommandParser>();
+           
     /**
      * Channel commands that have been registered to appear in the nicklist
      * popup.
@@ -160,21 +133,16 @@ public final class CommandManager {
         boolean canContinue = true;
         
         if (command instanceof ChannelCommand) {
-            registerCommand(command, channelParsers, register);
-            channelCommands.add(command);
+            registerCommand(command, parsers.get(CommandType.TYPE_CHANNEL), register);
         } else if (command instanceof ServerCommand) {
-            registerCommand(command, serverParsers, register);
-            serverCommands.add(command);
+            registerCommand(command, parsers.get(CommandType.TYPE_SERVER), register);
         } else if (command instanceof QueryCommand) {
-            registerCommand(command, queryParsers, register);
-            queryCommands.add(command);
+            registerCommand(command, parsers.get(CommandType.TYPE_QUERY), register);
         } else if (command instanceof GlobalCommand) {
-            registerCommand(command, globalParsers, register);
-            globalCommands.add(command);
+            registerCommand(command, parsers.get(CommandType.TYPE_GLOBAL), register);
         } else if (command instanceof ChatCommand) {
-            registerCommand(command, queryParsers, register);
-            registerCommand(command, channelParsers, register);
-            chatCommands.add(command);
+            registerCommand(command, parsers.get(CommandType.TYPE_QUERY), register);
+            registerCommand(command, parsers.get(CommandType.TYPE_CHANNEL), register);
         } else {
             canContinue = false;
             
@@ -183,6 +151,7 @@ public final class CommandManager {
         }
         
         if (canContinue) {
+            commands.put(command, command);
             registerCommandName(command, register);
         }
     }
@@ -194,7 +163,11 @@ public final class CommandManager {
      * @param parsers The parsers to register the command with
      */
     private static void registerCommand(final Command command,
-            final List<CommandParser> parsers, final boolean register) {
+            final List<? extends CommandParser> parsers, final boolean register) {
+        if (parsers == null) {
+            return;
+        }
+        
         for (CommandParser parser : parsers) {
             if (register) {
                 parser.registerCommand(command);
@@ -224,13 +197,15 @@ public final class CommandManager {
             
             if (command instanceof ChannelCommand || command instanceof ChatCommand) {
                 for (String channelName : server.getChannels()) {
-                    registerCommandName(server.getChannel(channelName).getTabCompleter(), commandName, register);
+                    registerCommandName(server.getChannel(channelName).getTabCompleter(),
+                            commandName, register);
                 }
             }
             
             if (command instanceof QueryCommand || command instanceof ChatCommand) {
                 for (String queryName : server.getQueries()) {
-                    registerCommandName(server.getQuery(queryName).getTabCompleter(), commandName, register);
+                    registerCommandName(server.getQuery(queryName).getTabCompleter(),
+                            commandName, register);
                 }
             }
         }
@@ -284,12 +259,9 @@ public final class CommandManager {
         new Ban();
         new ChannelSettings();
         new Cycle();
-        new Kick();
-        new KickEmpty();
         new KickReason();
         new Mode();
         new Part();
-        new PartDefault();
         new SetNickColour();
         new SetTopic();
         new ShowTopic();
@@ -327,7 +299,6 @@ public final class CommandManager {
         new Debug();
         new Echo();
         new Exit();
-        new ExitDefault();
         new Ifplugin();
         new NewServer();
         new Notify();
@@ -360,15 +331,15 @@ public final class CommandManager {
      * @param parser The parser to load commands into
      */
     public static void loadChannelCommands(final CommandParser parser) {
-        for (Command com : channelCommands) {
+        for (Command com : getCommands(CommandType.TYPE_CHANNEL, null, null)) {
             parser.registerCommand(com);
         }
         
-        for (Command com : chatCommands) {
+        for (Command com : getCommands(CommandType.TYPE_CHAT, null, null)) {
             parser.registerCommand(com);
         }
         
-        channelParsers.add(parser);
+        parsers.add(CommandType.TYPE_CHANNEL, parser);
     }
     
     /**
@@ -377,11 +348,11 @@ public final class CommandManager {
      * @param parser The parser to load commands into
      */
     public static void loadServerCommands(final CommandParser parser) {
-        for (Command command : serverCommands) {
+        for (Command command : getCommands(CommandType.TYPE_SERVER, null, null)) {
             parser.registerCommand(command);
         }
         
-        serverParsers.add(parser);
+        parsers.add(CommandType.TYPE_SERVER, parser);
     }
     
     /**
@@ -390,11 +361,11 @@ public final class CommandManager {
      * @param parser The parser to load commands into
      */
     public static void loadGlobalCommands(final CommandParser parser) {
-        for (Command com : globalCommands) {
+        for (Command com : getCommands(CommandType.TYPE_GLOBAL, null, null)) {
             parser.registerCommand(com);
         }
         
-        globalParsers.add(parser);
+        parsers.add(CommandType.TYPE_GLOBAL, parser);
     }
     
     /**
@@ -403,15 +374,15 @@ public final class CommandManager {
      * @param parser The parser to load commands into
      */
     public static void loadQueryCommands(final CommandParser parser) {
-        for (Command com : queryCommands) {
+        for (Command com : getCommands(CommandType.TYPE_QUERY, null, null)) {
             parser.registerCommand(com);
         }
         
-        for (Command com : chatCommands) {
+        for (Command com : getCommands(CommandType.TYPE_CHAT, null, null)) {
             parser.registerCommand(com);
         }
         
-        queryParsers.add(parser);
+        parsers.add(CommandType.TYPE_QUERY, parser);
     }
     
     /**
@@ -422,195 +393,16 @@ public final class CommandManager {
      * @return A command with a matching signature, or null if none were found
      */
     public static Command getCommand(final String name) {
-        if (getGlobalCommandByName(name) != null) {
-            return getGlobalCommandByName(name);
-        } else if (getServerCommandByName(name) != null) {
-            return getServerCommandByName(name);
-        } else if (getChannelCommandByName(name) != null) {
-            return getChannelCommandByName(name);
-        } else if (getChatCommandByName(name) != null) {
-            return getChatCommandByName(name);
-        } else {
-            return getChannelCommandByName(name);
-        }
-    }
-    
-    /**
-     * Retrieves the server command identified by the specified signature.
-     * 
-     * @param signature The signature to look for
-     * @return A server command with a matching signature, or null if none
-     * were found.
-     */
-    public static ServerCommand getServerCommand(final String signature) {
-        for (Command com : serverCommands) {
-            if (com.getSignature().equalsIgnoreCase(signature)) {
-                return (ServerCommand) com;
-            }
-        }
-        
-        return null;
-    }
-    
-    /**
-     * Retrieves the server command identified by the specified name.
-     * 
-     * @param name The name to look for
-     * @return A server command with a matching name, or null if none were found
-     */
-    public static ServerCommand getServerCommandByName(final String name) {
-        return (ServerCommand) getCommandByName(name, serverCommands);
-    }
-    
-    /**
-     * Retrieves the global command identified by the specified signature.
-     * 
-     * @param signature The signature to look for
-     * @return A global command with a matching signature, or null if none
-     * were found.
-     */
-    public static GlobalCommand getGlobalCommand(final String signature) {
-        for (Command com : globalCommands) {
-            if (com.getSignature().equalsIgnoreCase(signature)) {
-                return (GlobalCommand) com;
-            }
-        }
-        
-        return null;
-    }
-    
-    /**
-     * Retrieves the global command identified by the specified name.
-     * 
-     * @param name The name to look for
-     * @return A global command with a matching name, or null if none were found
-     */
-    public static GlobalCommand getGlobalCommandByName(final String name) {
-        return (GlobalCommand) getCommandByName(name, globalCommands);
-    }
-    
-    /**
-     * Retrieves the channel command identified by the specified signature.
-     * 
-     * @param signature The signature to look for
-     * @return A channel command with a matching signature, or null if none
-     * were found.
-     */
-    public static ChannelCommand getChannelCommand(final String signature) {
-        for (Command com : channelCommands) {
-            if (com.getSignature().equalsIgnoreCase(signature)) {
-                return (ChannelCommand) com;
-            }
-        }
-        
-        return null;
-    }
-    
-    /**
-     * Retrieves the channel command identified by the specified name.
-     * 
-     * @param name The name to look for
-     * @return A channel command with a matching name, or null if none were found
-     */
-    public static ChannelCommand getChannelCommandByName(final String name) {
-        return (ChannelCommand) getCommandByName(name, channelCommands);
-    }
-    
-    /**
-     * Retrieves the chat command identified by the specified signature.
-     * 
-     * @param signature The signature to look for
-     * @return A chat command with a matching signature, or null if none
-     * were found.
-     */
-    public static ChatCommand getChatCommand(final String signature) {
-        for (Command com : chatCommands) {
-            if (com.getSignature().equalsIgnoreCase(signature)) {
-                return (ChatCommand) com;
-            }
-        }
-        
-        return null;
-    }
-    
-    /**
-     * Retrieves the chat command identified by the specified name.
-     * 
-     * @param name The name to look for
-     * @return A chat command with a matching name, or null if none were found
-     */
-    public static ChatCommand getChatCommandByName(final String name) {
-        return (ChatCommand) getCommandByName(name, chatCommands);
+        return getCommand(null, name, null);
     }
     
-    /**
-     * Retrieves the command identified by the specified name.
-     * 
-     * @param name The name to look for
-     * @param list The list to look in
-     * @return A command with a matching name, or null if none were found
-     */
-    private static Command getCommandByName(final String name,
-            final List<Command> list) {
-        for (Command com : list) {
-            if (com.getName().equalsIgnoreCase(name)) {
-                return com;
-            }
-        }
+    public static Command getCommand(final CommandType type, final String name,
+            final String signature) {
+        final List<Command> res = getCommands(type, name, signature);
         
-        return null;
-    }
-    
-    /**
-     * Returns a list containing the global commands that have been initialised
-     * by this command manager.
-     * 
-     * @return An ArrayList of global commands, or null if none have been loaded
-     */
-    public static List<Command> getGlobalCommands() {
-        return globalCommands;
-    }
-    
-    /**
-     * Returns a list containing the server commands that have been initialised
-     * by this command manager.
-     * 
-     * @return An ArrayList of server commands, or null if none have been loaded
-     */
-    public static List<Command> getServerCommands() {
-        return serverCommands;
-    }
-    
-    /**
-     * Returns a list containing the channel commands that have been initialised
-     * by this command manager.
-     * 
-     * @return An ArrayList of channel commands, or null if none have been loaded
-     */
-    public static List<Command> getChannelCommands() {
-        return channelCommands;
-    }
-    
-    /**
-     * Returns a list containing the chat commands that have been initialised
-     * by this command manager.
-     * 
-     * @return An ArrayList of chat commands, or null if none have been loaded
-     */
-    public static List<Command> getChatCommands() {
-        return chatCommands;
-    }
-    
-    /**
-     * Returns a list containing the query commands that have been initialised
-     * by this command manager.
-     * 
-     * @return An ArrayList of query commands, or null if none have been loaded
-     */
-    public static List<Command> getQueryCommands() {
-        return queryCommands;
-    }
-    
+        return res.isEmpty() ? null : res.get(0);
+    }    
+     
     /**
      * Determines if the specified command is a valid channel command.
      * 
@@ -618,90 +410,34 @@ public final class CommandManager {
      * @return True iff the command is a channel command, false otherwise
      */
     public static boolean isChannelCommand(final String command) {
-        for (Command chanCommand : channelCommands) {
-            if (chanCommand.getName().equalsIgnoreCase(command)) {
-                return true;
-            }
-        }
+        return getCommand(CommandType.TYPE_CHANNEL, command, null) != null
+                || getCommand(CommandType.TYPE_CHAT, command, null) != null;
+    }
+       
+    public static List<String> getCommandNames(final CommandType type) {
+        final List<String> res = new ArrayList<String>();
         
-        for (Command chanCommand : chatCommands) {
-            if (chanCommand.getName().equalsIgnoreCase(command)) {
-                return true;
-            }
+        for (Command command : getCommands(type, null, null)) {
+            res.add(getCommandChar() + command.getName());
         }
         
-        return false;
-    }
-    
-    /**
-     * Returns the names (including command char) of all registered server
-     * commands.
-     * 
-     * @return An ArrayList&lt;String&gt; containing all registered server command
-     * names
-     */
-    public static List<String> getServerCommandNames() {
-        return getCommandNames(serverCommands);
-    }
-    
-    /**
-     * Returns the names (including command char) of all registered global
-     * commands.
-     * 
-     * @return An ArrayList&lt;String&gt; containing all registered global command
-     * names
-     */
-    public static List<String> getGlobalCommandNames() {
-        return getCommandNames(globalCommands);
-    }
-    
-    /**
-     * Returns the names (including command char) of all registered channel
-     * commands.
-     * 
-     * @return A list containing all registered channel command names
-     */
-    public static List<String> getChannelCommandNames() {
-        return getCommandNames(channelCommands);
-    }
-    
-    /**
-     * Returns the names (including command char) of all registered query
-     * commands.
-     * 
-     * @return A list containing all registered query command names
-     */
-    public static List<String> getQueryCommandNames() {
-        return getCommandNames(queryCommands);
+        return res;
     }
     
-    /**
-     * Returns the names (including command char) of all registered chat
-     * commands.
-     * 
-     * @return An ArrayList&lt;String&gt; containing all registered chat command
-     * names
-     */
-    public static List<String> getChatCommandNames() {
-        return getCommandNames(chatCommands);
+    public static List<Command> getCommands(final CommandType type) {    
+        return getCommands(type, null, null);
     }
     
-    /**
-     * Iterates through the specified source and returns a list of the names
-     * of all commands found in it.
-     * 
-     * @param source The source vector to iterate over
-     * @return A list of all commands in the source
-     */
-    private static List<String> getCommandNames(final List<Command> source) {
-        if (source == null) {
-            return null;
-        }
+    private static List<Command> getCommands(final CommandType type,
+            final String name, final String signature) {
+        final List<Command> res = new ArrayList<Command>();
         
-        final List<String> res = new ArrayList<String>();
-        
-        for (Command command : source) {
-            res.add(getCommandChar() + command.getName());
+        for (Map.Entry<CommandInfo, Command> entry : commands.entrySet()) {
+            if ((type == null || type.equals(entry.getKey().getType()))
+                    && (name == null || name.equals(entry.getKey().getName()))
+                    && (signature == null || signature.equals(entry.getKey().getSignature()))) {
+                res.add(entry.getValue());
+            }
         }
         
         return res;

src/com/dmdirc/commandparser/CommandType.java

@@ -0,0 +1,60 @@
+/*
+ * 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.commandparser;
+
+import com.dmdirc.commandparser.commands.ChannelCommand;
+import com.dmdirc.commandparser.commands.ChatCommand;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.GlobalCommand;
+import com.dmdirc.commandparser.commands.QueryCommand;
+import com.dmdirc.commandparser.commands.ServerCommand;
+
+/**
+ *
+ * @author chris
+ */
+public enum CommandType {
+    
+    TYPE_GLOBAL,
+    TYPE_SERVER,
+    TYPE_CHAT,
+    TYPE_CHANNEL,
+    TYPE_QUERY;
+    
+    public static CommandType fromCommand(final Command command) {
+        if (command instanceof GlobalCommand) {
+            return TYPE_GLOBAL;
+        } else if (command instanceof ServerCommand) {
+            return TYPE_SERVER;
+        } else if (command instanceof ChatCommand) {
+            return TYPE_CHAT;
+        } else if (command instanceof ChannelCommand) {
+            return TYPE_CHANNEL;
+        } else if (command instanceof QueryCommand) {
+            return TYPE_QUERY;
+        } else {
+            return null;
+        }
+    }
+
+}

src/com/dmdirc/commandparser/commands/Command.java

@@ -22,65 +22,23 @@
 
 package com.dmdirc.commandparser.commands;
 
+import com.dmdirc.commandparser.CommandInfo;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.ui.interfaces.InputWindow;
 
 /**
  * Represents a generic command.
  * @author chris
  */
-public abstract class Command implements Comparable<Command> {
+public abstract class Command extends CommandInfo implements Comparable<Command> {
     
     /** The format name used for command output. */
     protected static final String FORMAT_OUTPUT = "commandOutput";
     
     /** The format name used for command errors. */
     protected static final String FORMAT_ERROR = "commandError";
-            
-    /**
-     * Returns the signature of this command. For polyadic commands, the signature
-     * is simply the name. For other commands, the signature is a concatenation of
-     * the name, a literal "/", and the arity.
-     * @return The signature of this command
-     */
-    public final String getSignature() {
-        if (isPolyadic()) {
-            return getName();
-        } else {
-            return getName() + "/" + getArity();
-        }
-    }
-        
-    /**
-     * Returns this command's name.
-     * @return The name of this command
-     */
-    public abstract String getName();
-    
-    /**
-     * Returns whether or not this command should be shown in help messages.
-     * @return True iff the command should be shown, false otherwise
-     */
-    public abstract boolean showInHelp();
-    
-    /**
-     * Indicates whether this command is polyadic or not.
-     * @return True iff this command is polyadic, false otherwise
-     */
-    public abstract boolean isPolyadic();
-    
-    /**
-     * Returns the arity of this command.
-     * @return This command's arity
-     */
-    public abstract int getArity();
-    
-    /**
-     * Returns a string representing the help message for this command.
-     * @return the help message for this command
-     */
-    public abstract String getHelp();
-    
+               
     /**
      * Implodes the given list of arguments.
      * @param offset The index to start at
@@ -137,7 +95,15 @@ public abstract class Command implements Comparable<Command> {
     }    
     
     /** {@inheritDoc} */
+    @Override
     public final int compareTo(final Command o) {
         return getSignature().compareTo(o.getSignature());
     }
+
+    /** {@inheritDoc} */
+    @Override
+    public CommandType getType() {
+        return CommandType.fromCommand(this);
+    }
+
 }

src/com/dmdirc/commandparser/commands/channel/Kick.java

@@ -1,87 +0,0 @@
-/*
- * 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.commandparser.commands.channel;
-
-import com.dmdirc.Channel;
-import com.dmdirc.Server;
-import com.dmdirc.commandparser.commands.ChannelCommand;
-import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.ui.interfaces.InputWindow;
-
-/**
- * The kick command kicks a specified user from the channel.
- * @author chris
- */
-public final class Kick extends ChannelCommand {
-    
-    /** Creates a new instance of Kick. */
-    public Kick() {
-        super();
-        
-        CommandManager.registerCommand(this);
-        CommandManager.registerPopupCommand(this);
-    }
-    
-    /**
-     * Executes this command.
-     * @param origin The frame in which this command was issued
-     * @param server The server object that this command is associated with
-     * @param channel The channel object that this command is associated with
-     * @param isSilent Whether this command is silenced or not
-     * @param args The user supplied arguments
-     */
-    public void execute(final InputWindow origin, final Server server,
-            final Channel channel, final boolean isSilent, final String... args) {
-        final String[] newArgs = new String[2];
-        newArgs[0] = args[0]; // Nickname
-        newArgs[1] = origin.getConfigManager().getOption("general", "kickmessage");
-        
-        CommandManager.getChannelCommand("kick").execute(origin, server, channel, isSilent, newArgs);
-    }
-    
-    /** {@inheritDoc}. */
-    public String getName() {
-        return "kick";
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean showInHelp() {
-        return true;
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean isPolyadic() {
-        return false;
-    }
-    
-    /** {@inheritDoc}. */
-    public int getArity() {
-        return 1;
-    }
-    
-    /** {@inheritDoc}. */
-    public String getHelp() {
-        return "kick <user> - kicks the specified user from the channel";
-    }
-    
-}

src/com/dmdirc/commandparser/commands/channel/KickEmpty.java

@@ -1,82 +0,0 @@
-/*
- * 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.commandparser.commands.channel;
-
-import com.dmdirc.Channel;
-import com.dmdirc.Server;
-import com.dmdirc.commandparser.commands.ChannelCommand;
-import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.ui.interfaces.InputWindow;
-
-/**
- * The kick/0 command informs the user of the correct usage of /kick.
- * @author chris
- */
-public final class KickEmpty extends ChannelCommand {
-    
-    /** Creates a new instance of KickEmpty. */
-    public KickEmpty() {
-        super();
-        
-        CommandManager.registerCommand(this);
-    }
-    
-    /**
-     * Executes this command.
-     * @param origin The frame in which this command was issued
-     * @param server The server object that this command is associated with
-     * @param channel The channel object that this command is associated with
-     * @param isSilent Whether this command is silenced or not
-     * @param args The user supplied arguments
-     */
-    public void execute(final InputWindow origin, final Server server,
-            final Channel channel, final boolean isSilent, final String... args) {
-        showUsage(origin, isSilent, "kick", "<user> [reason]");
-    }
-    
-    /** {@inheritDoc}. */
-    public String getName() {
-        return "kick";
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean showInHelp() {
-        return false;
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean isPolyadic() {
-        return false;
-    }
-    
-    /** {@inheritDoc}. */
-    public int getArity() {
-        return 0;
-    }
-    
-    /** {@inheritDoc}. */
-    public String getHelp() {
-        return null;
-    }
-    
-}

src/com/dmdirc/commandparser/commands/channel/KickReason.java

@@ -53,13 +53,17 @@ public final class KickReason extends ChannelCommand {
      */
     public void execute(final InputWindow origin, final Server server,
             final Channel channel, final boolean isSilent, final String... args) {
+        if (args.length == 0) {
+            showUsage(origin, isSilent, "kick", "<user> [reason]");
+            return;
+        }
         
         final ChannelClientInfo victim = channel.getChannelInfo().getUser(args[0]);
         
         if (victim == null) {
             sendLine(origin, isSilent, FORMAT_ERROR, "User not found: " + args[0]);
         } else {
-            victim.kick(implodeArgs(1, args));
+            victim.kick(args.length > 1 ? implodeArgs(1, args) : origin.getConfigManager().getOption("general", "kickmessage"));
         }
     }
     
@@ -85,7 +89,7 @@ public final class KickReason extends ChannelCommand {
     
     /** {@inheritDoc}. */
     public String getHelp() {
-        return "kick <user> <reason> - kicks the specified user from the channel";
+        return "kick <user> [reason] - kicks the specified user from the channel";
     }
     
 }

src/com/dmdirc/commandparser/commands/channel/Part.java

@@ -51,7 +51,8 @@ public final class Part extends ChannelCommand {
      */
     public void execute(final InputWindow origin, final Server server,
             final Channel channel, final boolean isSilent, final String... args) {
-        channel.part(implodeArgs(args));
+        channel.part(args.length > 0 ? implodeArgs(args)
+                : origin.getConfigManager().getOption("general", "partmessage"));
         channel.closeWindow();
     }
     

src/com/dmdirc/commandparser/commands/channel/PartDefault.java

@@ -1,86 +0,0 @@
-/*
- * 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.commandparser.commands.channel;
-
-import com.dmdirc.Channel;
-import com.dmdirc.Server;
-import com.dmdirc.commandparser.commands.ChannelCommand;
-import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.ui.interfaces.InputWindow;
-
-/**
- * The PartDefault command (part/0) is used when the user does not specify a
- * part message to use. It retrieves the default part message from the config,
- * and calls the main Part command.
- * @author chris
- */
-public final class PartDefault extends ChannelCommand {
-    
-    /** Creates a new instance of PartDefault. */
-    public PartDefault() {
-        super();
-        
-        CommandManager.registerCommand(this);
-    }
-    
-    /**
-     * Executes this command.
-     * @param origin The frame in which this command was issued
-     * @param server The server object that this command is associated with
-     * @param channel The channel object that this command is associated with
-     * @param isSilent Whether this command is silenced or not
-     * @param args The user supplied arguments
-     */
-    public void execute(final InputWindow origin, final Server server,
-            final Channel channel, final boolean isSilent, final String... args) {
-        final ChannelCommand com = CommandManager.getChannelCommand("part");
-        com.execute(origin, server, channel, isSilent, origin.getConfigManager().getOption("general", "partmessage"));
-    }
-    
-    /** {@inheritDoc}. */
-    public String getName() {
-        return "part";
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean showInHelp() {
-        return true;
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean isPolyadic() {
-        return false;
-    }
-    
-    /** {@inheritDoc}. */
-    public int getArity() {
-        return 0;
-    }
-    
-    /** {@inheritDoc}. */
-    public String getHelp() {
-        return "part - parts the channel with the default message";
-    }
-    
-}
-

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

@@ -46,8 +46,9 @@ public final class Exit extends GlobalCommand {
     
     /** {@inheritDoc} */
     public void execute(final InputWindow origin, final boolean isSilent,
-            final String... args) {
-        Main.quit(implodeArgs(args));
+            final String... args) {                
+        Main.quit(args.length > 0 ? implodeArgs(args)
+                : origin.getConfigManager().getOption("general", "closemessage"));
     }
     
     
@@ -73,7 +74,7 @@ public final class Exit extends GlobalCommand {
     
     /** {@inheritDoc}. */
     public String getHelp() {
-        return "exit <reason> - exits the client with the specified reason";
+        return "exit [reason] - exits the client";
     }
     
 }

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

@@ -1,87 +0,0 @@
-/*
- * 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.commandparser.commands.global;
-
-import com.dmdirc.commandparser.CommandManager;
-import com.dmdirc.commandparser.commands.GlobalCommand;
-import com.dmdirc.config.IdentityManager;
-import com.dmdirc.ui.interfaces.InputWindow;
-
-/**
- * Represents the exit/0 command (i.e., an exit with no arguments). Reads the
- * default exit message from the config file and calls the normal exit command
- * with it as an argument.
- * @author chris
- */
-public final class ExitDefault extends GlobalCommand {
-    
-    /**
-     * Creates a new instance of ExitDefault.
-     */
-    public ExitDefault() {
-        super();
-        
-        CommandManager.registerCommand(this);
-    }
-    
-    /** {@inheritDoc} */
-    public void execute(final InputWindow origin, final boolean isSilent,
-            final String... args) {
-        String def;
-        
-        if (origin == null) {
-            def = IdentityManager.getGlobalConfig().getOption("general", "closemessage");
-        } else {
-            def = origin.getConfigManager().getOption("general", "closemessage");
-        }
-        
-        CommandManager.getGlobalCommand("exit").execute(origin, isSilent, def);
-    }
-    
-    
-    /** {@inheritDoc}. */
-    public String getName() {
-        return "exit";
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean showInHelp() {
-        return true;
-    }
-    
-    /** {@inheritDoc}. */
-    public boolean isPolyadic() {
-        return false;
-    }
-    
-    /** {@inheritDoc}. */
-    public int getArity() {
-        return 0;
-    }
-    
-    /** {@inheritDoc}. */
-    public String getHelp() {
-        return "exit - exits the client with the default closing message";
-    }
-    
-}

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

@@ -25,6 +25,7 @@ package com.dmdirc.commandparser.commands.global;
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.commands.Command;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.commands.ServerCommand;
 import com.dmdirc.ui.interfaces.ChannelWindow;
 import com.dmdirc.ui.interfaces.InputWindow;
@@ -61,22 +62,22 @@ public final class Help extends ServerCommand {
     public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final String... args) {
         sendLine(origin, isSilent, FORMAT_OUTPUT, "-- Global commands ----------------------------------");
-        showCommands(CommandManager.getGlobalCommands(), origin, isSilent);
+        showCommands(CommandManager.getCommands(CommandType.TYPE_GLOBAL), origin, isSilent);
         
         if (origin instanceof ServerWindow || origin instanceof ChannelWindow
                 || origin instanceof QueryWindow) {
             sendLine(origin, isSilent, FORMAT_OUTPUT, "-- Server commands ----------------------------------");
-            showCommands(CommandManager.getServerCommands(), origin, isSilent);
+            showCommands(CommandManager.getCommands(CommandType.TYPE_SERVER), origin, isSilent);
         }
         
             if (origin instanceof ChannelWindow) {
             sendLine(origin, isSilent, FORMAT_OUTPUT, "-- Channel commands ---------------------------------");
-            showCommands(CommandManager.getChannelCommands(), origin, isSilent);
+            showCommands(CommandManager.getCommands(CommandType.TYPE_CHANNEL), origin, isSilent);
         }
         
         if (origin instanceof QueryWindow) {
             sendLine(origin, isSilent, FORMAT_OUTPUT, "-- Query commands -----------------------------------");
-            showCommands(CommandManager.getQueryCommands(), origin, isSilent);
+            showCommands(CommandManager.getCommands(CommandType.TYPE_QUERY), origin, isSilent);
             
         }