visitor.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_VISITOR_H_
#define RTTR_VISITOR_H_

#include "rttr/detail/base/core_prerequisites.h"
#include "rttr/rttr_enable.h"
#include "rttr/type_list.h"
#include "rttr/detail/visitor/visitor_registration.h"

#include <type_traits>
#include <functional>
#include <tuple>

namespace rttr
{

class property;
class method;
class constructor;

class RTTR_API visitor
{
public:
    visitor();

    virtual ~visitor();

    void visit(type t);

    void visit(method meth);

    void visit(constructor ctor);

    void visit(property prop);

#ifdef DOXYGEN

    template<typename T>
    struct type_info
    {
        using declaring_type    = T;        

        using base_classes      = type_list<Base_Classes...>; 
        const type&             type_item;  
    };

    template<typename T>
    struct constructor_info
    {
        using declaring_type    = T;        
        using policy            = Policy;   
        const constructor&      ctor_item;  
    };

    template<typename T>
    struct constructor_function_info
    {
        using declaring_type = T;           
        using policy         = Policy;      
        const constructor    ctor_item;     
        Acc                  function_ptr;  
    };

    template<typename T>
    struct method_info
    {
        using declaring_type    = T;            
        using policy            = Policy;       
        const method&           method_item;    
        Acc                     function_ptr;   
    };

    template<typename T>
    struct property_info
    {
        using declaring_type = T;
        using policy         = Policy;
        const property       property_item;
        Acc                  property_accessor;
    };

    template<typename T>
    struct property_getter_setter_info
    {
        using declaring_type = T;
        using policy         = Policy;
        const property       property_item;
        Getter               property_getter;
        Setter               property_setter;
    };
#else
    template<typename T>
    struct type_info;

    template<typename T, typename...Base_Classes>
    struct type_info<type_list<T, type_list<Base_Classes...>>>
    {
        using declaring_type    = T;
        using base_classes      = type_list<Base_Classes...>;
        const type&             type_item;
    };

    template<typename T>
    struct constructor_info;

    template<typename T, typename Policy, typename...Ctor_args>
    struct constructor_info<type_list<T, Policy, type_list<Ctor_args...>>>
    {
        using declaring_type    = T;
        using ctor_args         = type_list<Ctor_args...>;
        using policy            = Policy;
        const constructor&      ctor_item;
    };

    template<typename T>
    struct constructor_function_info;

    template<typename T, typename Policy, typename Acc>
    struct constructor_function_info<type_list<T, Policy, Acc>>
    {
        using declaring_type = T;
        using policy         = Policy;
        const constructor    ctor_item;
        Acc                  function_ptr;
    };

    template<typename T>
    struct method_info;

    template<typename T, typename Policy, typename Acc>
    struct method_info<type_list<T, Policy, Acc>>
    {
        using declaring_type = T;
        using policy         = Policy;
        const method         method_item;
        Acc                  function_ptr;
    };

    template<typename T>
    struct property_info;

    template<typename T, typename Policy, typename Acc>
    struct property_info<type_list<T, Policy, Acc>>
    {
        using declaring_type = T;
        using policy         = Policy;
        const property       property_item;
        Acc                  property_accessor;
    };

    template<typename T>
    struct property_getter_setter_info;

    template<typename T, typename Policy, typename Getter, typename Setter>
    struct property_getter_setter_info<type_list<T, Policy, Getter, Setter>>
    {
        using declaring_type = T;
        using policy         = Policy;
        const property       property_item;
        Getter               property_getter;
        Setter               property_setter;
    };
#endif

    template<typename T, typename...Base_Classes>
    void visit_type_begin(const type_info<T>& info);

    template<typename T, typename...Base_Classes>
    void visit_type_end(const type_info<T>& info);

    template<typename T, typename...Ctor_Args>
    void visit_constructor(const constructor_info<T>& info);

    template<typename T>
    void visit_constructor_function(const constructor_function_info<T>& info);

    template<typename T>
    void visit_method(const method_info<T>& info);

    template<typename T>
    void visit_global_method(const method_info<T>& info);

    template<typename T>
    void visit_property(const property_info<T>& info);

    template<typename T>
    void visit_getter_setter_property(const property_getter_setter_info<T>& info);

    template<typename T>
    void visit_global_property(const property_info<T>& info);

    template<typename T>
    void visit_global_getter_setter_property(const property_getter_setter_info<T>& info);

    template<typename T>
    void visit_readonly_property(const property_info<T>& info);

    template<typename T>
    void visit_global_readonly_property(const property_info<T>& info);

private:
    void visit_impl(const type& t);

private:
    RTTR_ENABLE();
};

} // end namespace rttr

#include "rttr/detail/visitor/visitor_impl.h"

#endif  // RTTR_VISITOR_H_