Release v3.0.4

Author: arobenko

.github/workflows/actions_build.yml

@@ -14,6 +14,10 @@ option (DEMO3_GEN_SWIG "Use commsdsl2swig to generate swig bindings project." OF
 option (DEMO3_BUILD_SWIG "Build and install project generated by the commsdsl2swig." ${DEMO3_GEN_SWIG})
 option (DEMO3_GEN_EMSCRIPTEN "Use commsdsl2emscripten to generate emscripten bindings project." OFF)
 option (DEMO3_BUILD_EMSCRIPTEN "Build and install project generated by the commsdsl2emscripten." ${DEMO3_GEN_EMSCRIPTEN})
+option (DEMO3_GEN_C "Use commsdsl2c to generate \"C\" wrappers project." OFF)
+option (DEMO3_BUILD_C "Build and install project generated by the commsdsl2c." ${DEMO3_GEN_C})
+option (DEMO3_GEN_LATEX "Use commsdsl2latex to generate protocol specification." OFF)
+option (DEMO3_BUILD_LATEX "Build and install project generated by the commsdsl2latex." ${DEMO3_GEN_C})
 option (DEMO3_BUILD_EXAMPLES "Build examples." ON)
 
 # Additional variables to be used if needed
@@ -26,15 +30,19 @@ option (DEMO3_BUILD_EXAMPLES "Build examples." ON)
 # DEMO3_SWIG_SRC_DIR - Path to the commsdsl2swig sources. If not provided local "src/swig" dir is used.
 # DEMO3_SWIG_LANGUAGES - Languages list to support by swig. If not provided "python java csharp" are chosen
 # DEMO3_EMSCRIPTEN_OUTPUT_DIR - Path to emscripten output directory. If not provided <build_dir>/output_emscripten one is used.
+# DEMO3_C_OUTPUT_DIR - Path to "c" output directory. If not provided <build_dir>/output_c one is used.
+# DEMO3_LATEX_OUTPUT_DIR - Path to latex output directory. If not provided <build_dir>/output_latex one is used.
 # DEMO3_CCACHE_EXECUTABLE - Custom ccache executable
 # COMMSDSL2COMMS_EXTRA_ARGS - Extra arguments to pass to "commsdsl2comms"
 # COMMSDSL2TEST_EXTRA_ARGS - Extra arguments to pass to "commsdsl2test"
 # COMMSDSL2TOOLS_QT_EXTRA_ARGS - Extra arguments to pass to "commsdsl2tools_qt"
 # COMMSDSL2SWIG_EXTRA_ARGS - Extra arguments to pass to "commsdsl2swig"
 # COMMSDSL2EMSCRIPTEN_EXTRA_ARGS - Extra arguments to pass to "commsdsl2emscripten"
+# COMMSDSL2C_EXTRA_ARGS - Extra arguments to pass to "commsdsl2c"
+# COMMSDSL2LATEX_EXTRA_ARGS - Extra arguments to pass to "commsdsl2latex"
 
-set (DEMO3_VERSION "3.0.3")
-set (DEMO3_MIN_COMMSDSL_VERSION "7.1")
+set (DEMO3_VERSION "3.0.4")
+set (DEMO3_MIN_COMMSDSL_VERSION "7.3")
 
 if (("${CMAKE_VERSION}" VERSION_GREATER_EQUAL "3.30") AND
     (NOT DEFINED CMAKE_POLICY_DEFAULT_CMP0167))
@@ -80,6 +88,14 @@ if ("${DEMO3_EMSCRIPTEN_OUTPUT_DIR}" STREQUAL "")
     set (DEMO3_EMSCRIPTEN_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_emscripten")
 endif ()
 
+if ("${DEMO3_C_OUTPUT_DIR}" STREQUAL "")
+    set (DEMO3_C_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_c")
+endif ()
+
+if ("${DEMO3_LATEX_OUTPUT_DIR}" STREQUAL "")
+    set (DEMO3_LATEX_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_latex")
+endif ()
+
 if ("${DEMO3_TOOLS_QT_VER}" STREQUAL "")
     set (DEMO3_TOOLS_QT_VER 5)
 endif ()
@@ -162,7 +178,7 @@ if (DEMO3_GEN_TEST)
 
     add_custom_target("test_output_tgt" ALL
         COMMAND ${CMAKE_COMMAND} -E remove_directory ${test_tmp_dir}
-        COMMAND ${COMMSDSL2TEST} ${warn_as_error} ${COMMSDSL2TEST_EXTRA_ARGS}
+        COMMAND ${COMMSDSL2TEST} ${warn_as_error} -V ${DEMO3_VERSION} ${COMMSDSL2TEST_EXTRA_ARGS}
             -o ${test_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/test ${schema_file}        
         COMMAND ${CMAKE_COMMAND}
             -DGENERATED="${test_tmp_dir}" -DOUTPUT="${DEMO3_TEST_OUTPUT_DIR}"
@@ -214,7 +230,7 @@ if (DEMO3_GEN_TOOLS)
 
     add_custom_target("tools_output_tgt" ALL
         COMMAND ${CMAKE_COMMAND} -E remove_directory ${tools_tmp_dir}
-        COMMAND ${COMMSDSL2TOOLS_QT} ${warn_as_error} ${COMMSDSL2TOOLS_QT_EXTRA_ARGS}
+        COMMAND ${COMMSDSL2TOOLS_QT} ${warn_as_error} -V ${DEMO3_VERSION} ${COMMSDSL2TOOLS_QT_EXTRA_ARGS}
             --protocol "::CC Demo3:Synthenic demo protocol to demonstrate protocol versioning where the version is reported in the first Connect message.:cc.Demo3ProtocolPlugin"
             -o ${tools_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/tools ${schema_file}        
         COMMAND ${CMAKE_COMMAND}
@@ -267,8 +283,8 @@ if (DEMO3_GEN_SWIG)
 
     add_custom_target("swig_output_tgt" ALL
         COMMAND ${CMAKE_COMMAND} -E remove_directory ${swig_tmp_dir}
-        COMMAND ${COMMSDSL2SWIG} ${warn_as_error} ${COMMSDSL2SWIG_EXTRA_ARGS}
-            -c ${DEMO3_SWIG_SRC_DIR} -o ${swig_tmp_dir} ${schema_file}        
+        COMMAND ${COMMSDSL2SWIG} ${warn_as_error} -V ${DEMO3_VERSION} ${COMMSDSL2SWIG_EXTRA_ARGS}
+            -c ${DEMO3_SWIG_SRC_DIR} -o ${swig_tmp_dir} ${schema_file}
         COMMAND ${CMAKE_COMMAND}
             -DGENERATED="${swig_tmp_dir}" -DOUTPUT="${DEMO3_SWIG_OUTPUT_DIR}"
             -P "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake"        
@@ -325,7 +341,7 @@ if (DEMO3_GEN_EMSCRIPTEN)
 
     add_custom_target("emscripten_output_tgt" ALL
         COMMAND ${CMAKE_COMMAND} -E remove_directory ${emscripten_tmp_dir}
-        COMMAND ${COMMSDSL2EMSCRIPTEN} ${warn_as_error} ${COMMSDSL2EMSCRIPTEN_EXTRA_ARGS}
+        COMMAND ${COMMSDSL2EMSCRIPTEN} ${warn_as_error} -V ${DEMO3_VERSION} ${COMMSDSL2EMSCRIPTEN_EXTRA_ARGS}
             -o ${emscripten_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/emscripten ${schema_file}
         COMMAND ${CMAKE_COMMAND}
             -DGENERATED="${emscripten_tmp_dir}" -DOUTPUT="${DEMO3_EMSCRIPTEN_OUTPUT_DIR}"
@@ -373,6 +389,115 @@ if (DEMO3_GEN_EMSCRIPTEN)
     endif ()
 endif ()
 
+if (DEMO3_GEN_C)
+    find_program(COMMSDSL2C commsdsl2c PATH_SUFFIXES bin REQUIRED)    
+    execute_process(COMMAND "${COMMSDSL2C}" --version OUTPUT_VARIABLE commsdsl2c_version)
+    if ("${commsdsl2c_version}" VERSION_LESS "${DEMO3_MIN_COMMSDSL_VERSION}")
+        message (FATAL_ERROR "Version of commsdsl2c is too old, required minimum is v${DEMO3_MIN_COMMSDSL_VERSION}.")
+    endif ()    
+
+    set (c_tmp_dir "${CMAKE_BINARY_DIR}/output_c.tmp")
+
+    add_custom_target("c_output_tgt" ALL
+        COMMAND ${CMAKE_COMMAND} -E remove_directory ${c_tmp_dir}
+        COMMAND ${COMMSDSL2C} ${warn_as_error} -V ${DEMO3_VERSION} ${COMMSDSL2C_EXTRA_ARGS}
+            -o ${c_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/c ${schema_file}        
+        COMMAND ${CMAKE_COMMAND}
+            -DGENERATED="${c_tmp_dir}" -DOUTPUT="${DEMO3_C_OUTPUT_DIR}"
+            -P "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake"        
+        DEPENDS "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake" ${schema_file})
+
+    if (DEMO3_BUILD_C)
+        if ((NOT DEMO3_GEN_PROTOCOL) OR (NOT DEMO3_BUILD_PROTOCOL))
+            message (FATAL_ERROR "DEMO3_GEN_PROTOCOL and DEMO3_BUILD_PROTOCOL are required for DEMO3_BUILD_C")
+        endif ()
+            
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${DEMO3_C_OUTPUT_DIR}
+        )    
+
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E touch ${DEMO3_C_OUTPUT_DIR}/dummy.txt
+        )
+
+        set (c_build_dir ${CMAKE_CURRENT_BINARY_DIR}/c_tgt_build)
+        ExternalProject_Add(
+            "c_tgt"
+            BUILD_ALWAYS TRUE
+            DEPENDS "prot_tgt" "c_output_tgt"
+            SOURCE_DIR ${DEMO3_C_OUTPUT_DIR}
+            BINARY_DIR ${c_build_dir}
+            LIST_SEPARATOR |
+            CMAKE_ARGS
+                -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
+                -DCMAKE_GENERATOR=${CMAKE_GENERATOR} -DCMAKE_GENERATOR_PLATFORM=${CMAKE_GENERATOR_PLATFORM}
+                -DCMAKE_GENERATOR_TOOLSET=${CMAKE_GENERATOR_TOOLSET} -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}
+                -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCMAKE_EXE_LINKER_FLAGS=${CMAKE_EXE_LINKER_FLAGS}           
+                -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} -DCMAKE_PREFIX_PATH=${combined_prefix_path_str}
+                -DCMAKE_CXX_STANDARD=${CMAKE_CXX_STANDARD}
+                -DOPT_USE_CCACHE=${DEMO3_USE_CCACHE}
+                -DOPT_CCACHE_EXECUTABLE=${DEMO3_CCACHE_EXECUTABLE}
+        )  
+        
+        find_package(Doxygen)
+        if (DEMO3_BUILD_PROT_DOC AND DOXYGEN_FOUND)
+            ExternalProject_Add_Step(
+                "c_tgt" 
+                "doc"
+                COMMAND ${CMAKE_COMMAND} --build ${c_build_dir} --target doc_cc_demo3_c
+                DEPENDEES "build"
+                DEPENDERS "install"
+            )
+        endif ()        
+    endif ()
+endif ()
+
+if (DEMO3_GEN_LATEX)
+    find_program(COMMSDSL2LATEX commsdsl2latex PATH_SUFFIXES bin REQUIRED)    
+    execute_process(COMMAND "${COMMSDSL2LATEX}" --version OUTPUT_VARIABLE commsdsl2latex_version)
+    if ("${commsdsl2latex_version}" VERSION_LESS "${DEMO3_MIN_COMMSDSL_VERSION}")
+        message (FATAL_ERROR "Version of commsdsl2latex is too old, required minimum is v${DEMO3_MIN_COMMSDSL_VERSION}.")
+    endif ()    
+
+    set (latex_tmp_dir "${CMAKE_BINARY_DIR}/output_latex.tmp")
+
+    add_custom_target("latext_output_tgt" ALL
+        COMMAND ${CMAKE_COMMAND} -E remove_directory ${latex_tmp_dir}
+        COMMAND ${COMMSDSL2LATEX} ${warn_as_error} ${COMMSDSL2LATEX_EXTRA_ARGS}
+            -o ${latex_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/latex ${schema_file}        
+        COMMAND ${CMAKE_COMMAND}
+            -DGENERATED="${latex_tmp_dir}" -DOUTPUT="${DEMO3_LATEX_OUTPUT_DIR}"
+            -P "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake"        
+        DEPENDS "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake" ${schema_file})
+
+    if (DEMO3_BUILD_LATEX)
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${DEMO3_LATEX_OUTPUT_DIR}
+        )    
+
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E touch ${DEMO3_LATEX_OUTPUT_DIR}/dummy.txt
+        )
+
+        set (latex_build_dir ${CMAKE_CURRENT_BINARY_DIR}/latex_tgt_build)
+        ExternalProject_Add(
+            "latex_tgt"
+            BUILD_ALWAYS TRUE
+            DEPENDS "latext_output_tgt"
+            SOURCE_DIR ${DEMO3_LATEX_OUTPUT_DIR}
+            BINARY_DIR ${latex_build_dir}
+            LIST_SEPARATOR |
+            CMAKE_ARGS
+                -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} 
+                -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} -DCMAKE_PREFIX_PATH=${combined_prefix_path_str}
+            BUILD_COMMAND
+                ${CMAKE_COMMAND} --build ${latex_build_dir} --config ${CMAKE_BUILD_TYPE} --target all_artifacts
+            INSTALL_COMMAND
+                ${CMAKE_COMMAND} -E echo "No install for documentation build"
+        )  
+    endif ()
+endif ()
+
 if (NOT DEMO3_BUILD_EXAMPLES)
     return()
 endif()

CMakeLists.txt

@@ -10,7 +10,7 @@
     <interface name="Message">
         <int name="Version" type="uint8" semanticType="version" />
     </interface>
-    
+
     <frame name="Frame">
         <sync name="Sync">
             <int name="Sync" type="uint16" defaultValidValue="0xabcd" failOnInvalid="true"/>
@@ -26,12 +26,12 @@
         <checksum name="Checksum" alg="crc-ccitt" from="Size">
             <int name="Checksum" type="uint16" />
         </checksum>
-    </frame>       
+    </frame>
 
     <message name="Connect" id="MsgId.Connect" sender="client">
         <int name="Version" type="uint8" semanticType="version"/>
     </message>
-    
+
     <message name="Msg1" id="MsgId.Msg1" sender="client">
         <int name="F1" type="uint8" defaultValue="1" />
         <int name="F2" type="uint8" defaultValue="2" deprecated="2" removed="true" />

dsl/schema.xml

@@ -33,7 +33,7 @@ if (DEMO3_USE_CCACHE)
 
     if (NOT "${DEMO3_CCACHE_EXECUTABLE}" STREQUAL "")
         list (APPEND extra_opts CCACHE_EXECTUABLE "${DEMO3_CCACHE_EXECUTABLE}")
-    endif ()    
+    endif ()
 endif()
 
 cc_compile(${extra_opts})

examples/CMakeLists.txt

@@ -21,7 +21,6 @@ if (WIN32)
         ${name} Setupapi.lib Ws2_32.lib imm32.lib winmm.lib)
 endif ()
 
-
 add_dependencies(${name} ${PROT_OUTPUT_TGT})
 
 install(TARGETS ${name}

examples/client/CMakeLists.txt

@@ -34,14 +34,14 @@ void printVersionDependentField(const TField& f)
         std::cout << static_cast<unsigned>(f.field().value());
     }
     std::cout << '\n';
-}    
+}
 
-} // namespace 
+} // namespace
 
 Client::Client(
-        common::boost_wrap::io& io, 
+        common::boost_wrap::io& io,
         const std::string& server,
-        std::uint16_t port)    
+        std::uint16_t port)
   : m_io(io),
     m_socket(io),
     m_server(server),
