Moved command logic into static Command methods

ChangeLog.md

@@ -2,6 +2,9 @@
 
 ## OpenRaider (0.1.3) xythobuz <xythobuz@xythobuz.de>
 
+    [ 20140831 ]
+    * Moved command specific code from OpenRaider to static Command methods
+
     [ 20140829 ]
     * Moved key/action/string comparison functions into CommandBind
     * Added Renderflag command to toggle all flags in Render

TODO.md

@@ -8,6 +8,9 @@
 * Mesh has 2 different approaches of storing the same data (eg. mColors and mColorArray), but half of ‘em isn’t implemented. Unify this, probably even combining Mesh and StaticMesh...
 * Don’t use float everywhere just because (eg. float colors)
 * Add verbose command line flag for debug output also in release builds
+* Don’t depend on setup: no data or config files should be necessary
+* Be able to change configuration from within OpenRaider
+* Put log functionality outside of Console
 
 ## Bugs
 
@@ -21,9 +24,14 @@
 
 ## Future Features
 
+* Depend on physfs for easier file location management
 * Depend on libcdio, use it to read original CDs or CUE/TOC/ISO images
 * Depend on imgui for nicer GUIs?
 * Add ability to play the FMVs. Format? VLC can play them!
 * Cut TGA image reader, currently only used for menu background?!
     * Need useful, always available image writer alternative for screenshots then
 
+* Create abstract interface from Game/Menu/Console, use this to do real “windows” that can be layered independently and can receive keyboard/mouse input
+* Put keyboard/mouse/windowing logic into UI or UIManager class
+* Move small rest of OpenRaider into main or a config class or something, remove OpenRaider class
+

include/OpenRaider.h

@@ -8,11 +8,7 @@
 #ifndef _OPENRAIDER_H_
 #define _OPENRAIDER_H_
 
-#include <memory>
 #include <string>
-#include <vector>
-
-#include "commands/Command.h"
 
 /*!
  * \brief Main Game Singleton
@@ -57,9 +53,6 @@ public:
     KeyboardButton keyBindings[ActionEventCount];
     bool mRunning;
     bool mFPS;
-
-private:
-    std::vector<std::shared_ptr<Command>> commands;
 };
 
 OpenRaider &getOpenRaider();

include/commands/Command.h

@@ -20,24 +20,13 @@ public:
     virtual std::string brief() = 0;
     virtual void printHelp();
     virtual int execute(std::istream& args) = 0;
-};
 
-#define DECLARE_SIMPLE_CMD(x) \
-    class x : public Command { \
-    public: \
-        virtual std::string name(); \
-        virtual std::string brief(); \
-        virtual void printHelp(); \
-        virtual int execute(std::istream& args); \
-    }
+    static void fillCommandList();
+    static int command(std::string c);
 
-#define DECLARE_SIMPLE_CMD_NO_HELP(x) \
-    class x : public Command { \
-    public: \
-        virtual std::string name(); \
-        virtual std::string brief(); \
-        virtual int execute(std::istream& args); \
-    }
+private:
+    static std::vector<std::shared_ptr<Command>> commands;
+};
 
 #endif
 

include/commands/CommandAnimate.h

@@ -10,7 +10,13 @@
 
 #include "commands/Command.h"
 
-DECLARE_SIMPLE_CMD(CommandAnimate);
+class CommandAnimate : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual void printHelp();
+    virtual int execute(std::istream& args);
+};
 
 #endif
 

include/commands/CommandEngine.h

@@ -10,11 +10,28 @@
 
 #include "commands/Command.h"
 
-DECLARE_SIMPLE_CMD(CommandLoad);
+class CommandLoad : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual void printHelp();
+    virtual int execute(std::istream& args);
+};
 
-DECLARE_SIMPLE_CMD(CommandScreenshot);
+class CommandScreenshot : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual void printHelp();
+    virtual int execute(std::istream& args);
+};
 
-DECLARE_SIMPLE_CMD_NO_HELP(CommandQuit);
+class CommandQuit : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual int execute(std::istream& args);
+};
 
 #endif
 

include/commands/CommandGame.h

@@ -10,13 +10,33 @@
 
 #include "commands/Command.h"
 
-DECLARE_SIMPLE_CMD_NO_HELP(CommandPos);
-
-DECLARE_SIMPLE_CMD_NO_HELP(CommandViewmodel);
-
-DECLARE_SIMPLE_CMD_NO_HELP(CommandPigtail);
-
-DECLARE_SIMPLE_CMD_NO_HELP(CommandPonypos);
+class CommandPos : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual int execute(std::istream& args);
+};
+
+class CommandViewmodel : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual int execute(std::istream& args);
+};
+
+class CommandPigtail : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual int execute(std::istream& args);
+};
+
+class CommandPonypos : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual int execute(std::istream& args);
+};
 
 #endif
 

include/commands/CommandMove.h

@@ -10,7 +10,13 @@
 
 #include "commands/Command.h"
 
-DECLARE_SIMPLE_CMD(CommandMove);
+class CommandMove : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual void printHelp();
+    virtual int execute(std::istream& args);
+};
 
 #endif
 

include/commands/CommandRender.h

@@ -10,7 +10,13 @@
 
 #include "commands/Command.h"
 
-DECLARE_SIMPLE_CMD(CommandMode);
+class CommandMode : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual void printHelp();
+    virtual int execute(std::istream& args);
+};
 
 class CommandRenderflag : public Command {
 public:

include/commands/CommandSet.h

@@ -10,7 +10,13 @@
 
 #include "commands/Command.h"
 
-DECLARE_SIMPLE_CMD(CommandSet);
+class CommandSet : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual void printHelp();
+    virtual int execute(std::istream& args);
+};
 
 #endif
 

include/commands/CommandSound.h

@@ -10,7 +10,13 @@
 
 #include "commands/Command.h"
 
-DECLARE_SIMPLE_CMD(CommandSound);
+class CommandSound : public Command {
+public:
+    virtual std::string name();
+    virtual std::string brief();
+    virtual void printHelp();
+    virtual int execute(std::istream& args);
+};
 
 #endif
 

src/OpenRaider.cpp

@@ -5,21 +5,11 @@
  * \author xythobuz
  */
 
