* Added me/0 and me commands for query windows

* Updated help command to show query commands
* Javadoc'd and tidied up server commands and the CommandManager

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

src/uk/org/ownage/dmdirc/commandparser/CommandManager.java

@@ -26,6 +26,7 @@ import java.util.Vector;
 import uk.org.ownage.dmdirc.commandparser.commands.*;
 import uk.org.ownage.dmdirc.commandparser.commands.server.*;
 import uk.org.ownage.dmdirc.commandparser.commands.channel.*;
+import uk.org.ownage.dmdirc.commandparser.commands.query.*;
 
 /**
  * The command manager creates and manages a single instance of all commands,
@@ -94,6 +95,9 @@ public class CommandManager {
     static void loadQueryCommands(QueryCommandParser parser) {
         if (queryCommands == null)    {
             queryCommands = new Vector<Command>(0,1);
+            
+            queryCommands.add(new QueryMe());
+            queryCommands.add(new QueryMeEmpty());
         }
         
         for (Command com : queryCommands) {
@@ -141,20 +145,31 @@ public class CommandManager {
         return null;
     }
     
-    public static Vector<Command> getServerCommands() {
-        if (serverCommands == null) {
-            return null;
-        }
-        
+    /**
+     * Returns a Vector containing the server commands that have been initialised
+     * by this command manager
+     * @return A Vector of server commands, or null if none have been loaded
+     */
+    public static Vector<Command> getServerCommands() {       
         return serverCommands;
     }
     
-    public static Vector<Command> getChannelCommands() {
-        if (channelCommands == null) {
-            return null;
-        }
-        
+    /**
+     * Returns a Vector containing the channel commands that have been initialised
+     * by this command manager
+     * @return A Vector of channel commands, or null if none have been loaded
+     */    
+    public static Vector<Command> getChannelCommands() {       
         return channelCommands;
     }
     
+    /**
+     * Returns a Vector containing the query commands that have been initialised
+     * by this command manager
+     * @return A Vector of query commands, or null if none have been loaded
+     */    
+    public static Vector<Command> getQueryCommands() {       
+        return queryCommands;
+    }    
+    
 }

src/uk/org/ownage/dmdirc/commandparser/commands/query/QueryMe.java

@@ -0,0 +1,57 @@
+/*
+ * 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 uk.org.ownage.dmdirc.commandparser.commands.query;
+
+import uk.org.ownage.dmdirc.Query;
+import uk.org.ownage.dmdirc.Server;
+import uk.org.ownage.dmdirc.commandparser.QueryCommand;
+import uk.org.ownage.dmdirc.commandparser.CommandWindow;
+
+/**
+ * Represents the /me command used in a query window.
+ * @author chris
+ */
+public class QueryMe extends QueryCommand {
+    
+    /** Creates a new instance of QueryMe */
+    public QueryMe() {
+        description = "sends an action to the query receipient";
+        arguments = "<action>";
+        polyadic = true;
+        arity = 0;
+        name = "me";
+        show = true;
+    }
+
+    /**
+     * 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 query The query object that this command is associated with
+     * @param args The user supplied arguments
+     */
+    public void execute(CommandWindow origin, Server server, Query query, String... args) {
+        query.sendAction(implodeArgs(args));
+    }
+    
+}

src/uk/org/ownage/dmdirc/commandparser/commands/query/QueryMeEmpty.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 uk.org.ownage.dmdirc.commandparser.commands.query;
+
+import uk.org.ownage.dmdirc.Query;
+import uk.org.ownage.dmdirc.Config;
+import uk.org.ownage.dmdirc.Server;
+import uk.org.ownage.dmdirc.commandparser.QueryCommand;
+import uk.org.ownage.dmdirc.commandparser.CommandWindow;
+
+/**
+ * Represents the /me command used in a query window, with no parameters.
+ * Informs the user of the correct usage
+ * @author chris
+ */
+public class QueryMeEmpty extends QueryCommand {
+    
+    /** Creates a new instance of QueryMeEmpty */
+    public QueryMeEmpty() {
+        description = "informs the user of the correct usage of the me command";
+        arguments = "";
+        polyadic = false;
+        arity = 0;
+        name = "me";
+        show = false;
+    }
+    
+    /**
+     * 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 query The query object that this command is associated with
+     * @param args The user supplied arguments
+     */
+    public void execute(CommandWindow origin, Server server, Query query, String... args) {
+        origin.addLine("Usage: "+Config.getOption("general","commandchar")+"me <action>");
+    }
+    
+}

src/uk/org/ownage/dmdirc/commandparser/commands/server/Help.java