@@ -59,20 +59,20 @@ bool Client::start()
     auto resolveResult = resolver.resolve(m_server, std::to_string(m_port), ec);
     if (ec) {
         std::cerr << "ERROR: Failed to resolve \"" << m_server << ':' << m_port << "\" " <<
-            "with error: " << ec.message() << std::endl; 
+            "with error: " << ec.message() << std::endl;
         return false;
     }
 
     if (resolveResult.empty()) {
-        std::cerr << "ERROR: No resolution result" << std::endl; 
-        return false;        
-    }    
+        std::cerr << "ERROR: No resolution result" << std::endl;
+        return false;
+    }
 
     auto endpoint = resolveResult.begin()->endpoint();
     m_socket.connect(endpoint, ec);
     if (ec) {
         std::cerr << "ERROR: Failed to connect to \"" << endpoint << "\" " <<
-            "with error: " << ec.message() << std::endl; 
+            "with error: " << ec.message() << std::endl;
         return false;
     }
 
@@ -109,7 +109,7 @@ void Client::readDataFromServer()
 
             m_inputBuf.insert(m_inputBuf.end(), m_readBuf.begin(), m_readBuf.begin() + bytesCount);
             processInput();
-            readDataFromServer();            
+            readDataFromServer();
         });
 }
 
