Release v3.4.1

Author: arobenko

.github/workflows/actions_build.yml

@@ -3,8 +3,8 @@ name: Github Actions Build
 on: [push]
 
 jobs:
-  build_gcc_ubuntu_16_04:
-    runs-on: ubuntu-16.04
+  build_gcc_ubuntu_18_04:
+    runs-on: ubuntu-18.04
     strategy:
       fail-fast: false
       matrix:

CMakeLists.txt

@@ -14,7 +14,7 @@ option (CC_BUILD_DEMO_PROTOCOL "Build demo protocol plugin." OFF)
 option (CC_INSTALL_DEMO_PROTOCOL "Install demo protocol plugin." ${CC_BUILD_DEMO_PROTOCOL})
 option (CC_WARN_AS_ERR "Treat warning as error" ON)
 option (CC_USE_CCACHE "Use ccache on UNIX systems if it's available" ON)
-option (CC_SKIP_CXX_STANDARD_FORCING "Use ccache on UNIX systems if it's available" ON)
+option (CC_SKIP_CXX_STANDARD_FORCING "Do NOT force C++ standard to C++11, use compiler's default one." ON)
 option (CC_STATIC_RUNTIME "Enable/Disable static runtime" OFF)
 
 # Extra variables

README.md

@@ -169,7 +169,7 @@ or **cc_dump.exe**), which resides in
 **${CMAKE_ISNTALL_PREFIX}/bin** directory. If the execution fails due to missing **Qt5** dlls,
 either set your **%PATH%** variable accordingly or try to execute generated **.bat**
 files (**cc_view.bat** or **cc_dump.bat**) residing in the same directory. Another
-option is to build **deploy_qt** target to deploy Qt5 libraries into installation directory, whill will allow execution of any **.exe** file without and extra manupulations.
+option is to build **deploy_qt** target to deploy Qt5 libraries into installation directory, which will allow execution of any **.exe** file without any extra manipulations.
 
 On Linux platforms use the appropriate shell script 
 (**cc_view.sh** or **cc_dump.sh**), which also resides in

cmake/CC_External.cmake

@@ -24,6 +24,7 @@
 #         [REPO <repo>]
 #         [CMAKE_ARGS <arg1> <arg2> ...]
 #         [NO_DEFAULT_CMAKE_ARGS]
+#         [NO_REPO]
 #     )
 # - SRC_DIR - A directory where comms_champion sources will end up.
 # - BUILD_DIR - A build directory, defaults to ${PROJECT_BINARY_DIR}/comms_champion
@@ -41,6 +42,8 @@
 #         * CMAKE_CXX_STANDARD=${CMAKE_CXX_STANDARD}
 #       The default values are passed before ones specified in CMAKE_ARGS, which can overwrite 
 #       some of the default values.
+# - NO_REPO - Don't checkout sources, SRC_DIR must contain checkout out sources, suitable 
+#       for this repo being a submodule.
 #
 # ******************************************************
 # - Build comms_champion as external project during normal build process.
@@ -68,7 +71,8 @@
 # - CMAKE_ARGS - Extra cmake arguments to be passed to the comms_champion project.
 # - QT_DIR - Path to external Qt5 libraries, will be passed to the comms_champion 
 #   build process using CC_QT_DIR variable.
-# - NO_REPO - Don't checkout sources, SRC_DIR must contain checkout out sources, suitable for this repo being a submodule.
+# - NO_REPO - Don't checkout sources, SRC_DIR must contain checkout out sources, 
+#       suitable for this repo being a submodule.
 # - NO_TOOLS - Will disable build of the CommsChampion Tools, will result in 
 #   having CC_BUILD_TOOLS_LIBRARY=OFF option being passed to the build process.
 # - NO_DEPLOY_QT - Don't generate "deploy_qt" build target when applicable.
@@ -155,7 +159,7 @@ endfunction ()
 
 function (cc_build_during_config)
     set (_prefix CC_BUILD)
-    set (_options NO_DEFAULT_CMAKE_ARGS)
+    set (_options NO_DEFAULT_CMAKE_ARGS NO_REPO)
     set (_oneValueArgs SRC_DIR BUILD_DIR REPO TAG)
     set (_mutiValueArgs CMAKE_ARGS)
     cmake_parse_arguments(${_prefix} "${_options}" "${_oneValueArgs}" "${_mutiValueArgs}" ${ARGN})
