chore: Lints build system files

Author: cvilas

gbs/00_utilities.cmake

@@ -5,9 +5,9 @@
 #==================================================================================================
 # Print all variables generated during configuration
 function(print_cmake_variables)
-    get_cmake_property(_variable_names VARIABLES)
-    list (SORT _variable_names)
-    foreach (_var ${_variable_names})
-        message(STATUS "${_var}=${${_var}}")
-    endforeach()
+  get_cmake_property(variable_names VARIABLES)
+  list (SORT variable_names)
+  foreach (var ${variable_names})
+    message(STATUS "${var}=${${var}}")
+  endforeach()
 endfunction()

gbs/03_compiler_config.cmake

@@ -12,15 +12,15 @@ add_compile_options(-Wall -Wextra -Wpedantic -Werror)
 set(THIRD_PARTY_COMPILER_WARNINGS -Wall -Wextra -Wpedantic)
 
 # clang warnings
-set(CLANG_WARNINGS -Weverything 
-  -Wno-c++20-compat 
-  -Wno-pre-c++20-compat-pedantic 
-  -Wno-pre-c++17-compat 
-  -Wno-c++98-compat 
-  -Wno-c++98-compat-pedantic 
-  -Wno-unsafe-buffer-usage 
-  -Wno-padded 
-  -Wno-switch-default 
+set(CLANG_WARNINGS -Weverything
+  -Wno-c++20-compat
+  -Wno-pre-c++20-compat-pedantic
+  -Wno-pre-c++17-compat
+  -Wno-c++98-compat
+  -Wno-c++98-compat-pedantic
+  -Wno-unsafe-buffer-usage
+  -Wno-padded
+  -Wno-switch-default
   -Wno-ctad-maybe-unsupported
   -Wno-global-constructors
   -Wno-weak-vtables
@@ -39,15 +39,15 @@ set(GCC_WARNINGS
   -Wnull-dereference # warn if a null dereference is detected
   -Wdouble-promotion # warn if float is implicit promoted to double
   -Wformat=2 # warn on security issues around functions that format output (ie printf)
-  -Wimplicit-fallthrough # warn on statements that fallthrough without an explicit annotation    
+  -Wimplicit-fallthrough # warn on statements that fallthrough without an explicit annotation
   -Wmisleading-indentation # warn if indentation implies blocks where blocks do not exist
   -Wduplicated-cond # warn if if / else chain has duplicated conditions
   -Wduplicated-branches # warn if if / else branches have duplicated code
   -Wlogical-op # warn about logical operations being used where bitwise were probably wanted
   -Wuseless-cast # warn if you perform a cast to the same type
-  -Wconversion 
-  -Wcast-qual 
-  -Wpointer-arith 
+  -Wconversion
+  -Wcast-qual
+  -Wpointer-arith
 )
 
 if(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
@@ -88,10 +88,7 @@ endif()
 option(ENABLE_MSAN "Enable memory sanitizer" FALSE)
 if(${ENABLE_MSAN})
   if(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
-    message(
-      WARNING
-        "Memory sanitizer requires all the code (including libc++) to be MSAN-instrumented otherwise it reports false positives"
-    )
+    message(WARNING "Memory sanitizer requires all code (including libc++) to be MSAN-instrumented to avoid false positives")
   endif()
   if("address" IN_LIST SANITIZERS
      OR "thread" IN_LIST SANITIZERS
@@ -131,8 +128,8 @@ endif()
 option(ENABLE_CACHE "Enable cache if available" ON)
 if(ENABLE_CACHE)
   set(CACHE_PROGRAM_OPTIONS "ccache" "sccache")
-  foreach(CACHE_OPTION IN LISTS CACHE_PROGRAM_OPTIONS)
-    find_program(CACHE_BIN ${CACHE_OPTION})
+  foreach(cache_option IN LISTS CACHE_PROGRAM_OPTIONS)
+    find_program(CACHE_BIN ${cache_option})
     if(CACHE_BIN)
       set(CMAKE_CXX_COMPILER_LAUNCHER ${CACHE_BIN})
       set(CMAKE_C_COMPILER_LAUNCHER ${CACHE_BIN})
@@ -156,14 +153,13 @@ option(ENABLE_LINTER "Enable static analysis" ON)
 if(ENABLE_LINTER)
   find_program(LINTER_BIN NAMES clang-tidy QUIET)
   if(LINTER_BIN)
-    set(LINTER_ARGS 
-      -extra-arg=-Wno-ignored-optimization-argument 
+    set(LINTER_ARGS
+      -extra-arg=-Wno-ignored-optimization-argument
       -extra-arg=-Wno-unknown-warning-option)
     # NOTE: To speed up linting, clang-tidy is invoked via clang-tidy-cache.
     # (https://github.com/matus-chochlik/ctcache) Cache location is set by environment variable
     # CTCACHE_DIR
-    set(LINTER_INVOKE_COMMAND
-        ${GBS_TEMPLATES_DIR}/clang-tidy-cache.py ${LINTER_BIN} -p ${CMAKE_BINARY_DIR} ${LINTER_ARGS})
+    set(LINTER_INVOKE_COMMAND ${GBS_TEMPLATES_DIR}/clang-tidy-cache.py ${LINTER_BIN} -p ${CMAKE_BINARY_DIR} ${LINTER_ARGS})
     set(CMAKE_C_CLANG_TIDY ${LINTER_INVOKE_COMMAND})
     set(CMAKE_CXX_CLANG_TIDY ${LINTER_INVOKE_COMMAND})
     if(CMAKE_CXX_COMPILER_ID MATCHES "GNU")

gbs/04_code_formatter.cmake

@@ -15,56 +15,53 @@ if(ENABLE_FORMATTER)
   endif()
 endif()
 
-# Target to format source files
-add_custom_target(format)
+add_custom_target(format COMMENT "Format source files")
 
 # Function to apply clang formatting on a target
-# https://www.linkedin.com/pulse/simple-elegant-wrong-how-integrate-clang-format-friends-brendan-drew
-
-function(add_clang_format _target_name)
+function(add_clang_format target_name)
   if(CLANG_FORMAT_BIN AND ENABLE_FORMATTER)
-    if(NOT TARGET ${_target_name})
-      message(FATAL_ERROR "add_clangformat called on a non-target \"${_target_name}\"")
+    if(NOT TARGET ${target_name})
+      message(FATAL_ERROR "add_clangformat called on a non-target \"${target_name}\"")
     endif()
 
     # figure out which sources this should be applied to
-    get_target_property(_clang_sources ${_target_name} SOURCES)
-    get_target_property(_builddir ${_target_name} BINARY_DIR)
+    get_target_property(_clang_sources ${target_name} SOURCES)
+    get_target_property(_builddir ${target_name} BINARY_DIR)
 
     # There are file types we don't want to process (or may be the inverse list is shorter)
-    set(_supported_file_types ".c" ".cpp" ".h" ".hpp" ".inl")
+    set(supported_file_types ".c" ".cpp" ".h" ".hpp" ".inl")
 
-    set(_sources "")
-    foreach(_source ${_clang_sources})
-      if(NOT TARGET ${_source})
-        get_filename_component(_ext_type ${_source} EXT)
+    set(sources "")
+    foreach(source ${_clang_sources})
+      if(NOT TARGET ${source})
+        get_filename_component(_ext_type ${source} EXT)
         if(NOT ${_ext_type} STREQUAL "")
-          if(${_ext_type} IN_LIST _supported_file_types)
-            get_filename_component(_source_file ${_source} NAME)
-            get_source_file_property(_file_loc "${_source}" LOCATION)
+          if(${_ext_type} IN_LIST supported_file_types)
+            get_filename_component(_source_file ${source} NAME)
+            get_source_file_property(_file_loc "${source}" LOCATION)
 
             math(EXPR counter "${counter}+1")
-            set(_format_file
-                .${CMAKE_FILES_DIRECTORY}/${_target_name}_${counter}_${_source_file}.format)
+            set(format_file
+                .${CMAKE_FILES_DIRECTORY}/${target_name}_${counter}_${_source_file}.format)
             add_custom_command(
-              OUTPUT ${_format_file}
-              DEPENDS ${_source}
-              COMMENT "Format ${_source}"
+              OUTPUT ${format_file}
+              DEPENDS ${source}
+              COMMENT "Format ${source}"
               COMMAND ${CLANG_FORMAT_BIN} -style=file -i ${_file_loc}
-              COMMAND ${CMAKE_COMMAND} -E touch ${_format_file})
-            list(APPEND _sources ${_format_file})
+              COMMAND ${CMAKE_COMMAND} -E touch ${format_file})
+            list(APPEND sources ${format_file})
           endif() # in included types list
         endif() # extension detected
       endif()
     endforeach()
 
-    if(_sources)
+    if(sources)
       add_custom_target(
-        ${_target_name}_clangformat
-        SOURCES ${_sources}
+        ${target_name}_clangformat
+        SOURCES ${sources}
         COMMENT "Format target ${_target}")
-      add_dependencies(${_target_name} ${_target_name}_clangformat)
-      add_dependencies(format ${_target_name}_clangformat)
+      add_dependencies(${target_name} ${target_name}_clangformat)
+      add_dependencies(format ${target_name}_clangformat)
     endif()
   endif() # CLANG_FORMAT_BIN found
 endfunction()