Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/keckslevelHS14/src/libraries/core/command/ConsoleCommand.h @ 10139

Last change on this file since 10139 was 9983, checked in by landauf, 11 years ago

detail

  • Property svn:eol-style set to native
File size: 39.4 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/**
30    @defgroup ConsoleCommand Console commands
31    @ingroup Command
32*/
33
34/**
35    @file
36    @ingroup Command ConsoleCommand
37    @brief Declaration of the orxonox::ConsoleCommand class and the SetConsoleCommand() macro.
38
39    @anchor ConsoleCommandExample
40
41    Console commands can be used to write scripts, use key-bindings or simply to be
42    entered into the shell by the user. Instances of orxonox::ConsoleCommand define
43    the function of a command, and also more information like, for example, if it is
44    active, default values, and possible arguments.
45
46    Commands need to be registered to the system statically on startup by using the
47    SetConsoleCommand() or DeclareConsoleCommand() macros outside of a function.
48    This ensures that commands are known to the system at any time, so they can be
49    evaluated (see orxonox::CommandExecutor::evaluate()), for example for key-bindings.
50
51    Example:
52    @code
53    void myCoutFunction(const std::string& text)        // Define a static function
54    {
55        orxout() << "Text: " << text << endl;           // Print the text to the console
56    }
57
58    SetConsoleCommand("cout", &myCoutFunction);         // Register the function as command with name "cout"
59    @endcode
60
61    Now you can open the shell and execute the command:
62    @code
63    $ cout Hello World
64    @endcode
65
66    Internally this command is now passed to orxonox::CommandExecutor::execute():
67    @code
68    CommandExecutor::execute("cout HelloWorld");
69    @endcode
70
71    CommandExecutor searches for a command with name "cout" and passes the arguments
72    "Hello World" to it. Because we registered myCoutFunction() with this command,
73    as a result the following text will be printed to the console:
74    @code
75    Text: Hello World
76    @endcode
77
78    You can add more attributes to the ConsoleCommand, by using the command-chain feature
79    of SetConsoleCommand(). For example like this:
80    @code
81    SetConsoleCommand("cout", &myCoutFunction)
82        .addGroup("output", "text")
83        .accessLevel(AccessLevel::Offline)
84        .defaultValues("no text");
85    @endcode
86
87    Open the shell again and try it:
88    @code
89    $ cout Hello World
90    Text: Hello World
91    $ output text Hello World
92    Text: Hello World
93    $ cout
94    Text: no text
95    @endcode
96
97    If you execute it online (note: the access level is "Offline"), you will see the
98    following (or something similar):
99    @code
100    $ cout Hello World
101    Error: Can't execute command "cout", access denied.
102    @endcode
103
104    If a command is executed, the arguments are passed to an underlying function,
105    whitch is wrapped by an orxonox::Functor which again is wrapped by an orxonox::Executor.
106    The Functor contains the function-pointer, as well as the object-pointer in
107    case of a non-static member-function. The executor stores possible default-values
108    for each argument of the function.
109
110    The function of a command can be changed at any time. It's possible to just exchange
111    the function-pointer of the underlying Functor if the headers of the functions are
112    exactly the same. But you can also exchange the Functor itself or even completely
113    replace the Executor. Also the other attributes of a ConsoleCommand can be modified
114    during the game, for example it can be activated or deactivated.
115
116    To do so, the function ModifyConsoleCommand() has to be used. It returns an instance
117    of orxonox::ConsoleCommand::ConsoleCommandManipulator which has an interface similar to
118    orxonox::ConsoleCommand, but with slight differences. You can use it the same way like
119    SetConsoleCommand(), meaning you can use command-chains to change different attributes at
120    the same time. ModifyConsoleCommand() must not be executed statically, but rather in a
121    function at some point of the execution of the program.
122
123    Example:
124    @code
125    void myOtherCoutFunction(const std::string& text)                       // Define a new static function
126    {
127        orxout() << "Uppercase: " << getUppercase(text) << endl;            // Print the text in uppercase to the console
128    }
129
130    {
131        // ...                                                              // somewhere in the code
132
133        ModifyConsoleCommand("cout").setFunction(&myOtherCoutFunction);     // Modify the underlying function of the command
134
135        // ...
136    }
137    @endcode
138
139    If you now enter the command into the shell, you'll see a different behavior:
140    @code
141    $ cout Hello World
142    Uppercase: HELLO WORLD
143    $ cout
144    Uppercase: NO TEXT
145    @endcode
146
147    A few important notes about changing functions:
148
149    Instead of changing the function with setFunction(), you can also create a command-stack
150    by using pushFunction() and popFunction(). It's important to note a few things about that,
151    because the underlying structure of Executor and Functor has a few pitfalls:
152     - If you push a new function-pointer, the same executor as before will be used (and, if
153       the headers match, even the same functor can be used, which is very fast)
154     - If you push a new Functor, the same executor as before will be used
155     - If you push a new Executor, everything is changed
156
157    Note that the executor contains the @b default @b values, so if you just exchange the
158    Functor, the default values remain the same. However if you decide to change the default
159    values at any point of the stack, <b>this will also change the default values on all
160    other stack-levels</b> that share the same executor. If you don't like this behavior,
161    you have to explicitly push a new executor before changing the default values, either by
162    calling pushFunction(executor) or by calling pushFunction(void) which pushes a copy of
163    the current executor to the stack.
164
165    Another important point are object pointers in case of non-static member-functions.
166    Whenever you set or push a new function, <b>you must add the object pointer again</b>
167    because objects are stored in the Functor which is usually exchanged if you change
168    the function.
169
170    You can also use a stack for objects, but note that this <b>object-stack is different for each
171    function</b> - so if you set a new function, the object-stack will be cleared. If you push
172    a new function, the old object-stack is stored in the stack, so it can be restored if
173    you pop the function.
174
175    %DeclareConsoleCommand():
176
177    Appart from SetConsoleCommand() you can also call DeclareConsoleCommand(). In contrast
178    to SetConsoleCommand(), this doesn't assign a function to the command. Indeed you have
179    to pass a function-pointer to DeclareConsoleCommand(), but it is only used to determine
180    the header of the future command-function. This allows to declare a command statically,
181    thus it's possible to evaluate key-bindings of this command, but the actual function
182    can be assigned at a later point.
183
184    Example:
185    @code
186    DeclareConsoleCommand("cout", &prototype::void__string);
187    @endcode
188
189    If you try to execute the command now, you see the following (or something similar):
190    @code
191    $ cout Hello World
192    Error: Can't execute command "cout", command is not active.
193    @endcode
194
195    You first have to assign a function to use the command:
196    @code
197    {
198        // ...
199
200        ModifyConsoleCommand("cout").setFunction(&myCoutFunction);
201
202        // ...
203    }
204    @endcode
205
206    Now you can use it:
207    @code
208    $ cout Hello World
209    Text: Hello World
210    @endcode
211
212    Note that the initial function prototype::void__string is defined in the namespace
213    orxonox::prototype. If there's no function with the desired header, you can extend
214    the collection of functions or simply use another function that has the same header.
215*/
216
217#ifndef _ConsoleCommand_H__
218#define _ConsoleCommand_H__
219
220#include "core/CorePrereqs.h"
221
222#include <stack>
223#include <vector>
224
225#include "util/VA_NARGS.h"
226#include "ArgumentCompletionFunctions.h"
227#include "Executor.h"
228
229
230/**
231    @brief Defines a console command. The macro is overloaded for 2-4 parameters.
232
233    This is an overloaded macro. Depending on the number of arguments a different
234    overloaded implementation of the macro will be chosen.
235
236    Console commands created with SetConsoleCommand() become active immediately and
237    the given function-pointer (and optionally the object) will be used to execute
238    the command.
239*/
240#define SetConsoleCommand(...) \
241    BOOST_PP_EXPAND(BOOST_PP_CAT(SetConsoleCommand, ORXONOX_VA_NARGS(__VA_ARGS__))(__VA_ARGS__))
242/**
243    @brief This macro is executed if you call SetConsoleCommand() with 2 arguments.
244    @param name The name (string) of the console command
245    @param functionpointer The function-pointer of the corresponding command-function
246*/
247#define SetConsoleCommand2(name, functionpointer) \
248    SetConsoleCommandGeneric("", name, orxonox::createFunctor(functionpointer))
249/**
250    @brief This macro is executed if you call SetConsoleCommand() with 3 arguments.
251    @param group The group (string) of the console command
252    @param name The name (string) of the console command
253    @param functionpointer The function-pointer of the corresponding command-function
254*/
255#define SetConsoleCommand3(group, name, functionpointer) \
256    SetConsoleCommandGeneric(group, name, orxonox::createFunctor(functionpointer))
257/**
258    @brief This macro is executed if you call SetConsoleCommand() with 4 arguments.
259    @param group The group (string) of the console command
260    @param name The name (string) of the console command
261    @param functionpointer The function-pointer of the corresponding command-function
262    @param object The object that will be assigned to the command. Used for member-functions.
263*/
264#define SetConsoleCommand4(group, name, functionpointer, object) \
265    SetConsoleCommandGeneric(group, name, orxonox::createFunctor(functionpointer, object))
266
267/// Internal macro
268#define SetConsoleCommandGeneric(group, name, functor) \
269    static orxonox::ConsoleCommand& BOOST_PP_CAT(__consolecommand_, __UNIQUE_NUMBER__) = (*orxonox::createConsoleCommand(group, name, orxonox::createExecutor(functor)))
270
271
272/**
273    @brief Declares a console command. The macro is overloaded for 2-3 parameters.
274
275    This is an overloaded macro. Depending on the number of arguments a different
276    overloaded implementation of the macro will be chosen.
277
278    Console commands created with DeclareConsoleCommand() don't use the the given
279    function-pointer to execute the command, it is only used to define the header
280    of the future command-function. The command is inactive until you manually
281    set a function with orxonox::ModifyConsoleCommand(). You can use a different
282    function-pointer than in the final command, as long as it has the same header.
283*/
284#define DeclareConsoleCommand(...) \
285    BOOST_PP_EXPAND(BOOST_PP_CAT(DeclareConsoleCommand, ORXONOX_VA_NARGS(__VA_ARGS__))(__VA_ARGS__))
286/**
287    @brief This macro is executed if you call DeclareConsoleCommand() with 2 arguments.
288    @param name The name (string) of the console command
289    @param functionpointer The function-pointer of an arbitrary function that has the same header as the final function
290*/
291#define DeclareConsoleCommand2(name, functionpointer) \
292    DeclareConsoleCommandGeneric("", name, orxonox::createFunctor(functionpointer))
293/**
294    @brief This macro is executed if you call DeclareConsoleCommand() with 3 arguments.
295    @param group The group (string) of the console command
296    @param name The name (string) of the console command
297    @param functionpointer The function-pointer of an arbitrary function that has the same header as the final function
298*/
299#define DeclareConsoleCommand3(group, name, functionpointer) \
300    DeclareConsoleCommandGeneric(group, name, orxonox::createFunctor(functionpointer))
301
302/// Internal macro
303#define DeclareConsoleCommandGeneric(group, name, functor) \
304    static orxonox::ConsoleCommand& BOOST_PP_CAT(__consolecommand_, __UNIQUE_NUMBER__) = (*orxonox::createConsoleCommand(group, name, orxonox::createExecutor(functor), false))
305
306
307namespace orxonox
308{
309    /**
310        @brief A small collection of functions that can be used in DeclareConsoleCommand() if
311        you don't want to use the real function-pointer.
312    */
313    namespace prototype
314    {
315        inline void void__void(void) {}
316        inline void void__string(const std::string&) {}
317
318        inline std::string string__bool(bool) { return ""; }
319        inline std::string string__string(const std::string&) { return ""; }
320        inline std::string string__uint_uint_bool(unsigned int, unsigned int, bool) { return ""; }
321    }
322
323    namespace AccessLevel
324    {
325        /**
326            @brief Possible access levels: A command can only be executed if the program is in the state which is requested by the access level.
327        */
328        enum Enum
329        {
330            All,
331            Standalone,
332            Master,
333            Server,
334            Client,
335            Online,
336            Offline,
337            None
338        };
339    }
340
341    /**
342        @brief The ConsoleCommand class stores all information about a console command which can be executed by CommandExecutor.
343
344        Console commands can be entered by the user into the shell, called in scripts, or
345        used for key-bindings. They are simple text strings that can be executed by
346        CommandExecutor. CommandExecutor will search for a ConsoleCommand with the given
347        group and name and will execute it's Executor (which again calls the Functor and
348        this finally calls the command-function).
349
350        @see See @ref ConsoleCommandExample "ConsoleCommand.h" for more information and some examples.
351    */
352    class _CoreExport ConsoleCommand
353    {
354        friend struct ConsoleCommandManipulator;
355
356        /**
357            @brief Helper class that is used to put the current state of the ConsoleCommand on a stack.
358        */
359        struct Command
360        {
361            ExecutorPtr executor_;              ///< The executor
362            FunctorPtr functor_;                ///< The function that is used with the executor - has to be stored separatley because the executor is often used with different functors
363            std::vector<void*> objectStack_;    ///< The object stack
364        };
365
366        public:
367            /**
368                @brief Helper class that is used to manipulate console commands.
369
370                An instance of this class is returned if you call the ModifyConsoleCommand macro.
371                This class provides an interface which wraps some functions of ConsoleCommand. It
372                allows access to some private functions like setFunction() (that can't be called
373                right after SetConsoleCommand()) but it also hides some functions that shouln't be
374                called after the static declaration like addShortcut() or description().
375
376                @see See @ref ConsoleCommandExample "ConsoleCommand.h" for more information and examples.
377            */
378            struct ConsoleCommandManipulator
379            {
380                public:
381                    /// Constructor: Creates a manipulator for a given ConsoleCommand.
382                    ConsoleCommandManipulator(ConsoleCommand* command) : command_(command) {}
383
384                    /// Changes the current function of the command. @param function The new function-pointer @param bForce If true, the new function-pointer is always assigned, even if the headers don't match
385                    template <class F>
386                    inline ConsoleCommandManipulator& setFunction(F function, bool bForce = false)
387                        {
388                            if (this->command_)
389                            {
390                                // check if the headers match. If they do, only change the function-pointer of the current Functor instead of creating a new Functor
391                                if (this->command_->getExecutor() && this->command_->getExecutor()->getFunctor() && this->command_->getExecutor()->getFunctor()->getFullIdentifier() == typeid(F))
392                                {
393                                    FunctorPointer<F>* functor = static_cast<FunctorPointer<F>*>(this->command_->getExecutor()->getFunctor().get());
394                                    functor->setFunction(function);
395                                    return *this;
396                                }
397                                this->command_->setFunction(createFunctor(function), bForce);
398                            }
399                            return *this;
400                        }
401                    /// Changes the current function of the command. @param function The new function-pointer @param object The new object-pointer (for member-functions) @param bForce If true, the new function-pointer is always assigned, even if the headers don't match
402                    template <class F, class O>
403                    inline ConsoleCommandManipulator& setFunction(F function, O* object, bool bForce = false)
404                        {
405                            if (this->command_)
406                            {
407                                // check if the headers match. If they do, only change the function-pointer of the current Functor instead of creating a new Functor
408                                if (this->command_->getExecutor() && this->command_->getExecutor()->getFunctor() && this->command_->getExecutor()->getFunctor()->getFullIdentifier() == typeid(F))
409                                {
410                                    FunctorPointer<F, O>* functor = static_cast<FunctorPointer<F, O>*>(this->command_->getExecutor()->getFunctor().get());
411                                    functor->setFunction(function);
412                                    functor->setObject(object);
413                                    return *this;
414                                }
415                                this->command_->setFunction(createFunctor(function, object), bForce);
416                            }
417                            return *this;
418                        }
419                    /// Changes the current Functor of the command. @param functor The new Functor @param bForce If true, the new Functor is always assigned, even if the headers don't match
420                    inline ConsoleCommandManipulator& setFunction(const FunctorPtr& functor, bool bForce = false)
421                        { if (this->command_) { this->command_->setFunction(functor, bForce); } return *this; }
422                    /// Changes the current Executor of the command. @param executor The new Executor @param bForce If true, the new Executor is always assigned, even if the headers don't match
423                    inline ConsoleCommandManipulator& setFunction(const ExecutorPtr& executor, bool bForce = false)
424                        { if (this->command_) { this->command_->setFunction(executor, bForce); } return *this; }
425
426                    /// Pushes a copy of the current Executor on the command-stack, that can be altered without changing the old Executor. @details This function is especially useful if you don't wan't to change the function, but only the default values of the executor.
427                    inline ConsoleCommandManipulator& pushFunction()
428                        { if (this->command_) { this->command_->pushFunction(); } return *this; }
429                    /// Pushes a new function on the command-stack. @param function The new function-pointer @param bForce If true, the new function-pointer is always assigned, even if the headers don't match
430                    template <class F>
431                    inline ConsoleCommandManipulator& pushFunction(F function, bool bForce = false)
432                        { if (this->command_) { this->command_->pushFunction(createFunctor(function), bForce); } return *this; }
433                    /// Pushes a new function on the command-stack. @param function The new function-pointer @param object The new object-pointer (for member-functions) @param bForce If true, the new function-pointer is always assigned, even if the headers don't match
434                    template <class F, class O>
435                    inline ConsoleCommandManipulator& pushFunction(F function, O* object, bool bForce = false)
436                        { if (this->command_) { this->command_->pushFunction(createFunctor(function, object), bForce); } return *this; }
437                    /// Pushes a new Functor on the command-stack. @param functor The new Functor @param bForce If true, the new Functor is always assigned, even if the headers don't match
438                    inline ConsoleCommandManipulator& pushFunction(const FunctorPtr& functor, bool bForce = false)
439                        { if (this->command_) { this->command_->pushFunction(functor, bForce); } return *this; }
440                    /// Pushes a new Executor on the command-stack. @param executor The new Executor @param bForce If true, the new Executor is always assigned, even if the headers don't match
441                    inline ConsoleCommandManipulator& pushFunction(const ExecutorPtr& executor, bool bForce = false)
442                        { if (this->command_) { this->command_->pushFunction(executor, bForce); } return *this; }
443
444                    /// Removes the current function from the stack and restores the old state. If there's no other function on the stack, the command is deactivated.
445                    inline ConsoleCommandManipulator& popFunction()
446                        { if (this->command_) { this->command_->popFunction(); } return *this; }
447
448                    /// Sets the current function-pointer to NULL, which also deactivates the command.
449                    inline ConsoleCommandManipulator& resetFunction()
450                        { if (this->command_) { this->command_->resetFunction(); } return *this; }
451
452                    /// Changes the current object (used for member-functions).
453                    inline ConsoleCommandManipulator& setObject(void* object)
454                        { if (this->command_) { this->command_->setObject(object); } return *this; }
455                    /// Pushes a new object on the object-stack.
456                    inline ConsoleCommandManipulator& pushObject(void* object)
457                        { if (this->command_) { this->command_->pushObject(object); } return *this; }
458                    /// Removes the current object from the object-stack and restores the old object (or NULL if there's no object left on the stack).
459                    inline ConsoleCommandManipulator& popObject()
460                        { if (this->command_) { this->command_->popObject(); } return *this; }
461
462                    /// Changes the activity of the command.
463                    inline ConsoleCommandManipulator& setActive(bool bActive)
464                        { if (this->command_) { this->command_->setActive(bActive); } return *this; }
465                    /// Activates the command.
466                    inline ConsoleCommandManipulator& activate()
467                        { return this->setActive(true); }
468                    /// Deactivates the command.
469                    inline ConsoleCommandManipulator& deactivate()
470                        { return this->setActive(false); }
471
472                    /// Changes the visibility of the command.
473                    inline ConsoleCommandManipulator& setHidden(bool bHidden)
474                        { if (this->command_) { this->command_->setHidden(bHidden); } return *this; }
475                    /// Hides the command (can still be executed, but is not visible in the list of available commands).
476                    inline ConsoleCommandManipulator& hide()
477                        { return this->setHidden(true); }
478                    /// Makes the command visible.
479                    inline ConsoleCommandManipulator& show()
480                        { return this->setHidden(false); }
481
482                    /// Changes the default values of the current executor (doesn't modify executors on deeper levels of the command-stack).
483                    inline ConsoleCommandManipulator& defaultValues(const MultiType& arg1)
484                        { if (this->command_) { this->command_->defaultValues(arg1); } return *this; }
485                    /// Changes the default values of the current executor (doesn't modify executors on deeper levels of the command-stack).
486                    inline ConsoleCommandManipulator& defaultValues(const MultiType& arg1, const MultiType& arg2)
487                        { if (this->command_) { this->command_->defaultValues(arg1, arg2); } return *this; }
488                    /// Changes the default values of the current executor (doesn't modify executors on deeper levels of the command-stack).
489                    inline ConsoleCommandManipulator& defaultValues(const MultiType& arg1, const MultiType& arg2, const MultiType& arg3)
490                        { if (this->command_) { this->command_->defaultValues(arg1, arg2, arg3); } return *this; }
491                    /// Changes the default values of the current executor (doesn't modify executors on deeper levels of the command-stack).
492                    inline ConsoleCommandManipulator& defaultValues(const MultiType& arg1, const MultiType& arg2, const MultiType& arg3, const MultiType& arg4)
493                        { if (this->command_) { this->command_->defaultValues(arg1, arg2, arg3, arg4); } return *this; }
494                    /// Changes the default values of the current executor (doesn't modify executors on deeper levels of the command-stack).
495                    inline ConsoleCommandManipulator& defaultValues(const MultiType& arg1, const MultiType& arg2, const MultiType& arg3, const MultiType& arg4, const MultiType& arg5)
496                        { if (this->command_) { this->command_->defaultValues(arg1, arg2, arg3, arg4, arg5); } return *this; }
497                    /// Changes the default value of the argument with given index of the current executor (doesn't modify executors on deeper levels of the command-stack).
498                    inline ConsoleCommandManipulator& defaultValue(unsigned int index, const MultiType& arg)
499                        { if (this->command_) { this->command_->defaultValue(index, arg); } return *this; }
500
501                    /// Changes the access level of the command.
502                    inline ConsoleCommandManipulator& accessLevel(AccessLevel::Enum level)
503                        { if (this->command_) { this->command_->accessLevel(level); } return *this; }
504
505                    /// Changes the argument completer for the given parameter.
506                    inline ConsoleCommandManipulator& argumentCompleter(unsigned int index, ArgumentCompleter* completer)
507                        { if (this->command_) { this->command_->argumentCompleter(index, completer); } return *this; }
508
509                    /// Defines the command to be an input command.
510                    inline ConsoleCommandManipulator& setAsInputCommand()
511                        { if (this->command_) { this->command_->setAsInputCommand(); } return *this; }
512                    /// Changes the keybind mode of the command.
513                    inline ConsoleCommandManipulator& keybindMode(KeybindMode::Value mode)
514                        { if (this->command_) { this->command_->changeKeybindMode(mode); } return *this; }
515                    /// Sets the input configured param to the given index.
516                    inline ConsoleCommandManipulator& inputConfiguredParam(int index)
517                        { if (this->command_) { this->command_->inputConfiguredParam(index); } return *this; }
518
519                private:
520                    ConsoleCommand* command_;   ///< The command which is being manipulated by this object
521            };
522
523        public:
524            ConsoleCommand(const std::string& group, const std::string& name, const ExecutorPtr& executor, bool bInitialized = true);
525            ~ConsoleCommand();
526
527            ConsoleCommand& addShortcut();
528            ConsoleCommand& addShortcut(const std::string&  name);
529            ConsoleCommand& addGroup(const std::string& group);
530            ConsoleCommand& addGroup(const std::string& group, const std::string&  name);
531
532            /// Returns the name that was first used for this command.
533            inline const std::string& getName() const
534                { return this->baseName_; }
535
536            const ExecutorPtr& getExecutor() const;
537            /// Returns the functor that defines the required header for this command (but isn't necessarily executed).
538            inline const FunctorPtr& getBaseFunctor() const
539                { return this->baseFunctor_; }
540
541            /// Changes the activity of the command.
542            inline ConsoleCommand& setActive(bool bActive)
543                { this->bActive_ = bActive; return *this; }
544            /// Activates the command.
545            inline ConsoleCommand& activate()
546                { return this->setActive(true); }
547            /// Deactivates the command.
548            inline ConsoleCommand& deactivate()
549                { return this->setActive(false); }
550
551            /// Changes the visibility of the command.
552            inline ConsoleCommand& setHidden(bool bHidden)
553                { this->bHidden_ = bHidden; return *this; }
554            /// Hides the command (can still be executed, but is not visible in the list of available commands).
555            inline ConsoleCommand& hide()
556                { return this->setHidden(true); }
557            /// Makes the command visible.
558            inline ConsoleCommand& show()
559                { return this->setHidden(false); }
560
561            bool isActive() const;
562            bool hasAccess() const;
563            /// Returns true if the command is currently hidden.
564            inline bool isHidden() const
565                { return this->bHidden_; }
566
567            ConsoleCommand& description(const std::string& description);
568            const std::string& getDescription() const;
569
570            ConsoleCommand& descriptionParam(unsigned int index, const std::string& description);
571            const std::string& getDescriptionParam(unsigned int index) const;
572
573            ConsoleCommand& descriptionReturnvalue(const std::string& description);
574            const std::string& getDescriptionReturnvalue(int index) const;
575
576            ConsoleCommand& defaultValues(const MultiType& arg1);
577            ConsoleCommand& defaultValues(const MultiType& arg1, const MultiType& arg2);
578            ConsoleCommand& defaultValues(const MultiType& arg1, const MultiType& arg2, const MultiType& arg3);
579            ConsoleCommand& defaultValues(const MultiType& arg1, const MultiType& arg2, const MultiType& arg3, const MultiType& arg4);
580            ConsoleCommand& defaultValues(const MultiType& arg1, const MultiType& arg2, const MultiType& arg3, const MultiType& arg4, const MultiType& arg5);
581            ConsoleCommand& defaultValue(unsigned int index, const MultiType& arg);
582
583            /// Changes the access level of the command.
584            inline ConsoleCommand& accessLevel(AccessLevel::Enum level)
585                { this->accessLevel_ = level; return *this; }
586            /// Returns the access level of the command.
587            inline AccessLevel::Enum getAccessLevel() const
588                { return this->accessLevel_; }
589
590            ConsoleCommand& argumentCompleter(unsigned int index, ArgumentCompleter* completer);
591            ArgumentCompleter* getArgumentCompleter(unsigned int index) const;
592
593            /// Defines the command to be an input command
594            inline ConsoleCommand& setAsInputCommand()
595            {
596                this->keybindMode(KeybindMode::OnHold);
597                this->defaultValue(0, Vector2(0.0f, 0.0f));
598                this->inputConfiguredParam(0);
599                return *this;
600            }
601
602            /// Sets the keybind mode. Note: use changeKeybindMode if you intend to change the mode.
603            inline ConsoleCommand& keybindMode(KeybindMode::Value mode)
604                { this->keybindMode_ = mode; return *this; }
605            /// Returns the keybind mode
606            inline KeybindMode::Value getKeybindMode() const
607                { return this->keybindMode_; }
608
609            ConsoleCommand& changeKeybindMode(KeybindMode::Value mode);
610
611            /// Changes the input configured param to the given index.
612            inline ConsoleCommand& inputConfiguredParam(int index)
613                { this->inputConfiguredParam_ = index; return *this; }
614            /// Returns the input configured param.
615            inline int getInputConfiguredParam() const
616                { return this->inputConfiguredParam_; }
617
618            /// Returns a manipulator for this command.
619            inline ConsoleCommandManipulator getManipulator()
620                { return this; }
621
622        private:
623            bool headersMatch(const FunctorPtr& functor);
624            bool headersMatch(const ExecutorPtr& executor);
625
626            bool setFunction(const ExecutorPtr& executor, bool bForce = false);
627            bool setFunction(const FunctorPtr& functor, bool bForce = false);
628            void pushFunction(const ExecutorPtr& executor, bool bForce = false);
629            void pushFunction(const FunctorPtr& functor, bool bForce = false);
630            void pushFunction();
631            void popFunction();
632            void resetFunction();
633
634            bool setObject(void* object);
635            void pushObject(void* object);
636            void popObject();
637            void* getObject() const;
638
639            bool bActive_;                                                  ///< True if the command should be active (it can still be inactive, for example if the function is missing)
640            bool bHidden_;                                                  ///< True if the command is hidden (it is still executable, but not visible in the list of available commands)
641            AccessLevel::Enum accessLevel_;                                 ///< The access level (the state of the game in which you can access the command)
642            std::string baseName_;                                          ///< The name that was first assigned to the command
643            FunctorPtr baseFunctor_;                                        ///< The functor that defines the header of the command-function
644
645            ExecutorPtr executor_;                                          ///< The Executor that is used to execute the command
646            std::stack<Command> commandStack_;                              ///< A stack of commands, used to push and pop different functions
647            std::vector<void*> objectStack_;                                ///< A stack of objects, used to push and pop different objects for a function
648
649            ArgumentCompleter* argumentCompleter_[MAX_FUNCTOR_ARGUMENTS];   ///< ArgumentCompleter for each argument
650
651            KeybindMode::Value keybindMode_;                                ///< The keybind mode
652            int inputConfiguredParam_;                                      ///< The input configured param
653
654            LanguageEntryLabel description_;                                ///< The description of the command
655            LanguageEntryLabel descriptionReturnvalue_;                     ///< A description of the return-value
656            LanguageEntryLabel descriptionParam_[MAX_FUNCTOR_ARGUMENTS];    ///< A description for each argument
657
658        public:
659            /// Returns the map with all groups and commands.
660            static inline const std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommands()
661                { return ConsoleCommand::getCommandMap(); }
662            /// Returns the map with all groups and commands in lowercase.
663            static inline const std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommandsLC()
664                { return ConsoleCommand::getCommandMapLC(); }
665
666            /// 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
667            static inline ConsoleCommand* getCommand(const std::string& name, bool bPrintError = false)
668                { return ConsoleCommand::getCommand("", name, bPrintError); }
669            /// 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
670            static inline ConsoleCommand* getCommandLC(const std::string& name, bool bPrintError = false)
671                { return ConsoleCommand::getCommandLC("", name, bPrintError); }
672
673            static ConsoleCommand* getCommand(const std::string& group, const std::string& name, bool bPrintError = false);
674            static ConsoleCommand* getCommandLC(const std::string& group, const std::string& name, bool bPrintError = false);
675
676            static void destroyAll();
677
678        private:
679            static std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommandMap();
680            static std::map<std::string, std::map<std::string, ConsoleCommand*> >& getCommandMapLC();
681
682            static void registerCommand(const std::string& group, const std::string& name, ConsoleCommand* command);
683            static void unregisterCommand(ConsoleCommand* command);
684    };
685
686    /**
687        @brief Creates a new ConsoleCommand.
688        @param name The name of the command
689        @param executor The executor of the command
690        @param bInitialized If true, the command is ready to be executed, otherwise it has to be activated first.
691    */
692    inline ConsoleCommand* createConsoleCommand(const std::string& name, const ExecutorPtr& executor, bool bInitialized = true)
693        { return new ConsoleCommand("", name, executor, bInitialized); }
694    /**
695        @brief Creates a new ConsoleCommand.
696        @param group The group of the command
697        @param name The name of the command
698        @param executor The executor of the command
699        @param bInitialized If true, the command is ready to be executed, otherwise it has to be activated first.
700    */
701    inline ConsoleCommand* createConsoleCommand(const std::string& group, const std::string& name, const ExecutorPtr& executor, bool bInitialized = true)
702        { return new ConsoleCommand(group, name, executor, bInitialized); }
703
704
705    /**
706        @brief Returns a manipulator for a command with the given name.
707
708        @note If the command doesn't exist, the manipulator contains a NULL pointer to the command,
709        but it can still be used without checks, because all functions of ConsoleCommandManipulator
710        check internally if the command exists.
711    */
712    inline ConsoleCommand::ConsoleCommandManipulator ModifyConsoleCommand(const std::string& name)
713        { return ConsoleCommand::getCommand(name, true); }
714    /**
715        @brief Returns a manipulator for a command with the given group and name.
716
717        @note If the command doesn't exist, the manipulator contains a NULL pointer to the command,
718        but it can still be used without checks, because all functions of ConsoleCommandManipulator
719        check internally if the command exists.
720    */
721    inline ConsoleCommand::ConsoleCommandManipulator ModifyConsoleCommand(const std::string& group, const std::string& name)
722        { return ConsoleCommand::getCommand(group, name, true); }
723}
724
725#endif /* _ConsoleCommand_H__ */
Note: See TracBrowser for help on using the repository browser.