Integrate hpc coding conventions and reformat CMake files

.cmake-format.changes.yaml

@@ -0,0 +1,6 @@
+additional_commands:
+  cuda_add_library:
+    pargs: '*'
+    flags: ["STATIC", "SHARED", "MODULE", "EXCLUDE_FROM_ALL"]
+    kwargs:
+      OPTIONS: '*'

.gitmodules

@@ -10,3 +10,6 @@
 [submodule "external/Random123"]
 	path = external/Random123
 	url = https://github.com/BlueBrain/Random123.git
+[submodule "CMake/hpc-coding-conventions"]
+	path = CMake/hpc-coding-conventions
+	url = https://github.com/BlueBrain/hpc-coding-conventions.git

CMake/AddCLI11Submodule.cmake

@@ -1,13 +1,17 @@
 # =============================================================================
-# Copyright (C) 2020 Blue Brain Project
+# Copyright (C) 2016-2020 Blue Brain Project
 #
 # See top-level LICENSE file for details.
 # =============================================================================
 
-
 include(FindPackageHandleStandardArgs)
 find_package(FindPkgConfig QUIET)
-find_path(CLI11_PROJ NAMES CMakeLists.txt PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/CLI11")
+
+find_path(
+  CLI11_PROJ
+  NAMES CMakeLists.txt
+  PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/CLI11")
+
 find_package_handle_standard_args(CLI11 REQUIRED_VARS CLI11_PROJ)
 
 if(NOT CLI11_FOUND)
@@ -16,8 +20,9 @@ if(NOT CLI11_FOUND)
     message(FATAL_ERROR "git not found, clone repository with --recursive")
   endif()
   message(STATUS "Sub-module CLI11 missing: running git submodule update --init --recursive")
-  execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive --
-                          ${CORENEURON_PROJECT_SOURCE_DIR}/external/CLI11
-                  WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
+  execute_process(
+    COMMAND
+      ${GIT_EXECUTABLE} submodule update --init --recursive --
+      ${CORENEURON_PROJECT_SOURCE_DIR}/external/CLI11
+    WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
 endif()
-

CMake/AddMod2cSubmodule.cmake

@@ -1,13 +1,17 @@
 # =============================================================================
-# Copyright (C) 2016-2019 Blue Brain Project
+# Copyright (C) 2016-2020 Blue Brain Project
 #
 # See top-level LICENSE file for details.
 # =============================================================================
 
 include(ExternalProject)
-
 find_package(FindPkgConfig QUIET)
-find_path(MOD2C_PROJ NAMES CMakeLists.txt PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/mod2c")
+
+find_path(
+  MOD2C_PROJ
+  NAMES CMakeLists.txt
+  PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/mod2c")
+
 find_package_handle_standard_args(MOD2C REQUIRED_VARS MOD2C_PROJ)
 
 if(NOT MOD2C_FOUND)
@@ -16,24 +20,23 @@ if(NOT MOD2C_FOUND)
     message(FATAL_ERROR "git not found, clone repository with --recursive")
   endif()
   message(STATUS "Sub-module mod2c missing : running git submodule update --init --recursive")
-  execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive --
-                          ${CORENEURON_PROJECT_SOURCE_DIR}/external/mod2c
-                  WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
+  execute_process(
+    COMMAND
+      ${GIT_EXECUTABLE} submodule update --init --recursive --
+      ${CORENEURON_PROJECT_SOURCE_DIR}/external/mod2c
+    WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
 else()
   message(STATUS "Using mod2c submodule from ${MOD2C_PROJ}")
 endif()
 
 set(ExternalProjectCMakeArgs
-    -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-    -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}
+    -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}
     -DCMAKE_C_COMPILER=${CORENRN_FRONTEND_C_COMPILER}
     -DCMAKE_CXX_COMPILER=${CORENRN_FRONTEND_CXX_COMPILER})
 
-externalproject_add(mod2c
-                    BUILD_ALWAYS
-                    1
-                    SOURCE_DIR
-                    ${CORENEURON_PROJECT_SOURCE_DIR}/external/mod2c
-                    GIT_SUBMODULES
-                    CMAKE_ARGS
-                    ${ExternalProjectCMakeArgs})
+ExternalProject_Add(
+  mod2c
+  BUILD_ALWAYS 1
+  SOURCE_DIR ${CORENEURON_PROJECT_SOURCE_DIR}/external/mod2c
+  GIT_SUBMODULES
+  CMAKE_ARGS ${ExternalProjectCMakeArgs})

CMake/AddNmodlSubmodule.cmake

@@ -1,12 +1,16 @@
 # =============================================================================
-# Copyright (C) 2016-2019 Blue Brain Project
+# Copyright (C) 2016-2020 Blue Brain Project
 #
 # See top-level LICENSE file for details.
 # =============================================================================
 
-
 find_package(FindPkgConfig QUIET)
-find_path(NMODL_PROJ NAMES CMakeLists.txt PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/nmodl")
+
+find_path(
+  NMODL_PROJ
+  NAMES CMakeLists.txt
+  PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/nmodl")
+
 find_package_handle_standard_args(NMODL REQUIRED_VARS NMODL_PROJ)
 
 if(NOT NMODL_FOUND)
@@ -15,12 +19,13 @@ if(NOT NMODL_FOUND)
     message(FATAL_ERROR "git not found, clone repository with --recursive")
   endif()
   message(STATUS "Sub-module nmodl missing : running git submodule update --init --recursive")
-  execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive --
-                          ${CORENEURON_PROJECT_SOURCE_DIR}/external/nmodl
-                  WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
+  execute_process(
+    COMMAND
+      ${GIT_EXECUTABLE} submodule update --init --recursive --
+      ${CORENEURON_PROJECT_SOURCE_DIR}/external/nmodl
+    WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
 else()
   message(STATUS "Using nmodl submodule from ${NMODL_PROJ}")
 endif()
 
 add_subdirectory(${CORENEURON_PROJECT_SOURCE_DIR}/external/nmodl)
-

CMake/AddRandom123Submodule.cmake

@@ -1,13 +1,17 @@
 # =============================================================================
-# Copyright (C) 2020 Blue Brain Project
+# Copyright (C) 2016-2020 Blue Brain Project
 #
 # See top-level LICENSE file for details.
 # =============================================================================
 
-
 include(FindPackageHandleStandardArgs)
 find_package(FindPkgConfig QUIET)
-find_path(Random123_PROJ NAMES LICENSE PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/Random123")
+
+find_path(
+  Random123_PROJ
+  NAMES LICENSE
+  PATHS "${CORENEURON_PROJECT_SOURCE_DIR}/external/Random123")
+
 find_package_handle_standard_args(Random123 REQUIRED_VARS Random123_PROJ)
 
 if(NOT Random123_FOUND)
@@ -16,8 +20,9 @@ if(NOT Random123_FOUND)
     message(FATAL_ERROR "git not found, clone repository with --recursive")
   endif()
   message(STATUS "Sub-module Random123 missing: running git submodule update --init --recursive")
-  execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive --
-                          ${CORENEURON_PROJECT_SOURCE_DIR}/external/Random123
-                  WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
+  execute_process(
+    COMMAND
+      ${GIT_EXECUTABLE} submodule update --init --recursive --
+      ${CORENEURON_PROJECT_SOURCE_DIR}/external/Random123
+    WORKING_DIRECTORY ${CORENEURON_PROJECT_SOURCE_DIR})
 endif()
-

CMake/CMakeDetermineISPCCompiler.cmake

@@ -1,16 +1,15 @@
 # =============================================================================
-# Copyright (C) 2016-2019 Blue Brain Project
+# Copyright (C) 2016-2020 Blue Brain Project
 #
 # See top-level LICENSE file for details.
 # =============================================================================
 
-# Find the compiler
+# Find the ISPC compiler
 find_program(
-    CMAKE_ISPC_COMPILER
-        NAMES $ENV{ISPC} ispc
-        PATHS ENV PATH
-        DOC "ISPC compiler"
-)
+  CMAKE_ISPC_COMPILER
+  NAMES $ENV{ISPC} ispc
+  PATHS ENV PATH
+  DOC "ISPC compiler")
 mark_as_advanced(CMAKE_ISPC_COMPILER)
 
 set(CMAKE_ISPC_SOURCE_FILE_EXTENSIONS ispc)

CMake/CMakeISPCInformation.cmake

@@ -8,6 +8,6 @@
 set(CMAKE_INCLUDE_FLAG_ISPC "-I")
 
 if(NOT CMAKE_ISPC_COMPILE_OBJECT)
-    set(CMAKE_ISPC_COMPILE_OBJECT "<CMAKE_ISPC_COMPILER> <FLAGS> <INCLUDES> <SOURCE> -o <OBJECT>")
+  set(CMAKE_ISPC_COMPILE_OBJECT "<CMAKE_ISPC_COMPILER> <FLAGS> <INCLUDES> <SOURCE> -o <OBJECT>")
 endif()
 set(CMAKE_ISPC_INFORMATION_LOADED 1)

CMake/CMakeTestISPCCompiler.cmake

@@ -1,30 +1,36 @@
 if(CMAKE_ISPC_COMPILER_FORCED)
-  # The compiler configuration was forced by the user.
-  # Assume the user has configured all compiler information.
+  # ~~~
+  # The compiler configuration was forced by the user. Assume the user has
+  # configured all compiler information.
+  # ~~~
   set(CMAKE_ISPC_COMPILER_WORKS TRUE)
   return()
 endif()
 
-set(CMAKE_ISPC_COMPILER_WORKS 1 CACHE INTERNAL "")
+set(CMAKE_ISPC_COMPILER_WORKS
+    1
+    CACHE INTERNAL "")
 
-# Remove any cached result from an older CMake version.
-# We now store this in CMakeISPCCompiler.cmake.
+# Remove any cached result from an older CMake version. We now store this in
+# CMakeISPCCompiler.cmake.
 unset(CMAKE_ISPC_COMPILER_WORKS CACHE)
 
-# This file is used by EnableLanguage in cmGlobalGenerator to
-# determine that the selected ispc compiler can actually compile
-# and the most basic program. If not, a fatal error
-# is set and cmake stops processing commands and will not generate
-# any makefiles or projects.
+# ~~~
+# This file is used by EnableLanguage in cmGlobalGenerator to determine that the selected
+# ispc compiler can actually compile and the most basic program. If not, a fatal error is
+# set and cmake stops processing commands and will not generate any makefiles or projects.
+# ~~~
 if(NOT CMAKE_ISPC_COMPILER_WORKS)
-  PrintTestCompilerStatus("ISPC" "")
+  printtestcompilerstatus("ISPC" "")
   file(WRITE ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/kernel.ispc
-    "export uniform int kernel(uniform int){return 0;}\n")
+       "export uniform int kernel(uniform int){return 0;}\n")
 
-  execute_process(COMMAND ${CMAKE_ISPC_COMPILER} "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/kernel.ispc"
-     OUTPUT_VARIABLE __CMAKE_ISPC_COMPILER_OUTPUT
-     ERROR_VARIABLE __CMAKE_ISPC_COMPILER_ERROR
-     RESULT_VARIABLE ISPC_RESULT)
+  execute_process(
+    COMMAND ${CMAKE_ISPC_COMPILER}
+            "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/kernel.ispc"
+    OUTPUT_VARIABLE __CMAKE_ISPC_COMPILER_OUTPUT
+    ERROR_VARIABLE __CMAKE_ISPC_COMPILER_ERROR
+    RESULT_VARIABLE ISPC_RESULT)
 
   if(${ISPC_RESULT})
     set(CMAKE_ISPC_COMPILER_WORKS 0)
@@ -37,25 +43,28 @@ if(NOT CMAKE_ISPC_COMPILER_WORKS)
   set(ISPC_TEST_WAS_RUN 1)
 endif()
 
+# Print compiler status
 if(NOT CMAKE_ISPC_COMPILER_WORKS)
-  PrintTestCompilerStatus("ISPC" " -- broken")
+  printtestcompilerstatus("ISPC" " -- broken")
   file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
-    "Determining if the ISPC compiler works failed with "
-    "the following output:\n${__CMAKE_ISPC_COMPILER_OUTPUT}\n\n")
-  string(REPLACE "\n" "\n  " _output "${__CMAKE_ISPC_COMPILER_OUTPUT} ${__CMAKE_ISPC_COMPILER_ERROR}")
-  message(FATAL_ERROR "The ISPC compiler\n  \"${CMAKE_ISPC_COMPILER}\"\n"
-    "is not able to compile a simple test program.\nIt fails "
-    "with the following output:\n  ${_output}\n\n"
-    "CMake will not be able to correctly generate this project.")
+       "Determining if the ISPC compiler works failed with "
+       "the following output:\n${__CMAKE_ISPC_COMPILER_OUTPUT}\n\n")
+  string(REPLACE "\n" "\n  " _output
+                 "${__CMAKE_ISPC_COMPILER_OUTPUT} ${__CMAKE_ISPC_COMPILER_ERROR}")
+  message(
+    FATAL_ERROR
+      "The ISPC compiler\n  \"${CMAKE_ISPC_COMPILER}\"\n"
+      "is not able to compile a simple test program.\nIt fails "
+      "with the following output:\n  ${_output}\n\n"
+      "CMake will not be able to correctly generate this project.")
 else()
   if(ISPC_TEST_WAS_RUN)
-    PrintTestCompilerStatus("ISPC" " -- works")
+    printtestcompilerstatus("ISPC" " -- works")
     file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
-      "Determining if the ISPC compiler works passed with "
-      "the following output:\n${__CMAKE_ISPC_COMPILER_OUTPUT}\n\n")
+         "Determining if the ISPC compiler works passed with "
+         "the following output:\n${__CMAKE_ISPC_COMPILER_OUTPUT}\n\n")
   endif()
 endif()
 
-
 unset(__CMAKE_ISPC_COMPILER_OUTPUT)
 unset(__CMAKE_ISPC_COMPILER_ERROR)

CMake/ClangFormatHelper.cmake

@@ -1,5 +1,5 @@
 # =============================================================================
-# Copyright (C) 2016-2019 Blue Brain Project
+# Copyright (C) 2016-2020 Blue Brain Project
 #
 # See top-level LICENSE file for details.
 # =============================================================================
@@ -17,23 +17,26 @@ if(CLANG_FORMAT_FOUND)
   file(COPY ${CORENEURON_PROJECT_SOURCE_DIR}/.clang-format DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
 
   # all source files under coreneuron directory
-  file(GLOB_RECURSE SRC_FILES_FOR_CLANG_FORMAT
-                    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.c
-                    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.cpp
-                    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.h*
-                    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.ipp*)
+  file(
+    GLOB_RECURSE
+    SRC_FILES_FOR_CLANG_FORMAT
+    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.c
+    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.cpp
+    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.h*
+    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/*.ipp*)
 
   # exclude random123
   file(GLOB_RECURSE RANDOM123_FILES
-                    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/utils/randoms/Random123/*.cpp
-                    ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/utils/randoms/Random123/*.h)
+       ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/utils/randoms/Random123/*.cpp
+       ${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/utils/randoms/Random123/*.h)
 
   foreach(R123_PATH ${RANDOM123_FILES})
     list(REMOVE_ITEM SRC_FILES_FOR_CLANG_FORMAT ${R123_PATH})
   endforeach(R123_PATH)
 
-  add_custom_target(clang-format
-                    COMMAND ${CMAKE_COMMAND} -DSOURCE_FILES:STRING="${SRC_FILES_FOR_CLANG_FORMAT}"
-                            -DCLANG_FORMAT_EXECUTABLE=${CLANG_FORMAT_EXECUTABLE} -P
-                            "${CORENEURON_PROJECT_SOURCE_DIR}/CMake/ClangFormatUtils.cmake")
+  add_custom_target(
+    clang-format
+    COMMAND ${CMAKE_COMMAND} -DSOURCE_FILES:STRING="${SRC_FILES_FOR_CLANG_FORMAT}"
+            -DCLANG_FORMAT_EXECUTABLE=${CLANG_FORMAT_EXECUTABLE} -P
+            "${CORENEURON_PROJECT_SOURCE_DIR}/CMake/ClangFormatUtils.cmake")
 endif()

CMake/ClangFormatUtils.cmake

@@ -1,15 +1,12 @@
 # =============================================================================
-# Copyright (C) 2016-2019 Blue Brain Project
+# Copyright (C) 2016-2020 Blue Brain Project
 #
 # See top-level LICENSE file for details.
 # =============================================================================
 
-string(REPLACE " "
-               ";"
-               FILES_TO_FORMAT
-               ${SOURCE_FILES})
+string(REPLACE " " ";" FILES_TO_FORMAT ${SOURCE_FILES})
 
 foreach(SRC_FILE ${FILES_TO_FORMAT})
-  execute_process(
-    COMMAND ${CLANG_FORMAT_EXECUTABLE} -i -style=file -fallback-style=none ${SRC_FILE})
+  execute_process(COMMAND ${CLANG_FORMAT_EXECUTABLE} -i -style=file -fallback-style=none
+                          ${SRC_FILE})
 endforeach()