Release v3.4

Author: arobenko

.appveyor.yml

@@ -41,7 +41,7 @@ install:
 build_script:
     - mkdir build.%PLATFORM%.%CONFIGURATION%.%TOOLCHAIN%
     - cd build.%PLATFORM%.%CONFIGURATION%.%TOOLCHAIN%
-    - cmake .. -DCMAKE_BUILD_TYPE=%CONFIGURATION% -G "NMake Makefiles" -DCC_QT_DIR=%QTDIR% -DCMAKE_CXX_STANDARD=%CPP_STD% -DCMAKE_INSTALL_PREFIX=%cd%/install -DCC_ENABLE_DEMO_PROTOCOL=ON
+    - cmake .. -DCMAKE_BUILD_TYPE=%CONFIGURATION% -G "NMake Makefiles" -DCC_QT_DIR=%QTDIR% -DCMAKE_CXX_STANDARD=%CPP_STD% -DCMAKE_INSTALL_PREFIX=%cd%/install -DCC_BUILD_DEMO_PROTOCOL=ON
     - nmake install
     - IF "%CONFIGURATION%"=="Release" ( nmake deploy_qt )
 test_script:

.github/workflows/codeql-analysis.yml

@@ -17,8 +17,6 @@ on:
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ master, develop ]
-  schedule:
-    - cron: '28 20 * * 5'
 
 jobs:
   analyze:
@@ -57,7 +55,7 @@ jobs:
     - run: |
        cmake -E make_directory ${{runner.workspace}}/build
        cd ${{runner.workspace}}/build
-       cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=${{matrix.type}} -DCMAKE_INSTALL_PREFIX=install -DCC_COMMS_LIB_ONLY=ON
+       cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=${{matrix.type}} -DCMAKE_INSTALL_PREFIX=install -DCC_BUILD_TOOLS_LIBRARY=OFF
        cmake --build . --target install
 
     - name: Perform CodeQL Analysis

.travis.yml

@@ -14,7 +14,7 @@ matrix:
         apt:
           packages:
             - g++-4.8    
-      env: _CC=gcc-4.8 _CXX=g++-4.8 _BUILD="-DCC_COMMS_LIB_ONLY=ON"
+      env: _CC=gcc-4.8 _CXX=g++-4.8 _BUILD="-DCC_BUILD_TOOLS_LIBRARY=OFF"
     - os: linux
       addons:
         apt:
@@ -315,21 +315,21 @@ script:
   - echo "------------------ Debug build ------------------"
   - mkdir build.debug
   - cd build.debug
-  - CC=${_CC} CXX=${_CXX} cmake .. ${_BUILD} -DCMAKE_INSTALL_PREFIX=./install -DCC_ENABLE_DEMO_PROTOCOL=ON
+  - CC=${_CC} CXX=${_CXX} cmake .. ${_BUILD} -DCMAKE_INSTALL_PREFIX=./install -DCC_BUILD_DEMO_PROTOCOL=ON
   - make install
   - ctest
   - cd ..
   - echo "------------------ Release build ------------------"  
   - mkdir build.release
   - cd build.release
-  - CC=${_CC} CXX=${_CXX} cmake .. ${_BUILD} -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./install -DCC_ENABLE_DEMO_PROTOCOL=ON
+  - CC=${_CC} CXX=${_CXX} cmake .. ${_BUILD} -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./install -DCC_BUILD_DEMO_PROTOCOL=ON
   - make install
   - ctest
   - cd ..  
   - echo "------------------ MinSize Release build ------------------"  
   - mkdir build.min_size
   - cd build.min_size
-  - CC=${_CC} CXX=${_CXX} cmake .. ${_BUILD} -DCMAKE_BUILD_TYPE=MinSizeRel -DCMAKE_INSTALL_PREFIX=./install -DCC_ENABLE_DEMO_PROTOCOL=ON
+  - CC=${_CC} CXX=${_CXX} cmake .. ${_BUILD} -DCMAKE_BUILD_TYPE=MinSizeRel -DCMAKE_INSTALL_PREFIX=./install -DCC_BUILD_DEMO_PROTOCOL=ON
   - make install
   - ctest
   - cd ..    

CMakeLists.txt

@@ -2,30 +2,40 @@ cmake_minimum_required (VERSION 3.1)
 project ("comms_champion")
 
 # Available options
