EnumValue.h

Go to the documentation of this file.

//
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
#pragma once
 
#include <type_traits>
 
#include "comms/options.h"
#include "details/OptionsParser.h"
#include "basic/EnumValue.h"
#include "details/AdaptBasicField.h"
 
namespace comms
{
namespace field
{
 
template <typename TFieldBase, typename TEnum, typename... TOptions>
class EnumValue : public details::AdaptBasicFieldT<basic::EnumValue<TFieldBase, TEnum>, TOptions...>
{
    using BaseImpl = details::AdaptBasicFieldT<basic::EnumValue<TFieldBase, TEnum>, TOptions...>;
    static_assert(std::is_enum<TEnum>::value, "TEnum must be enum type");
 
public:
    using FieldBase = TFieldBase;
 
    using Endian = typename BaseImpl::Endian;
 
    using VersionType = typename BaseImpl::VersionType;
 
    using ParsedOptions = details::OptionsParser<TOptions...>;
 
    using CommsTag = typename BaseImpl::CommsTag;
 
    using ValueType = typename BaseImpl::ValueType;
 
    using FieldType = typename ParsedOptions::FieldType;    
 
    EnumValue() = default;
 
    explicit EnumValue(const ValueType& val)
      : BaseImpl(val)
    {
    }
 
    EnumValue(const EnumValue&) = default;
 
    ~EnumValue() noexcept = default;
 
    EnumValue& operator=(const EnumValue&) = default;
 
    static constexpr bool hasFailOnInvalid()
    {
        return ParsedOptions::HasFailOnInvalid;
    }
 
    static constexpr bool hasIgnoreInvalid()
    {
        return ParsedOptions::HasIgnoreInvalid;
    }
 
    static constexpr bool hasEmptySerialization()
    {
        return ParsedOptions::HasEmptySerialization;
    }    
 
    static constexpr bool hasFieldType()
    {
        return ParsedOptions::HasFieldType;
    }    
 
    static constexpr bool hasFixedValue()
    {
        return ParsedOptions::HasFixedValue;
    }   
 
    static constexpr bool hasName()
    {
        return ParsedOptions::HasName;
    }    
 
    const ValueType& value() const
    {
        return BaseImpl::value();
    }
 
    ValueType& value()
    {
        return BaseImpl::value();
    }
 
    const ValueType& getValue() const
    {
        return BaseImpl::getValue();
    }
 
    template <typename U>
    void setValue(U&& val)
    {
        BaseImpl::setValue(std::forward<U>(val));
    }          
 
    constexpr std::size_t length() const
    {
        return BaseImpl::length();
    }
 
    static constexpr std::size_t minLength()
    {
        return BaseImpl::minLength();
    }
 
    static constexpr std::size_t maxLength()
    {
        return BaseImpl::maxLength();
    }
 
    template <typename TIter>
    ErrorStatus read(TIter& iter, std::size_t size)
    {
        return BaseImpl::read(iter, size);
    }
 
    static constexpr bool hasReadNoStatus()
    {
        return BaseImpl::hasReadNoStatus();
    }
 
    template <typename TIter>
    void readNoStatus(TIter& iter)
    {
        BaseImpl::readNoStatus(iter);
    }
 
    bool canWrite() const
    {
        return BaseImpl::canWrite();
    }
 
    template <typename TIter>
    ErrorStatus write(TIter& iter, std::size_t size) const
    {
        return BaseImpl::write(iter, size);
    }
 
    static constexpr bool hasWriteNoStatus()
    {
        return BaseImpl::hasWriteNoStatus();
    }
 
    template <typename TIter>
    void writeNoStatus(TIter& iter) const
    {
        BaseImpl::writeNoStatus(iter);
    }
 
    bool valid() const
    {
        return BaseImpl::valid();
    }
 
    bool refresh()
    {
        return BaseImpl::refresh();
    }
 
    static constexpr bool isVersionDependent()
    {
        return ParsedOptions::HasCustomVersionUpdate || BaseImpl::isVersionDependent();
    }
 
    static constexpr bool hasNonDefaultRefresh()
    {
        return BaseImpl::hasNonDefaultRefresh();
    }
 
