SdlEnum.h

Go to the documentation of this file.

#pragma once
 
#include <Common/primitive_type.h>
 
#include <string>
#include <string_view>
#include <cstddef>
#include <utility>
#include <vector>
 
namespace ph
{
 
class SdlEnum
{
public:
    template<typename ValueType>
    struct TEntry
    {
        std::string_view name;
        ValueType        value;
 
        inline TEntry() :
            name(), value(static_cast<ValueType>(0))
        {}
 
        inline TEntry(std::string_view name, ValueType value) :
            name(std::move(name)), value(std::move(value))
        {}
    };
 
    using Entry = TEntry<int64>;
 
    explicit SdlEnum(std::string name);
 
    virtual Entry getEntry(std::size_t entryIndex) const = 0;
    virtual std::size_t numEntries() const = 0;
 
    const std::string& getName() const;
    const std::string& getDescription() const;
    std::string getEntryDescription(std::size_t entryIndex) const;
 
protected:
    SdlEnum& setDescription(std::string description);
    SdlEnum& setEntryDescription(std::size_t entryIndex, std::string description);
 
private:
    std::string              m_name;
    std::string              m_description;
    std::vector<std::string> m_entryDescriptions;
};
 
// In-header Implementations:
 
inline SdlEnum::SdlEnum(std::string name) : 
    m_name(std::move(name))
{
    PH_ASSERT(!m_name.empty());
}
 
inline SdlEnum& SdlEnum::setDescription(std::string description)
{
    m_description = std::move(description);
 
    return *this;
}
 
inline SdlEnum& SdlEnum::setEntryDescription(const std::size_t entryIndex, std::string description)
{
    // Allocate more storage for entry descriptions if required
    if(entryIndex >= m_entryDescriptions.size())
    {
        m_entryDescriptions.resize(entryIndex + 1);
    }
 
    PH_ASSERT_LT(entryIndex, m_entryDescriptions.size());
    m_entryDescriptions[entryIndex] = std::move(description);
 
    return *this;
}
 
inline const std::string& SdlEnum::getName() const
{
    return m_name;
}
 
inline const std::string& SdlEnum::getDescription() const
{
    return m_description;
}
 
// Returns a copy of string as the method accepts out-of-bound entry index
inline std::string SdlEnum::getEntryDescription(const std::size_t entryIndex) const
{
    return entryIndex < m_entryDescriptions.size() ? 
        m_entryDescriptions[entryIndex] : "";
}
 
}// end namespace ph