@@ -29,15 +29,18 @@ import uk.org.ownage.dmdirc.commandparser.CommandManager;
 import uk.org.ownage.dmdirc.commandparser.CommandWindow;
 import uk.org.ownage.dmdirc.commandparser.ServerCommand;
 import uk.org.ownage.dmdirc.ui.ChannelFrame;
+import uk.org.ownage.dmdirc.ui.QueryFrame;
 
 /**
- *
+ * The help command shows the user a list of available commands, along with
+ * their arguments, and a description. It is context-aware, so channel commands
+ * are only displayed when in a channel window, for example.
  * @author chris
  */
 public class Help extends ServerCommand {
     
     /**
-     * Creates a new instance of QuitDefault
+     * Creates a new instance of Help
      */
     public Help() {
         description = "Displays usage information for all implemented commands";
@@ -48,6 +51,12 @@ public class Help extends ServerCommand {
         show = true;
     }
     
+    /**
+     * 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 args The user supplied arguments
+     */    
     public void execute(CommandWindow origin, Server server, String... args) {
         origin.addLine("-- Server commands ----------------------------------");
         for (Command com : CommandManager.getServerCommands()) {
@@ -63,6 +72,14 @@ public class Help extends ServerCommand {
                 }
             }
         }
+        if (origin instanceof QueryFrame) {
+            origin.addLine("-- Query commands -----------------------------------");
+            for (Command com : CommandManager.getQueryCommands()) {
+                if (com.showInHelp()) {
+                    origin.addLine(com.getHelp());
+                }
+            }
+        }
         origin.addLine("-----------------------------------------------------");
     }
     

src/uk/org/ownage/dmdirc/commandparser/commands/server/Join.java

@@ -28,13 +28,14 @@ import uk.org.ownage.dmdirc.commandparser.CommandWindow;
 import uk.org.ownage.dmdirc.commandparser.ServerCommand;
 
 /**
- *
+ * The join command allows users to join a channel, or a comma-seperated list
+ * of channels.
  * @author chris
  */
 public class Join extends ServerCommand {
     
     /**
-     * Creates a new instance of QuitDefault
+     * Creates a new instance of Join
      */
     public Join () {
         description = "Joins the specified channel. Multiple channels may be seperated by commas.";
@@ -44,7 +45,13 @@ public class Join extends ServerCommand {
         name = "join";
         show = true;
     }
-    
+
+    /**
+     * 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 args The user supplied arguments
+     */    
     public void execute(CommandWindow origin, Server server, String... args) {
         server.getParser().joinChannel(args[0]);
     }

src/uk/org/ownage/dmdirc/commandparser/commands/server/Quit.java

@@ -29,13 +29,15 @@ import uk.org.ownage.dmdirc.commandparser.CommandWindow;
 import uk.org.ownage.dmdirc.commandparser.ServerCommand;
 
 /**
- *
+ * The quit command allows the user to quit DMDirc with a custom quit message.
+ * When the client quits, it disconnects all servers (with the quit message
+ * supplied) and saves the config file.
  * @author chris
  */
 public class Quit extends ServerCommand {
     
     /**
-     * Creates a new instance of QuitDefault
+     * Creates a new instance of Quit
      */
     public Quit() {
         description = "Quits DMDirc, sending the specified quit message to all servers";
@@ -46,6 +48,12 @@ public class Quit extends ServerCommand {
         show = true;
     }
     
+    /**
+     * 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 args The user supplied arguments
+     */    
     public void execute(CommandWindow origin, Server server, String... args) {
         ServerManager.getServerManager().disconnectAll(implodeArgs(args));
         Config.save();

src/uk/org/ownage/dmdirc/commandparser/commands/server/QuitDefault.java

@@ -29,7 +29,9 @@ import uk.org.ownage.dmdirc.commandparser.CommandWindow;
 import uk.org.ownage.dmdirc.commandparser.ServerCommand;
 
 /**
- *
+ * Represents the quit/0 command (i.e., a quit with no arguments). Reads the
+ * default quit message from the config file and calls the normal quit command
+ * with it as an argument.
  * @author chris
  */
 public class QuitDefault extends ServerCommand {
@@ -41,11 +43,17 @@ public class QuitDefault extends ServerCommand {
         description = "Quits DMDirc, sending a default quit message to all servers";
         arguments = "";
         polyadic = false;
-        arity = 0;            
-        name = "quit";        
-        show = true;        
+        arity = 0;
+        name = "quit";
+        show = true;
     }
-
+    
+    /**
+     * 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 args The user supplied arguments
+     */
     public void execute(CommandWindow origin, Server server, String... args) {
         String def = Config.getOption("general","quitmessage");
         CommandManager.getServerCommad("quit").execute(origin, server, def);