Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/objecthierarchy2/src/core/Super.h @ 2343

Last change on this file since 2343 was 2257, checked in by landauf, 16 years ago

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