[947] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
[1056] | 3 | * > www.orxonox.net < |
---|
[947] | 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
| 29 | #ifndef _CommandExecutor_H__ |
---|
| 30 | #define _CommandExecutor_H__ |
---|
| 31 | |
---|
[1062] | 32 | #include "CorePrereqs.h" |
---|
| 33 | |
---|
[947] | 34 | #include <map> |
---|
| 35 | |
---|
[1341] | 36 | #include "CommandEvaluation.h" |
---|
[947] | 37 | |
---|
[972] | 38 | #define COMMAND_EXECUTOR_CURSOR "$" |
---|
[947] | 39 | |
---|
| 40 | namespace orxonox |
---|
| 41 | { |
---|
[952] | 42 | class _CoreExport CommandExecutor |
---|
| 43 | { |
---|
| 44 | public: |
---|
[1198] | 45 | static bool execute(const std::string& command, bool useTcl = true); |
---|
[947] | 46 | static std::string complete(const std::string& command); |
---|
| 47 | static std::string hint(const std::string& command); |
---|
| 48 | |
---|
[953] | 49 | static CommandEvaluation evaluate(const std::string& command); |
---|
[1194] | 50 | static const CommandEvaluation& getLastEvaluation(); |
---|
| 51 | |
---|
[1341] | 52 | static ConsoleCommand& addConsoleCommandShortcut(ConsoleCommand* command); |
---|
| 53 | static ConsoleCommand* getConsoleCommandShortcut(const std::string& name); |
---|
| 54 | static ConsoleCommand* getLowercaseConsoleCommandShortcut(const std::string& name); |
---|
[947] | 55 | |
---|
| 56 | /** @brief Returns the map that stores all console commands. @return The const_iterator */ |
---|
[1341] | 57 | static inline const std::map<std::string, ConsoleCommand*>& getConsoleCommandShortcutMap() { return CommandExecutor::getInstance().consoleCommandShortcuts_; } |
---|
[947] | 58 | /** @brief Returns a const_iterator to the beginning of the map that stores all console commands. @return The const_iterator */ |
---|
[1341] | 59 | static inline std::map<std::string, ConsoleCommand*>::const_iterator getConsoleCommandShortcutMapBegin() { return CommandExecutor::getInstance().consoleCommandShortcuts_.begin(); } |
---|
[947] | 60 | /** @brief Returns a const_iterator to the end of the map that stores all console commands. @return The const_iterator */ |
---|
[1341] | 61 | static inline std::map<std::string, ConsoleCommand*>::const_iterator getConsoleCommandShortcutMapEnd() { return CommandExecutor::getInstance().consoleCommandShortcuts_.end(); } |
---|
[947] | 62 | |
---|
| 63 | /** @brief Returns the map that stores all console commands with their names in lowercase. @return The const_iterator */ |
---|
[1341] | 64 | static inline const std::map<std::string, ConsoleCommand*>& getLowercaseConsoleCommandShortcutMap() { return CommandExecutor::getInstance().consoleCommandShortcuts_LC_; } |
---|
[947] | 65 | /** @brief Returns a const_iterator to the beginning of the map that stores all console commands with their names in lowercase. @return The const_iterator */ |
---|
[1341] | 66 | static inline std::map<std::string, ConsoleCommand*>::const_iterator getLowercaseConsoleCommandShortcutMapBegin() { return CommandExecutor::getInstance().consoleCommandShortcuts_LC_.begin(); } |
---|
[947] | 67 | /** @brief Returns a const_iterator to the end of the map that stores all console commands with their names in lowercase. @return The const_iterator */ |
---|
[1341] | 68 | static inline std::map<std::string, ConsoleCommand*>::const_iterator getLowercaseConsoleCommandShortcutMapEnd() { return CommandExecutor::getInstance().consoleCommandShortcuts_LC_.end(); } |
---|
[947] | 69 | |
---|
| 70 | private: |
---|
[950] | 71 | CommandExecutor() {} |
---|
[1064] | 72 | CommandExecutor(const CommandExecutor& other); |
---|
[950] | 73 | ~CommandExecutor() {} |
---|
| 74 | |
---|
[949] | 75 | static CommandExecutor& getInstance(); |
---|
[952] | 76 | static CommandEvaluation& getEvaluation(); |
---|
[949] | 77 | |
---|
[1402] | 78 | static void parseIfNeeded(const std::string& command); |
---|
[947] | 79 | static void parse(const std::string& command, bool bInitialize = true); |
---|
| 80 | |
---|
[1351] | 81 | static unsigned int argumentsFinished(); |
---|
[947] | 82 | static unsigned int argumentsGiven(); |
---|
[1390] | 83 | static bool enoughArgumentsGiven(ConsoleCommand* command); |
---|
| 84 | static std::string getArgument(unsigned int index); |
---|
| 85 | static std::string getLastArgument(); |
---|
[947] | 86 | |
---|
[1390] | 87 | static void createListOfPossibleIdentifiers(const std::string& fragment); |
---|
[1351] | 88 | static void createListOfPossibleFunctions(const std::string& fragment, Identifier* identifier = 0); |
---|
[1390] | 89 | static void createListOfPossibleArguments(const std::string& fragment, ConsoleCommand* command, unsigned int param); |
---|
[947] | 90 | |
---|
[1351] | 91 | static Identifier* getPossibleIdentifier(const std::string& name); |
---|
| 92 | static ConsoleCommand* getPossibleCommand(const std::string& name, Identifier* identifier = 0); |
---|
[1390] | 93 | static const std::string* getPossibleArgument(const std::string& name, ConsoleCommand* command, unsigned int param); |
---|
[1351] | 94 | |
---|
[972] | 95 | static bool compareStringsInList(const std::pair<const std::string*, const std::string*>& first, const std::pair<const std::string*, const std::string*>& second); |
---|
[947] | 96 | |
---|
| 97 | |
---|
[952] | 98 | CommandEvaluation evaluation_; |
---|
[1341] | 99 | std::map<std::string, ConsoleCommand*> consoleCommandShortcuts_; |
---|
| 100 | std::map<std::string, ConsoleCommand*> consoleCommandShortcuts_LC_; |
---|
[947] | 101 | }; |
---|
| 102 | } |
---|
| 103 | |
---|
| 104 | #endif /* _CommandExecutor_H__ */ |
---|