ArrayList.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 "comms/CompileControl.h"
 
#include <vector>
 
#if COMMS_HAS_CPP20_SPAN
#include <span>
#endif // #if COMMS_HAS_CPP20_SPAN
 
#include "comms/ErrorStatus.h"
#include "comms/options.h"
#include "comms/util/StaticVector.h"
#include "comms/util/ArrayView.h"
#include "comms/util/type_traits.h"
#include "basic/ArrayList.h"
#include "details/AdaptBasicField.h"
#include "details/OptionsParser.h"
 
namespace comms
{
 
namespace field
{
 
namespace details
{
 
template <bool THasOrigDataViewStorage>
struct ArrayListOrigDataViewStorageType;
 
template <>
struct ArrayListOrigDataViewStorageType<true>
{
#if COMMS_HAS_CPP20_SPAN
    template <typename TElement>
    using Type = std::span<TElement>;
#else // #if COMMS_HAS_CPP20_SPAN    
    template <typename TElement>
    using Type = comms::util::ArrayView<TElement>;
#endif // #if COMMS_HAS_CPP20_SPAN        
};
 
template <>
struct ArrayListOrigDataViewStorageType<false>
{
    template <typename TElement>
    using Type = std::vector<TElement>;
};
 
template <bool THasSequenceFixedSizeUseFixedSizeStorage>
struct ArrayListSequenceFixedSizeUseFixedSizeStorageType;
 
template <>
struct ArrayListSequenceFixedSizeUseFixedSizeStorageType<true>
{
    template <typename TElement, typename TOpt>
    using Type = comms::util::StaticVector<TElement, TOpt::SequenceFixedSize>;
};
 
template <>
struct ArrayListSequenceFixedSizeUseFixedSizeStorageType<false>
{
    template <typename TElement, typename TOpt>
    using Type =
        typename ArrayListOrigDataViewStorageType<
            TOpt::HasOrigDataView && std::is_integral<TElement>::value && (sizeof(TElement) == sizeof(std::uint8_t))
        >::template Type<TElement>;
};
 
template <bool THasFixedSizeStorage>
struct ArrayListFixedSizeStorageType;
 
template <>
struct ArrayListFixedSizeStorageType<true>
{
    template <typename TElement, typename TOpt>
    using Type = comms::util::StaticVector<TElement, TOpt::FixedSizeStorage>;
};
 
template <>
struct ArrayListFixedSizeStorageType<false>
{
    template <typename TElement, typename TOpt>
    using Type =
        typename ArrayListSequenceFixedSizeUseFixedSizeStorageType<TOpt::HasSequenceFixedSizeUseFixedSizeStorage>
            ::template Type<TElement, TOpt>;
};
 
template <bool THasCustomStorage>
struct ArrayListCustomArrayListStorageType;
 
template <>
struct ArrayListCustomArrayListStorageType<true>
{
    template <typename TElement, typename TOpt>
    using Type = typename TOpt::CustomStorageType;
};
 
template <>
struct ArrayListCustomArrayListStorageType<false>
{
    template <typename TElement, typename TOpt>
    using Type =
        typename ArrayListFixedSizeStorageType<TOpt::HasFixedSizeStorage>::template Type<TElement, TOpt>;
};
 
template <typename TElement, typename TOpt>
using ArrayListStorageTypeT =
    typename ArrayListCustomArrayListStorageType<TOpt::HasCustomStorageType>::template Type<TElement, TOpt>;
 
template <typename TFieldBase, typename TElement, typename... TOptions>
using ArrayListBase =
    AdaptBasicFieldT<
        comms::field::basic::ArrayList<
            TFieldBase,
            ArrayListStorageTypeT<TElement, OptionsParser<TOptions...> >
        >,
        TOptions...
    >;
 
}  // namespace details
 
 
template <typename TFieldBase, typename TElement, typename... TOptions>
class ArrayList : public details::ArrayListBase<TFieldBase, TElement, TOptions...>
{
    using BaseImpl = details::ArrayListBase<TFieldBase, TElement, TOptions...>;
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 ElementType = typename BaseImpl::ElementType;
 
