Commit 547dacad authored by Brad King's avatar Brad King

Add a script to run clang-format on the entire source tree

List all sources in version control and filter out those that we should
not format for various reasons.  Then run the clang-format tool to do an
in-place update.

Change-Id: If6d24b3b2e2de1b8e66f7fc2a713d2fd1d579f3d
parent 89b98af5
#!/usr/bin/env bash
#=============================================================================
# Copyright 2015-2016 Kitware, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#=============================================================================
usage='usage: clang-format.bash [<options>] [--]
--help Print usage plus more detailed help.
--clang-format <tool> Use given clang-format tool.
--amend Filter files changed by HEAD.
--cached Filter files locally staged for commit.
--modified Filter files locally modified from HEAD.
--tracked Filter files tracked by Git.
'
help="$usage"'
Example to format locally modified files:
Utilities/Scripts/clang-format.bash --modified
Example to format locally modified files staged for commit:
Utilities/Scripts/clang-format.bash --cached
Example to format files modified by the most recent commit:
Utilities/Scripts/clang-format.bash --amend
Example to format all files:
Utilities/Scripts/clang-format.bash --tracked
Example to format the current topic:
git filter-branch \
--tree-filter "Utilities/Scripts/clang-format.bash --tracked" \
master..
'
die() {
echo "$@" 1>&2; exit 1
}
#-----------------------------------------------------------------------------
# Parse command-line arguments.
clang_format=''
mode=''
while test "$#" != 0; do
case "$1" in
--amend) mode="amend" ;;
--cached) mode="cached" ;;
--clang-format) shift; clang_format="$1" ;;
--help) echo "$help"; exit 0 ;;
--modified) mode="modified" ;;
--tracked) mode="tracked" ;;
--) shift ; break ;;
-*) die "$usage" ;;
*) break ;;
esac
shift
done
test "$#" = 0 || die "$usage"
# Find a default tool.
tools='
clang-format
clang-format-3.8
'
if test "x$clang_format" = "x"; then
for tool in $tools; do
if type -p "$tool" >/dev/null; then
clang_format="$tool"
break
fi
done
fi
# Verify that we have a tool.
if ! type -p "$clang_format" >/dev/null; then
echo "Unable to locate '$clang_format'"
exit 1
fi
# Select listing mode.
case "$mode" in
'') echo "$usage"; exit 0 ;;
amend) git_ls='git diff-tree --diff-filter=AM --name-only HEAD -r --no-commit-id' ;;
cached) git_ls='git diff-index --diff-filter=AM --name-only HEAD --cached' ;;
modified) git_ls='git diff-index --diff-filter=AM --name-only HEAD' ;;
tracked) git_ls='git ls-files' ;;
*) die "invalid mode: $mode" ;;
esac
# Filter sources to which our style should apply.
list_cfg_files() {
$git_ls -z -- '*.c.in' '*.h.in' '*.hxx.in'
}
list_all_files() {
$git_ls -z -- '*.c' '*.c.in' '*.cxx' '*.h' '*.h.in' '*.hxx' '*.hxx.in'
}
# Transform configured sources to protect @SYMBOLS@.
list_cfg_files | xargs -0 -r sed -i 's/@\(KWSYS_[A-Z0-9_]\+\)@/x\1x/g'
# Update sources in-place.
list_all_files | xargs -0 "$clang_format" -i
# Transform configured sources to restore @SYMBOLS@.
list_cfg_files | xargs -0 -r sed -i 's/x\(KWSYS_[A-Z0-9_]\+\)x/@\1@/g'
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment