Add CMake style target and githooks for formatting

.clang-format

@@ -1,27 +1,84 @@
-BasedOnStyle : google
+BasedOnStyle : LLVM
+# Indent formatting
 IndentWidth : 2
-BreakBeforeBraces : Linux
+Language: Cpp
+UseTab: Never
 KeepEmptyLinesAtTheStartOfBlocks : true
 MaxEmptyLinesToKeep : 2
 AccessModifierOffset : -2
-UseTab: Never
+# This must be off so that include order in RAJA is preserved
+SortIncludes: false
+
+# Alignment of consecutive declarations, assignments etc
+AlignConsecutiveAssignments : true
+AlignConsecutiveDeclarations : false
+AlignConsecutiveMacros : true
+AlignTrailingComments : true
+
+# Control curly brace placement
+BreakBeforeBraces : Custom
+BraceWrapping:
+  AfterCaseLabel:  true
+  AfterClass:      true
+  AfterControlStatement: true
+  AfterEnum:       true
+  AfterFunction:   true
+  AfterNamespace:  true
+  AfterObjCDeclaration: false
+  AfterStruct:     true
+  AfterUnion:      true
+  AfterExternBlock: false
+  BeforeCatch:     true
+  BeforeElse:      true
+  BeforeLambdaBody: false
+  IndentBraces:    false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+
+# Pointer alignment
+DerivePointerAlignment: false
+PointerAlignment: Left
+
+# Single line config
 AllowShortIfStatementsOnASingleLine : true
-ConstructorInitializerAllOnOneLineOrOnePerLine : true
 AllowShortFunctionsOnASingleLine : true
 AllowShortLoopsOnASingleLine : false
-BinPackParameters : false
+AllowShortLambdasOnASingleLine : None
+PackConstructorInitializers : CurrentLine
+AllowAllArgumentsOnNextLine : true
 AllowAllParametersOfDeclarationOnNextLine : false
-AlignTrailingComments : true
+BinPackArguments : true
+BinPackParameters : false
+ConstructorInitializerAllOnOneLineOrOnePerLine : true
 ColumnLimit : 80
-PenaltyBreakBeforeFirstCallParameter : 100
-PenaltyReturnTypeOnItsOwnLine : 65000
-PenaltyBreakString : 10
 
-# These improve formatting results but require clang 3.6/7 or higher
-BreakBeforeBinaryOperators : None
-AlignAfterOpenBracket: true
-BinPackArguments : false
+AlignAfterOpenBracket: Align
 AlignOperands : true
 AlwaysBreakTemplateDeclarations : true
-Cpp11BracedListStyle : true
+AlwaysBreakAfterDefinitionReturnType : None
+PenaltyReturnTypeOnItsOwnLine : 10000
+BreakBeforeBinaryOperators : None
+
+# Indents
+IndentCaseLabels: true
+
+# Lambda body
+LambdaBodyIndentation : Signature
+
+SeparateDefinitionBlocks : Always
 
+# Space before/after settings
+SpaceAfterTemplateKeyword: false
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInConditionalStatement: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false

CMakeLists.txt

@@ -41,7 +41,7 @@ project(RAJA LANGUAGES CXX C
   VERSION ${RAJA_LOADED})
 
 set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/thirdparty" ${CMAKE_MODULE_PATH})
-
+set(BLT_REQUIRED_CLANGFORMAT_VERSION  "14" CACHE STRING "")
 include(cmake/SetupRajaOptions.cmake)
 
 cmake_minimum_required(VERSION 3.23)
@@ -136,6 +136,9 @@ include(cmake/SetupCompilers.cmake)
 # Macros for building executables and libraries
 include (cmake/RAJAMacros.cmake)
 
+# Configure `style` target for enforcing code style
+raja_add_code_checks()
+
 set (raja_sources
   src/AlignedRangeIndexSetBuilders.cpp
   src/DepGraphNode.cpp

cmake/RAJAMacros.cmake

@@ -204,3 +204,62 @@ macro(raja_add_benchmark)
     NUM_OMP_THREADS ${arg_NUM_OMP_THREADS}
     COMMAND ${TEST_DRIVER} ${arg_NAME})
 endmacro(raja_add_benchmark)
