/usr/include/OGRE/OgreStringConverter.h is in libogre-dev 1.7.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | /*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2011 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __StringConverter_H__
#define __StringConverter_H__
#include "OgrePrerequisites.h"
#include "OgreStringVector.h"
#include "OgreColourValue.h"
#include "OgreMath.h"
#include "OgreMatrix3.h"
#include "OgreMatrix4.h"
#include "OgreQuaternion.h"
#include "OgreVector2.h"
#include "OgreVector3.h"
#include "OgreVector4.h"
namespace Ogre {
/** \addtogroup Core
* @{
*/
/** \addtogroup General
* @{
*/
/** Class for converting the core Ogre data types to/from Strings.
@remarks
The code for converting values to and from strings is here as a separate
class to avoid coupling String to other datatypes (and vice-versa) which reduces
compilation dependency: important given how often the core types are used.
@par
This class is mainly used for parsing settings in text files. External applications
can also use it to interface with classes which use the StringInterface template
class.
@par
The String formats of each of the major types is listed with the methods. The basic types
like int and Real just use the underlying C runtime library atof and atoi family methods,
however custom types like Vector3, ColourValue and Matrix4 are also supported by this class
using custom formats.
@author
Steve Streeting
*/
class _OgreExport StringConverter
{
public:
/** Converts a Real to a String. */
static String toString(Real val, unsigned short precision = 6,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
/** Converts a Radian to a String. */
static String toString(Radian val, unsigned short precision = 6,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) )
{
return toString(val.valueAngleUnits(), precision, width, fill, flags);
}
/** Converts a Degree to a String. */
static String toString(Degree val, unsigned short precision = 6,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) )
{
return toString(val.valueAngleUnits(), precision, width, fill, flags);
}
/** Converts an int to a String. */
static String toString(int val, unsigned short width = 0,
char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
#if OGRE_ARCH_TYPE == OGRE_ARCHITECTURE_64 || OGRE_PLATFORM == OGRE_PLATFORM_APPLE || OGRE_PLATFORM == OGRE_PLATFORM_IPHONE
/** Converts an unsigned int to a String. */
static String toString(unsigned int val,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
/** Converts a size_t to a String. */
static String toString(size_t val,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
#if OGRE_COMPILER == OGRE_COMPILER_MSVC
/** Converts an unsigned long to a String. */
static String toString(unsigned long val,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
#endif
#else
/** Converts a size_t to a String. */
static String toString(size_t val,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
/** Converts an unsigned long to a String. */
static String toString(unsigned long val,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
#endif
/** Converts a long to a String. */
static String toString(long val,
unsigned short width = 0, char fill = ' ',
std::ios::fmtflags flags = std::ios::fmtflags(0) );
/** Converts a boolean to a String.
@param yesNo If set to true, result is 'yes' or 'no' instead of 'true' or 'false'
*/
static String toString(bool val, bool yesNo = false);
/** Converts a Vector2 to a String.
@remarks
Format is "x y" (i.e. 2x Real values, space delimited)
*/
static String toString(const Vector2& val);
/** Converts a Vector3 to a String.
@remarks
Format is "x y z" (i.e. 3x Real values, space delimited)
*/
static String toString(const Vector3& val);
/** Converts a Vector4 to a String.
@remarks
Format is "x y z w" (i.e. 4x Real values, space delimited)
*/
static String toString(const Vector4& val);
/** Converts a Matrix3 to a String.
@remarks
Format is "00 01 02 10 11 12 20 21 22" where '01' means row 0 column 1 etc.
*/
static String toString(const Matrix3& val);
/** Converts a Matrix4 to a String.
@remarks
Format is "00 01 02 03 10 11 12 13 20 21 22 23 30 31 32 33" where
'01' means row 0 column 1 etc.
*/
static String toString(const Matrix4& val);
/** Converts a Quaternion to a String.
@remarks
Format is "w x y z" (i.e. 4x Real values, space delimited)
*/
static String toString(const Quaternion& val);
/** Converts a ColourValue to a String.
@remarks
Format is "r g b a" (i.e. 4x Real values, space delimited).
*/
static String toString(const ColourValue& val);
/** Converts a StringVector to a string.
@remarks
Strings must not contain spaces since space is used as a delimiter in
the output.
*/
static String toString(const StringVector& val);
/** Converts a String to a Real.
@returns
0.0 if the value could not be parsed, otherwise the Real version of the String.
*/
static Real parseReal(const String& val, Real defaultValue = 0);
/** Converts a String to a Angle.
@returns
0.0 if the value could not be parsed, otherwise the Angle version of the String.
*/
static inline Radian parseAngle(const String& val, Radian defaultValue = Radian(0)) {
return Angle(parseReal(val, defaultValue.valueRadians()));
}
/** Converts a String to a whole number.
@returns
0.0 if the value could not be parsed, otherwise the numeric version of the String.
*/
static int parseInt(const String& val, int defaultValue = 0);
/** Converts a String to a whole number.
@returns
0.0 if the value could not be parsed, otherwise the numeric version of the String.
*/
static unsigned int parseUnsignedInt(const String& val, unsigned int defaultValue = 0);
/** Converts a String to a whole number.
@returns
0.0 if the value could not be parsed, otherwise the numeric version of the String.
*/
static long parseLong(const String& val, long defaultValue = 0);
/** Converts a String to a whole number.
@returns
0.0 if the value could not be parsed, otherwise the numeric version of the String.
*/
static unsigned long parseUnsignedLong(const String& val, unsigned long defaultValue = 0);
/** Converts a String to a boolean.
@remarks
Returns true if case-insensitive match of the start of the string
matches "true", "yes" or "1", false otherwise.
*/
static bool parseBool(const String& val, bool defaultValue = 0);
/** Parses a Vector2 out of a String.
@remarks
Format is "x y" ie. 2 Real components, space delimited. Failure to parse returns
Vector2::ZERO.
*/
static Vector2 parseVector2(const String& val, const Vector2& defaultValue = Vector2::ZERO);
/** Parses a Vector3 out of a String.
@remarks
Format is "x y z" ie. 3 Real components, space delimited. Failure to parse returns
Vector3::ZERO.
*/
static Vector3 parseVector3(const String& val, const Vector3& defaultValue = Vector3::ZERO);
/** Parses a Vector4 out of a String.
@remarks
Format is "x y z w" ie. 4 Real components, space delimited. Failure to parse returns
Vector4::ZERO.
*/
static Vector4 parseVector4(const String& val, const Vector4& defaultValue = Vector4::ZERO);
/** Parses a Matrix3 out of a String.
@remarks
Format is "00 01 02 10 11 12 20 21 22" where '01' means row 0 column 1 etc.
Failure to parse returns Matrix3::IDENTITY.
*/
static Matrix3 parseMatrix3(const String& val, const Matrix3& defaultValue = Matrix3::IDENTITY);
/** Parses a Matrix4 out of a String.
@remarks
Format is "00 01 02 03 10 11 12 13 20 21 22 23 30 31 32 33" where
'01' means row 0 column 1 etc. Failure to parse returns Matrix4::IDENTITY.
*/
static Matrix4 parseMatrix4(const String& val, const Matrix4& defaultValue = Matrix4::IDENTITY);
/** Parses a Quaternion out of a String.
@remarks
Format is "w x y z" (i.e. 4x Real values, space delimited).
Failure to parse returns Quaternion::IDENTITY.
*/
static Quaternion parseQuaternion(const String& val, const Quaternion& defaultValue = Quaternion::IDENTITY);
/** Parses a ColourValue out of a String.
@remarks
Format is "r g b a" (i.e. 4x Real values, space delimited), or "r g b" which implies
an alpha value of 1.0 (opaque). Failure to parse returns ColourValue::Black.
*/
static ColourValue parseColourValue(const String& val, const ColourValue& defaultValue = ColourValue::Black);
/** Pareses a StringVector from a string.
@remarks
Strings must not contain spaces since space is used as a delimiter in
the output.
*/
static StringVector parseStringVector(const String& val);
/** Checks the String is a valid number value. */
static bool isNumber(const String& val);
};
/** @} */
/** @} */
}
#endif
|