-option (CC_COMMS_LIB_ONLY "Install only COMMS library, no other apps will be built." OFF)
-option (CC_LIBS_ONLY "Build and install COMMS and CommsChampion libraries, no other apps will be built." OFF)
-option (CC_STATIC_RUNTIME "Enable/Disable static runtime" OFF)
-option (CC_NO_UNIT_TESTS "Disable unittests." OFF)
-option (CC_NO_WARN_AS_ERR "Do NOT treat warning as error" OFF)
-option (CC_ENABLE_DEMO_PROTOCOL "Enable demo protocol" OFF)
-option (CC_NO_CXX_STANDARD_FORCING "Disable forcing C++ standard to C++11 when no CMAKE_CXX_STANDARD is defined" OFF)
-option (CC_NO_CCACHE "Disable use of ccache on UNIX systems")
+
+option (CC_INSTALL_COMMS_LIB "Install comms library headers." ON)
+option (CC_BUILD_UNIT_TESTS "Build unittests." ${CC_INSTALL_COMMS_LIB})
 option (CC_UNIT_TESTS_USE_SANITIZERS "Use sanitizers during unittests. Applicable when unittest are enabled." ON)
+option (CC_BUILD_TOOLS_LIBRARY "Build tools library." ON)
+option (CC_INSTALL_TOOLS_LIBRARY "Install tools library." ${CC_BUILD_TOOLS_LIBRARY})
+option (CC_BUILD_TOOLS "Build tools binaries." ${CC_BUILD_TOOLS_LIBRARY})
+option (CC_INSTALL_TOOLS "Install tools binaries." ${CC_BUILD_TOOLS})
+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_STATIC_RUNTIME "Enable/Disable static runtime" OFF)
 
 # Extra variables
 # CC_QT_DIR=dir - Directory of QT5 installation. Can be used to provide path to QT5 if
 #   differs from system default installation path.
 # CC_EXTERNALS_DIR - Directory where pull externals, defaults to 
 #   ${PROJECT_SOURCE_DIR}/externals
 
+# Deprecated options for backward compatibility, use the ones above for new builds.
+# option (CC_COMMS_LIB_ONLY "Install only COMMS library, no other apps will be built." OFF)
+# option (CC_LIBS_ONLY "Build and install COMMS and CommsChampion libraries, no other apps will be built." OFF)
+# option (CC_NO_UNIT_TESTS "Disable unittests." OFF)
+# option (CC_NO_WARN_AS_ERR "Do NOT treat warning as error" OFF)
+# option (CC_ENABLE_DEMO_PROTOCOL "Enable demo protocol" OFF)
+# option (CC_NO_CXX_STANDARD_FORCING "Disable forcing C++ standard to C++11 when no CMAKE_CXX_STANDARD is defined" OFF)
+# option (CC_NO_CCACHE "Disable use of ccache on UNIX systems" OFF)
+
 if (CMAKE_TOOLCHAIN_FILE AND EXISTS ${CMAKE_TOOLCHAIN_FILE})
     message(STATUS "Loading toolchain from ${CMAKE_TOOLCHAIN_FILE}")
 endif()
 
-if ((NOT CMAKE_CXX_STANDARD) AND (NOT CC_NO_CXX_STANDARD_FORCING))
-    set (CMAKE_CXX_STANDARD 11)
-endif()
-
 if (NOT CC_EXTERNALS_DIR)
     set (CC_EXTERNALS_DIR "${PROJECT_SOURCE_DIR}/externals")
 endif ()
@@ -34,8 +44,60 @@ set (CMAKE_SCRIPTS_DIR "${PROJECT_SOURCE_DIR}/cmake")
 
 ################################################
 
