type.h

Go to the documentation of this file.

/************************************************************************************
*                                                                                   *
*   Copyright (c) 2014 Axel Menzel <info@axelmenzel.de>                             *
*                                                                                   *
*   This file is part of RTTR (Run Time Type Reflection)                            *
*   License: MIT License                                                            *
*                                                                                   *
*   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 __RTTR_TYPE_H__
#define __RTTR_TYPE_H__

#include "rttr/base/core_prerequisites.h"

#include <type_traits>
#include <vector>
#include <string>
#include <memory>

namespace rttr
{
class variant;
class constructor;
class destructor;
class method;
class property;
class enumeration;
class type;

template<typename TargetType, typename SourceType>
TargetType rttr_cast(SourceType object);

namespace detail
{
class instance;
class argument;
struct derived_info;
struct base_class_info;
struct type_converter_base;
} // end namespace detail

namespace impl
{
template<typename T>
struct MetaTypeInfo;
static type get_invalid_type();
} // end namespace impl

class RTTR_API type
{
    public:
        typedef uint16 type_id;

        type(const type& other);

        type& operator=(const type& other);

        bool operator<(const type& other) const;

        bool operator>(const type& other) const;

        bool operator>=(const type& other) const;

        bool operator<=(const type& other) const;

        bool operator==(const type& other) const;

        bool operator!=(const type& other) const;

        type_id get_id() const;

        std::string get_name() const;
        
        bool is_valid() const;

        operator bool() const;

        type get_raw_type() const;

        template<typename T> 
        static type get();

        template<typename T> 
        static type get(T&& object);

        static type get(const char* name);

        static std::vector<type> get_types();

        bool is_class() const;

        bool is_enumeration() const;

        enumeration get_enumeration() const;

        bool is_array() const;

        bool is_pointer() const;

        bool is_primitive() const;

        bool is_derived_from(const type& other) const;

        template<typename T>
        bool is_derived_from() const;

        std::vector<type> get_base_classes() const;

        std::vector<type> get_derived_classes() const;


        constructor get_constructor(const std::vector<type>& params = std::vector<type>() ) const;

        std::vector<constructor> get_constructors() const;

        variant create(std::vector<detail::argument> args) const;

        destructor get_destructor() const;

        void destroy(variant& obj) const;


        property get_property(const std::string& name) const;

        std::vector<property> get_properties() const;

        static property get_global_property(const std::string& name);

        static std::vector<property> get_global_properties();


        variant get_property_value(const std::string& name, detail::instance obj) const;

        static variant get_property_value(const std::string& name);

        bool set_property_value(const std::string& name, detail::instance obj, detail::argument arg) const;

        static bool set_property_value(const std::string& name, detail::argument arg);


        method get_method(const std::string& name) const;

        method get_method(const std::string& name, const std::vector<type>& params) const;
        
        std::vector<method> get_methods() const;

        static method get_global_method(const std::string& name);

        static method get_global_method(const std::string& name, const std::vector<type>& params);

        static std::vector<method> get_global_methods();


        variant invoke(const std::string& name, detail::instance obj, std::vector<detail::argument> args) const;

        static variant invoke(const std::string& name, std::vector<detail::argument> args);

        template<typename F>
        static void register_converter_func(F func);

    private:

        type();

        type(type_id id);

        static void* apply_offset(void* ptr, const type& source_type, const type& target_type);

        detail::type_converter_base* get_type_converter(const type& target_type) const;

        // now comes the register functions

        static type register_type(const char* name, 
                                  const type& raw_type,
                                  std::vector<detail::base_class_info> base_classes, 
                                  detail::derived_info(*get_derived_func)(void*),
                                  variant(*variant_create_func)(void*),
                                  bool is_class,
                                  bool is_enum,
                                  bool is_array,
                                  bool is_pointer,
                                  bool is_primitive);

        void register_type_converter(std::unique_ptr<detail::type_converter_base> converter) const;

        variant create_from_ptr(void* ptr) const;

        template<typename T>
        friend struct impl::MetaTypeInfo;

        template<typename T>
        friend class class_;

        friend type impl::get_invalid_type();
        friend class variant;

        friend class detail::instance;
        
        template<typename TargetType, typename SourceType>
        friend TargetType rttr_cast(SourceType object);

    private:
        type_id  m_id;
};

#ifdef DOXYGEN

#define RTTR_DECLARE_TYPE(Type)

#define RTTR_DECLARE_STANDARD_TYPE_VARIANTS(Type)


#define RTTR_DEFINE_TYPE(Type)

#endif

} // end namespace rttr

#include "rttr/impl/type_impl.h"

#endif // __RTTR_TYPE_H__