@@ -119,7 +119,7 @@ void Client::readDataFromStdin()
     m_sentVersion = std::numeric_limits<decltype(m_sentVersion)>::max();
 
     do {
-        // Unfortunatelly Windows doesn't provide an easy way to 
+        // Unfortunatelly Windows doesn't provide an easy way to
         // asynchronously read from stdin with boost::asio,
         // read synchronously. DON'T COPY-PASTE TO PRODUCTION CODE!!!
         std::cin >> m_sentVersion;

examples/client/Client.cpp

@@ -23,7 +23,7 @@
 namespace cc_demo3
 {
 
-namespace client    
+namespace client
 {
 
 class Client
@@ -33,7 +33,7 @@ class Client
 
     bool start();
 
-    using InputMsg = 
+    using InputMsg =
         cc_demo3::Message<
             comms::option::ReadIterator<const std::uint8_t*>,
             comms::option::Handler<Client>,
@@ -45,7 +45,7 @@ class Client
 private:
     using Socket = boost::asio::ip::tcp::socket;
 
-    using OutputMsg = 
+    using OutputMsg =
         cc_demo3::Message<
             comms::option::WriteIterator<std::back_insert_iterator<std::vector<std::uint8_t> > >,
             comms::option::LengthInfoInterface,
@@ -57,7 +57,6 @@ class Client
 
     using Frame = cc_demo3::frame::Frame<InputMsg, AllInputMessages>;
 
-
     void readDataFromServer();
     void readDataFromStdin();
     void sendConnect();

examples/client/Client.h

@@ -15,7 +15,7 @@ namespace cc_demo3
 {
 
 namespace client
-{    
+{
 
 namespace
 {

examples/client/ProgramOptions.cpp

@@ -50,8 +50,6 @@ void post(io& i, TFunc&& func)
 
 } // namespace boost_wrap
 
-
 } // namespace common
 
-
 } // namespace cc_demo3

examples/common/include/common/boost_wrap.h

@@ -15,7 +15,7 @@ namespace cc_demo3
 {
 
 namespace server
-{    
+{
 
 namespace
 {