SdlField.h

Go to the documentation of this file.

#pragma once
 
#include "SDL/sdl_fwd.h"
#include "SDL/Introspect/EFieldImportance.h"
#include "SDL/Introspect/SdlNativeData.h"
 
#include <Common/logging.h>
 
#include <string>
#include <string_view>
#include <utility>
 
namespace ph
{
 
PH_DEFINE_EXTERNAL_LOG_GROUP(SdlField, SDL);
 
class SdlField
{
public:
    SdlField(std::string typeName, std::string fieldName);
 
    SdlField(
        std::string typeName, 
        std::string fieldName,
        std::string typeSignature);
 
    virtual ~SdlField();
 
    virtual SdlNativeData nativeData(SdlNonConstInstance instance) const = 0;
 
    std::string genPrettyName() const;
    std::string_view getTypeName() const;
    std::string_view getFieldName() const;
    std::string_view getDescription() const;
    std::string_view getTypeSignature() const;
 
    EFieldImportance getImportance() const;
 
    bool isFallbackEnabled() const;
 
protected:
    SdlField& setDescription(std::string descriptionStr);
 
    SdlField& setImportance(EFieldImportance importance);
 
    SdlField& setEnableFallback(bool isFallbackEnabled);
 
private:
    std::string m_typeName;
    std::string m_fieldName;
    std::string m_description;
    std::string m_typeSignature;
    EFieldImportance m_importance;
    bool m_isFallbackEnabled;
};
 
// In-header Implementation:
 
inline std::string_view SdlField::getTypeName() const
{
    return m_typeName;
}
 
inline std::string_view SdlField::getFieldName() const
{
    return m_fieldName;
}
 
inline std::string_view SdlField::getDescription() const
{
    return m_description;
}
 
inline std::string_view SdlField::getTypeSignature() const
{
    return m_typeSignature;
}
 
inline EFieldImportance SdlField::getImportance() const
{
    return m_importance;
}
 
inline bool SdlField::isFallbackEnabled() const
{
    return m_isFallbackEnabled;
}
 
inline SdlField& SdlField::setDescription(std::string descriptionStr)
{
    m_description = std::move(descriptionStr);
 
    return *this;
}
 
inline SdlField& SdlField::setImportance(EFieldImportance importance)
{
    m_importance = importance;
 
    return *this;
}
 
inline SdlField& SdlField::setEnableFallback(bool isFallbackEnabled)
{
    m_isFallbackEnabled = isFallbackEnabled;
 
    return *this;
}
 
}// end namespace ph