3 # This file is part of the GROMACS molecular simulation package.
5 # Copyright (c) 2013,2014,2015,2019, by the GROMACS development team, led by
6 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 # and including many others, as listed in the AUTHORS file in the
8 # top-level source directory and at http://www.gromacs.org.
10 # GROMACS is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU Lesser General Public License
12 # as published by the Free Software Foundation; either version 2.1
13 # of the License, or (at your option) any later version.
15 # GROMACS is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 # Lesser General Public License for more details.
20 # You should have received a copy of the GNU Lesser General Public
21 # License along with GROMACS; if not, see
22 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 # If you want to redistribute modifications to GROMACS, please
26 # consider that scientific software is very special. Version
27 # control is crucial - bugs must be traceable. We will be happy to
28 # consider code for inclusion in the official distribution, but
29 # derived work must not be called official GROMACS. Details are found
30 # in the README & COPYING files - if they are missing, get the
31 # official version at http://www.gromacs.org.
33 # To help us fund GROMACS development, we humbly ask that you cite
34 # the research papers on the package. Check out http://www.gromacs.org.
36 # This script runs uncrustify on modified files and
37 # reports/applies the necessary changes.
39 # See `uncrustify.sh -h` for a brief usage, and docs/dev-manual/code-formatting.rst
42 # Parse command-line arguments
44 echo "usage: uncrustify.sh [-f|--force] [--rev=REV]"
45 echo " [--uncrustify=(off|check)]"
46 echo " [--warnings=<file>] [<action>]"
47 echo "<action>: (check*|diff|update)[-(index|workdir*)] (*=default)"
50 action
="check-workdir"
57 if [[ "$arg" == "check-index" ||
"$arg" == "check-workdir" || \
58 "$arg" == "diff-index" ||
"$arg" == "diff-workdir" || \
59 "$arg" == "update-index" ||
"$arg" == "update-workdir" ]]
62 elif [[ "$arg" == "check" ||
"$arg" == "diff" ||
"$arg" == "update" ]] ; then
64 elif [[ "$action" == diff-
* ]] ; then
66 elif [[ "$arg" == --uncrustify=* ]] ; then
67 uncrustify_mode
=${arg#--uncrustify=}
68 if [[ "$uncrustify_mode" != "off" && "$uncrustify_mode" != "check" ]] ; then
69 echo "Unknown option: $arg"
74 elif [[ "$arg" == "-f" ||
"$arg" == "--force" ]] ; then
76 elif [[ "$arg" == --rev=* ]] ; then
78 elif [[ "$arg" == --warnings=* ]] ; then
79 warning_file
=${arg#--warnings=}
80 elif [[ "$arg" == "-h" ||
"$arg" == "--help" ]] ; then
84 echo "Unknown option: $arg"
91 # Check that uncrustify is present
92 if [[ "$uncrustify_mode" != "off" ]]
94 if [ -z "$UNCRUSTIFY" ]
96 UNCRUSTIFY
=`git config hooks.uncrustifypath`
98 if [ -z "$UNCRUSTIFY" ]
100 echo "Please set the path to uncrustify using UNCRUSTIFY or"
101 echo "git config hooks.uncrustifypath."
102 echo "Note that you need a custom version of uncrustify."
103 echo "See docs/dev-manual/uncrustify.rst for how to get one."
106 if ! which "$UNCRUSTIFY" 1>/dev
/null
108 echo "Uncrustify not found: $UNCRUSTIFY"
113 # Switch to the root of the source tree and check the config file
114 srcdir
=`git rev-parse --show-toplevel`
115 pushd $srcdir >/dev
/null
116 admin_dir
=$srcdir/admin
117 cfg_file
=$admin_dir/uncrustify.cfg
118 if [ ! -f "$cfg_file" ]
120 echo "Uncrustify configuration file not found: $cfg_file"
124 # Actual processing starts: create a temporary directory
125 tmpdir
=`mktemp -d -t gmxuncrust.XXXXXX`
127 # Produce a list of changed files
128 # Only include files that have proper filter set in .gitattributes
130 if [[ $action == *-index ]]
132 internal_diff_args
="--cached"
134 git diff-index
$internal_diff_args --diff-filter=ACMR
$baserev >$tmpdir/difflist
135 cut
-f2 <$tmpdir/difflist | \
136 git check-attr
--stdin filter | \
137 sed -e 's/.*: filter: //' | \
138 paste $tmpdir/difflist
- | \
139 grep -E '(complete_formatting|uncrustify|copyright|includesort)$' >$tmpdir/filtered
140 cut
-f2 <$tmpdir/filtered
>$tmpdir/filelist_all
141 grep -E '(uncrustify)$' <$tmpdir/filtered | \
142 cut
-f2 >$tmpdir/filelist_uncrustify
143 git diff-files
--name-only |
grep -Ff $tmpdir/filelist_all
>$tmpdir/localmods
145 # Extract changed files to a temporary directory
147 if [[ $action == *-index ]] ; then
148 git checkout-index
--prefix=$tmpdir/org
/ --stdin <$tmpdir/filelist_all
150 rsync
--files-from=$tmpdir/filelist_all
$srcdir $tmpdir/org
152 # Duplicate the original files to a separate directory, where all changes will
154 cp -r $tmpdir/org
$tmpdir/new
156 # Create output file for what was done (in case no messages get written)
157 touch $tmpdir/messages
159 # Run uncrustify on the temporary directory
161 if [[ $uncrustify_mode != "off" ]] ; then
162 if ! $UNCRUSTIFY -c $cfg_file -F $tmpdir/filelist_uncrustify
--no-backup >$tmpdir/uncrustify.out
2>&1 ; then
163 echo "Reformatting failed. Check uncrustify output below for errors:"
164 cat $tmpdir/uncrustify.out
168 # Find the changed files if necessary
169 if [[ $action != diff-
* ]] ; then
170 msg
="needs uncrustify"
171 if [[ $action == update-
* ]] ; then
174 git
diff --no-index --name-only ..
/org
/ . | \
175 awk -v msg
="$msg" '{sub(/.\//,""); print $0 ": " msg}' >> $tmpdir/messages
177 # TODO: Consider checking whether rerunning uncrustify causes additional changes
182 # If a diff was requested, show it and we are done
183 if [[ $action == diff-
* ]] ; then
184 git
diff --no-index --no-prefix "${diffargs[@]}" org
/ new
/
189 # Find the changed files
190 git
diff --no-index --name-only --exit-code org
/ new
/ | \
191 sed -e 's#new/##' > $tmpdir/changed
193 if [[ -s $tmpdir/changed
]]
198 # Check if changed files have changed outside the index
199 if grep -Ff $tmpdir/localmods
$tmpdir/changed
> $tmpdir/conflicts
201 awk '{print $0 ": has changes in work tree"}' $tmpdir/conflicts \
203 if [[ ! $force && $action == update-
* ]] ; then
204 echo "Modified files found in work tree, skipping update. Use -f to override."
205 echo "The following would have been done:"
206 sort $tmpdir/messages
212 # Update the index/work tree if requested
213 if [[ $action == update-index
]] ; then
214 grep -Ff $tmpdir/changed
$tmpdir/filtered
> $tmpdir/tohash
218 for change
in `cut -f2 $tmpdir/tohash | \
219 git --git-dir=$srcdir/.git hash-object -w --stdin-paths --no-filters | \
220 paste - $tmpdir/tohash`
222 # NOTE: the patterns below contain literal tabs
228 # Contains a literal tab
229 echo "$mode $sha1 $path" >> $tmpdir/toindex
232 git
--git-dir=$srcdir/.git update-index
--index-info < $tmpdir/toindex
233 elif [[ $action == update-workdir
]] ; then
234 rsync
--files-from=$tmpdir/changed
$tmpdir/new
/ $srcdir/
237 # Get back to the original directory
240 # Report what was done
241 sort $tmpdir/messages |
tee $warning_file