Merge pull request #2882 in HDFFV/hdf5 from ~BYRN/hdf5_adb:feature/cmakeV2-clang-format to develop

* commit '571a5e9250ca69adb54ef956361a5cf77059f67c':
  Add h5ls test plugin format target
  Fix manifest
  Add code owners file
  Update actions - split push/pull-request commits
  Change to executable
  Change to based on LLVM format
  Fix comment formatting due to tabs conversion
  Disable formatting for file
  File changes to affect formatting
  CMake and script changes for clang-format

2 files changed, 151 insertions, 4 deletions

diff --git a/config/sanitizer/formatting.cmake b/config/sanitizer/formatting.cmake
new file mode 100644
index 0000000..677a69a
--- /dev/null
+++ b/config/sanitizer/formatting.cmake
@@ -0,0 +1,144 @@
+#
+# Copyright (C) 2019 by George Cave - gcave@stablecoder.ca
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+#
+# clang-format
+#
+find_program(CLANG_FORMAT_EXE "clang-format")
+mark_as_advanced(FORCE CLANG_FORMAT_EXE)
+if(CLANG_FORMAT_EXE)
+  message(STATUS "clang-format found: ${CLANG_FORMAT_EXE}")
+else()
+  message(STATUS "clang-format not found!")
+endif()
+
+# Generates a 'format' target using a custom name, files, and include
+# directories all being parameters.
+#
+# Do note that in order for sources to be inherited properly, the source paths
+# must be reachable from where the macro is called, or otherwise require a full
+# path for proper inheritance.
+#
+# ~~~
+# Required:
+# TARGET_NAME - The name of the target to create.
+#
+# Optional: ARGN - The list of targets OR files to format. Relative and absolute
+# paths are accepted.
+# ~~~
+function(clang_format TARGET_NAME)
+  if(CLANG_FORMAT_EXE)
+    set(FORMAT_FILES)
+    # Check through the ARGN's, determine existent files
+    foreach(item IN LISTS ARGN)
+      if(TARGET ${item})
+        # If the item is a target, then we'll attempt to grab the associated
+        # source files from it.
+        get_target_property(_TARGET_TYPE ${item} TYPE)
+        if(NOT
+           _TARGET_TYPE
+           STREQUAL
+           "INTERFACE_LIBRARY")
+          get_property(
+            _TEMP
+            TARGET ${item}
+            PROPERTY SOURCES)
+          foreach(iter IN LISTS _TEMP)
+            if(EXISTS ${iter})
+              set(FORMAT_FILES ${FORMAT_FILES} ${iter})
+            endif()
+          endforeach()
+        endif()
+      elseif(EXISTS ${item})
+        # Check if it's a full file path
+        set(FORMAT_FILES ${FORMAT_FILES} ${item})
+      elseif(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${item})
+        # Check if it's based on the current source dir
+        set(FORMAT_FILES ${FORMAT_FILES} ${CMAKE_CURRENT_SOURCE_DIR}/${item})
+      endif()
+    endforeach()
+
+    # Make the target
+    if(FORMAT_FILES)
+      if(TARGET ${TARGET_NAME})
+        message(
+          ERROR
+          "Cannot create clang-format target '${TARGET_NAME}', already exists.")
+      else()
+        add_custom_target(${TARGET_NAME} COMMAND ${CLANG_FORMAT_EXE} -i -style=file ${FORMAT_FILES})
+
+        if(NOT TARGET format)
+          add_custom_target(format)
+        endif()
+
+        add_dependencies(format ${TARGET_NAME})
+      endif()
+    endif()
+
+  endif()
+endfunction()
+
+#
+# cmake-format
+#
+find_program(CMAKE_FORMAT_EXE "cmake-format")
+mark_as_advanced(FORCE CMAKE_FORMAT_EXE)
+if(CMAKE_FORMAT_EXE)
+  message(STATUS "cmake-format found: ${CMAKE_FORMAT_EXE}")
+else()
+  message(STATUS "cmake-format not found!")
+endif()
+
+# When called, this function will call 'cmake-format' program on all listed
+# files (if both the program and the files exist and are found)
+# ~~~
+# Required:
+# TARGET_NAME - The name of the target to create.
+#
+# Optional:
+# ARGN - Any  arguments passed in will be considered as 'files' to perform the
+# formatting on. Any items that are not files will be ignored. Both relative and
+# absolute paths are accepted.
+# ~~~
+function(cmake_format TARGET_NAME)
+  if(CMAKE_FORMAT_EXE)
+    set(FORMAT_FILES)
+    # Determine files that exist
+    foreach(iter IN LISTS ARGN)
+      if(EXISTS ${iter})
+        set(FORMAT_FILES ${FORMAT_FILES} ${iter})
+      elseif(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${iter})
+        set(FORMAT_FILES ${FORMAT_FILES} ${CMAKE_CURRENT_SOURCE_DIR}/${iter})
+      endif()
+    endforeach()
+
+    # Generate target
+    if(FORMAT_FILES)
+      if(TARGET ${TARGET_NAME})
+        message(
+          ERROR
+          "Cannot create cmake-format target '${TARGET_NAME}', already exists.")
+      else()
+        add_custom_target(${TARGET_NAME} COMMAND ${CMAKE_FORMAT_EXE} -i
+                                                 ${FORMAT_FILES})
+
+        if(NOT TARGET cmake-format)
+          add_custom_target(cmake-format)
+        endif()
+        add_dependencies(cmake-format ${TARGET_NAME})
+      endif()
+    endif()
+  endif()
+endfunction()
diff --git a/config/sanitizer/tools.cmake b/config/sanitizer/tools.cmake
index a44022f..2f73cce 100644
--- a/config/sanitizer/tools.cmake
+++ b/config/sanitizer/tools.cmake
@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2018 by George Cave - gcave@stablecoder.ca
+# Copyright (C) 2018-2020 by George Cave - gcave@stablecoder.ca
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may not
 # use this file except in compliance with the License. You may obtain a copy of
