Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/core/CommandExecutor.h @ 2809

Last change on this file since 2809 was 2710, checked in by rgrieder, 16 years ago

Merged buildsystem3 containing buildsystem2 containing Adi's buildsystem branch back to the trunk.
Please update the media directory if you were not using buildsystem3 before.

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