Release v3.0.4

Author: arobenko

.github/workflows/actions_build.yml

@@ -14,27 +14,35 @@ option (DEMO1_GEN_SWIG "Use commsdsl2swig to generate swig bindings project." OF
 option (DEMO1_BUILD_SWIG "Build and install project generated by the commsdsl2swig." ${DEMO1_GEN_SWIG})
 option (DEMO1_GEN_EMSCRIPTEN "Use commsdsl2emscripten to generate emscripten bindings project." OFF)
 option (DEMO1_BUILD_EMSCRIPTEN "Build and install project generated by the commsdsl2emscripten." ${DEMO1_GEN_EMSCRIPTEN})
+option (DEMO1_GEN_C "Use commsdsl2c to generate \"C\" wrappers project." OFF)
+option (DEMO1_BUILD_C "Build and install project generated by the commsdsl2c." ${DEMO1_GEN_C})
+option (DEMO1_GEN_LATEX "Use commsdsl2latex to generate protocol specification." OFF)
+option (DEMO1_BUILD_LATEX "Build and install project generated by the commsdsl2latex." ${DEMO1_GEN_C})
 option (DEMO1_BUILD_EXAMPLES "Build examples." ON)
 
 # Additional variables to be used if needed
 # ---------------------------
 # DEMO1_PROT_OUTPUT_DIR - Path to protocol output directory. If not provided <build_dir>/output one is used.
-# DEMO1_TEST_OUTPUT_DIR - Path to test output directory. If not provided <build_dir>/output_tools one is used.
+# DEMO1_TEST_OUTPUT_DIR - Path to test output directory. If not provided <build_dir>/output_test one is used.
 # DEMO1_TOOLS_OUTPUT_DIR - Path to tools output directory. If not provided <build_dir>/output_tools one is used.
 # DEMO1_TOOLS_QT_VER - Major Qt version to be used when building tools output. Defaults to 5
 # DEMO1_SWIG_OUTPUT_DIR - Path to swig output directory. If not provided <build_dir>/output_swig one is used.
 # DEMO1_SWIG_SRC_DIR - Path to the commsdsl2swig sources. If not provided local "src/swig" dir is used.
 # DEMO1_SWIG_LANGUAGES - Languages list to support by swig. If not provided "python java csharp" are chosen
 # DEMO1_EMSCRIPTEN_OUTPUT_DIR - Path to emscripten output directory. If not provided <build_dir>/output_emscripten one is used.
+# DEMO1_C_OUTPUT_DIR - Path to "c" output directory. If not provided <build_dir>/output_c one is used.
+# DEMO1_LATEX_OUTPUT_DIR - Path to latex output directory. If not provided <build_dir>/output_latex one is used.
 # DEMO1_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 (DEMO1_VERSION "3.0.3")
-set (DEMO1_MIN_COMMSDSL_VERSION "7.1")
+set (DEMO1_VERSION "3.0.4")
+set (DEMO1_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 ("${DEMO1_EMSCRIPTEN_OUTPUT_DIR}" STREQUAL "")
     set (DEMO1_EMSCRIPTEN_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_emscripten")
 endif ()
 
+if ("${DEMO1_C_OUTPUT_DIR}" STREQUAL "")
+    set (DEMO1_C_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_c")
+endif ()
+
+if ("${DEMO1_LATEX_OUTPUT_DIR}" STREQUAL "")
+    set (DEMO1_LATEX_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_latex")
+endif ()
+
 if ("${DEMO1_TOOLS_QT_VER}" STREQUAL "")
     set (DEMO1_TOOLS_QT_VER 5)
 endif ()
@@ -162,7 +178,7 @@ if (DEMO1_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 ${DEMO1_VERSION} ${COMMSDSL2TEST_EXTRA_ARGS}
             -o ${test_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/test ${schema_file}
         COMMAND ${CMAKE_COMMAND}
             -DGENERATED="${test_tmp_dir}" -DOUTPUT="${DEMO1_TEST_OUTPUT_DIR}"
@@ -214,7 +230,7 @@ if (DEMO1_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 ${DEMO1_VERSION} ${COMMSDSL2TOOLS_QT_EXTRA_ARGS}
             --protocol "::CC Demo1:Synthenic demo protocol to demonstrate definition of various fields as well as simple protocol framing.:cc.Demo1ProtocolPlugin"
             -o ${tools_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/tools ${schema_file}        
         COMMAND ${CMAKE_COMMAND}
@@ -267,7 +283,7 @@ if (DEMO1_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}
+        COMMAND ${COMMSDSL2SWIG} ${warn_as_error} -V ${DEMO1_VERSION} ${COMMSDSL2SWIG_EXTRA_ARGS}
             -c ${DEMO1_SWIG_SRC_DIR} -o ${swig_tmp_dir} ${schema_file}
         COMMAND ${CMAKE_COMMAND}
             -DGENERATED="${swig_tmp_dir}" -DOUTPUT="${DEMO1_SWIG_OUTPUT_DIR}"
@@ -325,7 +341,7 @@ if (DEMO1_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 ${DEMO1_VERSION} ${COMMSDSL2EMSCRIPTEN_EXTRA_ARGS}
             -o ${emscripten_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/emscripten ${schema_file}
         COMMAND ${CMAKE_COMMAND}
             -DGENERATED="${emscripten_tmp_dir}" -DOUTPUT="${DEMO1_EMSCRIPTEN_OUTPUT_DIR}"
@@ -373,6 +389,115 @@ if (DEMO1_GEN_EMSCRIPTEN)
     endif ()
 endif ()
 
+if (DEMO1_GEN_C)
+    find_program(COMMSDSL2C commsdsl2c PATH_SUFFIXES bin REQUIRED)    
+    execute_process(COMMAND "${COMMSDSL2C}" --version OUTPUT_VARIABLE commsdsl2c_version)
+    if ("${commsdsl2c_version}" VERSION_LESS "${DEMO1_MIN_COMMSDSL_VERSION}")
+        message (FATAL_ERROR "Version of commsdsl2c is too old, required minimum is v${DEMO1_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 ${DEMO1_VERSION} ${COMMSDSL2C_EXTRA_ARGS}
+            -o ${c_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/c ${schema_file}        
+        COMMAND ${CMAKE_COMMAND}
+            -DGENERATED="${c_tmp_dir}" -DOUTPUT="${DEMO1_C_OUTPUT_DIR}"
+            -P "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake"        
+        DEPENDS "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake" ${schema_file})
+
+    if (DEMO1_BUILD_C)
+        if ((NOT DEMO1_GEN_PROTOCOL) OR (NOT DEMO1_BUILD_PROTOCOL))
+            message (FATAL_ERROR "DEMO1_GEN_PROTOCOL and DEMO1_BUILD_PROTOCOL are required for DEMO1_BUILD_C")
+        endif ()
+            
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${DEMO1_C_OUTPUT_DIR}
+        )    
+
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E touch ${DEMO1_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 ${DEMO1_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=${DEMO1_USE_CCACHE}
+                -DOPT_CCACHE_EXECUTABLE=${DEMO1_CCACHE_EXECUTABLE}
+        )  
+        
+        find_package(Doxygen)
+        if (DEMO1_BUILD_PROT_DOC AND DOXYGEN_FOUND)
+            ExternalProject_Add_Step(
+                "c_tgt" 
+                "doc"
+                COMMAND ${CMAKE_COMMAND} --build ${c_build_dir} --target doc_cc_demo1_c
+                DEPENDEES "build"
+                DEPENDERS "install"
+            )
+        endif ()        
+    endif ()
+endif ()
+
+if (DEMO1_GEN_LATEX)
+    find_program(COMMSDSL2LATEX commsdsl2latex PATH_SUFFIXES bin REQUIRED)    
+    execute_process(COMMAND "${COMMSDSL2LATEX}" --version OUTPUT_VARIABLE commsdsl2latex_version)
+    if ("${commsdsl2latex_version}" VERSION_LESS "${DEMO1_MIN_COMMSDSL_VERSION}")
+        message (FATAL_ERROR "Version of commsdsl2latex is too old, required minimum is v${DEMO1_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="${DEMO1_LATEX_OUTPUT_DIR}"
+            -P "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake"        
+        DEPENDS "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake" ${schema_file})
+
+    if (DEMO1_BUILD_LATEX)
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${DEMO1_LATEX_OUTPUT_DIR}
+        )    
+
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E touch ${DEMO1_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 ${DEMO1_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 DEMO1_BUILD_EXAMPLES)
     return()
 endif()

CMakeLists.txt

@@ -16,7 +16,7 @@
             <validValue name="Variants" val="11" />
         </enum>
     </fields>
-    
+
     <frame name="Frame">
         <sync name="Sync">
             <int name="Sync" type="uint16" defaultValue="0xabcd" validValue="0xabcd" failOnInvalid="true"/>
@@ -29,24 +29,24 @@
         <checksum name="Checksum" alg="crc-ccitt" from="Size">
             <int name="Checksum" type="uint16" />
         </checksum>
-    </frame>       
-    
+    </frame>
+
     <message name="Ack" id="MsgId.Ack" sender="Server">
         <ref field="MsgId" />
     </message>
-    
+
     <message name="SimpleInts" id="MsgId.SimpleInts" displayName="Simple Ints" sender="client">
         <int name="F1" type="int8" defaultValue="S1">
             <special name="S1" val="1" />
-        </int>        
+        </int>
         <int name="F2" type="uint8" defaultValue="2" />
-        <int name="F3" type="int16" defaultValue="3" />        
+        <int name="F3" type="int16" defaultValue="3" />
         <int name="F4" type="uint16" defaultValue="4" />
-        <int name="F5" type="int32" defaultValue="5"/>        
+        <int name="F5" type="int32" defaultValue="5"/>
         <int name="F6" type="uint32" defaultValue="6">
             <special name="S1" val="0xffffffff" />
         </int>
-        <int name="F7" type="int64" defaultValue="7"/>        
+        <int name="F7" type="int64" defaultValue="7"/>
         <int name="F8" type="uint64" defaultValue="8"/>
         <int name="F9" type="intvar" length="4" defaultValue="9" />
         <int name="F10" type="uintvar" length="4" defaultValue="10" endian="little">
@@ -83,11 +83,11 @@
         <float name="Timeout" type="float" units="sec">
             <special name="Infinite" val="0.0" />
             <special name="Invalid" val="nan" />
-        </float>        
+        </float>
         <float name="Distance" type="float" units="m" defaultValue="Invalid" displayDecimals="3">
             <special name="Infinite" val="inf" />
             <special name="Invalid" val="nan" />
-        </float>        
+        </float>
     </message>
 
     <message name="Enums" id="MsgId.Enums" sender="client">
@@ -339,5 +339,5 @@
                 </lengthPrefix>
             </list>
         </fields>
-    </message>    
+    </message>
 </schema>

dsl/schema.xml

@@ -33,7 +33,7 @@ if (DEMO1_USE_CCACHE)
 
     if (NOT "${DEMO1_CCACHE_EXECUTABLE}" STREQUAL "")
         list (APPEND extra_opts CCACHE_EXECTUABLE "${DEMO1_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}