+# Check usage of deprecated options and ovewrite the default values of proper ones
+if ((DEFINED CC_COMMS_LIB_ONLY) AND (${CC_COMMS_LIB_ONLY}))
+    set (CC_INSTALL_COMMS_LIB ON)
+    set (CC_BUILD_TOOLS_LIBRARY OFF)
+    set (CC_INSTALL_TOOLS_LIBRARY OFF)
+    set (CC_BUILD_TOOLS OFF)
+    set (CC_INSTALL_TOOLS OFF)
+    set (CC_BUILD_DEMO_PROTOCOL OFF)
+    set (CC_INSTALL_DEMO_PROTOCOL OFF)
+endif ()
+
+if ((DEFINED CC_LIBS_ONLY) AND (${CC_LIBS_ONLY}))
+    set (CC_INSTALL_COMMS_LIB ON)
+    set (CC_BUILD_TOOLS_LIBRARY ON)
+    set (CC_INSTALL_TOOLS_LIBRARY ON)
+    set (CC_BUILD_TOOLS OFF)
+    set (CC_INSTALL_TOOLS OFF)
+    set (CC_BUILD_DEMO_PROTOCOL OFF)
+    set (CC_INSTALL_DEMO_PROTOCOL OFF)
+endif ()
+
+macro (cc_negate_option old_name new_name)
+    if (DEFINED ${old_name})
+        if (${old_name})
+            set (${new_name} OFF)
+        else ()
+            set (${new_name} ON)
+        endif ()
+    endif ()
+endmacro ()
+
+cc_negate_option(CC_NO_UNIT_TESTS CC_BUILD_UNIT_TESTS)
+cc_negate_option(CC_NO_WARN_AS_ERR CC_WARN_AS_ERR)
+cc_negate_option(CC_NO_CCACHE CC_USE_CCACHE)
+
+if (DEFINED CC_NO_CXX_STANDARD_FORCING)
+    set (CC_SKIP_CXX_STANDARD_FORCING ${CC_NO_CXX_STANDARD_FORCING})
+endif ()
+
+if ((DEFINED CC_ENABLE_DEMO_PROTOCOL) AND (${CC_ENABLE_DEMO_PROTOCOL}))
+    set (CC_BUILD_TOOLS_LIBRARY ON)
+    set (CC_INSTALL_TOOLS_LIBRARY ON)
+    set (CC_BUILD_DEMO_PROTOCOL ON)
+    set (CC_INSTALL_DEMO_PROTOCOL ON)
+endif ()
+
+################################################
+
+if ((NOT CMAKE_CXX_STANDARD) AND (NOT CC_SKIP_CXX_STANDARD_FORCING))
+    set (CMAKE_CXX_STANDARD 11)
+endif()
+
 while (TRUE)
-    if (CC_NO_UNIT_TESTS)
+    if (NOT CC_BUILD_UNIT_TESTS)
         message (STATUS "Unittests are disabled")
         break()
     endif ()
@@ -53,7 +115,7 @@ endwhile ()
 ################################################
 # Compiler options
 set (warn_opt)
-if (NOT CC_NO_WARN_AS_ERR)
+if (CC_WARN_AS_ERR)
     set (warn_opt WARN_AS_ERR)
 endif ()
 
@@ -63,7 +125,7 @@ if (CC_STATIC_RUNTIME)
 endif ()
 
 set (ccache_opt)
-if ((UNIX) AND (NOT CC_NO_CCACHE))
+if ((UNIX) AND (CC_USE_CCACHE))
     set (ccache_opt USE_CCACHE)
 endif ()
 
@@ -135,31 +197,9 @@ set (COMMS_CHAMPION_CMAKE_FILES
     ${PROJECT_SOURCE_DIR}/cmake/CommsChampionConfig.cmake
 )    
 
-install (
-    FILES ${LIB_COMMS_CMAKE_FILES}
-    DESTINATION ${LIB_INSTALL_DIR}/LibComms/cmake/
-)
-
-if (NOT CC_COMMS_LIB_ONLY)
-    install (
-        FILES ${COMMS_CHAMPION_CMAKE_FILES}
-        DESTINATION ${LIB_INSTALL_DIR}/CommsChampion/cmake/
-    )
-endif ()
-
-
 add_subdirectory (comms)
-
-if (CC_COMMS_LIB_ONLY)
-    return ()
-endif ()
-
 add_subdirectory (comms_champion)
 
-if (CC_LIBS_ONLY)
-    return ()
-endif ()
-
 add_subdirectory (demo)
 
 if (WIN32 AND CC_QT_DIR)

cmake/CC_External.cmake

@@ -45,28 +45,32 @@
 # ******************************************************
 # - Build comms_champion as external project during normal build process.
 #     cc_build_as_external_project(
