Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/core/Super.h @ 1757

Last change on this file since 1757 was 1747, checked in by landauf, 16 years ago

merged core3 back to trunk
  • Property svn:eol-style set to native
File size: 20.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/**
30    @file Super.h
31    @brief Definition of all super-function related macros.
32
33    This file defines all macros needed to add a new "super-function".
34    If you add a super-function, you can call SUPER(myclass, functionname) inside your
35    code and the function of the parentclass gets called. This is comparable with
36    super.functionname() in Java or other languages.
37
38    This works only with virtual functions that return nothing (void) and belong to
39    classes that have an Identifier. Arguments however are supported.
40
41    To add a new super-function, you have process 4 steps:
42
43    1) Add a new SUPER macro
44       This allows you to call the super-function in your code.
45       Location: This file (Super.h), marked with --> HERE <-- comments (1/3)
46
47    2) Call the SUPER_FUNCTION_GLOBAL_DECLARATION_PART1/2 macros.
48       This defines some global classes and templates, needed to create and call the super-functions.
49       Location: This file (Super.h), marked with --> HERE <-- comments (2/3)
50
51    3) Call the SUPER_INTRUSIVE_DECLARATION macro.
52       This will be included into the declaration of ClassIdentifier<T>.
53       Location: This file (Super.h), marked with --> HERE <-- comments (3/3)
54
55    4) Call the SUPER_FUNCTION macro.
56       This defines a partially specialized template that will decide if a class is "super" to another class.
57       If the check returns true, a SuperFunctionCaller gets created, which will be used by the SUPER macro.
58       You have to add this into the header-file of the baseclass of the super-function (the class that first
59       implements the function), below the class declaration. You can't call it directly in this file, because
60       otherwise you had to include the headerfile right here, which would cause some ugly backdependencies,
61       include loops and slower compilation.
62       Dont forget to include Super.h in the header-file.
63       Location: The header-file of the baseclass (Baseclass.h), below the class declaration
64*/
65
66#ifndef _Super_H__
67#define _Super_H__
68
69#include <iostream>
70
71#include "CorePrereqs.h"
72
73#include "util/Debug.h"
74#include "util/XMLIncludes.h"
75
76///////////////////////
77// Macro definitions //
78///////////////////////
79
80//// Common macros ////
81
82    /**
83        @brief Declares a new super-function by creating a specialized template. Add this below the class declaration of the baseclass.
84        @param functionnumber Each super-function needs a unique number, starting with zero, increasing by one
85        @param baseclass The baseclass of the super-function (~the root)
86        @param functionname The name of the super-function
87        @param purevirtualbase "true" if the function is pure virtual in the baseclass, "false" if the function is implemented (without "")
88    */
89    #define SUPER_FUNCTION(functionnumber, baseclass, functionname, purevirtualbase) \
90        template <class T, int templatehack2> \
91        struct SuperFunctionCondition<functionnumber, T, 0, templatehack2> \
92        { \
93            static void check() \
94            { \
95                SuperFunctionCondition<functionnumber, T, 0, templatehack2>::apply((T*)0); \
96                SuperFunctionCondition<functionnumber + 1, T, 0, templatehack2>::check(); \
97            } \
98            \
99            static void apply(void* temp) {} \
100            static void apply(baseclass* temp) \
101            { \
102                ClassIdentifier<T>* identifier = ClassIdentifier<T>::getIdentifier(); \
103                for (std::set<const Identifier*>::iterator it = identifier->getDirectChildrenIntern().begin(); it != identifier->getDirectChildrenIntern().end(); ++it) \
104                { \
105                    if (!((ClassIdentifier<T>*)(*it))->superFunctionCaller_##functionname##_) \
106                    { \
107                        COUT(5) << "Added SuperFunctionCaller for " << #functionname << ": " << ClassIdentifier<T>::getIdentifier()->getName() << " <- " << ((ClassIdentifier<T>*)(*it))->getName() << std::endl; \
108                        ((ClassIdentifier<T>*)(*it))->superFunctionCaller_##functionname##_ = new SuperFunctionClassCaller_##functionname <T>; \
109                    } \
110                } \
111            } \
112        }; \
113        \
114        SUPER_FUNCTION_PUREVIRTUAL_WORKAROUND##purevirtualbase(functionnumber, baseclass)
115
116    #define SUPER_FUNCTION_PUREVIRTUAL_WORKAROUND0(functionnumber, baseclass) SUPER_FUNCTION_PUREVIRTUAL_WORKAROUNDfalse(functionnumber, baseclass)
117    #define SUPER_FUNCTION_PUREVIRTUAL_WORKAROUND1(functionnumber, baseclass) SUPER_FUNCTION_PUREVIRTUAL_WORKAROUNDtrue(functionnumber, baseclass)
118    #define SUPER_FUNCTION_PUREVIRTUAL_WORKAROUNDfalse(functionnumber, baseclass)
119    #define SUPER_FUNCTION_PUREVIRTUAL_WORKAROUNDtrue(functionnumber, baseclass) \
120        template <int templatehack2> \
121        struct SuperFunctionCondition<functionnumber, baseclass, 0, templatehack2> \
122        { \
123            static void check() \
124            { \
125                SuperFunctionCondition<functionnumber + 1, baseclass, 0, templatehack2>::check(); \
126            } \
127        };
128
129
130    /*
131    //// Comments about the macro ////
132
133        // Partially specialized template (templatehack is now specialized too).
134        //
135        // This ensures the compiler takes THIS template if the header-file of the super-function
136        // is included. In any other case, the compiler just uses the fallback template which is
137        // defined in this file.
138        template <class T, templatehack2>
139        struct SuperFunctionCondition<functionnumber, T, 0, templatehack2>
140        {
141            static void check()
142            {
143                // This call to the apply-function is the whole check. By calling the function with
144                // a T* pointer, the right function get's called.
145                SuperFunctionCondition<functionnumber, T, 0, templatehack2>::apply((T*)0);
146
147                // Go go the check for of next super-function (functionnumber + 1)
148                SuperFunctionCondition<functionnumber + 1, T, 0, templatehack2>::check();
149            }
150
151            // This function gets called if T is not a child of the baseclass.
152            // The function does nothing.
153            static void apply(void* temp) {}
154
155            // This function gets called if T is a child of the baseclass and can therefore be converted.
156            // The function adds a SuperFunctionCaller to the Identifier of all subclasses of T.
157            static void apply(baseclass* temp)
158            {
159                ClassIdentifier<T>* identifier = ClassIdentifier<T>::getIdentifier();
160
161                // Iterate through all children
162                for (std::set<const Identifier*>::iterator it = identifier->getDirectChildrenIntern().begin(); it != identifier->getDirectChildrenIntern().end(); ++it)
163                {
164                    // Check if there's not already a caller
165                    if (!((ClassIdentifier<T>*)(*it))->superFunctionCaller_##functionname##_)
166                    {
167                        // Add the SuperFunctionCaller
168                        COUT(5) << "adding functionpointer to " << ((ClassIdentifier<T>*)(*it))->getName() << std::endl;
169                        ((ClassIdentifier<T>*)(*it))->superFunctionCaller_##functionname##_ = new SuperFunctionClassCaller_##functionname <T>;
170                    }
171                }
172            }
173        };
174        SUPER_FUNCTION_PUREVIRTUAL_WORKAROUND##purevirtualbase
175
176
177        // The following piece of code is only added if purevirtualbase = true
178
179        // Explicit specialization of the Condition template for the baseclass to avoid
180        // errors if the function is pure virtual in the baseclass.
181        template <int templatehack2> \
182        struct SuperFunctionCondition<functionnumber, baseclass, 0, templatehack2> \
183        { \
184            // The check function just behaves like the fallback - it advances to the check for the next super-function (functionnumber + 1)
185            static void check() \
186            { \
187                SuperFunctionCondition<functionnumber + 1, baseclass, 0, templatehack2>::check(); \
188            } \
189        };
190    */
191
192    // SUPER-macro: Calls Parent::functionname() where Parent is the direct parent of classname
193    #define SUPER(classname, functionname, ...) \
194        SUPER_##functionname(classname, functionname, __VA_ARGS__)
195
196    // helper macro: for functions without arguments
197    #define SUPER_NOARGS(classname, functionname) \
198        (*ClassIdentifier<classname>::getIdentifier()->superFunctionCaller_##functionname##_)(this)
199
200    // helper macro: for functions with arguments
201    #define SUPER_ARGS(classname, functionname, ...) \
202        (*ClassIdentifier<classname>::getIdentifier()->superFunctionCaller_##functionname##_)(this, __VA_ARGS__)
203
204
205//// Function-specific macros ////
206
207    /*
208        Add a macro for each super-function
209
210        Example (no arguments):
211        #define SUPER_myfunction(classname, functionname, ...) \
212            SUPER_NOARGS(classname, functionname)
213
214        Example (with arguments):
215        #define SUPER_myfunction(classname, functionname, ...) \
216            SUPER_ARGS(classname, functionname, __VA_ARGS__)
217    */
218
219    // (1/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
220    #define SUPER_XMLPort(classname, functionname, ...) \
221        SUPER_ARGS(classname, functionname, __VA_ARGS__)
222
223    #define SUPER_tick(classname, functionname, ...) \
224        SUPER_ARGS(classname, functionname, __VA_ARGS__)
225
226    #define SUPER_changedActivity(classname, functionname, ...) \
227        SUPER_NOARGS(classname, functionname)
228
229    #define SUPER_changedVisibility(classname, functionname, ...) \
230        SUPER_NOARGS(classname, functionname)
231    // (1/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
232
233
234namespace orxonox
235{
236    /////////////////////////////////////////////////////////////////////////////////////////////////////
237    // This code gets included by Identifier.h and every other header file that needs a super-function //
238    /////////////////////////////////////////////////////////////////////////////////////////////////////
239
240    //// Common code ////
241
242        // Base templates
243        /**
244            @brief Creates the SuperFunctionCaller if T is a child of the super-functions baseclass.
245        */
246        template <int functionnumber, class T, int templatehack1, int templatehack2>
247        struct SuperFunctionCondition
248        {
249            static void check() {}
250        };
251
252        /**
253            @brief Initializes the SuperFunctionCaller-pointer with zero.
254        */
255        template <int functionnumber, class T>
256        struct SuperFunctionInitialization
257        {
258            static void initialize(ClassIdentifier<T>* identifier) {}
259        };
260
261        /**
262            @brief Deletes the SuperFunctionCaller.
263        */
264        template <int functionnumber, class T>
265        struct SuperFunctionDestruction
266        {
267            static void destroy(ClassIdentifier<T>* identifier) {}
268        };
269
270
271    //// Function-specific code ////
272
273        /**
274            @brief Creates the needed objects and templates to call a super-function.
275            @param functionnumber Each super-function needs a unique number, starting with zero, increasing by one
276            @param functionname The name of the super-function
277            @param hasarguments "false" if the function doesn't take any arguments, "true" if it does (without "")
278            @param ... Variadic: If the function takes arguments, add them here with type and name. Example: int myvalue, float myothervalue
279        */
280        #define SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(functionnumber, functionname, hasarguments, ...) \
281            template <class T, int templatehack1, int templatehack2> \
282            struct SuperFunctionCondition<functionnumber, T, templatehack1, templatehack2> \
283            { \
284                static void check() \
285                { \
286                    SuperFunctionCondition<functionnumber + 1, T, templatehack1, templatehack2>::check(); \
287                } \
288            }; \
289            \
290            template <class T> \
291            struct SuperFunctionInitialization<functionnumber, T> \
292            { \
293                static void initialize(ClassIdentifier<T>* identifier) \
294                { \
295                    identifier->superFunctionCaller_##functionname##_ = 0; \
296                    SuperFunctionInitialization<functionnumber + 1, T>::initialize(identifier); \
297                } \
298            }; \
299            \
300            template <class T> \
301            struct SuperFunctionDestruction<functionnumber, T> \
302            { \
303                static void destroy(ClassIdentifier<T>* identifier) \
304                { \
305                    if (identifier->superFunctionCaller_##functionname##_) \
306                        delete identifier->superFunctionCaller_##functionname##_; \
307                    SuperFunctionDestruction<functionnumber + 1, T>::destroy(identifier); \
308                } \
309            }; \
310            \
311            class _CoreExport SuperFunctionCaller_##functionname \
312            { \
313                public: \
314                    virtual void operator()( SUPER_CALL_ARGUMENTS##hasarguments(__VA_ARGS__) ) = 0; \
315                    virtual ~SuperFunctionCaller_##functionname () {} \
316            }; \
317            \
318            template <class T> \
319            class SuperFunctionClassCaller_##functionname : public SuperFunctionCaller_##functionname \
320            { \
321                public: \
322                    inline void operator()( SUPER_CALL_ARGUMENTS##hasarguments(__VA_ARGS__) ) \
323                    { \
324                        (dynamic_cast<T*>(object))->T:: functionname
325
326        /*
327            JUST ADD THE FUNCTION ARGUMENTS BETWEEN BOTH MACROS, ENCLOSED BY BRACKETS
328            EXAMPLE:
329
330              SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(0, myfunction, true, int myvalue, float myothervalue) <-- !!! DONT ADD A SEMICOLON HERE !!!
331                (myvalue, myothervalue)
332              SUPER_FUNCTION_GLOBAL_DECLARATION_PART2
333        */
334
335        #define SUPER_FUNCTION_GLOBAL_DECLARATION_PART2 \
336                                                        ; \
337                    } \
338            };
339
340        #define SUPER_CALL_ARGUMENTSfalse(...) OrxonoxClass* object
341        #define SUPER_CALL_ARGUMENTS0(...)     OrxonoxClass* object
342        #define SUPER_CALL_ARGUMENTStrue(...) OrxonoxClass* object, __VA_ARGS__
343        #define SUPER_CALL_ARGUMENTS1(...)    OrxonoxClass* object, __VA_ARGS__
344
345
346    /*
347    //// COMMENTS ABOUT THE MACRO ////
348
349        // Partially specialized template (templatehack not yet specialized, this
350        // will be done by the real condition in the header-file of the super-function)
351        // Only used as fallback
352        template <class T, int templatehack1, int templatehack2>
353        struct SuperFunctionCondition<functionnumber, T, templatehack1, templatehack2>
354        {
355            // If this function gets called, the header-file of the super function is not
356            // included, so this fallback template (templatehack not specialized) is used
357            static void check()
358            {
359                // Calls the condition-check of the next super-function (functionnumber + 1)
360                SuperFunctionCondition<functionnumber + 1, T, templatehack1, templatehack2>::check();
361            }
362        };
363
364        // Initializes the SuperFunctionCaller-pointer with zero.
365        template <class T>
366        struct SuperFunctionInitialization<functionnumber, T>
367        {
368            static void initialize(ClassIdentifier<T>* identifier)
369            {
370                identifier->superFunctionCaller_##functionname##_ = 0;
371
372                // Calls the initialization of the next super-function (functionnumber + 1)
373                SuperFunctionInitialization<functionnumber + 1, T>::initialize(identifier);
374            }
375        };
376
377        // Deletes the SuperFunctionCaller.
378        template <class T>
379        struct SuperFunctionDestruction<functionnumber, T>
380        {
381            static void destroy(ClassIdentifier<T>* identifier)
382            {
383                if (identifier->superFunctionCaller_##functionname##_)
384                    delete identifier->superFunctionCaller_##functionname##_;
385
386                // Calls the destruction of the next super-function (functionnumber + 1)
387                SuperFunctionDestruction<functionnumber + 1, T>::destroy(identifier);
388            }
389        };
390
391        // Baseclass of the super-function caller. The real call will be done by a
392        // templatized subclass through the virtual () operator.
393        class _CoreExport SuperFunctionCaller_##functionname
394        {
395            public:
396                virtual void operator()( SUPER_CALL_ARGUMENTS##hasarguments(__VA_ARGS__) ) = 0;
397                virtual ~SuperFunctionCaller_##functionname () {}
398        };
399
400        // The real super-function caller: Calls T::functionname()
401        // T should be the parent, but this will be done by the spezialized condition template
402        template <class T>
403        class SuperFunctionClassCaller_##functionname : public SuperFunctionCaller_##functionname
404        {
405            public:
406                // @brief Calls the function.
407                // @param object The object to call the function on
408                // @param ... The arguments of the function
409                inline void operator()( SUPER_CALL_ARGUMENTS##hasarguments(__VA_ARGS__) )
410                {
411                    (dynamic_cast<T*>(object))->T:: functionname ( Call the function with it's arguments );
412                }
413        }
414    */
415
416
417    //// Execute the code for each super-function ////
418
419        // (2/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
420        SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(0, XMLPort, true, Element& xmlelement, XMLPort::Mode mode)
421            (xmlelement, mode)
422        SUPER_FUNCTION_GLOBAL_DECLARATION_PART2;
423
424        SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(1, tick, true, float dt)
425            (dt)
426        SUPER_FUNCTION_GLOBAL_DECLARATION_PART2;
427
428        SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(2, changedActivity, false)
429            ()
430        SUPER_FUNCTION_GLOBAL_DECLARATION_PART2;
431
432        SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(3, changedVisibility, false)
433            ()
434        SUPER_FUNCTION_GLOBAL_DECLARATION_PART2;
435        // (2/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
436
437}
438
439#else /* _Super_H__ */
440  #ifdef SUPER_INTRUSIVE_DECLARATION_INCLUDE
441
442//////////////////////////////////////////////////////////////////////////
443// This code gets included within the declaration of ClassIdentifier<T> //
444//////////////////////////////////////////////////////////////////////////
445
446//// Common code ////
447
448    private:
449
450        template <int functionnumber, class TT, int templatehack1, int templatehack2>
451        friend struct SuperFunctionCondition;
452
453        // Creates the super-function-callers by calling the first SuperFunctionCondition check
454        // This get's called within the initialization of an Identifier
455        virtual void createSuperFunctionCaller() const
456        {
457            SuperFunctionCondition<0, T, 0, 0>::check();
458        }
459
460
461//// Function-specific code ////
462
463    public:
464        /**
465            @brief Adds a pointer to the SuperFunctionCaller as a member of ClassIdentifier.
466            @param functionname The name of the super-function
467        */
468        #ifndef SUPER_INTRUSIVE_DECLARATION
469          #define SUPER_INTRUSIVE_DECLARATION(functionname) \
470            SuperFunctionCaller_##functionname * superFunctionCaller_##functionname##_
471        #endif
472
473
474//// Execute the code for each super-function ////
475
476    // (3/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
477    SUPER_INTRUSIVE_DECLARATION(XMLPort);
478    SUPER_INTRUSIVE_DECLARATION(tick);
479    SUPER_INTRUSIVE_DECLARATION(changedActivity);
480    SUPER_INTRUSIVE_DECLARATION(changedVisibility);
481    // (3/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
482
483
484    #undef SUPER_INTRUSIVE_DECLARATION_INCLUDE
485  #endif /* SUPER_INTRUSIVE_DECLARATION_INCLUDE */
486#endif /* _Super_H__ */
Note: See TracBrowser for help on using the repository browser.