@@ -176,7 +180,9 @@ function (cc_build_during_config)
         set (CC_BUILD_TAG ${CC_EXTERNAL_DEFAULT_TAG})
     endif () 
 
-    cc_pull_sources(SRC_DIR ${CC_BUILD_SRC_DIR} REPO ${CC_BUILD_REPO} TAG ${CC_BUILD_TAG})      
+    if (NOT CC_BUILD_NO_REPO)
+        cc_pull_sources(SRC_DIR ${CC_BUILD_SRC_DIR} REPO ${CC_BUILD_REPO} TAG ${CC_BUILD_TAG})      
+    endif ()
 
     execute_process (
         COMMAND ${CMAKE_COMMAND} -E make_directory "${CC_BUILD_BUILD_DIR}"

comms/doc/page_custom_checksum_layer.dox

@@ -267,6 +267,10 @@
 /// function that is invoked to calculate serialization length of the field.
 /// @li @ref comms::protocol::ChecksumLayer::calculateChecksum() "calculateChecksum()" - 
 /// Member function that is responsible to calculate a checksum on provided range.
+/// @li @ref comms::protocol::ChecksumLayer::getChecksumFromField() "getChecksumFromField()" - 
+/// Retrieve value of the checksum from the field.
+/// @li @ref comms::protocol::ChecksumLayer::prepareFieldForWrite() "prepareFieldForWrite()" -
+/// Assign the calculated checksum value to the field's value.
 /// 
 /// The newly defined custom protocol stack layer can be used instead of
 /// @ref comms::protocol::ChecksumLayer when defining 

comms/include/comms/protocol/ChecksumLayer.h

@@ -20,6 +20,7 @@
 #include "comms/protocol/details/ProtocolLayerExtendingClassHelper.h"
 #include "comms/util/type_traits.h"
 #include "comms/details/tag.h"
+#include "comms/cast.h"
 
 COMMS_MSVC_WARNING_PUSH
 COMMS_MSVC_WARNING_DISABLE(4189) // Disable erroneous initialized but not referenced variable warning
@@ -42,8 +43,8 @@ namespace protocol
 ///     ResultType operator()(TIter& iter, std::size_t len) const;
 ///     @endcode
 ///     It is up to the checksum calculator to choose the "ResultType" it
-///     returns. The falue is going to be casted to Field::ValueType before
-///     assigning it as a value of the check field being read and/or written.@n
+///     returns. The falue is going to be casted to @b Field::ValueType before
+///     assigning it as a value of the checksum field being read and/or written.@n
 ///     Available checksum algorithms provided by the COMMS library reside in
 ///     @ref comms::protocol::checksum namespace (`comms/protocol/checkum` folder).
 /// @tparam TNextLayer Next transport layer in protocol stack.
@@ -318,15 +319,39 @@ class ChecksumLayer : public
         static_cast<void>(msg);
         checksumValid = true;
         return TCalc()(iter, len);
-    }    
+    }
 
-private:
-    static_assert(comms::field::isIntValue<Field>(),
-        "The checksum field is expected to be of IntValue type");
+    /// @brief Retrieve checksum value from the field.
+    /// @details May be overridden by the extending class.
+    ///     Default implementation is
+    ///     @code
+    ///     return field.value();
+    ///     @endcode
+    /// @param[in] field Field for this layer.
+    static auto getChecksumFromField(const Field& field) -> typename Field::ValueType
+    {
+        return field.value();
+    }
 
-    static_assert(Field::minLength() == Field::maxLength(),
-        "The checksum field is expected to be of fixed length");
+    /// @brief Prepare field for writing
+    /// @details Must assign provided checksum value. 
+    ///     May be overridden by the extending class if some complex functionality is required.
+    ///     The default implementation is:
+    ///     @code
+    ///     comms::cast_assign(field.value()) = checksum;
+    ///     @endcode
+    /// @param[in] checksum Checksum value to assign
+    /// @param[in] msg Pointer to message object being written, may be nullptr.
+    /// @param[out] field Field, value of which needs to be populated
+    /// @note May be non-static in the extending class. In case of non-static must be const.
+    template <typename TChecksum, typename TMsg>
+    static void prepareFieldForWrite(TChecksum checksum, const TMsg* msg, Field& field)
+    {
+        static_cast<void>(msg);
+        comms::cast_assign(field.value()) = checksum;
+    }
 
