Release v2.0.1

Author: arobenko

.gitignore

@@ -3,4 +3,5 @@ build*
 .cproject
 CMakeLists.txt.user
 *autosave
-.vscode
+.vscode
+externals*

CMakeLists.txt

@@ -21,6 +21,7 @@ if (NOT CMAKE_CXX_STANDARD)
     set (CMAKE_CXX_STANDARD 11)
 endif()
 
+set (EXTERNALS_DIR "${CMAKE_SOURCE_DIR}/externals")
 while (TRUE)
     if (CC_NO_UNIT_TESTS)
         message (STATUS "Unittests are disabled")
@@ -39,20 +40,24 @@ while (TRUE)
     endif ()
 
     set (cxx_tag "4.4")
-    set (cxxtest_stamp "${CMAKE_BINARY_DIR}/cxxtest.stamp")
-    if ((EXISTS ${cxxtest_stamp}) AND (EXISTS "${CMAKE_BINARY_DIR}/cxxtest"))
+    set (cxxtest_stamp "${EXTERNALS_DIR}/cxxtest/cxxtest.stamp")
+    if (EXISTS ${cxxtest_stamp})
         execute_process (
             COMMAND ${GIT_EXECUTABLE} checkout ${cxx_tag}
             WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/cxxtest
         )
     else ()
         execute_process (
-            COMMAND ${CMAKE_COMMAND} -E remove_directory "${CMAKE_BINARY_DIR}/cxxtest"
+            COMMAND ${CMAKE_COMMAND} -E remove_directory "${EXTERNALS_DIR}/cxxtest"
+        )
+        
+        execute_process (
+            COMMAND ${CMAKE_COMMAND} -E make_directory "${EXTERNALS_DIR}"
         )
 
         execute_process (
             COMMAND ${GIT_EXECUTABLE} clone -b ${cxx_tag} --depth 1 https://github.com/CxxTest/cxxtest.git
-            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            WORKING_DIRECTORY ${EXTERNALS_DIR}
             RESULT_VARIABLE git_result
         )
 
@@ -66,7 +71,7 @@ while (TRUE)
         )
     endif ()
 
-    set (CXXTEST_INCLUDE_DIR "${CMAKE_BINARY_DIR}/cxxtest")
+    set (CXXTEST_INCLUDE_DIR "${EXTERNALS_DIR}/cxxtest")
     set (CXXTEST_PYTHON_TESTGEN_EXECUTABLE "${CXXTEST_INCLUDE_DIR}/bin/cxxtestgen")
 
     find_package (CxxTest)
@@ -147,23 +152,67 @@ if (NOT "${CC_QT_DIR}" STREQUAL "")
     link_directories ("${CC_QT_DIR}/plugins/platforms")
 endif ()
 
-set (INSTALL_DIR ${CMAKE_INSTALL_PREFIX})
-
 include(GNUInstallDirs)
 set (INSTALL_NAME "CommsChampion")
-set (LIB_INSTALL_DIR ${INSTALL_DIR}/${CMAKE_INSTALL_LIBDIR})
-set (BIN_INSTALL_DIR ${INSTALL_DIR}/${CMAKE_INSTALL_BINDIR})
-set (INC_INSTALL_DIR ${INSTALL_DIR}/${CMAKE_INSTALL_INCLUDEDIR})
+set (LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR})
+set (BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR})
+set (INC_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR})
 set (PLUGIN_INSTALL_REL_DIR ${CMAKE_INSTALL_LIBDIR}/${INSTALL_NAME}/plugin)
-set (PLUGIN_INSTALL_DIR ${INSTALL_DIR}/${PLUGIN_INSTALL_REL_DIR})
+set (PLUGIN_INSTALL_DIR ${PLUGIN_INSTALL_REL_DIR})
 set (DATA_INSTALL_REL_DIR ${CMAKE_INSTALL_DATAROOTDIR}/${INSTALL_NAME})
-set (DATA_INSTALL_DIR ${INSTALL_DIR}/${DATA_INSTALL_REL_DIR})
-set (DOC_INSTALL_DIR ${INSTALL_DIR}/${CMAKE_INSTALL_DATAROOTDIR}/doc)
+set (DATA_INSTALL_DIR ${DATA_INSTALL_REL_DIR})
+set (DOC_INSTALL_DIR ${CMAKE_INSTALL_DATAROOTDIR}/doc)
 set (ICON_INSTALL_DIR ${DATA_INSTALL_DIR}/icon)
 set (CONFIG_INSTALL_REL_DIR ${CMAKE_INSTALL_DATADIR}/${INSTALL_NAME})
