Major changes to the command parser framework

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

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

@@ -22,21 +22,19 @@
 
 package uk.org.ownage.dmdirc.commandparser;
 
-import uk.org.ownage.dmdirc.parser.ChannelInfo;
+import uk.org.ownage.dmdirc.Channel;
+import uk.org.ownage.dmdirc.Server;
 
 /**
  *
  * @author chris
  */
 public abstract class ChannelCommand extends Command {
-    
-    protected ChannelInfo channel;
-    
+       
     /** Creates a new instance of ChannelCommand */
-    public ChannelCommand(ChannelInfo channel) {
+    public ChannelCommand() {
         super();
-        
-        this.channel = channel;
     }
-        
-}
+    
+    public abstract void Execute(Server server, Channel channel, String... args);    
+}

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

@@ -22,16 +22,40 @@
 
 package uk.org.ownage.dmdirc.commandparser;
 
+import uk.org.ownage.dmdirc.Channel;
+import uk.org.ownage.dmdirc.Server;
+
 /**
  *
  * @author chris
  */
-public class ChannelCommandParser extends ServerCommandParser {
+public class ChannelCommandParser extends CommandParser {
+    
+    private Server server;
+    private Channel channel;
     
     /** Creates a new instance of ChannelCommandParser */
-    public ChannelCommandParser() {
+    public ChannelCommandParser(Server server, Channel channel) {
+        super();
+        
+        this.server = server;
+        this.channel = channel;
     }
 
-    
+    protected void LoadCommands() {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
+
+    protected void executeCommand(Command command, String... args) {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
+
+    protected void handleInvalidCommand(String command, String... args) {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
+
+    protected void handleNonCommand(String line) {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
     
 }

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

@@ -22,17 +22,23 @@
 
 package uk.org.ownage.dmdirc.commandparser;
 
+import uk.org.ownage.dmdirc.Server;
+
 /**
  *
  * @author chris
  */
 public abstract class Command {
     
+    protected static Command instance;
+    
     protected String name;
     protected int arity = 0;
     protected boolean polyadic;
+    protected boolean show = true;
+    protected String arguments = "<unknown>";
+    protected String description = "unknown";
     
-    /** Creates a new instance of Command */
     public Command() {
     }
     
@@ -44,6 +50,16 @@ public abstract class Command {
         }
     }
     
-    public abstract void Execute(String... args);
+    public boolean showInHelp() {
+        return show;
+    }
+    
+    public String getHelp() {
+        return name+" "+arguments+" - "+description;
+    }
+    
+    public static Command getInstance() {
+        return instance;
+    }
     
 }

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

@@ -0,0 +1,39 @@
+/*
+ * 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 class CommandManager {
+           
+    public static void loadChannelCommands(CommandParser parser) {
+        throw new UnsupportedOperationException("Not implemented yet");        
+    }
+    
+    public static void loadServerCommands(CommandParser parser) {
+        throw new UnsupportedOperationException("Not implemented yet");        
+    }    
+    
+}

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

@@ -23,6 +23,7 @@
 package uk.org.ownage.dmdirc.commandparser;
 
 import java.util.Hashtable;
+import uk.org.ownage.dmdirc.Config;
 
 /**
  *
@@ -46,23 +47,33 @@ abstract public class CommandParser {
     
     /** Parses the specified string as a command */
     public void parseCommand(String line) {
-        String[] args = line.split(" ");
-        
-        assert(args.length > 0);
-        
-        String command = args[0];
-        String signature = command+"/"+(args.length-1);
-        
-        // Check the specific signature first, so that polyadic commands can
-        // 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)) {
+        if (line.charAt(0) == Config.getOption("general","commandchar").charAt(0)) {
+            String[] args = line.split(" ");
             
-        } else if (commands.containsKey(command)) {
+            assert(args.length > 0);
             
-        } else {
+            String command = args[0];
+            
+            String signature = command+"/"+(args.length-1);
             
+            // Check the specific signature first, so that polyadic commands can
+            // 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);
+            } else if (commands.containsKey(command)) {
+                executeCommand(commands.get(command), args);
+            } else {
+                handleInvalidCommand(command, args);
+            }
+        } else {
+            handleNonCommand(line);
         }
     }
     
+    abstract protected void executeCommand(Command command, String... args);
+    
+    abstract protected void handleInvalidCommand(String command, String... args);
+
+    abstract protected void handleNonCommand(String line);
 }

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

@@ -0,0 +1,40 @@
+/*
+ * 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;
+
+import uk.org.ownage.dmdirc.Channel;
+import uk.org.ownage.dmdirc.Server;
+
+/**
+ *
+ * @author chris
+ */
+public abstract class ServerCommand extends Command {
+       
+    /** Creates a new instance of ChannelCommand */
+    public ServerCommand() {
+        super();
+    }
+    
+    public abstract void Execute(Server server, String... args);
+}

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

@@ -22,17 +22,37 @@
 
 package uk.org.ownage.dmdirc.commandparser;
 
+import uk.org.ownage.dmdirc.Server;
+
 /**
  *
  * @author chris
  */
 public class ServerCommandParser extends CommandParser {
     
+    private Server server;
+    
     /** Creates a new instance of ServerCommandParser */
-    public ServerCommandParser() {
+    public ServerCommandParser(Server server) {
+        super();
+        
+        this.server = server;
     }
 
     protected void LoadCommands() {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
+
+    protected void executeCommand(Command command, String... args) {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
+
+    protected void handleInvalidCommand(String command, String... args) {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
+
+    protected void handleNonCommand(String line) {
+        throw new UnsupportedOperationException("Not implemented yet");
     }
     
 }

src/uk/org/ownage/dmdirc/commandparser/commands/Test.java

@@ -0,0 +1,51 @@
+/*
+ * 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;
+
+import uk.org.ownage.dmdirc.Server;
+import uk.org.ownage.dmdirc.commandparser.Command;
+import uk.org.ownage.dmdirc.commandparser.ServerCommand;
+
+/**
+ *
+ * @author chris
+ */
+public class Test extends ServerCommand {
+    
+    protected static Command instance = new Test();
+    
+    /** Creates a new instance of Test */
+    public Test() {
+        description = "a test command";
+        arguments = "";
+        polyadic = false;
+        arity = 0;            
+        name = "test";        
+        show = true;
+    }
+
+    public void Execute(Server server, String... args) {
+        throw new UnsupportedOperationException("Not implemented yet");
+    }
+    
+}