+private:
     template <typename... TParams>
     using VerifyBeforeReadTag = comms::details::tag::Tag1<>;
 
@@ -369,7 +394,7 @@ class ChecksumLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        auto expectedValue = field.value();
+        auto expectedValue = thisObj.getChecksumFromField(field);
 
         if (expectedValue != static_cast<decltype(expectedValue)>(checksum)) {
             BaseImpl::resetMsg(msg);
@@ -428,7 +453,7 @@ class ChecksumLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        auto expectedValue = field.value();
+        auto expectedValue = thisObj.getChecksumFromField(field);
 
         if (expectedValue != static_cast<decltype(expectedValue)>(checksum)) {
             BaseImpl::resetMsg(msg);
@@ -499,6 +524,7 @@ class ChecksumLayer : public
         auto& thisObj = BaseImpl::thisLayer();
 
         if (es == comms::ErrorStatus::UpdateRequired) {
+            thisObj.prepareFieldForWrite(0, &msg, field);
             auto esTmp = thisObj.writeField(&msg, field, iter, remSize);
             if (esTmp != comms::ErrorStatus::Success) {
                 return esTmp;
@@ -519,8 +545,7 @@ class ChecksumLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        using FieldValueType = typename Field::ValueType;
-        field.value() = static_cast<FieldValueType>(checksum);
+        thisObj.prepareFieldForWrite(checksum, &msg, field);
         return thisObj.writeField(&msg, field, iter, remSize);
     }
 
@@ -596,8 +621,7 @@ class ChecksumLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        using FieldValueType = typename Field::ValueType;
-        field.value() = static_cast<FieldValueType>(checksum);
+        thisObj.prepareFieldForWrite(checksum, msgPtr, field);
         return thisObj.writeField(msgPtr, field, to, remSize);
     }
 };

comms/include/comms/protocol/ChecksumPrefixLayer.h

@@ -225,7 +225,6 @@ class ChecksumPrefixLayer : public
         using IterType = typename std::decay<decltype(iter)>::type;
         using Tag = typename std::iterator_traits<IterType>::iterator_category;
 
-        field.value() = 0;
         return writeInternal(field, msg, iter, size, std::forward<TNextLayerWriter>(nextLayerWriter), Tag());
     }
 
@@ -347,12 +346,37 @@ class ChecksumPrefixLayer : public
         return TCalc()(iter, len);
     }    
 
-private:
-    static_assert(comms::field::isIntValue<Field>(),
-        "The checksum field is expected to be of IntValue type");
+    /// @brief Retrieve checksum value from the field.
+    /// @details May be overridden by the extending class.
+    ///     Default implementation is
+    ///     @code
+    ///     return field.value();
+    ///     @endcode
+    /// @param[in] field Field for this layer.
+    static auto getChecksumFromField(const Field& field) -> typename Field::ValueType
+    {
+        return field.value();
+    }
+
+    /// @brief Prepare field for writing
+    /// @details Must assign provided checksum value. 
+    ///     May be overridden by the extending class if some complex functionality is required.
+    ///     The default implementation is:
+    ///     @code
+    ///     comms::cast_assign(field.value()) = checksum;
+    ///     @endcode
+    /// @param[in] checksum Checksum value to assign
+    /// @param[in] msg Pointer to message object being written, may be nullptr.
+    /// @param[out] field Field, value of which needs to be populated
+    /// @note May be non-static in the extending class. In case of non-static, must be const
+    template <typename TChecksum, typename TMsg>
+    static void prepareFieldForWrite(TChecksum checksum, const TMsg* msg, Field& field)
+    {
+        static_cast<void>(msg);
+        comms::cast_assign(field.value()) = checksum;
+    }
 
-    static_assert(Field::minLength() == Field::maxLength(),
-        "The checksum field is expected to be of fixed length");
+private:
 
     template <typename... TParams>
     using VerifyBeforeReadTag = comms::details::tag::Tag1<>;
