Added tutorial26 code.

Author: arobenko

tutorials/CMakeLists.txt

@@ -35,3 +35,4 @@ add_subdirectory (tutorial22)
 add_subdirectory (tutorial23)
 add_subdirectory (tutorial24)
 add_subdirectory (tutorial25)
+add_subdirectory (tutorial26)

tutorials/tutorial26/CMakeLists.txt

@@ -0,0 +1,19 @@
+get_filename_component(name ${CMAKE_CURRENT_SOURCE_DIR} NAME)
+
+set (schema_files
+    ${CMAKE_CURRENT_SOURCE_DIR}/dsl/schema.xml
+)
+
+set (server_src
+    src/ServerSession.cpp
+)
+
+set (client_src
+    src/ClientSession.cpp
+)
+
+dsl_tutorial_parse(${name} SCHEMAS ${schema_files})
+
+bin_tutorial_server(${name} ${server_src})
+bin_tutorial_client(${name} ${client_src})
+

tutorials/tutorial26/README.md

@@ -0,0 +1,4 @@
+# Tutorial 26
+Stateful message sequence.
+
+[Read Previous Tutorial](../tutorial25) <-----------------------

tutorials/tutorial26/dsl/schema.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schema name="tutorial26" endian="big" nonUniqueMsgIdAllowed="true">
+    <fields>
+        <string name="Msg1Name" defaultValue="Message 1" />
+        <string name="Msg2Name" defaultValue="Message 2" />
+        <string name="Msg3Name" defaultValue="Message 3" />
+    </fields>
+    <frame name="Frame">
+        <size name="Size">
+            <int name="SizeField" type="uint16" />
+        </size>
+        <id name="Id">
+            <int name="IdField" type="uint8" pseudo="true" />
+        </id>
+        <payload name="Data" />
+    </frame>
+    
+    <message name="Msg1" id="0" order="0" displayName="^Msg1Name" />
+    <message name="Msg2" id="0" order="1" displayName="^Msg2Name" />
+    <message name="Msg3" id="0" order="2" displayName="^Msg3Name" />
+</schema>

tutorials/tutorial26/include/tutorial26/Message.h

@@ -0,0 +1,26 @@
+// Generated by commsdsl2comms v7.1.0
+
+/// @file
+/// @brief Contains definition of <b>"Message"</b> interface class.
+
+#pragma once
+
+#include "comms/Message.h"
+#include "comms/options.h"
+#include "tutorial26/MsgId.h"
+
+namespace tutorial26
+{
+
+/// @brief Definition of <b>"Message"</b> common interface class.
+/// @tparam TOpt Interface definition options
+/// @headerfile tutorial26/Message.h
+template <typename... TOpt>
+using Message =
+    comms::Message<
+        TOpt...,
+        comms::option::def::BigEndian,
+        comms::option::def::MsgIdType<tutorial26::MsgId>
+    >;
+
+} // namespace tutorial26

tutorials/tutorial26/include/tutorial26/MsgId.h

@@ -0,0 +1,22 @@
+// Generated by commsdsl2comms v7.1.0
+
+/// @file
+/// @brief Contains definition of message ids enumeration.
+
+#pragma once
+
+#include <cstdint>
+#include "tutorial26/Version.h"
+
+namespace tutorial26
+{
+
+/// @brief Message ids enumeration.
+enum MsgId : unsigned
+{
+    MsgId_Msg1 = 0U,
+    MsgId_Msg2 = 0U,
+    MsgId_Msg3 = 0U
+};
+
+} // namespace tutorial26

tutorials/tutorial26/include/tutorial26/Version.h

@@ -0,0 +1,26 @@
+// Generated by commsdsl2comms v7.1.0
+
+/// @file
+/// @brief Contains protocol version definition.
+
+#pragma once
+
+#include "comms/version.h"
+
+/// @brief Version of the protocol specification.
+#define TUTORIAL26_SPEC_VERSION (0U)
+
+namespace tutorial26
+{
+
+/// @brief Version of the protocol specification.
+inline constexpr unsigned specVersion()
+{
+    return TUTORIAL26_SPEC_VERSION;
+}
+
+} // namespace tutorial26
+
+// Generated compile time check for minimal supported version of the COMMS library
+static_assert(COMMS_MAKE_VERSION(5, 4, 0) <= comms::version(),
+    "The version of COMMS library is too old");

tutorials/tutorial26/include/tutorial26/dispatch/DispatchClientInputMessage.h

