OgreAny.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 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.
-----------------------------------------------------------------------------
*/
// -- Based on boost::any, original copyright information follows --
// Copyright Kevlin Henney, 2000, 2001, 2002. All rights reserved.
//
// Distributed under the Boost Software License, Version 1.0. (See
// accompAnying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// -- End original copyright --
#ifndef __OGRE_ANY_H__
#define __OGRE_ANY_H__
#include "OgrePrerequisites.h"
#include "OgreException.h"
#include "OgreString.h"
#include <algorithm>
#include <typeinfo>
#include "OgreHeaderPrefix.h"
namespace Ogre
{
class Any
{
public: // constructors
Any()
: mContent(0)
{
}
template<typename ValueType>
explicit Any(const ValueType & value)
: mContent(OGRE_NEW_T(holder<ValueType>, MEMCATEGORY_GENERAL)(value))
{
}
Any(const Any & other)
: mContent(other.mContent ? other.mContent->clone() : 0)
{
}
virtual ~Any()
{
destroy();
}
public: // modifiers
Any& swap(Any & rhs)
{
std::swap(mContent, rhs.mContent);
return *this;
}
template<typename ValueType>
Any& operator=(const ValueType & rhs)
{
Any(rhs).swap(*this);
return *this;
}
Any & operator=(const Any & rhs)
{
Any(rhs).swap(*this);
return *this;
}
public: // queries
bool isEmpty() const
{
return !mContent;
}
const std::type_info& getType() const
{
return mContent ? mContent->getType() : typeid(void);
}
inline friend std::ostream& operator <<
( std::ostream& o, const Any& v )
{
if (v.mContent)
v.mContent->writeToStream(o);
return o;
}
void destroy()
{
OGRE_DELETE_T(mContent, placeholder, MEMCATEGORY_GENERAL);
mContent = NULL;
}
protected: // types
class placeholder
{
public: // structors
virtual ~placeholder()
{
}
public: // queries
virtual const std::type_info& getType() const = 0;
virtual placeholder * clone() const = 0;
virtual void writeToStream(std::ostream& o) = 0;
};
template<typename ValueType>
class holder : public placeholder
{
public: // structors
holder(const ValueType & value)
: held(value)
{
}
public: // queries
virtual const std::type_info & getType() const
{
return typeid(ValueType);
}
virtual placeholder * clone() const
{
return OGRE_NEW_T(holder, MEMCATEGORY_GENERAL)(held);
}
virtual void writeToStream(std::ostream& o)
{
o << held;
}
public: // representation
ValueType held;
};
protected: // representation
placeholder * mContent;
template<typename ValueType>
friend ValueType * any_cast(Any *);
public:
template<typename ValueType>
ValueType operator()() const
{
if (!mContent)
{
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
"Bad cast from uninitialised Any",
"Any::operator()");
}
else if(getType() == typeid(ValueType))
{
return static_cast<Any::holder<ValueType> *>(mContent)->held;
}
else
{
StringUtil::StrStreamType str;
str << "Bad cast from type '" << getType().name() << "' "
<< "to '" << typeid(ValueType).name() << "'";
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
str.str(),
"Any::operator()");
}
}
template <typename ValueType>
ValueType get(void) const
{
if (!mContent)
{
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
"Bad cast from uninitialised Any",
"Any::operator()");
}
else if(getType() == typeid(ValueType))
{
return static_cast<Any::holder<ValueType> *>(mContent)->held;
}
else
{
StringUtil::StrStreamType str;
str << "Bad cast from type '" << getType().name() << "' "
<< "to '" << typeid(ValueType).name() << "'";
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
str.str(),
"Any::operator()");
}
}
};
class AnyNumeric : public Any
{
public:
AnyNumeric()
: Any()
{
}
template<typename ValueType>
AnyNumeric(const ValueType & value)
{
mContent = OGRE_NEW_T(numholder<ValueType>, MEMCATEGORY_GENERAL)(value);
}
AnyNumeric(const AnyNumeric & other)
: Any()
{
mContent = other.mContent ? other.mContent->clone() : 0;
}
protected:
class numplaceholder : public Any::placeholder
{
public: // structors
~numplaceholder()
{
}
virtual placeholder* add(placeholder* rhs) = 0;
virtual placeholder* subtract(placeholder* rhs) = 0;
virtual placeholder* multiply(placeholder* rhs) = 0;
virtual placeholder* multiply(Real factor) = 0;
virtual placeholder* divide(placeholder* rhs) = 0;
};
template<typename ValueType>
class numholder : public numplaceholder
{
public: // structors
numholder(const ValueType & value)
: held(value)
{
}
public: // queries
virtual const std::type_info & getType() const
{
return typeid(ValueType);
}
virtual placeholder * clone() const
{
return OGRE_NEW_T(numholder, MEMCATEGORY_GENERAL)(held);
}
virtual placeholder* add(placeholder* rhs)
{
return OGRE_NEW_T(numholder, MEMCATEGORY_GENERAL)(held + static_cast<numholder*>(rhs)->held);
}
virtual placeholder* subtract(placeholder* rhs)
{
return OGRE_NEW_T(numholder, MEMCATEGORY_GENERAL)(held - static_cast<numholder*>(rhs)->held);
}
virtual placeholder* multiply(placeholder* rhs)
{
return OGRE_NEW_T(numholder, MEMCATEGORY_GENERAL)(held * static_cast<numholder*>(rhs)->held);
}
virtual placeholder* multiply(Real factor)
{
return OGRE_NEW_T(numholder, MEMCATEGORY_GENERAL)(held * factor);
}
virtual placeholder* divide(placeholder* rhs)
{
return OGRE_NEW_T(numholder, MEMCATEGORY_GENERAL)(held / static_cast<numholder*>(rhs)->held);
}
virtual void writeToStream(std::ostream& o)
{
o << held;
}
public: // representation
ValueType held;
};
AnyNumeric(placeholder* pholder)
{
mContent = pholder;
}
public:
AnyNumeric & operator=(const AnyNumeric & rhs)
{
AnyNumeric(rhs).swap(*this);
return *this;
}
AnyNumeric operator+(const AnyNumeric& rhs) const
{
return AnyNumeric(
static_cast<numplaceholder*>(mContent)->add(rhs.mContent));
}
AnyNumeric operator-(const AnyNumeric& rhs) const
{
return AnyNumeric(
static_cast<numplaceholder*>(mContent)->subtract(rhs.mContent));
}
AnyNumeric operator*(const AnyNumeric& rhs) const
{
return AnyNumeric(
static_cast<numplaceholder*>(mContent)->multiply(rhs.mContent));
}
AnyNumeric operator*(Real factor) const
{
return AnyNumeric(
static_cast<numplaceholder*>(mContent)->multiply(factor));
}
AnyNumeric operator/(const AnyNumeric& rhs) const
{
return AnyNumeric(
static_cast<numplaceholder*>(mContent)->divide(rhs.mContent));
}
AnyNumeric& operator+=(const AnyNumeric& rhs)
{
*this = AnyNumeric(
static_cast<numplaceholder*>(mContent)->add(rhs.mContent));
return *this;
}
AnyNumeric& operator-=(const AnyNumeric& rhs)
{
*this = AnyNumeric(
static_cast<numplaceholder*>(mContent)->subtract(rhs.mContent));
return *this;
}
AnyNumeric& operator*=(const AnyNumeric& rhs)
{
*this = AnyNumeric(
static_cast<numplaceholder*>(mContent)->multiply(rhs.mContent));
return *this;
}
AnyNumeric& operator/=(const AnyNumeric& rhs)
{
*this = AnyNumeric(
static_cast<numplaceholder*>(mContent)->divide(rhs.mContent));
return *this;
}
};
template<typename ValueType>
ValueType * any_cast(Any * operand)
{
return operand && (std::strcmp(operand->getType().name(), typeid(ValueType).name()) == 0)
? &static_cast<Any::holder<ValueType> *>(operand->mContent)->held
: 0;
}
template<typename ValueType>
const ValueType * any_cast(const Any * operand)
{
return any_cast<ValueType>(const_cast<Any *>(operand));
}
template<typename ValueType>
ValueType any_cast(const Any & operand)
{
const ValueType * result = any_cast<ValueType>(&operand);
if(!result)
{
StringUtil::StrStreamType str;
str << "Bad cast from type '" << operand.getType().name() << "' "
<< "to '" << typeid(ValueType).name() << "'";
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
str.str(),
"Ogre::any_cast");
}
return *result;
}
}
#include "OgreHeaderSuffix.h"
#endif
Ogre::Any::destroy
void destroy()
Definition: OgreAny.h:122
Ogre::Any::Any
Any(const Any &other)
Definition: OgreAny.h:71
Ogre::AnyNumeric::AnyNumeric
AnyNumeric(const ValueType &value)
Definition: OgreAny.h:256
Ogre::Any::placeholder::clone
virtual placeholder * clone() const =0
Ogre::Any::mContent
placeholder * mContent
Definition: OgreAny.h:185
Ogre::AnyNumeric::numholder::getType
virtual const std::type_info & getType() const
Definition: OgreAny.h:295
Ogre::AnyNumeric::operator*
AnyNumeric operator*(Real factor) const
Definition: OgreAny.h:363
Ogre::AnyNumeric::operator*
AnyNumeric operator*(const AnyNumeric &rhs) const
Definition: OgreAny.h:358
Ogre::Any::any_cast
friend ValueType * any_cast(Any *)
Definition: OgreAny.h:405
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::Any::placeholder::getType
virtual const std::type_info & getType() const =0
Ogre::AnyNumeric::operator=
AnyNumeric & operator=(const AnyNumeric &rhs)
Definition: OgreAny.h:343
OgreString.h
Ogre::Any::Any
Any(const ValueType &value)
Definition: OgreAny.h:66
Ogre::Any::holder::getType
virtual const std::type_info & getType() const
Definition: OgreAny.h:160
Ogre::StringUtil::StrStreamType
StringStream StrStreamType
Definition: OgreString.h:78
Ogre::AnyNumeric::numholder::held
ValueType held
Definition: OgreAny.h:332
Ogre::AnyNumeric::numholder::divide
virtual placeholder * divide(placeholder *rhs)
Definition: OgreAny.h:321
Ogre::Any
Variant type that can hold Any other type.
Definition: OgreAny.h:56
Ogre::AnyNumeric::numplaceholder::~numplaceholder
~numplaceholder()
Definition: OgreAny.h:273
Ogre::AnyNumeric::AnyNumeric
AnyNumeric(const AnyNumeric &other)
Definition: OgreAny.h:262
Ogre::AnyNumeric::numholder
Definition: OgreAny.h:284
OgrePrerequisites.h
Ogre::Any::operator()
ValueType operator()() const
Definition: OgreAny.h:194
Ogre::Any::holder::holder
holder(const ValueType &value)
Definition: OgreAny.h:153
Ogre::MEMCATEGORY_GENERAL
General purpose.
Definition: OgreMemoryAllocatorConfig.h:162
Ogre::AnyNumeric::AnyNumeric
AnyNumeric(placeholder *pholder)
Construct from holder.
Definition: OgreAny.h:337
OGRE_DELETE_T
#define OGRE_DELETE_T(ptr, T, category)
Free the memory allocated with OGRE_NEW_T. Category is required to be restated to ensure the matching...
Definition: OgreMemoryAllocatorConfig.h:437
Ogre::AnyNumeric::AnyNumeric
AnyNumeric()
Definition: OgreAny.h:250
Ogre::AnyNumeric
Specialised Any class which has built in arithmetic operators, but can hold only types which support ...
Definition: OgreAny.h:247
Ogre::Any::holder::held
ValueType held
Definition: OgreAny.h:178
Ogre::Any::placeholder::writeToStream
virtual void writeToStream(std::ostream &o)=0
Ogre::AnyNumeric::operator+=
AnyNumeric & operator+=(const AnyNumeric &rhs)
Definition: OgreAny.h:373
Ogre::Any::holder::writeToStream
virtual void writeToStream(std::ostream &o)
Definition: OgreAny.h:170
Ogre::AnyNumeric::numholder::multiply
virtual placeholder * multiply(placeholder *rhs)
Definition: OgreAny.h:313
Ogre::Any::operator=
Any & operator=(const ValueType &rhs)
Definition: OgreAny.h:90
Ogre::AnyNumeric::numholder::numholder
numholder(const ValueType &value)
Definition: OgreAny.h:288
Ogre::AnyNumeric::numholder::clone
virtual placeholder * clone() const
Definition: OgreAny.h:300
OGRE_NEW_T
#define OGRE_NEW_T(T, category)
Allocate space for one primitive type, external type or non-virtual type with constructor parameters...
Definition: OgreMemoryAllocatorConfig.h:433
Ogre::Any::holder
Definition: OgreAny.h:149
std::swap
void swap(Ogre::SmallVectorImpl< T > &LHS, Ogre::SmallVectorImpl< T > &RHS)
Implement std::swap in terms of SmallVector swap.
Definition: OgreSmallVector.h:802
OgreHeaderSuffix.h
Ogre::Any::swap
Any & swap(Any &rhs)
Definition: OgreAny.h:83
Ogre::AnyNumeric::operator/=
AnyNumeric & operator/=(const AnyNumeric &rhs)
Definition: OgreAny.h:391
OGRE_EXCEPT
#define OGRE_EXCEPT(num, desc, src)
Definition: OgreException.h:334
Ogre::AnyNumeric::operator-
AnyNumeric operator-(const AnyNumeric &rhs) const
Definition: OgreAny.h:353
Ogre::Any::placeholder
Definition: OgreAny.h:130
Ogre::Exception::ERR_INVALIDPARAMS
Definition: OgreException.h:103
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::AnyNumeric::numholder::multiply
virtual placeholder * multiply(Real factor)
Definition: OgreAny.h:317
OgreException.h
Ogre::AnyNumeric::operator/
AnyNumeric operator/(const AnyNumeric &rhs) const
Definition: OgreAny.h:368
OgreHeaderPrefix.h
Ogre::AnyNumeric::numplaceholder
Definition: OgreAny.h:269
Ogre::Any::isEmpty
bool isEmpty() const
Definition: OgreAny.h:104
Ogre::Any::Any
Any()
Definition: OgreAny.h:60
Ogre::AnyNumeric::numholder::add
virtual placeholder * add(placeholder *rhs)
Definition: OgreAny.h:305
Ogre::AnyNumeric::numholder::writeToStream
virtual void writeToStream(std::ostream &o)
Definition: OgreAny.h:325
Ogre::Any::holder::clone
virtual placeholder * clone() const
Definition: OgreAny.h:165
Ogre::AnyNumeric::operator-=
AnyNumeric & operator-=(const AnyNumeric &rhs)
Definition: OgreAny.h:379
Ogre::Any::~Any
virtual ~Any()
Definition: OgreAny.h:76
Ogre::Any::getType
const std::type_info & getType() const
Definition: OgreAny.h:109
Ogre::AnyNumeric::operator*=
AnyNumeric & operator*=(const AnyNumeric &rhs)
Definition: OgreAny.h:385
Ogre::Any::placeholder::~placeholder
virtual ~placeholder()
Definition: OgreAny.h:134
Ogre::Any::operator=
Any & operator=(const Any &rhs)
Definition: OgreAny.h:96
Ogre::AnyNumeric::numholder::subtract
virtual placeholder * subtract(placeholder *rhs)
Definition: OgreAny.h:309
Ogre::AnyNumeric::operator+
AnyNumeric operator+(const AnyNumeric &rhs) const
Definition: OgreAny.h:348

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.