YiRtti.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_RTTI_H_
#define _YI_RTTI_H_

#include "framework/YiPredef.h"
#include "utility/YiPreprocessorMacros.h"
#include "utility/YiString.h"
#include "utility/YiTypeTraits.h"

#include <map>

class CYIRuntimeTypeInfo
{
public:
    virtual ~CYIRuntimeTypeInfo();

    template<typename T>
    inline std::unique_ptr<T> CreateInstance() const;

    virtual bool CanCastTo(const CYIRuntimeTypeInfo &baseType) const = 0;
    
    template<typename T>
    inline bool CanCastTo() const;
    
    const CYIString &GetName() const;
    
    virtual const std::vector<const CYIRuntimeTypeInfo*> &GetBasesTypeInfos() const = 0;
    
    virtual bool IsInstantiable() const = 0;
    
    void RegisterWithLinker() const;

    template<typename T>
    inline const T *CastVoidPointer(const void *pObject) const;

    inline bool operator==(const CYIRuntimeTypeInfo &other) const;
    inline bool operator!=(const CYIRuntimeTypeInfo &other) const;
    inline bool operator<(const CYIRuntimeTypeInfo &other) const;
    
protected:
    CYIRuntimeTypeInfo(const CYIString &name);
    virtual void *CreateVoidInstance() const = 0;

private:
    virtual const void *CastVoidToVoid(const CYIRuntimeTypeInfo &baseType, const void *pObject) const = 0;
    
    CYIString m_name;
    
    YI_DISALLOW_COPY_AND_ASSIGN(CYIRuntimeTypeInfo)
};



template<typename CLASS, typename BASE1 = void, typename BASE2 = void, typename BASE3 = void>
class CYIRuntimeTypeInfoTyped : public CYIRuntimeTypeInfo
{
public:
    typedef CLASS ClassType;
    
    typedef BASE1 BaseType1;
    
    typedef BASE2 BaseType2;
    
    typedef BASE3 BaseType3;

    inline bool CanCastToNonVirtual(const CYIRuntimeTypeInfo &baseType) const;
    
    template<typename T>
    inline bool CanCastTo() const;
    
    template<typename T, typename TBASE1, typename TBASE2, typename TBASE3>
    inline bool CanCastTo(const CYIRuntimeTypeInfoTyped<T, TBASE1, TBASE2, TBASE3> &baseType) const;

    inline std::unique_ptr<CLASS> CreateInstance() const;

    virtual const void *CastVoidToVoid(const CYIRuntimeTypeInfo &baseType, const void *pObject) const override;
    inline const void *CastVoidToVoidNonVirtual(const CYIRuntimeTypeInfo &baseType, const void *pObject) const;
    virtual bool CanCastTo(const CYIRuntimeTypeInfo &baseType) const override;
    virtual const std::vector<const CYIRuntimeTypeInfo*> &GetBasesTypeInfos() const override;
    
protected:
    CYIRuntimeTypeInfoTyped(const CYIString &name);
};



class CYIRTTIRegistry
{
public:
    static CYIRTTIRegistry &GetInstance();

    void RegisterType(const CYIRuntimeTypeInfo &typeInfo, const CYIString &name);
    
    const CYIRuntimeTypeInfo &RegisterTypeHelper(const CYIRuntimeTypeInfo &typeInfo);
    
    void UnregisterType(const CYIString &name);

    inline const CYIRuntimeTypeInfo *GetTypeForName(const CYIString &typeName) const;
    
    std::map<CYIString, const CYIRuntimeTypeInfo*> GetRegisteredTypes() const;
    
    std::vector<const CYIRuntimeTypeInfo *> GetSuperclassesTypeInfos(const CYIRuntimeTypeInfo &type, bool bDirectSuperclassesOnly = false) const;
    
    std::vector<const CYIRuntimeTypeInfo *> GetSubclassesTypeInfos(const CYIRuntimeTypeInfo &type, bool bDirectSubclassesOnly = false) const;
    
    std::vector<const CYIRuntimeTypeInfo *> GetRootTypeInfos() const;
    
    CYIString GenerateInheritanceTreeString(const CYIRuntimeTypeInfo &type, bool bUseASCII = false, const CYIString &textColor = "", const CYIString &graphColor = "", const CYIString &noticeColor = "") const;

private:
    struct StringComparator
    {
        inline bool operator()(const CYIString &lhs, const CYIString &rhs) const;
    };

    CYIRTTIRegistry();
    
    std::map<CYIString, const CYIRuntimeTypeInfo*, StringComparator> m_types;
    
    YI_DISALLOW_COPY_AND_ASSIGN(CYIRTTIRegistry)
};



#define YI_TYPE_BASES(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_BASES_, ##__VA_ARGS__)

#define YI_TYPE_DEF(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_, ##__VA_ARGS__)

#define YI_TYPE_DEF_INST(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_INST_, ##__VA_ARGS__)

#define YI_TYPE_DEF_WITH_NAME(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_WITH_NAME_, ##__VA_ARGS__)

#define YI_TYPE_DEF_INST_WITH_NAME(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_INST_WITH_NAME_, ##__VA_ARGS__)



#if defined(DOXY)

template<typename TARGET, typename SOURCE>
inline TARGET *YiDynamicCast(SOURCE *pObject);

template<typename TARGET, typename SOURCE>
inline std::shared_ptr<TARGET> YiDynamicPointerCast(const std::shared_ptr<SOURCE> &pObject);

template<typename TARGET, typename SOURCE>
inline std::shared_ptr<TARGET> YiDynamicCast(const std::shared_ptr<SOURCE> &pObject);
#endif

template<typename T>
std::unique_ptr<T> YiRTTINew(const CYIString &name);

const CYIRuntimeTypeInfo *YiGetTypeInfo(const char *pTypeName);

const CYIRuntimeTypeInfo *YiGetTypeInfo(const CYIString &typeName);

template<typename T>
inline const CYIRuntimeTypeInfo *YiGetTypeInfo(T *pObject);



#if defined(DOXY)

class RTTISampleClass : public Base1, public Base2, public Base3
{
public:
    static const CYIRuntimeTypeInfoTyped<RTTISampleClass, Base1, Base2, Base3> &GetClassTypeInfo();
    
    const CYIRuntimeTypeInfo &GetRuntimeTypeInfo() const;
};

#endif

#include "utility/YiRtti.inl"

#endif /* _YI_RTTI_H_ */