-set (CONFIG_INSTALL_DIR ${INSTALL_DIR}/${CONFIG_INSTALL_REL_DIR})
+set (CONFIG_INSTALL_DIR ${CONFIG_INSTALL_REL_DIR})
+
+file (READ "${CMAKE_SOURCE_DIR}/comms/include/comms/version.h" version_file)
+string (REGEX MATCH "COMMS_MAJOR_VERSION ([0-9]*)U*" _ ${version_file})
+set (major_ver ${CMAKE_MATCH_1})
+string (REGEX MATCH "COMMS_MINOR_VERSION ([0-9]*)U*" _ ${version_file})
+set (minor_ver ${CMAKE_MATCH_1})
+string (REGEX MATCH "COMMS_PATCH_VERSION ([0-9]*)U*" _ ${version_file})
+set (patch_ver ${CMAKE_MATCH_1})
+set (COMMS_VERSION "${major_ver}.${minor_ver}.${patch_ver}")
+
+
+include(CMakePackageConfigHelpers)
+write_basic_package_version_file(
+    ${CMAKE_BINARY_DIR}/LibCommsConfigVersion.cmake
+    VERSION ${COMMS_VERSION}
+    COMPATIBILITY AnyNewerVersion)
+
+write_basic_package_version_file(
+    ${CMAKE_BINARY_DIR}/CommsChampionConfigVersion.cmake
+    VERSION ${COMMS_VERSION}
+    COMPATIBILITY AnyNewerVersion)
+    
+set (LIB_COMMS_CMAKE_FILES
+    ${CMAKE_SOURCE_DIR}/cmake/LibCommsConfig.cmake
+    ${CMAKE_SOURCE_DIR}/cmake/DocCleanupScript.cmake    
+    ${CMAKE_BINARY_DIR}/LibCommsConfigVersion.cmake
+) 
+
+set (COMMS_CHAMPION_CMAKE_FILES
+    ${CMAKE_SOURCE_DIR}/cmake/CC_DefineExternalProjectTargets.cmake
+    ${CMAKE_SOURCE_DIR}/cmake/CommsChampionConfig.cmake
+    ${CMAKE_SOURCE_DIR}/cmake/DefineExternalProjectTargets.cmake
+    ${CMAKE_SOURCE_DIR}/cmake/DeployQt5.cmake
+    ${CMAKE_SOURCE_DIR}/cmake/DocCleanupScript.cmake
+    ${CMAKE_SOURCE_DIR}/cmake/GenWinAppStartBat.cmake                    
+    ${CMAKE_BINARY_DIR}/LibCommsConfigVersion.cmake
+)    
+   
+install (
+    FILES ${LIB_COMMS_CMAKE_FILES}
+    DESTINATION ${LIB_INSTALL_DIR}/LibComms/cmake/
+)
+
+install (
+    FILES ${COMMS_CHAMPION_CMAKE_FILES}
+    DESTINATION ${LIB_INSTALL_DIR}/CommsChampion/cmake/
+)
 
-install (DIRECTORY cmake DESTINATION ${LIB_INSTALL_DIR}/${INSTALL_NAME})
 
 add_subdirectory (comms)
 

cmake/CommsChampionConfig.cmake

@@ -15,19 +15,33 @@
 # cc::comms - Link target for COMMS library
 # cc::comms_champion - Link target for "comms_champion" libarary. Use it in plugin development.
 
-if (EXISTS ${CMAKE_CURRENT_LIST_DIR}/commsExport.cmake)
-    include (${CMAKE_CURRENT_LIST_DIR}/commsExport.cmake)
+get_filename_component(_ONE_UP_DIR "${CMAKE_CURRENT_LIST_DIR}" PATH)
+get_filename_component(_TWO_UP_DIR "${_ONE_UP_DIR}" PATH)
+set (LIBCOMMS_CMAKE_DIR "${_TWO_UP_DIR}/LibComms/cmake")
+
+if ((NOT TARGET cc::comms) AND (EXISTS ${LIBCOMMS_CMAKE_DIR}/LibCommsConfig.cmake))
+    include (${LIBCOMMS_CMAKE_DIR}/LibCommsConfig.cmake)
 endif ()
 
 if (EXISTS ${CMAKE_CURRENT_LIST_DIR}/comms_championExport.cmake)
     include (${CMAKE_CURRENT_LIST_DIR}/comms_championExport.cmake)
 endif ()
 
