[682] | 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 | |
---|
[497] | 28 | /*! |
---|
| 29 | @file ConfigValueContainer.h |
---|
| 30 | @brief Definition of the ConfigValueContainer class. |
---|
| 31 | |
---|
| 32 | The ConfigValueContainer class contains all needed informations about a configurable variable: |
---|
| 33 | - the name of the variable |
---|
| 34 | - the name of the class the variable belongs to |
---|
| 35 | - the default value |
---|
| 36 | - the user-specified value |
---|
| 37 | - a pointer to the entry in the config-file |
---|
| 38 | |
---|
| 39 | This is needed to assign the configured values to all newly created objects. |
---|
| 40 | */ |
---|
| 41 | |
---|
| 42 | #ifndef _ConfigValueContainer_H__ |
---|
| 43 | #define _ConfigValueContainer_H__ |
---|
| 44 | |
---|
| 45 | #include <string> |
---|
| 46 | #include <list> |
---|
| 47 | |
---|
[682] | 48 | #include "CorePrereqs.h" |
---|
| 49 | |
---|
[497] | 50 | #include "OgreVector2.h" |
---|
| 51 | #include "OgreVector3.h" |
---|
| 52 | #include "OgreColourValue.h" |
---|
| 53 | |
---|
| 54 | namespace orxonox |
---|
| 55 | { |
---|
| 56 | //! The ConfigValuecontainer contains all needed informations about a configurable variable. |
---|
| 57 | /** |
---|
| 58 | The ConfigValueContainer class contains all needed informations about a configurable variable: |
---|
| 59 | - the name of the variable |
---|
| 60 | - the name of the class the variable belongs to |
---|
| 61 | - the default value |
---|
| 62 | - the user-specified value |
---|
| 63 | - a pointer to the entry in the config-file |
---|
| 64 | |
---|
| 65 | This is needed to assign the configured values to all newly created objects. |
---|
| 66 | |
---|
| 67 | The container searches for the entry in the config file. |
---|
| 68 | If there is an entry, it parses the specified value and assigns it to the variable of the right type. |
---|
| 69 | If there is no entry, it adds the entry with the default-value to the section of the variables class. |
---|
| 70 | If there is no section, the section and the entry are added to the end of the config-file. |
---|
| 71 | */ |
---|
[682] | 72 | class _CoreExport ConfigValueContainer |
---|
[497] | 73 | { |
---|
| 74 | public: |
---|
| 75 | ConfigValueContainer(const std::string& classname, const std::string& varname, int defvalue); |
---|
[667] | 76 | ConfigValueContainer(const std::string& classname, const std::string& varname, unsigned int defvalue); |
---|
| 77 | ConfigValueContainer(const std::string& classname, const std::string& varname, char defvalue); |
---|
| 78 | ConfigValueContainer(const std::string& classname, const std::string& varname, unsigned char defvalue); |
---|
| 79 | ConfigValueContainer(const std::string& classname, const std::string& varname, float defvalue); |
---|
[497] | 80 | ConfigValueContainer(const std::string& classname, const std::string& varname, double defvalue); |
---|
| 81 | ConfigValueContainer(const std::string& classname, const std::string& varname, bool defvalue); |
---|
[667] | 82 | ConfigValueContainer(const std::string& classname, const std::string& varname, const std::string& defvalue); |
---|
[497] | 83 | ConfigValueContainer(const std::string& classname, const std::string& varname, const char* defvalue); |
---|
| 84 | ConfigValueContainer(const std::string& classname, const std::string& varname, Ogre::Vector2 defvalue); |
---|
| 85 | ConfigValueContainer(const std::string& classname, const std::string& varname, Ogre::Vector3 defvalue); |
---|
| 86 | ConfigValueContainer(const std::string& classname, const std::string& varname, Ogre::ColourValue defvalue); |
---|
| 87 | |
---|
[667] | 88 | void setConfigFileEntyToDefault(); |
---|
[497] | 89 | void searchConfigFileLine(); |
---|
[667] | 90 | std::string parseValueString(bool bStripped = true); |
---|
[497] | 91 | |
---|
| 92 | static std::string getStrippedLine(const std::string& line); |
---|
| 93 | static bool isEmpty(const std::string& line); |
---|
| 94 | static bool isComment(const std::string& line); |
---|
| 95 | static void readConfigFile(const std::string& filename); |
---|
| 96 | static void writeConfigFile(const std::string& filename); |
---|
| 97 | |
---|
[667] | 98 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
[497] | 99 | inline int getValue(int value) { return this->value_.value_int_; } |
---|
[667] | 100 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
| 101 | inline unsigned int getValue(unsigned int value) { return this->value_.value_uint_; } |
---|
| 102 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
| 103 | inline char getValue(char value) { return this->value_.value_char_; } |
---|
| 104 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
| 105 | inline unsigned char getValue(unsigned char value) { return this->value_.value_uchar_; } |
---|
| 106 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
| 107 | inline float getValue(float value) { return this->value_.value_float_; } |
---|
| 108 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
[497] | 109 | inline double getValue(double value) { return this->value_.value_double_; } |
---|
[667] | 110 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
[497] | 111 | inline bool getValue(bool value) { return this->value_.value_bool_; } |
---|
[667] | 112 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
| 113 | inline const std::string& getValue(const std::string& value) { return this->value_string_; } |
---|
| 114 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
| 115 | inline const char* getValue(const char* value) { return this->value_string_.c_str(); } |
---|
| 116 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
[497] | 117 | inline Ogre::Vector2 getValue(const Ogre::Vector2& value) { return this->value_vector2_; } |
---|
[667] | 118 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
[497] | 119 | inline Ogre::Vector3 getValue(const Ogre::Vector3& value) { return this->value_vector3_; } |
---|
[667] | 120 | /** @returns the value. @param value This is only needed to determine the right type. */ |
---|
[497] | 121 | inline Ogre::ColourValue getValue(const Ogre::ColourValue& value) { return this->value_colourvalue_; } |
---|
| 122 | |
---|
| 123 | private: |
---|
| 124 | std::string classname_; //!< The name of the class the variable belongs to |
---|
| 125 | std::string varname_; //!< The name of the variable |
---|
[667] | 126 | std::string defvalueString_; //!< The string of the default-variable |
---|
[497] | 127 | |
---|
| 128 | union MultiType |
---|
| 129 | { |
---|
| 130 | int value_int_; //!< The value, if the variable is of the type int |
---|
[667] | 131 | unsigned int value_uint_; //!< The value, if the variable is of the type unsigned int |
---|
| 132 | char value_char_; //!< The value, if the variable is of the type char |
---|
| 133 | unsigned char value_uchar_; //!< The value, if the variable is of the type unsigned char |
---|
| 134 | float value_float_; //!< The value, if the variable is of the type float |
---|
[497] | 135 | double value_double_; //!< The value, if the variable is of the type double |
---|
| 136 | bool value_bool_; //!< The value, if the variable is of the type bool |
---|
[667] | 137 | } value_; //!< The value of the variable |
---|
[497] | 138 | |
---|
| 139 | std::string value_string_; //!< The value, if the variable is of the type string |
---|
| 140 | Ogre::Vector2 value_vector2_; //!< The value, if the variable is of the type Vector2 |
---|
| 141 | Ogre::Vector3 value_vector3_; //!< The value, if the variable is of the type Vector3 |
---|
| 142 | Ogre::ColourValue value_colourvalue_; //!< The value, if the variable is of the type ColourValue |
---|
| 143 | |
---|
| 144 | std::list<std::string>::iterator configFileLine_; //!< An iterator, pointing to the entry of the variable in the config-file |
---|
| 145 | static std::list<std::string>* configFileLines_s; //!< A list, containing all entrys in the config-file |
---|
| 146 | static bool readConfigFile_s; //!< True if the config-file is read and stored in the list |
---|
[667] | 147 | |
---|
| 148 | enum VariableType |
---|
| 149 | { |
---|
| 150 | Int, |
---|
| 151 | uInt, |
---|
| 152 | Char, |
---|
| 153 | uChar, |
---|
| 154 | Float, |
---|
| 155 | Double, |
---|
| 156 | Bool, |
---|
| 157 | ConstChar, |
---|
| 158 | String, |
---|
| 159 | Vector2, |
---|
| 160 | Vector3, |
---|
| 161 | ColourValue |
---|
| 162 | } type_; //!< The type of the variable |
---|
[497] | 163 | }; |
---|
| 164 | } |
---|
| 165 | |
---|
[673] | 166 | #endif /* _ConfigValueContainer_H__ */ |
---|