Supporting sub-projects generation with commsdsl2c and commsdsl2latex.

Author: arobenko

CMakeLists.txt

@@ -14,24 +14,32 @@ option (UBLOX_GEN_SWIG "Use commsdsl2swig to generate swig bindings project." OF
 option (UBLOX_BUILD_SWIG "Build and install project generated by the commsdsl2swig." ${UBLOX_GEN_SWIG})
 option (UBLOX_GEN_EMSCRIPTEN "Use commsdsl2emscripten to generate emscripten bindings project." OFF)
 option (UBLOX_BUILD_EMSCRIPTEN "Build and install project generated by the commsdsl2emscripten." ${UBLOX_GEN_EMSCRIPTEN})
+option (UBLOX_GEN_C "Use commsdsl2c to generate \"C\" wrappers project." OFF)
+option (UBLOX_BUILD_C "Build and install project generated by the commsdsl2c." ${UBLOX_GEN_C})
+option (UBLOX_GEN_LATEX "Use commsdsl2latex to generate protocol specification." OFF)
+option (UBLOX_BUILD_LATEX "Build and install project generated by the commsdsl2latex." ${UBLOX_GEN_C})
 option (UBLOX_BUILD_EXAMPLES "Build examples." OFF)
 
 # Additional variables to be used if needed
 # ---------------------------
 # UBLOX_PROT_OUTPUT_DIR - Path to protocol output directory. If not provided <build_dir>/output one is used.
-# UBLOX_TEST_OUTPUT_DIR - Path to test output directory. If not provided <build_dir>/output_tools one is used.
+# UBLOX_TEST_OUTPUT_DIR - Path to test output directory. If not provided <build_dir>/output_test one is used.
 # UBLOX_TOOLS_OUTPUT_DIR - Path to tools output directory. If not provided <build_dir>/output_tools one is used.
 # UBLOX_TOOLS_QT_VER - Major Qt version to be used when building tools output. Defaults to 5
 # UBLOX_SWIG_OUTPUT_DIR - Path to swig output directory. If not provided <build_dir>/output_swig one is used.
 # UBLOX_SWIG_SRC_DIR - Path to the commsdsl2swig sources. If not provided local "src/swig" dir is used.
 # UBLOX_SCHEMA_FILES_LIST_FILE - Path to the file containing list of DSL files, use it to replace "schema_files" list below.
 # UBLOX_EMSCRIPTEN_OUTPUT_DIR - Path to emscripten output directory. If not provided <build_dir>/output_emscripten one is used.
+# UBLOX_C_OUTPUT_DIR - Path to "c" output directory. If not provided <build_dir>/output_c one is used.
+# UBLOX_LATEX_OUTPUT_DIR - Path to latex output directory. If not provided <build_dir>/output_latex one is used.
 # UBLOX_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 (UBLOX_VERSION "3.0.4")
 set (UBLOX_MIN_COMMSDSL_VERSION "7.3")
@@ -78,6 +86,18 @@ if ("${UBLOX_EMSCRIPTEN_OUTPUT_DIR}" STREQUAL "")
     set (UBLOX_EMSCRIPTEN_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_emscripten")
 endif ()
 
+if ("${UBLOX_C_OUTPUT_DIR}" STREQUAL "")
+    set (UBLOX_C_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_c")
+endif ()
+
+if ("${UBLOX_LATEX_OUTPUT_DIR}" STREQUAL "")
+    set (UBLOX_LATEX_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_latex")
+endif ()
+
+if ("${UBLOX_TOOLS_QT_VER}" STREQUAL "")
+    set (UBLOX_TOOLS_QT_VER 5)
+endif ()
+
 if ("${UBLOX_SCHEMA_FILES_LIST_FILE}" STREQUAL "")
     set (schema_files
         dsl/main.xml
@@ -245,18 +265,6 @@ set (prot_tmp_dir "${CMAKE_BINARY_DIR}/output.tmp")
 set (test_tmp_dir "${CMAKE_BINARY_DIR}/output_test.tmp")
 set (tools_tmp_dir "${CMAKE_BINARY_DIR}/output_tools.tmp")
 
-if ("${UBLOX_PROT_OUTPUT_DIR}" STREQUAL "")
-    set (UBLOX_PROT_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output")
-endif ()
-
-if ("${UBLOX_TEST_OUTPUT_DIR}" STREQUAL "")
-    set (UBLOX_TEST_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_test")
-endif ()
-
-if ("${UBLOX_TOOLS_OUTPUT_DIR}" STREQUAL "")
-    set (UBLOX_TOOLS_OUTPUT_DIR "${CMAKE_BINARY_DIR}/output_tools")
-endif ()
-
 set (warn_as_error "--warn-as-err")
 if (UBLOX_NO_WARN_AS_ERR)
     set (warn_as_error)
@@ -554,6 +562,117 @@ if (UBLOX_GEN_EMSCRIPTEN)
     endif ()
 endif ()
 
+if (UBLOX_GEN_C)
+    find_program(COMMSDSL2C commsdsl2c PATH_SUFFIXES bin REQUIRED)    
+    execute_process(COMMAND "${COMMSDSL2C}" --version OUTPUT_VARIABLE commsdsl2c_version)
+    if ("${commsdsl2c_version}" VERSION_LESS "${UBLOX_MIN_COMMSDSL_VERSION}")
+        message (FATAL_ERROR "Version of commsdsl2c is too old, required minimum is v${UBLOX_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 ${UBLOX_VERSION} ${COMMSDSL2C_EXTRA_ARGS}
+            -o ${c_tmp_dir} -c ${PROJECT_SOURCE_DIR}/src/c 
+            -p ${PROJECT_SOURCE_DIR} -i ${UBLOX_SCHEMA_FILES_LIST_FILE} 
+        COMMAND ${CMAKE_COMMAND}
+            -DGENERATED="${c_tmp_dir}" -DOUTPUT="${UBLOX_C_OUTPUT_DIR}"
+            -P "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake"        
+        DEPENDS "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake" ${schema_file})
+
+    if (UBLOX_BUILD_C)
+        if ((NOT UBLOX_GEN_PROTOCOL) OR (NOT UBLOX_BUILD_PROTOCOL))
+            message (FATAL_ERROR "UBLOX_GEN_PROTOCOL and UBLOX_BUILD_PROTOCOL are required for UBLOX_BUILD_C")
+        endif ()
+            
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${UBLOX_C_OUTPUT_DIR}
+        )    
+
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E touch ${UBLOX_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 ${UBLOX_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=${UBLOX_USE_CCACHE}
+                -DOPT_CCACHE_EXECUTABLE=${UBLOX_CCACHE_EXECUTABLE}
+        )  
+        
+        find_package(Doxygen)
+        if (UBLOX_BUILD_PROT_DOC AND DOXYGEN_FOUND)
+            ExternalProject_Add_Step(
+                "c_tgt" 
+                "doc"
+                COMMAND ${CMAKE_COMMAND} --build ${c_build_dir} --target doc_cc_ublox_c
+                DEPENDEES "build"
+                DEPENDERS "install"
+            )
+        endif ()        
+    endif ()
+endif ()
+
+if (UBLOX_GEN_LATEX)
+    find_program(COMMSDSL2LATEX commsdsl2latex PATH_SUFFIXES bin REQUIRED)    
+    execute_process(COMMAND "${COMMSDSL2LATEX}" --version OUTPUT_VARIABLE commsdsl2latex_version)
+    if ("${commsdsl2latex_version}" VERSION_LESS "${UBLOX_MIN_COMMSDSL_VERSION}")
+        message (FATAL_ERROR "Version of commsdsl2latex is too old, required minimum is v${UBLOX_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
+            -p ${PROJECT_SOURCE_DIR} -i ${UBLOX_SCHEMA_FILES_LIST_FILE}
+        COMMAND ${CMAKE_COMMAND}
+            -DGENERATED="${latex_tmp_dir}" -DOUTPUT="${UBLOX_LATEX_OUTPUT_DIR}"
+            -P "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake"        
+        DEPENDS "${CMAKE_CURRENT_LIST_DIR}/CopyGenerated.cmake" ${schema_file})
+
+    if (UBLOX_BUILD_LATEX)
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${UBLOX_LATEX_OUTPUT_DIR}
+        )    
+
+        execute_process(
+            COMMAND ${CMAKE_COMMAND} -E touch ${UBLOX_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 ${UBLOX_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 UBLOX_BUILD_EXAMPLES)
     return()
 endif()

script/full_build.sh

@@ -27,7 +27,8 @@ ${SCRIPT_DIR}/prepare_externals.sh
 cd ${BUILD_DIR}
 cmake .. -DCMAKE_INSTALL_PREFIX=${COMMON_INSTALL_DIR} \
     -DCMAKE_BUILD_TYPE=${COMMON_BUILD_TYPE} -DUBLOX_GEN_TEST=ON \
-    -DUBLOX_GEN_TOOLS=ON  -DUBLOX_GEN_SWIG=OFF -DUBLOX_GEN_EMSCRIPTEN=OFF \
+    -DUBLOX_GEN_TOOLS=ON -DUBLOX_GEN_SWIG=OFF -DUBLOX_GEN_EMSCRIPTEN=OFF \
+    -DUBLOX_GEN_C=ON -DUBLOX_GEN_LATEX=ON \
     -DUBLOX_BUILD_EXAMPLES=ON -DUBLOX_USE_CCACHE=ON "$@"
 
 procs=$(nproc)

script/prepare_externals.bat

@@ -107,7 +107,8 @@ mkdir "%COMMSDSL_BUILD_DIR%"
 cd %COMMSDSL_BUILD_DIR%
 cmake %GENERATOR_PARAM% %COMMSDSL_PLATFORM_PARAM% -S %COMMSDSL_SRC_DIR% -B %COMMSDSL_BUILD_DIR% ^
     -DCMAKE_INSTALL_PREFIX=%COMMSDSL_INSTALL_DIR% -DCMAKE_BUILD_TYPE=%COMMON_BUILD_TYPE% ^
-    -DCOMMSDSL_INSTALL_LIBRARY=OFF -DCOMMSDSL_BUILD_COMMSDSL2TEST=ON -DCOMMSDSL_BUILD_COMMSDSL2TOOLS_QT=ON
+    -DCOMMSDSL_INSTALL_LIBRARY=OFF -DCOMMSDSL_BUILD_COMMSDSL2TEST=ON -DCOMMSDSL_BUILD_COMMSDSL2TOOLS_QT=ON ^
+    -DCOMMSDSL_BUILD_COMMSDSL2LATEX=ON -DCOMMSDSL_BUILD_COMMSDSL2C=ON
 if %errorlevel% neq 0 exit /b %errorlevel%
 cmake --build %COMMSDSL_BUILD_DIR% --config %COMMON_BUILD_TYPE% --target install
 if %errorlevel% neq 0 exit /b %errorlevel%

script/prepare_externals.sh

@@ -146,7 +146,8 @@ function build_commsdsl() {
         ${COMMON_USE_CCACHE:+"-DCOMMSDSL_USE_CCACHE=${COMMON_USE_CCACHE}"} \
         ${COMMON_CCACHE_EXECUTABLE:+"-DCOMMSDSL_CCACHE_EXECUTABLE=${COMMON_CCACHE_EXECUTABLE}"} \
         -DCOMMSDSL_INSTALL_LIBRARY=OFF -DCOMMSDSL_BUILD_COMMSDSL2TEST=ON -DCOMMSDSL_BUILD_COMMSDSL2TOOLS_QT=ON \
-        -DCOMMSDSL_BUILD_COMMSDSL2SWIG=ON -DCOMMSDSL_BUILD_COMMSDSL2EMSCRIPTEN=ON
+        -DCOMMSDSL_BUILD_COMMSDSL2SWIG=ON -DCOMMSDSL_BUILD_COMMSDSL2EMSCRIPTEN=ON \
+        -DCOMMSDSL_BUILD_COMMSDSL2LATEX=ON -DCOMMSDSL_BUILD_COMMSDSL2C=ON 
     cmake --build ${COMMSDSL_BUILD_DIR} --config ${COMMON_BUILD_TYPE} --target install ${procs_param}
 }
 
@@ -180,6 +181,7 @@ function build_cc_tools_qt() {
         ${COMMON_CCACHE_EXECUTABLE:+"-DCC_TOOLS_QT_CCACHE_EXECUTABLE=${COMMON_CCACHE_EXECUTABLE}"} \
         -DCMAKE_BUILD_TYPE=${COMMON_BUILD_TYPE} -DCC_TOOLS_QT_BUILD_APPS=OFF -DCMAKE_PREFIX_PATH=${COMMS_INSTALL_DIR} \
         -DCMAKE_CXX_STANDARD=${COMMON_CXX_STANDARD} ${CC_TOOLS_QT_VERSION_OPT}
+        
     cmake --build ${CC_TOOLS_QT_BUILD_DIR} --config ${COMMON_BUILD_TYPE} --target install ${procs_param}
 }