Field.h

Go to the documentation of this file.

//
// Copyright 2014 - 2026 (C). Alex Robenko. All rights reserved.
//
// SPDX-License-Identifier: MPL-2.0
//
// 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 "comms/details/FieldBase.h"
#include "comms/details/field_alias.h"
#include "comms/details/fields_access.h"
#include "comms/details/macro_common.h"
#include "comms/util/access.h"
 
#include <cstddef>
#include <type_traits>
 
namespace comms
{
 
template <typename... TOptions>
class Field : public details::FieldBase<TOptions...>
{
    using BaseImpl = details::FieldBase<TOptions...>;
public:
    using Endian = typename BaseImpl::Endian;
 
    using VersionType = typename BaseImpl::VersionType;
 
    static constexpr bool valid()
    {
        return true;
    }
 
    static constexpr bool refresh()
    {
        return false;
    }
 
    static constexpr bool isVersionDependent()
    {
        return false;
    }
 
    static constexpr bool hasNonDefaultRefresh()
    {
        return false;
    }
 
    static constexpr bool hasReadNoStatus()
    {
        return true;
    }
 
    static constexpr bool hasWriteNoStatus()
    {
        return true;
    }
 
    static constexpr bool hasVarLength()
    {
        return false;
    }
 
    static constexpr bool canWrite()
    {
        return true;
    }
 
    static constexpr bool setVersion(VersionType)
    {
        return false;
    }
 
    static constexpr bool hasName()
    {
        return false;
    }
 
protected:
    template <typename T, typename TIter>
    static void writeData(T value, TIter& iter)
    {
        writeData<sizeof(T), T>(value, iter);
    }
 
    template <std::size_t TSize, typename T, typename TIter>
    static void writeData(T value, TIter& iter)
    {
        static_assert(TSize <= sizeof(T),
                                    "Cannot put more bytes than type contains");
        return util::writeData<TSize, T>(value, iter, Endian());
    }
 
    template <typename T, typename TIter>
    static T readData(TIter& iter)
    {
        return readData<T, sizeof(T)>(iter);
    }
 
    template <typename T, std::size_t TSize, typename TIter>
    static T readData(TIter& iter)
    {
        static_assert(TSize <= sizeof(T),
            "Cannot get more bytes than type contains");
        return util::readData<T, TSize>(iter, Endian());
    }
 
};
 
#define COMMS_FIELD_MEMBERS_ACCESS(...) \
    COMMS_EXPAND(COMMS_DEFINE_FIELD_ENUM(__VA_ARGS__)) \
    COMMS_FIELD_VALUE_ACCESS_FUNC { \
        auto& val = comms::field::toFieldBase(*this).value(); \
        using AllFieldsTuple = typename std::decay<decltype(val)>::type; \
        static_assert(std::tuple_size<AllFieldsTuple>::value == FieldIdx_numOfValues, \
            "Invalid number of names for fields tuple"); \
        return val; \
    } \
    COMMS_FIELD_VALUE_ACCESS_CONST_FUNC { \
        auto& val = comms::field::toFieldBase(*this).value(); \
        using AllFieldsTuple = typename std::decay<decltype(val)>::type; \
        static_assert(std::tuple_size<AllFieldsTuple>::value == FieldIdx_numOfValues, \
            "Invalid number of names for fields tuple"); \
        return val; \
    } \
    COMMS_EXPAND(COMMS_DO_FIELD_ACC_FUNC(ValueType, value(), __VA_ARGS__))
 
#define COMMS_FIELD_MEMBERS_ACCESS_NOTEMPLATE(...) \
    COMMS_EXPAND(COMMS_DEFINE_FIELD_ENUM(__VA_ARGS__)) \
    COMMS_EXPAND(COMMS_DO_FIELD_ACC_FUNC_NOTEMPLATE(__VA_ARGS__))
 
#define COMMS_FIELD_MEMBERS_NAMES(...) \
    COMMS_EXPAND(COMMS_FIELD_MEMBERS_ACCESS(__VA_ARGS__)) \
    COMMS_EXPAND(COMMS_DO_FIELD_TYPEDEF(typename Base::ValueType, Field_, FieldIdx_, __VA_ARGS__))
 
#define COMMS_FIELD_ALIAS(f_, ...) COMMS_DO_ALIAS(field_, f_, __VA_ARGS__)
 
}  // namespace comms