@@ -385,8 +409,7 @@ class ChecksumPrefixLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        auto expectedValue = field.value();
-
+        auto expectedValue = thisObj.getChecksumFromField(field);
         if (expectedValue != static_cast<decltype(expectedValue)>(checksum)) {
             BaseImpl::resetMsg(msg);
             return ErrorStatus::ProtocolError;
@@ -427,8 +450,7 @@ class ChecksumPrefixLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        auto expectedValue = field.value();
-
+        auto expectedValue = thisObj.getChecksumFromField(field);
         if (expectedValue != static_cast<decltype(expectedValue)>(checksum)) {
             BaseImpl::resetMsg(msg);
             return ErrorStatus::ProtocolError;
@@ -487,6 +509,7 @@ class ChecksumPrefixLayer : public
     {
         auto& thisObj = BaseImpl::thisLayer();
         auto checksumIter = iter;
+        thisObj.prepareFieldForWrite(0U, &msg, field);
         auto es = thisObj.writeField(&msg, field, iter, size);
         if (es != comms::ErrorStatus::Success) {
             return es;
@@ -504,7 +527,6 @@ class ChecksumPrefixLayer : public
         COMMS_ASSERT(fromIter <= iter);
         auto len = static_cast<std::size_t>(std::distance(fromIter, iter));
 
-        using FieldValueType = typename Field::ValueType;
         bool checksumValid = false;
         auto checksum = 
             thisObj.calculateChecksum(
@@ -517,7 +539,7 @@ class ChecksumPrefixLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        field.value() = static_cast<FieldValueType>(checksum);
+        thisObj.prepareFieldForWrite(checksum, &msg, field);
         auto checksumEs = thisObj.writeField(&msg, field, checksumIter, checksumLen);
         static_cast<void>(checksumEs);
         COMMS_ASSERT(checksumEs == comms::ErrorStatus::Success);
@@ -533,6 +555,7 @@ class ChecksumPrefixLayer : public
         TWriter&& nextLayerWriter) const
     {
         auto& thisObj = BaseImpl::thisLayer();
+        thisObj.prepareFieldForWrite(0U, &msg, field);
         auto es = thisObj.writeField(&msg, field, iter, size);
         if (es != comms::ErrorStatus::Success) {
             return es;
@@ -602,9 +625,8 @@ class ChecksumPrefixLayer : public
             return comms::ErrorStatus::ProtocolError;
         }
 
-        using FieldValueType = typename Field::ValueType;
-        field.value() = static_cast<FieldValueType>(checksum);
-        return field.write(checksumIter, fieldLen);
+        thisObj.prepareFieldForWrite(checksum, msgPtr, field);
+        return thisObj.doWriteField(msgPtr, field, checksumIter, fieldLen);
     }
 };
 

comms/include/comms/protocol/MsgSizeLayer.h

@@ -316,7 +316,7 @@ class MsgSizeLayer : public
     /// @details Must assign provided size (length) value. 
     ///     May be overridden by the extending class if some complex functionality is required.
     /// @param[in] size Size value to assign
-    /// @param[in] msg Pointer to message object being written, maybe nullptr (in case invoked
+    /// @param[in] msg Pointer to message object being written, may be nullptr (in case invoked
     ///     from @ref comms::protocol::MsgSizeLayer::doUpdate "doUpdate()")
     /// @param[out] field Field, value of which needs to be populated
     /// @note May be non-static in the extending class

comms/include/comms/version.h

@@ -17,7 +17,7 @@
 #define COMMS_MINOR_VERSION 4U
 
 /// @brief Patch level of the library
-#define COMMS_PATCH_VERSION 0U
+#define COMMS_PATCH_VERSION 1U
 
 /// @brief Macro to create numeric version as single unsigned number
 #define COMMS_MAKE_VERSION(major_, minor_, patch_) \

comms/test/ChecksumPrefixLayer.th

@@ -458,7 +458,12 @@ void ChecksumPrefixLayerTestSuite::test7()
 void ChecksumPrefixLayerTestSuite::test8()
 {
     static const char Buf[] = {
-        static_cast<char>(0xab), static_cast<char>(0xcd), 0x06, 0x0, 0x3, MessageType1, 0x01, 0x02, static_cast<char>(0x3f)
+        static_cast<char>(0xab), static_cast<char>(0xcd), // sync
+        0x06, // checksum
+        0x0, 0x3, // size
+        MessageType1, // id
+        0x01, 0x02, //data
+        static_cast<char>(0x3f) // garbage
     };
 
     static const std::size_t BufSize = std::extent<decltype(Buf)>::value;