+#         TGT <target_name>
 #         SRC_DIR <src_dir>
 #         [BUILD_DIR <build_dir>]
 #         [INSTALL_DIR] <install_dir>]
 #         [TAG <tag>]
 #         [REPO <repo>]
 #         [CMAKE_ARGS <arg1> <arg2> ...]
 #         [QT_DIR <path_to_qt>]
+#         [NO_REPO]
 #         [NO_TOOLS]
 #         [UPDATE_DISCONNECTED]
 #         [NO_DEFAULT_CMAKE_ARGS]
 #     )
+# - TGT - Name of CMake target that can be used to establish dependencies.
 # - SRC_DIR - A directory where comms_champion sources will end up.
 # - BUILD_DIR - A directory where comms_champion will be build.
 # - INSTALL_DIR - A directory where comms_champion will be installed, also passed as 
 #       CMAKE_INSTALL_PREFIX in addition to provided CMAKE_ARGS.
-# - TAG - Override the default tag to checkout.
-# - REPO - Override the default repository of the comms_champion.
+# - TAG - Override the default tag to checkout (unless NO_REPO param is used).
+# - REPO - Override the default repository of the comms_champion (unless NO_REPO param is used).
 # - 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_TOOLS - Will disable build of the CommsChampion Tools, will result in 
-#   having CC_COMMS_LIB_ONLY=ON option being passed to the build process.
+#   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.
 # - UPDATE_DISCONNECTED - Pass "UPDATE_DISCONNECTED 1" to ExternalProject_Add()
 # - NO_DEFAULT_CMAKE_ARGS - Exclude passing the extra cmake arguments that copy the 
@@ -223,10 +227,11 @@ macro (cc_define_external_project_targets inst_dir)
     set (CC_COMMS_FOUND TRUE)
     set (CC_INCLUDE_DIRS "${inst_dir}/include")
 
-    add_library(comms INTERFACE)
-    add_library(cc::comms ALIAS comms)
-
-    target_include_directories(comms INTERFACE ${CC_INCLUDE_DIRS})
+    add_library(cc::comms INTERFACE IMPORTED GLOBAL)
+    execute_process(
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${CC_INCLUDE_DIRS}
+    )    
+    target_include_directories(cc::comms INTERFACE ${CC_INCLUDE_DIRS})
 
     while (TRUE)
         if (CC_EXT_TGT_NO_COMMS_CHAMPION OR CC_EXT_TGT_NO_TOOLS)
@@ -266,7 +271,7 @@ macro (cc_define_external_project_targets inst_dir)
             set (cc_lib_name lib${CC_PLUGIN_LIBRARIES}.so)
         endif ()
 
-        add_library(cc::comms_champion UNKNOWN IMPORTED)
+        add_library(cc::comms_champion UNKNOWN IMPORTED GLOBAL)
         file (MAKE_DIRECTORY ${CC_INCLUDE_DIRS})
         set (interface_link_libs cc::comms)        
 
@@ -297,7 +302,7 @@ endmacro ()
 
 function (cc_build_as_external_project)
     set (_prefix CC_EXTERNAL_PROJ)
-    set (_options NO_TOOLS NO_DEPLOY_QT UPDATE_DISCONNECTED NO_DEFAULT_CMAKE_ARGS)
+    set (_options NO_TOOLS NO_DEPLOY_QT UPDATE_DISCONNECTED NO_DEFAULT_CMAKE_ARGS NO_REPO)
     set (_oneValueArgs SRC_DIR BUILD_DIR INSTALL_DIR REPO TAG QT_DIR TGT)
     set (_mutiValueArgs CMAKE_ARGS)
     cmake_parse_arguments(${_prefix} "${_options}" "${_oneValueArgs}" "${_mutiValueArgs}" ${ARGN})
@@ -314,13 +319,21 @@ function (cc_build_as_external_project)
         set (CC_EXTERNAL_PROJ_INSTALL_DIR ${CC_EXTERNAL_PROJ_BUILD_DIR}/install)
     endif ()  
 