@@ -29,7 +29,7 @@ endmacro()
 # used as the options set.
 macro(include_what_you_use)
   if(IWYU AND IWYU_EXE)
-    set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "${IWYU_EXE};${IWYU_STRING}")
+    set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE ${IWYU_EXE} ${ARGN})
   endif()
 endmacro()
 
@@ -37,11 +37,12 @@ endmacro()
 # options set.
 macro(cppcheck)
   if(CPPCHECK AND CPPCHECK_EXE)
-    set(CMAKE_CXX_CPPCHECK "${CPPCHECK_EXE};${CPPCHECK_STRING}")
+    set(CMAKE_CXX_CPPCHECK ${CPPCHECK_EXE} ${ARGN})
   endif()
 endmacro()
 
 find_program(CLANG_TIDY_EXE NAMES "clang-tidy")
+mark_as_advanced(FORCE CLANG_TIDY_EXE)
 if(CLANG_TIDY_EXE)
   message(STATUS "clang-tidy found: ${CLANG_TIDY_EXE}")
   if(NOT CLANG_TIDY)
@@ -63,6 +64,7 @@ else()
 endif()
 
 find_program(IWYU_EXE NAMES "include-what-you-use")
+mark_as_advanced(FORCE IWYU_EXE)
 if(IWYU_EXE)
   message(STATUS "include-what-you-use found: ${IWYU_EXE}")
   if(NOT IWYU)
@@ -85,6 +87,7 @@ else()
 endif()
 
 find_program(CPPCHECK_EXE NAMES "cppcheck")
+mark_as_advanced(FORCE CPPCHECK_EXE)
 if(CPPCHECK_EXE)
   message(STATUS "cppcheck found: ${CPPCHECK_EXE}")
   if(CPPECHECK)
@@ -108,4 +111,4 @@ else()
   set(CMAKE_CXX_CPPCHECK
       ""
       CACHE STRING "" FORCE) # delete it
-endif()
+endif()
\ No newline at end of file