    VersionType getVersion() const
    {
        return BaseImpl::getVersion();
    }
 
    bool setVersion(VersionType version)
    {
        return BaseImpl::setVersion(version);
    }
 
    void setForcedLength(int len)
    {
        BaseImpl::setForcedLength(len);
    }
 
    int getForcedLength() const
    {
        return BaseImpl::getForcedLength();
    }    
 
protected:
    using BaseImpl::readData;
    using BaseImpl::writeData;
private:
    static_assert(!ParsedOptions::HasSequenceElemLengthForcing,
        "comms::option::def::SequenceElemLengthForcingEnabled option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceSizeForcing,
        "comms::option::def::SequenceSizeForcingEnabled option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceLengthForcing,
        "comms::option::def::SequenceLengthForcingEnabled option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceFixedSize,
        "comms::option::def::SequenceFixedSize option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceFixedSizeUseFixedSizeStorage,
        "comms::option::app::SequenceFixedSizeUseFixedSizeStorage option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceSizeFieldPrefix,
        "comms::option::def::SequenceSizeFieldPrefix option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceSerLengthFieldPrefix,
        "comms::option::def::SequenceSerLengthFieldPrefix option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceElemSerLengthFieldPrefix,
        "comms::option::def::SequenceElemSerLengthFieldPrefix option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceElemFixedSerLengthFieldPrefix,
        "comms::option::def::SequenceElemSerLengthFixedFieldPrefix option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceTrailingFieldSuffix,
        "comms::option::def::SequenceTrailingFieldSuffix option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasSequenceTerminationFieldSuffix,
        "comms::option::def::SequenceTerminationFieldSuffix option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasFixedSizeStorage,
        "comms::option::app::FixedSizeStorage option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasCustomStorageType,
        "comms::option::app::CustomStorageType option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasScalingRatio,
        "comms::option::def::ScalingRatio option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasUnits,
        "comms::option::def::Units option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasOrigDataView,
        "comms::option::app::OrigDataView option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasVersionsRange,
        "comms::option::def::ExistsBetweenVersions (or similar) option is not applicable to EnumValue field");
    static_assert(!ParsedOptions::HasMissingOnReadFail,
            "comms::option::def::MissingOnReadFail option is not applicable to EnumValue field");           
    static_assert(!ParsedOptions::HasMissingOnInvalid,
            "comms::option::def::MissingOnInvalid option is not applicable to EnumValue field");                
};
 
// Implementation
 
template <typename TFieldBase, typename TEnum, typename... TOptions>
bool operator==(
    const EnumValue<TFieldBase, TEnum, TOptions...>& field1,
    const EnumValue<TFieldBase, TEnum, TOptions...>& field2) noexcept
{
    return field1.value() == field2.value();
}
 
template <typename TFieldBase, typename TEnum, typename... TOptions>
bool operator!=(
    const EnumValue<TFieldBase, TEnum, TOptions...>& field1,
    const EnumValue<TFieldBase, TEnum, TOptions...>& field2) noexcept
{
    return field1.value() != field2.value();
}
 
template <typename TFieldBase, typename TEnum, typename... TOptions>
bool operator<(
    const EnumValue<TFieldBase, TEnum, TOptions...>& field1,
    const EnumValue<TFieldBase, TEnum, TOptions...>& field2) noexcept
{
    return field1.value() < field2.value();
}
 
template <typename T>
constexpr bool isEnumValue()
{
    return std::is_same<typename T::CommsTag, tag::Enum>::value;
}
 
template <typename TFieldBase, typename TEnum, typename... TOptions>
inline
EnumValue<TFieldBase, TEnum, TOptions...>&
toFieldBase(EnumValue<TFieldBase, TEnum, TOptions...>& field)
{
    return field;
}
 
template <typename TFieldBase, typename TEnum, typename... TOptions>
inline
const EnumValue<TFieldBase, TEnum, TOptions...>&
toFieldBase(const EnumValue<TFieldBase, TEnum, TOptions...>& field)
{
    return field;
}
 
}  // namespace field
 
}  // namespace comms