-    if (NOT CC_EXTERNAL_PROJ_REPO)
-        set (CC_EXTERNAL_PROJ_REPO ${CC_EXTERNAL_DEFAULT_REPO})
-    endif ()  
+    set (repo_param)
+    set (repo_tag_param)
+    if (NOT CC_EXTERNAL_PROJ_NO_REPO)
+        if (NOT CC_EXTERNAL_PROJ_REPO)
+            set (CC_EXTERNAL_PROJ_REPO ${CC_EXTERNAL_DEFAULT_REPO})
+        endif ()  
+
+        if (NOT CC_EXTERNAL_PROJ_TAG)
+            set (CC_EXTERNAL_PROJ_TAG ${CC_EXTERNAL_DEFAULT_TAG})
+        endif ()            
 
-    if (NOT CC_EXTERNAL_PROJ_TAG)
-        set (CC_EXTERNAL_PROJ_TAG ${CC_EXTERNAL_DEFAULT_TAG})
-    endif ()            
+
+        set (repo_param GIT_REPOSITORY "${CC_EXTERNAL_PROJ_REPO}")
+        set (repo_tag_param GIT_TAG "${CC_EXTERNAL_PROJ_TAG}")
+    endif ()
 
     set (exteral_proj_qt_dir_param)
     if (CC_EXTERNAL_PROJ_QT_DIR)
@@ -329,7 +342,7 @@ function (cc_build_as_external_project)
 
     set (comms_lib_only_param)
     if (CC_EXTERNAL_PROJ_NO_TOOLS)
-        set (comms_lib_only_param "-DCC_COMMS_LIB_ONLY=ON")
+        set (comms_lib_only_param "-DCC_BUILD_TOOLS_LIBRARY=OFF")
     endif ()
 
     if (NOT CC_EXTERNAL_PROJ_TGT)
@@ -357,8 +370,8 @@ function (cc_build_as_external_project)
     ExternalProject_Add(
         "${CC_EXTERNAL_PROJ_TGT}"
         PREFIX "${CC_EXTERNAL_PROJ_BUILD_DIR}"
-        GIT_REPOSITORY "${CC_EXTERNAL_PROJ_REPO}"
-        GIT_TAG "${CC_EXTERNAL_PROJ_TAG}"
+        ${repo_param}
+        ${repo_tag_param}
         SOURCE_DIR "${CC_EXTERNAL_PROJ_SRC_DIR}"
         BINARY_DIR "${CC_EXTERNAL_PROJ_BUILD_DIR}"
         INSTALL_DIR "${CC_EXTERNAL_PROJ_INSTALL_DIR}"
@@ -386,12 +399,12 @@ function (cc_build_as_external_project)
         ${define_targets_no_tools_param}
     )
 
-    if (TARGET comms)
-        add_dependencies(comms ${CC_EXTERNAL_PROJ_TGT})
+    if (TARGET cc::comms)
+        add_dependencies(cc::comms ${CC_EXTERNAL_PROJ_TGT})
     endif ()
 
-    if (TARGET comms_champion)
-        add_dependencies(comms_champion ${CC_EXTERNAL_PROJ_TGT})
+    if (TARGET cc::comms_champion)
+        add_dependencies(cc::comms_champion ${CC_EXTERNAL_PROJ_TGT})
     endif ()
 
     if ((NOT CC_EXTERNAL_PROJ_NO_DEPLOY_QT) AND WIN32 AND (NOT "${CC_EXTERNAL_PROJ_QT_DIR}" STREQUAL ""))

comms/CMakeLists.txt

@@ -27,15 +27,22 @@ target_include_directories(comms INTERFACE
   $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
 )
 
-install(TARGETS comms EXPORT commsExport)
-install(EXPORT commsExport NAMESPACE cc::
-    DESTINATION ${LIB_INSTALL_DIR}/LibComms/cmake
-)
-
-install (
-    DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/comms
-    DESTINATION ${INC_INSTALL_DIR}
-)
+if (CC_INSTALL_COMMS_LIB)
+    install (
+        FILES ${LIB_COMMS_CMAKE_FILES}
+        DESTINATION ${LIB_INSTALL_DIR}/LibComms/cmake/
+    )
+
+    install(TARGETS comms EXPORT commsExport)
+    install(EXPORT commsExport NAMESPACE cc::
+        DESTINATION ${LIB_INSTALL_DIR}/LibComms/cmake
+    )
+
+    install (
+        DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/comms
+        DESTINATION ${INC_INSTALL_DIR}
+    )
+endif ()    
 
 add_subdirectory (test)