Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/core3/src/core/CommandExecutor.h @ 1780

Last change on this file since 1780 was 1505, checked in by rgrieder, 16 years ago

f* svn: It doesn't even inform you if you attempt to set a non existing property. It is svn:eol-style and not eol-style when using the command by the way…

  • Property svn:eol-style set to native
File size: 5.5 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
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
32#include "CorePrereqs.h"
33
34#include <map>
35
36#include "CommandEvaluation.h"
37
38namespace orxonox
39{
40    class _CoreExport CommandExecutor
41    {
42        public:
43            static bool execute(const std::string& command, bool useTcl = true);
44            static std::string complete(const std::string& command);
45            static std::string hint(const std::string& command);
46
47            static CommandEvaluation evaluate(const std::string& command);
48            static const CommandEvaluation& getLastEvaluation();
49
50            static ConsoleCommand& addConsoleCommandShortcut(ConsoleCommand* command);
51            static ConsoleCommand* getConsoleCommandShortcut(const std::string& name);
52            static ConsoleCommand* getLowercaseConsoleCommandShortcut(const std::string& name);
53
54            /** @brief Returns the map that stores all console commands. @return The const_iterator */
55            static inline const std::map<std::string, ConsoleCommand*>& getConsoleCommandShortcutMap() { return CommandExecutor::getInstance().consoleCommandShortcuts_; }
56            /** @brief Returns a const_iterator to the beginning of the map that stores all console commands. @return The const_iterator */
57            static inline std::map<std::string, ConsoleCommand*>::const_iterator getConsoleCommandShortcutMapBegin() { return CommandExecutor::getInstance().consoleCommandShortcuts_.begin(); }
58            /** @brief Returns a const_iterator to the end of the map that stores all console commands. @return The const_iterator */
59            static inline std::map<std::string, ConsoleCommand*>::const_iterator getConsoleCommandShortcutMapEnd() { return CommandExecutor::getInstance().consoleCommandShortcuts_.end(); }
60
61            /** @brief Returns the map that stores all console commands with their names in lowercase. @return The const_iterator */
62            static inline const std::map<std::string, ConsoleCommand*>& getLowercaseConsoleCommandShortcutMap() { return CommandExecutor::getInstance().consoleCommandShortcuts_LC_; }
63            /** @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 */
64            static inline std::map<std::string, ConsoleCommand*>::const_iterator getLowercaseConsoleCommandShortcutMapBegin() { return CommandExecutor::getInstance().consoleCommandShortcuts_LC_.begin(); }
65            /** @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 */
66            static inline std::map<std::string, ConsoleCommand*>::const_iterator getLowercaseConsoleCommandShortcutMapEnd() { return CommandExecutor::getInstance().consoleCommandShortcuts_LC_.end(); }
67
68        private:
69            CommandExecutor() {}
70            CommandExecutor(const CommandExecutor& other);
71            ~CommandExecutor() {}
72
73            static CommandExecutor& getInstance();
74            static CommandEvaluation& getEvaluation();
75
76            static void parseIfNeeded(const std::string& command);
77            static void parse(const std::string& command, bool bInitialize = true);
78
79            static unsigned int argumentsFinished();
80            static unsigned int argumentsGiven();
81            static bool enoughArgumentsGiven(ConsoleCommand* command);
82            static std::string getArgument(unsigned int index);
83            static std::string getLastArgument();
84
85            static void createListOfPossibleIdentifiers(const std::string& fragment);
86            static void createListOfPossibleFunctions(const std::string& fragment, Identifier* identifier = 0);
87            static void createListOfPossibleArguments(const std::string& fragment, ConsoleCommand* command, unsigned int param);
88
89            static Identifier* getPossibleIdentifier(const std::string& name);
90            static ConsoleCommand* getPossibleCommand(const std::string& name, Identifier* identifier = 0);
91            static std::string getPossibleArgument(const std::string& name, ConsoleCommand* command, unsigned int param);
92
93            static void createArgumentCompletionList(ConsoleCommand* command, unsigned int param);
94            static std::string getCommonBegin(const std::list<std::pair<const std::string*, const std::string*> >& list);
95            static std::string getCommonBegin(const ArgumentCompletionList& list);
96
97            CommandEvaluation evaluation_;
98            std::map<std::string, ConsoleCommand*> consoleCommandShortcuts_;
99            std::map<std::string, ConsoleCommand*> consoleCommandShortcuts_LC_;
100    };
101}
102
103#endif /* _CommandExecutor_H__ */
Note: See TracBrowser for help on using the repository browser.