+if (NOT TARGET cc::comms_champion)
+    return ()
+endif ()
+
+# Load information for each installed configuration.
+file(GLOB config_files "${CMAKE_CURRENT_LIST_DIR}/CommsChampionConfig-*.cmake")
+foreach(f ${config_files})
+    include(${f})
+endforeach()
+
 get_filename_component (CC_INSTALL_LIB_PROJ_DIR ${CMAKE_CURRENT_LIST_DIR} DIRECTORY)
 get_filename_component (CC_INSTALL_LIB_DIR ${CC_INSTALL_LIB_PROJ_DIR} DIRECTORY)
 get_filename_component (CC_ROOT_DIR ${CC_INSTALL_LIB_DIR} DIRECTORY)
 
-find_path(CC_INCLUDE_DIR NAMES comms/comms.h PATHS "${CC_ROOT_DIR}" PATH_SUFFIXES include)
+find_path(CC_INCLUDE_DIR NAMES comms_champion/Message.h PATHS "${CC_ROOT_DIR}" PATH_SUFFIXES include)
 find_library(CC_PLUGIN_LIBRARY  NAMES "comms_champion" PATHS "${CC_ROOT_DIR}" PATH_SUFFIXES lib)
 
 if (MSVC)
@@ -47,15 +61,11 @@ endif ()
 set (CC_CMAKE_DIR ${CMAKE_CURRENT_LIST_DIR})
 
 find_package(PackageHandleStandardArgs REQUIRED)
-FIND_PACKAGE_HANDLE_STANDARD_ARGS(CC_COMMS REQUIRED_VARS CC_INCLUDE_DIR)
 FIND_PACKAGE_HANDLE_STANDARD_ARGS(CC_COMMS_CHAMPION REQUIRED_VARS 
     CC_ROOT_DIR CC_INCLUDE_DIR CC_PLUGIN_LIBRARY_DIR CC_PLUGIN_LIBRARY CC_CMAKE_DIR)
 
-if (CC_COMMS_FOUND)
-    set (CC_INCLUDE_DIRS ${CC_INCLUDE_DIR})
-endif ()
-
 if (CC_COMMS_CHAMPION_FOUND)
+    set (CC_INCLUDE_DIRS ${CC_INCLUDE_DIR})
     set (CC_PLUGIN_LIBRARIES ${CC_PLUGIN_LIBRARY})
     set (CC_PLUGIN_LIBRARY_DIRS ${CC_PLUGIN_LIBRARY_DIR})
 endif ()    

cmake/LibCommsConfig.cmake

@@ -0,0 +1,34 @@
+# Find COMMS library from CommsChampion Ecosystem
+# 
+# Output is provided using the following variables
+#  CC_COMMS_FOUND - Found COMMS library, use CC_COMMS_INCLUDE_DIRS for includes
+#  CC_COMMS_INCLUDE_DIRS - Where to find all the headers
+#
+# Additional output targets
+# cc::comms - Link target for COMMS library
+
+if (EXISTS ${CMAKE_CURRENT_LIST_DIR}/commsExport.cmake)
+    include (${CMAKE_CURRENT_LIST_DIR}/commsExport.cmake)
+endif ()
+
+# Load information for each installed configuration.
+file(GLOB config_files "${CMAKE_CURRENT_LIST_DIR}/LibCommsConfig-*.cmake")
+foreach(f ${config_files})
+    include(${f})
+endforeach()
+
+if (NOT TARGET cc::comms)
+    return ()
+endif ()
+
+get_target_property(CC_COMMS_INCLUDE_DIRS cc::comms INTERFACE_INCLUDE_DIRECTORIES)
+
+find_package(PackageHandleStandardArgs REQUIRED)
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(CC_COMMS REQUIRED_VARS CC_COMMS_INCLUDE_DIRS)
+
+if (CC_COMMS_FOUND)
+    set (CC_COMMS_INCLUDE_DIR ${CC_COMMS_INCLUDE_DIRS})
+endif ()    
+
+
+

comms/CMakeLists.txt

