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 macros for Identifiers |
---|
32 | |
---|
33 | Every class needs the RegisterObject(class) macro in its constructor. If the class is an interface |
---|
34 | or the BaseObject itself, it needs the macro RegisterRootObject(class) instead. |
---|
35 | |
---|
36 | To allow the object being created through the factory, use the CreateFactory(class) macro outside |
---|
37 | the of the class implementation, so it gets executed before main(). |
---|
38 | */ |
---|
39 | |
---|
40 | #ifndef _CoreIncludes_H__ |
---|
41 | #define _CoreIncludes_H__ |
---|
42 | |
---|
43 | #include "CorePrereqs.h" |
---|
44 | |
---|
45 | #include "util/Debug.h" |
---|
46 | #include "Identifier.h" |
---|
47 | #include "SubclassIdentifier.h" |
---|
48 | #include "ClassFactory.h" |
---|
49 | #include "ObjectList.h" |
---|
50 | |
---|
51 | |
---|
52 | /** |
---|
53 | @brief Intern macro, containing the common parts of RegisterObject and RegisterRootObject. |
---|
54 | @param ClassName The name of the class |
---|
55 | @param bRootClass True if the class is directly derived from OrxonoxClass |
---|
56 | */ |
---|
57 | #define InternRegisterObject(ClassName, bRootClass) \ |
---|
58 | if (ClassIdentifier<ClassName>::getIdentifier(#ClassName)->initialiseObject(this, #ClassName, bRootClass)) \ |
---|
59 | return; \ |
---|
60 | else \ |
---|
61 | ((void)0) |
---|
62 | |
---|
63 | /** |
---|
64 | @brief RegisterObject - with and without debug output. |
---|
65 | @param ClassName The name of the class |
---|
66 | */ |
---|
67 | #define RegisterObject(ClassName) \ |
---|
68 | InternRegisterObject(ClassName, false) |
---|
69 | |
---|
70 | /** |
---|
71 | @brief RegisterRootObject - with and without debug output. |
---|
72 | @param ClassName The name of the class |
---|
73 | */ |
---|
74 | #define RegisterRootObject(ClassName) \ |
---|
75 | InternRegisterObject(ClassName, true) |
---|
76 | |
---|
77 | /** |
---|
78 | @brief Creates the Factory. |
---|
79 | @param ClassName The name of the class |
---|
80 | */ |
---|
81 | #define CreateFactory(ClassName) \ |
---|
82 | Factory* _##ClassName##Factory = new orxonox::ClassFactory<ClassName>(#ClassName, true) |
---|
83 | |
---|
84 | /** |
---|
85 | @brief Creates the Factory for classes which should not be loaded through XML. |
---|
86 | @param ClassName The name of the class |
---|
87 | */ |
---|
88 | #define CreateUnloadableFactory(ClassName) \ |
---|
89 | Factory* _##ClassName##Factory = new orxonox::ClassFactory<ClassName>(#ClassName, false) |
---|
90 | |
---|
91 | /** |
---|
92 | @brief Returns the Identifier of the given class. |
---|
93 | @param ClassName The name of the class |
---|
94 | */ |
---|
95 | #define Class(ClassName) \ |
---|
96 | orxonox::ClassIdentifier<ClassName>::getIdentifier() |
---|
97 | |
---|
98 | |
---|
99 | namespace orxonox |
---|
100 | { |
---|
101 | /** |
---|
102 | @brief Returns the Identifier with a given name. |
---|
103 | @param String The name of the class |
---|
104 | */ |
---|
105 | inline Identifier* ClassByString(const std::string& name) |
---|
106 | { |
---|
107 | return Identifier::getIdentifierByString(name); |
---|
108 | } |
---|
109 | |
---|
110 | /** |
---|
111 | @brief Returns the Identifier with a given lowercase name. |
---|
112 | @param String The lowercase name of the class |
---|
113 | */ |
---|
114 | inline Identifier* ClassByLowercaseString(const std::string& name) |
---|
115 | { |
---|
116 | return Identifier::getIdentifierByLowercaseString(name); |
---|
117 | } |
---|
118 | |
---|
119 | /** |
---|
120 | @brief Returns the Identifier with a given network ID. |
---|
121 | @param networkID The network ID of the class |
---|
122 | */ |
---|
123 | inline Identifier* ClassByID(uint32_t id) |
---|
124 | { |
---|
125 | return Identifier::getIdentifierByID(id); |
---|
126 | } |
---|
127 | |
---|
128 | /** |
---|
129 | @brief Returns the Identifier with a given 'this' pointer. |
---|
130 | @note This of course only works with OrxonoxClasses. |
---|
131 | The only use is in conjunction with macros that don't know the class type. |
---|
132 | @param Pointer to an OrxonoxClass |
---|
133 | */ |
---|
134 | template <class T> |
---|
135 | inline Identifier* ClassByObjectType(const T* object) |
---|
136 | { |
---|
137 | return ClassIdentifier<T>::getIdentifier(); |
---|
138 | } |
---|
139 | } |
---|
140 | |
---|
141 | #endif /* _CoreIncludes_H__ */ |
---|