* Added CommandWindow interface, for frames that allow the user to issue commands

* Updated command parser to take a CommandWindow reference when executing

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

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

@@ -60,10 +60,11 @@ public class ChannelCommandParser extends CommandParser {
     
     /**
      * Executes the specified command with the given arguments.
+     * @param origin The window in which the command was typed
      * @param command The command to be executed
      * @param args The arguments to the command
      */    
-    protected void executeCommand(Command command, String... args) {
+    protected void executeCommand(CommandWindow origin, Command command, String... args) {
         throw new UnsupportedOperationException("Not implemented yet");
     }
     
@@ -71,19 +72,21 @@ public class ChannelCommandParser extends CommandParser {
      * Called when the user attempted to issue a command (i.e., used the command
      * character) that wasn't found. It could be that the command has a different
      * arity, or that it plain doesn't exist.
+     * @param origin The window in which the command was typed
      * @param command The command the user tried to execute
      * @param args The arguments passed to the command
      */    
-    protected void handleInvalidCommand(String command, String... args) {
+    protected void handleInvalidCommand(CommandWindow origin, String command, String... args) {
         throw new UnsupportedOperationException("Not implemented yet");
     }
     
     /**
      * Called when the input was a line of text that was not a command. This normally
      * means it is sent to the server/channel/user as-is, with no further processing.
+     * @param origin The window in which the command was typed
      * @param line The line input by the user
      */    
-    protected void handleNonCommand(String line) {
+    protected void handleNonCommand(CommandWindow origin, String line) {
         throw new UnsupportedOperationException("Not implemented yet");
     }
     

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

@@ -57,9 +57,10 @@ abstract public class CommandParser {
     
     /**
      * Parses the specified string as a command
+     * @param origin The window in which the command was typed
      * @param line The line to be parsed
      */
-    public void parseCommand(String line) {
+    public void parseCommand(CommandWindow origin, String line) {
         if (line.charAt(0) == Config.getOption("general","commandchar").charAt(0)) {
             String[] args = line.split(" ");
             
@@ -73,37 +74,40 @@ abstract public class CommandParser {
             // have error handlers if there are too few arguments (e.g., msg/0 and
             // msg/1 would return errors, so msg only gets called with 2+ args).
             if (commands.containsKey(signature)) {
-                executeCommand(commands.get(signature), args);
+                executeCommand(origin, commands.get(signature), args);
             } else if (commands.containsKey(command)) {
-                executeCommand(commands.get(command), args);
+                executeCommand(origin, commands.get(command), args);
             } else {
-                handleInvalidCommand(command, args);
+                handleInvalidCommand(origin, command, args);
             }
         } else {
-            handleNonCommand(line);
+            handleNonCommand(origin, line);
         }
     }
     
     /**
      * Executes the specified command with the given arguments.
+     * @param origin The window in which the command was typed
      * @param command The command to be executed
      * @param args The arguments to the command
      */
-    abstract protected void executeCommand(Command command, String... args);
+    abstract protected void executeCommand(CommandWindow origin, Command command, String... args);
     
     /**
      * Called when the user attempted to issue a command (i.e., used the command
      * character) that wasn't found. It could be that the command has a different
      * arity, or that it plain doesn't exist.
+     * @param origin The window in which the command was typed
      * @param command The command the user tried to execute
      * @param args The arguments passed to the command
      */
-    abstract protected void handleInvalidCommand(String command, String... args);
+    abstract protected void handleInvalidCommand(CommandWindow origin, String command, String... args);
 
     /**
      * Called when the input was a line of text that was not a command. This normally
      * means it is sent to the server/channel/user as-is, with no further processing.
+     * @param origin The window in which the command was typed
      * @param line The line input by the user
      */
-    abstract protected void handleNonCommand(String line);
+    abstract protected void handleNonCommand(CommandWindow origin, String line);
 }

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

@@ -0,0 +1,33 @@
+/*
+ * 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;
+
+/**
+ *
+ * @author chris
+ */
+public interface CommandWindow {
+    
+    public void addLine(String line);
+    
+}

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

@@ -52,10 +52,11 @@ public class ServerCommandParser extends CommandParser {
     
     /**
      * Executes the specified command with the given arguments.
+     * @param origin The window in which the command was typed
      * @param command The command to be executed
      * @param args The arguments to the command
      */
-    protected void executeCommand(Command command, String... args) {
+    protected void executeCommand(CommandWindow origin, Command command, String... args) {
         ((ServerCommand)command).execute(server, args);
     }
     
@@ -63,19 +64,21 @@ public class ServerCommandParser extends CommandParser {
      * Called when the user attempted to issue a command (i.e., used the command
      * character) that wasn't found. It could be that the command has a different
      * arity, or that it plain doesn't exist.
+     * @param origin The window in which the command was typed
      * @param command The command the user tried to execute
      * @param args The arguments passed to the command
      */
-    protected void handleInvalidCommand(String command, String... args) {
-        server.addLine("Unknown command: "+command+"/"+(args.length-1));
+    protected void handleInvalidCommand(CommandWindow origin, String command, String... args) {
+        origin.addLine("Unknown command: "+command+"/"+(args.length-1));
     }
     
     /**
      * Called when the input was a line of text that was not a command. This normally
      * means it is sent to the server/channel/user as-is, with no further processing.
+     * @param origin The window in which the command was typed
      * @param line The line input by the user
      */
-    protected void handleNonCommand(String line) {
+    protected void handleNonCommand(CommandWindow origin, String line) {
         server.getParser().sendLine(line);
     }
     

src/uk/org/ownage/dmdirc/ui/ChannelFrame.java

@@ -36,13 +36,14 @@ import javax.swing.plaf.basic.BasicInternalFrameUI;
 import javax.swing.text.BadLocationException;
 import javax.swing.text.StyledDocument;
 import uk.org.ownage.dmdirc.Channel;
+import uk.org.ownage.dmdirc.commandparser.CommandWindow;
 import uk.org.ownage.dmdirc.parser.ChannelClientInfo;
 
 /**
  *
  * @author  chris
  */
-public class ChannelFrame extends javax.swing.JInternalFrame {
+public class ChannelFrame extends javax.swing.JInternalFrame implements CommandWindow {
     
     private Channel parent;
     private NicklistListModel nicklistModel;
@@ -173,8 +174,7 @@ public class ChannelFrame extends javax.swing.JInternalFrame {
         );
         pack();
     }// </editor-fold>//GEN-END:initComponents
-    
-    
+      
     // Variables declaration - do not modify//GEN-BEGIN:variables
     private javax.swing.JList jList1;
     private javax.swing.JScrollPane jScrollPane1;

src/uk/org/ownage/dmdirc/ui/ServerFrame.java

@@ -35,13 +35,14 @@ import javax.swing.JComponent;
 import javax.swing.border.Border;
 import javax.swing.border.EmptyBorder;
 import javax.swing.plaf.basic.BasicInternalFrameUI;
+import uk.org.ownage.dmdirc.commandparser.CommandWindow;
 import uk.org.ownage.dmdirc.commandparser.ServerCommandParser;
 
 /**
  * The ServerFrame is the MDI window that shows server messages to the user
  * @author chris
  */
-public class ServerFrame extends javax.swing.JInternalFrame {
+public class ServerFrame extends javax.swing.JInternalFrame implements CommandWindow {
     
     /**
      * The Server object that owns this frame
@@ -84,7 +85,7 @@ public class ServerFrame extends javax.swing.JInternalFrame {
         
         jTextField1.addActionListener(new ActionListener() {
             public void actionPerformed(ActionEvent actionEvent) {
-                ServerFrame.this.commandParser.parseCommand(jTextField1.getText());
+                ServerFrame.this.commandParser.parseCommand(ServerFrame.this, jTextField1.getText());
                 jTextField1.setText("");
             }
         });