@@ -1,7 +1,6 @@
 find_package (Doxygen)
 if (DOXYGEN_FOUND)
-    set (doc_output_dir "${DOC_INSTALL_DIR}/comms")
-    make_directory (${doc_output_dir})
+    set (doc_output_dir "${CMAKE_INSTALL_PREFIX}/${DOC_INSTALL_DIR}/comms")
 
     set (match_str "OUTPUT_DIRECTORY[^\n]*")
     set (replacement_str "OUTPUT_DIRECTORY = ${doc_output_dir}")
@@ -13,6 +12,7 @@ if (DOXYGEN_FOUND)
     file (WRITE "${output_file}" "${modified_config_text}")
 
     add_custom_target ("doc_comms"
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${doc_output_dir}
             COMMAND ${DOXYGEN_EXECUTABLE} ${output_file}
             COMMAND ${CMAKE_COMMAND} -DDOC_OUTPUT_DIR="${doc_output_dir}" -P 
                             ${CMAKE_SOURCE_DIR}/cmake/DocCleanupScript.cmake
@@ -33,7 +33,7 @@ target_compile_options(comms INTERFACE
 
 install(TARGETS comms EXPORT commsExport)
 install(EXPORT commsExport NAMESPACE cc::
-  DESTINATION ${LIB_INSTALL_DIR}/${INSTALL_NAME}/cmake
+  DESTINATION ${LIB_INSTALL_DIR}/LibComms/cmake
 )
 
 install (

comms/include/comms/Assert.h

@@ -148,6 +148,7 @@ class EnableAssert
 };
 
 
+#ifndef COMMS_ASSERT
 #ifndef NDEBUG
 
 /// @cond DOCUCMENT_AM_ASSERT_FUNCTION
@@ -184,9 +185,12 @@ class EnableAssert
 #define COMMS_ASSERT(expr) static_cast<void>(0)
 
 #endif // #ifndef NDEBUG
+#endif // #ifndef COMMS_ASSERT
 
+#ifndef GASSERT
 /// @brief Same as @ref COMMS_ASSERT
 /// @details Kept for backward compatibility of already written protocols.
 #define GASSERT(expr) COMMS_ASSERT(expr)
+#endif // #ifndef GASSERT
 
 }  // namespace comms

comms/include/comms/version.h

@@ -27,7 +27,7 @@
 #define COMMS_MINOR_VERSION 0U
 
 /// @brief Patch level of the library
-#define COMMS_PATCH_VERSION 0U
+#define COMMS_PATCH_VERSION 1U
 
 /// @brief Macro to create numeric version as single unsigned number
 #define COMMS_MAKE_VERSION(major_, minor_, patch_) \

comms_champion/CMakeLists.txt

@@ -1,8 +1,6 @@
 find_package (Doxygen)
 if (DOXYGEN_FOUND)
-    set (doc_output_dir "${DOC_INSTALL_DIR}/comms_champion")
-    make_directory (${doc_output_dir})
-    
+    set (doc_output_dir "${CMAKE_INSTALL_PREFIX}/${DOC_INSTALL_DIR}/comms_champion")
     set (match_str "OUTPUT_DIRECTORY[^\n]*")
     set (replacement_str "OUTPUT_DIRECTORY = ${doc_output_dir}")
     set (output_file "${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf")
@@ -13,6 +11,7 @@ if (DOXYGEN_FOUND)
     file (WRITE "${output_file}" "${modified_config_text}")
 
     add_custom_target ("doc_commschampion"
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${doc_output_dir}
             COMMAND ${DOXYGEN_EXECUTABLE} ${output_file}
             COMMAND ${CMAKE_COMMAND} -DDOC_OUTPUT_DIR="${doc_output_dir}" -P 
                             ${CMAKE_SOURCE_DIR}/cmake/DocCleanupScript.cmake

comms_champion/app/cc_view/src/widget/ProtocolsStackWidget.cpp

@@ -176,7 +176,7 @@ void ProtocolsStackWidget::newItemSelected()
         assert(item != nullptr);
         msgPtrVar = item->data(0, Qt::UserRole);
         m_ui.m_protocolsTreeWidget->setCurrentItem(item);
-        assert(m_ui.m_protocolsTreeWidget->isItemSelected(item));
+        assert(item->isSelected());
     }
 
     assert(msgPtrVar.isValid());