// This file is distributed under the BSD License. // See "license.txt" for details. // Copyright 2009-2011, Jonathan Turner (jonathan@emptycrate.com) // and Jason Turner (jason@emptycrate.com) // http://www.chaiscript.com #ifndef CHAISCRIPT_BOXED_VALUE_HPP_ #define CHAISCRIPT_BOXED_VALUE_HPP_ #include "type_info.hpp" #include "../chaiscript_threading.hpp" #include #include namespace chaiscript { /// \brief A wrapper for holding any valid C++ type. All types in ChaiScript are Boxed_Value objects /// \sa chaiscript::boxed_cast class Boxed_Value { public: /** * used for explicitly creating a "void" object */ struct Void_Type { }; private: /** * structure which holds the internal state of a Boxed_Value */ struct Data { Data(const Type_Info &ti, const boost::any &to, bool tr, const void *t_void_ptr) : m_type_info(ti), m_obj(to), m_data_ptr(ti.is_const()?0:const_cast(t_void_ptr)), m_const_data_ptr(t_void_ptr), m_is_ref(tr) { } Data &operator=(const Data &rhs) { m_type_info = rhs.m_type_info; m_obj = rhs.m_obj; m_is_ref = rhs.m_is_ref; m_data_ptr = rhs.m_data_ptr; m_const_data_ptr = rhs.m_const_data_ptr; return *this; } ~Data() { } Type_Info m_type_info; boost::any m_obj; void *m_data_ptr; const void *m_const_data_ptr; bool m_is_ref; std::vector > m_dependencies; }; struct Object_Data { static std::shared_ptr get(Boxed_Value::Void_Type) { return std::shared_ptr (new Data( detail::Get_Type_Info::get(), boost::any(), false, 0) ); } template static std::shared_ptr get(const std::shared_ptr *obj) { return get(*obj); } template static std::shared_ptr get(const std::shared_ptr &obj) { return std::shared_ptr(new Data( detail::Get_Type_Info::get(), boost::any(obj), false, obj.get()) ); } template static std::shared_ptr get(T *t) { return get(std::ref(*t)); } template static std::shared_ptr get(std::reference_wrapper obj) { return std::shared_ptr(new Data( detail::Get_Type_Info::get(), boost::any(obj), true, &obj.get()) ); } template static std::shared_ptr get(const T& t) { std::shared_ptr p(new T(t)); return std::shared_ptr(new Data( detail::Get_Type_Info::get(), boost::any(p), false, p.get()) ); } static std::shared_ptr get() { return std::shared_ptr (new Data( Type_Info(), boost::any(), false, 0) ); } }; public: /** * Basic Boxed_Value constructor */ template explicit Boxed_Value(T t) : m_data(Object_Data::get(t)) { } /** * Copy constructor - each copy shares the same data pointer */ Boxed_Value(const Boxed_Value &t_so) : m_data(t_so.m_data) { } /** * Unknown-type constructor */ Boxed_Value() : m_data(Object_Data::get()) { } ~Boxed_Value() { } void swap(Boxed_Value &rhs) { std::swap(m_data, rhs.m_data); } /** * copy the values stored in rhs.m_data to m_data * m_data pointers are not shared in this case */ Boxed_Value assign(const Boxed_Value &rhs) { (*m_data) = (*rhs.m_data); return *this; } /** * shared data assignment, same as copy construction */ Boxed_Value &operator=(const Boxed_Value &rhs) { Boxed_Value temp(rhs); swap(temp); return *this; } const Type_Info &get_type_info() const { return m_data->m_type_info; } /** * return true if the object is uninitialized */ bool is_undef() const { return m_data->m_type_info.is_undef(); } bool is_const() const { return m_data->m_type_info.is_const(); } bool is_type(const Type_Info &ti) const { return m_data->m_type_info.bare_equal(ti); } bool is_null() const { return (m_data->m_data_ptr == 0 && m_data->m_const_data_ptr == 0); } const boost::any & get() const { return m_data->m_obj; } bool is_ref() const { return m_data->m_is_ref; } bool is_pointer() const { return !is_ref(); } void clear_dependencies() { m_data->m_dependencies.clear(); } template void add_dependencies(InItr begin, const InItr &end) { while (begin != end) { if (begin->m_data != m_data) { m_data->m_dependencies.push_back(begin->m_data); } ++begin; } } void *get_ptr() const { return m_data->m_data_ptr; } const void *get_const_ptr() const { return m_data->m_const_data_ptr; } private: std::shared_ptr m_data; }; /// \brief Creates a Boxed_Value. If the object passed in is a value type, it is copied. If it is a pointer, std::shared_ptr, or std::reference_type /// a copy is not made. /// \param t The value to box /// /// Example: /// \code /// int i; /// chaiscript::ChaiScript chai; /// chai.add(chaiscript::var(i), "i"); /// chai.add(chaiscript::var(&i), "ip"); /// \endcode /// /// \sa \ref addingobjects template Boxed_Value var(T t) { return Boxed_Value(t); } namespace detail { /// \brief Takes a value, copies it and returns a Boxed_Value object that is immutable /// \param[in] t Value to copy and make const /// \returns Immutable Boxed_Value /// \sa Boxed_Value::is_const template Boxed_Value const_var_impl(const T &t) { return Boxed_Value(std::shared_ptr::type >(new T(t))); } /// \brief Takes a pointer to a value, adds const to the pointed to type and returns an immutable Boxed_Value. /// Does not copy the pointed to value. /// \param[in] t Pointer to make immutable /// \returns Immutable Boxed_Value /// \sa Boxed_Value::is_const template Boxed_Value const_var_impl(T *t) { return Boxed_Value( const_cast::type *>(t) ); } /// \brief Takes a std::shared_ptr to a value, adds const to the pointed to type and returns an immutable Boxed_Value. /// Does not copy the pointed to value. /// \param[in] t Pointer to make immutable /// \returns Immutable Boxed_Value /// \sa Boxed_Value::is_const template Boxed_Value const_var_impl(const std::shared_ptr &t) { return Boxed_Value( std::const_pointer_cast::type>(t) ); } /// \brief Takes a std::reference_wrapper value, adds const to the referenced type and returns an immutable Boxed_Value. /// Does not copy the referenced value. /// \param[in] t Reference object to make immutable /// \returns Immutable Boxed_Value /// \sa Boxed_Value::is_const template Boxed_Value const_var_impl(const std::reference_wrapper &t) { return Boxed_Value( std::cref(t.get()) ); } } /// \brief Takes an object and returns an immutable Boxed_Value. If the object is a std::reference or pointer type /// the value is not copied. If it is an object type, it is copied. /// \param[in] t Object to make immutable /// \returns Immutable Boxed_Value /// \sa chaiscript::Boxed_Value::is_const /// \sa chaiscript::var /// /// Example: /// \code /// enum Colors /// { /// Blue, /// Green, /// Red /// }; /// chaiscript::ChaiScript chai /// chai.add(chaiscript::const_var(Blue), "Blue"); // add immutable constant /// chai.add(chaiscript::const_var(Red), "Red"); /// chai.add(chaiscript::const_var(Green), "Green"); /// \endcode /// /// \sa \ref addingobjects template Boxed_Value const_var(const T &t) { return detail::const_var_impl(t); } /// \returns true if the two Boxed_Values share the same internal type static bool type_match(Boxed_Value l, Boxed_Value r) { return l.get_type_info() == r.get_type_info(); } } #endif