type.h

Go to the documentation of this file.

/************************************************************************************
*                                                                                   *
*   Copyright (c) 2014 - 2018 Axel Menzel <info@rttr.org>                           *
*                                                                                   *
*   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/detail/base/core_prerequisites.h"
#include "rttr/string_view.h"
#include "rttr/array_range.h"
#include "rttr/filter_item.h"

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

namespace rttr
{

class variant;
class constructor;
class destructor;
class method;
class property;
class enumeration;
class type;
class instance;
class argument;
class visitor;

template<typename Target_Type, typename Source_Type>
Target_Type rttr_cast(Source_Type object) RTTR_NOEXCEPT;

namespace detail
{
struct derived_info;
struct base_class_info;
struct type_converter_base;
class type_register;
class type_register_private;

static type get_invalid_type() RTTR_NOEXCEPT;
struct invalid_type{};
struct type_data;
struct class_data;
class destructor_wrapper_base;
class property_wrapper_base;
RTTR_LOCAL RTTR_INLINE type create_type(type_data*) RTTR_NOEXCEPT;

template<typename T>
RTTR_LOCAL std::unique_ptr<type_data> make_type_data();

template<typename T, typename Tp, typename Converter>
struct variant_data_base_policy;

struct type_comparator_base;

enum class type_of_visit : bool;

RTTR_API bool compare_types_less_than(const void*, const void*, const type&, int&);
RTTR_API bool compare_types_equal(const void*, const void*, const type&, bool&);

template<typename T>
RTTR_LOCAL RTTR_INLINE type get_type_from_instance(const T*) RTTR_NOEXCEPT;
} // end namespace detail

class RTTR_API type
{
    public:
        typedef uintptr_t type_id;

        RTTR_INLINE type(const type& other) RTTR_NOEXCEPT;

        RTTR_INLINE type& operator=(const type& other) RTTR_NOEXCEPT;

        RTTR_INLINE bool operator<(const type& other) const RTTR_NOEXCEPT;

        RTTR_INLINE bool operator>(const type& other) const RTTR_NOEXCEPT;

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

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

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

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

        RTTR_INLINE type_id get_id() const RTTR_NOEXCEPT;

        RTTR_INLINE string_view get_name() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_valid() const RTTR_NOEXCEPT;

         RTTR_INLINE explicit operator bool() const RTTR_NOEXCEPT;

        RTTR_INLINE type get_raw_type() const RTTR_NOEXCEPT;

        RTTR_INLINE type get_wrapped_type() const RTTR_NOEXCEPT;

        template<typename T>
        RTTR_LOCAL static type get() RTTR_NOEXCEPT;

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

        static type get_by_name(string_view name) RTTR_NOEXCEPT;

        static array_range<type> get_types() RTTR_NOEXCEPT;

        RTTR_INLINE std::size_t get_sizeof() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_class() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_template_instantiation() const RTTR_NOEXCEPT;

        array_range<type> get_template_arguments() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_enumeration() const RTTR_NOEXCEPT;

        enumeration get_enumeration() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_wrapper() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_array() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_associative_container() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_sequential_container() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_pointer() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_arithmetic() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_function_pointer() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_member_object_pointer() const RTTR_NOEXCEPT;

        RTTR_INLINE bool is_member_function_pointer() const RTTR_NOEXCEPT;

        bool is_derived_from(const type& other) const RTTR_NOEXCEPT;

        template<typename T>
        bool is_derived_from() const RTTR_NOEXCEPT;

        bool is_base_of(const type& other) const RTTR_NOEXCEPT;

        template<typename T>
        bool is_base_of() const RTTR_NOEXCEPT;

        array_range<type> get_base_classes() const RTTR_NOEXCEPT;

        array_range<type> get_derived_classes() const RTTR_NOEXCEPT;


        variant get_metadata(const variant& key) const;

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

        array_range<constructor> get_constructors() const RTTR_NOEXCEPT;

        array_range<constructor> get_constructors(filter_items filter) const RTTR_NOEXCEPT;

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

        destructor get_destructor() const RTTR_NOEXCEPT;

        bool destroy(variant& obj) const RTTR_NOEXCEPT;


        property get_property(string_view name) const RTTR_NOEXCEPT;

        array_range<property> get_properties() const RTTR_NOEXCEPT;

        array_range<property> get_properties(filter_items filter) const RTTR_NOEXCEPT;

        static property get_global_property(string_view name) RTTR_NOEXCEPT;

        static array_range<property> get_global_properties() RTTR_NOEXCEPT;


        variant get_property_value(string_view name, instance obj) const;

        static variant get_property_value(string_view name);

        bool set_property_value(string_view name, instance obj, argument arg) const;

        static bool set_property_value(string_view name, argument arg);


        method get_method(string_view name) const RTTR_NOEXCEPT;

        method get_method(string_view name, const std::vector<type>& type_list) const RTTR_NOEXCEPT;

        array_range<method> get_methods() const RTTR_NOEXCEPT;

        array_range<method> get_methods(filter_items filter) const RTTR_NOEXCEPT;

        static method get_global_method(string_view name) RTTR_NOEXCEPT;

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

        static array_range<method> get_global_methods() RTTR_NOEXCEPT;


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

        static variant invoke(string_view name, std::vector<argument> args);

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

        template<typename T>
        static void register_wrapper_converter_for_base_classes();

        template<typename T>
        static void register_comparators();

        template<typename T>
        static void register_equal_comparator();

        template<typename T>
        static void register_less_than_comparator();

    private:

        type() RTTR_NOEXCEPT;

        RTTR_INLINE explicit type(detail::type_data* data) RTTR_NOEXCEPT;

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

        static type get_derived_type(void* ptr, const type& source_type) RTTR_NOEXCEPT;

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

        const detail::type_comparator_base* get_equal_comparator() const RTTR_NOEXCEPT;

        const detail::type_comparator_base* get_less_than_comparator() const RTTR_NOEXCEPT;

        RTTR_INLINE std::size_t get_pointer_dimension() const RTTR_NOEXCEPT;

        RTTR_INLINE type get_raw_array_type() const RTTR_NOEXCEPT;

        RTTR_INLINE string_view get_full_name() const RTTR_NOEXCEPT;

        void create_wrapped_value(const argument& arg, variant& var) const;

        void visit(visitor& visitor, detail::type_of_visit visit_type) const RTTR_NOEXCEPT;


        RTTR_INLINE variant create_variant(const argument& data) const;

        friend class variant;
        template<typename Target_Type, typename Source_Type>
        friend Target_Type rttr_cast(Source_Type object) RTTR_NOEXCEPT;

        friend class instance;
        friend class detail::type_register;
        friend class detail::type_register_private;
        friend class visitor;
        friend struct detail::class_data;

        friend type detail::create_type(detail::type_data*) RTTR_NOEXCEPT;

        template<typename T>
        friend std::unique_ptr<detail::type_data> detail::make_type_data();

        template<typename T, typename Tp, typename Converter>
        friend struct detail::variant_data_base_policy;

        friend RTTR_API bool detail::compare_types_less_than(const void*, const void*, const type&, int&);
        friend RTTR_API bool detail::compare_types_equal(const void*, const void*, const type&, bool&);

    private:
        detail::type_data* m_type_data;
};

} // end namespace rttr

#include "rttr/detail/type/type_impl.h"

#endif // RTTR_TYPE_H_