    using FieldType = typename ParsedOptions::FieldType;    
 
    using SizeFieldPrefix = typename ParsedOptions::SequenceSizeFieldPrefix;
 
    using SerLengthFieldPrefix = typename ParsedOptions::SequenceSerLengthFieldPrefix;    
 
    using ElemSerLengthFieldPrefix = typename ParsedOptions::SequenceElemSerLengthFieldPrefix;    
 
    using ElemFixedSerLengthFieldPrefix = typename ParsedOptions::SequenceElemFixedSerLengthFieldPrefix;    
 
    using TerminationFieldSuffix = typename ParsedOptions::SequenceTerminationFieldSuffix;    
 
    using TrailingFieldSuffix = typename ParsedOptions::SequenceTrailingFieldSuffix;      
 
    ArrayList() = default;
 
    explicit ArrayList(const ValueType& val)
      : BaseImpl(val)
    {
    }
 
    explicit ArrayList(ValueType&& val)
      : BaseImpl(std::move(val))
    {
    }
 
    ArrayList(const ArrayList&) = default;
 
    ArrayList(ArrayList&&) = default;
 
    ~ArrayList() noexcept = default;
 
    ArrayList& operator=(const ArrayList&) = default;
 
    ArrayList& operator=(ArrayList&&) = 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 hasSizeFieldPrefix()
    {
        return ParsedOptions::HasSequenceSizeFieldPrefix;
    }
 
    static constexpr bool hasSerLengthFieldPrefix()
    {
        return ParsedOptions::HasSequenceSerLengthFieldPrefix;
    }    
 
    static constexpr bool hasElemSerLengthFieldPrefix()
    {
        return ParsedOptions::HasSequenceElemSerLengthFieldPrefix;
    }
 
    static constexpr bool hasElemFixedSerLengthFieldPrefix()
    {
        return ParsedOptions::HasSequenceElemFixedSerLengthFieldPrefix;
    }    
 
    static constexpr bool hasTerminationFieldSuffix()
    {
        return ParsedOptions::HasSequenceTerminationFieldSuffix;
    }      
 
    static constexpr bool hasTrailingFieldSuffix()
    {
        return ParsedOptions::HasSequenceTrailingFieldSuffix;
    }    
 
    static constexpr bool hasFixedSize()
    {
        return ParsedOptions::HasSequenceFixedSize;
    }   
 
    static constexpr bool hasFixedValue()
    {
        return ParsedOptions::HasFixedValue;
    }      
 
    static constexpr bool hasName()
    {
        return ParsedOptions::HasName;
    }  
 
    static constexpr std::size_t fixedSize()
    {
        return ParsedOptions::SequenceFixedSize;
    }           
 
    ValueType& value()
    {
        return BaseImpl::value();
    }
 
    const ValueType& value() const
    {
        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();
    }
 
    template <typename TIter>
    ErrorStatus read(TIter& iter, std::size_t len)
    {
        return BaseImpl::read(iter, len);
    }
 
    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 len) const
    {
        return BaseImpl::write(iter, len);
    }
 
    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 std::size_t minLength()
    {
        return BaseImpl::minLength();
    }
 
    static constexpr std::size_t maxLength()
    {
        return BaseImpl::maxLength();
    }
 
    void forceReadElemCount(std::size_t count)
    {
        return BaseImpl::forceReadElemCount(count);
    }
 
    void clearReadElemCount()
    {
        return BaseImpl::clearReadElemCount();
    }
 
    void forceReadLength(std::size_t count)
    {
        return BaseImpl::forceReadLength(count);
    }
 
    void clearReadLengthForcing()
    {
        return BaseImpl::clearReadLengthForcing();
    }
 
    void forceReadElemLength(std::size_t count)
    {
        return BaseImpl::forceReadElemLength(count);
    }
 
    void clearReadElemLengthForcing()
    {
        return BaseImpl::clearReadElemLengthForcing();
    }
 
    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);
    }
 
