[859] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * |
---|
| 4 | * |
---|
| 5 | * License notice: |
---|
| 6 | * |
---|
| 7 | * This program is free software; you can redistribute it and/or |
---|
| 8 | * modify it under the terms of the GNU General Public License |
---|
| 9 | * as published by the Free Software Foundation; either version 2 |
---|
| 10 | * of the License, or (at your option) any later version. |
---|
| 11 | * |
---|
| 12 | * This program is distributed in the hope that it will be useful, |
---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 15 | * GNU General Public License for more details. |
---|
| 16 | * |
---|
| 17 | * You should have received a copy of the GNU General Public License |
---|
| 18 | * along with this program; if not, write to the Free Software |
---|
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 20 | * |
---|
| 21 | * Author: |
---|
| 22 | * Fabian 'x3n' Landau |
---|
| 23 | * Co-authors: |
---|
| 24 | * ... |
---|
| 25 | * |
---|
| 26 | */ |
---|
| 27 | |
---|
| 28 | /** |
---|
| 29 | @file CoreIncludes.h |
---|
| 30 | @brief Definition of macros and typedefs. |
---|
| 31 | |
---|
| 32 | Every class needs the RegisterObject(class) macro in its constructor. If the class is an interface |
---|
| 33 | or the BaseObject itself, it needs the macro RegisterRootObject(class) instead. |
---|
| 34 | |
---|
| 35 | To allow the object being created through the factory, use the CreateFactory(class) macro outside |
---|
| 36 | the of the class implementation, so it gets executed before main(). |
---|
| 37 | */ |
---|
| 38 | |
---|
| 39 | #ifndef _CoreIncludes_H__ |
---|
| 40 | #define _CoreIncludes_H__ |
---|
| 41 | |
---|
| 42 | #include "CorePrereqs.h" |
---|
| 43 | |
---|
| 44 | // All needed header-files |
---|
| 45 | #include "Identifier.h" |
---|
| 46 | #include "Factory.h" |
---|
| 47 | #include "ClassFactory.h" |
---|
| 48 | #include "Iterator.h" |
---|
| 49 | #include "OrxonoxClass.h" |
---|
| 50 | #include "ConfigValueContainer.h" |
---|
| 51 | #include "Debug.h" |
---|
| 52 | |
---|
| 53 | /** |
---|
| 54 | @brief Intern macro, containing the common parts of RegisterObject and RegisterRootObject. |
---|
| 55 | @param ClassName The name of the class |
---|
| 56 | @param bRootClass True if the class is directly derived from OrxonoxClass |
---|
| 57 | */ |
---|
| 58 | #define InternRegisterObject(ClassName, bRootClass) \ |
---|
| 59 | this->setIdentifier(orxonox::ClassIdentifier<ClassName>::registerClass(this->getParents(), #ClassName, bRootClass)); \ |
---|
| 60 | if (orxonox::Identifier::isCreatingHierarchy() && this->getParents()) \ |
---|
| 61 | this->getParents()->add(this->getIdentifier()); \ |
---|
| 62 | orxonox::ClassIdentifier<ClassName>::addObject(this) |
---|
| 63 | |
---|
| 64 | /** |
---|
| 65 | @brief Intern macro, containing the specific part of RegisterRootObject. |
---|
| 66 | @param ClassName The name of the class |
---|
| 67 | */ |
---|
| 68 | #define InternRegisterRootObject(ClassName) \ |
---|
| 69 | if (orxonox::Identifier::isCreatingHierarchy() && !this->getParents()) \ |
---|
| 70 | this->setParents(new orxonox::IdentifierList()); \ |
---|
| 71 | InternRegisterObject(ClassName, true) |
---|
| 72 | |
---|
| 73 | /** |
---|
| 74 | @brief RegisterObject - with and without debug output. |
---|
| 75 | @param ClassName The name of the class |
---|
| 76 | */ |
---|
| 77 | #define RegisterObject(ClassName) \ |
---|
| 78 | COUT(4) << "*** Register Object: " << #ClassName << std::endl; \ |
---|
| 79 | InternRegisterObject(ClassName, false) |
---|
| 80 | |
---|
| 81 | /** |
---|
| 82 | @brief RegisterRootObject - with and without debug output. |
---|
| 83 | @param ClassName The name of the class |
---|
| 84 | */ |
---|
| 85 | #define RegisterRootObject(ClassName) \ |
---|
| 86 | COUT(4) << "*** Register Root-Object: " << #ClassName << std::endl; \ |
---|
| 87 | InternRegisterRootObject(ClassName) |
---|
| 88 | |
---|
| 89 | /** |
---|
| 90 | @brief Exports the necessary templates in order to make them available to all libraries. |
---|
| 91 | @param ClassName The name of the Class |
---|
| 92 | @param LibraryName The name of the Library |
---|
| 93 | */ |
---|
| 94 | #define ExportClass(ClassName, LibraryName) \ |
---|
| 95 | template class _##LibraryName##Export orxonox::ClassIdentifier<ClassName>; \ |
---|
| 96 | template class _##LibraryName##Export orxonox::ObjectList<ClassName>; \ |
---|
| 97 | template class _##LibraryName##Export orxonox::ClassFactory<ClassName> |
---|
| 98 | |
---|
| 99 | /** |
---|
| 100 | @brief Exports the necessary templates in order to make them available to all libraries. |
---|
| 101 | @param ClassName The name of the Class |
---|
| 102 | @param LibraryName The name of the Library |
---|
| 103 | */ |
---|
| 104 | #define ExportAbstractClass(ClassName, LibraryName) \ |
---|
| 105 | template class _##LibraryName##Export orxonox::ClassIdentifier<ClassName>; \ |
---|
| 106 | template class _##LibraryName##Export orxonox::ObjectList<ClassName> |
---|
| 107 | |
---|
| 108 | /** |
---|
| 109 | @brief Returns the Identifier of the given class. |
---|
| 110 | @param ClassName The name of the class |
---|
| 111 | */ |
---|
| 112 | #define Class(ClassName) \ |
---|
| 113 | ClassIdentifier<ClassName>::getIdentifier() |
---|
| 114 | |
---|
| 115 | /** |
---|
| 116 | @brief Creates the entry in the Factory. |
---|
| 117 | @param ClassName The name of the class |
---|
| 118 | */ |
---|
| 119 | #define CreateFactory(ClassName) \ |
---|
| 120 | bool bCreated##ClassName##Factory = orxonox::ClassFactory<ClassName>::create(#ClassName) |
---|
| 121 | |
---|
| 122 | /** |
---|
| 123 | @brief Returns the Identifier with either a given name or a given network ID through the factory. |
---|
| 124 | @param StringOrInt The name or the network ID of the class |
---|
| 125 | */ |
---|
| 126 | #define ID(StringOrInt) \ |
---|
| 127 | orxonox::Factory::getIdentifier(StringOrInt) |
---|
| 128 | |
---|
| 129 | /** |
---|
| 130 | @brief Assigns the value, defined in the config-file, to the variable (or the default-value, if there is no entry in the file). |
---|
| 131 | @param varname The name of the variable |
---|
| 132 | @param defvalue The default-value of the variable |
---|
| 133 | */ |
---|
| 134 | #define SetConfigValue(varname, defvalue) \ |
---|
| 135 | orxonox::ConfigValueContainer* container##varname = this->getIdentifier()->getConfigValueContainer(#varname); \ |
---|
| 136 | if (!container##varname) \ |
---|
| 137 | { \ |
---|
| 138 | container##varname = new orxonox::ConfigValueContainer(this->getIdentifier()->getName(), #varname, varname = defvalue); \ |
---|
| 139 | this->getIdentifier()->setConfigValueContainer(#varname, container##varname); \ |
---|
| 140 | } \ |
---|
| 141 | container##varname->getValue(varname) |
---|
| 142 | |
---|
| 143 | /** |
---|
| 144 | @brief Sets the variable and the config-file entry back to the previously defined default-value. |
---|
| 145 | @param varname The name of the variable |
---|
| 146 | */ |
---|
| 147 | #define ResetConfigValue(varname) \ |
---|
| 148 | orxonox::ConfigValueContainer* container##varname##reset = this->getIdentifier()->getConfigValueContainer(#varname); \ |
---|
| 149 | if (container##varname##reset) \ |
---|
| 150 | { \ |
---|
| 151 | container##varname##reset->resetConfigValue(); \ |
---|
| 152 | container##varname##reset->getValue(varname); \ |
---|
| 153 | } \ |
---|
| 154 | else \ |
---|
| 155 | COUT(2) << "Warning: Couldn't reset variable " << #varname << ", corresponding container doesn't exist." << std::endl |
---|
| 156 | |
---|
| 157 | #endif /* _CoreIncludes_H__ */ |
---|