Add help script to apply uncrustify to a constrained set of files/dirs

.uncrustify.cfg

@@ -174,8 +174,8 @@ sp_after_new                    = force
 sp_between_new_paren            = force
 sp_after_newop_paren            = force
 sp_inside_newop_paren           = force
-sp_before_tr_emb_cmt            = add
-sp_num_before_tr_emb_cmt        = 1
+sp_before_tr_cmt                = add
+sp_num_before_tr_cmt            = 1
 sp_skip_vbrace_tokens           = false
 sp_after_noexcept               = remove
 
@@ -206,7 +206,7 @@ indent_ctor_init                = 0
 indent_else_if                  = false
 indent_var_def_blk              = 0
 indent_var_def_cont             = false
-indent_shift                    = false
+indent_shift                    = 0
 indent_func_def_force_col1      = false
 indent_func_call_param          = false
 indent_func_def_param           = false
@@ -219,7 +219,8 @@ indent_func_const               = 0
 indent_func_throw               = 0
 indent_member                   = 2
 indent_member_single            = true
-indent_sing_line_comments       = 0
+#indent_sing_line_comments       = 0
+indent_single_line_comments_before = 0
 indent_relative_single_line_comments = false
 indent_switch_case              = 2
 indent_switch_pp                = true
@@ -231,7 +232,7 @@ indent_access_spec              = -2
 indent_access_spec_body         = false
 indent_paren_nl                 = false
 indent_paren_close              = 0
-indent_bool_paren               = false
+indent_bool_paren               = 0
 indent_square_nl                = false
 indent_align_assign             = true
 indent_align_paren              = true
@@ -529,7 +530,7 @@ pp_ignore_define_body           = false
 pp_indent_case                  = true
 pp_indent_func_def              = true
 pp_indent_extern                = true
-pp_indent_brace                 = true
+pp_indent_brace                 = 1
 
 # Use or Do not Use options
 use_indent_func_call_param      = true

scripts/unix_uncrustify.bash

@@ -0,0 +1,137 @@
+#!/bin/bash
+#
+# This file is part of KWIVER, and is distributed under the
+# OSI-approved BSD 3-Clause License. See top-level LICENSE file or
+# https://github.com/Kitware/kwiver/blob/master/LICENSE for details.
+#
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT_DIR="$(realpath "${SCRIPT_DIR}/..")"
+UNCRUSTIFY_CFG_FPATH="$ROOT_DIR"/.uncrustify.cfg
+
+# Regex for just the text following the final `.` before the end of the filename.
+# This set of file extensions should cover all C/C++ source files that we
+# desire to check against uncrustify under the `CPP` language mode.
+CPP_FILE_SUFFIX_RE="(h|hpp|hxx|txx|cpp|cxx|cu)"
+
+# Directories relative to the root directory to search for C++ files for
+# uncrustification. This is used when performing general file discovery (e.g.
+# not used when deducing from git status, explicit filepaths, etc.).
+CPP_SOURCE_DIRS=(
+#  "arrows"
+#  "examples"
+#  "CMake"
+#  "python"
+#  "tests"
+#  "vital"
+
+  # TO START: Just one file that abides the style configuration.
+  "vital/types/color.h"
+)
+
+# Exit is for when cd fails for whatever reason
+cd "$ROOT_DIR" || exit
+
+function usage {
+  echo "\
+${BASH_SOURCE[0]} [--check] [--git] [FILEPATHS]
+
+Run the uncrustify tool against repository C++ files.
+Assumes a unix environment.
+
+If no explicit filepaths are provided, automatic file discovery will occur:
+
+* If the '--git' option is provided, we use 'git status' to deduce
+  added/modified/unstaged files to check/format.
+
+* Otherwise, all h/txx/cxx files under known directories here will be collected
+  for checking/formatting.
+
+The --check option may be provided to instead run uncrustify in check-mode,
+which doesn't modify files but instead exits with a non-zero code if any
+files *would* be changed. Files that would be changed are output to STDERR:
+    $ bash unix_uncrustify.sh --check 1>/dev/null
+
+Options:
+
+  -h, --help    Print this
+  --check       Just check file formatting. See the '--check' option for the
+                uncrustify tool for more details.
+  --git         Discover files based that have been added, modified, or
+                no-staged via the 'git status -s' command.
+
+Arguments:
+
+  FILEPATHS     Optionally provided explicit files to be formatted/checked.
+"
+}
+
+# If we should run uncrustify in to CHECK files instead of modifying them.
+CHECK_MODE=0
+# If we should collect files from git status added/modified/unstaged
+GIT_MODE=0
+# Explicitly provided filepaths
+EXPLICIT_FILES=()
+
+while [[ $# -gt 0 ]]
+do
+  key="$1"
+  shift  # past key
+  case ${key} in
+    -h|--help)
+      usage
+      exit 0
+      ;;
+    --check)
+      CHECK_MODE=1
+    ;;
+    --git)
+      # Collect files modified/added in git status
+      GIT_MODE=1
+    ;;
+    *)  # Anything else (wildcard)
+      # Assuming a provided filepath
+      echo "Adding \"$key\""
+      EXPLICIT_FILES[${#EXPLICIT_FILES[@]}]="$key"
+    ;;
+  esac
+done
+
+if [[ "${#EXPLICIT_FILES[@]}" -eq 0 ]]
+then
+  # If there were no files specifically provided, discover files instead.
+  if [[ "${GIT_MODE}" -eq 1 ]]
+  then
+    mapfile -d "" CPP_FILES < <(git status -s | grep -v "^D " | grep -E "\.${CPP_FILE_SUFFIX_RE}$" | cut -c 4- | tr '\n' '\0')
+  else
+    # NOTE: This subtractive grep usage to filter out certain places we chose not to
+    # enforce style requirements on.
+    mapfile -d "" CPP_FILES \
+      < <(find "${CPP_SOURCE_DIRS[@]}" \
+          -type f -regextype egrep -iregex ".*\.${CPP_FILE_SUFFIX_RE}$" -print0 \
+          | grep -zv "^vital/kwiversys" )
+  fi
+else
+  CPP_FILES=("${EXPLICIT_FILES[@]}")
+fi
+
+## Debug file selection
+#echo "CPP FILES: (${#CPP_FILES[@]})"
+#for F in "${CPP_FILES[@]}"
+#do
+#  echo "- '$F'"
+#done
+#exit
+
+# This call may be adapted to only "check" for files that **would** be modified
+# by replacing the ``--no-backup --replace`` options with ``--check``.
+if [[ "${CHECK_MODE}" -eq 1 ]]
+then
+  MODE_ARGS="--check"
+else
+  MODE_ARGS="--no-backup --replace"
+fi
+# Use of `-lCPP` is important. Otherwise not all files are treated the same.
+# shellcheck disable=SC2086
+uncrustify -c "${UNCRUSTIFY_CFG_FPATH}" -lCPP ${MODE_ARGS} "${CPP_FILES[@]}"