iox-eclipse-iceoryx#1287 Add cmake linter CI target and handle MAKE_UNIQUE_INCLUDEDIR

Signed-off-by: Christian Eltzschig <me@elchris.org>

Author: elfenpiff

.github/workflows/build-test.yml

@@ -23,6 +23,12 @@ jobs:
       - uses: actions/checkout@v3
       - run: ./tools/ci/markdown-link-verificator.sh
 
+  cmake-lint-check:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - run: ./tools/ci/cmake-linter.sh
+
   build-test-ubuntu:
     runs-on: ubuntu-20.04
     needs: pre-flight-check

iceoryx_binding_c/CMakeLists.txt

@@ -31,20 +31,7 @@ if(CMAKE_SYSTEM_NAME MATCHES Linux OR CMAKE_SYSTEM_NAME MATCHES Darwin)
     option(BUILD_SHARED_LIBS "Create shared libraries by default" ON)
 endif()
 
-option(MAKE_UNIQUE_INCLUDEDIR
-  "When ON headers are installed to a path ending with folders called \
-  iceoryx/vX.Y.Z/ . This avoids include directory search order issues when \
-  overriding this package from a merged catkin, ament, or colcon workspace."
-  ON)
-
-if(MAKE_UNIQUE_INCLUDEDIR)
-  set(_unique_dir "iceoryx/v${IOX_VERSION_STRING}")
-  if(PREFIX STREQUAL "")
-    set(PREFIX "${_unique_dir}")
-  else()
-    set(PREFIX "${PREFIX}/${_unique_dir}")
-  endif()
-endif()
+iox_make_unique_includedir()
 
 #
 ########## build building-block library ##########

iceoryx_hoofs/CMakeLists.txt

@@ -28,21 +28,7 @@ if(CMAKE_SYSTEM_NAME MATCHES Linux OR CMAKE_SYSTEM_NAME MATCHES Darwin)
     option(BUILD_SHARED_LIBS "Create shared libraries by default" ON)
 endif()
 
-option(MAKE_UNIQUE_INCLUDEDIR
-  "When ON headers are installed to a path ending with folders called \
-  iceoryx/vX.Y.Z/ . This avoids include directory search order issues when \
-  overriding this package from a merged catkin, ament, or colcon workspace."
-  ON)
-
-if(MAKE_UNIQUE_INCLUDEDIR)
-  set(_unique_dir "iceoryx/v${IOX_VERSION_STRING}")
-  if(PREFIX STREQUAL "")
-    set(PREFIX "${_unique_dir}")
-  else()
-    set(PREFIX "${PREFIX}/${_unique_dir}")
-  endif()
-endif()
-
+iox_make_unique_includedir()
 add_subdirectory(platform)
 
 #

iceoryx_hoofs/cmake/IceoryxPackageHelper.cmake

@@ -112,6 +112,23 @@ Macro(install_package_files_and_export)
     )
 endMacro()
 
+Macro(iox_make_unique_includedir)
+    option(MAKE_UNIQUE_INCLUDEDIR
+      "When ON headers are installed to a path ending with folders called \
+      iceoryx/vX.Y.Z/ . This avoids include directory search order issues when \
+      overriding this package from a merged catkin, ament, or colcon workspace."
+      ON)
+
+    if(MAKE_UNIQUE_INCLUDEDIR)
+      set(_unique_dir "iceoryx/v${IOX_VERSION_STRING}")
+      if(PREFIX STREQUAL "")
+        set(PREFIX "${_unique_dir}")
+      else()
+        set(PREFIX "${PREFIX}/${_unique_dir}")
+      endif()
+    endif()
+endMacro()
+
 Macro(iox_set_rpath)
     set(arguments TARGET RPATH )
     cmake_parse_arguments(IOX "" "" "${arguments}" ${ARGN} )
@@ -211,7 +228,6 @@ Macro(iox_add_library)
     cmake_parse_arguments(IOX "${switches}" "${arguments}" "${multiArguments}" ${ARGN} )
 
     if ( NOT IOX_NO_PACKAGE_SETUP )
-        message("setup ${IOX_TARGET}")
         setup_package_name_and_create_files(
             NAME ${IOX_TARGET}
             NAMESPACE ${IOX_NAMESPACE}

tools/ci/cmake-linter.sh

@@ -40,6 +40,12 @@ performCmakeLinting()
             echo "  please do not use the cmake command \"add_executable\", use \"iox_add_executable\" instead"
             EXIT_CODE=1
         fi
+
+         if ! [[ $(cat $FILE | grep "MAKE_UNIQUE_INCLUDEDIR" | wc -l) == "0" ]]
+        then
+            echo "  please do not access MAKE_UNIQUE_INCLUDEDIR directly, use \"iox_make_unique_includedir()\" and access it via the variable \"PREFIX\""
+            EXIT_CODE=1
+        fi
     done
 }