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 | /** |
---|
30 | @defgroup ConsoleCommand Console commands |
---|
31 | @ingroup Command |
---|
32 | */ |
---|
33 | |
---|
34 | #ifndef _ConsoleCommandManager_H__ |
---|
35 | #define _ConsoleCommandManager_H__ |
---|
36 | |
---|
37 | #include "core/CorePrereqs.h" |
---|
38 | |
---|
39 | namespace orxonox |
---|
40 | { |
---|
41 | /** |
---|
42 | * A static class that stores all existing ConsoleCommands. |
---|
43 | */ |
---|
44 | class _CoreExport ConsoleCommandManager |
---|
45 | { |
---|
46 | public: |
---|
47 | static void registerCommand(ConsoleCommand* command); |
---|
48 | static void registerCommand(const std::string& group, const std::string& name, ConsoleCommand* command); |
---|
49 | static void unregisterCommand(ConsoleCommand* command); |
---|
50 | |
---|
51 | /// Returns the map with all groups and commands. |
---|
52 | static inline const std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommands() |
---|
53 | { return ConsoleCommandManager::getCommandMap(); } |
---|
54 | /// Returns the map with all groups and commands in lowercase. |
---|
55 | static inline const std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommandsLC() |
---|
56 | { return ConsoleCommandManager::getCommandMapLC(); } |
---|
57 | |
---|
58 | /// Returns a command (shortcut) with given name. @param name The name of the command shortcut @param bPrintError If true, an error is printed if the command doesn't exist |
---|
59 | static inline ConsoleCommand* getCommand(const std::string& name, bool bPrintError = false) |
---|
60 | { return ConsoleCommandManager::getCommand("", name, bPrintError); } |
---|
61 | /// Returns a command (shortcut) with given name in lowercase. @param name The lowercase name of the command shortcut @param bPrintError If true, an error is printed if the command doesn't exist |
---|
62 | static inline ConsoleCommand* getCommandLC(const std::string& name, bool bPrintError = false) |
---|
63 | { return ConsoleCommandManager::getCommandLC("", name, bPrintError); } |
---|
64 | |
---|
65 | static ConsoleCommand* getCommand(const std::string& group, const std::string& name, bool bPrintError = false); |
---|
66 | static ConsoleCommand* getCommandLC(const std::string& group, const std::string& name, bool bPrintError = false); |
---|
67 | |
---|
68 | static void destroyAll(); |
---|
69 | |
---|
70 | private: |
---|
71 | static std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommandMap(); |
---|
72 | static std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommandMapLC(); |
---|
73 | }; |
---|
74 | } |
---|
75 | |
---|
76 | #endif /* _ConsoleCommandManager_H__ */ |
---|