| 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 |  *      Reto Grieder | 
|---|
| 26 |  * | 
|---|
| 27 |  */ | 
|---|
| 28 |  | 
|---|
| 29 | /** | 
|---|
| 30 |     @file Core.cc | 
|---|
| 31 |     @brief Implementation of the Core class. | 
|---|
| 32 | */ | 
|---|
| 33 |  | 
|---|
| 34 | #include "Core.h" | 
|---|
| 35 | #include <cassert> | 
|---|
| 36 | #include "Language.h" | 
|---|
| 37 | #include "CoreIncludes.h" | 
|---|
| 38 | #include "ConfigValueIncludes.h" | 
|---|
| 39 | //#include "input/InputManager.h" | 
|---|
| 40 | //#include "TclThreadManager.h" | 
|---|
| 41 |  | 
|---|
| 42 | namespace orxonox | 
|---|
| 43 | { | 
|---|
| 44 |     /** | 
|---|
| 45 |         @brief Constructor: Registers the object and sets the config-values. | 
|---|
| 46 |         @param A reference to a global variable, used to avoid an infinite recursion in getSoftDebugLevel() | 
|---|
| 47 |     */ | 
|---|
| 48 |     Core::Core() | 
|---|
| 49 |     { | 
|---|
| 50 |         RegisterRootObject(Core); | 
|---|
| 51 |         this->setConfigValues(); | 
|---|
| 52 |         isCreatingCoreSettings() = false; | 
|---|
| 53 |     } | 
|---|
| 54 |  | 
|---|
| 55 |     /** | 
|---|
| 56 |         @brief Sets the bool to true to avoid static functions accessing a deleted object. | 
|---|
| 57 |     */ | 
|---|
| 58 |     Core::~Core() | 
|---|
| 59 |     { | 
|---|
| 60 |         isCreatingCoreSettings() = true; | 
|---|
| 61 |     } | 
|---|
| 62 |  | 
|---|
| 63 |     /** | 
|---|
| 64 |         @brief Returns true if the Core instance is not yet ready and the static functions have to return a default value. | 
|---|
| 65 |     */ | 
|---|
| 66 |     bool& Core::isCreatingCoreSettings() | 
|---|
| 67 |     { | 
|---|
| 68 |         static bool bCreatingCoreSettings = true; | 
|---|
| 69 |         return bCreatingCoreSettings; | 
|---|
| 70 |     } | 
|---|
| 71 |  | 
|---|
| 72 |     /** | 
|---|
| 73 |         @brief Returns a unique instance of Core. | 
|---|
| 74 |         @return The instance | 
|---|
| 75 |     */ | 
|---|
| 76 |     Core& Core::getInstance() | 
|---|
| 77 |     { | 
|---|
| 78 |         // If bCreatingSoftDebugLevelObject is true, we're just about to create an instance of the DebugLevel class | 
|---|
| 79 |         //if (Core::isCreatingCoreSettings()) | 
|---|
| 80 |         //{ | 
|---|
| 81 |         //    isCreatingCoreSettings() = false; | 
|---|
| 82 |         //    //instance.setConfigValues(); | 
|---|
| 83 |         //} | 
|---|
| 84 |  | 
|---|
| 85 |         static bool firstTime = true; | 
|---|
| 86 |         if (firstTime) | 
|---|
| 87 |             isCreatingCoreSettings() = true; | 
|---|
| 88 |  | 
|---|
| 89 |         static Core instance; | 
|---|
| 90 |         return instance; | 
|---|
| 91 |     } | 
|---|
| 92 |  | 
|---|
| 93 |     /** | 
|---|
| 94 |         @brief Function to collect the SetConfigValue-macro calls. | 
|---|
| 95 |     */ | 
|---|
| 96 |     void Core::setConfigValues() | 
|---|
| 97 |     { | 
|---|
| 98 |         SetConfigValue(softDebugLevelConsole_, 3).description("The maximal level of debug output shown in the console").callback(this, &Core::debugLevelChanged); | 
|---|
| 99 |         SetConfigValue(softDebugLevelLogfile_, 3).description("The maximal level of debug output shown in the logfile").callback(this, &Core::debugLevelChanged); | 
|---|
| 100 |         SetConfigValue(softDebugLevelShell_, 1).description("The maximal level of debug output shown in the ingame shell").callback(this, &Core::debugLevelChanged); | 
|---|
| 101 |         SetConfigValue(language_, Language::getLanguage().defaultLanguage_).description("The language of the ingame text").callback(this, &Core::languageChanged); | 
|---|
| 102 |     } | 
|---|
| 103 |  | 
|---|
| 104 |     /** | 
|---|
| 105 |         @brief Callback function if the debug level has changed. | 
|---|
| 106 |     */ | 
|---|
| 107 |     void Core::debugLevelChanged() | 
|---|
| 108 |     { | 
|---|
| 109 |         // softDebugLevel_ is the maximum of the 3 variables | 
|---|
| 110 |         this->softDebugLevel_ = this->softDebugLevelConsole_; | 
|---|
| 111 |         if (this->softDebugLevelLogfile_ > this->softDebugLevel_) | 
|---|
| 112 |             this->softDebugLevel_ = this->softDebugLevelLogfile_; | 
|---|
| 113 |         if (this->softDebugLevelShell_ > this->softDebugLevel_) | 
|---|
| 114 |             this->softDebugLevel_ = this->softDebugLevelShell_; | 
|---|
| 115 |  | 
|---|
| 116 |         OutputHandler::setSoftDebugLevel(OutputHandler::LD_All,     this->softDebugLevel_); | 
|---|
| 117 |         OutputHandler::setSoftDebugLevel(OutputHandler::LD_Console, this->softDebugLevelConsole_); | 
|---|
| 118 |         OutputHandler::setSoftDebugLevel(OutputHandler::LD_Logfile, this->softDebugLevelLogfile_); | 
|---|
| 119 |         OutputHandler::setSoftDebugLevel(OutputHandler::LD_Shell,   this->softDebugLevelShell_); | 
|---|
| 120 |     } | 
|---|
| 121 |  | 
|---|
| 122 |     /** | 
|---|
| 123 |         @brief Callback function if the language has changed. | 
|---|
| 124 |     */ | 
|---|
| 125 |     void Core::languageChanged() | 
|---|
| 126 |     { | 
|---|
| 127 |         // Read the translation file after the language was configured | 
|---|
| 128 |         Language::getLanguage().readTranslatedLanguageFile(); | 
|---|
| 129 |     } | 
|---|
| 130 |  | 
|---|
| 131 |     /** | 
|---|
| 132 |         @brief Returns the softDebugLevel for the given device (returns a default-value if the class ist right about to be created). | 
|---|
| 133 |         @param device The device | 
|---|
| 134 |         @return The softDebugLevel | 
|---|
| 135 |     */ | 
|---|
| 136 |     int Core::getSoftDebugLevel(OutputHandler::OutputDevice device) | 
|---|
| 137 |     { | 
|---|
| 138 |         if (!Core::isCreatingCoreSettings()) | 
|---|
| 139 |         { | 
|---|
| 140 |             switch (device) | 
|---|
| 141 |             { | 
|---|
| 142 |             case OutputHandler::LD_All: | 
|---|
| 143 |                 return Core::getInstance().softDebugLevel_; | 
|---|
| 144 |             case OutputHandler::LD_Console: | 
|---|
| 145 |                 return Core::getInstance().softDebugLevelConsole_; | 
|---|
| 146 |             case OutputHandler::LD_Logfile: | 
|---|
| 147 |                 return Core::getInstance().softDebugLevelLogfile_; | 
|---|
| 148 |             case OutputHandler::LD_Shell: | 
|---|
| 149 |                 return Core::getInstance().softDebugLevelShell_; | 
|---|
| 150 |             default: | 
|---|
| 151 |                 assert(0); | 
|---|
| 152 |             } | 
|---|
| 153 |         } | 
|---|
| 154 |  | 
|---|
| 155 |         // Return a constant value while we're creating the object | 
|---|
| 156 |         return 2; | 
|---|
| 157 |     } | 
|---|
| 158 |  | 
|---|
| 159 |      /** | 
|---|
| 160 |         @brief Sets the softDebugLevel for the given device. Please use this only temporary and restore the value afterwards, as it overrides the configured value. | 
|---|
| 161 |         @param device The device | 
|---|
| 162 |         @param level The level | 
|---|
| 163 |     */ | 
|---|
| 164 |      void Core::setSoftDebugLevel(OutputHandler::OutputDevice device, int level) | 
|---|
| 165 |      { | 
|---|
| 166 |         if (!Core::isCreatingCoreSettings()) | 
|---|
| 167 |         { | 
|---|
| 168 |             if (device == OutputHandler::LD_All) | 
|---|
| 169 |                 Core::getInstance().softDebugLevel_ = level; | 
|---|
| 170 |             else if (device == OutputHandler::LD_Console) | 
|---|
| 171 |                 Core::getInstance().softDebugLevelConsole_ = level; | 
|---|
| 172 |             else if (device == OutputHandler::LD_Logfile) | 
|---|
| 173 |                 Core::getInstance().softDebugLevelLogfile_ = level; | 
|---|
| 174 |             else if (device == OutputHandler::LD_Shell) | 
|---|
| 175 |                 Core::getInstance().softDebugLevelShell_ = level; | 
|---|
| 176 |  | 
|---|
| 177 |             OutputHandler::setSoftDebugLevel(device, level); | 
|---|
| 178 |         } | 
|---|
| 179 |      } | 
|---|
| 180 |  | 
|---|
| 181 |     /** | 
|---|
| 182 |         @brief Returns the configured language. | 
|---|
| 183 |     */ | 
|---|
| 184 |     const std::string& Core::getLanguage() | 
|---|
| 185 |     { | 
|---|
| 186 |         if (!Core::isCreatingCoreSettings()) | 
|---|
| 187 |             return Core::getInstance().language_; | 
|---|
| 188 |  | 
|---|
| 189 |         return Language::getLanguage().defaultLanguage_; | 
|---|
| 190 |     } | 
|---|
| 191 |  | 
|---|
| 192 |     /** | 
|---|
| 193 |         @brief Sets the language in the config-file back to the default. | 
|---|
| 194 |     */ | 
|---|
| 195 |     void Core::resetLanguage() | 
|---|
| 196 |     { | 
|---|
| 197 |         Core::getInstance().resetLanguageIntern(); | 
|---|
| 198 |     } | 
|---|
| 199 |  | 
|---|
| 200 |     /** | 
|---|
| 201 |         @brief Sets the language in the config-file back to the default. | 
|---|
| 202 |     */ | 
|---|
| 203 |     void Core::resetLanguageIntern() | 
|---|
| 204 |     { | 
|---|
| 205 |         ResetConfigValue(language_); | 
|---|
| 206 |     } | 
|---|
| 207 |  | 
|---|
| 208 |     ///** | 
|---|
| 209 |     //    @brief Ticks every core class in a specified sequence. Has to be called | 
|---|
| 210 |     //           every Orxonox tick! | 
|---|
| 211 |     //    @param dt Delta Time | 
|---|
| 212 |     //*/ | 
|---|
| 213 |     //void Core::tick(float dt) | 
|---|
| 214 |     //{ | 
|---|
| 215 |     //    TclThreadManager::getInstance().tick(dt); | 
|---|
| 216 |     //    InputManager::getInstance().tick(dt); | 
|---|
| 217 |     //} | 
|---|
| 218 | } | 
|---|