Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/CoreIncludes.h @ 11392

Last change on this file since 11392 was 11099, checked in by muemart, 9 years ago

Fix loads of doxygen warnings and other documentation issues

  • Property svn:eol-style set to native
File size: 8.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    @defgroup Factory RegisterObject() and RegisterClass()
31    @ingroup Object
32*/
33
34/**
35    @file
36    @ingroup Object Factory Class Identifier
37    @brief Defines several very important macros used to register objects, register classes, and to work with identifiers.
38
39    Every class needs the @c RegisterObject(class) macro in its constructor.
40
41    To register @a class in the class-hierarchy, use the @c RegisterClass(class) macro outside of the class implementation,
42    so it gets executed statically before @c main(). If you don't want @a class to be loadable, but still register it, call
43    @c RegisterUnloadableClass(class).
44
45    Abstract classes are registered with @c RegisterAbstractClass(class). For abstract classes, the inheritance must be
46    defined manually with @c RegisterAbstractClass(class).inheritsFrom(Class(parent)). Multiple parent classes can be defined
47    by chaining the above command.
48
49    Example:
50    @code
51    // register MyClass
52    RegisterClass(MyClass);
53
54    // Constructor:
55    MyClass::MyClass()
56    {
57        // Register the object in the Identifier of MyClass
58        RegisterObject(MyClass);
59    }
60    @endcode
61
62    This file also defines a number of other useful macros, like, for example, @c Class(class) which
63    returns the @ref orxonox::Identifier "Identifier" of @a class, or @c ClassByString("class") which
64    returns the Identifier of a class with name @a "class".
65
66    Example:
67    @code
68    // Assigns the Identifier of MyClass
69    Identifier* identifier = Class(MyClass);
70    @endcode
71    @code
72    // Assigns the Identifier of a class named "MyClass"
73    Identifier* identifier = ClassByString("MyClass");
74    @endcode
75*/
76
77#ifndef _CoreIncludes_H__
78#define _CoreIncludes_H__
79
80#include "CorePrereqs.h"
81
82#include "util/Output.h"
83#include "class/IdentifierManager.h"
84#include "object/ClassFactory.h"
85#include "object/ObjectList.h"
86#include "module/StaticallyInitializedInstance.h"
87
88// resolve macro conflict on windows
89#if defined(ORXONOX_PLATFORM_WINDOWS)
90#   define WIN32_LEAN_AND_MEAN
91#   include <windows.h>
92#   undef RegisterClass
93#endif
94
95
96/**
97    @brief Registers the class in the framework.
98    @param ClassName The name of the class
99*/
100#define RegisterClass(ClassName) \
101    RegisterClassWithFactory(ClassName, new orxonox::ClassFactoryWithContext<ClassName>(), true)
102
103/**
104    @brief Registers the class in the framework (for classes without arguments in their constructor).
105    @param ClassName The name of the class
106*/
107#define RegisterClassNoArgs(ClassName) \
108    RegisterClassWithFactory(ClassName, new orxonox::ClassFactoryNoArgs<ClassName>(), true)
109
110/**
111    @brief Registers the class in the framework (for classes which should not be loaded through XML).
112    @param ClassName The name of the class
113*/
114#define RegisterUnloadableClass(ClassName) \
115    RegisterClassWithFactory(ClassName, new orxonox::ClassFactoryWithContext<ClassName>(), false)
116
117/**
118    @brief Registers an abstract class in the framework. Should be used in combination with inheritsFrom(base-class-identifier).
119    @param ClassName The name of the class
120*/
121#define RegisterAbstractClass(ClassName) \
122    RegisterClassWithFactory(ClassName, static_cast<ClassFactory<ClassName>*>(nullptr), false)
123
124/**
125    @brief Registers the class in the framework with a given Factory.
126    @param ClassName The name of the class
127    @param FactoryInstance An instance of a factory that can create the class
128    @param bLoadable Whether the class is allowed to be loaded through XML
129*/
130#define RegisterClassWithFactory(ClassName, FactoryInstance, bLoadable) \
131    orxonox::SI_I& _##ClassName##Identifier = (*new orxonox::SI_I(orxonox::registerClass<ClassName>(#ClassName, FactoryInstance, bLoadable)))
132
133/**
134    @brief Registers a newly created object in the framework. Has to be called at the beginning of the constructor of @a ClassName.
135    @param ClassName The name of the class
136*/
137#define RegisterObject(ClassName) \
138    if (ClassIdentifier<ClassName>::getIdentifier()->initializeObject(this)) \
139        return; \
140    else \
141        ((void)0)
142
143/**
144    @brief Returns the Identifier of the given class.
145    @param ClassName The name of the class
146*/
147#define Class(ClassName) \
148    orxonox::ClassIdentifier<ClassName>::getIdentifier()
149
150
151namespace orxonox
152{
153    /**
154     * @brief Overload of registerClass() which determines T implicitly by the template argument of the ClassFactory.
155     */
156    template <class T>
157    inline Identifier* registerClass(const std::string& name, ClassFactory<T>* factory, bool bLoadable = true)
158    {
159        return registerClass<T>(name, static_cast<Factory*>(factory), bLoadable);
160    }
161
162    /**
163     * @brief Registers a class in the framework.
164     * @param name The name of the class
165     * @param factory The factory which is able to create new instances of this class
166     * @param bLoadable Whether the class is allowed to be loaded through XML
167     */
168    template <class T>
169    inline Identifier* registerClass(const std::string& name, Factory* factory, bool bLoadable = true)
170    {
171        return new ClassIdentifier<T>(name, factory, bLoadable);
172    }
173
174    /**
175        @brief Returns the Identifier with a given name.
176        @param name The name of the class
177    */
178    inline Identifier* ClassByString(const std::string& name)
179    {
180        return IdentifierManager::getInstance().getIdentifierByString(name);
181    }
182
183    /**
184        @brief Returns the Identifier with a given lowercase name.
185        @param name The lowercase name of the class
186    */
187    inline Identifier* ClassByLowercaseString(const std::string& name)
188    {
189        return IdentifierManager::getInstance().getIdentifierByLowercaseString(name);
190    }
191
192    /**
193        @brief Returns the Identifier with a given network ID.
194        @param id The network ID of the class
195    */
196    inline Identifier* ClassByID(uint32_t id)
197    {
198        return IdentifierManager::getInstance().getIdentifierByID(id);
199    }
200
201    /**
202        @brief Returns the Identifier with a given 'this' pointer.
203        @note This of course only works with Identifiables.
204              The only use is in conjunction with macros that don't know the class type.
205        @param p Pointer to an Identifiable
206    */
207    template <class T>
208    inline Identifier* ClassByObjectType(const T* p)
209    {
210        return ClassIdentifier<T>::getIdentifier();
211    }
212
213
214
215
216    /**
217     * The static initializer stores the parent classes of this identifier. The corresponding identifiers are later loaded. This prevents identifiers from
218     * being used before they are completely initialized.
219     */
220    class _CoreExport StaticallyInitializedIdentifier : public StaticallyInitializedInstance
221    {
222        template <class T>
223        struct InheritsFromClass : public Identifier::InheritsFrom
224        {
225            virtual Identifier* getParent() const override { return Class(T); }
226        };
227
228        public:
229            StaticallyInitializedIdentifier(Identifier* identifier)
230                : StaticallyInitializedInstance(StaticInitialization::IDENTIFIER)
231                , identifier_(identifier)
232            {}
233            ~StaticallyInitializedIdentifier() { identifier_->destroy(); }
234
235            virtual void load() override
236            {
237                IdentifierManager::getInstance().addIdentifier(this->identifier_);
238            }
239
240            virtual void unload() override
241            {
242                IdentifierManager::getInstance().removeIdentifier(this->identifier_);
243            }
244
245            inline Identifier& getIdentifier()
246                { return *this->identifier_; }
247
248            template <class T>
249            inline StaticallyInitializedIdentifier& inheritsFrom()
250                { this->identifier_->inheritsFrom(new InheritsFromClass<T>()); return *this; }
251
252            inline StaticallyInitializedIdentifier& virtualBase()
253                { this->identifier_->setVirtualBase(true); return *this; }
254
255        private:
256            Identifier* identifier_;
257    };
258
259    typedef StaticallyInitializedIdentifier SI_I;
260}
261
262#endif /* _CoreIncludes_H__ */
Note: See TracBrowser for help on using the repository browser.