Utilize common script for pre-commit hook

Change-Id: Id468016065eb19a24375c8cecb0ac6faf631f316

Author: jserv

scripts/pre-commit.hook

@@ -11,7 +11,7 @@ declare -F set_colors >/dev/null 2>&1 || { echo "[!] '$common_script' does not d
 # Build unmatched suppressions for each *.c file.
 cppcheck_build_unmatched() {
   local file suppression=""
-  for file in *.c tools/*.c; do
+  for file in *.c; do
     suppression+=" --suppress=unmatchedSuppression:$file"
   done
   echo "$suppression"
@@ -46,12 +46,11 @@ cppcheck_suppressions() {
     "staticFunction:linenoise.c"
     "nullPointerOutOfMemory:web.c"
     "staticFunction:web.c"
-    "constParameterCallback:tools/fmtscan.c"
   )
 
   # Array for additional cppcheck options (non-suppressions)
   local -a other_flags=(
-    "--inline-suppr harness.c --inline-suppr tools/fmtscan.c"
+    "--inline-suppr harness.c"
   )
 
   local out=""
@@ -69,50 +68,20 @@ cppcheck_suppressions() {
   printf "%s" "$out" | sed 's/[[:space:]]*$//'
 }
 
-# Generation of standard compliance for GCC/Clang
-detect_cc_std() {
-  local STDC_VERSION=""
-  local EXTRA_DEFINES=""
-  if command -v cc >/dev/null 2>&1; then
-    if cc --version 2>/dev/null | grep -q "clang"; then
-      STDC_VERSION=$(cc -dM -E -xc /dev/null | awk '/__STDC_VERSION__/ {print $3}')
-      EXTRA_DEFINES="-D__clang__=1"
-    elif cc --version 2>/dev/null | grep -q "Free Software Foundation"; then
-      STDC_VERSION=$(cc -dM -E -xc /dev/null | awk '/__STDC_VERSION__/ {print $3}')
-      EXTRA_DEFINES="-D__GNUC__=1"
-    fi
-  fi
-  if [ -n "$STDC_VERSION" ]; then
-    EXTRA_DEFINES+=" -D__STDC__=1 -D__STDC_VERSION__=${STDC_VERSION}"
-  fi
-  echo "$EXTRA_DEFINES"
-}
-
 CPPCHECK_OPTS="-I. --enable=all --error-exitcode=1"
-CPPCHECK_OPTS+=" $(detect_cc_std)"
 CPPCHECK_OPTS+=" --force $(cppcheck_suppressions) $(cppcheck_build_unmatched)"
-CPPCHECK_OPTS+=" --cppcheck-build-dir=.out"
+CPPCHECK_OPTS+=" --cppcheck-build-dir=.out ."
 
 set_colors
 
 RETURN=0
 
 # Disallow non-ASCII characters in workspace path
 workspace=$(git rev-parse --show-toplevel)
-if echo "$workspace" | LC_ALL=C grep -q "[一-龥]"; then
+if echo "$workspace" | grep -q "[一-龥]"; then
   throw "The workspace path '$workspace' contains non-ASCII characters."
 fi
 
-# Check for merge conflict markers in staged changes.
-# Assemble the conflict marker regex without embedding it directly.
-CONFLICT_MARKERS=$(printf '%s|%s|%s' "<<<<<<<" "=======" ">>>>>>>")
-# Get staged files that contain conflict markers, but exclude hook files.
-CONFLICT_FILES=$(git diff --cached --name-only -G "${CONFLICT_MARKERS}" | \
-                 grep -vE '(^|/)\.git/hooks/|(^|/)(pre-commit|commit-msg|prepare-commit-msg|pre-push)\.hook$')
-if [ -n "${CONFLICT_FILES}" ]; then
-  throw "Conflict markers are still present in the following files:\n%s" ${CONFLICT_FILES}
-fi
-
 CLANG_FORMAT=$(which clang-format)
 if [ $? -ne 0 ]; then
   throw "clang-format not installed. Unable to check source file format policy."
@@ -179,8 +148,8 @@ if [ "${#binary_files[@]}" -gt 0 ]; then
   printf "${RED}[!]${NC} Binary data found.\n"
 fi
 
-C_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep -E "\.(c|cpp|h|hpp)$")
-for FILE in $C_FILES; do
+FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep -E "\.(c|cpp|h)$")
+for FILE in $FILES; do
   nf=$(git checkout-index --temp $FILE | cut -f 1)
   tempdir=$(mktemp -d) || exit 1
   newfile=$(mktemp ${tempdir}/${nf}.XXXXXX) || exit 1
@@ -207,47 +176,9 @@ for FILE in $C_FILES; do
   fi
 done
 
-# Check syntax for changed shell scripts
-SHELL_FILES=()
-for file in "${FILES[@]}"; do
-  if [[ "$file" =~ ^scripts/common\.sh$ || "$file" =~ ^scripts/.*\.hook$ ]]; then
-    SHELL_FILES+=("$file")
-  fi
-done
-if [ "${#SHELL_FILES[@]}" -gt 0 ]; then
-  for file in "${SHELL_FILES[@]}"; do
-    if ! bash -n "$file"; then
-      throw "Syntax errors detected in $file." >&2
-    fi
-  done
-fi
-
-ASPELL_DICT_FILE='scripts/aspell-pws'
-if ! LC_ALL=C tail -n +2 $ASPELL_DICT_FILE | sort -f -cdu; then
-  throw '%s\n%s\n%s' \
-    'Aspell dictionary is unsorted or contains duplicated entries.' \
-    'Make sure that by using:' \
-    "    tail -n +2 $ASPELL_DICT_FILE | sort -f -du"
-fi
-
-# Show insertion and deletion counts.
-if [ "${#FILES[@]}" -gt 0 ]; then
-  echo "Following files were changed:"
-  for file in "${FILES[@]}"; do
-    summary=$(git diff --cached --numstat "$file" | awk '{
-      if ($1 != "0" && $2 != "0")
-        printf "%s insertions(+), %s deletions(-)", $1, $2;
-      else if ($1 != "0")
-        printf "%s insertions(+)", $1;
-      else if ($2 != "0")
-        printf "%s deletions(-)", $2;
-    }')
-    if [ -n "$summary" ]; then
-      echo "  - $file : $summary"
-    else
-      echo "  - $file"
-    fi
-  done
+if [ ! -z "${FILES[*]}" ]; then
+  echo "Following files need to be cleaned up:"
+  echo "${FILES[*]}"
 fi
 
 $SHA1SUM -c scripts/checksums 2>/dev/null >/dev/null
@@ -259,7 +190,8 @@ fi
 root=$(git rev-parse --show-toplevel)
 banned="([^f]gets\()|(sprintf\()|(strcpy\()"
 status=0
-for file in $C_FILES; do
+for file in $(git diff --staged --name-only | grep -E "\.(c|cc|cpp|h|hh|hpp)\$")
+do
   filepath="${root}/${file}"
   output=$(grep -nrE "${banned}" "${filepath}")
   if [ ! -z "${output}" ]; then
@@ -272,41 +204,21 @@ for file in $C_FILES; do
   fi
 done
 
-# format string checks
-if [[ "$OSTYPE" != darwin* ]]; then
-  # Format string checks
-  if [ ! -f fmtscan ]; then
-    make fmtscan
-    if [ ! -f fmtscan ]; then
-      throw "Fail to build 'fmtscan' tool"
-    fi
-  fi
-  if [ -n "$C_FILES" ]; then
-    echo "Running fmtscan..."
-    ./fmtscan
-    if [ $? -ne 0 ]; then
-      throw "Check format strings for spelling"
-    fi
-  fi
-fi
-
 # static analysis
-if [ -n "$C_FILES" ]; then
-  echo "Running static analysis..."
-  $CPPCHECK $CPPCHECK_OPTS $C_FILES >/dev/null
-  if [ $? -ne 0 ]; then
-    RETURN=1
-    echo "" >&2
-    echo "Fail to pass static analysis." >&2
-    echo
-  fi
+echo "Running static analysis..."
+$CPPCHECK $CPPCHECK_OPTS >/dev/null
+if [ $? -ne 0 ]; then
+  RETURN=1
+  echo "" >&2
+  echo "Fail to pass static analysis." >&2
+  echo
 fi
 
 # non-ASCII filenames are not allowed.
 # Cross platform projects tend to avoid non-ASCII filenames; prevent
 # them from being added to the repository.
 if test $(git diff --cached --name-only --diff-filter=A -z $against |
-          LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+        LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
 then
   cat <<\EOF
 ERROR: Attempt to add a non-ASCII file name.