Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 9725 was 9667, checked in by landauf, 11 years ago

merged core6 back to trunk

  • Property svn:eol-style set to native
File size: 7.1 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
87// resolve macro conflict on windows
88#if defined(ORXONOX_PLATFORM_WINDOWS)
89#   include <windows.h>
90#   undef RegisterClass
91#endif
92
93
94/**
95    @brief Registers the class in the framework.
96    @param ClassName The name of the class
97*/
98#define RegisterClass(ClassName) \
99    RegisterClassWithFactory(ClassName, new orxonox::ClassFactoryWithContext<ClassName>(), true)
100
101/**
102    @brief Registers the class in the framework (for classes without arguments in their constructor).
103    @param ClassName The name of the class
104*/
105#define RegisterClassNoArgs(ClassName) \
106    RegisterClassWithFactory(ClassName, new orxonox::ClassFactoryNoArgs<ClassName>(), true)
107
108/**
109    @brief Registers the class in the framework (for classes which should not be loaded through XML).
110    @param ClassName The name of the class
111*/
112#define RegisterUnloadableClass(ClassName) \
113    RegisterClassWithFactory(ClassName, new orxonox::ClassFactoryWithContext<ClassName>(), false)
114
115/**
116    @brief Registers an abstract class in the framework.
117    @param ClassName The name of the class
118*/
119#define RegisterAbstractClass(ClassName) \
120    RegisterClassWithFactory(ClassName, static_cast<ClassFactory<ClassName>*>(NULL), false)
121
122/**
123    @brief Registers the class in the framework with a given Factory.
124    @param ClassName The name of the class
125*/
126#define RegisterClassWithFactory(ClassName, FactoryInstance, bLoadable) \
127    Identifier& _##ClassName##Identifier = orxonox::registerClass<ClassName>(#ClassName, FactoryInstance, bLoadable)
128
129/**
130    @brief Registers a newly created object in the framework. Has to be called at the beginning of the constructor of @a ClassName.
131    @param ClassName The name of the class
132*/
133#define RegisterObject(ClassName) \
134    if (ClassIdentifier<ClassName>::getIdentifier(#ClassName)->initializeObject(this)) \
135        return; \
136    else \
137        ((void)0)
138
139/**
140    @brief Returns the Identifier of the given class.
141    @param ClassName The name of the class
142*/
143#define Class(ClassName) \
144    orxonox::ClassIdentifier<ClassName>::getIdentifier()
145
146
147namespace orxonox
148{
149    /**
150     * @brief Overload of registerClass() which determines T implicitly by the template argument of the ClassFactory.
151     */
152    template <class T>
153    inline Identifier& registerClass(const std::string& name, ClassFactory<T>* factory, bool bLoadable = true)
154    {
155        return registerClass<T>(name, static_cast<Factory*>(factory), bLoadable);
156    }
157
158    /**
159     * @brief Registers a class in the framework.
160     * @param name The name of the class
161     * @param factory The factory which is able to create new instances of this class
162     * @param bLoadable Whether the class is allowed to be loaded through XML
163     */
164    template <class T>
165    inline Identifier& registerClass(const std::string& name, Factory* factory, bool bLoadable = true)
166    {
167        orxout(verbose, context::misc::factory) << "Create entry for " << name << " in Factory." << endl;
168        Identifier* identifier = ClassIdentifier<T>::getIdentifier(name);
169        identifier->setFactory(factory);
170        identifier->setLoadable(bLoadable);
171        return *identifier;
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 object Pointer to an Identifiable
206    */
207    template <class T>
208    inline Identifier* ClassByObjectType(const T*)
209    {
210        return ClassIdentifier<T>::getIdentifier();
211    }
212}
213
214#endif /* _CoreIncludes_H__ */
Note: See TracBrowser for help on using the repository browser.