#ifdef FOR_DOXYGEN_DOC_ONLY
    auto terminationFieldSuffix() -> decltype(BaseImpl::terminationFieldSuffix())
    {
        return BaseImpl::terminationFieldSuffix();
    }    
 
    auto terminationFieldSuffix() const -> decltype(BaseImpl::terminationFieldSuffix())
    {
        return BaseImpl::terminationFieldSuffix();
    }     
 
#endif // #ifdef FOR_DOXYGEN_DOC_ONLY    
 
protected:
    using BaseImpl::readData;
    using BaseImpl::writeData;
 
private:
    static_assert(!ParsedOptions::HasSerOffset,
            "comms::option::def::NumValueSerOffset option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasFixedLengthLimit,
            "comms::option::def::FixedLength option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasFixedBitLengthLimit,
            "comms::option::def::FixedBitLength option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasVarLengthLimits,
            "comms::option::def::VarLength option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasAvailableLengthLimit,
            "comms::option::def::AvailableLengthLimit option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasScalingRatio,
            "comms::option::def::ScalingRatio option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasUnits,
            "comms::option::def::Units option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasMultiRangeValidation,
            "comms::option::def::ValidNumValueRange (or similar) option is not applicable to ArrayList field");
    static_assert((!ParsedOptions::HasOrigDataView) || (std::is_integral<TElement>::value && (sizeof(TElement) == sizeof(std::uint8_t))),
        "Usage of comms::option::app::OrigDataView option is allowed only for raw binary data (std::uint8_t) types.");
    static_assert(!ParsedOptions::HasVersionsRange,
            "comms::option::def::ExistsBetweenVersions (or similar) option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasInvalidByDefault,
            "comms::option::def::InvalidByDefault option is not applicable to ArrayList field");
    static_assert(!ParsedOptions::HasMissingOnReadFail,
            "comms::option::def::MissingOnReadFail option is not applicable to ArrayList field");     
    static_assert(!ParsedOptions::HasMissingOnInvalid,
            "comms::option::def::MissingOnInvalid option is not applicable to ArrayList field");                       
};
 
template <typename TFieldBase, typename TElement, typename... TOptions>
bool operator<(
    const ArrayList<TFieldBase, TElement, TOptions...>& field1,
    const ArrayList<TFieldBase, TElement, TOptions...>& field2) noexcept
{
    return std::lexicographical_compare(
                field1.value().begin(), field1.value().end(),
                field2.value().begin(), field2.value().end());
}
 
template <typename TFieldBase, typename TElement, typename... TOptions>
bool operator==(
    const ArrayList<TFieldBase, TElement, TOptions...>& field1,
    const ArrayList<TFieldBase, TElement, TOptions...>& field2) noexcept
{
    auto& vec1 = field1.value();
    auto& vec2 = field2.value();
    if (vec1.size() != vec2.size()) {
        return false;
    }
 
    for (auto idx = 0U; idx < vec1.size(); ++idx) {
        if (vec1[idx] != vec2[idx]) {
            return false;
        }
    }
    return true;
}
 
template <typename TFieldBase, typename TElement, typename... TOptions>
bool operator!=(
    const ArrayList<TFieldBase, TElement, TOptions...>& field1,
    const ArrayList<TFieldBase, TElement, TOptions...>& field2) noexcept
{
    return !(field1 == field2);
}
 
template <typename T>
constexpr bool isArrayList()
{
    return 
        std::is_same<typename T::CommsTag, tag::ArrayList>::value || 
        std::is_same<typename T::CommsTag, tag::RawArrayList>::value;
}
 
template <typename TFieldBase, typename TElement, typename... TOptions>
inline
ArrayList<TFieldBase, TElement, TOptions...>&
toFieldBase(ArrayList<TFieldBase, TElement, TOptions...>& field)
{
    return field;
}
 
template <typename TFieldBase, typename TElement, typename... TOptions>
inline
const ArrayList<TFieldBase, TElement, TOptions...>&
toFieldBase(const ArrayList<TFieldBase, TElement, TOptions...>& field)
{
    return field;
}
 
 
}  // namespace field
 
}  // namespace comms