type.h

Go to the documentation of this file.

/************************************************************************************
*                                                                                   *
*   Copyright (c) 2014, 2015 - 2016 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 <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;

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

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

template<typename T, typename Enable = void>
struct type_getter;

static type get_invalid_type();
} // end namespace detail

class RTTR_API type
{
    public:
        typedef uint16_t type_id;

        RTTR_INLINE type(const type& other);

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

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

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

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

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

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

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

        RTTR_INLINE type_id get_id() const;

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

         RTTR_INLINE explicit operator bool() const;

        type get_raw_type() const;

        type get_wrapped_type() const;

        template<typename T> 
        static type get();

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

        static type get_by_name(const char* name);

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

        std::size_t get_sizeof() const;

        bool is_class() const;

        bool is_enumeration() const;

        enumeration get_enumeration() const;

        bool is_wrapper() const;

        bool is_array() const;

        bool is_pointer() const;

        bool is_arithmetic() const;

        bool is_function_pointer() const;

        bool is_member_object_pointer() const;

        bool is_member_function_pointer() 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;


        variant get_metadata(const variant& key) const;

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

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

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

        destructor get_destructor() const;

        void destroy(variant& obj) const;


        property get_property(const char* name) const;

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

        static property get_global_property(const char* name);

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


        variant get_property_value(const char* name, instance obj) const;

        static variant get_property_value(const char* name);

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

        static bool set_property_value(const char* name, argument arg);


        method get_method(const char* name) const;

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

        static method get_global_method(const char* name);

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

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


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

        static variant invoke(const char* name, std::vector<argument> args);

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

        template<typename T>
        static void register_comparators();

    private:

        RTTR_INLINE type();

        RTTR_INLINE type(type_id id);

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

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

        std::size_t get_pointer_dimension() const;

        type get_raw_array_type() const;

        std::string get_full_name() const;

        static std::string normalize_orig_name(const char* name);

        static void init_globals();



        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);

        template<typename T, typename Enable>
        friend struct detail::type_getter;
        friend class instance;
        friend class detail::type_register;
        friend type detail::get_invalid_type();
        friend class detail::type_database;
        
    private:
        type_id  m_id;
        static const type_id m_invalid_id = 0;
};

} // end namespace rttr

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

#endif // RTTR_TYPE_H_