clangify.sh

#!/bin/bash

# This script will run clang-format on all modified, non-3rd-party C++/Header files.
# Never, ever, should this recieve a path with a newline in it. Don't bother proofing it for that.


# go to the project root directory, this file should be located in the project root directory
cd "${BASH_SOURCE%/*}/" || exit 2 # could not find path, this could happen with special links etc.

# defaults
include=("common" \
"cockatrice/src" \
"oracle/src" \
"servatrice/src")
exclude=("servatrice/src/smtp" \
"common/sfmt" \
"common/lib" \
"oracle/src/zip" \
"oracle/src/lzma" \
"oracle/src/qt-json")
exts=("cpp" "h")
cf_cmd="clang-format"
branch="origin/master"

# parse options
while [[ $@ ]]; do
  case "$1" in
    '-b'|'--branch')
      branch=$2
      set_branch=1
      shift 2
      ;;
    '-c'|'--color-diff')
      color=" --color=always"
      mode=diff
      shift
      ;;
    '-d'|'--diff')
      mode=diff
      shift
      ;;
    '-h'|'--help')
      cat <<EOM
A bash script to automatically format your code using clang-format.

If no options are given, all dirty source files are edited in place.
If <dir>s are given, all source files in those directories of the project root
path are formatted. To only format changed files in these directories use the
--branch option in combination. <dir> has to be a path relative to the project
root path or a full path inside $PWD.
. can not be specified as a dir, if you really want to format everything use */.

USAGE: $0 [option] [--branch <git branch or object>] [<dir> ...]

DEFAULTS:
Current includes are:
  ${include[@]/%/
 }
Default excludes are:
  ${exclude[@]/%/
 }
OPTIONS:
    -b, --branch <branch>
        Compare to this git branch and format only files that differ.
        If unspecified it defaults to origin/master.
        To not compare to a branch this has to be explicitly set to "".
        When not comparing to a branch, git will not be used at all and every
        source file in the entire project will be parsed.

    -c, --color-diff
        Display a colored diff. Implies --diff.
        Only available on systems which support 'diff --color'.

    -d, --diff
        Display a diff. Implies --test.

    -h, --help
        Display this message and exit.

    -n, --names
        Display a list of filenames that require formatting. Implies --test.

    -t, --test
        Do not edit files in place. Set exit code to 1 if changes are required.

    --cf-version
        Print the version of clang-format being used before continuing.

EXIT CODES:
    0 on a successful format or if no files require formatting.
    1 if a file requires formatting.
    2 if given incorrect arguments.
    3 if clang-format could not be found.

EXAMPLES:
    $0 --test \$PWD || echo "code requires formatting"
        Tests if the source files in the current directory are correctly
        formatted and prints an error message if formatting is required.

    $0 --branch $USER/patch-2 ${include[0]}
        Formats all changed files compared to the git branch "$USER/patch-2"
        in the directory ${include[0]}.
EOM
      exit 0
      ;;
    '-n'|'--names')
      mode=name
      shift
      ;;
    '-t'|'--test')
      mode=code
      shift
      ;;
    '--cf-version')
      print_version=1
      shift
      ;;
    '--')
      shift
      ;;
    *)
      if next_dir=$(cd "$1" && pwd); then
        if [[ ${next_dir#$PWD/} == /* ]]; then
          echo "error in parsing arguments of $0: $next_dir is not in $PWD" >&2
          exit 2 # input error
        elif ! [[ $set_include ]]; then
          include=() # remove default includes
          set_include=1
        fi
        include+=("${next_dir#$PWD/}")
      else
        echo "error in parsing arguments of $0: $PWD/$1 is not a directory" >&2
        exit 2 # input error
      fi
      if ! [[ $set_branch ]]; then
        unset branch # unset branch if not set explicitly
      fi
      shift
      ;;
  esac
done

# check availability of clang-format
if ! hash $cf_cmd 2>/dev/null; then
  echo "could not find $cf_cmd" >&2
  # find any clang-format-x.x in /usr/bin
  cf_cmd=$(find /usr/bin -regex '.*/clang-format-[0-9]+\.[0-9]+' -print -quit)
  if [[ $cf_cmd ]]; then
    echo "found $cf_cmd instead" >&2
  else
    exit 3 # special exit code for missing dependency
  fi
fi

if [[ $branch ]]; then
  # get all dirty files through git
  if ! base=$(git merge-base ${branch} HEAD); then
    echo "could not find git merge base" >&2
    exit 2 # input error
  fi
  declare -a reg
  for ex in ${exts[@]}; do
    reg+=(${include[@]/%/.*\\.$ex\$})
  done
  names=$(git diff --diff-filter=d --name-only $base | grep ${reg[@]/#/-e ^})
else
  names=$(find ${include[@]} -type f -false ${exts[@]/#/-o -name *\\.})
fi

# filter excludes
names=$(<<<"$names" grep -v ${exclude[@]/#/-e ^})

if ! [[ $names ]]; then
  exit 0 # nothing to format means format is successful!
fi

# optionally print version
[[ $print_version ]] && $cf_cmd -version

# format
case $mode in
  diff)
    declare -i code=0
    for name in ${names[@]}; do
      if ! $cf_cmd "$name" | diff "$name" - -p $color; then
        code=1
      fi
    done
    exit $code
    ;;
  name)
    declare -i code=0
    for name in ${names[@]}; do
      if ! $cf_cmd "$name" | diff "$name" - -q >/dev/null; then
        echo "$name"
        code=1
      fi
    done
    exit $code
    ;;
  code)
    for name in ${names[@]}; do
      $cf_cmd "$name" | diff "$name" - -q >/dev/null || exit 1
    done
    ;;
  *)
    $cf_cmd -i $names
    ;;
esac