Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/command/Executor.h @ 7378

Last change on this file since 7378 was 7284, checked in by landauf, 15 years ago

merged consolecommands3 branch back to trunk.

note: the console command interface has changed completely, but the documentation is not yet up to date. just copy an existing command and change it to your needs, it's pretty self-explanatory. also the include files related to console commands are now located in core/command/. in the game it should work exactly like before, except for some changes in the auto-completion.
  • Property svn:eol-style set to native
File size: 10.9 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 *   Inspiration: Executor by Benjamin Grauer
28 */
29
30#ifndef _Executor_H__
31#define _Executor_H__
32
33#include "core/CorePrereqs.h"
34
35#include <string>
36#include "util/MultiType.h"
37#include "Functor.h"
38#include "ExecutorPtr.h"
39
40namespace orxonox
41{
42    class _CoreExport Executor
43    {
44        public:
45            Executor(const FunctorPtr& functor, const std::string& name = "");
46            Executor(const Executor& other);
47            virtual ~Executor();
48
49            inline MultiType operator()() const
50                { return (*this->functor_)(this->defaultValue_[0], this->defaultValue_[1], this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
51            inline MultiType operator()(const MultiType& param1) const
52                { return (*this->functor_)(param1, this->defaultValue_[1], this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
53            inline MultiType operator()(const MultiType& param1, const MultiType& param2) const
54                { return (*this->functor_)(param1, param2, this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
55            inline MultiType operator()(const MultiType& param1, const MultiType& param2, const MultiType& param3) const
56                { return (*this->functor_)(param1, param2, param3, this->defaultValue_[3], this->defaultValue_[4]); }
57            inline MultiType operator()(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4) const
58                { return (*this->functor_)(param1, param2, param3, param4, this->defaultValue_[4]); }
59            inline MultiType operator()(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4, const MultiType& param5) const
60                { return (*this->functor_)(param1, param2, param3, param4, param5); }
61
62            MultiType parse(const std::string& arguments, int* error = 0, const std::string& delimiter = " ", bool bPrintError = false) const;
63            MultiType parse(const SubString& arguments, int* error = 0, const std::string& delimiter = " ", bool bPrintError = false) const;
64
65            int evaluateParams(const SubString& arguments, MultiType param[MAX_FUNCTOR_ARGUMENTS], int* error = 0, const std::string& delimiter = " ") const;
66
67            inline void setFunctor(const FunctorPtr& functor)
68                { this->functor_ = functor; }
69            inline const FunctorPtr& getFunctor() const
70                { return this->functor_; }
71
72            inline void setName(const std::string& name)
73                { this->name_ = name; }
74            inline const std::string& getName() const
75                { return this->name_; }
76
77            inline unsigned int getParamCount() const
78                { return this->functor_->getParamCount(); }
79            inline bool hasReturnvalue() const
80                { return this->functor_->hasReturnvalue(); }
81            inline Functor::Type::Enum getType() const
82                { return this->functor_->getType(); }
83            inline std::string getTypenameParam(unsigned int param) const
84                { return this->functor_->getTypenameParam(param); }
85            inline std::string getTypenameReturnvalue() const
86                { return this->functor_->getTypenameReturnvalue(); }
87
88            void setDefaultValues(const MultiType& param1);
89            void setDefaultValues(const MultiType& param1, const MultiType& param2);
90            void setDefaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3);
91            void setDefaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4);
92            void setDefaultValues(const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4, const MultiType& param5);
93            void setDefaultValue(unsigned int index, const MultiType& param);
94
95            inline MultiType getDefaultValue(unsigned int index) const
96            {
97                if (index < MAX_FUNCTOR_ARGUMENTS)
98                    return this->defaultValue_[index];
99
100                return MT_Type::Null;
101            }
102
103            bool allDefaultValuesSet() const;
104            inline bool defaultValueSet(unsigned int index) const
105            {
106                if (index < MAX_FUNCTOR_ARGUMENTS)
107                    return !this->defaultValue_[index].null();
108
109                return false;
110            }
111
112        protected:
113            FunctorPtr functor_;
114            std::string name_;
115            MultiType defaultValue_[MAX_FUNCTOR_ARGUMENTS];
116    };
117
118    class _CoreExport ExecutorStatic : public Executor
119    {
120        public:
121            ExecutorStatic(const FunctorStaticPtr& functor, const std::string& name = "") : Executor(functor, name) {}
122            virtual ~ExecutorStatic() {}
123    };
124
125    template <class T>
126    class ExecutorMember : public Executor
127    {
128        public:
129            ExecutorMember(const FunctorMemberPtr<T>& functor, const std::string& name = "") : Executor(functor, name), functorMember_(functor) {}
130            virtual ~ExecutorMember() {}
131
132            using Executor::operator();
133
134            inline MultiType operator()(T* object) const
135                { return (*this->functorMember_)(object, this->defaultValue_[0], this->defaultValue_[1], this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
136            inline MultiType operator()(T* object, const MultiType& param1) const
137                { return (*this->functorMember_)(object, param1, this->defaultValue_[1], this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
138            inline MultiType operator()(T* object, const MultiType& param1, const MultiType& param2) const
139                { return (*this->functorMember_)(object, param1, param2, this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
140            inline MultiType operator()(T* object, const MultiType& param1, const MultiType& param2, const MultiType& param3) const
141                { return (*this->functorMember_)(object, param1, param2, param3, this->defaultValue_[3], this->defaultValue_[4]); }
142            inline MultiType operator()(T* object, const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4) const
143                { return (*this->functorMember_)(object, param1, param2, param3, param4, this->defaultValue_[4]); }
144            inline MultiType operator()(T* object, const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4, const MultiType& param5) const
145                { return (*this->functorMember_)(object, param1, param2, param3, param4, param5); }
146
147
148            inline MultiType operator()(const T* object) const
149                { return (*this->functorMember_)(object, this->defaultValue_[0], this->defaultValue_[1], this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
150            inline MultiType operator()(const T* object, const MultiType& param1) const
151                { return (*this->functorMember_)(object, param1, this->defaultValue_[1], this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
152            inline MultiType operator()(const T* object, const MultiType& param1, const MultiType& param2) const
153                { return (*this->functorMember_)(object, param1, param2, this->defaultValue_[2], this->defaultValue_[3], this->defaultValue_[4]); }
154            inline MultiType operator()(const T* object, const MultiType& param1, const MultiType& param2, const MultiType& param3) const
155                { return (*this->functorMember_)(object, param1, param2, param3, this->defaultValue_[3], this->defaultValue_[4]); }
156            inline MultiType operator()(const T* object, const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4) const
157                { return (*this->functorMember_)(object, param1, param2, param3, param4, this->defaultValue_[4]); }
158            inline MultiType operator()(const T* object, const MultiType& param1, const MultiType& param2, const MultiType& param3, const MultiType& param4, const MultiType& param5) const
159                { return (*this->functorMember_)(object, param1, param2, param3, param4, param5); }
160
161            inline void setObject(T* object) const
162                { this->functorMember_->setObject(object); }
163            inline void setObject(const T* object) const
164                { this->functorMember_->setObject(object); }
165
166            using Executor::parse;
167
168            MultiType parse(T* object, const std::string& params, int* error = 0, const std::string& delimiter = " ", bool bPrintError = false) const
169            {
170                T* oldobject = this->functorMember_->getObject();
171
172                this->functorMember_->setObject(object);
173                const MultiType& result = this->Executor::parse(params, error, delimiter, bPrintError);
174                this->functorMember_->setObject(oldobject);
175
176                return result;
177            }
178
179            MultiType parse(const T* object, const std::string& params, int* error = 0, const std::string& delimiter = " ", bool bPrintError = false) const
180            {
181                T* oldobject = this->functorMember_->getObject();
182
183                this->functorMember_->setObject(object);
184                const MultiType& result = this->Executor::parse(params, error, delimiter, bPrintError);
185                this->functorMember_->setObjects(oldobject);
186
187                return result;
188            }
189
190        protected:
191            FunctorMemberPtr<T> functorMember_;
192    };
193
194    inline ExecutorPtr createExecutor(const FunctorPtr& functor, const std::string& name = "")
195    {
196        return new Executor(functor, name);
197    }
198
199    template <class T>
200    inline ExecutorMemberPtr<T> createExecutor(const FunctorMemberPtr<T>& functor, const std::string& name = "")
201    {
202        return new ExecutorMember<T>(functor, name);
203    }
204
205    inline ExecutorStaticPtr createExecutor(const FunctorStaticPtr& functor, const std::string& name = "")
206    {
207        return new ExecutorStatic(functor, name);
208    }
209}
210
211#endif /* _Executor_H__ */
Note: See TracBrowser for help on using the repository browser.