Enums.h

Go to the documentation of this file.

#ifndef ZSERIO_ENUMS_H_INC
#define ZSERIO_ENUMS_H_INC
 
#include <algorithm>
#include <cstddef>
#include <type_traits>
 
#include "zserio/CppRuntimeException.h"
#include "zserio/StringView.h"
#include "zserio/Types.h"
 
// This should be implemented in runtime library header.
namespace zserio
{
 
// forward declarations
class BitStreamReader;
class BitStreamWriter;
 
template <typename T>
struct EnumTraits
{};
 
template <typename T>
size_t enumToOrdinal(T value);
 
template <typename T>
T valueToEnum(typename std::underlying_type<T>::type rawValue);
 
template <typename T>
constexpr typename std::underlying_type<T>::type enumToValue(T value)
{
    return static_cast<typename std::underlying_type<T>::type>(value);
}
 
template <typename T>
uint32_t enumHashCode(T value);
 
template <typename T>
T stringToEnum(StringView itemName)
{
    const auto foundIt = std::find_if(EnumTraits<T>::names.begin(), EnumTraits<T>::names.end(),
            [itemName](const char* enumItemName) { return itemName.compare(enumItemName) == 0; });
    if (foundIt == EnumTraits<T>::names.end())
    {
        throw CppRuntimeException("Enum item '")
                << itemName << "' doesn't exist in enum '" << EnumTraits<T>::enumName << "'!";
    }
 
    const size_t ordinal = static_cast<size_t>(std::distance(EnumTraits<T>::names.begin(), foundIt));
    return EnumTraits<T>::values[ordinal];
}
 
template <typename T>
const char* enumToString(T value)
{
    return EnumTraits<T>::names[enumToOrdinal(value)];
}
 
template <typename PACKING_CONTEXT, typename T>
void initPackingContext(PACKING_CONTEXT& context, T value);
 
template <typename T>
size_t bitSizeOf(T value);
 
template <typename PACKING_CONTEXT, typename T>
size_t bitSizeOf(PACKING_CONTEXT& context, T value);
 
template <typename T>
size_t initializeOffsets(size_t bitPosition, T value);
 
template <typename PACKING_CONTEXT, typename T>
size_t initializeOffsets(PACKING_CONTEXT& context, size_t bitPosition, T value);
 
template <typename T>
T read(BitStreamReader& in);
 
template <typename T, typename PACKING_CONTEXT>
T read(PACKING_CONTEXT& context, BitStreamReader& in);
 
template <typename T>
void write(BitStreamWriter& out, T value);
 
template <typename PACKING_CONTEXT, typename T>
void write(PACKING_CONTEXT& context, BitStreamWriter& out, T value);
 
template <typename T, typename std::enable_if<std::is_enum<T>::value, int>::type = 0>
CppRuntimeException& operator<<(CppRuntimeException& exception, T value)
{
    exception << enumToString(value);
    return exception;
}
 
} // namespace zserio
 
#endif // ZSERIO_ENUMS_H_INC