-#include <cstdio>
-#include <cstring>
 #include <fstream>
-#include <iomanip>
 #include <sstream>
 
 #include "global.h"
-#include "commands/CommandAnimate.h"
-#include "commands/CommandBind.h"
-#include "commands/CommandEngine.h"
-#include "commands/CommandGame.h"
-#include "commands/CommandMove.h"
-#include "commands/CommandRender.h"
-#include "commands/CommandSet.h"
-#include "commands/CommandSound.h"
+#include "commands/Command.h"
 #include "Console.h"
 #include "Font.h"
 #include "Game.h"
@@ -44,20 +34,7 @@ OpenRaider::OpenRaider() {
     for (int i = 0; i < ActionEventCount; i++)
         keyBindings[i] = unknownKey;
 
-    commands.push_back(std::shared_ptr<Command>(new CommandLoad()));
-    commands.push_back(std::shared_ptr<Command>(new CommandBind()));
-    commands.push_back(std::shared_ptr<Command>(new CommandSet()));
-    commands.push_back(std::shared_ptr<Command>(new CommandScreenshot()));
-    commands.push_back(std::shared_ptr<Command>(new CommandAnimate()));
-    commands.push_back(std::shared_ptr<Command>(new CommandMove()));
-    commands.push_back(std::shared_ptr<Command>(new CommandMode()));
-    commands.push_back(std::shared_ptr<Command>(new CommandRenderflag()));
-    commands.push_back(std::shared_ptr<Command>(new CommandSound()));
-    commands.push_back(std::shared_ptr<Command>(new CommandPos()));
-    commands.push_back(std::shared_ptr<Command>(new CommandViewmodel()));
-    commands.push_back(std::shared_ptr<Command>(new CommandPigtail()));
-    commands.push_back(std::shared_ptr<Command>(new CommandPonypos()));
-    commands.push_back(std::shared_ptr<Command>(new CommandQuit()));
+    Command::fillCommandList();
 }
 
 OpenRaider::~OpenRaider() {
@@ -102,64 +79,7 @@ int OpenRaider::loadConfig(const char *config) {
 }
 
 int OpenRaider::command(std::string c) {
-    // Remove comment, if any
-    size_t comment = c.find_first_of('#');
-    if (comment != std::string::npos)
-        c.erase(comment);
-
-    // Execute command
-    std::stringstream command(c);
-    std::string cmd;
-    command >> cmd;
-    command >> std::boolalpha >> std::ws;
-
-    if (cmd.length() == 0)
-        return 0;
-
-    // Print help
-    if (cmd.compare("help") == 0) {
-        std::string arg;
-        command >> arg;
-        if (arg.length() == 0) {
-            // List all available commands
-            getConsole() << "Available commands:" << Console::endl;
-            getConsole() << std::right << std::setw(11);
-            getConsole() << "help" << " - print command help" << Console::endl;
-            for (auto &x : commands) {
-                if (x) {
-                    getConsole() << std::right << std::setw(11);
-                    getConsole() << x->name() << " - " << x->brief() << Console::endl;
-                }
-            }
-            getConsole() << "Use help COMMAND to get additional info" << Console::endl;
-            getConsole() << "Pass BOOLs as true or false" << Console::endl;
-            return 0;
-        } else {
-            // Show help for a specific command
-            for (auto &x : commands) {
-                if (x) {
-                    if (x->name().compare(arg) == 0) {
-                        x->printHelp();
-                        return 0;
-                    }
-                }
-            }
-            getConsole() << "Unknown command: \"" << arg << "\"" << Console::endl;
-            return -1;
-        }
-    }
-
-    // Execute command
-    for (auto &x : commands) {
-        if (x) {
-            if (x->name().compare(cmd) == 0) {
-                return x->execute(command);
-            }
-        }
-    }
-
-    getConsole() << "Unknown command: \"" << cmd << "\"" << Console::endl;
-    return -1;
+    return Command::command(c);
 }
 
 int OpenRaider::initialize() {

src/commands/Command.cpp

@@ -5,15 +5,107 @@
  * \author xythobuz
  */
 
+#include <iomanip>
+
 #include "global.h"
 #include "Console.h"
 #include "commands/Command.h"
+#include "commands/CommandAnimate.h"
+#include "commands/CommandBind.h"
+#include "commands/CommandEngine.h"
+#include "commands/CommandGame.h"
+#include "commands/CommandMove.h"
+#include "commands/CommandRender.h"
+#include "commands/CommandSet.h"
+#include "commands/CommandSound.h"
 
-Command::~Command() {
+std::vector<std::shared_ptr<Command>> Command::commands;
 
+Command::~Command() {
 }
 
 void Command::printHelp() {
     getConsole() << "No help available!" << Console::endl;
 }
 
+void Command::fillCommandList() {
+    commands.clear();
+    commands.push_back(std::shared_ptr<Command>(new CommandLoad()));
+    commands.push_back(std::shared_ptr<Command>(new CommandBind()));
+    commands.push_back(std::shared_ptr<Command>(new CommandSet()));
+    commands.push_back(std::shared_ptr<Command>(new CommandScreenshot()));
+    commands.push_back(std::shared_ptr<Command>(new CommandAnimate()));
+    commands.push_back(std::shared_ptr<Command>(new CommandMove()));
+    commands.push_back(std::shared_ptr<Command>(new CommandMode()));
+    commands.push_back(std::shared_ptr<Command>(new CommandRenderflag()));
+    commands.push_back(std::shared_ptr<Command>(new CommandSound()));
+    commands.push_back(std::shared_ptr<Command>(new CommandPos()));
+    commands.push_back(std::shared_ptr<Command>(new CommandViewmodel()));
+    commands.push_back(std::shared_ptr<Command>(new CommandPigtail()));
+    commands.push_back(std::shared_ptr<Command>(new CommandPonypos()));
+    commands.push_back(std::shared_ptr<Command>(new CommandQuit()));
+}
+
+int Command::command(std::string c) {
+    assert(commands.size() > 0);
+
+    // Remove comment, if any
+    size_t comment = c.find_first_of('#');
+    if (comment != std::string::npos)
+        c.erase(comment);
+
+    // Execute command
+    std::stringstream command(c);
+    std::string cmd;
+    command >> cmd;
+    command >> std::boolalpha >> std::ws;
+
+    if (cmd.length() == 0)
+        return 0;
+
+    // Print help
+    if (cmd.compare("help") == 0) {
+        std::string arg;
+        command >> arg;
+        if (arg.length() == 0) {
+            // List all available commands
+            getConsole() << "Available commands:" << Console::endl;
+            getConsole() << std::right << std::setw(11);
+            getConsole() << "help" << " - print command help" << Console::endl;
+            for (auto &x : commands) {
+                if (x) {
+                    getConsole() << std::right << std::setw(11);
+                    getConsole() << x->name() << " - " << x->brief() << Console::endl;
+                }
+            }
+            getConsole() << "Use help COMMAND to get additional info" << Console::endl;
+            getConsole() << "Pass BOOLs as true or false" << Console::endl;
+            return 0;
+        } else {
+            // Show help for a specific command
+            for (auto &x : commands) {
+                if (x) {
+                    if (x->name().compare(arg) == 0) {
+                        x->printHelp();
+                        return 0;
+                    }
+                }
+            }
+            getConsole() << "Unknown command: \"" << arg << "\"" << Console::endl;
+            return -1;
+        }
+    }
+
+    // Execute command
+    for (auto &x : commands) {
+        if (x) {
+            if (x->name().compare(cmd) == 0) {
+                return x->execute(command);
+            }
+        }
+    }
+
+    getConsole() << "Unknown command: \"" << cmd << "\"" << Console::endl;
+    return -1;
+}
+

src/commands/CommandBind.cpp

@@ -44,13 +44,13 @@ int CommandBind::execute(std::istream& args) {
         getConsole() << "Invalid use of bind-command" << Console::endl;
         return -1;
     } else {
-        ActionEvents e = stringToActionEvent(a.c_str());
+        ActionEvents e = stringToActionEvent(a);
         if (e == ActionEventCount) {
             getConsole() << "bind-Error: Unknown action (" << a << ")" << Console::endl;
             return -2;
         }
 
-        KeyboardButton c = stringToKeyboardButton(b.c_str());
+        KeyboardButton c = stringToKeyboardButton(b);
         if (c == unknownKey) {
             getConsole() << "bind-Error: Unknown key (" << b << ")" << Console::endl;
             return -3;