@@ -0,0 +1,205 @@
+// Generated by commsdsl2comms v7.1.0
+
+/// @file
+/// @brief Contains dispatch to handling function(s) for client input input messages.
+
+#pragma once
+
+#include <cstdint>
+#include "tutorial26/input/ClientInputMessages.h"
+#include "tutorial26/options/DefaultOptions.h"
+
+namespace tutorial26
+{
+
+namespace dispatch
+{
+
+/// @brief Dispatch message object to its appropriate handling function.
+/// @details @b switch statement based (on message ID) cast and dispatch functionality.
+/// @tparam TProtOptions Protocol options struct used for the application,
+///     like @ref tutorial26::options::DefaultOptions.
+/// @param[in] id Numeric message ID.
+/// @param[in] idx Index of the message among messages with the same ID.
+/// @param[in] msg Message object held by reference to its interface class.
+/// @param[in] handler Reference to handling object. Must define
+///     @b handle() member function for every message type it exects
+///     to handle and one for the interface class as well.
+///     @code
+///     using MyInterface = tutorial26::Message<...>;
+///     using MyMsg1 = tutorial26::message::Msg1<MyInterface, tutorial26::options::DefaultOptions>;
+///     using MyMsg2 = tutorial26::message::Msg2<MyInterface, tutorial26::options::DefaultOptions>;
+///     struct MyHandler {
+///         void handle(MyMsg1& msg) {...}
+///         void handle(MyMsg2& msg) {...}
+///         ...
+///         // Handle all unexpected or irrelevant messages.
+///         void handle(MyInterface& msg) {...}
+///     };
+///     @endcode
+///     Every @b handle() function may return a value, but every
+///     function must return the @b same type.
+/// @note Defined in tutorial26/dispatch/DispatchClientInputMessage.h
+template<typename TProtOptions, typename TId, typename TMsg, typename THandler>
+auto dispatchClientInputMessage(
+    TId id,
+    std::size_t idx,
+    TMsg& msg,
+    THandler& handler) -> decltype(handler.handle(msg))
+{
+    using InterfaceType = typename std::decay<decltype(msg)>::type;
+    switch(static_cast<std::intmax_t>(id)) {
+    case 0 /* 0x0 */:
+    {
+        switch (idx) {
+        case 0U:
+        {
+            using MsgType = tutorial26::message::Msg1<InterfaceType, TProtOptions>;
+            return handler.handle(static_cast<MsgType&>(msg));
+        }
+        case 1U:
+        {
+            using MsgType = tutorial26::message::Msg2<InterfaceType, TProtOptions>;
+            return handler.handle(static_cast<MsgType&>(msg));
+        }
+        case 2U:
+        {
+            using MsgType = tutorial26::message::Msg3<InterfaceType, TProtOptions>;
+            return handler.handle(static_cast<MsgType&>(msg));
+        }
+        default:
+            return handler.handle(msg);
+        };
+        break;
+    }
+    default:
+        break;
+    };
+
+    return handler.handle(msg);
+}
+
+/// @brief Dispatch message object to its appropriate handling function.
+/// @details Same as other dispatchClientInputMessage(), but without @b idx parameter.
+/// @tparam TProtOptions Protocol options struct used for the application,
+///     like @ref tutorial26::options::DefaultOptions.
+/// @param[in] id Numeric message ID.
+/// @param[in] msg Message object held by reference to its interface class.
+/// @param[in] handler Reference to handling object.
+/// @see dispatchClientInputMessage()
+/// @note Defined in tutorial26/dispatch/DispatchClientInputMessage.h
+template<typename TProtOptions, typename TId, typename TMsg, typename THandler>
+auto dispatchClientInputMessage(
+    TId id,
+    TMsg& msg,
+    THandler& handler) -> decltype(handler.handle(msg))
+{
+    return dispatchClientInputMessage<TProtOptions>(id, 0U, msg, handler);
+}
+
+/// @brief Dispatch message object to its appropriate handling function.
+/// @details Same as other dispatchClientInputMessage(), but passing
+///     tutorial26::options::DefaultOptions as first template parameter.
+/// @param[in] id Numeric message ID.
+/// @param[in] idx Index of the message among messages with the same ID.
+/// @param[in] msg Message object held by reference to its interface class.
+/// @param[in] handler Reference to handling object.
+/// @see dispatchClientInputMessage()
+/// @note Defined in tutorial26/dispatch/DispatchClientInputMessage.h
+template<typename TId, typename TMsg, typename THandler>
+auto dispatchClientInputMessageDefaultOptions(
+    TId id,
+    std::size_t idx,
+    TMsg& msg,
+    THandler& handler) -> decltype(handler.handle(msg))
+{
+    return dispatchClientInputMessage<tutorial26::options::DefaultOptions>(id, idx, msg, handler);
+}
+
+/// @brief Dispatch message object to its appropriate handling function.
+/// @details Same as other dispatchClientInputMessageDefaultOptions(), 
+///     but without @b idx parameter.
+/// @param[in] id Numeric message ID.
+/// @param[in] msg Message object held by reference to its interface class.
+/// @param[in] handler Reference to handling object.
+/// @see dispatchClientInputMessageDefaultOptions()
+/// @note Defined in tutorial26/dispatch/DispatchClientInputMessage.h
+template<typename TId, typename TMsg, typename THandler>
+auto dispatchClientInputMessageDefaultOptions(
+    TId id,
+    TMsg& msg,
+    THandler& handler) -> decltype(handler.handle(msg))
+{
+    return dispatchClientInputMessage<tutorial26::options::DefaultOptions>(id, msg, handler);
+}
+
+/// @brief Message dispatcher class to be used with
+///     @b comms::processAllWithDispatchViaDispatcher() function (or similar).
+/// @tparam TProtOptions Protocol options struct used for the application,
+///     like @ref tutorial26::options::DefaultOptions.
+/// @headerfile tutorial26/dispatch/DispatchClientInputMessage.h
+template <typename TProtOptions = tutorial26::options::DefaultOptions>
+struct ClientInputMsgDispatcher
+{
+    /// @brief Class detection tag
+    using MsgDispatcherTag = void;
+
+    /// @brief Dispatch message to its handler.
+    /// @details Uses appropriate @ref dispatchClientInputMessage() function.
+    /// @param[in] id ID of the message.
+    /// @param[in] idx Index (or offset) of the message among those having the same numeric ID.
+    /// @param[in] msg Reference to message object.
+    /// @param[in] handler Reference to handler object.
+    /// @return What the @ref dispatchClientInputMessage() function returns.
+    template <typename TMsg, typename THandler>
+    static auto dispatch(tutorial26::MsgId id, std::size_t idx, TMsg& msg, THandler& handler) ->
+        decltype(tutorial26::dispatch::dispatchClientInputMessage<TProtOptions>(id, idx, msg, handler))
+    {
+        return tutorial26::dispatch::dispatchClientInputMessage<TProtOptions>(id, idx, msg, handler);
+    }
+
+    /// @brief Complementary dispatch function.
+    /// @details Same as other dispatch without @b TAllMessages template parameter,
+    ///     used by  @b comms::processAllWithDispatchViaDispatcher().
+    template <typename TAllMessages, typename TMsg, typename THandler>
+    static auto dispatch(tutorial26::MsgId id, std::size_t idx, TMsg& msg, THandler& handler) ->
+        decltype(dispatch(id, idx, msg, handler))
+    {
+        return dispatch(id, idx, msg, handler);
+    }
+
+    /// @brief Dispatch message to its handler.
+    /// @details Uses appropriate @ref dispatchClientInputMessage() function.
+    /// @param[in] id ID of the message.
+    /// @param[in] msg Reference to message object.
+    /// @param[in] handler Reference to handler object.
+    /// @return What the @ref dispatchClientInputMessage() function returns.
+    template <typename TMsg, typename THandler>
+    static auto dispatch(tutorial26::MsgId id, TMsg& msg, THandler& handler) ->
+        decltype(tutorial26::dispatch::dispatchClientInputMessage<TProtOptions>(id, msg, handler))
+    {
+        return tutorial26::dispatch::dispatchClientInputMessage<TProtOptions>(id, msg, handler);
+    }
+
+    /// @brief Complementary dispatch function.
+    /// @details Same as other dispatch without @b TAllMessages template parameter,
+    ///     used by  @b comms::processAllWithDispatchViaDispatcher().
+    template <typename TAllMessages, typename TMsg, typename THandler>
+    static auto dispatch(tutorial26::MsgId id, TMsg& msg, THandler& handler) ->
+        decltype(dispatch(id, msg, handler))
+    {
+        return dispatch(id, msg, handler);
+    }
+};
+
+/// @brief Message dispatcher class to be used with
+///     @b comms::processAllWithDispatchViaDispatcher() function (or similar).
+/// @details Same as ClientInputMsgDispatcher, but passing
+///     @ref tutorial26::options::DefaultOptions as template parameter.
+/// @note Defined in tutorial26/dispatch/DispatchClientInputMessage.h
+using ClientInputMsgDispatcherDefaultOptions =
+    ClientInputMsgDispatcher<>;
+
+} // namespace dispatch
+
+} // namespace tutorial26