+
+##------------------------------------------------------------------------------
+## raja_add_code_checks()
+##
+## Adds code checks for all source files recursively in the RAJA repository.
+##
+## This creates the following parent build targets:
+##  check - Runs a non file changing style check and CppCheck
+##  style - In-place code formatting
+##
+## Creates various child build targets that follow this pattern:
+##  raja_<check|style>
+##  raja_<cppcheck|clangformat>_<check|style>
+##------------------------------------------------------------------------------
+macro(raja_add_code_checks)
+
+  set(options)
+  set(singleValueArgs)
+  set(multiValueArgs)
+
+  # Parse the arguments to the macro
+  cmake_parse_arguments(arg
+       "${options}" "${singleValueArgs}" "${multiValueArgs}" ${ARGN})
+
+  # Only do code checks if building raja by itself and not included in
+  # another project
+  if ("${PROJECT_SOURCE_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}")
+      # Create file globbing expressions that only include directories that contain source
+      # TODO(bowen) Add examples, exercises, test, and benchmark to the list below
+      set(_base_dirs "RAJA" "include" "src")
+      set(_ext_expressions "*.cpp" "*.hpp" "*.inl"
+                           "*.cxx" "*.hxx" "*.cc" "*.c" "*.h" "*.hh")
+
+      set(_glob_expressions)
+      foreach(_exp ${_ext_expressions})
+          foreach(_base_dir ${_base_dirs})
+              list(APPEND _glob_expressions "${PROJECT_SOURCE_DIR}/${_base_dir}/${_exp}")
+          endforeach()
+      endforeach()
+
+      # Glob for list of files to run code checks on
+      set(_sources)
+      file(GLOB_RECURSE _sources ${_glob_expressions})
+
+      blt_add_code_checks(PREFIX          RAJA
+                          SOURCES         ${_sources}
+                          CLANGFORMAT_CFG_FILE ${PROJECT_SOURCE_DIR}/.clang-format
+                          CPPCHECK_FLAGS  --enable=all --inconclusive)
+
+      # Set FOLDER property for code check targets
+      foreach(_suffix clangformat_check clangformat_style clang_tidy_check clang_tidy_style)
+          set(_tgt ${arg_PREFIX}_${_suffix})
+          if(TARGET ${_tgt})
+              set_target_properties(${_tgt} PROPERTIES FOLDER "RAJA/code_checks")
+          endif()
+      endforeach()
+  endif()
+
+endmacro(raja_add_code_checks)

cmake/SetupRajaOptions.cmake

@@ -28,7 +28,7 @@ option(RAJA_ENABLE_FORCEINLINE_RECURSIVE "Enable Forceinline recursive (only sup
 option(RAJA_DEPRECATED_TESTS "Test deprecated features" Off)
 option(RAJA_ENABLE_BOUNDS_CHECK "Enable bounds checking in RAJA::Views/Layouts" Off)
 option(RAJA_TEST_EXHAUSTIVE "Build RAJA exhaustive tests" Off)
-option(RAJA_TEST_OPENMP_TARGET_SUBSET "Build subset of RAJA OpenMP target tests" On)
+option(RAJA_TEST_OPENMP_TARGET_SUBSET "Build subset of RAJA OpenMP target tests when it is enabled" On)
 option(RAJA_ENABLE_RUNTIME_PLUGINS "Enable support for loading plugins at runtime" Off)
 option(RAJA_ALLOW_INCONSISTENT_OPTIONS "Enable inconsistent values for ENABLE_X and RAJA_ENABLE_X options" Off)
 

scripts/githooks/pre-commit

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#  Copyright (c) 2016-24, Lawrence Livermore National Security, LLC
+#  and RAJA project contributors. See the RAJA/LICENSE file for details.
+#
+#  SPDX-License-Identifier: (BSD-3-Clause)
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+# List of file extensions to format
+file_extensions=("cpp" "h" "c" "hpp")
+__clang_format_executable=""
+# Check if clang-format exists
+if command -v "$RAJA_CLANG_FORMAT" &> /dev/null; then
+  __clang_format_executable="$RAJA_CLANG_FORMAT"
+elif command -v clang-format &> /dev/null; then
+  __clang_format_executable=clang-format
+else
+  echo "Warning: clang-format and the environment variable RAJA_CLANG_FORMAT are not available.
+        Please set RAJA_CLANG_FORMAT to enable the automatic file formatting git hook."
+  exit 0
+fi
+
+# Check the major version of the provided clang-format
+VERSION_STRING=$($__clang_format_executable --version)
+MAJOR_VERSION=$(echo "$VERSION_STRING" | grep -oP '\d+' | head -1)
+
+if [ "$MAJOR_VERSION" != "14" ]; then
+  echo "Warning: RAJA_CLANG_FORMAT not set to a valid version number."
+  exit 0
+else
+  echo "Using clang-format at $RAJA_CLANG_FORMAT"
+fi
+
+# Convert file extensions array to regex pattern
+IFS="|"
+file_extensions_pattern="\.(${file_extensions[*]})$"
+unset IFS
+
+RAJA_DIR="$(git rev-parse --show-toplevel)"
+
+# Function to format files
+format_file() {
+  local loc_file="$1"
+  "$__clang_format_executable" -i "$loc_file"
+  git add "$loc_file"
+}
+
+# Find and format staged files with the specified extensions
+for file in $(git diff --cached --name-only --diff-filter=ACM | grep -E "$file_extensions_pattern"); do
+  if [[ -f "$RAJA_DIR/$file" ]]; then
+    echo "Formatting $RAJA_DIR/$file"
+    format_file "$RAJA_DIR/$file"
+  fi
+done
+
+exit 0

scripts/setup-hooks.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#  Copyright (c) 2016-24, Lawrence Livermore National Security, LLC
+#  and RAJA project contributors. See the RAJA/LICENSE file for details.
+#
+#  SPDX-License-Identifier: (BSD-3-Clause)
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+#------------------------------------------------------------------------------
+# This script installs client-side hooks
+#------------------------------------------------------------------------------
+basedir=`git rev-parse --show-toplevel`
+hooksdir="$basedir/.git/hooks/"
+cp -v $basedir/scripts/githooks/pre-commit $hooksdir