summaryrefslogtreecommitdiffstats
path: root/Utilities/Scripts/clang-format.bash
blob: 2b36ac5dd97c052f856904758a02a2f7a46edc23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
#!/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.
$git_ls -z -- '*.c' '*.cc' '*.cpp' '*.cxx' '*.h' '*.hh' '*.hpp' '*.hxx' '*.cu' '*.notcu' |

  # Exclude lexer/parser generator input and output.
  egrep -z -v '^Source/cmCommandArgumentLexer\.' |
  egrep -z -v '^Source/cmCommandArgumentParser(\.y|\.cxx|Tokens\.h)' |
  egrep -z -v '^Source/cmDependsJavaLexer\.' |
  egrep -z -v '^Source/cmDependsJavaParser(\.y|\.cxx|Tokens\.h)' |
  egrep -z -v '^Source/cmExprLexer\.' |
  egrep -z -v '^Source/cmExprParser(\.y|\.cxx|Tokens\.h)' |
  egrep -z -v '^Source/cmFortranLexer\.' |
  egrep -z -v '^Source/cmFortranParser(\.y|\.cxx|Tokens\.h)' |
  egrep -z -v '^Source/cmListFileLexer(\.in\.l|\.c)' |

  # Exclude third-party sources.
  egrep -z -v '^Source/bindexplib' |
  egrep -z -v '^Source/(kwsys|CursesDialog/form)/' |
  egrep -z -v '^Utilities/(KW|cm).*/' |

  # Exclude reference content.
  egrep -z -v '^Tests/RunCMake/GenerateExportHeader/reference/' |

  # Exclude manually-formatted sources (e.g. with long lines).
  egrep -z -v '^Tests/PositionIndependentTargets/pic_test.h' |
  egrep -z -v '^Tests/CompileFeatures/cxx_right_angle_brackets.cpp' |

  # Exclude sources with encoding not suported by clang-format.
  egrep -z -v '^Tests/RunCMake/CommandLine/cmake_depends/test_UTF-16LE.h' |

  # Update sources in-place.
  xargs -0 "$clang_format" -i